Skip to main content
Documentatie
Documentatie
Adaptive Planning
Laatst bijgewerkt: 2023-06-23
Instances

Instances

URL-eindpunt

HTTPS://api.adaptiveplanning.com/api/rest/security/<version>/<tenant>/users/instances
Versie: v1
Categorie
Gegevens bijwerken
Omschrijving
Wijs gebruikers toe aan instances wanneer u Adaptive Planning met meerdere instances gebruikt in een bovenliggende/onderliggende hiërarchie.
Vereiste machtigingen voor aanroepen
Beheerderstoegang > Gebruikers
Met de API voor gebruikerstoegang voor meerdere instances kunt u instancetoewijzingen voor een gebruiker ophalen en wijzigen.

Ondersteunde HTTPS-werkwoorden:

HTTP-werkwoord
Eén resource
Inningsresource
Omschrijving
GET
Niet ondersteund
Ondersteund
Hiermee worden alle instancetoewijzingen van gebruikers opgehaald, inclusief hun standaardinstancetoewijzing.
PATCH
Ondersteund
Niet ondersteund
Hiermee wordt een nieuwe instance toegevoegd aan de instancetoewijzing van een bestaande gebruiker.
PUT
Ondersteund
Niet ondersteund
Bestaande instances die aan een gebruiker zijn toegewezen, worden bijgewerkt en vervangen door de opgegeven gegevens in de hoofdtekst van de aanvraag.

GET

Aanvraag:
/users/instances:
Hiermee wordt een verzameling instances opgehaald die aan gebruikers zijn toegewezen.
Hiermee worden alle instancetoewijzingen van gebruikers opgehaald, inclusief hun standaardinstancetoewijzing. U kunt filteren op instanceCode. Bij paginering worden de standaardwaarden voor limiet of verschuiving gebruikt als deze queryparameters ontbreken.
Voorbeeldaanvraag-URI
HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/users/instances?offset=5&limit=5
Kop voorbeeldaanvraag:
Taal accepteren: en
Hoofdtekst voorbeeldaanvraag
Query Parameters
Naam
Omschrijving
Vereist
instanceCode
De unieke ID van een instance die de instancecontext definieert om de lijst met gebruikers voor die instance op te halen. Als er geen instancecode is opgegeven, worden alle gebruikers uit de standaardinstance van de API-aanroeper opgehaald.
N
limiet
Het maximum aantal objecten in één antwoord. De standaardwaarde is 500. Het maximum is 500.
N
verschuiving
De op nul gebaseerde index van de eerste gebruiker in een antwoordverzameling. De standaardwaarde is 0.
Gebruik verschuiving met de parameter limiet om het paginering van een antwoordverzameling te beheren.
N
Voorbeeldantwoord:
200
Geslaagd antwoord
Voorbeeldantwoord:
 

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

Aanvraag:
users/instances?instanceCode={INSTANCECODE}:
Hiermee wordt de instancetoewijzing van een bestaande gebruiker gedeeltelijk bijgewerkt.
Hiermee wordt een nieuwe instance toegevoegd aan de instancetoewijzing van een bestaande gebruiker. Als u het standaardkenmerk voor een instance opgeeft, wordt de huidige standaardinstancetoewijzing van de gebruiker vervangen.
Geef een gebruikers-ID op in de queryparameter userIdentifier.
Geef in de hoofdtekst van de aanvraag een userIdentifier op.
Voorbeeldaanvraag-URI
HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/users/instances?userIdentifier=userName
Hoofdtekst voorbeeldaanvraag
Hoofdtekst voorbeeld-PATCH-aanvraag
 

{
      "userName": "SampleUser1@SampleCompany.com",
      "instances": [
          {
              "code": "SampleCompany"
          },
          {
              "code": "SampleCompany_Child",
              "default": true
          }
      ]
  }
Query Parameters
Naam
Omschrijving
Vereist
instanceCode
Een instancecode die hoger is in dezelfde instancehiërarchie als de instance die wordt toegevoegd voor een bestaande gebruiker. Alleen gebruikers met toegang tot de bovenliggende instance op een hoger niveau kunnen onderliggende instances toevoegen.
N
userIdentifier
Er wordt een userIdentifier gebruikt om de unieke Adaptive Planning-gebruiker te bepalen. Mogelijke waarden: userName, wid, userGuid.
J
Aanvraagkop
Type inhoud
application/json
Autorisatie:
Basis of op basis van tokens
Payload Parameters
Naam
Omschrijving
Vereist
wid
De Workday-ID van een gebruiker.
N
gebruikersnaam
De gebruikersnaam (aanmeldingsnaam) van een gebruiker.
N
userGuid
De algemene unieke gebruikers-ID die door het systeem wordt toegewezen bij het maken van de gebruiker.
N
instancecode
Een instanceCode van het bedrijf dat moet worden toegewezen aan een gebruiker in de payload.
J
standaard
De standaardinstanceCode die is toegewezen aan een gebruiker in de payload.
N

PUT:

Aanvraag:
users/instances
:
werkt bij en vervangt bestaande instances die aan een gebruiker zijn toegewezen
Hiermee wordt een bestaande instance bijgewerkt die is toegewezen aan een gebruiker met de opgegeven userIdentifier. Aan de gebruiker toegewezen instances worden vervangen door opgegeven gegevens in de hoofdtekst van de aanvraag.
  • Als een instancetoewijzing geen deel uitmaakt van bestaande instances die aan een gebruiker zijn toegewezen, wordt de instance toegevoegd.
  • Als een instancetoewijzing geen deel uitmaakt van de hoofdtekst van de aanvraag, wordt de toegang tot de instance verwijderd als deze eerder bestond.
  • Geef een gebruikers-ID op in de queryparameter userIdentifier.
  • Geef indien nodig een instancecode op in de queryparameter instanceCode.
  • Een gebruikers-ID in de queryparameter userIdentifier.
  • Geef in de hoofdtekst van de aanvraag de volgende vereiste velden op: <userIdentifier> (Username, WID of userGUID). <userIdentifier> is de waarde die u hebt opgegeven in de queryparameter userIdentifier.
  • Als u het standaardkenmerk voor een instance opgeeft, wordt de huidige standaardinstance voor de gebruiker vervangen.
Voorbeeldaanvraag-URI
HTTPS://api.adaptiveinsights.com/api/rest/security/v{1}/{default}/users/instances?userIdentifier=userName
Hoofdtekst voorbeeldaanvraag
Hoofdtekst van voorbeeld-PUT-aanvraag 

{
      "userName": "sampleUser@SampleCompanyParent.com",
      "instances": [
          {
              "code": "SampleCompanyParent"
          },
          {
              "code": "SampleCompanyChild",
              "default": true
          },
          {
              "code": "SampleCompanyGrandChild"
          }
      ]
  }
Query Parameters
Naam
Omschrijving
Vereist
instanceCode
Een instancecode die hoger is in dezelfde instancehiërarchie als de instance die wordt toegevoegd voor een bestaande gebruiker. Alleen gebruikers met toegang tot de bovenliggende instance op een hoger niveau kunnen onderliggende instances toevoegen.
N
userIdentifier
Er wordt een userIdentifier gebruikt om de unieke Adaptive Planning-gebruiker te bepalen. Mogelijke waarden: userName, wid, userGuid.
J
Aanvraagkop
Type inhoud
application/json
Autorisatie:
Basis of op basis van tokens
Payload Parameters
Naam
Omschrijving
Vereist
wid
De Workday-ID van een gebruiker.
N
gebruikersnaam
De gebruikersnaam (aanmeldingsnaam) van een gebruiker.
N
userGuid
De algemene unieke gebruikers-ID die door het systeem wordt toegewezen bij het maken van de gebruiker.
N
instancecode
Een instanceCode van het bedrijf dat moet worden toegewezen aan een gebruiker in de payload.
J
standaard
De standaardinstanceCode die is toegewezen aan een gebruiker in de payload.
N
Antwoorden
Antwoorden
Lijst met ondersteunde statuscodes:
200
Geslaagd antwoord.
Voorbeeldantwoord:
Voorbeeld van geslaagde PATCH-antwoord 200
 

{
"userName": "SampleUser@SampleComopany.com",
"instances": [
    {
        "code": "SampleCompany"
    },
    {
        "code": "SampleCompany_Child1",
        "default": true
    }
]
}
500
Interne serverfout
Voorbeeld: Als Gebruiker ongeldig is.
Voorbeeld van antwoord 500
 

{
 "status": {
     "errorMessage": "User with username user@samplecompany.com does not exists in company SampleCompany. "
 },
 "userName": "user@samplecompany.com"
}
Voorbeeld: indien ongeldig instanceCode
Voorbeeld van antwoord 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
Ongeldige resource of bewerking
403
Gebruiker heeft onvoldoende machtigingen
404
Resource niet gevonden.