Data: role
- Namespace: http://genologics.com/ri/role
- XML Schema File: role.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 role
- Type: role
The detailed representation of a Role
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<role:role xmlns:role="http://genologics.com/ri/role" built-in="..." uri="...">
<name>
<!--content of type 'string'-->
...
</name>
<researchers>
<researcher last-name="..." first-name="..." uri="...">
<!--content of type 'researcher-link'-->
</researcher>
<researcher>
<!--(another 'researcher-link' type)-->
</researcher>
<!--...more "researcher" elements...-->
</researchers>
<permissions>
<permission action="..." name="..." uri="...">
<!--content of type 'permission-link'-->
</permission>
<permission>
<!--(another 'permission-link' type)-->
</permission>
<!--...more "permission" elements...-->
</permissions>
</role:role>
Element roles
- Type: roles
API representation of a list of Roles
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<role:roles xmlns:role="http://genologics.com/ri/role" uri="...">
<role name="..." uri="...">
<!--content of type 'role-link'-->
</role>
<role>
<!--(another 'role-link' type)-->
</role>
<!--...more "role" elements...-->
</role:roles>
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 Creatable with POST: No Required for POST: No Updatable with PUT: No Required for PUT: No |
| name | string |
The name of this Permission
Always returns with GET: Yes Creatable with POST: No Required for POST: No Updatable with PUT: No Required for PUT: No |
| uri | anyURI |
The URI of the Permission
Always returns with GET: Yes Creatable with POST: No Required for POST: Yes Updatable with PUT: No Required for PUT: Yes |
Type researcher-link
Researcher-link is a child element type of researchers and provides a URI linking to the detailed representation of a researcher.
Attributes
| name | type | description |
|---|---|---|
| last-name | string |
The last name of the researcher.
Always returns with GET: Yes Creatable with POST: No Required for POST: No Updatable with PUT: No Required for PUT: No |
| first-name | string |
The first name of the researcher.
Always returns with GET: Yes Creatable with POST: No Required for POST: No Updatable with PUT: No Required for PUT: No |
| uri | anyURI |
The URI of the Researcher
Always returns with GET: Yes Creatable with POST: No Required for POST: No Updatable with PUT: No Required for PUT: No |
Type role
The detailed representation of a Role
Attributes
| name | type | description |
|---|---|---|
| built-in | boolean |
Whether this role is a built-in role (built-in roles cannot be deleted)
Always returns with GET: Yes Creatable with POST: No Required for POST: No Updatable with PUT: No Required for PUT: No |
| uri | anyURI |
The URI of the Role.
Always returns with GET: Yes Creatable with POST: No Required for POST: No Updatable with PUT: No Required for PUT: No |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| name (string) | 0/1 |
Name of the represented role
Always returns with GET: Yes Creatable with POST: Yes Required for POST: Yes Updatable with PUT: Yes Required for PUT: Yes |
| researchers/researcher (researcher-link) | 0/unbounded |
The researchers who have been granted the Role. This field is read-only.
Always returns with GET: Yes Creatable with POST: No Required for POST: No Updatable with PUT: No Required for PUT: No |
| permissions/permission (permission-link) | 0/unbounded |
The permissions assigned to the Role. If omitted from a PUT, all permissions will be unassigned from the Role.
Always returns with GET: Yes Creatable with POST: Yes Required for POST: No Updatable with PUT: Yes Required for PUT: No |
Type role-link
Role-link is a child element type of roles and provides a URI linking to the detailed representation of a Role.
Attributes
| name | type | description |
|---|---|---|
| name | string |
The name of this Role
Always returns with GET: Yes |
| uri | anyURI |
The URI of the Role
Always returns with GET: Yes |
Type roles
API representation of a list of Roles
Attributes
| name | type | description |
|---|---|---|
| uri | anyURI |
The URI of the Roles LIST endpoint
Always returns with GET: Yes |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| role (role-link) | 0/unbounded |
The list of Roles
Always returns with GET: Yes |