Saltar al contenido principal

​
1. Endpoint

GET/Projection
GET https://rest-api.argosidentity.com/v3/projection/{projectionId}

​
2. Autenticación

Incluya la clave API en el encabezado x-api-key:
x-api-key
x-api-key: {yourAPIKey}

​
3. Cuerpo de la Solicitud

Los parámetros de solicitud deben enviarse como parámetros de consulta URL. A continuación se encuentran las descripciones de los parámetros:
​
projectionId
string
requerido
El ID único de una proyección

​
4. Ejemplo de Solicitud

No se requiere un nombre de parámetro; projectionId solo requiere un valor.
GET/Projection
curl --location 'https://rest-api.argosidentity.com/v3/projection/{projectionId}' \
--header 'x-api-key: {yourAPIKey}'

​
5. Respuesta

​
5-1. Respuesta Exitosa

{
    "item": {
        "projection_id": "{projection_id}",
        "name": "{name}",
        "mode": "{mode}",
        "fields": [
            "gender",
            "nationality"
        ],
        "created_at": "2023-12-01T12:34:56.789Z"
    },
    "message": "Get projection success"
}

​
5-2. Campos de Respuesta

Field NameDescripciónData TypeCategory
projection_idEl ID único de la proyección generadaStringProjection Info
nameEl nombre de la proyecciónStringProjection Info
modeEl modo de proyección. Actualmente, solo existe la opción exclude.StringProjection Info
fieldsLa lista para excluir campos específicos.Array<String>Projection Info
created_atHora de creación (Tipo ISO 8601)StringProjection Info

​
5-3. Códigos de Error

Status CodeError MessageDescripción
404Projection not foundCuando los campos requeridos (name, mode, fields) faltan en el cuerpo de la solicitud
405Method not allowed for /projections/projectionId pathLas solicitudes HTTP (PUT, DELETE, etc.) no son GET o POST.
500Internal server errorCuando el servidor encuentra un error de excepción inesperado