NOTE: This is an article for the legacy API. To access updated information on this endpoint, please reference the HTML guide attached to the bottom of the REST API Access document
Resource: StagingTableImportSettings/
The Staging Table Import settings control which of the various staging tables are read in by StockIQ. There are a large number of staging tables, only a fraction of which are used by most StockIQ integrations.
The most common use of this API would be so set certain feeds to Partial or Complete based on the data you're able to send, such as marking a SalesOrder feed a partial during the week to avoid having to regenerate the whole file.
Verb: GET
Submit a "GET" to get the current list of settings.
Returns: JSON Array of StagingTableImportSettings objects
Example JSON:
[
{
"DataSetCompleteness": 1,
"StagingTableImportSettingsId": 1,
"SchemaName": "dati",
"TableName": "BoMEntry",
"IsActive": true,
"MaxDays": null,
"ImportMethod": 1,
"Source": 1,
"DateCreated": "2017-01-16T19:56:09.2996512-07:00",
"DateUpdated": "2017-01-16T19:56:09.2996512-07:00",
"CreatedByUserId": 1,
"UpdatedByUserId": 1,
"Note": null
}
]
Verb: POST
Submit a POST to save a specific staging table settings.
Returns: The saved table settings
Example Request JSON:
{
"DataSetCompleteness": 1,
"StagingTableImportSettingsId": 1,
"SchemaName": "dati",
"TableName": "SalesOrder",
"IsActive": true,
"MaxDays": 30,
"ImportMethod": 1,
"Source": 1,
"DateCreated": "2017-01-16T19:56:09.2996512-07:00",
"DateUpdated": "2017-01-16T19:56:09.2996512-07:00",
"CreatedByUserId": 1,
"UpdatedByUserId": 1,
"Note": "Set SalesOrder Partial"
}Field Details:
| DataSetCompleteness | Readonly property, based on the MaxDays setting. 1 = Complete, 2 = Partial. Do not change this value. |
| StagingTableImportSettingsId | The primary key. Do not change this value from what you received in the GET |
| SchemaName | The schema where the table resides. Do not change this value. |
| TableName | The name of the table you wish to change import settings. |
| IsActive | true = enabled, false = disabled |
| MaxDays | The number of days of data to extract. Set null to instruct StockIQ that you are sending a complete data set, or any non-null value (e.g: 1) to tell us you are sending a partial file. |
| ImportMethod | 1 = Standard, 2 = Bulk. Standard enables more verbose logging, but takes longer. Bulk is faster, but is not able to log some errors. |
| Source |
1 = System Default, 2 = User 2 will be the value saved when using the REST API. The system automatically determines the value. |
| DateCreated | The system automatically determines the value. |
| DateUpdated | The system automatically determines the value. |
| CreatedByUserId | The system automatically determines the value based on who submits the REST request. |
| UpdatedByUserId | The system automatically determines the value based on who submits the REST request. |
| Note | String field to capture a note about the setting, if you like |