/dataviewschemas/{id}
This resource is available only to principals with these entitlements: com.unboundid.broker.models.security.access.BrokerRole.READ_DATAVIEWSCHEMA com.unboundid.broker.models.security.access.BrokerRole.BROKER_ADMIN
Mount Point: /auth/api/v1/dataviewschemas/{id}/
The following operations are supported on this resource:
GET
This operation is available only to principals with these entitlements: com.unboundid.broker.models.security.access.BrokerRole.READ_DATAVIEWSCHEMA com.unboundid.broker.models.security.access.BrokerRole.BROKER_ADMIN
Retrieves a specified model object.
Parameters
| name | description | type | default |
|---|---|---|---|
| id | The ID of the model object to be retrieved. | path |
Response Body
| result: | dataViewSchema |
| media types: | application/json |
The requested model object.
Status Codes
| code | description |
|---|---|
| 200 | Success |
| 304 | Not modified |
| 404 | No such object |
PUT
This operation is available only to principals with these entitlements: com.unboundid.broker.models.security.access.BrokerRole.UPDATE_DATAVIEWSCHEMA com.unboundid.broker.models.security.access.BrokerRole.BROKER_ADMIN
Updates a model object.
Parameters
| name | description | type | default |
|---|---|---|---|
| id | The ID of the model object to be updated. | path |
Request Body
| element: | dataViewSchema |
| media types: | application/json |
(no documentation provided)
Response Body
| result: | dataViewSchema |
| media types: | application/json |
The updated model object response.
Status Codes
| code | description |
|---|---|
| 200 | Success |
| 412 | Precondition failed |
| 409 | Reserved for cache object out of date |
DELETE
This operation is available only to principals with these entitlements: com.unboundid.broker.models.security.access.BrokerRole.DELETE_DATAVIEWSCHEMA com.unboundid.broker.models.security.access.BrokerRole.BROKER_ADMIN
Deletes the specified data view schema.
Parameters
| name | description | type | default |
|---|---|---|---|
| id | The ID of the data view schema to be deleted. | path |
Status Codes
| code | description |
|---|---|
| 204 | Success |
| 404 | No such object |