跳至主要内容
文档
文档
Adaptive Planning
上次更新时间 ：2023-06-23
实例

实例

URL 端点

HTTPS://api.adaptiveplanning.com/api/rest/security/<version>/<tenant>/users/instances
版本：v1
种类
数据更新
描述
在父级-子级层次结构中使用 Adaptive Planning 多实例时，为实例指定用户。
调用所需的权限
管理员访问权限 > 用户
通过访问多实例用户 API，您可以检索和更改用户的实例指定。

支持的 HTTPS VERB：

HTTP 谓词
单一资源
收款资源
描述
GET
不支持
支持
检索用户的所有实例指定，包括其默认实例指定。
PATCH
支持
不支持
将新实例添加到现有用户的实例指定中。
PUT
支持
不支持
使用请求正文中的指定数据更新并替换指定给用户的现有实例。

GET

请求：
/users/instances:
检索指定给用户的实例集合。
检索用户的所有实例指定，包括其默认实例指定。您可以按 instanceCode 进行筛选。如果缺少这些查询参数，则分页将使用 limit 或offset 的默认值。
请求 URI 示例
HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/users/instances?offset=5&limit=5
请求标头示例：
接受-语言：en
请求正文示例
查询参数
名称
描述
必填
instanceCode
实例的唯一标识符，定义用于检索该实例的用户列表的实例上下文。如果未指定实例代码，则系统会检索 API 调用方的默认实例中的所有用户。
否
limit
单个响应中的最大对象数。默认值为 500。最大值为 500。
否
offset
回复集合中第一个用户的索引（从零开始）。默认值为 0。
将 offset 与 limit 参数结合使用，可控制回复集合的分页。
否
示例回复
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
           }
       ]
   }
]
}

修补程序：

请求：
users/instances?instanceCode={INSTANCECODE}:
部分更新现有用户的实例指定。
将新实例添加到现有用户的实例指定中。如果您为实例指定默认属性，该属性将替换用户当前的默认实例指定。
在 userIdentifier 查询参数中指定用户标识符。
在请求主体中，指定 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
在与要为现有用户添加的实例相同的实例层次结构中，指定较高级别的实例代码。只有有权访问较高级别父级实例的用户才能添加子级实例。
否
userIdentifier
userIdentifier 用于确定唯一的 Adaptive Planning 用户。可能的值：userName、wid、userGuid。
是
请求标头
内容类型
application/json
授权
“基本”或“基于令牌”
负载参数
名称
描述
必填
wid
用户的 Workday 编号。
否
userName
用户的用户名（登录名）。
否
userGuid
用户的全局唯一编号，由系统在创建用户时指定。
否
实例代码
要在负载中指定给用户的公司的 instanceCode。
是
默认
在负载中指定给用户的默认 instanceCode。
否

更新：

请求：
users/instances
：
更新并替换指定给用户的现有实例
更新指定给具有指定 userIdentifier 的用户的现有实例。将指定给用户的实例替换为请求主体中的指定数据。
  • 如果某个实例指定不是指定给用户的现有实例的一部分，则会添加该实例。
  • 如果某个实例指定不是请求主体的一部分，则系统会移除先前存在的对该实例的访问权限。
  • 在 userIdentifier 查询参数中指定用户标识符。
  • 根据需要在 instanceCode 查询参数中指定实例代码。
  • 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
在与要为现有用户添加的实例相同的实例层次结构中，指定较高级别的实例代码。只有有权访问较高级别父级实例的用户才能添加子级实例。
否
userIdentifier
userIdentifier 用于确定唯一的 Adaptive Planning 用户。可能的值：userName、wid、userGuid。
是
请求标头
内容类型
application/json
授权
“基本”或“基于令牌”
负载参数
名称
描述
必填
wid
用户的 Workday 编号。
否
userName
用户的用户名（登录名）。
否
userGuid
用户的全局唯一编号，由系统在创建用户时指定。
否
实例代码
要在负载中指定给用户的公司的 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
未找到资源。