Skip to main content

Get Task Definition

Endpoint: GET /api/metadata/taskdefs/{taskType}

Gets a single task definition from the cluster.

Path parameters​

ParameterDescriptionTypeRequired/Optional
taskTypeThe name of the task definition to be retrieved.stringRequired.

Query parameters​

ParameterDescriptionTypeRequired/Optional
metadataWhether metadata (such as tags) should be included in the response. Default is false.booleanOptional.

Response​

Returns the task definition and includes the metadata if queried.

Examples​

Get an individual task definition without metadata​

Get an individual task definition without metadata

Request

curl -X 'GET' \
  '<YOUR-CLUSTER>/api/metadata/taskdefs/simple?metadata=false' \
  -H 'accept: */*' \
  -H 'X-Authorization: <TOKEN>'

Response

{
  "createTime": 1736398189156,
  "updateTime": 1736398211995,
  "createdBy": "john.doe@acme.com",
  "updatedBy": "john.doe@acme.com",
  "name": "simple",
  "description": "test",
  "retryCount": 3,
  "timeoutSeconds": 3600,
  "inputKeys": [],
  "outputKeys": [
    "someOutputParameter"
  ],
  "timeoutPolicy": "TIME_OUT_WF",
  "retryLogic": "FIXED",
  "retryDelaySeconds": 60,
  "responseTimeoutSeconds": 600,
  "concurrentExecLimit": 0,
  "inputTemplate": {},
  "rateLimitPerFrequency": 0,
  "rateLimitFrequencyInSeconds": 1,
  "ownerEmail": "john.doe@acme.com",
  "pollTimeoutSeconds": 3600,
  "backoffScaleFactor": 1,
  "totalTimeoutSeconds": 0,
  "enforceSchema": false
}

Get an individual task definition with metadata​

Get an individual task definition with metadata

Request

curl -X 'GET' \
  'https://<YOUR-CLUSTER>/api/metadata/taskdefs/simple?metadata=true' \
  -H 'accept: */*' \
  -H 'X-Authorization: <TOKEN>'

Response

{
  "createTime": 1736398189156,
  "updateTime": 1736398211995,
  "createdBy": "john.doe@acme.com",
  "updatedBy": "john.doe@acme.com",
  "name": "simple",
  "description": "test",
  "retryCount": 3,
  "timeoutSeconds": 3600,
  "inputKeys": [],
  "outputKeys": [
    "someOutputParameter"
  ],
  "timeoutPolicy": "TIME_OUT_WF",
  "retryLogic": "FIXED",
  "retryDelaySeconds": 60,
  "responseTimeoutSeconds": 600,
  "concurrentExecLimit": 0,
  "inputTemplate": {},
  "rateLimitPerFrequency": 0,
  "rateLimitFrequencyInSeconds": 1,
  "ownerEmail": "john.doe@acme.com",
  "pollTimeoutSeconds": 3600,
  "backoffScaleFactor": 1,
  "totalTimeoutSeconds": 0,
  "enforceSchema": false,
  "overwriteTags": true,
  "tags": []
}