.png){kind=logo}
JobCombinedValues
- 22 Nov 2024
- 2 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
JobCombinedValues
- Updated on 22 Nov 2024
- 2 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Job Combined Values
/v1/dru/jobcombinedvalues/
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.
The Jobs, JobDatasetValues, JobGroupValues and JobPeriodValues retrives individual values, this endpoint combines them into one result set.
Example for calling:
http://server/v1/dru/jobcombinedvalues?id=2 – retrieves values from the job with id 2
Allowed Methods:
[GET]
API Controller: dru_jobresult
Description:
- Retrieves combined aggregated results of a Job and details of the job it selves.
Parameters:
| Name | Type | Description | Notes |
|---|---|---|---|
| id | integer | The ID of the Job | Mandatory |
Response Fields:
| Name | Type | Description | Notes |
|---|---|---|---|
| jobdetails | jobdetails[] | Details of the Job, used when calculating the result, see jobdetails | |
| datagroup | datagroup[] | The details of the grouping on the Job, see Jobs.DataGroup | |
| period | period[] | The periods of the calculated aggregated values, see JobPeriodValues | |
| result | result[] | The calculated aggregation values, see Result |
jobdetails
Jobdetails table
| Name | Type | Description | Notes |
|---|---|---|---|
| jobid | integer | The ID of the Job | |
| jobname | string | The name of the Job | |
| project | project[] | The project linked to the Job, see Jobs.Project | |
| interval | interval[] | The Job interval, see Jobs.Interval |
result
Result table
| Name | Type | Description | Notes |
|---|---|---|---|
| jobdatafield_id | integer | The ID of the Dataset | |
| group | group[] | The group of the dataset result, see JobDatasetValues.Group | |
| period | period[] | Periods found in the Dataset result JobDatasetValues.Period | |
| value | value[] | Aggregated values found in the Dataset result, see JobDatasetValues.Value |
Show JSON Response
json result
[
{
"jobdetails": {
"jobId": 1,
"jobName": "Test Minutes Sundays (Produces 40 records)",
"project": {
"network_id": 1280,
"network_name": "DRU Minutes Sundays(91)",
"project_id": 1237
},
"interval": {
"interval": 1,
"unit": "Week"
}
},
"datagroup": [
{
"number": 1,
"field": "an",
"oc_level": 1,
"label": ""
},
{
"number": 2,
"field": "r1",
"oc_level": 2,
"label": "Reference 1"
},
{
"number": 3,
"field": "l55",
"oc_level": 3,
"label": "Flag 55"
},
{
"number": 4,
"field": "r46",
"oc_level": 4,
"label": "Reference 46"
},
{
"number": 5,
"field": "t",
"oc_level": 5,
"label": ""
}
],
"period": [
{
"start": "2024-01-01T00:00:00",
"finish": "2024-06-02T00:00:00"
},
{
"start": "2024-06-02T00:00:00",
"finish": "2024-06-03T00:00:00"
},
{
"start": "2024-06-17T00:00:00",
"finish": "2024-06-18T00:00:00"
}
],
"result": [
{
"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
}
},
{
"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
}
},
{
"jobdatafield_id": 4,
"group": {
"short1": "00010",
"short2": "0",
"short3": "No",
"short4": "0",
"short5": "<Total>"
},
"period": {
"start": "2024-09-09T00:00:00",
"finish": "2051-01-01T00:00:00"
},
"value": {
"period": 0,
"cumulative": 50,
"manpower": 0
}
}
]
}
]
Was this article helpful?