Saltar al contenido principal
Documentación
Documentación
Adaptive Planning
Última actualización: 2023-06-23
Instancias

Instancias

Punto final de URL

HTTPS://api.adaptiveplanning.com/api/rest/security/<version>/<tenant>/users/instances
Versión: v1
Categoría
Actualización de datos
Descripción
Asigne usuarios a instancias cuando utilice varias instancias de Adaptive Planning en una jerarquía principal-secundaria.
Permisos obligatorios para invocar
Acceso de administrador > Usuarios
La API de acceso de usuario a varias instancias le permite recuperar y cambiar las asignaciones de instancia de un usuario.

VERB HTTPS admitidos:

HTTP Verb
Recurso único
Recurso de recopilación
Descripción
GET
No admitido
Compatible
Recupera todas las asignaciones de instancia de los usuarios, incluida su asignación de instancia por defecto.
PARCHE
Compatible
No admitido
Añade una nueva instancia a la asignación de instancia de un usuario existente.
PUT
Compatible
No admitido
Actualiza y sustituye las instancias existentes asignadas a un usuario con los datos especificados en el cuerpo de la solicitud.

GET

Solicitud:
/users/instances:
Recupera una recopilación de instancias asignadas a usuarios.
Recupera todas las asignaciones de instancia de los usuarios, incluida su asignación de instancia por defecto. Puede filtrar por instanceCode. La paginación utiliza los valores por defecto de límite o compensación si faltan estos parámetros de consulta.
URI de solicitud de muestra
HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/users/instances?offset=5&limit=5
Cabecera de solicitud de muestra:
Accept-Language: es
Cuerpo de solicitud de muestra
Parámetros de consulta
Nombre
Descripción
Obligatorias
instanceCode
El identificador exclusivo de una instancia que define el contexto de instancia para recuperar la lista de usuarios de esa instancia. Si no se especifica un código de instancia, se recuperan todos los usuarios de la instancia por defecto del emisor de la API.
No
limit
El número máximo de objetos en una sola respuesta. El valor por defecto es 500. El máximo es 500.
No
offset
El índice de base cero del primer usuario de una recopilación de respuestas. El valor por defecto es 0.
Utilice la compensación con el parámetro limit para controlar la paginación de una recopilación de respuestas.
No
Respuesta de muestra
200
Respuesta correcta
Respuesta de muestra
 

{
"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
           }
       ]
   }
]
}

PARCHE:

Solicitud:
users/instances?instanceCode={INSTANCECODE}:
Actualiza parcialmente la asignación de instancia de un usuario existente.
Añade una nueva instancia a la asignación de instancia de un usuario existente. Si especifica el atributo por defecto para una instancia, sustituye la asignación de instancia por defecto actual del usuario.
Especifique un identificador de usuario en el parámetro de consulta userIdentifier.
En el cuerpo de la solicitud, especifique un userIdentifier.
URI de solicitud de muestra
HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/users/instances?userIdentifier=userName
Cuerpo de solicitud de muestra
Ejemplo de cuerpo de solicitud PATCH
 

{
      "userName": "SampleUser1@SampleCompany.com",
      "instances": [
          {
              "code": "SampleCompany"
          },
          {
              "code": "SampleCompany_Child",
              "default": true
          }
      ]
  }
Parámetros de consulta
Nombre
Descripción
Obligatorias
instanceCode
Un código de instancia que está más arriba en la misma jerarquía de instancias que la instancia que se añade para un usuario existente. Solo los usuarios con acceso a la instancia principal de nivel superior pueden añadir instancias secundarias.
No
userIdentifier
Se utiliza un userIdentifier para determinar el usuario exclusivo de Adaptive Planning. Valores posibles: userName, wid, userGuid.
Sí
Cabecera de solicitud
Tipo de contenido
application/json
Autorización
Básico o basado en token
Parámetros de carga útil
Nombre
Descripción
Obligatorias
wid
El ID de Workday de un usuario.
No
userName
El nombre de usuario (nombre de inicio de sesión) de un usuario.
No
userGuid
El identificador de usuario exclusivo global, asignado por el sistema en el momento de la creación del usuario.
No
Código de instancia
Un instanceCode de empresa que se asignará a un usuario en la carga útil.
Sí
valor por defecto
El instanceCode por defecto asignado a un usuario en la carga útil.
No

PUT:

Solicitud:
users/instances
:
actualiza y sustituye las instancias existentes asignadas a un usuario.
Actualiza una instancia existente asignada a un usuario con el userIdentifier especificado. Sustituye las instancias asignadas al usuario por los datos especificados en el cuerpo de la solicitud.
  • Si una asignación de instancia no forma parte de las instancias existentes asignadas a un usuario, añade la instancia.
  • Si una asignación de instancia no forma parte del cuerpo de la solicitud, se elimina el acceso a la instancia si existía anteriormente.
  • Especifique un identificador de usuario en el parámetro de consulta userIdentifier.
  • Especifique un código de instancia en el parámetro de consulta instanceCode según sea necesario.
  • Un identificador de usuario en el parámetro de consulta userIdentifier.
  • En el cuerpo de la solicitud, especifique los siguientes campos obligatorios: <userIdentifier> (Username, WID o userGUID). <userIdentifier> es el valor que ha especificado en el parámetro de consulta userIdentifier.
  • Si especifica el atributo por defecto para una instancia, sustituye la instancia por defecto actual para el usuario.
URI de solicitud de muestra
HTTPS://api.adaptiveinsights.com/api/rest/security/v{1}/{default}/users/instances?userIdentifier=userName
Cuerpo de solicitud de muestra
Cuerpo de solicitud PUT de muestra 

{
      "userName": "sampleUser@SampleCompanyParent.com",
      "instances": [
          {
              "code": "SampleCompanyParent"
          },
          {
              "code": "SampleCompanyChild",
              "default": true
          },
          {
              "code": "SampleCompanyGrandChild"
          }
      ]
  }
Parámetros de consulta
Nombre
Descripción
Obligatorias
instanceCode
Un código de instancia que está más arriba en la misma jerarquía de instancias que la instancia que se añade para un usuario existente. Solo los usuarios con acceso a la instancia principal de nivel superior pueden añadir instancias secundarias.
No
userIdentifier
Se utiliza un userIdentifier para determinar el usuario exclusivo de Adaptive Planning. Valores posibles: userName, wid, userGuid.
Sí
Cabecera de solicitud
Tipo de contenido
application/json
Autorización
Básico o basado en token
Parámetros de carga útil
Nombre
Descripción
Obligatorias
wid
El ID de Workday de un usuario.
No
userName
El nombre de usuario (nombre de inicio de sesión) de un usuario.
No
userGuid
El identificador de usuario exclusivo global, asignado por el sistema en el momento de la creación del usuario.
No
Código de instancia
Un instanceCode de empresa que se asignará a un usuario en la carga útil.
Sí
valor por defecto
El instanceCode por defecto asignado a un usuario en la carga útil.
No
Respuestas
Respuestas
Lista de códigos de estado admitidos:
200
Respuesta correcta.
Ejemplo de respuesta
Ejemplo de respuesta correcta de PATCH 200
 

{
"userName": "SampleUser@SampleComopany.com",
"instances": [
    {
        "code": "SampleCompany"
    },
    {
        "code": "SampleCompany_Child1",
        "default": true
    }
]
}
500
Error interno de servidor
Ejemplo: si el usuario no es válido.
Ejemplo de respuesta 500
 

{
 "status": {
     "errorMessage": "User with username user@samplecompany.com does not exists in company SampleCompany. "
 },
 "userName": "user@samplecompany.com"
}
Ejemplo: si el código de instancia no es válido
Ejemplo de respuesta 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 u operación no válidos
403
El usuario no tiene suficientes permisos
404
No se ha encontrado el recurso.