v1

latestOpenAPI 3.0.12026-07-245752052.0 MB

requirements

Find and update a requirement

Partially update one existing requirement

put/api/servicecompliancev2/requirements/{identifier}

Path parameters

identifierstring uuid required

requirement unique identifier

Request body

namestring required

segmentUuidsstring[] required

fulfillmentDocumentTypeUuidsstring[] required

status'INACTIVE' | 'ACTIVE' | 'ARCHIVED' required

isPapiHireStageOptionTypeboolean

multiDocumentboolean

hideFromWorkersboolean

type'DOCUMENT' | 'BACKGROUND_CHECK'

Response

updated requirement.

Example response

{
  "meta": {
    "timestamp": "2021-05-05T09:47:58.924Z",
    "verb": "GET",
    "path": "/api/structure/resources/5949cf7c-fec6-4b31-947c-3aceabff58c5",
    "jti": "%cQN3RIGp",
    "rid": "$2d2zkHZ5",
    "count": 1,
    "status": "200",
    "duration": 17,
    "size": 1234
  }
}