Validation Rules

post

Authorizations

Path parameters

customerIdstring · objectidrequired

customer id

initiativeExternalIdstringrequired

initiative's external id

Body

requiredCodeTypeExternalIdsstring[]optional

code type external identifiers that are required for an entry

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v1/validations/customers/{customerId}/initiatives/{initiativeExternalId}/rules' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "requiredCodeTypeExternalIds": [
      "text"
    ]
  }'

200

200

{
  "_id": "text",
  "cannotReleaseFutureWork": true,
  "createdAt": "2022-08-12T20:44:48Z",
  "customerId": "text",
  "initiative": {
    "type": "pms",
    "_id": "text",
    "billingType": "billable",
    "callSign": "text",
    "unitIncrements": 1,
    "externalId": "text",
    "name": "text",
    "description": "text",
    "client": {
      "_id": "text",
      "externalId": "text",
      "name": "text",
      "description": "text",
      "callSign": "text"
    }
  },
  "isSummaryRequired": true,
  "updatedAt": "2022-08-12T20:44:48Z",
  "schemaVersion": "text",
  "requiredCodeTypes": [
    {
      "_id": "text",
      "externalId": "text",
      "name": "text",
      "semanticType": "action"
    }
  ]
}