기본 스키마 정보 조회
- 인쇄
- PDF
기본 스키마 정보 조회
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
Classic/VPC 환경에서 이용 가능합니다.
데이터셋 타입에 따라 필수로 구성되는 기본 스키마 정보를 조회합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
메서드 | URI |
---|---|
GET | /schemas/default |
요청 헤더
AiTEMS API에서 공통으로 사용하는 헤더에 대한 정보는 AiTEMS 공통 헤더를 참조해 주십시오.
요청 쿼리 파라미터
파라미터에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
datasetType | String | Required | 데이터셋 타입
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request GET 'https://aitems.apigw.ntruss.com/api/v1/schemas/default
?datasetType=interaction' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
datasetType | String | - | 데이터셋 타입
|
name | String | - | 스키마 이름 |
fields | Array | - | 스키마 필드 정보 |
description | String | - | 스키마에 대한 설명 |
fields
fields
에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
name | String | - | 스키마 필드 이름 |
type | Array | - | 스키마 필드의 데이터 타입
|
categorical | Boolean | - | 범주형 필드 여부
|
응답 상태 코드
AiTEMS API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 AiTEMS API 공통 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
{
"datasetType": "user",
"name": "user-sample",
"fields": [
{
"name": "USER_ID",
"type": [
"string"
]
}
],
"description": ""
}
이 문서가 도움이 되었습니까?