/dataviewschemas
This resource is available only to principals with these entitlements: "ROLE_READ_DATAVIEWSCHEMA" "ROLE_BROKER_ADMIN"
Mount Point: /auth/api/v1/dataviewschemas/
GET
This operation is available only to principals with these entitlements: "ROLE_READ_DATAVIEWSCHEMA" "ROLE_BROKER_ADMIN"
Retrieve a list of data view schemas from the entire set of defined data view schemas.
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 defined by getSortsByEnumValues(). A null value returns items in an unspecified order. | query | NAME_ASCENDING |
| filterBy | Specifies how filtering will occur. Allowed values are defined by getFiltersByEnumValues(). | query | |
| filter | user-supplied input used for filtering. | query | |
| excludesList | comma-separated list of ids to exclude from results. | query |
Response Body
| element: | (custom) |
| media types: | application/json |
Paged results of all requested data view schemas.
Status Codes
| code | description |
|---|---|
| 200 | Success |
POST
This operation is available only to principals with these entitlements: "ROLE_CREATE_DATAVIEWSCHEMA" "ROLE_BROKER_ADMIN"
Creates a model object.
Request Body
| element: | (custom) |
| media types: | application/json |
(no documentation provided)
Response Body
| element: | (custom) |
| media types: | application/json |
The created model object response.
Status Codes
| code | description |
|---|---|
| 201 | Success |
| 400 | Bad Request |