Passer au contenu principal
Documentation
Documentation
Adaptive Planning
Dernière mise à jour : 2023-06-23
Instances

Instances

Point de terminaison de l'adresse URL

HTTPS://api.adaptiveplanning.com/api/rest/security/<version>/<tenant>/users/instances
Version : v1
Catégorie
Mise à jour des données
Description
Affectez des utilisateurs à des instances lorsque vous utilisez des instances multiples Adaptive Planning dans une hiérarchie parent-enfant.
Autorisations obligatoires pour pouvoir être appelées
Accès administrateur > Utilisateurs
L’API Multi-instance User Access vous permet de récupérer et de modifier les affectations d’instances pour un utilisateur.

HTTPS VERB pris en charge :

Configurer HTTP HTTP
Ressource unique
Ressource de recouvrement
Description
GET
Non pris en charge
Pris en charge
Récupère toutes les affectations d’instances des utilisateurs, y compris leur affectation d’instance par défaut.
PATCH
Pris en charge
Non pris en charge
Ajoute une nouvelle instance à l’affectation d’instance d’un utilisateur existant.
PUT
Pris en charge
Non pris en charge
Met à jour et remplace les instances existantes affectées à un utilisateur avec les données précisées dans le corps de la demande.

GET

Demande :
/users/instances:
Récupère un ensemble d’instances affectées aux utilisateurs.
Récupère toutes les affectations d’instances des utilisateurs, y compris leur affectation d’instance par défaut. Vous pouvez filtrer par instanceCode. La pagination utilise les valeurs par défaut pour la limite ou le décalage si ces paramètres d’interrogation sont manquants.
URI de demande d'exemple
HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/users/instances?offset=5&limit=5
En-tête de demande d’exemple :
Accepter la langue : en
Corps de la demande d'exemple
Paramètres d'interrogation
Nom
Description
Obligatoire
instanceCode
Identifiant unique d’une instance définissant le contexte de l’instance pour récupérer la liste des utilisateurs de cette instance. Si aucun code d’instance n’est indiqué, tous les utilisateurs de l’instance par défaut de l’appeler API sont récupérés.
N
limit
Le nombre maximum d’objets dans une seule réponse. La valeur par défaut est de 500. Le maximum est 500.
N
offset
L’index de zéro du premier utilisateur d’une collection de réponses. La valeur par défaut est 0.
Utilisez la valeur de décalage avec le paramètre de limite pour contrôler la pagination d’une collection de réponses.
N
Exemple de réponse
200
Réponse réussie
Exemple de réponse
 

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

Demande :
users/instances?instanceCode={INSTANCECODE}:
Met à jour partiellement l’affectation d’instance d’un utilisateur existant.
Ajoute une nouvelle instance à l’affectation d’instance d’un utilisateur existant. Si vous précisez l’attribut par défaut pour une instance, il remplace l’affectation d’instance par défaut actuelle de l’utilisateur.
Indiquez un identifiant utilisateur dans le paramètre d’interrogation userIdentifier.
Dans le corps de la demande, indiquez un userIdentifier.
URI de demande d'exemple
HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/users/instances?userIdentifier=userName
Corps de la demande d'exemple
Exemple de corps de demande PATCH
 

{
      "userName": "SampleUser1@SampleCompany.com",
      "instances": [
          {
              "code": "SampleCompany"
          },
          {
              "code": "SampleCompany_Child",
              "default": true
          }
      ]
  }
Paramètres d'interrogation
Nom
Description
Obligatoire
instanceCode
Un code d’instance qui est plus élevé dans la même hiérarchie d’instances que l’instance ajoutée pour un utilisateur existant. Seuls les utilisateurs ayant accès à l’instance parente de niveau supérieur peuvent ajouter des instances enfants.
N
userIdentifier
Un userIdentifier est utilisé pour déterminer l'utilisateur Adaptive Planning unique. Valeurs possibles : userName, wid, userGuid.
Y
En-tête de la demande
Type de contenu
application/json
Autorisation
De base ou à jeton
Paramètres des données utiles
Nom
Description
Obligatoire
Workday
Identifiant Workday d’un utilisateur.
N
userName
Le nom d’utilisateur (nom de connexion) d’un utilisateur.
N
userGuid
L’identifiant utilisateur unique global, affecté par le système lors de la création de l’utilisateur.
N
code de l'instance
Un instanceCode de la société à affecter à un utilisateur dans les données utiles.
Y
par défaut
La valeur par défaut d'instanceCode affectée à un utilisateur dans Payload.
N

PUT :

Demande :
users/instances
:
Met à jour et remplace les instances existantes affectées à un utilisateur
Met à jour une instance existante affectée à un utilisateur avec l’identifiant de utilisateur précisé. Remplace les instances affectées à l’utilisateur par des données précisées dans le corps de la demande.
  • Si une affectation d’instance ne fait pas partie des instances existantes affectées à un utilisateur, ajoute l’instance.
  • Si une affectation d’instance ne fait pas partie du corps de la demande, l’accès à l’instance est retiré si elle existait déjà.
  • Indiquez un identifiant utilisateur dans le paramètre d’interrogation userIdentifier.
  • Indiquez un code d’instance dans le paramètre d’interrogation instanceCode si nécessaire.
  • Un identifiant utilisateur dans le paramètre d’interrogation userIdentifier.
  • Dans le corps de la demande, précisez les champs obligatoires suivants : <userIdentifier> (Username, WID ou userGUID). <userIdentifier> est la valeur que vous avez indiquée dans le paramètre d'interrogation userIdentifier.
  • Si vous spécifiez l’attribut par défaut pour une instance, remplace l’instance par défaut actuelle pour l’utilisateur.
URI de demande d'exemple
HTTPS://api.adaptiveinsights.com/api/rest/security/v{1}/{default}/users/instances?userIdentifier=userName
Corps de la demande d'exemple
Exemple de corps de demande PUT 

{
      "userName": "sampleUser@SampleCompanyParent.com",
      "instances": [
          {
              "code": "SampleCompanyParent"
          },
          {
              "code": "SampleCompanyChild",
              "default": true
          },
          {
              "code": "SampleCompanyGrandChild"
          }
      ]
  }
Paramètres d'interrogation
Nom
Description
Obligatoire
instanceCode
Un code d’instance qui est plus élevé dans la même hiérarchie d’instances que l’instance ajoutée pour un utilisateur existant. Seuls les utilisateurs ayant accès à l’instance parente de niveau supérieur peuvent ajouter des instances enfants.
N
userIdentifier
Un userIdentifier est utilisé pour déterminer l'utilisateur Adaptive Planning unique. Valeurs possibles : userName, wid, userGuid.
Y
En-tête de la demande
Type de contenu
application/json
Autorisation
De base ou à jeton
Paramètres des données utiles
Nom
Description
Obligatoire
Workday
Identifiant Workday d’un utilisateur.
N
userName
Le nom d’utilisateur (nom de connexion) d’un utilisateur.
N
userGuid
L’identifiant utilisateur unique global, affecté par le système lors de la création de l’utilisateur.
N
code de l'instance
Un instanceCode de la société à affecter à un utilisateur dans les données utiles.
Y
par défaut
La valeur par défaut d'instanceCode affectée à un utilisateur dans Payload.
N
Réponses
Réponses
Liste des codes de statut pris en charge :
200
Réponse réussie.
Exemple de réponse
Exemple 200 de réponses PATCH réussies
 

{
"userName": "SampleUser@SampleComopany.com",
"instances": [
    {
        "code": "SampleCompany"
    },
    {
        "code": "SampleCompany_Child1",
        "default": true
    }
]
}
500
Erreur de serveur interne
Exemple : Si l’utilisateur n’est pas valide.
Exemple de réponse 500
 

{
 "status": {
     "errorMessage": "User with username user@samplecompany.com does not exists in company SampleCompany. "
 },
 "userName": "user@samplecompany.com"
}
Exemple : si instanceCode n’est pas valide
Exemple de réponse 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
Ressource non valide ou opération
403
L’utilisateur a des autorisations insuffisantes
404
Ressource introuvable.