Jump to

• Request
• Response

Retrieve Task Type by ID

get

/api/1.0/tasktype/{id}

This endpoint is used to retrieve the Task Type by ID.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id(required): string
  ID of the user that needs to be fetched

Query Parameters

• version(required): string
  ID of the user that needs to be fetched

Header Parameters

• appId(required): string
  The application ID of host service.
• branchCode(required): string
  The branch code of requesting branch.
• contentType: string
  The content type of request or response body.
• userId(required): string
  The user ID of requesting user.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns the task type based on given ID.

Body ()

Root Schema : DmTmTaskTypeWrapperDTO

Type: object

Show Source

• data: object DmTmTaskTypeDTO
  The task type dto

{
    "type":"object",
    "properties":{
        "data":{
            "$ref":"#/definitions/DmTmTaskTypeDTO"
        }
    }
}

Nested Schema : DmTmTaskTypeDTO

Type: object

The task type dto

Show Source

• taskCd: string
  The task Cod of the task type
• taskTypeCd: string
  The task Type Code of the task type
• taskTypeDesc: string
  The task Type Desc of the task type
• workflowCd: string
  The workflowCd of the task type

{
    "description":"The task type dto",
    "properties":{
        "taskTypeCd":{
            "description":"The task Type Code of the task type",
            "type":"string"
        },
        "taskTypeDesc":{
            "description":"The task Type Desc of the task type",
            "type":"string"
        },
        "taskCd":{
            "description":"The task Cod of the task type",
            "type":"string"
        },
        "workflowCd":{
            "description":"The workflowCd of the task type",
            "type":"string"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error.

Back to Top