Data

Insert new data records

post

Creates one or more new records in the specified schema. The payload contains a list of records, each with a unique ID and column values mapped to their respective field IDs.

Important considerations:

• Each record must include a unique UUID as its id

• Column values are identified by the field's UUID, not its name

• Required fields (as defined in the schema) must be provided

• Unique field constraints are validated before insertion

• Records can be inserted in batch for better performance

The response indicates which records were successfully inserted and which failed validation.

Body

application/json

schemaIdstring · uuidOptional

Responses

201

Records processed - Check response for individual results

application/json

206

Partial success - Some records were rejected

application/json

400

Invalid input - Missing required fields or invalid data format

application/json

401

Unauthorized - Invalid or missing JWT token

application/json

404

Schema not found - No schema exists with the provided ID

application/json

post

/api/data/add

HTTPcURLJavaScriptPython

POST /api/data/add HTTP/1.1
Host: api-z2.zinkee.com
Content-Type: application/json
Accept: */*
Content-Length: 563

{
  "schemaId": "550e8400-e29b-41d4-a716-446655440000",
  "payload": [
    {
      "id": "c3d4e5f6-a7b8-9012-cdef-234567890123",
      "columns": [
        {
          "fieldId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
          "value": "New Customer"
        },
        {
          "fieldId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
          "value": "[email protected]"
        },
        {
          "fieldId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "value": "Premium"
        }
      ]
    },
    {
      "id": "d4e5f6a7-b8c9-0123-def0-345678901234",
      "columns": [
        {
          "fieldId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
          "value": "Another Customer"
        },
        {
          "fieldId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
          "value": "[email protected]"
        }
      ]
    }
  ]
}

{
  "validUUIDs": [
    "c3d4e5f6-a7b8-9012-cdef-234567890123",
    "d4e5f6a7-b8c9-0123-def0-345678901234"
  ],
  "invalidUUIDs": {}
}

Delete data records

post

Permanently deletes one or more records from the specified schema. This operation cannot be undone.

Considerations:

• Deleted records cannot be recovered

• Associated files (FileField) may need to be deleted separately

• If the schema is auditable, the deletion is recorded in the activity log

• References to deleted records in other schemas may become orphaned

Body

application/json

idsstring · uuid[]Optional

schemaIdstring · uuidOptional

Responses

200

Records deleted successfully

application/json

anyOptional

400

Invalid input - Check schema ID and record IDs

application/json

401

Unauthorized - Invalid or missing JWT token

application/json

404

Record or schema not found - One or more record/schema IDs do not exist

application/json

post

/api/data/delete

HTTPcURLJavaScriptPython

POST /api/data/delete HTTP/1.1
Host: api-z2.zinkee.com
Content-Type: application/json
Accept: */*
Content-Length: 137

{
  "schemaId": "550e8400-e29b-41d4-a716-446655440000",
  "ids": [
    "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "b2c3d4e5-f6a7-8901-bcde-f12345678901"
  ]
}

No content

Filter and query data records

post

Queries and filters data records from a schema based on the provided criteria. This is the primary endpoint for retrieving data with support for:

• Filtering: Apply conditions using various comparison operators (EQUAL, NOT_EQUAL, GREATER, LESS, CONTAINS, RANGE, ANY_OF, IS_EMPTY, IS_NOT_EMPTY)

• Column Selection: Specify which fields to return in the response

• Sorting: Order results by one or more fields in ascending or descending order

• Pagination: Use startRow and endRow for efficient data loading

• Grouping: Group results by specific fields with aggregation functions (COUNT, SUM, AVERAGE, MIN, MAX)

• Pivot Mode: Transform grouped data into a pivot table format

The response includes a X-Total-Count header with the total number of matching records before pagination.

Body

application/json

schemaIdstring · uuidOptional

recordIdstring · uuidOptional

columnsstring[]Optional

groupBystring[]Optional

pivotBystring[]Optional

pivotModebooleanOptional

startRowinteger · int32Optional

endRowinteger · int32Optional

Responses

200

Data retrieved successfully

application/json

400

Invalid filter request - Check schema ID and field IDs

application/json

401

Unauthorized - Invalid or missing JWT token

application/json

404

Schema not found - No schema exists with the provided ID

application/json

post

/api/data/filter

HTTPcURLJavaScriptPython

POST /api/data/filter HTTP/1.1
Host: api-z2.zinkee.com
Content-Type: application/json
Accept: */*
Content-Length: 340

{
  "schemaId": "550e8400-e29b-41d4-a716-446655440000",
  "filters": [
    {
      "origin": {
        "schemaId": "550e8400-e29b-41d4-a716-446655440000",
        "fieldId": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
      },
      "comparisonOperator": "CONTAINS",
      "values": [
        "John"
      ]
    }
  ],
  "columns": [
    "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "7c9e6679-7425-40de-944b-e07fc1f90ae7"
  ],
  "startRow": 0,
  "endRow": 50
}

Basic filtering with paginationQuery with multiple filters and sortingGroup by with aggregations

[
  {
    "data": {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "f47ac10b-58cc-4372-a567-0e02b2c3d479": "John Smith",
      "7c9e6679-7425-40de-944b-e07fc1f90ae7": "[email protected]"
    }
  },
  {
    "data": {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "f47ac10b-58cc-4372-a567-0e02b2c3d479": "Jane Doe",
      "7c9e6679-7425-40de-944b-e07fc1f90ae7": "[email protected]"
    }
  }
]

Update existing data records

put

Updates one or more existing records in the specified schema. The structure is identical to the insert operation, but the record IDs must correspond to existing records.

Key behaviors:

• Only provided fields are updated; omitted fields retain their current values

• The previousValue field in columns can be used for optimistic locking

• If the schema is auditable, changes are recorded in the activity log

• Unique field constraints are validated before update

Body

application/json

schemaIdstring · uuidOptional

Responses

200

Records updated successfully

application/json

validUUIDsstring · uuid[]Optional

400

Invalid input - Check field IDs and data format

application/json

401

Unauthorized - Invalid or missing JWT token

application/json

404

Record or schema not found - The specified record/schema does not exist

application/json

put

/api/data/update

HTTPcURLJavaScriptPython

PUT /api/data/update HTTP/1.1
Host: api-z2.zinkee.com
Content-Type: application/json
Accept: */*
Content-Length: 299

{
  "schemaId": "550e8400-e29b-41d4-a716-446655440000",
  "payload": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "columns": [
        {
          "fieldId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "value": "VIP",
          "previousValue": "Premium"
        },
        {
          "fieldId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
          "value": "[email protected]"
        }
      ]
    }
  ]
}

{
  "validUUIDs": [
    "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  ],
  "invalidUUIDs": {}
}