Jump to

• Request
• Response

Get task history data

get

/api/1.0/collectordashboard/taskhistory/{timeFrame}

based on the time frame specified.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• timeFrame(required): string
  Time frame code is used to fetch task history date.

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 count of tasks within different intervals.

Body ()

Root Schema : TaskHistoryWrapperDto

Type: object

Show Source

• TaskHistoryDto: object TaskHistoryDto

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

Nested Schema : TaskHistoryDto

Type: object

Show Source

• taskTypeCountDtoList: array taskTypeCountDtoList
• timeFrame: string

{
    "type":"object",
    "properties":{
        "timeFrame":{
            "type":"string"
        },
        "taskTypeCountDtoList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TaskTypeCountDto"
            }
        }
    }
}

Nested Schema : taskTypeCountDtoList

Type: array

Show Source

• Array of: object TaskTypeCountDto

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

Nested Schema : TaskTypeCountDto

Type: object

Show Source

• actionResultsCountDtoList: array actionResultsCountDtoList
• count: integer
• description: string
• taskCodeCountDtoList: array taskCodeCountDtoList
• taskType: string

{
    "type":"object",
    "properties":{
        "taskType":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "count":{
            "type":"integer"
        },
        "taskCodeCountDtoList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TaskCodeCountDto"
            }
        },
        "actionResultsCountDtoList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ActionResultsCountDto"
            }
        }
    }
}

Nested Schema : actionResultsCountDtoList

Type: array

Show Source

• Array of: object ActionResultsCountDto

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

Nested Schema : taskCodeCountDtoList

Type: array

Show Source

• Array of: object TaskCodeCountDto

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

Nested Schema : ActionResultsCountDto

Type: object

Show Source

• count: integer
• description: string
• resultCode: string

{
    "type":"object",
    "properties":{
        "resultCode":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "count":{
            "type":"integer"
        }
    }
}

Nested Schema : TaskCodeCountDto

Type: object

Show Source

• count: integer
• description: string
• taskCode: string

{
    "type":"object",
    "properties":{
        "taskCode":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "count":{
            "type":"integer"
        }
    }
}

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