API - Integration Queue
Represents an Integration Queue Entry in Business Central.
Object Definition
| Object Type | Page |
| Object ID | 70314178 |
| Object Name | QWESR API - Integration Queue |
| Source Table | QWESR Integration Queue |
API Definition
| APIPublisher | smartApps |
| APIGroup | spider |
| APIVersion | v1.0 |
| EntitySetName | integrationQueueEntries |
| EntityName | integrationQueueEntry |
Service Enabled Procedures
| Name | Description |
|---|---|
| Execute() | Processes the current Integration Queue Entry. |
Events
| Name | Description |
|---|---|
| OnAfterInsert(Record "QWESR Integration Queue"; Text; Text; Text; Text; Text; Text; Text; Text; Text; Text; List of [Integer]) | Raised after a record is inserted. Makes it possible to handle the values in ExtraValues 1..10. |
| OnGetExtraValues(Record "QWESR Integration Queue"; Text; Text; Text; Text; Text; Text; Text; Text; Text; Text) | Raised after a record is read from the database. Makes it possible to set the ExtraValues 1..10, to be returned to the client. |
Remarks
If you use this API from the integration queue and the sending company/environment and the receiving company/environment are the same, you will get a locking error since the Integration Queue is locked in the sending company. This is by-design and is not supported.
Example
Read
Get a list of Integration Queue Entries.
GET businesscentralPrefix/companies({id})/integrationQueueEntries?$schemaversion=2.0
Get a single Integration Queue Entry
GET businesscentralPrefix/companies({id})/integrationQueueEntries({id})?$schemaversion=2.0
Create
Create a new Integration Queue Entry.
POST businesscentralPrefix/companies({id})/integrationQueueEntries?$schemaversion=2.0
Content-type: application/json
{
"integrationSetupCode": "A",
"name": "HelloWorld.txt",
"base64dataIn": "SGVsbG8gV29ybGQ=",
"sourceCreated": "2022-01-01T13:00:00Z"
}
Controls
| Type | Name | Data Type | Read-only | Description |
|---|---|---|---|---|
| Field | id | Guid | Yes | |
| Field | entryNo | Integer | Yes | |
| Field | integrationSetupCode | Code[20] | ||
| Field | name | Text[1000] | ||
| Field | externalID | Text[50] | ||
| Field | data | Blob | Yes | |
| Field | base64dataIn | Text | Base64 encoded data to be saved to the field Data. | |
| Field | created | DateTime | Yes | |
| Field | sourceCreated | DateTime | ||
| Field | lastModifiedDateTime | DateTime | Yes | |
| Field | base64functionDataIn | Text | Base64 encoded data to be saved to the field Function Data. | |
| Field | extraValue1 | Text | ||
| Field | extraValue2 | Text | ||
| Field | extraValue3 | Text | ||
| Field | extraValue4 | Text | ||
| Field | extraValue5 | Text | ||
| Field | extraValue6 | Text | ||
| Field | extraValue7 | Text | ||
| Field | extraValue8 | Text | ||
| Field | extraValue9 | Text | ||
| Field | extraValue10 | Text |
This documentation is generated from Spider v27.2