Add
Add a new CoNavigationLink.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
Response Format
HTTP Status |
Response Body |
Description |
---|---|---|
|
NewObjectResponse with |
CoNavigationLink added |
|
|
CoNavigationLink 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 |
|
|
Unknown error |
Delete
Remove a CoNavigationLink.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status |
Response Body |
Description |
---|---|---|
|
|
CoNavigationLink deleted |
|
|
|
|
|
Authentication required |
|
|
|
|
|
Unknown error |
Edit
Edit an existing CoNavigationLink.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
Response Format
HTTP Status |
Response Body |
Description |
---|---|---|
|
|
CoNavigationLink updated |
|
|
CoNavigationLink 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 |
|
|
|
|
|
Unknown error |
View (all)
Retrieve all existing CoNavigationLinks.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status |
Response Body |
Description |
---|---|---|
|
CoNavigationLink returned |
|
|
|
Authentication required |
|
|
Unknown error |
View (per CO)
Retrieve CoNavigationLink attached to a CO.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status |
Response Body |
Description |
---|---|---|
|
CoNavigationLink returned |
|
|
|
Authentication required |
|
|
|
|
|
Unknown error |
View (one)
Retrieve an existing CoNavigationLink.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status |
Response Body |
Description |
---|---|---|
|
CoNavigationLink 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_co_navigation_links data model definition
- NavigationLink API