Saltar al contenido

Update a rider line

Módulo Advancing

PATCH/rider-lines/{id}riderLines.update

A rider line, reconciled against capabilities. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

  • Requiere la capacidad advancing.rider.write.
  • Alcances de OAuth: advancing.
  • Envía If-Match con el ETag que leíste. Una etiqueta desactualizada devuelve 412; si falta, devuelve 428.
  • Estados de error: 400, 401, 404, 412, 422, 428, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

riderLines.update: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the rider line.

Cuerpo de la solicitud: RiderLineUpdate

riderLines.update: RiderLineUpdate
CampoTipoObligatorioDescripción
quantitynumber | nullNoQuantity.
descriptionstringNoWhat is asked.Restricciones: length 1 to 500
element_idstring | nullNoCatalog element that fulfills the ask.Restricciones: length 1 to 64
fulfilled_atstring (date-time) | nullNoWhen the ask was fulfilled; NULL while open.
{
  "quantity": 2,
  "description": "Two wedge monitors per vocalist.",
  "element_id": "5000.02.01-NWL-001",
  "fulfilled_at": "2026-10-08T14:30:00Z"
}

Respuesta 200: RiderLine

riderLines.update: RiderLine
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the rider line.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
rider_idstring (uuid)SíIdentifier of the rider.
quantitynumber | nullSíQuantity.
descriptionstringSíWhat is asked.Restricciones: length 1 to 500
element_idstring | nullSíCatalog element that fulfills the ask.Restricciones: length 1 to 64
fulfilled_atstring (date-time) | nullSíWhen the ask was fulfilled; NULL while open.
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "rider_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "quantity": 2,
  "description": "Two wedge monitors per vocalist.",
  "element_id": "5000.02.01-NWL-001",
  "fulfilled_at": "2026-10-08T14:30:00Z"
}

Ejemplos de código

curl -X PATCH "$XOS_BASE_URL/rider-lines/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"quantity":2,"description":"Two wedge monitors per vocalist.","element_id":"5000.02.01-NWL-001","fulfilled_at":"2026-10-08T14:30:00Z"}'
const { data, etag } = await xos.riderLines.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "quantity": 2,
    "description": "Two wedge monitors per vocalist.",
    "element_id": "5000.02.01-NWL-001",
    "fulfilled_at": "2026-10-08T14:30:00Z"
  }, { ifMatch: etag });
response = xos.rider_lines.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"quantity": 2, "description": "Two wedge monitors per vocalist.", "element_id": "5000.02.01-NWL-001", "fulfilled_at": "2026-10-08T14:30:00Z"}, if_match=etag)
xos rider-lines update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"quantity":2,"description":"Two wedge monitors per vocalist.","element_id":"5000.02.01-NWL-001","fulfilled_at":"2026-10-08T14:30:00Z"}' --if-match auto