Salta al contenuto principale
Simbioza

API: tareas en los contenidos

Las capturas de pantalla muestran la interfaz en inglés.

← API — contenido

Las tareas son parte del contenido de la página publicada. El API no crea su definición; los autores lo agregan en el editor HTML o mediante contenido estructurado en la página API. task:read requiere acceso a la página publicada. task:write además verifica el toggle_scope de la lista y los permisos de usuario actuales.

PUT requiere un completed booleano y la tarea actual GET ETag. Cambiar el estado no crea otra versión de la página; La historia registra al actor. El historial utiliza la paginación del cursor dentro de una ventana de registro disponible limitada. Seleccione el idioma con lang.

Operaciones y ejemplos verificados.

GET /api/v1/pages/{documentId}/tasks

Propósito: Devuelve todas las tareas de la publicación actual de la página.

Permiso: task:read. Acceso a la página publicada y permiso según la regla de cambio de estado de la lista de tareas.

Ruta: documentId. Tome los valores de la respuesta anterior. Una ID de página es su clave de documento; nodeId es numérico y UUID no es un slug.

Parámetros de consulta: lang, page[after], page[limit].

Cuerpo: sin campos de entrada adicionales; sigue el ejemplo.

curl --globoff --silent --show-error \
  --request GET \
  --header "Authorization: Bearer $SIMBIOZA_API_KEY" \
  "$BASE_URL/api/v1/pages/api-plan-radionice/tasks?lang=hr&page[limit]=1"

Respuesta real: HTTP 200.

{
  "data": [
    {
      "uuid": "a7586a8f-d1e7-4bb4-bcb7-2273eb82e923",
      "list_uuid": "076e4a13-3797-4bdd-9fa8-618e832bffd0",
      "text": "Pregledati upute",
      "toggle_scope": "viewers",
      "state": {
        "task_uuid": "a7586a8f-d1e7-4bb4-bcb7-2273eb82e923",
        "list_uuid": "076e4a13-3797-4bdd-9fa8-618e832bffd0",
        "completed": false,
        "updated_by_user_id": null,
        "updated_by_display_name": "",
        "updated_at": "",
        "version": 0
      }
    }
  ],
  "meta": {
    "request_id": "8520a08a8fe81a37a03f5a9e0644ba2d",
    "page": {
      "limit": 1,
      "total": 2,
      "has_more": true,
      "next_cursor": "eyJvZmZzZXQiOjF9"
    }
  },
  "links": {
    "self": "/api/v1/pages/api-plan-radionice/tasks?lang=hr&page%5Blimit%5D=1",
    "next": "/api/v1/pages/api-plan-radionice/tasks?lang=hr&page%5Blimit%5D=1&page%5Bafter%5D=eyJvZmZzZXQiOjF9"
  }
}

Errores verificados para esta operación: 401, 403. Consulte reglas compartidas para conocer el significado del estado y las respuestas a los problemas.

GET /api/v1/pages/{documentId}/tasks/{taskUuid}

Propósito: Devuelve una tarea y su estado actual.

Permiso: task:read. Acceso a la página publicada y permiso según la regla de cambio de estado de la lista de tareas.

Ruta: documentId, taskUuid. Tome los valores de la respuesta anterior. Una ID de página es su clave de documento; nodeId es numérico y UUID no es un slug.

Parámetros de consulta: lang.

Cuerpo: sin campos de entrada adicionales; sigue el ejemplo.

curl --globoff --silent --show-error \
  --request GET \
  --header "Authorization: Bearer $SIMBIOZA_API_KEY" \
  "$BASE_URL/api/v1/pages/api-plan-radionice/tasks/a7586a8f-d1e7-4bb4-bcb7-2273eb82e923?lang=hr"

Respuesta real: HTTP 200.

{
  "data": {
    "uuid": "a7586a8f-d1e7-4bb4-bcb7-2273eb82e923",
    "list_uuid": "076e4a13-3797-4bdd-9fa8-618e832bffd0",
    "text": "Pregledati upute",
    "toggle_scope": "viewers",
    "state": {
      "task_uuid": "a7586a8f-d1e7-4bb4-bcb7-2273eb82e923",
      "list_uuid": "076e4a13-3797-4bdd-9fa8-618e832bffd0",
      "completed": false,
      "updated_by_user_id": null,
      "updated_by_display_name": "",
      "updated_at": "",
      "version": 0
    }
  },
  "meta": {
    "request_id": "8e191e76e361b0b48ab9c57852a654a2"
  },
  "links": {
    "self": "/api/v1/pages/api-plan-radionice/tasks/a7586a8f-d1e7-4bb4-bcb7-2273eb82e923?lang=hr"
  }
}

Errores verificados para esta operación: 401, 403. Consulte reglas compartidas para conocer el significado del estado y las respuestas a los problemas.

GET /api/v1/pages/{documentId}/tasks/{taskUuid}/history

Propósito: Devuelve la auditoría de cambio de estado de una tarea.

Permiso: task:read. Acceso a la página publicada y permiso según la regla de cambio de estado de la lista de tareas.

Ruta: documentId, taskUuid. Tome los valores de la respuesta anterior. Una ID de página es su clave de documento; nodeId es numérico y UUID no es un slug.

Parámetros de consulta: lang, page[after], page[limit].

Cuerpo: sin campos de entrada adicionales; sigue el ejemplo.

curl --globoff --silent --show-error \
  --request GET \
  --header "Authorization: Bearer $SIMBIOZA_API_KEY" \
  "$BASE_URL/api/v1/pages/api-plan-radionice/tasks/a7586a8f-d1e7-4bb4-bcb7-2273eb82e923/history?lang=hr&page[limit]=1"

Respuesta real: HTTP 200.

{
  "data": [
    {
      "uuid": "e8222ff1-2de8-4e43-b7ea-3632fdc5e9fb",
      "task_uuid": "a7586a8f-d1e7-4bb4-bcb7-2273eb82e923",
      "list_uuid": "076e4a13-3797-4bdd-9fa8-618e832bffd0",
      "completed": true,
      "changed_by_user_id": 1,
      "changed_by_display_name": "Administrator",
      "changed_at": "2026-11-06 22:49:03"
    }
  ],
  "meta": {
    "request_id": "fb30976da54e1510df5467626307a71b",
    "page": {
      "limit": 1,
      "total": 1,
      "has_more": false,
      "next_cursor": null
    }
  },
  "links": {
    "self": "/api/v1/pages/api-plan-radionice/tasks/a7586a8f-d1e7-4bb4-bcb7-2273eb82e923/history?lang=hr&page%5Blimit%5D=1",
    "next": null
  }
}

Errores verificados para esta operación: 401, 403. Consulte reglas compartidas para conocer el significado del estado y las respuestas a los problemas.

PUT /api/v1/pages/{documentId}/tasks/{taskUuid}/state

Propósito: Establece el estado de la tarea sin crear una nueva versión de la página.

Permiso: task:write. Acceso a la página publicada y permiso según la regla de cambio de estado de la lista de tareas.

Ruta: documentId, taskUuid. Tome los valores de la respuesta anterior. Una ID de página es su clave de documento; nodeId es numérico y UUID no es un slug.

Parámetros de consulta: lang.

Cuerpo/campos admitidos: completed. El siguiente ejemplo utiliza valores verificados; Las condiciones y las reglas de reemplazo de listas se describen al comienzo del capítulo.

Antes de escribir: actualice GET y configure ETAG desde su encabezado ETag.

curl --globoff --silent --show-error \
  --request PUT \
  --header "Authorization: Bearer $SIMBIOZA_API_KEY" \
  --header "Content-Type: application/json" \
  --header "If-Match: $ETAG" \
  --data-raw '{
  "completed": true
}' \
  "$BASE_URL/api/v1/pages/api-plan-radionice/tasks/a7586a8f-d1e7-4bb4-bcb7-2273eb82e923/state?lang=hr"

Respuesta real: HTTP 200.

{
  "data": {
    "task_uuid": "a7586a8f-d1e7-4bb4-bcb7-2273eb82e923",
    "list_uuid": "076e4a13-3797-4bdd-9fa8-618e832bffd0",
    "completed": true,
    "updated_by_user_id": 1,
    "updated_by_display_name": "Administrator",
    "updated_at": "2026-11-06 22:49:03",
    "version": 1
  },
  "meta": {
    "request_id": "32fc68d59ba7a6ba20b12cc7736128f5"
  },
  "links": {
    "self": "/api/v1/pages/api-plan-radionice/tasks/a7586a8f-d1e7-4bb4-bcb7-2273eb82e923/state?lang=hr"
  }
}

Errores verificados para esta operación: 400, 401, 403, 422. Consulte reglas compartidas para conocer el significado de los estados y las respuestas a los problemas.

Attacchi

Nessun attaccamento.

Commenti

0

Non ci sono ancora commenti.

Devi iscriverti per aggiungere un commento.

Creato: Krešimir Mihalj 28 sept 2026, 18:05 · Ultima modifica: Krešimir Mihalj 30 sept 2026, 11:40