Add
Add a new CoExtendedAttribute.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
Response Format
HTTP Status |
Response Body |
Description |
---|---|---|
|
NewObjectResponse with |
CoExtendedAttribute added |
|
|
CoExtendedAttribute Request not provided in POST body |
|
ErrorResponse with details in |
An error in one or more provided fields |
|
|
Authentication required |
|
|
The specified CO does not exist |
|
|
An extended attribute already exists with the specified name in the specified CO |
|
|
The underlying RDBMS was unable to perform a supporting operation. |
|
|
Unknown error |
Delete
Remove a CoExtendedAttribute.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status |
Response Body |
Description |
---|---|---|
|
|
CoExtendedAttribute deleted |
|
|
|
|
|
Authentication required |
|
|
|
|
|
The underlying RDBMS was unable to perform a supporting operation. |
|
|
Unknown error |
Edit
Edit an existing CoExtendedAttribute.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
Response Format
HTTP Status |
Response Body |
Description |
---|---|---|
|
|
CoExtendedAttribute updated |
|
|
CoExtendedAttribute Request not provided in POST body |
|
ErrorResponse with details in |
An error in one or more provided fields |
|
|
Authentication required |
|
|
The specified CO does not exist |
|
|
An extended attribute already exists with the specified name in the specified CO |
|
|
|
|
|
The underlying RDBMS was unable to perform a supporting operation. |
|
|
Unknown error |
View (all)
Retrieve all existing CoExtendedAttributes.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status |
Response Body |
Description |
---|---|---|
|
CoExtendedAttribute returned |
|
|
|
Authentication required |
|
|
Unknown error |
View (per CO)
Retrieve CoExtendedAttributes attached to a CO.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status |
Response Body |
Description |
---|---|---|
|
CoExtendedAttribute returned |
|
|
|
Authentication required |
|
|
|
|
|
Unknown error |
View (one)
Retrieve an existing CoExtendedAttribute.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status |
Response Body |
Description |
---|---|---|
|
CoExtendedAttribute returned |
|
|
|
Authentication required |
|
|
|
|
|
Unknown error |
Notes
- Response format requested is ignored where response is only via HTTP status, but must still be provided.
This API manages the definition of Extended Attributes. The values for instantiated Extended Attributes are managed via the CoPersonRole API.
See Also
- cm_co_extended_attributes data model definition