Validation Rules

post

Authorizations

ApiBearerAuth

AuthorizationstringRequired

Enter access token

Path parameters

customerIdstring · objectidRequired

customer id

initiativeExternalIdstringRequired

initiative's external id

Body

application/json

requiredCodeTypeExternalIdsstring[]Optional

code type external identifiers that are required for an entry

Responses

200Success

application/json

post

/api/v1/validations/customers/{customerId}/initiatives/{initiativeExternalId}/rules

HTTPcURLJavaScriptPython

POST /api/v1/validations/customers/{customerId}/initiatives/{initiativeExternalId}/rules HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "requiredCodeTypeExternalIds": [
    "text"
  ]
}

200Success

{
  "_id": "text",
  "cannotReleaseFutureWork": true,
  "cannotReleaseNegativeIncrement": true,
  "cannotReleaseZeroIncrement": 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"
    }
  ]
}