Use of the Supplier Data API with Pagination headerFields Endpoint

The Supplier Data API with Pagination headerFields endpoint uses the PATCH method to send a JSON request to your site. The request sets region IDs and status decisions for process projects.

The PATCH URL includes query and filter parameters, and the request header specifies authentication.

Method

Endpoint

Description

PATCH

{{runtime_url}}/supplierdatapagination/v4/prod/{vendorID}/workspaces/{workspaceId}/headerFields

Updates the regions or status decisions of a process.

This endpoint is only applicable if your site uses the process project feature (SM-16798).

A JSON request that the headerFields endpoint sends to your site can either update region IDs or update status decisions, but the same request can't do both. Requests can include the following name/value pairs or arrays:

Name/Value Pair or Array

Valid Values

Required?

regionIds

One or more of the region codes loaded in your site as master data and used in supplier management projects, separated by commas.

Yes, to update the region. Otherwise, no.

If a value is specified for regionIds, decisionStatus, decisionComment, and decisionMadeBy are ignored.

decisionStatus

Values for this field are:
  • Approved

  • ConditionallyApproved

  • Denied

For details, refer to Project states (ProjectStatus) and custom supplier process management statuses.

To set a status decision for the process, all 3 are required. Otherwise, no.

decisionComment

A comment to explain the decision, with a maximum length of 255 characters.

decisionMadeBy

The user name of the decision maker. The user you specify must be a member of the Decision Maker group in the process project template.

The following example shows a request body that updates a region for a process:
{
	"regionIds": ["NAMER","LATAM"],
		}
The following example shows a request body that sets a status decision for a process:
{
"regionIds": [],
"decisionStatus": "Approved",
"decisionMadeBy": "ebrown",
"decisionComment": "All questionnaires are approved with high scores."
}

You can use the headerFields endpoint of the Supplier Data API with Pagination in combination with the External Approval API for Sourcing and Supplier Management to both approve a process's modular questionnaires and set its final status externally.