GET/Projection/projectionId

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:

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 Name	Descripción	Data Type	Category
`projection_id`	El ID único de la proyección generada	String	Projection Info
`name`	El nombre de la proyección	String	Projection Info
`mode`	El modo de proyección. Actualmente, solo existe la opción `exclude`.	String	Projection Info
`fields`	La lista para excluir campos específicos.	Array<String>	Projection Info
`created_at`	Hora de creación (Tipo ISO 8601)	String	Projection Info

5-3. Códigos de Error

Status Code	Error Message	Descripción
404	Projection not found	Cuando los campos requeridos (name, mode, fields) faltan en el cuerpo de la solicitud
405	Method not allowed for /projections/projectionId path	Las solicitudes HTTP (PUT, DELETE, etc.) no son GET o POST.
500	Internal server error	Cuando el servidor encuentra un error de excepción inesperado

Descripción General

Referencia API

GET/Projection/projectionId

1. Endpoint

2. Autenticación

3. Cuerpo de la Solicitud

4. Ejemplo de Solicitud

5. Respuesta

5-1. Respuesta Exitosa

5-2. Campos de Respuesta

5-3. Códigos de Error

​1. Endpoint

​2. Autenticación

​3. Cuerpo de la Solicitud

​4. Ejemplo de Solicitud

​5. Respuesta

​5-1. Respuesta Exitosa

​5-2. Campos de Respuesta

​5-3. Códigos de Error

1. Endpoint

2. Autenticación

3. Cuerpo de la Solicitud

4. Ejemplo de Solicitud

5. Respuesta

5-1. Respuesta Exitosa

5-2. Campos de Respuesta

5-3. Códigos de Error