MENU
      Viewing departments

        Viewing departments


        Article summary

        Available in Classic and VPC

        It is an API to view departments of the Media Connect Center.

        Requests

        GET https://ncloudmcc.apigw.ntruss.co/ncloudmcc/v1/companies/{companyId}/depts/{externalKey}
        Plain text

        Request headers

        ItemRequiredDescription
        x-ncp-apigw-timestampYTime elapsed since January 1, 1970, 00:00:00 UTC in milliseconds. The request is considered invalid if the time difference from the API Gateway server is 5 minutes or longer
        x-ncp-apigw-timestamp:{Timestamp}
        x-ncp-iam-access-keyYValue of access key ID issued from NAVER Cloud Platform portal
        x-ncp-iam-access-key:{Sub Account Access Key}
        x-ncp-apigw-signature-v2YSignature encrypted with the access key ID value and secret key
        x-ncp-apigw-signature-v2:{API Gateway Signature}
        x-ncp-region_codeNRegion code (KR)
        x-ncp-region_code:KR
        Content-TypeYSpecifies the request body content type as application/json
        Content-Type: application/json

        Request path parameters

        ParametersTypeSizeRequiredDescription
        companyIdString36YIntegration key (CompanyId)
        Developers > Basic settings > Integration key
        externalKeyString36YExternal key of department

        Request examples

        GET /ncloudmcc/v1/companies/48128f23-e29b-496e-aa04-1f741fed86bc/depts/dept01
        Host: ncloudmcc.apigw.ntruss.com
        x-ncp-apigw-signature-v2: yyoug5garNKcbEjaNkt+P9tfAVgwhYgOM3I/EO2lutU=
        x-ncp-apigw-timestamp: 1700459601582
        x-ncp-iam-access-key: HrR0s91elfiXEeTSZcwj
        x-ncp-region_code: KR
        Plain text

        Responses

        Response body parameters

        ParametersTypeSizeRequiredDescription
        dept.nameString100Department name
        dept.i18nNamesMapMultilingual department name
        Map<Locale, String> i18nNames
        dept.sortOrdNumber1Order of department to be exposed
        dept.uprDeptExternalKeyString50External key of the upper department; the highest default department if not specified
        dept.externalKeyString36External key of department

        Response examples

        HTTP/1.1 200 OK
        Connection: keep-alive
        Content-Type: application/json;charset=UTF-8
        Date: Mon, 20 Nov 2023 05:53:21 GMT
        Server: nginx
        x-ncp-apigw-response-origin: ENDPOINT
        x-ncp-trace-id: 32p9oc8rj8db63cp9oc5imacb4
        
        {
            "dept":
            {
                "name":"Sales",
                "i18nNames":
                {
                    "ko_KR": "영업",
                    "en_US": "Sales"
                },
                "uprDeptExternalKey":"dept00",
                "sortOrd":0,
                "externalKey":"dept01"
            }
        }
        Plain text

        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.