Computed Fields API¶

Programmatic access to Computed Fields uses the Field endpoints on the Qualytics REST API. The requests below cover creation, update, deletion, and read. Requests share the same base URL and Bearer token authentication as the rest of the platform API.

• Base URL. Your deployment's platform host (for example, https://<your-tenant>.qualytics.io/api).
• Auth. Bearer token in the Authorization header. See Access Tokens to create one.

Payload Shape¶

A Computed Field is a specialization of the generic Field payload. Common fields:

Create¶

Endpoint: POST /computed-fields

Permission: Editor team permission on the parent datastore, or Author when owner_id is omitted or set to the caller's own user id.

curl -X POST "https://<your-tenant>.qualytics.io/api/computed-fields" \
  -H "Authorization: Bearer $QUALYTICS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "container_id": 34,
    "name": "order_total_numeric",
    "transformation": "cast",
    "source_fields": ["order_total"],
    "properties": {
      "target_type": "decimal(10,2)"
    },
    "description": "Numeric version of order_total for aggregation checks."
  }'

curl -X POST "https://<your-tenant>.qualytics.io/api/computed-fields" \
  -H "Authorization: Bearer $QUALYTICS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "container_id": 34,
    "name": "full_name",
    "transformation": "customExpression",
    "properties": {
      "column_expression": "concat_ws('\'' '\'', first_name, last_name)"
    },
    "description": "First and last name concatenated with a space."
  }'

Returns the created Field object with its assigned id. The request runs a quick profile of the container before it returns, so the Computed Field already has its first values.

Update¶

Endpoint: PUT /computed-fields/{id}

Permission: Editor team permission on the parent datastore, or Author when the caller is the current owner. Reassigning ownership always requires Editor.

curl -X PUT "https://<your-tenant>.qualytics.io/api/computed-fields/128" \
  -H "Authorization: Bearer $QUALYTICS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "full_name",
    "transformation": "customExpression",
    "properties": {
      "column_expression": "concat_ws('\'' '\'', first_name, middle_name, last_name)"
    },
    "description": "First, middle, and last name concatenated with a space."
  }'

The container_id cannot be changed. Saving an edit re-registers the transformation on the container and runs a quick profile of the container, which computes values against the new definition.

Delete¶

Endpoint: DELETE /computed-fields/{id}

Permission: Editor team permission on the parent datastore, or Author when the caller is the current owner.

curl -X DELETE "https://<your-tenant>.qualytics.io/api/computed-fields/128" \
  -H "Authorization: Bearer $QUALYTICS_TOKEN"

Returns 204 No Content on success. The Computed Field definition, the derived output, and any quality checks that target it are removed. Expected Schema checks are kept and drop the field from their list. Source fields are not affected.

Read¶

Endpoint: GET /fields/{id} returns any field on the platform (regular or computed), and the response includes a computed_field object when the field is derived. To list every field on a container, use GET /containers/{id}/fields, or fetch the container itself with GET /containers/{id}, whose response includes a computed_fields array of the derived fields.

Permission: Reporter team permission on the parent datastore or above.

Error Responses¶