Jump to

• Request
• Response

Escalate Tasks by Task ID

put

/api/1.0/taskSummary/task/escalate

This endpoint is used to escalate tasks By Task ID.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId: string
  The application ID of host service.
• branchCode: string
  The branch code of requesting branch.
• userId: string
  The user ID of requesting user.

Body ()

Request Body contain task data required for escalating tasks.

Root Schema : DmEscalateTaskCollection

Type: object

Collection of Task data required for escalation.

Show Source

• dmEscalateTaskDTOs(optional): array dmEscalateTaskDTOs
  Escalate task details.

{
    "description":"Collection of Task data required for escalation.",
    "type":"object",
    "properties":{
        "dmEscalateTaskDTOs":{
            "description":"Escalate task details.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmEscalateTaskDTO"
            }
        }
    }
}

Nested Schema : dmEscalateTaskDTOs

Type: array

Escalate task details.

Show Source

• Array of: object DmEscalateTaskDTO
  Data required for Task escalation

{
    "description":"Escalate task details.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/DmEscalateTaskDTO"
    }
}

Nested Schema : DmEscalateTaskDTO

Type: object

Data required for Task escalation

Show Source

• accountId(optional): string
  Account ID
• isAdhocTask(optional): boolean
  If Adhoc Task
• taskId(optional): string
  Task ID
• taskName(optional): string
  Task Name
• taskStatusCd(optional): string
  Task Status Code

{
    "description":"Data required for Task escalation",
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "description":"Account ID"
        },
        "taskId":{
            "type":"string",
            "description":"Task ID"
        },
        "taskName":{
            "type":"string",
            "description":"Task Name"
        },
        "taskStatusCd":{
            "type":"string",
            "description":"Task Status Code"
        },
        "isAdhocTask":{
            "type":"boolean",
            "description":"If Adhoc Task"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of success or failure of escalation.

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Show Source

• data(optional): object ResponseResourceSupport
• messages(optional): object ResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Type: object

Nested Schema : ResponseDto

Type: object

Show Source

• codes(optional): array codes
• id(optional): string
• requestId(optional): string
• status(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

• Array of: object ResponseCode

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ResponseCode"
    }
}

Nested Schema : ResponseCode

Type: object

Show Source

• arg(optional): string
• args(optional): array args
• Code(optional): string
• Desc(optional): string
• Language(optional): string
• Type(optional): string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string"
        }
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input.

500 Response

Internal error.

Back to Top