Login
      Contents x
      Job grades
        • Print
        • PDF
        Contents

        Job grades

          • Print
          • PDF
          Article summary

          Description

          Adds, edits and deletes job grade information of your company in WORKBOX.

          Add

          Adds job grade information.

          Request URL

          POST https://workbox.apigw.ntruss.com/workbox/workbox/openapi/v1/organization/company/{companyId}/job-grade/{externalKey}

          Request header

          HeaderDescription
          x-ncp-apigw-timestampIt is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
          If the time difference with the API Gateway server is more than 5 minutes, the request is considered invalid.
          x-ncp-apigw-timestamp:{Timestamp}
          x-ncp-apigw-api-keyAPI key issued by API Gateway
          x-ncp-apigw-api-key:{API Gateway API Key}
          x-ncp-iam-access-keyAccess Key ID issued from the NAVER CLOUD PLATFORM portal.
          x-ncp-iam-access-key:{Account Access Key}
          x-ncp-apigw-signature-v1Signature encrypted with your Access Key ID and Secret Key.
          x-ncp-apigw-signature-v1:{API Gateway Signature}
          Content-TypeSet the request body content type to application/json.
          Content-Type: application/json

          Request path parameters

          ParameterTypeLengthRequiredDescription
          companyIdString36YAPI key (CompanyId). Developers > Basic Settings > API Key
          externalKeyString36YExternal key for a job grade

          Request body parameters

          ParameterTypeLengthRequiredDescription
          nameString100YJob grade name
          i18nNamesMapNJob grade name in multiple languages. Map<Locale, String> i18nNames
          sortOrdintYDisplay order of job grades

          Request example

          POST https://workbox.apigw.ntruss.com/workbox/workbox/openapi/v1/organization/company/578c7009-bdad-4493-9835-72302cf988c6/job-grade/0000001

POST /openapi/v1/organization/company/578c7009-bdad-4493-9835-72302cf988c6/job-grade/0000001
HOST: workbox.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-v1: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=
{
	"sortOrd": 91,
    "name": "사원",
	"i18nNames": {
			"ko_KR": "사원",
			"en_US": "Assist"
		}
}

          Response example

          HTTP/1.1 201 OK
Server: nginx
Date: Wed, 12 Sep 2018 10: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

{
	"sortOrd": 91,
    "name": "사원",
	"i18nNames": {
			"ko_KR": "사원",
			"en_US": "Assist"
		}
}

          Edit

          Edits job grade information.

          Request URL

          PUT https://workbox.apigw.ntruss.com/workbox/workbox/openapi/v1/organization/company/{companyId}/job-grade/{externalKey}

          Request header

          HeaderDescription
          x-ncp-apigw-timestampIt is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
          If the time difference with the API Gateway server is more than 5 minutes, the request is considered invalid.
          x-ncp-apigw-timestamp:{Timestamp}
          x-ncp-apigw-api-keyAPI key issued by API Gateway
          x-ncp-apigw-api-key:{API Gateway API Key}
          x-ncp-iam-access-keyAccess Key ID issued from the NAVER CLOUD PLATFORM portal.
          x-ncp-iam-access-key:{Account Access Key}
          x-ncp-apigw-signature-v1Signature encrypted with your Access Key ID and Secret Key.
          x-ncp-apigw-signature-v1:{API Gateway Signature}
          Content-TypeSet the request body content type to application/json.
          Content-Type: application/json

          Request path parameters

          ParameterTypeLengthRequiredDescription
          companyIdString36YAPI key (CompanyId). Developers > Basic Settings > API Key
          externalKeyString36YExternal key for a job grade

          Request body parameters

          ParameterTypeLengthRequiredDescription
          nameString100YJob grade name
          i18nNamesMapNJob grade name in multiple languages. Map<Locale, String> i18nNames
          sortOrdintYDisplay order of job grades

          Request example

          POST https://workbox.apigw.ntruss.com/workbox/workbox/openapi/v1/organization/company/578c7009-bdad-4493-9835-72302cf988c6/job-grade/0000001

POST /openapi/v1/organization/company/578c7009-bdad-4493-9835-72302cf988c6/job-grade/0000001
HOST: workbox.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-v1: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=
{
	"sortOrd": 91,
    "name": "사원",
	"i18nNames": {
			"ko_KR": "사원",
			"en_US": "Assist"
		}
}

          Response example

          HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Sep 2018 10: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

{
	"sortOrd": 91,
    "name": "사원",
	"i18nNames": {
			"ko_KR": "사원",
			"en_US": "Assist"
		}
}

          Delete

          Deletes job grade information.

          Request URL

          DELETE https://workbox.apigw.ntruss.com/workbox/workbox/openapi/v1/organization/company/{companyId}/job-grade/{externalKey}

          Request header

          HeaderDescription
          x-ncp-apigw-timestampIt is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
          If the time difference with the API Gateway server is more than 5 minutes, the request is considered invalid.
          x-ncp-apigw-timestamp:{Timestamp}
          x-ncp-apigw-api-keyAPI key issued by API Gateway
          x-ncp-apigw-api-key:{API Gateway API Key}
          x-ncp-iam-access-keyAccess Key ID issued from the NAVER CLOUD PLATFORM portal.
          x-ncp-iam-access-key:{Account Access Key}
          x-ncp-apigw-signature-v1Signature encrypted with your Access Key ID and Secret Key.
          x-ncp-apigw-signature-v1:{API Gateway Signature}
          Content-TypeSet the request body content type to application/json.
          Content-Type: application/json

          Request path parameters

          ParameterTypeLengthRequiredDescription
          companyIdString36YAPI key (CompanyId). Developers > Basic Settings > API Key
          externalKeyString36YExternal key for a job grade

          Response

          It returns an HTTP status code in the response body.

          HTTP status codeResponse messageDescription
          200OKSuccess
          201CreatedResource successfully created.
          400Bad RequestFailure (It is usually used to respond to the request format that the server cannot understand.)
          500Internal Server ErrorGeneral server error. Whereas 4XX error codes represent client-side errors,
          5XX error codes represent server-side errors.
          Was this article helpful?
          What's Next
          Change password!
          Changing your password will log you out immediately. Use the new password to log back in.
          Change profile
          Success!
          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.
          Logout