주 컨텐츠로 이동
문서
문서
Adaptive Planning
최종 업데이트: 2023-06-23
인스턴스

인스턴스

URL 엔드포인트

HTTPS://api.adaptiveplanning.com/api/rest/security/<version>/<tenant>/users/instances
버전: v1
카테고리
데이터 업데이트
설명
상위-하위 계층에서 Adaptive Planning 다중 인스턴스를 사용하는 경우 인스턴스에 사용자를 지정합니다.
호출에 필요한 권한
관리자 액세스 > 사용자
다중 인스턴스 사용자 액세스 API를 사용하면 사용자의 인스턴스 지정을 검색하고 변경할 수 있습니다.

지원되는 HTTPS 동사:

HTTP Verb
단일 리소스
수금 리소스
설명
GET
미지원
지원됨
기본 인스턴스 지정내역을 포함하여 사용자의 모든 인스턴스 지정내역을 검색합니다.
PATCH
지원됨
미지원
기존 사용자의 인스턴스 지정내역에 신규 인스턴스를 추가합니다.
PUT
지원됨
미지원
사용자에게 지정된 기존 인스턴스를 업데이트하고 요청 본문에 지정된 데이터로 바꿉니다.

GET

요청:
/users/instances:
사용자에게 지정된 인스턴스 모음을 검색합니다.
기본 인스턴스 지정내역을 포함하여 사용자의 모든 인스턴스 지정내역을 검색합니다. instanceCode를 기준으로 필터링할 수 있습니다. 이러한 쿼리 매개변수가 없으면 페이지 번호 매기기에서 한도 또는 오프셋에 기본값을 사용합니다.
샘플 요청 URI
HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/users/instances?offset=5&limit=5
샘플 요청 헤더:
Accept-Language: ko
샘플 요청 본문
쿼리 매개변수
이름
설명
필수
instanceCode
해당 인스턴스의 사용자 목록을 검색하기 위해 인스턴스 컨텍스트를 정의하는 인스턴스의 고유 ID입니다. 인스턴스 코드를 지정하지 않으면 API 호출자의 기본 인스턴스에서 모든 사용자가 검색됩니다.
아니요
limit
단일 응답의 최대 오브젝트 수입니다. 기본값은 500입니다. 최대값은 500입니다.
아니요
offset
응답 컬렉션에 있는 첫 번째 사용자의 인덱스(0부터 시작)입니다. 기본값은 0입니다.
오프셋을 한도 매개변수와 함께 사용하여 응답 컬렉션의 페이징을 제어합니다.
아니요
샘플 응답
200
성공한 응답
샘플 응답
 

{
"links": {
   "next": "https://api.adaptiveplanning.com/api/rest/security/v1/default/users/instances?offset=10&limit=5",
   "previous": "https://api.adaptiveplanning.com/api/rest/security/v1/default/users/instances?offset=0&limit=5"
},
"total": 26,
"users": [
   {
       "userGuid": "111SampleUserGuid",
       "userName": "sampleuser1@company.com",
       "wid" : "14400000000000000000000000000samplewid",
       "instances": [
           {
               "code": "sampleCompany",
               "default": true
           }
       ]
   },
   {
       "userGuid": "222SampleUserGuid",
       "userName": "sampleuser2@company.com",
       "wid" : "31100000000000000000000000000samplewid",
       "instances": [
           {
               "code": "sampleCompany",
               "default": true
           }
       ]
   },
   {
       "userGuid": "474C4F424F0000000000000001sampleGuid",
       "userName": "sampleuser3@company.com",
       "wid" : "34400000000000000000000000000samplewid",
       "instances": [
           {
               "code": "sampleCompany",
               "default": true
           }
       ]
   },
   {
       "userGuid": "111C4F424F0000000000000001sampleGuid",
       "userName": "sampleuser5@company.com",
       "wid" : "343400000000000000000000000000samplewid",
       "instances": [
           {
               "code": "sampleCompany",
               "default": true
           }
       ]
   },
   {
       "userGuid": "374C4F424F0000000000sampleGuid",
       "userName": "sampleuser4@company.com,
       ""wid" : "355000000000000000000000000samplewid",
       "instances": [
           {
               "code": "sampleCompany_Child1"
           },
           {
               "code": "sampleCompany_Child2"
           },
           {
               "code": "sampleCompany",
               "default": true
           }
       ]
   }
]
}

PATCH:

요청:
users/instances?instanceCode={INSTANCECODE}:
기존 사용자의 인스턴스 지정내역을 부분적으로 업데이트합니다.
기존 사용자의 인스턴스 지정내역에 신규 인스턴스를 추가합니다. 인스턴스의 기본 특성을 지정하면 사용자의 현재 기본 인스턴스 지정내역이 바뀝니다.
userIdentifier 쿼리 매개변수에 사용자 ID를 지정합니다.
요청 본문에서 userIdentifier를 지정합니다.
샘플 요청 URI
HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/users/instances?userIdentifier=userName
샘플 요청 본문
샘플 PATCH 요청 본문
 

{
      "userName": "SampleUser1@SampleCompany.com",
      "instances": [
          {
              "code": "SampleCompany"
          },
          {
              "code": "SampleCompany_Child",
              "default": true
          }
      ]
  }
쿼리 매개변수
이름
설명
필수
instanceCode
기존 사용자에 대해 추가되는 인스턴스와 동일한 인스턴스 계층에서 더 높은 인스턴스 코드 더 높은 레벨의 parent 인스턴스에 대한 액세스 권한이 있는 사용자만 child 인스턴스를 추가할 수 있습니다.
아니요
userIdentifier
userIdentifier는 고유한 Adaptive Planning 사용자를 결정하는 데 사용됩니다. 가능한 값은 userName, wid, userGuid입니다.
예
요청 헤더
콘텐츠 유형
application/json
권한 부여
기본 또는 토큰 기반
페이로드 매개변수
이름
설명
필수
wid
사용자의 Workday ID입니다.
아니요
userName
사용자의 사용자명(로그인명)입니다.
아니요
userGuid
글로벌 고유 사용자 ID(사용자 생성 시 시스템에서 지정)
아니요
인스턴스 코드
페이로드에서 사용자에게 지정할 회사의 instanceCode입니다.
예
기본값
페이로드에서 사용자에게 지정된 기본 instanceCode입니다.
아니요

PUT:

요청:
users/instances
:
사용자에게 지정된 기존 인스턴스를 업데이트하고 바꿉니다.
지정된 userIdentifier를 사용하여 사용자에게 지정된 기존 인스턴스를 업데이트합니다. 사용자에게 지정된 인스턴스를 요청 본문의 지정된 데이터로 바꿉니다.
  • 인스턴스 지정내역이 사용자에게 지정된 기존 인스턴스의 일부가 아닌 경우 에서 인스턴스를 추가합니다.
  • 인스턴스 지정이 요청 본문의 일부가 아닌 경우 이전에 존재했던 인스턴스에 대한 액세스 권한이 제거됩니다.
  • userIdentifier 쿼리 매개변수에 사용자 ID를 지정합니다.
  • 필요에 따라 instanceCode 쿼리 매개변수에 인스턴스 코드를 지정합니다.
  • userIdentifier 쿼리 매개변수의 사용자 ID
  • 요청 본문에서 필수 필드인 <userIdentifier>(사용자명, WID 또는 userGUID)를 지정합니다. <userIdentifier>는 userIdentifier 쿼리 매개변수에 지정한 값입니다.
  • 인스턴스의 기본 특성을 지정하는 경우 사용자의 현재 기본 인스턴스를 바꿉니다.
샘플 요청 URI
HTTPS://api.adaptiveinsights.com/api/rest/security/v{1}/{default}/users/instances?userIdentifier=userName
샘플 요청 본문
샘플 PUT 요청 본문 

{
      "userName": "sampleUser@SampleCompanyParent.com",
      "instances": [
          {
              "code": "SampleCompanyParent"
          },
          {
              "code": "SampleCompanyChild",
              "default": true
          },
          {
              "code": "SampleCompanyGrandChild"
          }
      ]
  }
쿼리 매개변수
이름
설명
필수
instanceCode
기존 사용자에 대해 추가되는 인스턴스와 동일한 인스턴스 계층에서 더 높은 인스턴스 코드 더 높은 레벨의 parent 인스턴스에 대한 액세스 권한이 있는 사용자만 child 인스턴스를 추가할 수 있습니다.
아니요
userIdentifier
userIdentifier는 고유한 Adaptive Planning 사용자를 결정하는 데 사용됩니다. 가능한 값은 userName, wid, userGuid입니다.
예
요청 헤더
콘텐츠 유형
application/json
권한 부여
기본 또는 토큰 기반
페이로드 매개변수
이름
설명
필수
wid
사용자의 Workday ID입니다.
아니요
userName
사용자의 사용자명(로그인명)입니다.
아니요
userGuid
글로벌 고유 사용자 ID(사용자 생성 시 시스템에서 지정)
아니요
인스턴스 코드
페이로드에서 사용자에게 지정할 회사의 instanceCode입니다.
예
기본값
페이로드에서 사용자에게 지정된 기본 instanceCode입니다.
아니요
응답
응답
지원되는 상태 코드 목록:
200
응답이 완료되었습니다.
응답 예
샘플 200 PATCH 응답
 

{
"userName": "SampleUser@SampleComopany.com",
"instances": [
    {
        "code": "SampleCompany"
    },
    {
        "code": "SampleCompany_Child1",
        "default": true
    }
]
}
500
내부 서버 오류
예: 사용자가 유효하지 않은 경우
샘플 500 응답
 

{
 "status": {
     "errorMessage": "User with username user@samplecompany.com does not exists in company SampleCompany. "
 },
 "userName": "user@samplecompany.com"
}
예: instanceCode가 유효하지 않은 경우
샘플 500 응답
 

{
  "userName": "user@samplecompany.com",
  "instances": [
      {
          "status": {
              "errorMessage": "SampleOtherCompany not in SampleCompany network. API Caller: APICaller@samplecompany.com  not authorized to assign user: user@samplecompany.com to Instance: SampleOtherCompany "
          },
          "code": "SampleCompany",
          "default": true
      },
      {
          "code": "SAMPLECOMPANY_CHILD2"
      }
  ]
}
405
잘못된 리소스 또는 작업
403
사용자에게 권한이 충분하지 않습니다.
404
리소스를 찾을 수 없습니다.