POST /api/v3/developmentplan/v1/types

Permissions to Run the Request

Account Owner and Account Administrators

Request Headers and Parameters

HeaderDescription
Authorization (required)Access token. You can obtain a token by making a request.
Content-Type: application/json
(required)
Property for processing a request in JSON
Accept: application/json
(required)
Property for processing a request in JSON
ParameterDescription

ids

Development plan type IDs

statuses

Development plan type statuses

Response Parameters

ParameterTypeDescription
items []Array of objectsList of development plan types
idstring(uuid)Development plan type ID
titlestringDevelopment plan type title
descriptionstringDevelopment plan type description
statusstring

Development plan type status

  • PUBLISHED — the plan type is published
  • HIDDEN — the plan type is hidden
inUsebooleanIndicates whether the development plan type is in use
typestring

Development plan type category

  • ADAPTATION — adaptation plan
  • INDIVIDUAL_PLAN — individual development plan
  • CUSTOM — custom plan type
resultsArray of objectsList of possible results for development plans of this type

Elements of the results [] array

ParameterTypeDescription
titlestringResult name
valuestring

Result value

  • ACCEPTED — the plan is accepted
  • NOT_ACCEPTED — the plan is not accepted

Response Codes

CodeTextDescription
200

ОК

The request has been successfully processed
400Bad Request

The request contains invalid parameters or has an invalid format

401 UnauthorizedAuthorization failed. The access token is missing, invalid, or expired
403

Permission Denied

No permission to run this request. Only the Account Owner and Account Administrators can run this request.

Sample Response

{
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "string",
      "description": "string",
      "status": "PUBLISHED",
      "inUse": true,
      "type": "ADAPTATION",
      "results": [
        {
          "title": "string",
          "value": "ACCEPTED"
        }
      ]
    }
  ]
}
CODE