조직

설명

고객사의 부서 정보를 WOKPLACE[k]로 설정하기 위한 API입니다.

전체 부서 목록 API

고객사의 전체 부서정보를 조회합니다.

요청 URL

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

요청 헤더

헤더명 설명
x-ncp-apigw-timestamp 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타내며
API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주

x-ncp-apigw-timestamp:{Timestamp}
x-ncp-apigw-api-key APIGW에서 발급받은 키 값
x-ncp-apigw-api-key:{API Gateway API Key}
x-ncp-iam-access-key 네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값
x-ncp-iam-access-key:{Account Access Key}
x-ncp-apigw-signature-v1 Access Key ID 값과 Secret Key로 암호화한 서명
x-ncp-apigw-signature-v1:{API Gateway Signature}
Content-Type Request body content type을 application/json으로 지정
Content-Type: application/json

요청 Path 파라미터

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

요청 예시

GET https://workplace.apigw.ntruss.com/organization/apigw/v1/company/578c7009-bdad-4493-9835-72302cf988c6/department

GET /organization/apigw/v1/company/578c7009-bdad-4493-9835-72302cf988c6/department
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-v1: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

응답 예시

{
  "timestamp": "2019-12-10 10:35:42",
  "status": 200,
  "error": null,
  "message": null,
  "path": "/organization/apigw/v1/company/578c7009-bdad-4493-9835-72302cf988c6",
  "body": [
    {
      "companyId": "578c7009-bdad-4493-9835-72302cf988c6",
      "departmentId": "abc00001",
      "departmentName": "ABC Corp",
      "i18nNames": {
        "zh_CN": "",
        "ja_JP": "",
        "ko_KR": "ABC Corp",
        "zh_TW": "",
        "en_US": ""
      },
      "parentDepartmentId": null,
      "deptReprEmpId": "ddb5fe37-3694-4381-b681-8293428e8d62",
      "displayOrder": 1,
      "departmentEmail": "abc00001@sample.com",
      "receiveExternalMail": false,
      "display": false
    },
    {
      "companyId": "578c7009-bdad-4493-9835-72302cf988c6",
      "departmentId": "abc00002",
      "departmentName": "기획팀",
      "i18nNames": {
        "ko_KR": "기획팀"
      },
      "parentDepartmentId": null,
      "deptReprEmpId": null,
      "displayOrder": 18,
      "departmentEmail": "abc00002@samlpe.com",
      "receiveExternalMail": true,
      "display": false
    }
  ]
}

단일 부서 조회 API

고객사의 단일 부서를 조회합니다.

요청 URL

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

요청 헤더

헤더명 설명
x-ncp-apigw-timestamp 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타내며
API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주

x-ncp-apigw-timestamp:{Timestamp}
x-ncp-apigw-api-key APIGW에서 발급받은 키 값
x-ncp-apigw-api-key:{API Gateway API Key}
x-ncp-iam-access-key 네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값
x-ncp-iam-access-key:{Account Access Key}
x-ncp-apigw-signature-v1 Access Key ID 값과 Secret Key로 암호화한 서명
x-ncp-apigw-signature-v1:{API Gateway Signature}
Content-Type Request body content type을 application/json으로 지정
Content-Type: application/json

요청 Path 파라미터

파라미터 타입 크기 필수 여부 설명
companyId String 36 Y 연동키(CompanyId) Developers > 기본 설정 > 연동키
externalKey String 36 Y 부서 외부키

요청 예시

GET https://workplace.apigw.ntruss.com/organization/apigw/v1/company/578c7009-bdad-4493-9835-72302cf988c6/department/abcdept00001

GET /organization/apigw/v1/company/578c7009-bdad-4493-9835-72302cf988c6/department/abcdept00001
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-v1: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

응답 예시

{
  "timestamp": "2019-12-10 10:35:42",
  "status": 200,
  "error": null,
  "message": null,
  "path": "/organization/apigw/v1/company/578c7009-bdad-4493-9835-72302cf988c6/department/abcdept00001",
  "body": {
      "companyId": "578c7009-bdad-4493-9835-72302cf988c6",
      "departmentId": "abcdept00001",
      "departmentName": "ABC Corp",
      "i18nNames": {
        "zh_CN": "",
        "ja_JP": "",
        "ko_KR": "ABC Corp",
        "zh_TW": "",
        "en_US": ""
      },
      "parentDepartmentId": null,
      "deptReprEmpId": "ddb5fe37-3694-4381-b681-8293428e8d62",
      "displayOrder": 1,
      "departmentEmail": "abcdept00001@sample.com",
      "receiveExternalMail": false,
      "display": false
  }
}

추가 API

고객사의 부서를 추가합니다.

요청 URL

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

요청 헤더

헤더명 설명
x-ncp-apigw-timestamp 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타내며
API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주

x-ncp-apigw-timestamp:{Timestamp}
x-ncp-apigw-api-key APIGW에서 발급받은 키 값
x-ncp-apigw-api-key:{API Gateway API Key}
x-ncp-iam-access-key 네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값
x-ncp-iam-access-key:{Account Access Key}
x-ncp-apigw-signature-v1 Access Key ID 값과 Secret Key로 암호화한 서명
x-ncp-apigw-signature-v1:{API Gateway Signature}
Content-Type Request body content type을 application/json으로 지정
Content-Type: application/json

요청 Path 파라미터

파라미터 타입 크기 필수 여부 설명
companyId String 36 Y 연동키(CompanyId) Developers > 기본 설정 > 연동키
externalKey String 36 Y 생성할 부서 외부키

요청 Body 파라미터

파라미터 타입 크기 필수 여부 설명
companyId String 36 Y 연동키
departmentId String 36 Y 생성할 부서 외부키
departmentName String 100 Y 부서명특수 문자 중 ! @ & ( ) - _ + [ ] { } , . 만 허용
i18nNames Map N 이름 다국어 Map<Locale, String> i18nNames 지원언어 [ko_KR, en_US, ja_JP, zh_CN, zh_TW]
parentDepartmentId String 36 Y 상위 부서 외부키
displayOrder int 100 Y 부서 노출 순서
departmentEmail String 30 Y 부서 외부 메일
receiveExternalMail boolean - N 외부 메일 수신 여부
display boolean - N 부서 노출 유무

요청 예시

POST https://workplace.apigw.ntruss.com/organization/apigw/v1/company/578c7009-bdad-4493-9835-72302cf988c6/department/abc00003

POST /organization/apigw/v1/company/578c7009-bdad-4493-9835-72302cf988c6/department/abc00003
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-v1: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

{
    "companyId": "578c7009-bdad-4493-9835-72302cf988c6",
    "departmentId": "abc00003",
    "departmentName": "재무팀",
    "i18nNames": {
      "zh_CN": "",
      "ja_JP": "",
      "ko_KR": "재무팀",
      "zh_TW": "",
      "en_US": "Finance"
    },
    "parentDepartmentId": "abc00001",
    "displayOrder": 1,
    "departmentEmail": "abc000001@sample.com",
    "receiveExternalMail": false,
    "display": true
}

응답 예시

{
  "timestamp": "2019-12-10 10:35:42",
  "status": 200,
  "error": null,
  "message": null,
  "path": "/organization/apigw/v1/company/578c7009-bdad-4493-9835-72302cf988c6/department/abc00003",
  "body": {
      "companyId": "578c7009-bdad-4493-9835-72302cf988c6",
      "departmentId": "abc00003",
      "departmentName": "재무팀",
      "i18nNames": {
        "zh_CN": "",
        "ja_JP": "",
        "ko_KR": "재무팀",
        "zh_TW": "",
        "en_US": "Finance"
      },
      "parentDepartmentId": null,
      "deptReprEmpId": "ddb5fe37-3694-4381-b681-8293428e8d62",
      "displayOrder": 1,
      "departmentEmail": "abc000001@sample.com",
      "receiveExternalMail": false,
      "display": false
  }
}

수정 API

고객사의 부서 정보를 수정합니다.

요청 URL

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

요청 헤더

헤더명 설명
x-ncp-apigw-timestamp 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타내며
API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주

x-ncp-apigw-timestamp:{Timestamp}
x-ncp-apigw-api-key APIGW에서 발급받은 키 값
x-ncp-apigw-api-key:{API Gateway API Key}
x-ncp-iam-access-key 네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값
x-ncp-iam-access-key:{Account Access Key}
x-ncp-apigw-signature-v1 Access Key ID 값과 Secret Key로 암호화한 서명
x-ncp-apigw-signature-v1:{API Gateway Signature}
Content-Type Request body content type을 application/json으로 지정
Content-Type: application/json

요청 Path 파라미터

파라미터 타입 크기 필수 여부 설명
companyId String 36 Y 연동키(CompanyId) Developers > 기본 설정 > 연동키
externalKey String 36 Y 수정할 부서 외부키

요청 Body 파라미터

파라미터 타입 크기 필수 여부 설명
companyId String 36 Y 연동키
departmentId String 36 Y 수정할 부서 외부키
departmentName String 100 Y 부서명특수 문자 중 ! @ & ( ) - _ + [ ] { } , . 만 허용
i18nNames Map N 이름 다국어 Map<Locale, String> i18nNames 지원언어 [ko_KR, en_US, ja_JP, zh_CN, zh_TW]
parentDepartmentId String 36 Y 상위 부서 외부키 최상위 부서 수정 시 "#" 입력
deptReprEmpId String 36 N 부서장 외부키(사원 외부키)
displayOrder int 100 Y 부서 노출 순서
departmentEmail String 30 N 부서 외부 메일
receiveExternalMail boolean - N 외부 메일 수신 여부
display boolean - N 부서 노출 유무

요청 예시

PUT https://workplace.apigw.ntruss.com/organization/apigw/v1/company/578c7009-bdad-4493-9835-72302cf988c6/department/abc00003

PUT /organization/apigw/v1/company/578c7009-bdad-4493-9835-72302cf988c6/department/abc00003
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-v1: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

{
    "companyId": "578c7009-bdad-4493-9835-72302cf988c6",
    "departmentId": "abc00003",
    "departmentName": "재무팀",
    "i18nNames": {
      "zh_CN": "",
      "ja_JP": "",
      "ko_KR": "재무팀",
      "zh_TW": "",
      "en_US": "Finance"
    },
    "parentDepartmentId": "abc00001",
    "displayOrder": 1,
    "departmentEmail": "abc00003@sample.com",
    "deptReprEmpId": "emp00001",
    "receiveExternalMail": false,
    "display": true
}

응답 예시

{
  "timestamp": "2019-12-10 10:35:42",
  "status": 200,
  "error": null,
  "message": null,
  "path": "/organization/apigw/v1/company/578c7009-bdad-4493-9835-72302cf988c6/department/nbp00003",
  "body": {
      "companyId": "578c7009-bdad-4493-9835-72302cf988c6",
      "departmentId": "abc00003",
      "departmentName": "재무팀",
      "i18nNames": {
        "zh_CN": "",
        "ja_JP": "",
        "ko_KR": "재무팀",
        "zh_TW": "",
        "en_US": "Finance"
      },
      "parentDepartmentId": "abc00001",
      "displayOrder": 1,
      "departmentEmail": "abc00003@sample.com",
      "deptReprEmpId": "emp00001",
      "receiveExternalMail": false,
      "display": true
  }
}