Reten Docs
Activity Results

Task Result Type Configs

Per-tenant configuration of active result types.

GET /api/task-result-type-configs

List all tenant result type configurations.

Auth: Required — VIEW_ACTIVITIES permission

Example

curl https://api.reten.ai/api/task-result-type-configs \
  -H "Authorization: Bearer <token>" \
  -H "x-tenant-id: <tenant-id>"
import axios from 'axios';

const response = await axios.get(
  'https://api.reten.ai/api/task-result-type-configs',
  {
    headers: {
      Authorization: 'Bearer <token>',
      'x-tenant-id': '<tenant-id>',
    },
  }
);

const configs = response.data;

Response 200 OK

[
  {
    "id": "880e8400-e29b-41d4-a716-446655440000",
    "taskResultTypeId": "uuid",
    "isPositive": true,
    "isActive": true,
    "taskResultType": {
      "code": "success",
      "label": "Exito"
    }
  },
  {
    "id": "990e8400-e29b-41d4-a716-446655440000",
    "taskResultTypeId": "uuid",
    "isPositive": false,
    "isActive": true,
    "taskResultType": {
      "code": "not_home",
      "label": "No se encontro"
    }
  }
]

POST /api/task-result-type-configs

Create a tenant result type configuration.

Auth: Required — MANAGE_ACTIVITY_CONFIG permission

Request Body

FieldTypeRequiredDescription
task_result_type_idUUIDYesGlobal result type ID
labelstringYesDisplay label for this tenant
is_positivebooleanYesWhether this is a positive outcome

Example

curl -X POST https://api.reten.ai/api/task-result-type-configs \
  -H "Authorization: Bearer <token>" \
  -H "x-tenant-id: <tenant-id>" \
  -H "Content-Type: application/json" \
  -d '{
    "task_result_type_id": "uuid",
    "label": "Exito",
    "is_positive": true
  }'
import axios from 'axios';

const response = await axios.post(
  'https://api.reten.ai/api/task-result-type-configs',
  {
    task_result_type_id: 'uuid',
    label: 'Exito',
    is_positive: true,
  },
  {
    headers: {
      Authorization: 'Bearer <token>',
      'x-tenant-id': '<tenant-id>',
    },
  }
);

Response 201 Created


PATCH /api/task-result-type-configs/:id

Update a tenant result type configuration.

Auth: Required — MANAGE_ACTIVITY_CONFIG permission

Request Body

FieldTypeRequiredDescription
labelstringNoDisplay label
is_positivebooleanNoPositive/negative classification
is_activebooleanNoEnable or disable this config

Example

curl -X PATCH https://api.reten.ai/api/task-result-type-configs/<id> \
  -H "Authorization: Bearer <token>" \
  -H "x-tenant-id: <tenant-id>" \
  -H "Content-Type: application/json" \
  -d '{
    "is_positive": false
  }'
import axios from 'axios';

const response = await axios.patch(
  'https://api.reten.ai/api/task-result-type-configs/<id>',
  {
    is_positive: false,
  },
  {
    headers: {
      Authorization: 'Bearer <token>',
      'x-tenant-id': '<tenant-id>',
    },
  }
);

Response 200 OK


DELETE /api/task-result-type-configs/:id

Deactivate a tenant result type configuration.

Auth: Required — MANAGE_ACTIVITY_CONFIG permission

Example

curl -X DELETE https://api.reten.ai/api/task-result-type-configs/<id> \
  -H "Authorization: Bearer <token>" \
  -H "x-tenant-id: <tenant-id>"
import axios from 'axios';

const response = await axios.delete(
  'https://api.reten.ai/api/task-result-type-configs/<id>',
  {
    headers: {
      Authorization: 'Bearer <token>',
      'x-tenant-id': '<tenant-id>',
    },
  }
);

Response 204 No Content