POST call to begin a publish. This will take all models in Data Manager (regardless of their workflow) and publish them. Note: Only one publish can be run at a time. If a new publish is requested before the previous publish has completed, an error will be returned.
Fields:
| apiKey | Required: Secret Code used to authenticate the call and identify the OEM. For more information on generating your secret API Key, please refer to Appendix A, API Key generation. |
| isStagingPublish | Flag to denote a publish to staging. Values expected: true or false. |
| isProductionPublish | Flag to denote a publish to production. Values expected: true or false. Note: A publish to production can only occur once a successful publish to staging has completed. |
| isRePublishAll | Flag to denote a republish all. Values expected: true or false. Note: You may only attempt one republish all per day. If the second attempt to republish all fails, you will need to contact ARI for assistance. |
Sample URL:
https://xmlimport.datamanager.arinet.com/api/publish
Note: one of the following flags MUST be listed as true: isStagingPublish, isProductionPublish, isRePublishAll, but if isProductionPublish is true, then isStagingProduction and isRepublishAll MUST be false (or omitted).
Sample JSON request, publish to staging:
{
“apiKey”: “992dc0e2-b8b0-4f9e-a4cd-19eb9fc19fa8”,
“isStagingPublish”: true,
“isProductionPublish”: false,
“isRePublishAll”: false
}
or:
{
“apiKey”: “992dc0e2-b8b0-4f9e-a4cd-19eb9fc19fa8”,
“isStagingPublish”: true
}
Sample JSON request, republish all:
{
“apiKey”: “992dc0e2-b8b0-4f9e-a4cd-19eb9fc19fa8”,
“isStagingPublish”: true,
“isProductionPublish”: false,
“isRePublishAll”: true
}
or:
{
“apiKey”: “992dc0e2-b8b0-4f9e-a4cd-19eb9fc19fa8”,
“isStagingPublish”: true,
“isRePublishAll”: true
}
or:
{
“apiKey”: “992dc0e2-b8b0-4f9e-a4cd-19eb9fc19fa8”,
“isRePublishAll”: true
}
Sample JSON request, publish to production:
{
“apiKey”: “992dc0e2-b8b0-4f9e-a4cd-19eb9fc19fa8”,
“isStagingPublish”: false,
“isProductionPublish”: true,
“isRePublishAll”: false
}
or:
{
“apiKey”: “992dc0e2-b8b0-4f9e-a4cd-19eb9fc19fa8”,
“isProductionPublish”: true
}
Response codes:
| 200 | If a successful publish has begun, the call will return a JSON object containing a unique publish ID (integer), which can be used to request the Progress of the publish using the /api/Status call below. |
| 400 | Error returned in the form of a JSON object and a detailed message. |
| 401 | Unauthorized. This means the apiKey used does not have access to make these calls. |
| 500 | Unexpected error. |
Sample response:
{
“publishID”: 1
}