.png){kind=logo}
JobDatasetValues
- 22 Nov 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
JobDatasetValues
- Updated on 22 Nov 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Job Dataset Values
/v1/dru/jobdatasetvalues/
The Data Reporting Utility enables users to define aggregation jobs and generate aggregated results. The job definitions and results are stored in your database and can be accessed through this API
List Of Dataset Values aggregated from a Data Reporting Utility Job.
Example for calling:
http://server/v1/dru/jobdatasetvalues?id=2 – retrieves values from the job with id 2
Allowed Methods:
[GET]
API Controller: dru_jobresult
Description:
- Retrieves aggregated results of a Job.
Parameters:
| Name | Type | Description | Notes |
|---|---|---|---|
| id | integer | The ID of the Job | Mandatory |
Response Fields:
| Name | Type | Description | Notes |
|---|---|---|---|
| job_id | integer | The ID of the Job | |
| jobdatafield_id | integer | The ID of the datafield | |
| group | group[] | The groups of the dataset result, see jobdatasetvalues.group | |
| period | period[] | Period of the Dataset, see jobdatasetvalues.period | |
| value | value[] | Aggregated values found in the Dataset result, see jobdatasetvalues.value |
jobdatasetvalues.group
The groups of the Dataset result
Group table
| Name | Type | Description | Notes |
|---|---|---|---|
| short1 | string | The short value of group 1 | |
| short2 | string | The short value of group 2 | |
| short3 | string | The short value of group 3 | |
| short4 | string | The short value of group 4 | |
| short5 | string | The short value of group 5 |
jobdatasetvalues.period
Period found in the Dataset result. The number of items idenfies the numer of periods of the result set
Period table
| Name | Type | Description | Notes |
|---|---|---|---|
| start | datetime | ||
| finish | datetime | At times aligns with the cutoff date |
jobdatasetvalues.value
Aggregated values found in the Dataset result
Value table
| Name | Type | Description | Notes |
|---|---|---|---|
| period | float | Aggregated value | |
| cumulative | float | Aggregated value | |
| manpower | float | Aggregated value |
Show JSON Response
json result
[
{
"job_id": 1,
"jobdatafield_id": 1,
"group": {
"short1": "00010",
"short2": "0",
"short3": "No",
"short4": "0",
"short5": "<Total>"
},
"period": {
"start": "2024-08-05T00:00:00",
"finish": "2024-08-12T00:00:00"
},
"value": {
"period": 50,
"cumulative": 50,
"manpower": 0.297619
}
},
{
"job_id": 1,
"jobdatafield_id": 1,
"group": {
"short1": "00010",
"short2": "0",
"short3": "No",
"short4": "0",
"short5": "<Total>"
},
"period": {
"start": "2024-08-12T00:00:00",
"finish": "2024-08-19T00:00:00"
},
"value": {
"period": 0,
"cumulative": 50,
"manpower": 0
}
}
]
Was this article helpful?