REST API - j5 - 28.0 - Reference - Hexagon PPM

j5 Framework IndustraForm API Reference

PPMProduct
j5
PPMCategory_custom
Reference
Version_j5
2019

IndustraForm entries are always created linked to a Logbook Form entry. The IndustraForm REST API provides a method to query a Logbook for data in associated IndustraForm entries over HTTP.

The logbook-query method is provided a logbook name, a list of attribute names, and, optionally, date/time or area filters. It returns a list of results with the values of the requested attributes for matching entries.

For example:

curl -X GET "http://j5.example.com/restserver/25.0/industraform/logbookquery/linked_industraforms_eg? attribute_names=EntryNumber,ResponsiblePerson,Priority,StartedTime,DueDate,EstimatedDuration,Estim atedEndDate&pretty=true" -H "accept: application/json" -H "authorization: Basic YWRtaW46YWRtaW4="

[

{

"ResponsiblePerson": "johns",

"EntryNumber": "EG1",

"EstimatedEndDate": "2017-07-01",

"StartedTime": "2017-06-29T10:19:18Z",

"Priority": "High",

"DueDate": "2017-06-30T22:00:00Z",

"EstimatedDuration": 2.0

},

{

"ResponsiblePerson": "jamesr",

"EntryNumber": "EG2",

"EstimatedEndDate": "2017-07-03",

"StartedTime": "2017-06-30T10:23:59Z",

"Priority": null,

"DueDate": "2017-07-06T22:00:00Z",

"EstimatedDuration": 3.0

}

]

The URL for accessing the method is http(s)://<j5server[:port]>/restserver/<j5_version>/industraform/logbookquery/<logbook_name>. Please use the HTTP GET method and use HTTP Basic Authentication to provide credentials. The Logbook name parameter is included in the URL, and all other parameters are provided as URL query components.