Each HTTP request needs the headers XA-REQUESTER: XRAS and XA-API-KEY: api-key.
| Resource | Description |
|---|---|
| POST /v1/actions/<actionId>/<requestId>/<actionType> | Do a New, Renewal, Extension, Supplement, Adjustment, Transfer, or Appeal |
| Resource | Description |
|---|---|
| GET /test_auth | Verify the headers XA-REQUESTER:XRAS and XA-API-KEY:api-key. |
| Resource | Description |
|---|---|
| GET /v1/dates/requests/<rqlist> | Get the begin and end dates for each request in a list. |
| Resource | Description |
|---|---|
| GET /v1/requests/request/<requestNumber> | Get a request. |
| GET /v1/requests/user/<username> | Get all requests that have a given user. |
| GET /v1/requests/role/pi/<username> | Get all requests that have a given PI. |
| GET /v1/requests/role/co_pi/<username> | Get all requests that have a given co-PI. |
| GET /v1/requests/role/allocation_manager/<username> | Get all requests that have a given allocation manager. |
| Resource | Description |
|---|---|
| POST /v1/roles/<requestNumber>/pi/<username> | Set the PI. |
| POST /v1/roles/<requestNumber>/allocation_manager/<username> | Add an allocation manager. |
| DELETE /v1/roles/<requestNumber>/allocation_manager/<username> | Remove an allocation manager. |
| POST /v1/roles/<requestNumber>/co_pi/<username> | Add a co-PI. |
| DELETE /v1/roles/<requestNumber>/co_pi/<username> | Remove a co-PI. |
| DELETE /v1/roles/<requestNumber>/user/<username> | Remove a user. |
| POST /v1/roles/<requestNumber>/user/<username> | Add a user. |
| Resource | Description |
|---|---|
| GET /v1/usage/by_month/<requestNumber>/<firstDate>/<lastDate> | Get the usage per month, in a date range, for a request. |
| Resource | Description |
|---|---|
| GET /v1/users/<requestNumber> | Get all users on a request. |
| POST /v1/users/<requestNumber> | Add user(s) to a resource/request. |
| GET /v1/users/<requestNumber>/<resourceRepositoryKey> | Get the users for a request on a resource. |
| POST /v1/users/<requestNumber>/<resourceRepositoryKey> | Add users to a resource on a request. |
| GET /v1/users/<requestNumber>/<resourceRepositoryKey>/<username> | Check if a user is on a resource/request. |
| POST /v1/users/<requestNumber>/<resourceRepositoryKey>/<username> | Add a user to a resource/request. |
| DELETE /v1/users/<requestNumber>/<resourceRepositoryKey>/<username> | Remove a user from a resource/request. |