Add
Add a new CO.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
---|---|---|
| NewObjectResponse with | CO created |
|
| CO Request not provided in POST body |
| ErrorResponse with details in | An error in one or more provided fields |
|
| Authentication required |
|
| A CO already exists with the requested name |
|
| Unknown error |
Delete
Remove a CO.
Warning: This method will delete all associated data, including CO people, roles, groups, history, etc. To preserve this data, set status to Inactive instead.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
---|---|---|
|
| CO deleted |
|
|
|
|
| Authentication required |
|
| The |
|
|
|
|
| Unknown error |
Duplicate
Duplicate an existing CO. Available as of Registry v3.2.0.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
---|---|---|
| NewObjectResponse with | CO created |
|
| |
|
| Authentication required |
|
|
|
|
| Unknown error |
Edit
Edit an existing CO.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
---|---|---|
|
| CO updated |
|
| CO Request not provided in POST body |
| ErrorResponse with details in | An error in one or more provided fields |
|
| The provided status is not valid |
|
| Authentication required |
|
| The |
|
| A CO already exists with the requested name |
|
|
|
|
| Unknown error |
View (all)
Retrieve all existing COs.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
---|---|---|
| COs returned | |
|
| Authentication required |
|
| Unknown error |
View (one)
Retrieve an existing CO.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
---|---|---|
| CO returned | |
|
| Authentication required |
|
|
|
|
| Unknown error |
Notes
- Response format requested is ignored where response is only via HTTP status, but must still be provided.
See Also
- cm_cos data model definition