Get attribute config of dispatch

1min

GET
API to get specific job details by dispatch ID. |  Header/Path   |   Description  |   Type    |

|---  |---  |---  |

|  X-COREOS-REQUEST-ID* (header)   | Unique request ID.    |   string  |
|  X-USER-ID* (header)   | User ID.    |   string  |
|  X-USER-NAME* (header)   | User name.    |   string  |
|  X-COREOS-TID* (header)   | Tenant ID.    |   string  |
*This is required.
HTTP Status Code Summary
CodeDescription
200 - OKEverything worked as expected.
400 - Bad RequestThe request was unacceptable, often due to missing a required parameter.
401 - UnauthorizedNo valid API key provided.
404 - Not FoundThe requested resource doesn't exist.
Path Parameters
dispatchTypeId
SystemGeneratedId
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
*
Responses
200
OK
object
error
Error
*
request
Request
*
data
AttributesConfig
400
Error Occurred
ErrorResponse
error
Error
*
request
Request
*
401
Error Occurred
ErrorResponse
error
Error
*
request
Request
*
404
Error Occurred
ErrorResponse
error
Error
*
request
Request
*
Curl
JS
Ruby
Python
curl --location --globoff 'https://{domain}/core/api/v2/dispatch-service/dispatch-types/{dispatchTypeId}/config/attributes' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff 'https://{domain}/core/api/v2/dispatch-service/dispatch-types/{dispatchTypeId}/config/attributes' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
400
401
404
// OK 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "attributes": [
      {
        "name": "",
        "description": "",
        "tags": [
          ""
        ],
        "dataType": "",
        "indexed": false,
        "defaultValue": {},
        "validation": {
          "range": {
            "min": 0,
            "max": 0
          },
          "regex": "",
          "valueOneOf": [
            ""
          ],
          "required": false
        }
      }
    ],
    "_event_meta": {}
  }
}
// OK 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "attributes": [
      {
        "name": "",
        "description": "",
        "tags": [
          ""
        ],
        "dataType": "",
        "indexed": false,
        "defaultValue": {},
        "validation": {
          "range": {
            "min": 0,
            "max": 0
          },
          "regex": "",
          "valueOneOf": [
            ""
          ],
          "required": false
        }
      }
    ],
    "_event_meta": {}
  }
}
﻿
﻿

Code	Description
200 - OK	Everything worked as expected.
400 - Bad Request	The request was unacceptable, often due to missing a required parameter.
401 - Unauthorized	No valid API key provided.
404 - Not Found	The requested resource doesn't exist.

Updated 03 Aug 2023

Did this page help you?

Status update for an Execution Worklow using workflow id

Post attribute config for dispatch