MENU
      Viewing category list
        • PDF

        Viewing category list

        • PDF

        Article summary

        VOD Station provides an API for searching a list of categories.

        Requests

        GET https://vodstation.apigw.ntruss.com/api/v2/category
        HTTP

        Request parameters

        Parameter nameRequirement statusTypeRestrictionsDescription
        pageNoNoInteger- Page number to request
        Total page number is total/pageSizeNo
        pageSizeNoNoIntegerNumber of categories per page

        Search created categories by page

        • Example: searching the category list to view 10 categories per page when 30 categories have been created
        GET https://vodstation.apigw.ntruss.com/api/v2/category?pageNo=1&pageSizeNo=10
        → Request the first page from a total of 30 categories, separated by 10 per page
        
        GET https://vodstation.apigw.ntruss.com/api/v2/category?pageNo=2&pageSizeNo=10
        → Request the second page from a total of 30 categories, separated by 10 per page
        
        GET https://vodstation.apigw.ntruss.com/api/v2/category?pageNo=3&pageSizeNo=10
        → Request the third page from a total of 30 categories, separated by 10 per page
        Plain text

        Request headers

        Header nameDescription
        x-ncp-region_codeNAVER Cloud Platform's region code
        x-ncp_region_code:{Region Code}
        x-ncp-apigw-timestampThis is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC
        If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.
        x-ncp-apigw-timestamp:{Timestamp}
        x-ncp-iam-access-keyAccess key ID value issued by the NAVER Cloud Platform portal
        x-ncp-iam-access-key:{Sub Account Access Key}
        x-ncp-apigw-signature-v2Signature encrypted with the Access Key ID value and Secret Key
        x-ncp-apigw-signature-v2:{API Gateway Signature}

        Responses

        Field nameTypeDescriptionRemarks
        errorObjectResponds when a request fails
        Error response code and message
        error.codeIntegerError response code
        error.messageStringError response message
        content[]Array(Object)VOD Station OPEN API response object
        content[].idStringID of the created category
        content[].nameStringCategory name
        content[].encodingOptions[]Array(Integer)Encoding option ID
        content[].encodingOptionTemplateIdIntegerEncoding template ID
        content[].thumbnailBooleanThumbnail extraction settings
        content[].notificationUrlStringCallback URL settings
        content[].outputObjectOutput settings
        content[].output.bucketNameStringOutput bucket name
        content[].output.filePathStringDetailed path to upload the output file
        content[].output.thumbnailBucketNameStringThumbnail output bucket name
        content[].output.thumbnailFilePathStringThumbnail output file upload detailed path
        content[].output.accessControlStringDisclosure scope of the output file
        content[].output.thumbnailAccessControlStringDisclosure scope of the output thumbnail
        content[].statusStringCategory statusCREATED, DELETED, RUNNING
        content[].createTimeIntegerCategory creation time
        content[].updateTimeIntegerCategory editing time
        content[].disabledBooleanFiled provided to sub accounts
        Resource activation status for the Sub Account
        content[].inputTotalIntegerTotal number of input files
        content[].lastWorkStartIntegerLast working time
        content[].outputTotalIntegerTotal number of output files
        content[].outputTotalSizeIntegerTotal size of output file (unit: byte)
        content[].outputTypeIntegerNumber of output types according to the encoding settings
        content[].advancedOptionsObjectAdvanced settings
        content[].advancedOptions.trimmingObjectOutput file trimming settings
        content[].advancedOptions.trimming.startTimeCodeStringTrimming start point
        content[].advancedOptions.trimming.endTimeCodeStringTrimming end point
        content[].advancedOptions.imageOverlayObjectImage overlay settings
        content[].advancedOptions.imageOverlay.inputObjectInput image
        content[].advancedOptions.imageOverlay.input.bucketNameStringName of the bucket where the input image has been uploaded
        content[].advancedOptions.imageOverlay.input.filePathStringDetailed path of the input image
        content[].advancedOptions.imageOverlay.positionObjectLocation settings of image to be inserted
        content[].advancedOptions.imageOverlay.position.xIntegerLocation of x-axis
        content[].advancedOptions.imageOverlay.position.yIntegerLocation of y-axis
        content[].advancedOptions.imageOverlay.sizeObejctSize settings of image to be inserted
        content[].advancedOptions.imageOverlay.size.widthIntegerImage width
        content[].advancedOptions.imageOverlay.size.heightIntegerImage height
        totalIntegerTotal number of categories

        Examples

        Request examples

        GET https://vodstation.apigw.ntruss.com/api/v2/category
        
        GET /api/v2/category
        HOST: vodstation.apigw.ntruss.com
        x-ncp-region_code:KR
        x-ncp-apigw-timestamp:1521787414578
        x-ncp-iam-access-key:6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy
        x-ncp-apigw-signature-v2:iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M==
        HTTP

        Response examples

        HTTP/1.1 200 OK
        Server: nginx
        Date: Wed, 12 Sep 2018 09:53:32 GMT
        Content-Type: application/json;charset=utf-8
        Connection: keep-alive
        Access-Control-Allow-Origin: *
        x-ncp-trace-id: 36c9k60om4p3238cpmc9gm4cj4
        
        {
          "content": [
              {
                "disabled": false,
                "id": 10095,
                "name": "3type-basic-category",
                "thumbnail": false,
                "output": {
                  "bucketName": "vs-output",
                  "filePath": "/"
                },
                "createTime": 1631594152000,
                "updateTime": 1631594152000,
                "status": "CREATED",
                "outputType": 3,
                "encodingOptions": [
                  1,
                  2,
                  3
                ]
              }
          ],
          "total": 1
        }
        HTTP

        Was this article helpful?

        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.