Skip to navigation

Create RequestV2Definition

Beta
Create RequestV2Definition.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

EARLY-ACCESSstringOptional

Set to true to access beta operations via /api/v3.

Request

This endpoint expects an object.
namestringRequired
Name of the request template. Must not be empty, must not exceed 255 characters, and must not contain a null character.
prefixstringRequired
Prefix for the displayId of requests created from this template.
taskSchemaIdstringRequired
API ID of the workflow task schema that defines the task structure and fields for this request template.
templateCollectionIdstringRequired
API ID of the template collection that this request template belongs to.
descriptionstring or nullOptional
Description of the request template. Must not exceed 1024 characters and must not contain a null character.

Response

Created
archiveReasonstring or nullOptional
archivedbooleanOptional
createdAtstring or nullOptionalformat: "datetime"
creatorobjectOptional
descriptionstring or nullOptional
Description of the request template.
idstringOptional
modifiedAtstring or nullOptionalformat: "datetime"
namestringOptional
prefixstringOptional
The prefix for the displayId of tasks of this schema.
templateCollectionobjectOptional
webUrlstring or nullOptional
workflowTaskSchemaobjectOptional
The task schema backing this configuration.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error