Propiedades personalizadas

Pares nombre/valor propios guardados en el contrato.

GET/api/contracts/{contractId}/customproperties

Listar propiedades personalizadas

Autenticación. Cabecera apikey con tu API key, o Authorization: Bearer con un token.

Parámetros de ruta

  • contractIdstringobligatorio

    ID del contrato.

Respuestas

  • 200object
    Campos de la respuesta
    • customPropertiesarray<object>obligatorio
      3 campos
      • idstringobligatorio

        ID para editar o borrar la propiedad.

      • namestringobligatorio
      • valuestringobligatorio
  • 400Petición no válida: parámetros, contrato inexistente o en un estado que no lo permite.
  • 401Credencial ausente, caducada o de otro entorno.
  • 403Al usuario le falta un privilegio (p. ej. API_ACCESS).

Petición

GET
/api/contracts/{contractId}/customproperties
curl "https://enterprise-stage.api.trato.io/api/contracts/{contractId}/customproperties" \
  -H "apikey: $TRATO_API_KEY"

Respuesta

{
  "customProperties": [
    {
      "id": "string",
      "name": "centroDeCoste",
      "value": "CC-1200"
    }
  ]
}
POST/api/contracts/{contractId}/customproperties

Añadir propiedades personalizadas

Pares nombre/valor propios en el contrato. Requiere SET_CUSTOM_PROPERTIES.

Autenticación. Cabecera apikey con tu API key, o Authorization: Bearer con un token.

Parámetros de ruta

  • contractIdstringobligatorio

    ID del contrato.

Cuerpo application/json

  • propertiesarray<object>obligatorio

    Propiedades que se añaden al contrato.

    2 campos
    • namestringobligatorio

      Nombre de la propiedad (se quitan los espacios). Único en el contrato.

    • valuestringobligatorio

      Valor de la propiedad.

Respuestas

  • 200object
    Campos de la respuesta
    • successbooleanobligatorio
  • 400Petición no válida: parámetros, contrato inexistente o en un estado que no lo permite.
  • 401Credencial ausente, caducada o de otro entorno.
  • 403Al usuario le falta un privilegio (p. ej. API_ACCESS).

Petición

POST
/api/contracts/{contractId}/customproperties
curl -X POST "https://enterprise-stage.api.trato.io/api/contracts/{contractId}/customproperties" \
  -H "apikey: $TRATO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "properties": [
    {
      "name": "centroDeCoste",
      "value": "CC-1200"
    }
  ]
}'

Respuesta

{
  "success": true
}
PUT/api/contracts/{contractId}/{propertyId}/customproperties

Editar una propiedad personalizada

Autenticación. Cabecera apikey con tu API key, o Authorization: Bearer con un token.

Parámetros de ruta

  • contractIdstringobligatorio

    ID del contrato.

  • propertyIdstringobligatorio

    ID de la propiedad (id en el listado).

Cuerpo application/json

  • namestringobligatorio

    Nombre de la propiedad (se quitan los espacios). Único en el contrato.

  • valuestringobligatorio

    Valor de la propiedad.

Respuestas

  • 200object
    Campos de la respuesta
    • sucessbooleanobligatorio

      Escrito así (sucess) por compatibilidad.

  • 400Petición no válida: parámetros, contrato inexistente o en un estado que no lo permite.
  • 401Credencial ausente, caducada o de otro entorno.
  • 403Al usuario le falta un privilegio (p. ej. API_ACCESS).

Petición

PUT
/api/contracts/{contractId}/{propertyId}/customproperties
curl -X PUT "https://enterprise-stage.api.trato.io/api/contracts/{contractId}/{propertyId}/customproperties" \
  -H "apikey: $TRATO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "centroDeCoste",
  "value": "CC-1200"
}'

Respuesta

{
  "sucess": true
}
DELETE/api/contracts/{contractId}/{propertyId}/customproperties

Borrar una propiedad personalizada

Autenticación. Cabecera apikey con tu API key, o Authorization: Bearer con un token.

Parámetros de ruta

  • contractIdstringobligatorio

    ID del contrato.

  • propertyIdstringobligatorio

    ID de la propiedad (id en el listado).

Respuestas

  • 200object
    Campos de la respuesta
    • sucessbooleanobligatorio

      Escrito así (sucess) por compatibilidad.

  • 400Petición no válida: parámetros, contrato inexistente o en un estado que no lo permite.
  • 401Credencial ausente, caducada o de otro entorno.
  • 403Al usuario le falta un privilegio (p. ej. API_ACCESS).

Petición

DELETE
/api/contracts/{contractId}/{propertyId}/customproperties
curl -X DELETE "https://enterprise-stage.api.trato.io/api/contracts/{contractId}/{propertyId}/customproperties" \
  -H "apikey: $TRATO_API_KEY"

Respuesta

{
  "sucess": true
}