$Participants attributes - j5 - 30 - Reference - Hexagon

j5 Framework IndustraForm API Reference

Language
English
Product
j5
Search by Category
Reference
j5 Version
30

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:

curl -X GET "https://[j5 Server URL]/restserver/30/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 [Base 64 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

}

]

}