The j5 REST API uses the conventions of the OpenAPI Specification (version 2.0) for parameters.
GET /restserver/30/industraform/logbook-query-v2/[logbook]: Query a logbook table for data in associated IndustraForms
Produces: application/json text/csv
Name |
In |
Description |
Type |
---|---|---|---|
logbook |
path |
The name of a logbook (for example, general_logbook) |
string |
area |
query |
Only include results that are associated with the specified area (including sub-areas). This parameter is a colon-separated string of area_hierarchy UUIDs (for example, for a particular second level area location, and all of its children, the parameter may look like: ‘3e880eb2-f50b-4c50-8c87-ab90672d4935:134c8eae-d616-49eb849e-e5ff113605cb’). You can query the ‘$Form.Area’ attribute to inspect the values that are filtered. |
string |
attribute_names |
query |
The list of IndustraForm element names to extract |
array of string (CSV) |
category |
query |
Only include results that are associated with the specified category (including sub-categories). This parameter is a colon-separated string of category IDs. You can specify multiple categories in the filter string as a comma-separated list. |
string |
default_element_attribute |
query |
Defines the default query attribute to request when IndustraForm element IDs are referenced in the attribute_names list without a specific dot-attribute. Must be one of Value, DisplayValue, IsDefined, IsValid, IsError or Error. |
string |
display_locale_name |
query |
Specify the locale to use for DisplayValue results. Use the two character language code and region code (For example, ‘en-US’). If not specified, the current user’s locale is used. Ask j5 Support if you don't know your locale code. |
string |
display_timezone_name |
query |
Specify the timezone to use for DisplayValue date or date-time results. Use the Olson timezone name (For example, ‘Asia/Tokyo’). If not specified, the current user’s timezone is used. |
string |
form_spec_name |
query |
Only include results with a particular form design (a fully-qualified Specification Name). If this parameter is not provided then forms for the IndustraForm design are included. You can query the ‘$Form.SpecificationName’ attribute to inspect the values that are filtered. To find a specific form_spec_name value, open the IndustraForms configuration page on the j5 Web Client. Copy and paste the IndustraForm's value in the Form Spec Name column and replace "IndustraFormLibrary" with "$local". |
string |
from_date_time |
query |
Only include results on or after the specified date/time (inclusive). This filters on the logbook ‘primary_time_field’. This requires a date/time string as defined by RFC3339 - full-date. For example, "2017-0420T00:39:57Z", or "2017-05-19T16:39:57-08:00". You can query the ‘$Form.DateTime’ attribute to inspect the values that are filtered. |
string |
to_date_time |
query |
Only include results before the specified date/time (exclusive). Like from_date_time, this uses the ‘primary_time_field’ and requires an RFC3339 full-date format. |
string |
last_modified |
query |
Allows you to query records that have been modified since a particular timestamp. |
string |
logid |
query |
Only include results that are associated with the specified LogIDs. You can specify multiple LogIDs in the filter string as a comma-separated list. |
string |
top |
query |
Only include up to the specified number of results. If there are fewer results, all of the them are returned. |
integer |
pretty |
query |
The JSON output is returned in a pretty format. |
boolean |
query_repeating |
query |
Set this to true in order to query a repeating section in the matching forms. Multiple result rows may be returned for each matching form. This behaves in a similar way to an INNER JOIN SQL query, where there is a row for each repeat, and where elements that are outside of the repeating section are duplicated in to each row. |
boolean |
status |
query |
Only include results that are associated with the specified status ID. You can specify multiple status IDs in the filter string as a comma-separated list. |
string |
To view all of the parameter references, enter /restserver/ after your j5 server's url. For example, https://[j5 Server URL]/restserver/.