Actualizar parte de un activo

Actualización parcial, como el PATCH de HubSpot: cambia solo lo que se envía. Acepta los mismos campos propios que el PUT con sus mismas reglas, pero todos opcionales (no hace falta reenviar name ni assetTypeId), y customFields mezclado por clave: las claves enviadas se escriben, null o "" borran el valor y las ausentes no se tocan. El cuerpo debe traer al menos un campo.

Con idField el activo se resuelve por valor, por ejemplo PATCH /api/assets/ASM-001?idField=codigo_de_inventario con { "customFields": { "area": "taller" } }.

Validaciones:

• 400 ASSET_CUSTOM_FIELD_VALUE_INVALID nombrando la clave si un valor no cumple el tipo, una regla o las opciones, o si la clave es desconocida o de un campo archivado.
• 400 si vacía un campo obligatorio. No exige los otros obligatorios que el activo no tenga: esos los exigen el POST y el PUT.
• 409 ASSET_CUSTOM_FIELD_VALUE_CONFLICT si un campo con Valor único ya lo tiene otro activo (details.asset con su id, nombre y patente).
• Un activo genérico sigue necesitando su equipo principal: si el PATCH cambia los equipos o el tipo, el resultado debe ser válido para el tipo.

Registra asset_updated en el Registro de actividades con los cambios y el canal.

Permisos requeridos: access_fleet_assets

PATCH /api/assets/{id}

Actualizar parte de un activo

cURL

curl --request PATCH \
  --url https://api.ugps.io/api/assets/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "icon": {
    "id": "<string>",
    "color": "<string>"
  },
  "mainTrackerId": 123,
  "trackers": [
    {
      "id": 123,
      "platform": "<string>"
    }
  ],
  "plate": "<string>",
  "assetTypeId": "<string>",
  "vehicleTypeId": "<string>",
  "model": "<string>",
  "year": 123,
  "color": "<string>",
  "make": "<string>",
  "chassis": "<string>",
  "motor": "<string>",
  "fuel": "<string>",
  "kilometer": 123,
  "technicalInspection": {
    "date": "2023-12-25",
    "result": "<string>",
    "resultGas": "<string>",
    "month": "<string>",
    "station": {
      "code": "<string>",
      "region": "<string>",
      "commune": "<string>",
      "concession": "<string>",
      "address": "<string>"
    }
  },
  "description": "<string>",
  "clientId": "<string>",
  "state": "<string>",
  "customFields": {
    "codigo_de_inventario": "ASM-001",
    "area": "taller_mecanico",
    "arrendado": false
  },
  "currentDriver": {
    "id": "<string>",
    "name": "<string>"
  }
}
'

200

{
  "status": "success",
  "data": {
    "name": "<string>",
    "icon": {
      "id": "<string>",
      "color": "<string>"
    },
    "mainTrackerId": 123,
    "trackers": [
      {
        "id": 123,
        "platform": "<string>"
      }
    ],
    "plate": "<string>",
    "assetTypeId": "<string>",
    "kind": "vehicle",
    "vehicleTypeId": "<string>",
    "model": "<string>",
    "year": 123,
    "color": "<string>",
    "make": "<string>",
    "chassis": "<string>",
    "motor": "<string>",
    "fuel": "<string>",
    "kilometer": 123,
    "technicalInspection": {
      "date": "2023-12-25",
      "result": "<string>",
      "resultGas": "<string>",
      "month": "<string>",
      "station": {
        "code": "<string>",
        "region": "<string>",
        "commune": "<string>",
        "concession": "<string>",
        "address": "<string>"
      }
    },
    "description": "<string>",
    "clientId": "<string>",
    "state": "<string>",
    "customFields": {
      "codigo_de_inventario": "ASM-001",
      "area": "taller_mecanico",
      "arrendado": false
    },
    "currentDriver": {
      "id": "<string>",
      "name": "<string>"
    }
  }
}

Authorizations

Authorization · string · header · required

Token de sesión Better Auth o API token (atk_...) en el header Authorization: Bearer <token>. Los JWT legacy ya no son válidos.

Path Parameters

id · string · required

ID del recurso

Query Parameters

idField · string

Resuelve el activo por valor en vez de por id: el segmento {id} de la ruta pasa a ser el valor buscado. Acepta plate, name o el Nombre interno de un Campo personalizado activo con Valor único (rules.unique). El texto se compara sin distinguir mayúsculas, tildes ni espacios de los extremos. Sin coincidencia responde 404 ASSET_NOT_FOUND; si más de un activo tiene el valor (patente o nombre repetidos), 409 ASSET_ID_FIELD_AMBIGUOUS con los activos en details.assets; un campo que no es plate, name ni un campo único, 400 ASSET_ID_FIELD_INVALID. Sin idField, {id} es el id del activo.

Example:

"codigo_de_inventario"

Body

application/json

Cuerpo del PATCH parcial: los mismos campos del activo, todos opcionales (también name y assetTypeId), con las mismas reglas que el PUT. Solo cambia lo que se envía; customFields se mezcla por clave. Debe traer al menos un campo.

name · string · required

icon · object · required

Show child attributes

mainTrackerId · number · required

trackers · object[] · required

Show child attributes

plate · string · required

assetTypeId · string · required

kind · enum<string>

Familia canonica del activo. Se rellena de forma compatible con tipos antiguos.

Available options: vehicle, generic

vehicleTypeId · string

ID del tipo de vehículo asociado al activo (opcional)

model · string

Modelo del activo (opcional)

year · number

color · string

Color del activo (opcional)

make · string

chassis · string

Número de chasis del activo (opcional)

motor · string

Número de motor del activo (opcional)

fuel · string

Tipo de combustible del activo (opcional)

kilometer · number

Kilometraje del activo (opcional)

technicalInspection · object

Revisión técnica del vehículo (opcional). La puebla la consulta vehicular por patente y también se puede editar a mano. Solo aplica a activos de kind vehicle: en los generic se limpia.

Show child attributes

description · string

Descripción adicional del activo (opcional)

clientId · string

state · string

Estado del activo (opcional)

customFields · object

Valores de los Campos personalizados de la empresa, una clave por Nombre interno (GET /api/asset-custom-fields lista las definiciones). Formato por tipo: text string (se guarda recortado, hasta 1.000 caracteres), number número, date YYYY-MM-DD, select el value de una opción activa, boolean true o false.

En las respuestas (GET de lista y detalle) siempre está presente, con solo los campos activos: una clave ausente significa «sin valor»; los valores de un campo archivado no salen y vuelven al restaurarlo.

Al escribir (POST, PUT, PATCH) se mezcla por clave: las claves enviadas se escriben, null o "" borran el valor y las ausentes no se tocan. Una clave desconocida, de un campo archivado o con un valor que no cumple el tipo o las reglas responde 400 ASSET_CUSTOM_FIELD_VALUE_INVALID nombrando la clave. En POST y PUT, después de mezclar, el activo debe quedar con todos los campos obligatorios completos (400 listando los que faltan); el PATCH solo falla si vacía un obligatorio. El 400 trae en details la clave (key) y, si aplica, la regla que no se cumple (rule), o los obligatorios que faltan (missingFields).

Show child attributes

Example:

{
  "codigo_de_inventario": "ASM-001",
  "area": "taller_mecanico",
  "arrendado": false
}

currentDriver · object | null

Conductor vigente del activo (vínculo conductor-activo abierto).

Show child attributes

Response

200

application/json

Activo actualizado

status · string

Example:

"success"

data · object

Show child attributes