Login
      내용 x
      조직 v2
        • 인쇄
        • PDF
        내용

        조직 v2

          • 인쇄
          • PDF
          Article Summary

          설명

          고객사의 조직 정보를 WORKPLACE 로 설정하기 위한 API입니다.

          요청 헤더 공통

          HeaderDescription
          x-ncp-apigw-timestamp* 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타낸 것
          * API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
          x-ncp-iam-access-key* 네이버 클라우드 플랫폼 포털 또는 Sub Account에서 발급받은 Access Key ID
          x-ncp-apigw-signature-v2* 위 예제의 Body를 Access Key ID와 맵핑되는 Secret Key로 암호화한 서명
          * HMAC 암호화 알고리즘은 HmacSHA256 사용

          추가 API

          조직 정보를 추가한다.

          요청 URL

          POST https://workplace.apigw.ntruss.com/organization/apigw/v2/company/{companyId}/department/{externalKey}

          요청 헤더

          HeaderDescription
          x-ncp-apigw-timestamp* 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타낸 것
          * API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
          x-ncp-iam-access-key* 네이버 클라우드 플랫폼 포털 또는 Sub Account에서 발급받은 Access Key ID
          x-ncp-apigw-signature-v2* 위 예제의 Body를 Access Key ID와 맵핑되는 Secret Key로 암호화한 서명
          * HMAC 암호화 알고리즘은 HmacSHA256 사용

          요청 Path 파라미터

          파라미터타입크기필수 여부설명
          companyIdString36Y연동키(CompanyId) Developers > 기본 설정 > 연동키
          externalKeyString36Y부서 외부키

          요청 Body 파라미터

          파라미터타입크기필수 여부설명
          nameString100Y부서 기본명
          i18nNamesMapN부서명 다국어 Map<Locale, String> i18nNames
          deptExternalKeyString100Y부서 외부키
          parentDeptExternalKeyString100Y상위부서 외부키(최상위 조직일 경우만 #)
          deptEmailAddressString100N부서 이메일 주소
          externalEmailReceiveYnbooleanN외부이메일 수신여부
          dispOrdString10Y조직도 부서 노출 순서

          요청 예시

          POST https://workplace.apigw.ntruss.com/organization/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/department/apitestdept2

POST /organization/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/department/apitestdept2
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=
{
        "name" : "테스트부서",
        "i18nNames" : {
            "ko_KR" : "테스트부서",
            "en_US" : "testDept"
        },
        "parentDeptExternalKey" : "apitestdept1",
        "deptEmailAddress" : "testDeptEmail@sample.com",
        "externalEmailReceiveYn" : true,
        "dispOrd" : "1"
}

          응답 예시

          HTTP/1.1 201 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

{
        "name" : "테스트부서",
        "i18nNames" : {
            "ko_KR" : "테스트부서",
            "en_US" : "testDept"
        },
        "parentDeptExternalKey" : "apitestdept1",
        "deptEmailAddress" : "testDeptEmail@sample.com",
        "externalEmailReceiveYn" : true,
        "dispOrd" : "1"
}

          수정 API

          조직 정보를 수정한다.

          요청 URL

          PUT https://workplace.apigw.ntruss.com/organization/apigw/v2/company/{companyId}/department/{externalKey}

          요청 헤더

          HeaderDescription
          x-ncp-apigw-timestamp* 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타낸 것
          * API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
          x-ncp-iam-access-key* 네이버 클라우드 플랫폼 포털 또는 Sub Account에서 발급받은 Access Key ID
          x-ncp-apigw-signature-v2* 위 예제의 Body를 Access Key ID와 맵핑되는 Secret Key로 암호화한 서명
          * HMAC 암호화 알고리즘은 HmacSHA256 사용

          요청 Path 파라미터

          파라미터타입크기필수 여부설명
          companyIdString36Y연동키(CompanyId) Developers > 기본 설정 > 연동키
          externalKeyString36Y부서 외부키

          요청 Body 파라미터

          파라미터타입크기필수 여부설명
          nameString100Y부서명
          i18nNamesMapN부서 다국어명Map<Locale, String> i18nNames
          deptExternalKeyString100Y부서 외부키
          parentDeptExternalKeyString100Y상위부서 외부키(최상위 조직일 경우만 #)
          deptEmailAddressString100N부서 이메일 주소
          externalEmailReceiveYnbooleanN외부이메일 수신여부
          dispOrdString10Y조직도 부서 노출 순서

          요청 예시

          PUT
https://workplace.apigw.ntruss.com/organization/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/department/apitestdept2

PUT /organization/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/department/apitestdept2
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=
 {
        "name" : "테스트부서2",
        "i18nNames" : {
            "ko_KR" : "테스트부서2",
            "en_US" : "testDept2"
        },
        "parentDeptExternalKey" : "apitestdept1",
        "deptEmailAddress" : "testDeptEmail@sample.com",
        "externalEmailReceiveYn" : true,
        "dispOrd" : "2"
}

          응답 예시

          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

{
        "name" : "테스트부서2",
        "i18nNames" : {
            "ko_KR" : "테스트부서2",
            "en_US" : "testDept2"
        },
        "parentDeptExternalKey" : "apitestdept1",
        "deptEmailAddress" : "testDeptEmail@sample.com",
        "externalEmailReceiveYn" : true,
        "dispOrd" : "2"
}

          삭제 API

          조직 정보를 삭제한다.

          요청 URL

          DELETE https://workplace.apigw.ntruss.com/organization/apigw/v2/company/{companyId}/department/{externalKey}

          요청 헤더

          HeaderDescription
          x-ncp-apigw-timestamp* 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타낸 것
          * API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
          x-ncp-iam-access-key* 네이버 클라우드 플랫폼 포털 또는 Sub Account에서 발급받은 Access Key ID
          x-ncp-apigw-signature-v2* 위 예제의 Body를 Access Key ID와 맵핑되는 Secret Key로 암호화한 서명
          * HMAC 암호화 알고리즘은 HmacSHA256 사용

          요청 Path 파라미터

          파라미터타입크기필수 여부설명
          companyIdString36Y연동키(CompanyId) Developers > 기본 설정 > 연동키
          externalKeyString36Y부서 외부키

          조직 조회 API

          조직을 조회한다.

          요청 URL

          GET https://workplace.apigw.ntruss.com/organization/apigw/v2/company/{companyId}/department/{externalKey}

          요청 헤더

          HeaderDescription
          x-ncp-apigw-timestamp* 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타낸 것
          * API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
          x-ncp-iam-access-key* 네이버 클라우드 플랫폼 포털 또는 Sub Account에서 발급받은 Access Key ID
          x-ncp-apigw-signature-v2* 위 예제의 Body를 Access Key ID와 맵핑되는 Secret Key로 암호화한 서명
          * HMAC 암호화 알고리즘은 HmacSHA256 사용

          요청 Path 파라미터

          파라미터타입크기필수 여부설명
          companyIdString36Y연동키(CompanyId)Developers > 기본 설정 > 연동키
          externalKeyString36Y조직 외부키Developers > 기본 설정 > 조직 연동 > 부서

          요청 예시

          GET https://workplace.apigw.ntruss.com/organization/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/department/apitestdept3

GET /organization/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/department/apitestdept3
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

{
  "tenantId": "c1798784-9a47-4751-ab9f-b9629825ab93",
  "companyId": "c1798784-9a47-4751-ab9f-b9629825ab93",
  "externalKey": "apitestdept3",
  "name": "테스트부서2",
  "i18nNames": {
    "ko_KR": "테스트부서2",
    "en_US": "testDept2"
  },
  "parentDeptExternalKey": "apitestdept1",
  "deptLeaderExternalKey": null,
  "deptEmailAddress" : "testDeptEmail@sample.com",
  "externalEmailReceiveYn" : true,
  "dispOrd": "2.0"
}

          조직목록 조회 API

          조직목록을 조회한다.

          요청 URL

          GET https://workplace.apigw.ntruss.com/organization/apigw/v2/company/{companyId}/department

          요청 Path 파라미터

          파라미터타입크기필수 여부설명
          companyIdString36Y연동키(CompanyId) Developers > 기본 설정 > 연동키

          요청 파라미터

          파라미터타입크기필수 여부설명
          offsetlongNoffset row부터 출력
          limitlongNlimit 갯수만큼 출력

          요청 예시

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

GET /organization/apigw/v2/company/c1798784-9a47-4751-ab9f-b9629825ab93/department?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": "apitestdept3",
            "name": "테스트부서2",
            "i18nNames": {
                "ko_KR": "테스트부서2",
                "en_US": "testDept2"
            },
            "parentDeptExternalKey": "apitestdept1",
            "deptLeaderExternalKey": null,
            "deptEmailAddress" : "testDeptEmail@sample.com",
            "externalEmailReceiveYn" : true,
            "dispOrd": "2.0"
        },
        {
            "tenantId": "c1798784-9a47-4751-ab9f-b9629825ab93",
            "companyId": "c1798784-9a47-4751-ab9f-b9629825ab93",
            "externalKey": "apitestdept2",
            "name": "테스트부서-1",
            "i18nNames": {
                "ko_KR": "테스트부서-1",
                "en_US": "testDept"
            },
            "parentDeptExternalKey": "apitestdept1",
            "deptLeaderExternalKey": null,
            "deptEmailAddress" : "testDeptEmail1@sample.com",
            "externalEmailReceiveYn" : false,
            "dispOrd": "1.0"
        }
    ],
    "totalCount": 2
}

          응답

          HTTP 상태 코드로 리턴되고, Body 정보로 전달한다.

          HTTP 상태 코드응답 메시지설명
          200OK일반적인 요청 성공
          201Created리소스 생성 성공에 대한 응답 코드
          400Bad Request일반적인 요청 실패에 사용
          500Internal Server Error- 일반적인 서버 오류에 대한 응답 코드
          4XX대의 오류 코드가 클라이언트 측 오류를 나타내기 위해 사용된다면,
          5XX대의 오류 코드는 서버 측 오류를 나타내기 위해 사용됨

          응답 예시

          {
    "status": 400,
    "code": -4020,
    "errors": [],
    "message": "parentDeptExternalKey is null"
}
          이 문서가 도움이 되었습니까?
          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