Example Requests

Service Board > Max for Developers > Appendix B: Max REST API > CRUD REST API Version 1 Examples > Example Requests

Example Requests

Get All Records of a Specified Object

Request Format

GET https://<host>/api/rest/v1/<object_full_identifier>

Request Example

Retrieve all Entitlement Rule records:

GET https://<host>/api/rest/v1/svmx_entitlement_rule

Response Example

Get a Single Record of a Specified Object

Request Format

GET https://<host>/api/rest/v1/<record_uuid>/

Request Example

Retrieve a single Entitlement Rule record:

GET https://<host>/api/rest/v1/svmx_entitlement_rule/86b4097e-cb58-4f5f-8604-88db6010845b

Response Example

Get Records by Selected Fields

To retrieve selected fields for records of an object, use the fields parameter to specify a comma-separated list of the fields to select.

Request Format

GET https://<host>/api/rest/v1/?fields=,,...,?

GET https://<host>/api/rest/v1//?fields=,,...,

Request Examples

• Retrieve all Entitlement Rule records, with only the Name and Updated On fields selected:

GET https://<host>/api/rest/v1/svmx_entitlement_rule?fields=io_name,io_updated_on

• Retrieve the Entitlement Rule record with UUID 86b4097e-cb58-4f5f-8604-88db6010845b, with only the Name and Updated On fields selected:

GET https://<host>/svmx_entitlement_rule/86b4097e-cb58-4f5f-8604-88db6010845b?fields=io_name,io_updated_on

Get Records by Selected Subset of Fields With Filtering

To retrieve records of an object by selecting a subset of their fields with filtering criteria applied, you send a POST request.

Request Format

POST https://<host>/api/rest/v1//read?fields=<field1_full_identifier>,<field2_full_identifier>,...,<fieldn_full_identifier>

Specify filtering in the request body in JSON, as follows:

{"operator": [
{"<operator>":[{"object":"<object_full_identifier>","field":"<field_full_identifier>"},"<value_to_compare>"]},
{"<operator>":[{"object":"<object_full_identifier>","field":"<field_full_identifier>"},"<value_to_compare>"]}]}

Request Example

Retrieve only the Account and Work Orderobjects, with only the Name and UUID fields selected:

POST https://<host>/api/rest/v1/io_object/read?fields=io_name,io_uuid

JSON filtering criteria in the request body:

{"or": [{"eq":[{"object":"io_object","field":"io_identifier"},"account"]}, {"eq":[{"object":"io_object","field":"io_identifier"},"work_order"]}]}

Response Example

[{"__object":"io_object","io_name”:
{“raw”:"Account"},"io_uuid”:
{“raw”:"bf35c30e-c6e5-11e0-be1e-001ec93afa2c"}},{"__object":"io_object","io_name”:
{“raw”:"Work Order"},"io_uuid”:
{“raw”:"b184d988-b195-446b-b8fd-7a1b8b09feae"}}]

Get Empty Record of an Object With Default Values

To retrieve an empty (new) record of a specified object with default field values set, you send a GET request.

Request Format

GET https://<host>/new_record/

Request Example

Retrieve a new Entitlement Rule record with default field values set:

GET https://<host>/new_record/svmx_entitlement_rule

Response Example

{"__object":"svmx_entitlement_rule","io_created_by":
{"raw":"764f0869-8b2a-4e43-8f23-88f593863eff","name":"System Administrator","deleted":false,"__object":"io_user"},"io_documentation":
{"raw":null},"io_custodian":
{"raw":"d641667c-4850-4a7b-8a76-117fc7bfe2b6","name":"Default Custodian","deleted":false,"__object":"io_custodian"},"io_deleted":
{"raw":false},"io_owner":
{"raw":"764f0869-8b2a-4e43-8f23-88f593863eff","name":"System Administrator","deleted":false,"__object":"io_user"},"io_created_on":
{"raw":null},"io_description":
{"raw":null},"io_external_id”:
{“raw”:null},"io_updated_by":
{"raw":null,"name":null,"deleted":null,"__object":"io_user"},"io_path":
{"raw":null},"io_updated_on":
{"raw":null},"io_tags":
{"raw":null},"io_overrides":
{"raw":null},"svmx_value":
{"raw":null},"io_platform_changes_permitted":
{"raw":null,"uuid":null,"identifier":null,"name":null},"svmx_name":
{"raw":null},"io_application":
{"raw":null,"name":null,"deleted":null,"__object":"io_application"},"io_notes":
{"raw":null},"io_folder":
{"raw":null,"name":null,"deleted":null,"__object":"io_folder"},"svmx_object":
{"raw":null,"name":null,"deleted":null,"__object":"io_object"},"svmx_rule_identifier":
{"raw":null},"io_active":
{"raw":true},"io_package":
{"raw":null,"name":null,"deleted":null,"__object":"io_package"},"svmx_operator":
{"raw":null,"uuid":null,"identifier":null,"name":null},"svmx_sequence":
{"raw":null},"io_release":
{"raw":null,"name":null,"deleted":null,"__object":"io_release"},"io_private":
{"raw":false},"svmx_field":
{"raw":null,"name":null,"deleted":null,"__object":"io_field"},"io_short_description":
{"raw":null},"io_release_status":
{"raw":null,"uuid":null,"identifier":null,"name":null},"io_uuid":
{"raw":"947d5437-4c08-4028-a625-bcd4f1ca6039"}}

Delete One Record of a Specified Object

To delete a specific record, you send a DEL request.

Request Format

DEL https://<host>/api/rest/v1/<record_uuid>/

Request Example

Delete the Entitlement Rule record with UUID 86b4097e-cb58-4f5f-8604-88db6010845b:

DEL https://<host>/api/rest/v1/svmx_entitlement_rule/86b4097e-cb58-4f5f-8604-88db6010845b

Was this helpful?