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

_idstring · objectidRequired

the identifier of the validation rules

cannotReleaseFutureWorkbooleanOptional

whether if future work cannot be released or not

cannotReleaseNegativeIncrementbooleanOptional

whether if negative increments cannot be released or not

cannotReleaseZeroIncrementbooleanOptional

whether if zero increments cannot be released or not

createdAtstring · iso-date-timeRequired

the date and time these rules were first created

Example: 2022-08-12T20:44:48Z

customerIdstring · objectidRequired

the identifier of customer who owns these validation rules

initiativeone ofOptional

the initiative that these validation rules apply to

or

or

any · nullableOptional

isSummaryRequiredbooleanOptional

whether summary is required for the entry or not

updatedAtstring · iso-date-timeRequired

the last date and time these rules were updated

Example: 2022-08-12T20:44:48Z

schemaVersionstringOptional

schema version

post

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

HTTPcURLJavaScriptPython

POST /api/v1/validations/customers/{customerId}/initiatives/{initiativeExternalId}/rules HTTP/1.1
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"
    }
  ]
}