Use of the Supplier Data API with Pagination processCreateRequests Endpoint
The Supplier Data API with Pagination processCreateRequests endpoint uses the POST method to send a JSON request to your site. The request creates a process for a supplier with a given process type.
|
Method |
Endpoint |
Description |
|---|---|---|
|
POST |
{{runtime_URL}}/supplierdatapagination/v4/prod/processes/processCreateRequests |
Creates the process for one supplier at a time using the specified process type. |
POST {{runtime_URL}}/supplierdatapagination/v4/prod/processes/processCreateRequests?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.
If a process with the same matrix combination (Category, Region, and Department) does not exist, a new process is created.
-
If a process for the same matrix combination already exists, then:
-
the system returns an error if a decision has not been taken on that process
-
the existing process is renewed if a decision has already been taken on that process
-
The process initiator is also the process owner, and this value is passed in the request body as shown below in the sample request body.
The JSON request that the processCreateRequests endpoint of the Supplier Data API with Pagination sends to your site uses the following values to specify the data you want to return in output:
| Value | Description | Mandatory/ Not Mandatory |
|---|---|---|
|
aribaLifeCycle |
Qualification or Miscellaneous. |
Mandatory |
|
templateId |
The templateID is retrieved from the response returned by the /processes/{processType}/templates endpoint. |
Mandatory |
|
templateProcessId |
The templateProcessID is retrieved from the response returned by the /processes/{processType}/templates endpoint. |
Mandatory |
|
expiryDetail |
Provide data only if expiry details are required as part of the qualification or process flow and if the field is present in the intake form. |
Not Mandatory |
|
smVendorId |
The vendor ID for which the qualification is to be created. |
Mandatory |
|
recipient |
The user name and email address of the questionnaire recipient. If you don't specify recipient, the default recipient (primary supplier contact for external questionnaires, process initiator for internal questionnaires) is used. |
Mandatory |
|
matrix |
Commodity, Region, Department. |
Mandatory |
|
currentProcessId |
Provide the current process ID only when renewing a qualification, using the process ID of the existing qualification. |
Not Mandatory |
|
questionnaireType |
The questionnaire type of the modular questionnaire which also determines the process type. |
Mandatory |
|
externalSystemCorrelationId |
Unique identifier for a piece of content within an individual questionnaire. |
Mandatory |
|
processCreationMessage |
Message to include in notifications sent to the supplier contact and process project team members. |
Mandatory |
{
"aribaLifeCycle": "Qualification",
"templateId": "WS16095921",
"templateProcessId": "PI875154",
"workspaceId": "",
"entityType": 0,
"processType": "Data Security",
"expiryDetail": {
"expiryOffset": null,
"expiryFrequency": "Days",
"expiryReminderOffset": null,
"expiryReminderFrequency": "days"
},
"templateIds": null,
"smProcessVendors": [
{
"smVendorId": "S10111701",
"currentProcessId": "SMP-8bab520f-af8f-4577-ad7b-5625933bbad7",
"isRenew": true,
"recipient": {
}
}
],
"matrix": {
"categoryIds": [
"30"
],
"regionIds": [
"SOAM"
],
"departmentIds": [
"100"
],
"materialIds": []
},
"questionnaires": [
{
"title": "Internal Audit for US",
"internalId": "WS15013638",
"questionnaireType": "Audit Process",
"requestUpdate": false,
"isInternal": true,
"isRequired": false,
"sendToUser": true,
"recipient": {
"s4UniqueName": "bobsmith",
"email": "bsmith@buyer.com",
"passwordAdapter": "PasswordAdapter1"
}
},
{
"title": "Internal Audit for Texas",
"internalId": "WS3486356",
"questionnaireType": "Audit Process",
"requestUpdate": false,
"isInternal": true,
"isRequired": false,
"sendToUser": true,
"recipient": {
"s4UniqueName": "alicejones",
"email": "ajones@buyer.com",
"passwordAdapter": "PasswordAdapter1"
}
}
],
"answers": [
{
"itemId": "5009971",
"externalSystemCorrelationId": "KI_232650",
"multiValueAnswer": [
"30"
]
},
{
"itemId": "5009972",
"externalSystemCorrelationId": "KI_232651",
"multiValueAnswer": [
"SOAM"
]
},
{
"itemId": "5009973",
"externalSystemCorrelationId": "KI_232652",
"multiValueAnswer": [
"100"
]
}
],
"processCreationMessage": "string",
"initiatorName": "jarvis",
"initiatorEmail": "string",
"initiatorPassword": "PasswordAdapter1"
}
The following example shows a sample response for a processCreateRequests endpoint:
{
"status": "OK",
"statusCode": 200,
"errorMessages": [],
"warnings": [],
"debugInfo": {
"requestProcessingTime": null,
"storeProcessingTime": null
},
"moreDataAvailable": false,
"nextToken": null,
"errorsByVendor": {},
"warningMessages": null,
"duplicateSuppliers": []
}