Related Resources

Relational fields (denoted by a field name ending in “_id”) require the integer “id” value of the target resource. This can be obtained by making a GET request to the corresponding entity with appropriate filters.

Assuming that you already know the corresponding fields each have an “id” value of 1; when creating a new resource with the required related fields “facility_id” and “company_id”, the JSON POST request body is modeled as:

{

“fields”: {

“facility_id”: 1,

“company_id”: 1

}

}

If a related field is optional and not required as part of the initial resource creation, the field should be omitted to apply the default value.