Operations Logbook examples - j5 - 30 - Reference - Hexagon

j5 Framework IndustraForm API Reference

Language
English
Product
j5
Search by Category
Reference
j5 Version
30
  • To query the operations logbook entries with an event time between 1 June 2023 00:00:00 and 30 June 2023 00:00:00.

    curl -X GET "https://[j5 Server URL]/restserver/30/industraform/logbook-query-v2/general_logbook?attribute_names=$Form.Area,Message,$Form.Category,EventTime,$Form.Status&pretty=true&from_date_time=2023-06-01T00:00:00Z&to_date_time=2023-06-30T00:00:00Z" -H "accept: text/csv" -H "authorization: Basic [Base 64 encoded username and password]"

  • To query the operations logbook entries with a $Form.Area that matches the specified area path.

    curl -X GET "https://[j5 Server URL]/restserver/30/industraform/logbook-query-v2/general_logbook?attribute_names=$Form.Area,Message,$Form.Category,EventTime,$Form.Status,Priority,CreatedByUser.DisplayValue&pretty=true&area=[area path]" -H "accept: text/csv" -H "authorization: Basic [Base 64 encoded username and password]"

    • To find the area path, run the same query but without the "&area=…" and refer to the $Form.Area for the relevant fields.

    • Replace [area path] with your area path.

    For example:

    curl -X GET "https://[j5 Server URL]/restserver/30/industraform/logbook-query-v2/general_logbook?attribute_names=$Form.Area,Message,$Form.Category,EventTime,$Form.Status,Priority,CreatedByUser.DisplayValue&pretty=true&area=9a138aad-a5f3-493d-bc53-4e11511b4606:5a4c8d7a-02e8-49c7-bb80-c4a7cccf7a7b:07150d36-f3c5-4408-93b4-5038acac9d5e:5924030f-5572-49b2-bf78-e02bbdf24dbc" -H "accept: text/csv" -H "authorization: Basic [Base 64 encoded username and password]"

  • To query the Open ($Form.Status) operations logbook entries.

    curl -X GET "https://[j5 Server URL]/restserver/30/industraform/logbook-query-v2/general_logbook?attribute_names=$Form.Area,Message,$Form.Category,EventTime,$Form.Status&pretty=true&status=Open" -H "accept: text/csv" -H "authorization: Basic [Base 64 encoded username and password]"

  • To query the On Hold ($Form.Status) operation logbook entries in the Operations category ($Form.Category).

    The space in the On Hold state is replaced with %20 in the query.

    curl -X GET "https://[j5 Server URL]/restserver/30/industraform/logbook-query-v2/general_logbook?attribute_names=$Form.Area,Message,$Form.Category,EventTime,$Form.Status,Equipment.DisplayValue&pretty=true&category=Operations&status=On%20Hold" -H "accept: text/csv" -H "authorization: Basic [Base 64 encoded username and password]"