Zum Hauptinhalt wechseln
Dokumentation
Dokumentation
Adaptive Planning
Zuletzt aktualisiert: 2024-03-08
Gruppen

Gruppen

URL-Endpunkt

HTTPS://api.adaptiveplanning.com/api/rest/security/<version>/<tenant>/groups/{groupID}
Version: v1
Kategorie
Abrufen von Metadaten
Beschreibung
Gibt die vollständige Liste aller für die angegebene Instanz definierten Gruppen zurück. Dazu gehören die Gruppen, die global für die gesamte Instanz definiert sind, und die Gruppen, die von Benutzern definiert sind.
Zum Aufrufen sind Berechtigungen erforderlich
Administratorzugriff > Benutzer
Auf Anforderung erforderliche Parameter
Zugangsdaten

Unterstützte HTTP-VERB(s)

HTTP Verb
Einzelressource
Einzugsressource
Beschreibung
GET
Unterstützt
Unterstützt
Ruft Gruppen aus Planning ab.

GET:

Anfrage:
/groups/{groupId}
Ruft die Liste aller Gruppen und ihrer Benutzer/Mitglieder ab, die für die angegebene Instanz definiert sind.
Beispiel für eine Anforderungs-URI:
HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/default/groups?instanceCode=globalsales&offset=2&limit=1
Beispiel für Anforderungs-Header:
Accept-Language: en
Beispielanforderungstext
Abfrageparameter
Name
Beschreibung
Erforderlich
groupId
Die ID der Gruppe, die Sie einzeln zurückgeben möchten
N
includeUsers
Um zu bestimmen, ob Benutzer von aufgerufenen Gruppen zurückgegeben werden sollen oder nicht. "Benutzer einschließen" ist standardmäßig aktiviert.
N
limit
Die maximale Anzahl von Objekten in einer einzelnen Antwort.
N
offset
Zur Anzeige einer bestimmten Anzahl von Gruppen pro Seite. Wenn mehr Gruppen als der Grenzwert vorhanden sind, werden die zusätzlichen Gruppen auf die nächste Seite verschoben. Um eine bestimmte Seite aufzurufen, müssen Sie einen Zeitversatz angeben.
N
instanceCode
Standardmäßig wird die dem Instanzbenutzer zugewiesene Standardinstanz zurückgegeben. Indem Sie einen Wert angeben, können Sie Instanzen aufrufen, auf die Ihr Benutzer Zugriff hat, einschließlich über-/untergeordnete Instanzen.
N
Beispielantwort
Beispielantwort
 
{
    "links": {
        "next": "HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=2&limit=1",
        "previous": "HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=0&limit=1"
    },
    "total": 3,
    "groups": [
        {
            "id": 2,
            "name": "Admins",
            "groupType": "NATIVE",
            "users": [
                {
                    "userGuid": "randomValue",
                    "wid": "",
                    "userName": "test@email.com"
                },
                {
                    "userGuid": "randomValue",
                    "wid": "",
                    "userName": "test2@email.com"
                },
            ]
        },
        {
            "id": 1,
            "name": "Corporate and Operations",
            "groupType": "NATIVE",
            "users": []
        },
        {
            "id": 3,
            "name": "Ops and Admins",
            "groupType": "NATIVE",
            "users": [],
            "groups": [
                {
                    "id": 2,
                    "name": "Admins",
                    "groupType": "NATIVE"
                },
                {
                    "id": 1,
                    "name": "Corporate and Operations",
                    "groupType": "NATIVE"
                }
            ]
        }
    ]
}
Antwortelement
Tag-Name
-Antwort
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
gesamt
J
Gesamtanzahl Gruppen.
3
Gruppe(n)
J
Gruppieren Sie Informationen aller oder angegebener Gruppen. Wenn sich eine Gruppe innerhalb einer anderen Gruppe befindet, werden auch Gruppen angezeigt, die mit der angegebenen Gruppe verknüpft sind.
{
"id": 1,
"name": "Corporate and Operations",
"groupType": "NATIVE",
"users": []
}
groupType
J
Zeigt die Art der Gruppe an.
Extern
id
J
Zugehörige ID der Gruppe.
1
Name
J
Name der Gruppe.
"Administratoren"
Benutzer(n)
N
Wenn includeUsers = true oder includeUsers die Standardvorgabe ist, wird sie mit GUID, WID und Benutzername des Benutzers bereitgestellt. Andernfalls wird es nicht zurückgegeben.
"users": [
{
"userGuid": "randomValue",
"wid": "",
"userName": "test@example.com"
},
{
"userGuid": "randomValue",
"wid": "",
"userName": "test2@example.com"
}
links
N
Wenn ein Grenzwert und/oder Zeitversatz angegeben ist und Sie eine Möglichkeit benötigen, zu verschiedenen Seiten von Gruppen zu wechseln, können Sie mithilfe von Links vor und zurück navigieren.
"links": {
"next": "HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=2&limit=1",
"previous": "HTTPS://api.adaptiveinsights.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=0&limit=1"
}
Nächste
N
Wenn ein Grenzwert angegeben wird und eine nächste Seite verfügbar ist, wird „links“ mit „next“ angezeigt.
"HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=2&limit=1"
vorherige
N
Wenn „Limit“ und „Zeitversatz“ angegeben ist und Sie sich gerade in der Mitte befinden, in der eine vorherige und eine weitere Seite verfügbar sind, ist „Vorherige“ verfügbar.
"HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=2&limit=1"
Inhalt des Elements
Informationen, die sich auf die angegebenen Elemente beziehen.
Fehlerantworten
Fehler
Ursache
Geben Sie gültige Parameterwerte für Grenzwert und Versatz an.
Ungültige Eingabe für Grenzwerte/Zeitversatzwerte
GroupAPI: für getGroupByGroupId, Gruppe für Instanzcode nicht gefunden: {TENANT}
groupId ist für den Instanzcode nicht vorhanden
Sie haben nicht alle Berechtigungen zum Ausführen der API: Globale Benutzergruppen verwalten.
Benutzerzugangsdaten haben keine entsprechenden Berechtigungen zum Aufrufen eines API-Aufrufs
Ungültige Zugangsdaten
Die verwendeten Zugangsdaten sind für die Instanz nicht korrekt
HTTP 404 nicht gefunden
groupId-Parameter ist ungültig