GetContractEventActions

This method returns a list of contract event actions.

Use this information to find and populate the required action for events in the API createContractEvents.

Supplementary SWAGGER documentation is available here: https://api.catch-e.com/docs/#/Contract%20%2F%20Events/getContractEventActions

Permissions

To run this API, the nominated 'web-services' role needs to be given permission.

If you are not actively using the API, leave the permission off for better security.

Go to Roles / APIs and check on ContractEventActions:Get.

Note: This API is not configured for external use. Contact your Account Manager to discuss access to this API.

HTTP Method

Use the HTTP Method 'GET' for consuming this web service.

URL Examples

https://api.catch-e.com/fm/contract-event-actions

https://api.catch-e.com/fm/contract-event-actions?name=urgent&page=1&page_size=25

Parameters - Query String

Key

Format

Notes

Mandatory

name

string

Name of action. This field supports the wildcard % operator (see Wildcard % operator notes below)

No

page

integer

Page number. Default value: 1

No

page_size

integer

Page size. Default value: 25

No

Wildcard % Operator Notes

If you are using the Postman app with the wildcard operator, search strings such as %ab% or %ba% will return an error response.

If you need to search %ab% or %ba%, use %25ab%25 or %25ba%25 as required to return results as expected.

Response Details

Validation Message

Comments

200 OK

Successful response returns paginated list of contract event actions

404 - Not Found

API endpoint not found

422 - Unprocessable Entity

The name passed is not stored in the database

423 - Locked

Either a contract is being edited or billing is being processed. Try again once the contract is no longer in use or the billing process has completed

403 - Forbidden

You do not have permissions for this request

Successful Response Example

{ "_links": { "self": { "href": "https://api.catch-e.com/fm/contract-event-actions/?name=%25&page=1&page_size=25" }, "first": { "href": "https://api.catch-e.com/fm/contract-event-actions/?name=%25&page_size=25" }, "last": { "href": "https://api.catch-e.com/fm/contract-event-actions/?name=%25&page=1&page_size=25" } }, "_embedded": { "fm_contract_event_actions": [ { "contract_event_action_id": 100000, "name": "none", "_links": { "self": { "href": "https://api.catch-e.com/fm/contract-event-actions/100000" } } }, { "contract_event_action_id": 100001, "name": "closed", "_links": { "self": { "href": "https://api.catch-e.com/fm/contract-event-actions/100001" } } }, { "contract_event_action_id": 100002, "name": "urgent", "_links": { "self": { "href": "https://api.catch-e.com/fm/contract-event-actions/100002" } } }, { "contract_event_action_id": 100003, "name": "follow-up", "_links": { "self": { "href": "https://api.catch-e.com/fm/contract-event-actions/100003" } } } ] }, "page_count": 1, "page_size": 25, "total_items": 4, "page": 1 }

Error Response Examples

422 Unprocessable Entity

{ "name": { "noRecordFound": "No record matching the input was found" } }

The name passed is not stored in the database.

423 Locked

{ "detail": "Locked" }

Either a contract is being edited or billing is being processed. Try again once the contract is no longer in use or the billing process has completed.

403 Forbidden

{ "detail": "Forbidden" }

You do not have permissions for this request.

404 Not Found

{ "detail": "API endpoint not found" }