Ir para o conteúdo principal
Documentação
Documentação
Adaptive Planning
Última atualização: 2023-06-23
Instâncias

Instâncias

Ponto de extremidade de URL

HTTPS://api.adaptiveplanning.com/api/rest/security/<version>/<tenant>/users/instances
Versão: v1
Categoria
Atualização de dados
Descrição
Atribua usuários a instâncias quando usar várias instâncias do Adaptive Planning em uma hierarquia principal-secundário.
Permissões obrigatórias para invocar
Acesso administrativo > Usuários
A API de acesso de usuário a várias instâncias permite que você recupere e altere as atribuições de instância de um usuário.

VERBs de HTTPS com suporte:

Verbo HTTP
Recurso único
Recurso de cobrança
Descrição
GET
Sem suporte
Com suporte
Recupera todas as atribuições de instância de usuários, incluindo a atribuição de instância por padrão.
PATCH
Com suporte
Sem suporte
Adiciona uma nova instância à atribuição de instância de um usuário existente.
PUT
Com suporte
Sem suporte
Atualiza e substitui as instâncias existentes atribuídas a um usuário pelos dados especificados no corpo da solicitação.

GET

Solicitação:
/users/instances:
Recupera uma coleção de instâncias atribuídas a usuários.
Recupera todas as atribuições de instância de usuários, incluindo a atribuição de instância por padrão. Você pode filtrar por instanceCode. A paginação usa os valores por padrão para limite ou deslocamento se esses parâmetros de consulta estão ausentes.
URI de amostra de solicitação
HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/users/instances?offset=5&limit=5
Cabeçalho de solicitação de amostra:
Accept-Language: en
Corpo da solicitação de amostra
Parâmetros de consulta
Nome
Descrição
Obrigatório
instanceCode
O identificador exclusivo de uma instância que define o contexto da instância para recuperar a lista de usuários dessa instância. Se um código de instância não é especificado, todos os usuários da instância por padrão de quem chama a API são recuperados.
N
limit
O número máximo de objetos em uma única resposta. O valor por padrão é 500. O máximo é 500.
N
offset
O índice de base zero do primeiro usuário em uma coleção de respostas. O valor por padrão é 0.
Use o deslocamento com o parâmetro de limite para controlar a paginação de uma coleção de respostas.
N
Exemplo de resposta
200
Resposta bem-sucedida
Exemplo de resposta
 

{
"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:

Solicitação:
users/instances?instanceCode={INSTANCECODE}:
Atualiza parcialmente a atribuição de instância de um usuário existente.
Adiciona uma nova instância à atribuição de instância de um usuário existente. Se você especifica o atributo por padrão para uma instância, ele substitui a atribuição de instância por padrão atual do usuário.
Especifique uma ID de usuário no parâmetro de consulta userIdentifier.
No corpo da solicitação, especifique um userIdentifier.
URI de amostra de solicitação
HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/users/instances?userIdentifier=userName
Corpo da solicitação de amostra
Corpo da solicitação de PATCH de amostra
 

{
      "userName": "SampleUser1@SampleCompany.com",
      "instances": [
          {
              "code": "SampleCompany"
          },
          {
              "code": "SampleCompany_Child",
              "default": true
          }
      ]
  }
Parâmetros de consulta
Nome
Descrição
Obrigatório
instanceCode
Um código de instância superior na mesma hierarquia de instâncias que a instância que está sendo adicionada para um usuário existente. Somente usuários com acesso à instância pai de nível superior podem adicionar instâncias filho.
N
userIdentifier
Um userIdentifier é usado para determinar o usuário exclusivo do Adaptive Planning. Valores possíveis: userName, wid, userGuid.
S
Cabeçalho da solicitação
Tipo de conteúdo
application/json
Autorização
Básico ou baseado em token
Parâmetros de carga
Nome
Descrição
Obrigatório
wid
A ID Workday de um usuário.
N
userName
O nome de usuário (nome de logon) de um usuário.
N
userGuid
A ID global exclusiva de usuário, atribuída pelo sistema no momento da criação do usuário.
N
código da instância
Um instanceCode da empresa a ser atribuído a um usuário na carga.
S
valor por padrão
O instanceCode por padrão atribuído a um usuário na carga.
N

PUT:

Solicitação:
users/instances
:
atualiza e substitui instâncias existentes atribuídas a um usuário
Atualiza uma instância existente atribuída a um usuário com o userIdentifier especificado. Substitui as instâncias atribuídas ao usuário pelos dados especificados no corpo da solicitação.
  • Se uma atribuição de instância não faz parte das instâncias existentes atribuídas a um usuário, o adiciona a instância.
  • Se uma atribuição de instância não faz parte do corpo da solicitação, o acesso à instância é removido, se já existia.
  • Especifique uma ID de usuário no parâmetro de consulta userIdentifier.
  • Especifique um código de instância no parâmetro de consulta instanceCode, conforme necessário.
  • Uma ID de usuário no parâmetro de consulta userIdentifier.
  • No corpo da solicitação, especifique estes campos obrigatórios: <userIdentifier> (Nome de usuário, WID ou userGUID). <userIdentifier> é o valor que você especificou no parâmetro de consulta userIdentifier.
  • Se você especifica o atributo por padrão para uma instância, o substitui a instância por padrão atual do usuário.
URI de amostra de solicitação
HTTPS://api.adaptiveinsights.com/api/rest/security/v{1}/{default}/users/instances?userIdentifier=userName
Corpo da solicitação de amostra
Exemplo de corpo da solicitação PUT 

{
      "userName": "sampleUser@SampleCompanyParent.com",
      "instances": [
          {
              "code": "SampleCompanyParent"
          },
          {
              "code": "SampleCompanyChild",
              "default": true
          },
          {
              "code": "SampleCompanyGrandChild"
          }
      ]
  }
Parâmetros de consulta
Nome
Descrição
Obrigatório
instanceCode
Um código de instância superior na mesma hierarquia de instâncias que a instância que está sendo adicionada para um usuário existente. Somente usuários com acesso à instância pai de nível superior podem adicionar instâncias filho.
N
userIdentifier
Um userIdentifier é usado para determinar o usuário exclusivo do Adaptive Planning. Valores possíveis: userName, wid, userGuid.
S
Cabeçalho da solicitação
Tipo de conteúdo
application/json
Autorização
Básico ou baseado em token
Parâmetros de carga
Nome
Descrição
Obrigatório
wid
A ID Workday de um usuário.
N
userName
O nome de usuário (nome de logon) de um usuário.
N
userGuid
A ID global exclusiva de usuário, atribuída pelo sistema no momento da criação do usuário.
N
código da instância
Um instanceCode da empresa a ser atribuído a um usuário na carga.
S
valor por padrão
O instanceCode por padrão atribuído a um usuário na carga.
N
Respostas
Respostas
Lista de códigos de status com suporte:
200
Resposta bem-sucedida.
Exemplo de resposta
Amostra 200 - Resposta PATCH bem-sucedida
 

{
"userName": "SampleUser@SampleComopany.com",
"instances": [
    {
        "code": "SampleCompany"
    },
    {
        "code": "SampleCompany_Child1",
        "default": true
    }
]
}
500
Erro interno do servidor
Exemplo: se o usuário é inválido.
Exemplo de resposta 500
 

{
 "status": {
     "errorMessage": "User with username user@samplecompany.com does not exists in company SampleCompany. "
 },
 "userName": "user@samplecompany.com"
}
Exemplo: se instanceCode for inválido
Exemplo de resposta 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
Recurso ou operação inválida
403
O usuário não tem permissões suficientes
404
Recurso não localizado.