Jump to

• Request
• Response

Fetch Action Results based on TaskId

post

/api/1.0/collectordashboard/actionResultsCountByTaskId

This endpoint is used to Fetch Action Results based on the provided task Id's.

Request

Supported Media Types

• application/json
• application/xml

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.
• entityId(required): string
  The entity ID of host service.
• userId(required): string
  The user ID of requesting user.

Body ()

Request Body contains data required to Fetch Action Results.

Root Schema : tasksIdCollForActionResultCount

Type: object

Collection of Task Id's list and Start Date, End Date for data filtration .

Show Source

• pastDate: string
  End Date used for data Filtration.
• startDate: string
  Start Date used for data Filtration.
• taskIdList: array taskIdList
  List of Task Id's.

{
    "description":"Collection of Task Id's list and Start Date, End Date for data filtration .",
    "type":"object",
    "properties":{
        "taskIdList":{
            "type":"array",
            "description":"List of Task Id's.",
            "items":{
                "type":"string"
            }
        },
        "startDate":{
            "type":"string",
            "description":"Start Date used for data Filtration."
        },
        "pastDate":{
            "type":"string",
            "description":"End Date used for data Filtration."
        }
    }
}

Nested Schema : taskIdList

Type: array

List of Task Id's.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of Task Id's.",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of success or failure

Headers

• Location: string
  Action Results Count

Body ()

Root Schema : actionResultsCountColl

Type: object

Collection of Action Results Count.

Show Source

• actionResultsCountDtoList: array actionResultsCountDtoList
  List of Action Results count DTO's.

{
    "description":"Collection of Action Results Count.",
    "type":"object",
    "properties":{
        "actionResultsCountDtoList":{
            "type":"array",
            "description":"List of Action Results count DTO's.",
            "items":{
                "$ref":"#/definitions/ActionResultsCountDto"
            }
        }
    }
}

Nested Schema : actionResultsCountDtoList

Type: array

List of Action Results count DTO's.

Show Source

• Array of: object ActionResultsCountDto

{
    "type":"array",
    "description":"List of Action Results count DTO's.",
    "items":{
        "$ref":"#/definitions/ActionResultsCountDto"
    }
}

Nested Schema : ActionResultsCountDto

Type: object

Show Source

• count: integer
  Count
• description: string
  Description
• resultCode: string
  Result Code

{
    "type":"object",
    "properties":{
        "resultCode":{
            "type":"string",
            "description":"Result Code"
        },
        "description":{
            "type":"string",
            "description":"Description"
        },
        "count":{
            "description":"Count",
            "type":"integer"
        }
    }
}

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