Add
Add a new CoExtendedType.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| NewObjectResponse with | CoExtendedType added |
|
| CoExtendedType 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 type for the specified attribute already exists with the specified name in the specified CO |
|
| Set up of default attribute types failed. |
|
| Unknown error |
Delete
Remove a CoExtendedType.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
|
| CoExtendedType deleted |
|
|
|
|
| Authentication required |
403 Type In Use |
| The type is in use and cannot be deleted (unless all references to the type are changed) |
|
|
|
|
| The underlying RDBMS was unable to perform a supporting operation. |
|
| Unknown error |
Edit
Edit an existing CoExtendedType.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
|
| CoExtendedType updated |
|
| CoExtendedType 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 type already exists with the specified name in the specified CO |
|
|
|
|
| Unknown error |
View (all)
Retrieve all existing CoExtendedTypes.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| CoExtendedType returned | |
|
| Authentication required |
|
| Unknown error |
View (per CO)
Retrieve CoExtendedTypes attached to a CO.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| CoExtendedType returned | |
|
| Authentication required |
|
|
|
|
| Unknown error |
View (one)
Retrieve an existing CoExtendedType.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| CoExtendedType 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 Types. The values for instantiated Extended Types are managed via the appropriate attribute API (eg Identifier API).
See Also
- cm_co_extended_types data model definition