REL documentation
maintains resources for the V2 user interface
| Rel (/rels/uiproperties/ + ) | On Billboard | Description |
|---|---|---|
| clientmetadata | yes | custom storage of client-specific metadata, such as UI preferences, none of which controls internal business logic |
| clientmetadatas | yes | Collection: of clientmetadata |
| customrole | list of rights, customizable | |
| customroles | yes | Collection: of customrole |
| customrolesummaries | yes | collection: custom role summaries |
| mobileuseravailable | yes | Operator: send event to mark user available for mobile jobs |
| policies | yes | collection: all rights granted to a given user, derived from user's role(s) |
| rights | yes | collection: names of all UI features requiring authorization |
| systemrole | list of rights, immutable | |
| systemrolesummaries | yes | collection: system role summaries |
| textoverride | ||
| textoverrides | yes | Collection: of textoverride |
| threepllogo | yes | ThreePL Logo |
| user | yes | a user |
| userindex | yes | user index in the list of users |
| users | yes | Collection: of user |
| usersactivate | yes | GroupOperator: activate/deactivate users |
| usersassignrole | yes | GroupOperator: assign role to users |
This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.