Modify schema description
    • PDF

    Modify schema description

    • PDF

    Article summary

    The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.

    Edit a schema description.

    PUT https://aitems.apigw.ntruss.com/api/v1/schemas/{schemaName}
    

    Request

    Request body

    Parameter nameRequirement statusTypeRestrictionsDescription
    contentYesStringEnter 0 to 100 charactersDataset description

    Response

    Field nameTypeDescriptionRemarks
    datasetTypeStringAvailable dataset types
    nameStringSchema name
    fields[].nameStringSchema field name
    fields[].typeArraySchema field type
    fields[].categoricalBooleanCategorical field status
    descriptionStringSchema description
    createdDateStringSchema creation date

    Response status

    HTTP StatusDesc
    200OK (Successfully edited)
    400Bad Request
    401Unauthorized
    403Forbidden
    404Not Found
    500Internal Server Error

    Examples

    Request example

    PUT /api/v1/schemas/LogInfo
    Host: aitems.apigw.ntruss.com
    accept: application/json
    x-ncp-iam-access-key: {Access key}
    x-ncp-apigw-signature-v2: {API GW signature}
    x-ncp-apigw-timestamp: {timestamp}
    
    {
      "content": "desc"
    }
    
    

    Response example

    {
      "name": "LogInfo",
      "fields": [
        {
          "name": "TIMESTAMP",
          "type": [
            "long"
          ]
        },
        {
          "name": "USER_ID",
          "type": [
            "string"
          ]
        },
        {
          "name": "ITEM_ID",
          "type": [
            "string"
          ]
        }
      ],
      "description": "desc",
      "createdDate": "2021-08-21T15:40:56.049"
    }
    

    Was this article helpful?

    What's Next
    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.