Table of Contents
- GET /
- GET /info/organization
- GET /info/organization/properties
- GET /info/organization/properties/engageuiurl
- GET /info/me
- GET /info/me/roles
- GET /version
- GET /version/default
Read methods
| Method / Path: | GET / |
|---|---|
| Description: | Returns key characteristics of the API such as the server name and the default version. |
| Path params: | NONE |
| Optional (query) params: | NONE |
| Response formats: |
application/json
application/v1.0.0+json application/v1.1.0+json application/v1.2.0+json application/v1.3.0+json application/v1.4.0+json application/v1.5.0+json application/v1.6.0+json application/v1.7.0+json application/v1.8.0+json application/v1.9.0+json application/v1.10.0+json |
| Status codes: | 200: OK, The api information is returned. |
| Testing: |
Sample:
/
/api/
|
| Method / Path: | GET /info/organization |
|---|---|
| Description: | Returns the current organization. |
| Path params: | NONE |
| Optional (query) params: | NONE |
| Response formats: |
application/json
application/v1.0.0+json application/v1.1.0+json application/v1.2.0+json application/v1.3.0+json application/v1.4.0+json application/v1.5.0+json application/v1.6.0+json application/v1.7.0+json application/v1.8.0+json application/v1.9.0+json application/v1.10.0+json |
| Status codes: | 200: OK, The organization details are returned. |
| Testing: |
Sample:
/info/organization
/api/info/organization
|
| Method / Path: | GET /info/organization/properties |
|---|---|
| Description: | Returns the current organization's properties. |
| Path params: | NONE |
| Optional (query) params: | NONE |
| Response formats: |
application/json
application/v1.0.0+json application/v1.1.0+json application/v1.2.0+json application/v1.3.0+json application/v1.4.0+json application/v1.5.0+json application/v1.6.0+json application/v1.7.0+json application/v1.8.0+json application/v1.9.0+json application/v1.10.0+json |
| Status codes: | 200: OK, The organization properties are returned. |
| Testing: |
Sample:
/info/organization/properties
/api/info/organization/properties
|
| Method / Path: | GET /info/organization/properties/engageuiurl |
|---|---|
| Description: | Returns the engage ui url property. |
| Path params: | NONE |
| Optional (query) params: | NONE |
| Response formats: |
application/json
application/v1.0.0+json application/v1.1.0+json application/v1.2.0+json application/v1.3.0+json application/v1.4.0+json application/v1.5.0+json application/v1.6.0+json application/v1.7.0+json application/v1.8.0+json application/v1.9.0+json application/v1.10.0+json |
| Status codes: | 200: OK, The engage ui url is returned. |
| Testing: |
Sample:
/info/organization/properties/engageuiurl
/api/info/organization/properties/engageuiurl
|
| Method / Path: | GET /info/me |
|---|---|
| Description: | Returns information on the logged in user. |
| Path params: | NONE |
| Optional (query) params: | NONE |
| Response formats: |
application/json
application/v1.0.0+json application/v1.1.0+json application/v1.2.0+json application/v1.3.0+json application/v1.4.0+json application/v1.5.0+json application/v1.6.0+json application/v1.7.0+json application/v1.8.0+json application/v1.9.0+json application/v1.10.0+json |
| Status codes: | 200: OK, The user information is returned. |
| Testing: |
Sample:
/info/me
/api/info/me
|
| Method / Path: | GET /info/me/roles |
|---|---|
| Description: | Returns current user's roles. |
| Path params: | NONE |
| Optional (query) params: | NONE |
| Response formats: |
application/json
application/v1.0.0+json application/v1.1.0+json application/v1.2.0+json application/v1.3.0+json application/v1.4.0+json application/v1.5.0+json application/v1.6.0+json application/v1.7.0+json application/v1.8.0+json application/v1.9.0+json application/v1.10.0+json |
| Status codes: | 200: OK, The set of roles is returned. |
| Testing: |
Sample:
/info/me/roles
/api/info/me/roles
|
| Method / Path: | GET /version |
|---|---|
| Description: | Returns a list of available version as well as the default version. |
| Path params: | NONE |
| Optional (query) params: | NONE |
| Response formats: |
application/json
application/v1.0.0+json application/v1.1.0+json application/v1.2.0+json application/v1.3.0+json application/v1.4.0+json application/v1.5.0+json application/v1.6.0+json application/v1.7.0+json application/v1.8.0+json application/v1.9.0+json application/v1.10.0+json |
| Status codes: | 200: OK, The default version is returned. |
| Testing: |
Sample:
/version
/api/version
|
| Method / Path: | GET /version/default |
|---|---|
| Description: | Returns the default version. |
| Path params: | NONE |
| Optional (query) params: | NONE |
| Response formats: |
application/json
application/v1.0.0+json application/v1.1.0+json application/v1.2.0+json application/v1.3.0+json application/v1.4.0+json application/v1.5.0+json application/v1.6.0+json application/v1.7.0+json application/v1.8.0+json application/v1.9.0+json application/v1.10.0+json |
| Status codes: | 200: OK, The default version is returned. |
| Testing: |
Sample:
/version/default
/api/version/default
|