Record management

Retrieving records

All records from a schema

You can get a list of all records from a schema. The schema is identified by UUID.

API reference available here.

curl --location --request \
GET 'https://api.synerise.com/boxes-v2/records/bcb027b1-4b49-44fb-9f96-7a3c710af7cf?page=1&limit=100' \
--header 'api-version: 4.2' \
--header 'authorization: Bearer eyJh...bg4'

One record

You can retrieve a single record. You need the UUIDs of the schema and of the record.

API reference available here.

curl --location --request \
GET 'https://api.synerise.com/boxes-v2/records/bcb027b1-4b49-44fb-9f96-7a3c710af7cf/2492bac8-92c1-4bce-919e-7979cd1d1afe' \
--header 'api-version: 4.2' \
--header 'authorization: Bearer eyJ...j19U'

Updating records/changing relations

When you update a record, you can change the data it stores and add/remove references to other records.

The request body is the same as when creating a record and a complete record must be sent - including any data that is not being changed.

Note: When you retrieve a record, the data contains a relations object. This object is not sent in any POST/PUT/PATCH requests.

API reference available here.

The following request example adds a project-employee relation according to the example from Schema relations. The value of the projectName is not modified.

curl --location --request \
PUT 'https://api.synerise.com/boxes-v2/records/bcb027b1-4b49-44fb-9f96-7a3c710af7cf/2492bac8-92c1-4bce-919e-7979cd1d1afe' \
--header 'api-version: 4.2' \
--header 'authorization: Bearer eyJheMt0s' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fields": {
        "projectName": {
            "value": "Synerise Documentation"
        },
        "project_with_many_employees": {
            "recordIds": [
                "e0f50659-459d-4bd5-84b5-4ad21426d97c",
                "45e5ea9a-7c3c-4ff2-b8b9-d7edfa24cd2f"
            ],
            "type": "many"
        }
    }
}'

The response includes the updated record details.

Deleting records

You can permanently delete a single record. You need the UUIDs of the schema and of the record.

API reference available here.

curl --location --request \
DELETE 'https://api.synerise.com/boxes-v2/records/94babf33-a30e-457b-a392-417264f3f31d/c6e3b17a-f307-49d4-a98d-081a0cbfe647' \
--header 'api-version: 4.2' \
--header 'authorization: Bearer eyJh...lJ6E'
😕

We are sorry to hear that

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

😉

Awesome!

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.