Add
Add a new HistoryRecord.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
Response Format
HTTP Status |
Response Body |
Description |
---|---|---|
|
NewObjectResponse with |
HistoryRecord added |
|
|
HistoryRecord Request not provided in POST body |
|
ErrorResponse with details in |
An error in one or more provided fields |
|
|
Authentication required |
|
|
A CO Person or an Org Identity must be specified to attach the HistoryRecord to |
|
|
The specified CO Person or Org Identity does not exist |
|
|
Unknown error |
View (all)
Retrieve all existing HistoryRecords.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status |
Response Body |
Description |
---|---|---|
|
HistoryRecords returned |
|
|
|
Authentication required |
|
|
Unknown error |
View (per person)
Retrieve HistoryRecords attached to a CO Person or Org Identity.
Request Format
Method |
|
---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status |
Response Body |
Description |
---|---|---|
|
HistoryRecord 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_history_records data model definition