There is also a set of attributes that give information about the form entry as a whole. They are queried using the attribute name "$Form.<FormAttribute>".
Attribute |
Data Type |
Description |
---|---|---|
Area |
string |
The area key for the logbook record (colon-separated). The area parameter filters data based on this value. |
Category |
string |
The category key for the logbook record (colon-separated). The category parameter filters data based on this value. |
DateTime |
string |
The ‘primary_time_field’ value for the logbook record, in UTC, formatted according to RFC3339 - full-date. The from_date_time and to_date_time parameters filter data based on this value. |
FlagsPending |
integer |
The total number of flags raised in sections that are still in edit mode (in other words, have not yet been submitted). |
FlagsTotal |
integer |
The total number of flags raised. |
IsComplete |
boolean |
Is every section of the form submitted and fully approved? |
last_modification |
string |
The last modified time |
ParentLogID |
string |
The logid value for the logbook record. |
SectionsWaitingForApproval |
integer |
The number of sections that have been submitted and are waiting for at least one approval. |
SectionsWaitingForRevision |
integer |
The number of sections that have been rejected, and have not yet been revised. |
SectionsWaitingForSubmission |
integer |
The number of sections that are enabled, but have not yet been submitted. |
SpecificationName |
string |
The fully qualified form specification name. The form_spec_name parameter filters data based on this value. |
SpecificationVersion |
string |
The form specification version hash code. |
StateName |
string |
The current state name (based on form design gate definitions). |
StateDisplayName |
string |
The localized state name. |
Status |
string |
The record's status name. |
UUID |
string |
The unique identifier for the form. |
Area, Category, DateTime, ParentLogID, and Status are only available through the REST API. They are not accessible through the corresponding in-process Python query API calls.
Here is an example, querying all of the $Form attributes:
curl -X GET "https://[j5 Server URL]/restserver/30/industraform/logbook-query-v2/permits
?attribute_names=$Form.UUID,$Form.SpecificationName,$Form.SpecificationVersion,$Form.IsComplete,
$Form.StateName,$Form.StateDisplayName,$Form.SectionsWaitingForSubmission,
$Form.SectionsWaitingForApproval,$Form.SectionsWaitingForRevision,$Form.FlagsTotal,
$Form.FlagsPending,$Form.Area,$Form.DateTime,$Form.ParentLogID&pretty=true&top=1" -H
"accept: application/json" -H
"authorization: Basic [Base 64 encoded username and password]"
json
{
"values": [
{
"$Form.StateDisplayName": "Drafting",
"$Form.SpecificationVersion": "9a039ad1952013c87470e30a2330e796bf4df6d6",
"$Form.Area": "3e880eb2-f50b-4c50-8c87-ab90672d4935:fa247105-d5d5-47c0-8205-6b972c005e1e:ab1ce956-49bf-4e5c-8878-3e8afaf655ad",
"$Form.SectionsWaitingForRevision": 1,
"$Form.SectionsWaitingForSubmission": 3,
"$Form.SpecificationName": "j5.ControlofWork.cold_work",
"$Form.UUID": "fcd569b5-83dd-4888-9073-54741cff3f6e",
"$Form.FlagsPending": 0,
"$Form.FlagsTotal": 0,
"$Form.StateName": "Drafting",
"$Form.IsComplete": false,
"$Form.ParentLogID": "ID1499061945058262581206",
"$Form.SectionsWaitingForApproval": 2,
"$Form.DateTime": "2020-07-03T06:05:45Z"
}
]
}