/purposes
Mount Point: /auth/api/v1/purposes/
GET
Retrieve a list of purposes from the entire set of defined purposes.
Parameters
| name | description | type | default |
|---|---|---|---|
| startIndex | The index number of the first item to be provided in the results. A null value is equivalent to 0. | query | 0 |
| count | The maximum number of items to be provided in the results. A null value signifies no maximum. | query | |
| sortBy | Specifies how the results should be sorted. Allowed values are NAME_ASCENDING, and NAME_DESCENDING. A null value returns items in an unspecified order. | query | NAME_ASCENDING |
| filterBy | Specifies how filtering will occur. Allowed values are NAME_EQUALITY, NAME, DEFAULT, DESCRIPTION, ID, and VERSION. | query | |
| filter | user-supplied input used for filtering. | query | |
| excludesList | comma-separated list of ids to exclude from results. | query |
Response Body
| result: | purpose |
| media types: | application/json |
Paged results of all requested purposes.
Status Codes
| code | description |
|---|---|
| 200 | Success |
POST
Creates a model object.
Request Body
| element: | purpose |
| media types: | application/json |
The object to be created.
Response Body
| result: | purpose |
| media types: | application/json |
The created model object response.
Status Codes
| code | description |
|---|---|
| 201 | Success |
| 400 | Bad Request |