Jump to

• Request
• Response

Retrieve Task Workflow by ID

get

/api/1.0/taskworkflow/{id}

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

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id: string
  ID of the user that needs to be fetched.

Query Parameters

• version: string
  Version of the data that needs to be fetched.

Header Parameters

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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns the Task Workflow based on given ID.

Body ()

Root Schema : DmTmTaskWorkflowWrapperDTO

Type: object

Task Workflow Wrapper Data transfer object

Show Source

• data(optional): object DmTmTaskWorkflowDTO
  Task Workflow Data transfer Object

{
    "description":"Task Workflow Wrapper Data transfer object",
    "type":"object",
    "properties":{
        "data":{
            "description":"Data",
            "$ref":"#/definitions/DmTmTaskWorkflowDTO"
        }
    }
}

Nested Schema : DmTmTaskWorkflowDTO

Type: object

Task Workflow Data transfer Object

Match All

Show Source

• allOf GenericDto
• object DmTmTaskWorkflowDTO-allOf[1]

{
    "description":"Task Workflow Data transfer Object",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "workflowCd":{
                    "description":"Workflow Code",
                    "type":"string"
                },
                "workflowDesc":{
                    "description":"Workflow Description",
                    "type":"string"
                },
                "DmTmTaskWorkflowStatusDetailsDTO":{
                    "description":"Task Workflow Status Details data transfer Object.",
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/DmTmTaskWorkflowStatusDetailsDTO"
                    }
                }
            }
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

• object GenericDto-allOf[0]
  Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : DmTmTaskWorkflowDTO-allOf[1]

Type: object

Show Source

• DmTmTaskWorkflowStatusDetailsDTO(optional): array DmTmTaskWorkflowStatusDetailsDTO
  Task Workflow Status Details data transfer Object.
• workflowCd(optional): string
  Workflow Code
• workflowDesc(optional): string
  Workflow Description

{
    "type":"object",
    "properties":{
        "workflowCd":{
            "description":"Workflow Code",
            "type":"string"
        },
        "workflowDesc":{
            "description":"Workflow Description",
            "type":"string"
        },
        "DmTmTaskWorkflowStatusDetailsDTO":{
            "description":"Task Workflow Status Details data transfer Object.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmTmTaskWorkflowStatusDetailsDTO"
            }
        }
    }
}

Nested Schema : DmTmTaskWorkflowStatusDetailsDTO

Type: array

Task Workflow Status Details data transfer Object.

Show Source

• Array of: object DmTmTaskWorkflowStatusDetailsDTO
  task Workflow Status Details data transfer object

{
    "description":"Task Workflow Status Details data transfer Object.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/DmTmTaskWorkflowStatusDetailsDTO"
    }
}

Nested Schema : DmTmTaskWorkflowStatusDetailsDTO

Type: object

task Workflow Status Details data transfer object

Show Source

• active(optional): string
  Active
• currentStatus(optional): string
  Current Status
• id(optional): string
  ID
• nextStatus(optional): string
  Next Status
• ruleId(optional): string
  Rule ID
• srNo(optional): integer
  Serial Number
• taskworkflowMasterId(optional): string
  Task Workflow Master ID
• type(optional): string
  Type

{
    "description":"task Workflow Status Details data transfer object",
    "type":"object",
    "properties":{
        "ruleId":{
            "description":"Rule ID",
            "type":"string"
        },
        "srNo":{
            "description":"Serial Number",
            "type":"integer"
        },
        "currentStatus":{
            "description":"Current Status",
            "type":"string"
        },
        "nextStatus":{
            "description":"Next Status",
            "type":"string"
        },
        "type":{
            "description":"Type",
            "type":"string"
        },
        "active":{
            "description":"Active",
            "type":"string"
        },
        "id":{
            "type":"string",
            "description":"ID"
        },
        "taskworkflowMasterId":{
            "type":"string",
            "description":"Task Workflow Master ID"
        }
    }
}

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