|
The dataset API allows consuming the return of queries created within sets recorded in the system. These sets need to use the default data source of the system (SESUITE).
Input parameters
|
ID #
|
Type
|
Description
|
identifier
|
PATH
|
ID # of the dataset to be consumed
|
Set parameters
|
BODY
|
Parameters added to the dataset. All parameters recorded in the dataset must be sent for a successful request.
|
Request body (Example)
|
{
"idParam1": 1234,
"idParam2": "value"
}
|
Example of the return JSON (in case of success)
|
[
{
"cduser": 1,
"idlogin": "string",
"nmuser": "string"
},
{
"cduser": 2,
"idlogin": "string",
"nmuser": "string"
},
{
"cduser": 3,
"idlogin": "string",
"nmuser": "string"
}
]
|
▪The structure of return fields varies according to those returned by the query and mapped in the dataset. The return above is just a simple example with a table of the system's users. Fields that return null values will return "" (empty) instead.
▪For each line returned by the query, it will be serialized in the form of a JSON object in the API return. Only the first 10000 records will be returned as objects.
|
Return (in case of error)
|
ID #
|
Description
|
message
|
Message explaining the error found
|
status
|
Return HTTP code
|
Mapped codes
|
HTTP code
|
Description
|
200 (OK)
|
It occurs when the resource is able to consume the dataset successfully and bring its results
|
400 (Bad request)
|
It occurs when an invalid dataset or a dataset with characteristics not supported by the resources is entered
|
404 (Not found)
|
It occurs when an invalid dataset ID # is entered, or when that user has not permission to view/edit
|
500 (Internal server error)
|
It occurs when an unexpected error is returned by the resource, or in case of query execution timeout
|
503 (Service unavailable)
|
It occurs when the sesuite job is overloaded as to the JVM memory usage
|
|
