1. 엔드포인트

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

2. 인증

x-api-key 헤더에 API 키를 포함시켜야 합니다:

x-api-key
x-api-key: {yourAPIKey}

3. 요청 파라미터

URL 쿼리 스트링 형태로 추가하여야 합니다.

projectionId
string
required

고유한 Projection 의 ID

4. 요청 예시

파라메터 기재시 projectionId 값만 기재하셔야 합니다. projectionId= 형식으로 기재하시면 동작하지 않습니다.

GET/Projection
curl --location 'https://rest-api.argosidentity.com/v3/projection/{projectrionId}' \
--header 'x-api-key: {yourAPIKey}'

5. 응답

5-1. 성공 응답

{
    "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. 응답 데이터 필드

필드명설명데이터 타입카테고리
projection_id고유의 Projection IDStringProjection Info
nameProjection 의 지정된 이름StringProjection Info
modeProjection 모드를 설정함 현재는exclude 옵션만 지원합니다.StringProjection Info
fields제외 시킬 Field 항목들Array<String>Projection Info
created_at생성 날짜 (ISO 8601 형식)StringProjection Info

5-3. 오류 코드

응답 코드오류 메시지설명
404Projection not found지정한 projectionId 가 프로젝션 목록에 없는 경우
405Method not allowed for /projections/projectionId pathGET, DELETE 이외의 HTTP 메서드(POST, PUT 등)로 요청한 경우
500Internal server error서버 내부에서 처리되지 않은 예외가 발생한 경우