Proyectos · API PÚBLICA V1

Listar ubicaciones

Lista las ubicaciones del proyecto. Su descripción no se edita desde el repaso.

Conectar con un entornoSin token

La petición sale de tu navegador hacia el entorno indicado. La API key y el token permanecen en la memoria de esta página.

Introduce las credenciales del entorno que quieras probar.

GET/api/public/v1/projects/{projectId}/situations

snag-points:read

Parámetros

projectIduuidobligatorioruta

Proyecto.

limitinteger1..200opcionalquery

Número máximo de elementos por página. Por defecto 50, máximo 200.

cursorstringopcionalquery

Cursor opaco para continuar desde la respuesta anterior.

modifiedSincedate-time localopcionalquery

Incluye registros creados o modificados después de esta fecha, interpretada en el timezone del tenant.

Respuesta

200Ubicaciones.

PublicSnagPointCatalogue

Elemento de catálogo

Categoría, responsable o ubicación seleccionable.

PropiedadTipoDescripción

idobligatoriouuidIdentificador.

codeobligatoriostringCódigo.

nameobligatoriostringNombre.

Ejemplo JSON

{
  "id": "a51a588c-b413-4ca7-8a23-1664683f9cb4",
  "code": "PORTAL",
  "name": "Portal"
}

Ejemplo de respuesta

{
  "items": [
    {
      "id": "a51a588c-b413-4ca7-8a23-1664683f9cb4",
      "code": "PORTAL",
      "name": "Portal"
    }
  ],
  "nextCursor": "eyJ2ZXJzaW9uIjoxLCJvZmZzZXQiOjUwfQ",
  "hasMore": true
}

Errores

400Solicitud incorrectaapplication/json

401Autenticación inválida o no proporcionadaapplication/json

403Permisos insuficientesapplication/json

404Recurso no encontradoapplication/json

409Conflicto con el estado actualapplication/json

410Recurso ya no disponibleapplication/json

422Error de validaciónapplication/json

429Límite de solicitudes excedidoapplication/json

Ver modelo de error

PublicApiError

Error de API

Formato estable de los errores públicos.

PropiedadTipoDescripción

statusobligatoriointegerCódigo HTTP.

codeobligatoriostringCódigo estable para tratamiento automático.

messageobligatoriostringMensaje legible.

correlationIdobligatoriostringIdentificador para soporte y trazabilidad.

currentConcurrencyTokenstring | nullToken actual cuando existe un conflicto.

validationErrorsobject<string,string[]>Errores agrupados por campo.

Ejemplo JSON

{
  "status": 422,
  "code": "validation_error",
  "message": "The request is invalid.",
  "correlationId": "01J9EXAMPLE",
  "validationErrors": {
    "unitCode": [
      "The unit does not exist."
    ]
  }
}

Probar endpointPetición directa desde el navegador

Petición

RespuestaSin ejecutar

Configura la conexión y ejecuta la petición.