REL documentation
Resource:collection: names of all UI features requiring authorizationC# Rel Const:Rels.UiPropertySvc.RightsURI template:rights{?scope}Obtain URI from:
gets all defined rights; each right corresponds to a UI feature requiring authorization
Success status: 200; Response is cacheable
| Name | Data Type | Description |
|---|---|---|
| scope | Common.Enum.UiRightScopeEnum | Scope of rights to retrieve - defaults to WarehouseAndCustUsers |
| - AdminWarehouseAndCustUsers | ||
| - WarehouseAndCustUsers | ||
| - CustUsersOnly |
| Type | Description | |
|---|---|---|
| Rights | IEnumerable<Generic.Models.Right> | |
| Name | string | fully qualified name, with dots suggesting hierarchy; this name SHOULD match the name of a UI feature requiring authorization |
| Description | string | |
| ControlledBy | string | |
| Scope | int |
Sample accept: application/hal+json
{
"rights": [
{
"name": "str",
"description": "str",
"controlledBy": "str",
"scope": 4
}
]
}
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.