Newtec Data Analytics (1.0.6)

Download OpenAPI specification:

E-mail: ja@newtec.dk License: MIT

API documentation for: Analytics - https://analytics.newtec.com

Grading

Grading report APIs

Generate grading batch report

Generate grading batch report for the provided report ID

Authorizations:

cookieAuthapiKey

path Parameters

reportId

required

integer

Report ID used in URL path

query Parameters

ids	Array of integers Examples: ids=1 - Single ID ids=1,2 - Multiple IDs Batch IDs to get report for
batchTags	Array of strings Examples: batchTags=10234ab - Single batch tag batchTags=10234ab,batch2 - Multiple batch tags Batch tags to get report for
export	string Examples: export=xlsx - xlsx export=csv - csv export=pdf - pdf export=json - json Format in which report should be exported
fs	string Examples: fs=, - Comma fs=%2C - Unicode fs=; - Semicolon Field seperator for CSV exports
orientation	string Examples: orientation=landscape - landscape orientation=portrait - portrait PDF orientation (landscape / portrait)
destination	string Examples: destination=download - Download destination=email - Email destination=sftp - sftp Export destination
emailTo	Array of integers Examples: emailTo=1 - Single ID emailTo=1,2 - Multiple IDs User IDs to send report to
sftpTo	Array of integers Examples: sftpTo=1 - Single ID sftpTo=1,2 - Multiple IDs SFTP IDs to send report to

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"data": {"reportSectionA": {"sortPosition": 1,
"sectionName": "Section A",
"data": { }
},
"reportSectionB": {"sortPosition": 3,
"sectionName": "Section B",
"data": { }
},
"etc": {"sortPosition": 2,
"sectionName": "Section etc.",
"data": { }
}
}
}

Generate grading job report

Generate grading job report for the provided report ID

Authorizations:

cookieAuthapiKey

path Parameters

reportId

required

integer

Report ID used in URL path

query Parameters

ids	Array of integers Examples: ids=1 - Single ID ids=1,2 - Multiple IDs Job IDs to get report for
jobNames	Array of strings Examples: jobNames=10234ab - Single job name jobNames=10234ab,batch2 - Multiple job names Job names to get report for
export	string Examples: export=xlsx - xlsx export=csv - csv export=pdf - pdf export=json - json Format in which report should be exported
fs	string Examples: fs=, - Comma fs=%2C - Unicode fs=; - Semicolon Field seperator for CSV exports
orientation	string Examples: orientation=landscape - landscape orientation=portrait - portrait PDF orientation (landscape / portrait)
destination	string Examples: destination=download - Download destination=email - Email destination=sftp - sftp Export destination
emailTo	Array of integers Examples: emailTo=1 - Single ID emailTo=1,2 - Multiple IDs User IDs to send report to
sftpTo	Array of integers Examples: sftpTo=1 - Single ID sftpTo=1,2 - Multiple IDs SFTP IDs to send report to

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"data": {"reportSectionA": {"sortPosition": 1,
"sectionName": "Section A",
"data": { }
},
"reportSectionB": {"sortPosition": 3,
"sectionName": "Section B",
"data": { }
},
"etc": {"sortPosition": 2,
"sectionName": "Section etc.",
"data": { }
}
}
}

Get report list

Authorizations:

cookieAuthapiKey

path Parameters

reportGroupId

required

integer

Examples:

1 -
2 -
3 -

Report group ID

Responses

Response samples

200
401
500

Content type

application/json

{"data": [{"reportId": 1,
"reportPath": "summary",
"reportName": "Summary",
"createdBy": "James"
}
]
}

Get report groups

Authorizations:

cookieAuthapiKey

query Parameters

userPrivileges

boolean

Examples:

userPrivileges=true -

If report groups are required for user privileges

Responses

Response samples

200
400
401
500

Content type

application/json

{"data": [{"id": 1,
"path": "/grading",
"name": "Grading",
"parentId": null
},
{"id": 2,
"path": "/grading/batches",
"name": "Grading Batches",
"parentId": 1
}
]
}

Weighing

Weighing report APIs

Get report list

Authorizations:

cookieAuthapiKey

path Parameters

reportGroupId

required

integer

Examples:

1 -
2 -
3 -

Report group ID

Responses

Response samples

200
401
500

Content type

application/json

{"data": [{"reportId": 1,
"reportPath": "summary",
"reportName": "Summary",
"createdBy": "James"
}
]
}

Get report groups

Authorizations:

cookieAuthapiKey

query Parameters

userPrivileges

boolean

Examples:

userPrivileges=true -

If report groups are required for user privileges

Responses

Response samples

200
400
401
500

Content type

application/json

{"data": [{"id": 1,
"path": "/grading",
"name": "Grading",
"parentId": null
},
{"id": 2,
"path": "/grading/batches",
"name": "Grading Batches",
"parentId": 1
}
]
}

Check Weighing

Check Weighing report APIs

Get report list

Authorizations:

cookieAuthapiKey

path Parameters

reportGroupId

required

integer

Examples:

1 -
2 -
3 -

Report group ID

Responses

Response samples

200
401
500

Content type

application/json

{"data": [{"reportId": 1,
"reportPath": "summary",
"reportName": "Summary",
"createdBy": "James"
}
]
}

Get report groups

Authorizations:

cookieAuthapiKey

query Parameters

userPrivileges

boolean

Examples:

userPrivileges=true -

If report groups are required for user privileges

Responses

Response samples

200
400
401
500

Content type

application/json

{"data": [{"id": 1,
"path": "/grading",
"name": "Grading",
"parentId": null
},
{"id": 2,
"path": "/grading/batches",
"name": "Grading Batches",
"parentId": 1
}
]
}

Sampling

Sampling report APIs

Get report list

Authorizations:

cookieAuthapiKey

path Parameters

reportGroupId

required

integer

Examples:

1 -
2 -
3 -

Report group ID

Responses

Response samples

200
401
500

Content type

application/json

{"data": [{"reportId": 1,
"reportPath": "summary",
"reportName": "Summary",
"createdBy": "James"
}
]
}

Get report groups

Authorizations:

cookieAuthapiKey

query Parameters

userPrivileges

boolean

Examples:

userPrivileges=true -

If report groups are required for user privileges

Responses

Response samples

200
400
401
500

Content type

application/json

{"data": [{"id": 1,
"path": "/grading",
"name": "Grading",
"parentId": null
},
{"id": 2,
"path": "/grading/batches",
"name": "Grading Batches",
"parentId": 1
}
]
}

Batch Management

Create celox batches

Authorizations:

cookieAuthapiKey

Request Body schema: application/json

batchTags

Array of strings

Array of batch tags

Array of objects

Array of Batch details
Traceability variables MUST already be manually created before sending through API
If a variable has parent, then passing parent value along with the value is mandatory. Example: If Grower is parent to Field, and if you are sending the field details for a batch, then you must send the grower for that batch as well.
New traceability values are automatically created
Existing traceability data is automatically updated

Responses

Request samples

Payload

Content type

application/json

Example

Array of batch tags

{"batchTags": ["Batch1",
"Batch2"
]
}

Response samples

200
401
406
500

Content type

application/json

{"message": "Batches created successfully but there was an error adding traceability data. Contact support at analytics.support@newtec.dk"
}

Traceability

Add traceability values

Authorizations:

cookieAuthapiKey

path Parameters

variableId

required

integer

Traceability variable ID for which traceability values will be added

Request Body schema: application/json

valueArray	Array of strings Array of values
	object Parent value and child values map

Responses

Request samples

Payload

Content type

application/json

Example

List of growers

{"valueArray": ["Grower1",
"Grower2"
]
}

Response samples

200
401
406
500

Content type

application/json

{"message": "Some values were not saved as your are not authorized to access some of the specified parent values"
}

Add traceability variable

Authorizations:

cookieAuthapiKey

Request Body schema: application/json

name required	string
typeId required	integer 1: List 2: Text 3: Number 4: Date 5: Date & Time
parentId	integer

Responses

Request samples

Payload

Content type

application/json

{"name": "Crop",
"typeId": 1,
"parentId": 1
}

Response samples

401
406
500

Content type

application/json

{"message": "Session expired. Please re-login"
}

Get traceability variables

Authorizations:

cookieAuthapiKey

Responses

Response samples

200
401
500

Content type

application/json

{"data": [{"id": 1,
"parentId": null,
"name": "Grower",
"type": "list",
"deletable": false
},
{"id": 2,
"parentId": 1,
"name": "Field",
"type": "list",
"deletable": false
}
]
}

Delete traceability value

Authorizations:

cookieAuth

path Parameters

id

required

integer

Traceability value ID to be deleted

Responses

Response samples

401
406
500

Content type

application/json

{"message": "Session expired. Please re-login"
}

Delete traceability variable

Authorizations:

cookieAuth

path Parameters

id

required

integer

Traceability variable ID to be deleted

Responses

Response samples

401
406
500

Content type

application/json

{"message": "Session expired. Please re-login"
}

Get traceability values

Authorizations:

cookieAuthapiKey

query Parameters

variableType	string Examples: variableType=list - Get variables & values where variable is of list type If only 'list' type variables & corresponding values are required
variables	Array of strings Examples: variables=Grower - Single variable variables=Grower,Variety - Multiple variables Get only these specific variables

Responses

Response samples

200
400
401
500

Content type

application/json

{"data": {"1": {"name": "Grower",
"type": "list",
"parentId": null,
"values": [{"id": 1,
"value": "Grower 1",
"parentId": null
},
{"id": 2,
"value": "Grower 2",
"parentId": null
}
]
},
"2": {"name": "Field",
"type": "list",
"parentId": 1,
"values": [{"id": 3,
"value": "Field 1",
"parentId": 1
},
{"id": 4,
"value": "Field 2",
"parentId": 2
}
]
}
}
}