職責

印刷する
共有
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

説明

パートナーに関連付けられた顧客会社の役職のリストを表示します。

職責リスト照会API

職責リストを照会する。

リクエストURL

GET https://workplace.apigw.ntruss.com/partner/apigw/v2/partner/{partnerId}/company/{companyId}/job

リクエストヘッダ

Header	Description
x-ncp-apigw-timestamp	* 1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリセカンド(Millisecond)で表したものである。 * API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす
x-ncp-iam-access-key	* NAVERクラウドプラットフォームポータルまたはSub Accountから発行されたAccess Key ID
x-ncp-apigw-signature-v2	* 上記例のBodyをAccess Key IDとマッピングするSecret Keyで暗号化した署名 * HMAC暗号化アルゴリズムはHmacSHA256を使用

リクエストPathパラメータ

パラメータ	タイプ	サイズ	必須の有無	説明
partnerId	String	15	Y	WORKPLACEで提供されたパートナーID
companyId	String	36	Y	照会する顧客会社の連携キー(CompanyId) `Developers > 基本設定 > 連携キー`

リクエストパラメータ

パラメータ	タイプ	サイズ	必須の有無	説明
offset	long		N	オフセット行から表示
limit	long		N	リミットの数だけ表示

リクエスト例

GET https://workplace.apigw.ntruss.com/partner/apigw/v2/partner/partnertestid/company/c1798784-9a47-4751-ab9f-b9629825ab93/job?offset=0&limit=10

GET /partner/apigw/v2/partner/partnertestid/company/c1798784-9a47-4751-ab9f-b9629825ab93/job?offset=0&limit=10
HOST: workplace.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-apigw-api-key: DUxjP4HYTP8V7khBkgywdDHQjKuaYWGrppHKpvdv
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

レスポンス例

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Sep 2020 01:18:11 GMT
Content-Type: application/json;charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 68d1o68pm4cr63gc3169gm4p34

{
    "elements": [
        {
            "tenantId": "c1798784-9a47-4751-ab9f-b9629825ab93",
            "companyId": "c1798784-9a47-4751-ab9f-b9629825ab93",
            "externalKey": "apitestjob1",
            "name": "開発",
            "i18nNames": {
                "zh_CN": "",
                "ja_JP": "",
                "ko_KR": "",
                "zh_TW": "",
                "en_US": ""
            },
            "sortOrder": 0,
            "itemUsed": true
        },
        {
            "tenantId": "c1798784-9a47-4751-ab9f-b9629825ab93",
            "companyId": "c1798784-9a47-4751-ab9f-b9629825ab93",
            "externalKey": "apitestjob2",
            "name": "企画",
            "i18nNames": {
                "zh_CN": "",
                "ja_JP": "",
                "ko_KR": "",
                "zh_TW": "",
                "en_US": ""
            },
            "sortOrder": 1,
            "itemUsed": true
        },
        {
            "tenantId": "c1798784-9a47-4751-ab9f-b9629825ab93",
            "companyId": "c1798784-9a47-4751-ab9f-b9629825ab93",
            "externalKey": "jobTest1",
            "name" : "チーム員",
            "i18nNames": {
                "ko_KR" : "チーム員",
                "zh_CN": "",
                "ja_JP": "",
                "ko_KR": "",
                "zh_TW": "",
                "en_US": "Team member"
            },       
            "sortOrder": 9,
            "itemUsed": false
        }
    ],
    "totalCount": 3
}

レスポンス

HTTPステータスコードでリターンされ、Body情報として伝達する。

HTTPステータスコード	レスポンスメッセージ	説明
200	OK	一般的なリクエストの成功
201	Created	リソース作成の成功に対するレスポンスコード
400	Bad Request	一般的なリクエスト失敗に使用
500	Internal Server Error	一般的なサーバエラーに対するレスポンスコード。4XX番台のエラーコードがクライアント側のエラーを表示するために使用される場合、 5XX番台のエラーコードはサーバ側のエラーを表示するために使用

レスポンス例

{
    "status": 400,
    "code": -4013,
    "errors": [],
    "message": "job not found"
}

この記事は役に立ちましたか?

What's Next

精算の登録

説明
職責リスト照会API
レスポンス

タグ

WORKPLACE