Zum Hauptinhalt wechseln
Dokumentation
Dokumentation
Adaptive Planning
Zuletzt aktualisiert: 2023-06-23
Instanzen

Instanzen

URL-Endpunkt

HTTPS://api.adaptiveplanning.com/api/rest/security/<version>/<tenant>/users/instances
Version: v1
Kategorie
Datenaktualisierung
Beschreibung
Weisen Sie Benutzern Instanzen zu, wenn Sie Adaptive Planning mit mehreren Instanzen in einer über-/untergeordneten Hierarchie verwenden.
Zum Aufrufen sind Berechtigungen erforderlich
Administratorzugriff > Benutzer
Mit der API für den Multiinstanz-Benutzerzugriff können Sie Instanzzuweisungen für einen Benutzer abrufen und ändern.

Unterstützte HTTPS-VERBs:

HTTP Verb
Einzelressource
Einzugsressource
Beschreibung
GET
Nicht unterstützt
Unterstützt
Ruft alle Instanzzuweisungen von Benutzern ab, einschließlich ihrer Standardinstanzzuweisung.
PATCH
Unterstützt
Nicht unterstützt
Fügt eine neue Instanz zur Instanzzuweisung eines vorhandenen Benutzers hinzu.
PUT
Unterstützt
Nicht unterstützt
Aktualisiert und ersetzt vorhandene Instanzen, die einem Benutzer zugewiesen sind, durch die angegebenen Daten im Anforderungstext.

GET

Anfrage:
/users/instances:
Ruft eine Sammlung von Instanzen ab, die Benutzern zugewiesen sind.
Ruft alle Instanzzuweisungen von Benutzern ab, einschließlich ihrer Standardinstanzzuweisung. Sie können nach instanceCode filtern. Die Paginierung verwendet die Standardwerte für Grenzwert oder Versatz, wenn diese Abfrageparameter fehlen.
Beispiel-URI für Anforderung
HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/users/instances?offset=5&limit=5
Beispiel für Anforderungs-Header:
Accept-Language: en
Beispielanforderungstext
Abfrageparameter
Name
Beschreibung
Erforderlich
instanceCode
Die eindeutige Kennung einer Instanz, die den Instanzkontext definiert, um die Liste der Benutzer für diese Instanz abzurufen. Wenn kein Instanzcode angegeben wird, werden alle Benutzer aus der Standardinstanz des API-Aufrufers abgerufen.
N
limit
Die maximale Anzahl von Objekten in einer einzelnen Antwort. Der Standardwert ist 500. Maximal sind 500 zulässig.
N
offset
Der 0-basierte Index des ersten Benutzers in einer Antwortsammlung. Der Standardwert ist 0.
Verwenden Sie Offset mit dem Grenzwert-Parameter, um das Paging einer Antworterfassung zu steuern.
N
Beispielantwort
200
Erfolgreiche Antwort
Beispielantwort
 

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

Anfrage:
users/instances?instanceCode={INSTANCECODE}:
Aktualisiert teilweise die Instanzzuweisung eines vorhandenen Benutzers.
Fügt eine neue Instanz zur Instanzzuweisung eines vorhandenen Benutzers hinzu. Wenn Sie das Standardattribut für eine Instanz angeben, ersetzt es die aktuelle Standardinstanzzuweisung des Benutzers.
Geben Sie im Abfrageparameter "userIdentifier" eine Benutzer-ID an.
Geben Sie im Anforderungstext einen userIdentifier an.
Beispiel-URI für Anforderung
HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/users/instances?userIdentifier=userName
Beispielanforderungstext
Beispiel für PATCH-Anforderungstext
 

{
      "userName": "SampleUser1@SampleCompany.com",
      "instances": [
          {
              "code": "SampleCompany"
          },
          {
              "code": "SampleCompany_Child",
              "default": true
          }
      ]
  }
Abfrageparameter
Name
Beschreibung
Erforderlich
instanceCode
Ein Instanzcode, der in derselben Instanzhierarchie weiter oben liegt als die Instanz, die für einen vorhandenen Benutzer hinzugefügt werden soll. Nur Benutzer mit Zugriff auf die übergeordnete Instanz können untergeordnete Instanzen hinzufügen.
N
userIdentifier
Ein userIdentifier wird verwendet, um den eindeutigen Adaptive Planning-Benutzer zu bestimmen. Mögliche Werte: userName, wid, userGuid.
J
Anforderungs-Header
Inhaltsart
application/json
Autorisierung
Einfach oder Token-basiert
Nutzlastparameter
Name
Beschreibung
Erforderlich
wid
Die Workday-ID eines Benutzers.
N
userName
Der Benutzername (Anmeldename) eines Benutzers.
N
userGuid
Die eindeutige Benutzer-ID Global, die bei der Erstellung des Benutzers vom System zugewiesen wird.
N
Instanz Code
Ein instanceCode des Unternehmens, das einem Benutzer in der Nutzlast zugewiesen werden soll.
J
Standard
Der Standard-instanceCode, der einem Benutzer in der Payload zugewiesen ist.
N

PUT:

Anfrage:
users/instances
:
Aktualisiert und ersetzt vorhandene Instanzen, die einem Benutzer zugewiesen sind
Aktualisiert eine vorhandene Instanz, die einem Benutzer mit dem angegebenen userIdentifier zugewiesen ist. Ersetzt dem Benutzer zugewiesene Instanzen durch angegebene Daten im Anforderungstext.
  • Wenn eine Instanzzuweisung nicht Teil vorhandener Instanzen ist, die einem Benutzer zugewiesen sind, fügt die Instanz hinzu.
  • Wenn eine Instanzzuweisung kein Teil des Anforderungstexts ist, wird der Zugriff auf die Instanz entfernt, falls sie zuvor vorhanden war.
  • Geben Sie im Abfrageparameter "userIdentifier" eine Benutzer-ID an.
  • Geben Sie bei Bedarf einen Instanzcode im Abfrageparameter instanceCode an.
  • Eine Benutzer-ID im Abfrageparameter userIdentifier.
  • Geben Sie im Anforderungstext die folgenden erforderlichen Felder an: <userIdentifier> (Benutzername, WID oder userGUID). <userIdentifier> ist der Wert, den Sie im Abfrageparameter "userIdentifier" angegeben haben.
  • Wenn Sie das Standardattribut für eine Instanz angeben, ersetzt die aktuelle Standardinstanz für den Benutzer.
Beispiel-URI für Anforderung
HTTPS://api.adaptiveinsights.com/api/rest/security/v{1}/{default}/users/instances?userIdentifier=userName
Beispielanforderungstext
Beispiel für PUT-Anforderungstext 

{
      "userName": "sampleUser@SampleCompanyParent.com",
      "instances": [
          {
              "code": "SampleCompanyParent"
          },
          {
              "code": "SampleCompanyChild",
              "default": true
          },
          {
              "code": "SampleCompanyGrandChild"
          }
      ]
  }
Abfrageparameter
Name
Beschreibung
Erforderlich
instanceCode
Ein Instanzcode, der in derselben Instanzhierarchie weiter oben liegt als die Instanz, die für einen vorhandenen Benutzer hinzugefügt werden soll. Nur Benutzer mit Zugriff auf die übergeordnete Instanz können untergeordnete Instanzen hinzufügen.
N
userIdentifier
Ein userIdentifier wird verwendet, um den eindeutigen Adaptive Planning-Benutzer zu bestimmen. Mögliche Werte: userName, wid, userGuid.
J
Anforderungs-Header
Inhaltsart
application/json
Autorisierung
Einfach oder Token-basiert
Nutzlastparameter
Name
Beschreibung
Erforderlich
wid
Die Workday-ID eines Benutzers.
N
userName
Der Benutzername (Anmeldename) eines Benutzers.
N
userGuid
Die eindeutige Benutzer-ID Global, die bei der Erstellung des Benutzers vom System zugewiesen wird.
N
Instanz Code
Ein instanceCode des Unternehmens, das einem Benutzer in der Nutzlast zugewiesen werden soll.
J
Standard
Der Standard-instanceCode, der einem Benutzer in der Payload zugewiesen ist.
N
Antworten
Antworten
Liste der unterstützten Statuscodes:
200
Erfolgreiche Antwort.
Beispielantwort
Beispielantwort von 200 Successful PATCH
 

{
"userName": "SampleUser@SampleComopany.com",
"instances": [
    {
        "code": "SampleCompany"
    },
    {
        "code": "SampleCompany_Child1",
        "default": true
    }
]
}
500
Interner Serverfehler
Beispiel: Wenn Benutzer ungültig ist.
Beispielantwort 500
 

{
 "status": {
     "errorMessage": "User with username user@samplecompany.com does not exists in company SampleCompany. "
 },
 "userName": "user@samplecompany.com"
}
Beispiel: Bei ungültigem Instanzcode
Beispielantwort 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
Ungültige Ressource oder ungültiger Vorgang
403
Benutzer hat unzureichende Berechtigungen
404
Ressource nicht gefunden.