Data: perm
- Namespace: http://genologics.com/ri/permission
- XML Schema File: permission.xsd
The data in this namespace is divided into elements and types. Types define the structure of the data. Elements define specific instances of the types, and are therefore more relevant to REST endpoints, which generally consume and/or produce elements.
The following elements are members of this namespace:
The following types are members of this namespace:
Element permission
- Type: permission
The detailed representation of a Permission
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<perm:permission xmlns:perm="http://genologics.com/ri/permission" uri="...">
<name>
<!--content of type 'string'-->
...
</name>
<action>
<!--content of type 'string'-->
...
</action>
<description>
<!--content of type 'string'-->
...
</description>
</perm:permission>
Element permissions
- Type: permissions
API representation of a list of Permissions
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<perm:permissions xmlns:perm="http://genologics.com/ri/permission" uri="...">
<permission action="..." name="..." uri="...">
<!--content of type 'permission-link'-->
</permission>
<permission>
<!--(another 'permission-link' type)-->
</permission>
<!--...more "permission" elements...-->
</perm:permissions>
Type permission
The detailed representation of a Permission
Attributes
| name | type | description |
|---|---|---|
| uri | anyURI |
The URI of the Permission.
Always returns with GET: Yes |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| name (string) | 0/1 |
Permission name. The combination of name and action must be unique.
Always returns with GET: Yes |
| action (string) | 0/1 |
Permission action. The combination of name and action must be unique.
Always returns with GET: No |
| description (string) | 0/1 |
Permission description
Always returns with GET: Yes |
Type permission-link
Permission-link is a child element type of permissions and provides a URI linking to the detailed representation of a Permission.
Attributes
| name | type | description |
|---|---|---|
| action | string |
The action this Permission is granting
Always returns with GET: No |
| name | string |
The name of this Permission
Always returns with GET: Yes |
| uri | anyURI |
The URI of the Permission
Always returns with GET: Yes |
Type permissions
API representation of a list of Permissions
Attributes
| name | type | description |
|---|---|---|
| uri | anyURI |
The URI of the Permissions LIST endpoint
Always returns with GET: Yes |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| permission (permission-link) | 0/unbounded |
The list of Permissions
Always returns with GET: Yes |