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

Instances

Point de terminaison de l'URL

HTTPS://api.adaptiveplanning.com/api/rest/security/<version>/<tenant>/users/instances
Version : v1
Catégorie
Mise à jour des données
Description
Affecter des utilisateurs à des instances lorsque vous utilisez des instances Adaptive Planning multiples dans une hiérarchie parent-enfant.
Autorisations requises pour appeler
Accès administrateur > Utilisateurs
L'API d'accès utilisateur multi-instances vous permet de récupérer et de modifier les affectations d'instances d'un utilisateur.

VERB HTTPS pris en charge :

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

GET

Demande :
/users/instances:
Récupère un ensemble d'instances affectées à des 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 de requête sont manquants.
Exemple d'URI de demande
HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/users/instances?offset=5&limit=5
Exemple d'en-tête de demande :
Accepter la langue : en
Exemple de corps de demande
Paramètres de requête
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 un code d'instance n'est pas indiqué, tous les utilisateurs de l'instance par défaut de l'appelant API seront récupérés.
N
limit
Le nombre maximum d'objets dans une même réponse. La valeur par défaut est 500. Le maximum est 500.
N
offset
Index à base zéro du premier utilisateur dans une collection de réponse. La valeur par défaut est 0.
Utilisez le décalage avec le paramètre de limite pour contrôler la pagination d'un ensemble 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 indiquez l'attribut par défaut d'une instance, il remplace l'affectation d'instance par défaut actuelle de l'utilisateur.
Spécifiez un identifiant utilisateur dans le paramètre de requête userIdentifier.
Dans le corps de la demande, indiquez un userIdentifier.
Exemple d'URI de demande
HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/users/instances?userIdentifier=userName
Exemple de corps de demande
Exemple de corps de la demande de PATCH
 

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

INSÉRER :

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 utilisateur spécifié. Remplace les instances affectées à l'utilisateur par les données indiquées dans le corps de la demande.
  • Si une affectation d'instance ne fait pas partie d'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 sera supprimé s'il existait précédemment.
  • Spécifiez un identifiant utilisateur dans le paramètre de requête userIdentifier.
  • Spécifiez un code d'instance dans le paramètre de requête instanceCode le cas échéant.
  • Un identifiant utilisateur dans le paramètre de requête userIdentifier.
  • Dans le corps de la demande, indiquez les champs obligatoires suivants : <userIdentifier> (Nom d'utilisateur, WID ou userGUID). <userIdentifier> est la valeur que vous avez indiquée dans le paramètre de requête userIdentifier.
  • Si vous indiquez l'attribut par défaut d'une instance, remplace l'instance par défaut actuelle pour l'utilisateur.
Exemple d'URI de demande
HTTPS://api.adaptiveinsights.com/api/rest/security/v{1}/{default}/users/instances?userIdentifier=userName
Exemple de corps de demande
Corps de la demande d'envoi de l'exemple 

{
      "userName": "sampleUser@SampleCompanyParent.com",
      "instances": [
          {
              "code": "SampleCompanyParent"
          },
          {
              "code": "SampleCompanyChild",
              "default": true
          },
          {
              "code": "SampleCompanyGrandChild"
          }
      ]
  }
Paramètres de requête
Nom
Description
Obligatoire
instanceCode
Un code d'instance plus élevé dans la même hiérarchie d'instances que celui de l'instance ajoutée pour un utilisateur existant. Seuls les utilisateurs ayant accès à l'instance parent de niveau supérieur peuvent ajouter des instances enfants.
N
userIdentifier
userIdentifier est utilisé pour déterminer l'utilisateur Adaptive Planning unique. Valeurs possibles : userName, wid, userGuid.
O
En-tête de la demande
Type de contenu
application/json
Autorisation
Basic ou par jeton
Paramètres des données utiles
Nom
Description
Obligatoire
identifiant Workday
L'identifiant Workday d'un utilisateur.
N
nom d'utilisateur
Le nom d'utilisateur (nom de connexion) d'un utilisateur.
N
userGuid
Identifiant utilisateur unique global, affecté par le système lors de sa création.
N
Code de l'instance
Un instanceCode de l'unité légale à affecter à un utilisateur dans les données utiles.
O
par défaut
Le code de l'instance par défaut attribué à un utilisateur dans les données utiles.
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éponse PATCH réussie
 

{
"userName": "SampleUser@SampleComopany.com",
"instances": [
    {
        "code": "SampleCompany"
    },
    {
        "code": "SampleCompany_Child1",
        "default": true
    }
]
}
500
Erreur interne du serveur
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 ou opération non valide
403
L'utilisateur ne dispose pas des autorisations requises
404
Ressource introuvable.