If a form has roles defined for it, you can to find information about the users that have been assigned to those roles (the participants). This information is queried using an attribute name like "$Participants.<RoleID>.<AttributeName>". Any of the element attributes can be referenced for participants (Value, DisplayValue, IsDefined, IsValid, IsError or Error). Here is an example of where all of the $Participants attributes are queried for a particular role:
Logbook-query example
curl -X GET "https://[j5 Server URL]/restserver/28.0/industraform/logbook-query/permits
?attribute_names=$Participants.IssuingAuthority.Value,$Participants.IssuingAuthority.DisplayValue,
$Participants.IssuingAuthority.IsDefined,$Participants.IssuingAuthority.IsValid,
$Participants.IssuingAuthority.IsError,$Participants.IssuingAuthority.Error&pretty=true&limit=1" -H
"accept: application/json" -H "authorization: Basic [Encoded username and password]"
[
{
"$Participants.IssuingAuthority.DisplayValue": "James Roland",
"$Participants.IssuingAuthority.Value": "jamesr",
"$Participants.IssuingAuthority.IsValid": true,
"$Participants.IssuingAuthority.IsDefined": true,
"$Participants.IssuingAuthority.IsError": false,
"$Participants.IssuingAuthority.Error": null
},
]
Logbook-query-v2 example
curl -X GET "https://[j5 Server URL]/restserver/28.0/industraform/logbook-query-v2/permits
?attribute_names=$Participants.IssuingAuthority.Value,$Participants.IssuingAuthority.DisplayValue,
$Participants.IssuingAuthority.IsDefined,$Participants.IssuingAuthority.IsValid,
$Participants.IssuingAuthority.IsError,$Participants.IssuingAuthority.Error&pretty=true&top=1" -H
"accept: application/json" -H "authorization: Basic [Encoded username and password]"
json
{
"values": [
{
"$Participants.IssuingAuthority.DisplayValue": "James Roland",
"$Participants.IssuingAuthority.Value": "jamesr",
"$Participants.IssuingAuthority.IsValid": true,
"$Participants.IssuingAuthority.IsDefined": true,
"$Participants.IssuingAuthority.IsError": false,
"$Participants.IssuingAuthority.Error": null
}
]
}