Actualizar una subtarea de una tarea de un plan de tareas

Modifica una subtarea existente de una tarea de un plan de tareas. La actualización es parcial: solo se cambia lo que envías en el cuerpo y el resto de la subtarea conserva su valor actual. Se edita una subtarea por petición. Para crear subtareas usa Crear subtareas en una tarea de un plan de tareas.

Add-on

Uso general — sin add-on específico. El token debe pertenecer a un perfil con permiso de edición sobre Tareas > Planes de tareas.

PUT https://app.fracttal.com/api/tasks_subtasks/{id_subtask}

Parámetros de entrada

ParámetroTipoRequeridoDescripción
id_subtaskenteroSí (en la ruta)Identificador de la subtarea. Se obtiene en el campo id de la respuesta de Crear subtareas en una tarea de un plan de tareas. La tarea a la que pertenece se deduce de la subtarea.

Parámetros del cuerpo

Se envían en formato JSON. Todos son opcionales, pero debes enviar al menos uno de los campos editables (id_task_form_item_type, description, task_form_item_group_description, id_unit, unit_description, dropdown_options, iterations, is_required o attachments_required).

ParámetroTipoRequeridoDescripción
id_task_form_item_typeenteroNoTipo de subtarea, de 1 a 8: 1 Texto, 2 Sí/No, 3 Número, 4 Verificación, 5 Lectura de medidor, 6 Localización GPS, 7 Lista, 8 Fecha y hora.
descriptiontextoNoEtiqueta o pregunta de la subtarea. No puede estar vacía ni contener solo espacios.
task_form_item_group_descriptiontextoNoNombre del grupo al que pertenece la subtarea (entre 1 y 150 caracteres). Se busca por similitud con los grupos existentes; si no hay coincidencia, el grupo se crea.
id_unitenteroCondicionalIdentificador de la unidad de medida. Solo aplica a subtareas de tipo 5. Debe existir en las unidades de la compañía.
unit_descriptiontextoCondicionalNombre de la unidad de medida (máximo 50 caracteres). Solo aplica a subtareas de tipo 5. Se busca por similitud con las unidades existentes; si no hay coincidencia, la unidad se crea.
dropdown_optionsarray de objetosCondicionalOpciones de la lista. Solo aplica a subtareas de tipo 7. Mínimo 2 elementos. Ver estructura en la tabla siguiente.
iterationsobjetoNoIteraciones en las que participa la subtarea, con el formato { "iteration_1": true, "iteration_2": false }. Solo se tiene en cuenta en tareas cíclicas.
is_requiredbooleanoNoIndica si la subtarea es obligatoria.
attachments_requiredbooleanoNoIndica si la subtarea exige adjuntos.
is_cyclicalbooleanoNoIndica si la tarea es cíclica. Si se envía, debe coincidir con la configuración de la tarea; este servicio no la modifica.
num_iterationsenteroNoNúmero de iteraciones de la tarea. Si se envía, debe ser mayor que 0 y coincidir con la configuración de la tarea; este servicio no la modifica.

Estructura de cada elemento en dropdown_options:

ParámetroTipoRequeridoDescripción
descriptiontextoSíTexto de la opción. No puede estar vacío.

Reglas de la edición

  • Las reglas por tipo se aplican sobre el tipo efectivo de la subtarea: el que envías en id_task_form_item_type o, si no lo envías, el que ya tiene.
  • Al pasar a tipo 7 (Lista) debes enviar dropdown_options con al menos 2 opciones.
  • Al pasar a tipo 5 (Lectura de medidor) debes enviar id_unit o unit_description, salvo que la subtarea ya tenga una unidad asignada.
  • Si la tarea tiene activos vinculados y la subtarea pasa a tipo 5, la subtarea se actualiza pero message llega como ERROR_CONFIG_METERS_ASSETS: falta configurar el medidor de cada activo desde Fracttal.
  • Al salir del tipo 7, se eliminan las opciones de la lista de la subtarea.
  • Al salir del tipo 5, se elimina la unidad de la subtarea y los medidores asociados a ella.
  • dropdown_options solo se acepta en subtareas de tipo 7; id_unit y unit_description solo en subtareas de tipo 5.
  • iterations se fusiona con las iteraciones actuales de la subtarea: solo cambian las iteraciones que envías. Cada iteration_n debe estar entre 1 y el número de iteraciones de la tarea. En una tarea que no es cíclica, iterations se ignora.
  • Una subtarea de otra compañía se trata igual que una inexistente (404).

Parámetros de salida

ParámetroTipoDescripción
successbooleanotrue si la subtarea se actualizó.
messagetexto200 cuando la operación es exitosa, o ERROR_CONFIG_METERS_ASSETS si la subtarea se actualizó pero falta configurar los medidores de los activos vinculados. En caso de error, contiene el código del error.
totalentero1 cuando la operación es exitosa.
dataobjetoSubtarea actualizada.
data.identeroIdentificador de la subtarea.
data.id_taskenteroIdentificador de la tarea a la que pertenece.
data.id_task_form_item_typeenteroTipo de subtarea (1 a 8).
data.id_unitenteroIdentificador de la unidad de medida. null si la subtarea no es de tipo 5.
data.descriptiontextoEtiqueta o pregunta de la subtarea.
data.order_numberenteroPosición de la subtarea dentro de la tarea.
data.is_requiredbooleanoIndica si es obligatoria.
data.attachments_requiredbooleanoIndica si exige adjuntos.
data.id_task_form_item_groupenteroIdentificador del grupo de la subtarea. null si no tiene grupo.
data.iterationsobjetoIteraciones en las que participa la subtarea.
data.dropdown_optionsarray de objetosOpciones de la lista. null si la subtarea no es de tipo 7.

Errores

CódigoCausa
400body is required: falta el cuerpo de la petición.
400at least one editable field must be sent: no se envió ningún campo editable.
400id_task_form_item_type must be between 1 and 8: tipo de subtarea no válido.
400description cannot be empty: la descripción está vacía o solo tiene espacios.
400is_required must be a boolean, attachments_required must be a boolean o is_cyclical must be a boolean: el valor enviado no es booleano.
400task_form_item_group_description must have between 1 and 150 characters: nombre de grupo vacío o demasiado largo.
400num_iterations must be greater than 0: num_iterations no es mayor que 0.
400dropdown_options only applies to list subtasks: se enviaron opciones para una subtarea que no es de tipo 7.
400dropdown_options requires at least 2 elements for list subtasks: lista con menos de 2 opciones.
400every dropdown option must have a non-empty description: una opción sin description.
400id_unit must be an integer and unit_description at most 50 characters: id_unit no es entero o unit_description supera los 50 caracteres.
400id_unit and unit_description only apply to meter reading subtasks: se envió unidad para una subtarea que no es de tipo 5.
400id_unit or unit_description is required for meter reading subtasks: lectura de medidor sin unidad.
400iterations must be an object o iterations must use the format {"iteration_n": true|false}: formato de iterations no válido.
400iteration_n does not exist in task (num_iterations=n): iteración fuera del rango de la tarea.
401INVALID_TOKEN: el token de autenticación no es válido.
403User does not have edit permission over TASKS > PLAN_TASKS: el perfil del token no puede editar planes de tareas.
404subtask not found: la subtarea no existe o pertenece a otra compañía.
409is_cyclical does not match the task configuration: is_cyclical no coincide con la tarea.
409num_iterations does not match the task configuration: num_iterations no coincide con la tarea.
422id_unit n does not exist: id_unit no existe en las unidades de la compañía.
500Error interno del sistema.

Nota sobre los códigos de error

Cuando la operación falla, el código del error llega en el campo message (por ejemplo "404" o "409") y el detalle en data[0].ERROR. La respuesta HTTP de los errores de validación es 400, sin importar el valor de message; usa message para distinguir la causa. Un token inválido responde con HTTP 401.


Ejemplo

Request body

PUT /api/tasks_subtasks/6102

{
  "description": "Estado del rodamiento tras la inspección",
  "is_required": true,
  "attachments_required": true,
  "id_task_form_item_type": 7,
  "dropdown_options": [
    { "description": "Bueno" },
    { "description": "Desgastado" },
    { "description": "Reemplazar" }
  ]
}

Response 200

{
  "success": true,
  "message": "200",
  "data": {
    "id": 6102,
    "id_task": 5001,
    "id_task_form_item_type": 7,
    "id_unit": null,
    "description": "Estado del rodamiento tras la inspección",
    "order_number": 3,
    "is_required": true,
    "attachments_required": true,
    "id_task_form_item_group": null,
    "iterations": {},
    "dropdown_options": [
      { "description": "Bueno" },
      { "description": "Desgastado" },
      { "description": "Reemplazar" }
    ]
  },
  "total": 1
}

Response — Cambio a lectura de medidor en una tarea con activos vinculados (200)

Request body:

{
  "id_task_form_item_type": 5,
  "unit_description": "Grados Celsius"
}

Response:

{
  "success": true,
  "message": "ERROR_CONFIG_METERS_ASSETS",
  "data": {
    "id": 6103,
    "id_task": 5002,
    "id_task_form_item_type": 5,
    "id_unit": 215,
    "description": "Temperatura del motor",
    "order_number": 1,
    "is_required": false,
    "attachments_required": false,
    "id_task_form_item_group": null,
    "iterations": {},
    "dropdown_options": null
  },
  "total": 1
}

Response — Lista con menos de 2 opciones (400)

{
  "success": false,
  "message": "400",
  "data": [
    {
      "ERROR": "dropdown_options requires at least 2 elements for list subtasks"
    }
  ],
  "total": "0"
}

Response — Subtarea inexistente (404)

{
  "success": false,
  "message": "404",
  "data": [
    {
      "ERROR": "subtask not found"
    }
  ],
  "total": "0"
}

Response — is_cyclical no coincide con la tarea (409)

{
  "success": false,
  "message": "409",
  "data": [
    {
      "ERROR": "is_cyclical does not match the task configuration"
    }
  ],
  "total": "0"
}

Response — Unidad inexistente (422)

{
  "success": false,
  "message": "422",
  "data": [
    {
      "ERROR": "id_unit 999999 does not exist"
    }
  ],
  "total": "0"
}

OpenAPI definition

{
  "openapi": "3.1.0",
  "info": {
    "title": "tasks_subtasks",
    "version": "1-Es"
  },
  "servers": [
    { "url": "https://app.fracttal.com/api/tasks_subtasks" }
  ],
  "security": [{}],
  "paths": {
    "/{id_subtask}": {
      "put": {
        "summary": "Actualizar una subtarea de una tarea de un plan de tareas",
        "description": "",
        "operationId": "actualizar-una-subtarea-de-una-tarea-de-un-plan-de-tareas",
        "deprecated": false,
        "security": []
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": false,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
Path Params
integer
required
Response
200
Language
LoadingLoading…