Service Modules > Scheduling and Optimization > Service Board > Max for Developers > Appendix B: Max REST API > REST API Version 2
REST API Version 2
REST API Endpoints
Action
Method
URL
Input
Output
Parameters
POST
/v2/<object_full_identifier>
JSON representation of a Map <field, value>
JSON representation of a record
POST
/v2/<object_full_identifier>
JSON representation of an array of Map <field, value>
JSON representation of an array of records
PUT
/v2/<object_full_identifier>/<record_uuid>
JSON representation of a Map <field, value>
JSON representation of a record
PUT
/v2/<object_full_identifier>
JSON representation of an array of Map <field, value>, including io_uuid fields of records to be updated
JSON representation of an array of records
DELETE
/v2/<object_full_identifier>/<record_uuid>
HTTP Status 200
permanent_delete
DELETE
/v2/<object_full_identifier>
HTTP Status 200 if all records were successfully deleted
uuids, permanent_delete
PUT
/v2/<object_full_identifier>/<record_uuid>/undelete
HTTP Status 200
GET
/v2/<object_full_identifier>
JSON representation of a list of records
fields, incomingRelationships, filter, sort, limit, offset, exclude_total_count
data_format, suppress_ror
POST
/v2/<object_full_identifier>/extended_read
JSON representation of a Map <parameter, value>
JSON representation of a list of records
fields, incomingRelationships, filter, sort, limit, offset, exclude_total_count
data_format, suppress_ror
GET
/v2/<object_full_identifier>/<record_UUID>/hierarchy
JSON representation of a list of records
fields, incomingRelationships, filter, sort, limit, offset, exclude_total_count
data_format, hie_field, direction
POST
/v2/<object_full_identifier>/<record_UUID>/hierarchy
JSON representation of a Map <parameter, value>
JSON representation of a list of records
fields, incomingRelationships, filter, sort, limit, offset, exclude_total_count
data_format, hie_field, direction
GET
/v2/<object_full_identifier>/<record_UUID>
JSON representation of a record
fields, data_format, ignore_delete, suppress_ror
POST
/v2/<object_full_identifier>/<record_UUID>/extended_read
JSON representation of a Map <parameter, value>
JSON representation of a record
fields, data_format
ignore_delete, suppress_ror
GET
/v2/<object_full_identifier>/new_record
JSON representation of an empty record
data_format
Upsert single records
PATCH
/v2/<object_full_identifier>
JSON representation of a Map <Field, value>
JSON representation of a record
Upsert multiple records
PATCH
/v2/<object_full_identifier>
JSON representation of an array of Map <Field, value>
JSON representation of an array of records
GET
/v2/query
JSON representation of a record or list of records
q
GET
/v2/<object_full_identifier>/count
The count number
filter
Errors
Max REST API Version 2 uses standard HTTP status code to report successful or failed endpoint requests. HTTP Status 200 indicates that the request was completed successfully. Status codes in the 400 range generally indicate errors associated with invalid or missing parameters and/or provided data that prevent successful endpoint completion. HTTP Status 500 indicates a general server error, which is typically less frequent.
In all cases, the API retrieves a JSON message that contains a list of errors in the following format:
{
"errors": [
{
"type": "error_type",
"message": "error message",
"details": "error details"
},
...
]
}
Each entry includes the error type, a general description of the error, and specific information regarding the issue.
Error Type
Description
HTTP Status Code
missing_parameter_error
Required parameters are missing or required body content is empty.
400
invalid_parameter_error
Parameters are invalid due to invalid data or incorrect formats.
400
serialization_error
Error occurred while serializing data to JSON.
400
smql_query_error
Error occurred while executing an SMQL query.
400
entity_validation_error
Entity validation error occurred due to invalid data or unspecified required fields.
400
operation_error
General error occurred during API operation execution.
400
unauthorized_error
User not authorized to access resource.
400
entity_not_found_error
Requested entity not found.
404
server_error
General server error. Typically less frequent.
500
For more information:
Was this helpful?