Add

Add a new CO.

Request Format

Method

POST

URL

/cos.<format>

Request Body

CO Request

Response Format

HTTP Status

Response Body

Description

201 Added

NewObjectResponse with ObjectType of Co

CO created

400 Bad Request

 

CO Request not provided in POST body

400 Invalid Fields

ErrorResponse with details in InvalidFields element

An error in one or more provided fields

401 Unauthorized

 

Authentication required

403 Name In Use

 

A CO already exists with the requested name

500 Other Error

 

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

DELETE

URL

/cos/<id>.<format>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 Deleted

 

CO deleted

400 Invalid Fields

 

id not provided

401 Unauthorized

 

Authentication required

403 Cannot Remove COmanage CO

 

The COmanage CO is required by the system and cannot be deleted

404 CO Unknown

 

id not found

500 Other Error

 

Unknown error


Duplicate

Duplicate an existing CO. Available as of Registry v3.2.0.

Request Format

Method

POST

URL

/cos/duplicate/<id>.<format>

Request Body


Response Format

HTTP Status

Response Body

Description

201 Added

NewObjectResponse with ObjectType of Co

CO created

400 Invalid Fields


id not provided

401 Unauthorized

 

Authentication required

404 CO Unknown

 

id not found

500 Other Error

 

Unknown error

Edit

Edit an existing CO.

Request Format

Method

PUT

URL

/cos/<id>.<format>

Request Body

CO Request

Response Format

HTTP Status

Response Body

Description

200 OK

 

CO updated

400 Bad Request

 

CO Request not provided in POST body

400 Invalid Fields

ErrorResponse with details in InvalidFields element

An error in one or more provided fields

400 Invalid Status

 

The provided status is not valid

401 Unauthorized

 

Authentication required

403 Cannot Edit COmanage CO

 

The COmanage CO is required by the system and cannot be edited

403 Name In Use

 

A CO already exists with the requested name

404 CO Unknown

 

id not found

500 Other Error

 

Unknown error


View (all)

Retrieve all existing COs.

Request Format

Method

GET

URL

/cos.<format>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

CO Response

COs returned

401 Unauthorized

 

Authentication required

500 Other Error

 

Unknown error


View (one)

Retrieve an existing CO.

Request Format

Method

GET

URL

/cos/<id>.<format>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

CO Response

CO returned

401 Unauthorized

 

Authentication required

404 CO Unknown

 

id not found

500 Other Error

 

Unknown error


Notes

  • Response format requested is ignored where response is only via HTTP status, but must still be provided.

See Also

  • No labels