MENU
      스키마 설명 수정

        스키마 설명 수정


        기사 요약

        Classic/VPC 환경에서 이용 가능합니다.

        스키마의 설명을 수정합니다.

        요청

        요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

        메서드URI
        PUT/schemas/{schemaName}

        요청 헤더

        AiTEMS API에서 공통으로 사용하는 헤더에 대한 정보는 AiTEMS 공통 헤더를 참조해 주십시오.

        요청 경로 파라미터

        파라미터에 대한 설명은 다음과 같습니다.

        필드타입필수 여부설명
        schemaNameStringRequired스키마 이름

        요청 바디

        요청 바디에 대한 설명은 다음과 같습니다.

        필드타입필수 여부설명
        contentStringRequired스키마에 대한 설명
        • 0~100자

        요청 예시

        요청 예시는 다음과 같습니다.

        curl --location --request GET 'https://aitems.apigw.ntruss.com/api/v1/schemas/item_schema' \
        --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' \
        --data '{
            "content": "description"
        }'
        Shell

        응답

        응답 형식을 설명합니다.

        응답 바디

        응답 바디에 대한 설명은 다음과 같습니다.

        필드타입필수 여부설명
        datasetTypeString-데이터셋 타입
        • user | item | interaction
          • user: 사용자 정보(연령, 성별 등)를 담은 데이터
          • item: 상품 관련 정보(가격, 출시일, 카테고리 등)를 담은 데이터
          • interaction: 사용자와 상품 간 상호작용으로 얻은 기록을 담은 데이터
        nameString-스키마 이름
        fieldsArray-스키마 필드 정보
        descriptionString-스키마에 대한 설명
        createdDateString-스키마 생성 일시

        fields

        fields에 대한 설명은 다음과 같습니다.

        필드타입필수 여부설명
        nameString-스키마 필드의 이름
        typeArray-스키마 필드의 데이터 타입
        • string | int | long | boolean | null
        categoricalBoolean-범주형 필드 여부
        • true | false
          • true: 범주가 정해진 데이터
          • false: 범주가 정해지지 않은 데이터
        • false일 경우 표시되지 않음

        응답 상태 코드

        AiTEMS API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 AiTEMS API 공통 응답 상태 코드를 참조해 주십시오.

        응답 예시

        응답 예시는 다음과 같습니다.

        {
            "datasetType": "item",
            "name": "item_schema",
            "fields": [
                {
                    "name": "ITEM_ID",
                    "type": [
                        "string"
                    ]
                },
                {
                    "name": "TAG_ID",
                    "type": [
                        "int",
                        "long"
                    ]
                },
                {
                    "name": "TAGWEIGHT",
                    "type": [
                        "int"
                    ]
                }
            ],
            "description": "description",
            "createdDate": "2024-07-30T08:56:29.040"
        }
        JSON

        이 문서가 도움이 되었습니까?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.