Jump to

• Request
• Response

Get All Valid Task Type

get

/api/1.0/tasktype

This endpoints is used to Get all the valid Task Type Maintenance records.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• authStat(optional): string
  Authorization status that needs to be fetched.
• includecloseandunauth(optional): boolean
  Include close and unauthorized need to be set to fetch summary record, default value is false.
• limit(optional): integer
  Limit is maximum no of records to be fetched.
• offset(optional): integer
  Offset is starting no of records to be fetched.
• recordStat(optional): string
  Record status that needs to be fetched.
• taskCd(optional): string
  Task Code that needs to be fetched.
• taskTypeCd(optional): string
  Task Type Code that needs to be fetched.
• taskTypeDesc(optional): string
  Task Type Description 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

201 Response

Returns message of success or failure.

Headers

• Location: string
  URL of newly created Task Type

Body ()

Root Schema : DmTmTaskTypeCollection

Type: object

Collection of tasktype.

Show Source

• data(optional): array data
• paging(optional): object PagingDto

{
    "description":"Collection of tasktype.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmTmTaskTypeDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object DmTmTaskTypeDTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : DmTmTaskTypeDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object DmTmTaskTypeDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "taskTypeCd":{
                    "description":"taskTypeCd of the tasktype",
                    "type":"string"
                },
                "taskTypeDesc":{
                    "description":"taskTypeDesc of the tasktype",
                    "type":"string"
                },
                "taskCd":{
                    "description":"taskCd of the tasktype",
                    "type":"string"
                },
                "workflowCd":{
                    "description":"workflowCd of the tasktype",
                    "type":"string"
                }
            }
        }
    ]
}

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 : DmTmTaskTypeDTO-allOf[1]

Type: object

Show Source

• taskCd(optional): string
  taskCd of the tasktype
• taskTypeCd(optional): string
  taskTypeCd of the tasktype
• taskTypeDesc(optional): string
  taskTypeDesc of the tasktype
• workflowCd(optional): string
  workflowCd of the tasktype

{
    "type":"object",
    "properties":{
        "taskTypeCd":{
            "description":"taskTypeCd of the tasktype",
            "type":"string"
        },
        "taskTypeDesc":{
            "description":"taskTypeDesc of the tasktype",
            "type":"string"
        },
        "taskCd":{
            "description":"taskCd of the tasktype",
            "type":"string"
        },
        "workflowCd":{
            "description":"workflowCd of the tasktype",
            "type":"string"
        }
    }
}

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