Skip to main content
Documentatie
Documentatie
Adaptive Planning
Laatst bijgewerkt: 2024-03-08
Groepen

Groepen

URL-eindpunt

HTTPS://api.adaptiveplanning.com/api/rest/security/<version>/<tenant>/groups/{groupID}
Versie: v1
Categorie
Ophalen van metagegevens
Omschrijving
Retourneert de volledige lijst met alle groepen die voor de opgegeven instance zijn gedefinieerd. Dit omvat de groepen die algemeen zijn gedefinieerd voor de hele instance en de groepen die door gebruikers zijn gedefinieerd.
Vereiste machtigingen voor aanroepen
Beheerderstoegang > Gebruikers
Vereiste parameters op aanvraag
Referenties

Ondersteunde HTTP-werkwoord(en)

HTTP Verb
Eén resource
Inningsresource
Omschrijving
GET
Ondersteund
Ondersteund
Hiermee worden groepen opgehaald uit de planning.

GET:

Aanvraag:
/groups/{groupId}
Haalt de lijst op met alle groepen en hun gebruikers/leden die voor de opgegeven instance zijn gedefinieerd.
Voorbeeldaanvraag-URI:
HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=globalsales&offset=2&limit=1
Kop voorbeeldaanvraag:
Taal accepteren: en
Hoofdtekst voorbeeldaanvraag
Queryparameters
Naam
Omschrijving
Vereist
groupId
De ID van de groep die u afzonderlijk wilt retourneren
N
includeUsers
Om te bepalen of gebruikers van groepen die worden aangeroepen moeten worden geretourneerd. Gebruikers opnemen is standaard ingeschakeld.
N
limiet
Het maximum aantal objecten in één antwoord.
N
verschuiving
Om een bepaald aantal groepen per pagina weer te geven. Als er meer groepen zijn dan de limiet, worden de extra groepen weergegeven op de volgende pagina. Als u een bepaalde pagina wilt openen, moet u een verschuivingswaarde opgeven.
N
instanceCode
Standaard wordt de standaard die aan de instancegebruiker is toegewezen geretourneerd. Door een waarde op te geven, kunt u instances aanroepen waartoe uw gebruiker toegang heeft, inclusief bovenliggende/onderliggende instances.
N
Voorbeeldantwoord:
Voorbeeldantwoord:
 
{
   "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"
               }
           ]
       }
   ]
}
Antwoordelement
Tagnaam
antwoord
Kenmerken van het element
Kenmerknaam
Vereist?
Waarde
Voorbeeld
totaal
J
Totaal aantal groepen.
3
groepen
J
Groepsgegevens van alle of opgegeven groepen. Als een groep zich in een andere groep bevindt, worden ook de groepen weergegeven die aan de aangegeven groep zijn gekoppeld.
{
"id": 1,
"name": "Corporate and Operations",
"groupType": "NATIVE",
"users": []
}
groupType
J
Hiermee wordt het type groep weergegeven.
Extern
ID
J
Gekoppelde ID van de groep.
1
Naam
J
Naam van de groep.
Beheerders
gebruikers
N
Als includeUsers = true of includeUsers de standaardwaarde is, wordt deze geleverd met de guid, wid en gebruikersnaam van de gebruiker. zo niet, dan wordt deze niet geretourneerd.
"users": [
{
"userGuid": "randomValue",
"wid": "",
"userName": "test@example.com"
},
{
"userGuid": "randomValue",
"wid": "",
"userName": "test2@example.com"
}
koppelingen
N
Wanneer limiet en/of verschuiving is opgegeven en u een manier nodig hebt om naar verschillende pagina's met groepen te gaan, kunt u koppelingen gebruiken om heen en weer te gaan.
"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"
}
volgende
N
Als een limiet is opgegeven en er een volgende pagina beschikbaar is, wordt 'koppelingen' weergegeven met 'next'.
"HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=2&limit=1"
vorige
N
Als limiet en verschuiving is opgegeven en u zich in het midden bevindt waar een vorige en volgende pagina beschikbaar is, is 'vorige' beschikbaar.
"HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=2&limit=1"
Inhoud van het element
Informatie met betrekking tot aangegeven elementen.
Foutantwoorden
Fouten
Oorzaak
Geef geldige parameterwaarden op voor limiet en verschuiving.
ongeldige invoer voor limiet-/verschuivingswaarden
GroupAPI: voor getGroupByGroupId: groep niet gevonden voor instancecode: {TENANT}
groupId bestaat niet voor instancecode
U hebt niet alle machtigingen om deze API uit te voeren: Algemene gebruikersgroepen beheren.
gebruikersreferenties hebben niet de juiste machtigingen om API-aanroep uit te voeren
Ongeldige referentie
Gebruikte referenties zijn onjuist voor instance
HTTP 404 niet gevonden
groupId-parameter is ongeldig