Use of the Supplier Data API with Pagination templates Endpoint
The Supplier Data API with Pagination templates endpoint uses the GET method to send a JSON request to your site. The request retrieves the intake form for the process type.
|
Method |
Endpoint |
Description |
|---|---|---|
|
GET |
{{runtime_URL}}/supplierdatapagination/v4/prod/processes/{processType}/templates |
Retrieves the intake form for the process type. |
For example, the following URL retrieves the intake form for the Process Type in myRealm:
GET {{runtime_URL}}/supplierdatapagination/v4/prod/processes/{processType}/templates?realm=myRealm
Refer to Supplier Data API with Pagination Header Parameters for information on header parameters and Supplier Data API with Pagination Query and Filter Parameters for information on query and filter parameters.
The following example shows a sample response for the templates endpoint:
{
"status": "OK",
"statusCode": 200,
"errorMessages": [],
"warnings": [],
"debugInfo": {
"requestProcessingTime": null,
"storeProcessingTime": null
},
"moreDataAvailable": false,
"nextToken": null,
"errorsByVendor": {},
"warningMessages": null,
"questionAnswers": [
{
"active": true,
"timeUpdated": null,
"timeCreated": null,
"purgeState": null,
"lastTimePurgeStateUpdated": null,
"parentUniqueName": null,
"uniqueName": null,
"itemId": "3942212",
"alternative": null,
"externalSystemCorrelationId": "KI_112257",
"processId": "PI875161",
"documentId": "Doc16095926",
"templateDocumentId": null,
"searchTerm": null,
"answer": null,
"enumerationCodeDelimiters": null,
"dataType": "String",
"multiValued": true,
"smVendorId": null,
"workspaceType": null,
"workspaceId": "WS16095921",
"type": null,
"totalQuestions": "11",
"questionnaireLabel": "Audit Process Form",
"questionLabel": "Enter Category",
"answerType": "CommodityType",
"rootId": null
},
{
"active": true,
"timeUpdated": null,
"timeCreated": null,
"purgeState": null,
"lastTimePurgeStateUpdated": null,
"parentUniqueName": null,
"uniqueName": null,
"itemId": "3942213",
"alternative": null,
"externalSystemCorrelationId": "KI_112258",
"processId": "PI875161",
"documentId": "Doc16095926",
"templateDocumentId": null,
"searchTerm": null,
"answer": null,
"enumerationCodeDelimiters": null,
"dataType": "String",
"multiValued": true,
"smVendorId": null,
"workspaceType": null,
"workspaceId": "WS16095921",
"type": null,
"totalQuestions": "11",
"questionnaireLabel": "Audit Process Form",
"questionLabel": "Enter Region",
"answerType": "RegionType",
"rootId": null
},
{
"active": true,
"timeUpdated": null,
"timeCreated": null,
"purgeState": null,
"lastTimePurgeStateUpdated": null,
"parentUniqueName": null,
"uniqueName": null,
"itemId": "3942214",
"alternative": null,
"externalSystemCorrelationId": "KI_10960765",
"processId": "PI875161",
"documentId": "Doc16095926",
"templateDocumentId": null,
"searchTerm": null,
"answer": null,
"enumerationCodeDelimiters": null,
"dataType": "String",
"multiValued": true,
"smVendorId": null,
"workspaceType": null,
"workspaceId": "WS16095921",
"type": null,
"totalQuestions": "11",
"questionnaireLabel": "Audit Process Form",
"questionLabel": "Enter Department",
"answerType": "DepartmentType",
"rootId": null
}
],
"templateId": "WS16095921",
"templateProcessId": "PI875154"
}