Get All Elements

Intro

With this API you can retrieve all the executions made to the CEP service

Important Points

Services
In order to retrieve the specific information of a service, you must indicate as a path paramater which service you want to retrieve.
Here are the possible values for the path parameter "service"

• validate, to retrieve the items consulted in Obtain CEP
• validate+pdf, to retrieve the items consulted in Obtain CEP + PDF

Pagination Parameters

The next two pagination parameters are mandatory to do the request.

• itemsPerPage, number of items by page, should be integer value between [1, 1000]
• page, number of recovered page, should be integer value greater than 0

The next errors can be returned if there is a problem with the request body or the execution of this service:

"itemsPerPage": ERROR_QUERY_PARAM_FORMAT; indicates that should be an integer value between 1 and 1000
"page": ERROR_QUERY_PARAM_FORMAT;  indicates that should be an integer value greater than 0

Response
Kiban will return a list of items with the next structure:

{
    "currentPage": 1,
    "hasNextPage": false,
    "items": [
        {
            "id": "640299c9b37cb2ea804e6939",
            "createdAt": "2023-03-04T01:07:21.997Z",
            "finishedAt": "2023-03-04T01:07:22.372Z",
            "duration": 375287745,
            "status": "SUCCESS"
        },
        {
            "id": "640299c7b37cb2ea804e6937",
            "createdAt": "2023-03-04T01:07:19.44Z",
            "finishedAt": "2023-03-04T01:07:19.702Z",
            "duration": 261694132,
            "status": "SUCCESS"
        }
    ]
}

• currentPage, the actual recovered page
• hasNextPage, indicate if there are more pages
• items, list of items in the request
  • id, identifier of the request.
  • createdAt, date time with the exact moment of creation.
  • finishedAt, date time with the exact moment of finalization.
  • duration, indicates how long it took to execute the service.
  • status, status of the request