REST V1 Approval Task Response

Response

AttributesTypeDescription
taskIdLongThe task id of the approval task.
statusStringThe status of the approval task.
environmentIdLongThe environment Id of the approval task.
requestTypeStringThe request type of the approval task. The request type can be a release, application, or project request.
flexFieldsList<FlexField>The list of flex fields for the approval task.
requestorPathStringThe requestor path of the approval task. 
externalIdStringThe externalId of the approval task. If the approval task is not an external approval task this will be null.
externalSystemIdLongThe externalSystemId of the approval task. If the approval task is not an external approval task this will be null.
externalSystemTypeStringThe externalSystemType of the approval task. If the approval task is not an external approval task this will be null.
notesStringNotes the requestor entered when approving or rejecting the task
linksList<Link>List of any relevant links for the object.

Each approval task can be one of three different types: Release, Application, and Project.

Release Approval Task

AttributesTypeDescription
snapshotIdLongThe snapshot id of the release approval task.
pipelineNameStringThe pipeline name of the release approval task.
environmentNameStringThe environment name of the release approval task.
gateNameStringThe gate name of the release approval task.
releaseNameStringThe release name of the release approval task.
releaseDefinitionIdLongThe release definition Id of the release approval task. 
releaseSnapshotStringThe release snapshot of the release approval task.
pipelineStageGateExecIdLongThe pipeline stage execution Id of the release approval task.
notesStringNotes entered when approving or rejecting the task

Application Approval Task

AttributesTypeDescription
applicationIdLongThe application id of the application approval task.
applicationNameStringThe application name of the application approval task.
folderVersionNameStringThe folder version name of the application approval task.
folderRequestIdStringThe folder request Id of the application approval task.
notesStringNotes entered when approving or rejecting the task

Project Approval Task

AttributesTypeDescription
projectIdLongThe project id of the project approval task.
projectNameStringThe prohect name of the project approval task.
projectVersionNameStringThe project version name of the project approval task.
workflowRequestIdLongThe workflow request id of the project approval task.
notesStringNotes entered when approving or rejecting the task

Link

AttributeTypeDescription
typeStringType of the link "REST", "UI"
linkStringPhysical link of the object.

The following macros are not currently supported in the footer:
  • style