Values¶

Information values are the answers stored in a case. Each value belongs to an instance and to an information field identified by its key.

List all values of a case¶

GET /api/1/cases/{case_pk}/values

Accepts the standard list parameters.

Example

curl -X GET \
  -H "Authorization: Api-Key $ATFINITY_API_KEY" \
  https://your-tenant.atfinity.app/api/1/cases/<case_pk>/values

Response 200

meta (object)
- pagination (object)
results (array)
- case_id (integer, required, nullable)
- ensured_by (string, nullable)
- id (integer, required)
- information (integer, nullable)
- information_key (string, required)
- information_user_readable_id (string, required)
- instance_id (string, required)
- is_touched (boolean)
- needed_document_id (integer, required, nullable)
- value (string, required)

{
  "meta": {
    "pagination": {
      "count": 1,
      "page": 1,
      "pages": 1
    }
  },
  "results": [
    {
      "case_id": 4711,
      "id": 90001,
      "information_key": "date_of_birth",
      "information_user_readable_id": "person.date_of_birth",
      "instance_id": 5001,
      "is_touched": true,
      "value": "1985-04-12"
    }
  ]
}

List all values of an instance¶

GET /api/1/instances/{instance_pk}/values

Accepts the standard list parameters.

Example

curl -X GET \
  -H "Authorization: Api-Key $ATFINITY_API_KEY" \
  https://your-tenant.atfinity.app/api/1/instances/<instance_pk>/values

Response 200

meta (object)
- pagination (object)
results (array)
- case_id (integer, required, nullable)
- ensured_by (string, nullable)
- id (integer, required)
- information (integer, nullable)
- information_key (string, required)
- information_user_readable_id (string, required)
- instance_id (string, required)
- is_touched (boolean)
- needed_document_id (integer, required, nullable)
- value (string, required)