Job position
- Print
- PDF
Job position
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Description
Searches the job position list of a customer connected to the partner company.
Search Job position list API
Searches job position list.
Request URL
GET https://workplace.apigw.ntruss.com/partner/apigw/v2/partner/{partnerId}/company/{companyId}/job
Request header
| Header | Description |
|---|---|
| x-ncp-apigw-timestamp | * This 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-iam-access-key | * Access Key ID issued on NAVER Cloud Platform portal or by Sub Account |
| x-ncp-apigw-signature-v2 | * A signature that encrypts the body of the example above with Secret Key mapped to the access key ID * HmacSHA256 is used as the HMAC encryption algorithm |
Request path parameters
| Parameter | Type | Capacity | Requirement status | Description |
|---|---|---|---|---|
| partnerId | String | 15 | Y | Partner ID provided by WORKPLACE |
| companyId | String | 36 | Y | Linkage key (CompanyId) of customer to be searched Developers > Basic settings > Linkage key |
Request parameters
| Parameter | Type | Capacity | Requirement status | Description |
|---|---|---|---|---|
| offset | long | N | Display offset rows first | |
| limit | long | N | Display as many as the number of limits |
Request example
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=
Response example
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": "Development",
"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": "Planning",
"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" : "Team member",
"i18nNames": {
"ko_KR" : "Team member",
"zh_CN": "",
"ja_JP": "",
"ko_KR": "",
"zh_TW": "",
"en_US": "Team member"
},
"sortOrder": 9,
"itemUsed": false
}
],
"totalCount": 3
}
Response
Returned as an HTTP status code in the response body.
| HTTP status code | Response message | Description |
|---|---|---|
| 200 | OK | General request made successfully |
| 201 | Created | Response code related to the success of resource creation |
| 400 | Bad Request | Used for failed general request |
| 500 | Internal Server Error | General server error. While 4xx error codes represent client-side errors, 5xx error codes represent server-side errors. |
Response example
{
"status": 400,
"code": -4013,
"errors": [],
"message": "job not found"
}
Was this article helpful?