Delen via

QPP NextGen (preview)

Quark Publishing Platform (QPP) NextGen is een cloudgebaseerd inhoudsbeheersysteem (CCMS) voor het automatiseren van het publiceren van sterk gereglementeerde bedrijfsinhoud. De QPP NextGen-connector helpt bij het verplaatsen van gegevens uit uw inhoudsecosysteem in beide richtingen om processen te vereenvoudigen en de markttijd te versnellen.

Deze connector is beschikbaar in de volgende producten en regio's:

Dienst Class Regions
Copilot Studio Premium Alle Power Automate-regio's , met uitzondering van het volgende:
     - Amerikaanse overheid (GCC)
     - Amerikaanse overheid (GCC High)
     - China Cloud beheerd door 21Vianet
     - Us Department of Defense (DoD)
Logic-apps Standaard Alle Logic Apps-regio's , met uitzondering van het volgende:
     - Azure Government-regio's
     - Azure China-regio's
     - Us Department of Defense (DoD)
Power Apps Premium Alle Power Apps-regio's , met uitzondering van het volgende:
     - Amerikaanse overheid (GCC)
     - Amerikaanse overheid (GCC High)
     - China Cloud beheerd door 21Vianet
     - Us Department of Defense (DoD)
Power Automate Premium Alle Power Automate-regio's , met uitzondering van het volgende:
     - Amerikaanse overheid (GCC)
     - Amerikaanse overheid (GCC High)
     - China Cloud beheerd door 21Vianet
     - Us Department of Defense (DoD)
Contactpersoon
Naam Technische ondersteuning voor Quark
URL https://quarksoftware.my.site.com
E-mailen support_cases@quark.com
Connectormetagegevens
Uitgever Quark Software Inc.
Webpagina https://www.quark.com/
Privacybeleid https://www.quark.com/privacy-policy
Categorieën Inhoud en bestanden; Productiviteit

Quark Publishing Platform (QPP) NextGen is een cloudgebaseerd inhoudsbeheersysteem (CCMS) voor het automatiseren van het publiceren van sterk gereglementeerde bedrijfsinhoud. De QPP NextGen-connector helpt bij het verplaatsen van gegevens uit uw inhoudsecosysteem in beide richtingen om processen te vereenvoudigen en de markttijd te versnellen.

Vereiste voorwaarden

  • U hebt een QPP-NG-omgeving (v3.3 hierboven) en QPP-NG licenties nodig om onze connector te kunnen gebruiken.
  • U moet een bestaande client (verbinding) hebben, bij voorkeur afzonderlijk, gemaakt op de tenants waarvoor ze de acties en triggers van deze connector willen laten communiceren. Meer informatie vindt u in de sectie Referenties verkrijgen.
  • Meer informatie over het gebruik van Power Automate en het ophalen van waarde met behulp van dynamische inhoud of van andere acties als antwoord met behulp van querymaker.

Referenties ophalen

Tijdens het maken van een nieuwe verbinding met onze connector ziet u drie parameters. Details voor het verkrijgen van elk item worden hieronder gedeeld. Tijdens het maken en manaWhile maken van een nieuwe verbinding met onze connector zien gebruikers drie parameters. Details voor het verkrijgen van elk item worden hieronder gedeeld. Het maken en beheren van QPP-NG verbindingen moet worden uitgevoerd door de gebruiker met beheerdersrechten. Neem contact op met de beheerder van uw QPP-NG omgevingen.

U kunt uw referenties ook op de juiste manier een naam geven om ze later eenvoudig te identificeren. Ga naar Verbindingen in Power Automate, zoek naar de naam van de connector en bewerk een bestaande verbinding en geef een geschikte naam op.

  • Client-id: U kunt naar de gewenste QPP-NG tenants admin-app en vervolgens instellingenverbindingen >navigeren. Hier kunnen ze een nieuwe verbinding maken of een bestaande verbinding gebruiken. Voer gewoon de naam van de verbinding in voor client-id.
  • Clientgeheim: Net als client-id gaat u naar Verbindingen en voert u alleen geheim in voor de bestaande verbinding. Genereer het geheim opnieuw als u het niet hebt. Geheimen moeten veilig worden opgeslagen voor bestaande verbindingen, beheerd door de beheerder. Neem contact op met de beheerder voordat u het geheim regenereert.
  • Hostnaam: De hostnaam voor de QPP-NG tenant die u wilt maken om te communiceren met onze connector. voorbeeld (yourtenantname.app.quark.com). Moet de URL zichtbaar zijn wanneer u toegang hebt tot uw QPP-NG-omgeving.

Nadat u referenties hebt gemaakt, kunt u de referenties testen om te zien of de referenties juist zijn.

Eenvoudige acties zoals getUser kunnen worden gebruikt vanuit onze connector in een handmatige stroom. Test de stroom met standaardvelden.

Tijdens het maken van een verbinding voor de eerste keer, zijn enkele foutcodes die kunnen worden geconfronteerd, zoals hieronder wordt weergegeven:

  • Ongeldige host-URL (500): Controleer de hostnaam voor de QPP-NG-omgeving opnieuw, de client-id en het geheim moeten deel uitmaken van deze verbinding.
  • Niet geautoriseerd/unauthorized_client (401): Voor ongeldige clientreferenties of ongeldige clientreferenties moet u ervoor zorgen dat de client-id en het clientgeheim geldig zijn en behoren tot de hostnaam die wordt gebruikt.

Aan de slag met QPP-NG Integration Hub

Om aan de slag te gaan, kunt u luisteren naar een groot aantal gebeurtenissen van type asset, verzamelingen, enzovoort vanuit uw QPP-NG tenant met behulp van ingebouwde trigger.

  • Maak een nieuwe Automation-stroom in Power Automate.
  • Selecteer onze QPP-NG Connector en kies vervolgens een trigger.
  • Vul de vereiste velden in. Raadpleeg de sectie Webhook-trigger in de Github Readme-documentatie.
  • Selecteer de juiste verbinding voor de QPP-NG-tenant waar u de webhook wilt registreren. U kunt ook nieuwe verbindingen maken. Volg de stappen in de sectie Referenties ophalen .
  • Sla de stroom op. Hiermee wordt de registratieaanvraag aan de achterkant uitgevoerd. Wanneer u teruggaat naar de pagina met stroomdetails (of op de knop Terug klikt), ziet u bovenaan een groene onderstreping waarin wordt vermeld dat alles goed is gegaan en de stroom gereed is om te worden geactiveerd.
  • Zodra uw stroom eenmaal wordt uitgevoerd, kunt u de webhook-reactie op de stroomuitvoering verder ophalen en het antwoord gebruiken om dynamische inhoud te genereren. Hiervoor kunt u de json OOTB-actie parseren.
  • Als dit de eerste webhook is met dit wijzigingstype (gebeurtenis) dat is geregistreerd op de QPP-NG tenant, moet u 15 minuten wachten voordat de webhook is geactiveerd. Vervolgens kunt u verwachten dat de stroom wordt geactiveerd.

Als er fouten zijn in de stroomcontrole met de webhooktrigger, wordt power automate rood weergegeven in de stroomcontrole. Open deze en controleer de fout. Hieronder vindt u enkele van de fouten die u kunt tegenkomen en de stappen om deze te verhelpen.

  • Webhook met naam bestaat al Geef een unieke naam op voor de webhook of gebruik de bewerking Webhook verwijderen met dezelfde verbinding in een andere handmatige stroom. Selecteer de webhook met dezelfde naam en verwijder deze. Meer informatie over Webhooks vindt u in de Quark Developer-portal.
  • Ongeldige aanvraag (400) Controleer de parameters die zijn opgegeven volgens de documentatie en foutdetails.
  • Resource is niet gevonden (404) & Locatieheader ontbreekt in de aanvraag voor abonneren Verwijder de stroom en maak vervolgens een nieuwe webhooktrigger en -stroom. Als de stroom groot is, dupliceer dan de stroom en probeer tijdens het inschakelen en opslaan van de stroom een nieuwe webhookregistratie uit te voeren.

Bekende problemen en beperkingen

  • Op dit moment kunt u geen parameters bijwerken voor een al geregistreerde webhooktrigger. Als tijdelijke oplossing verwijdert u de huidige webhookbewerking uit de stroom en voegt u een nieuwe QPP-NG webhooktrigger toe. Als u de eerder geregistreerde webhook uit de QPP-NG-omgeving wilt verwijderen, maakt u een nieuwe handmatige stroom met de verwijderbewerking, selecteert u de vorige webhook in de vervolgkeuzelijst en voert u de stroom uit. Als deze tijdelijke oplossing niet werkt en de stroom groot is, dupliceer dan de stroom en sla deze op na het bijwerken van de webhookdetails op en schakel deze in. Hiermee wordt ook een nieuwe webhookregistratie gemaakt.
  • U kunt de stroom ook uitschakelen voordat u een nieuwe trigger verwijdert en maakt. Dit zorgt er ook voor dat uw nieuwe webhook wordt geregistreerd.
  • Als de QPP-NG webhookservice de geregistreerde webhook-trigger niet gedurende drie keer kan aanroepen, wordt de webhook uitgeschakeld.
  • Het opslaan van bepaalde acties zonder parameters (leeg) geeft een fout (verwacht een bepaalde waarde in de hoofdtekst).
  • Als dit de eerste webhook is met dit wijzigingstype (gebeurtenis), moet u 15 minuten wachten voordat de webhook is geactiveerd en dan kunt u verwachten dat de stroom wordt geactiveerd.
  • Gebruik de verouderde ontwerpweergave voor de beste ervaring, omdat er mogelijk problemen zijn met de nieuwe ontwerper vanwege een voortdurende ontwikkeling. Dergelijke acties met problemen met nieuwe ontwerper zijn CheckOut, SetAttributeValues, InitNewCheckin & CreateQuery.

Veelvoorkomende fouten en oplossingen

  • Tijdens het registreren van Webhooks Trigger als eerste stap, kan er een probleem zijn in de registratie bij onze service als de details niet correct worden opgegeven. Dit kan worden beperkt nadat u de stroom hebt opgeslagen met de trigger en terugkeert naar het paginavenster Stroomdetails waarin de uitvoeringen van de afgelopen 28 dagen worden weergegeven. Als het rood wordt weergegeven, betekent dit dat de webhook niet goed is geregistreerd. Controleer de fout. Als de fout optreedt omdat de locatieheader ontbreekt of de resource niet wordt gevonden, verwijdert u de trigger en maakt u de trigger opnieuw.
  • Als uw stromen niet worden geactiveerd, kan dit worden veroorzaakt door een bestaande webhook die is geregistreerd als een eindpunt dat niet bestaat, zoals een verwijderde stroom, enzovoort. Voer in een dergelijke situatie API-https://{Host.name}/webhooks/api/v3/registrations uit met uw API-token om een lijst op te halen met alle geregistreerde webhooks in de QPP-NG-omgeving en gebruik dit antwoord om dergelijke webhooks te verwijderen met behulp van de actie Webhooks verwijderen. U moet er ook voor zorgen dat de webhooks-service correct is geconfigureerd en wordt uitgevoerd vanuit uw Quark-ondersteuning met behulp van (https://quarksoftware.my.site.com).
  • Als u geen bevoegde gebruiker of een verificatiefout ontvangt, controleert u of de gebruikersnaam die is opgegeven voor imitatie voldoende bevoegdheden heeft in uw QPP-NG tenant.
  • In het geval van actiespecifieke problemen raadpleegt u voorbeelden en documentatie die wordt gedeeld in de opensource-opslagplaats op Github in Readme.md bestand of raadpleegt u de Quark Developer-portal voor meer informatie over eindpunten en functionaliteit.

Veelgestelde vragen

Kan ik de acties en triggers gebruiken met verschillende QPP-NG omgevingen?

Ja, het is mogelijk. U hoeft alleen de hostnaamparameter in te vullen op basis van de omgeving en de juiste verbindingen met die omgeving te gebruiken.

Kunt u ons helpen als we ergens aan vastzitten of twijfels hebben?

Absoluut. Stuur gewoon een e-mail naar [e-mail beveiligd] (https://quarksoftware.my.site.com) en zorg ervoor dat u de Microsoft Power Automate-connector vermeldt wanneer u uw probleem beschrijft.

Waar vind ik meer informatie over de acties en eindpunten?

Meer informatie over de verschillende Quark-API's vindt u hier. Ga naar het tabblad Inhoudsplatform. Omdat deze connector alleen een subset bevat van de werkelijke API die mogelijk is voor het QPP-NG-platform, kan deze site worden gebruikt om meer acties en eindpunten te verkennen en aan te vragen via het registreren van een functieaanvraag op [e-mail beveiligd].

Een verbinding maken

De connector ondersteunt de volgende verificatietypen:
standaard Parameters voor het maken van verbinding. Alle regio's Niet deelbaar

Verstek

Van toepassing: Alle regio's

Parameters voor het maken van verbinding.

Dit is geen deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt een andere gebruiker gevraagd om expliciet een nieuwe verbinding te maken.

Naam Typologie Description Verplicht
Client-id (clientId) touw Geef de client-id op uit uw servicereferenties. Klopt
Clientgeheim (clientSecret) beveiligde string Geef het clientgeheim op uit uw servicereferenties. Klopt
Hostnaam touw Geef de hostnaam op Klopt

Beperkingslimieten

Name Aanroepen Verlengingsperiode
API-aanroepen per verbinding 100 60 seconden

Acties

Alle gebruikers ophalen

Deze aanvraag wordt gebruikt om alle gebruikers op te halen. Raadpleeg Github-documenten voor meer informatie.
Alle query's ophalen

Deze aanvraag retourneert alle query's met daarin de definitie. Zie Github-documenten voor meer informatie.
Asset asynchroon publiceren

Retourneert context-id voor asset die wordt gepubliceerd. Gebruiken met de publicatiestatus ophalen. Zie GitHub-documenten voor meer informatie.
Downloaden (Blob)

Deze aanvraag wordt gebruikt om het bestand te downloaden via de invoerstroom van de download-URL. Zie GitHub-documenten voor meer informatie.
Gebruiker ophalen op id

Deze aanvraag wordt gebruikt om de metagegevens van een opgegeven gebruiker op te halen. Zie GitHub-documenten voor meer informatie.
Gebruiker ophalen op naam

Met deze aanvraag worden gebruikersmetagegevens geretourneerd die specifiek zijn voor de gebruikersnaam. Zie GitHub-documenten voor meer informatie.
Groepen voor een verzameling ophalen

Deze aanvraag retourneert een matrix met toepasselijke routeringsgroepen voor de opgegeven verzameling voor de opgegeven werkstroom en status. Raadpleeg de github-documentatie voor meer informatie.
Groeperen op naam ophalen

Met deze aanvraag wordt een groep geretourneerd die specifiek is voor groepsnaam.
Groepsleden ophalen

Deze aanvraag retourneert een lijst met gebruikers en alle metagegevens die specifiek zijn voor groeps-id. Zie GitHub-documenten voor meer informatie.
Hiermee maakt u een nieuw kenmerk

Hiermee maakt u een nieuw kenmerk en retourneert u de id, samen met een bericht dat het is gelukt. Zie GitHub-documenten voor meer informatie.
Hiermee maakt u een nieuw lijstkenmerk

Hiermee maakt u een nieuw kenmerk en retourneert u de id nadat het kenmerkbericht is gemaakt. Raadpleeg de github-documentatie voor meer informatie.
Inchecken en bijwerken initiëren

De aanvraag wordt ingecheckt en werkt een al bestaande asset bij in QPPNG. Asset moet vooraf worden uitgecheckt. Gebruik de actie Voor uitchecken. Raadpleeg de github-documentatie voor meer informatie.
Informatie over het downloaden van assets ophalen

De aanvraag retourneert informatie over het downloaden van assets die samen met de actie Blob downloaden kunnen worden gebruikt om de assetstroom te downloaden. Raadpleeg de github-documentatie voor meer informatie.
Informatie over inhoudstypen ophalen op naam

Deze aanvraag wordt gebruikt om informatie over het inhoudstype op te halen op basis van de naam van het inhoudstype. Zie Github Docs voor meer informatie.
Is gebruiker een groepslid

Deze aanvraag retourneert waar of onwaar dat een gebruiker lid is van een groep die specifiek is voor de gebruikers-id.
Kassa

Markeert de asset met de opgegeven assetId als Uitgecheckt. Raadpleeg de Github-documenten voor meer informatie.
Kenmerken ophalen op naam

Retourneert alle bestaande kenmerken met metagegevens in QPPNG Server voor opgegeven namen. Zie GitHub-documenten voor meer informatie.
Kenmerktoewijzing voor inhoudstype bijwerken

Kenmerktoewijzing van inhoudstypen en onderliggende items bijwerken met een opgegeven kenmerktoewijzing in de aanvraagbody. Zie GitHub-documenten voor meer informatie.
Kenmerkwaarden instellen

Stel kenmerkwaarden in voor het QPP-platform. Raadpleeg de Github-documentatie voor meer informatie.
Kenmerkwaarden ophalen uit id's

Kenmerkwaarden ophalen voor door komma's gescheiden id's. Raadpleeg de Github-documentatie voor meer informatie.
Metagegevens van assets ophalen

Assetgegevens ophalen voor de opgegeven asset-id. Raadpleeg de Github-documentatie voor meer informatie.
Nieuwe check-in initiëren

Met de aanvraag wordt een lokaal bestand ingecheckt, zoals opgegeven matrix met Qpp-kenmerkwaarden, zoals de naam, verzameling, extensie, enzovoort om een asset in te checken bij QPPNG. Raadpleeg de github-documentatie voor meer informatie.
Onderliggende activarelaties ophalen

Onderliggende activarelaties ophalen voor een bovenliggende asset-id. Zie Github-documenten voor meer informatie.
Publicatiestatus ophalen

Publicatiestatus ophalen voor een bepaalde asset. Raadpleeg de Github-documenten voor meer informatie.
Query maken

Maak een query met definitie en details in de aanvraagbody. Raadpleeg GitHub-documenten voor meer informatie.
Relaties tussen bovenliggende activa ophalen

Met deze aanvraag wordt de lijst met relaties voor een bovenliggende assetrelatie geretourneerd. Zie GitHub-documenten voor meer informatie.
Resultaten van gepagineerde query's ophalen met filters

Deze aanvraag retourneert gepagineerd query-element en details van een query die is opgeslagen in het systeem met een specifiek filter in de query. Raadpleeg de github-documentatie voor meer informatie.
Token ophalen volgens toekenningstype

Met deze aanvraag wordt het token opgehaald voor de opgegeven gebruikersnaam en het opgegeven wachtwoord voor QPPNG. Zie GitHub-documenten voor meer informatie.
Uploaden (blob)

Deze aanvraag wordt gebruikt om het bestand te uploaden per invoerstroom. Zie GitHub-documenten voor meer informatie.
Waarden voor kenmerken ophalen op naam

Kenmerkwaarden ophalen voor door komma's gescheiden namen. Zie GitHub-documenten voor meer informatie.
Webhook verwijderen

Hiermee verwijdert u een al bestaande webhook voor een bepaalde gebeurtenis en wijzigt u het type. Raadpleeg de github-documentatie voor meer informatie.
Werkstroom ophalen op naam

Deze aanvraag retourneert alle metagegevens van een opgegeven werkstroom op naam. Zie Github-documenten voor meer informatie.

Alle gebruikers ophalen

Bewerkings-id:
GetAllUsers

Deze aanvraag wordt gebruikt om alle gebruikers op te halen. Raadpleeg Github-documenten voor meer informatie.

Parameters

Name Sleutel Vereist Type Description
Imitatiegebruiker
 user_name True string

Gebruikersnaam voor de QPPNG-gebruiker, die moet worden geïmiteerd.

Retouren

Antwoordelement voor het weergeven van gebruikers.

Antwoordgebruiker voor lijst
ListResponseUser

Alle query's ophalen

Bewerkings-id:
GetAllQueries

Deze aanvraag retourneert alle query's met daarin de definitie. Zie Github-documenten voor meer informatie.

Parameters

Name Sleutel Vereist Type Description
Imitatiegebruiker
 user_name True string

Gebruikersnaam voor de QPPNG-gebruiker, die moet worden geïmiteerd.

Retouren

response
array of QueryDefinition

Asset asynchroon publiceren

Bewerkings-id:
PublishAssetAsync

Retourneert context-id voor asset die wordt gepubliceerd. Gebruiken met de publicatiestatus ophalen. Zie GitHub-documenten voor meer informatie.

Parameters

Name Sleutel Vereist Type Description
Imitatiegebruiker
 user_name True string

Gebruikersnaam voor de QPPNG-gebruiker, die moet worden geïmiteerd.
Asset-id
 assetId True string

Variabele assetId moet verwijzen naar de asset van de QPP-server.
Publicatiekanaal-id
 publishingChannelId True string

variable channelId moet verwijzen naar de id van het kanaal dat moet worden gebruikt.

Retouren

Context-id voor asset die wordt gepubliceerd. Gebruik deze functie om de publicatiestatus te controleren.

Context-id
string

Downloaden (Blob)

Bewerkings-id:
DownloadBlob

Deze aanvraag wordt gebruikt om het bestand te downloaden via de invoerstroom van de download-URL. Zie GitHub-documenten voor meer informatie.

Parameters

Name Sleutel Vereist Type Description
Verificatietoken
 authTokenforHeader True string

Verificatietoken dat hier afzonderlijk is vereist. De actie TokenFromAuthWrapper kan hier worden gebruikt om het token op te halen.
Bestands-id
 fileIdentifier True string

Bestands-id verwijst naar het type bestand.
Context-id
 contextId True string

Context-id verwijst naar de resourcegegevens.

Retouren

Name Pad Type Description
Inhoudstype
 $content-type string

Het inhoudstype van het document, bijvoorbeeld toepassing/pdf.
Content
 $content byte

De inhoud van het document in Base64-codering.

Gebruiker ophalen op id

Bewerkings-id:
GetUser

Deze aanvraag wordt gebruikt om de metagegevens van een opgegeven gebruiker op te halen. Zie GitHub-documenten voor meer informatie.

Parameters

Name Sleutel Vereist Type Description
Imitatiegebruiker
 user_name True string

Gebruikersnaam voor de QPPNG-gebruiker, die moet worden geïmiteerd.
QPPNG-gebruikers-id
 userId True integer

Id voor de QPPNG-gebruiker.

Retouren

Body
User

Gebruiker ophalen op naam

Bewerkings-id:
GetUserByName

Met deze aanvraag worden gebruikersmetagegevens geretourneerd die specifiek zijn voor de gebruikersnaam. Zie GitHub-documenten voor meer informatie.

Parameters

Name Sleutel Vereist Type Description
Imitatiegebruiker
 user_name True string

Gebruikersnaam voor de QPPNG-gebruiker, die moet worden geïmiteerd.
Gebruikersnaam voor QPPNG-gebruiker
 userName True string

Dit verwijst naar de gebruikersnaam voor de QPPNG-gebruiker.

Retouren

Body
User

Groepen voor een verzameling ophalen

Bewerkings-id:
GetCollectionGroups

Deze aanvraag retourneert een matrix met toepasselijke routeringsgroepen voor de opgegeven verzameling voor de opgegeven werkstroom en status. Raadpleeg de github-documentatie voor meer informatie.

Parameters

Name Sleutel Vereist Type Description
Imitatiegebruiker
 user_name True string

Gebruikersnaam voor de QPPNG-gebruiker, die moet worden geïmiteerd.
Id voor QPPNG-verzameling
 collectionId True integer

Variable collectionId moet verwijzen naar de QPPNG-verzamelings-id.

Retouren

Body
ListResponseCollectionGroup

Groeperen op naam ophalen

Bewerkings-id:
GetGroupByName

Met deze aanvraag wordt een groep geretourneerd die specifiek is voor groepsnaam.

Parameters

Name Sleutel Vereist Type Description
Imitatiegebruiker
 user_name True string

Gebruikersnaam voor de QPPNG-gebruiker, die moet worden geïmiteerd.
Groepsnaam
 groupName True string

Variabele groupName moet verwijzen naar de naam van de QPP Server-groep.

Retouren

Body
Group

Groepsleden ophalen

Bewerkings-id:
GetGroupMembers

Deze aanvraag retourneert een lijst met gebruikers en alle metagegevens die specifiek zijn voor groeps-id. Zie GitHub-documenten voor meer informatie.

Parameters

Name Sleutel Vereist Type Description
Imitatiegebruiker
 user_name True string

Gebruikersnaam voor de QPPNG-gebruiker, die moet worden geïmiteerd.
Groeps-id
 groupId True integer

De groeps-id moet verwijzen naar de QPPNG-groep.

Retouren

response
array of User

Hiermee maakt u een nieuw kenmerk

Bewerkings-id:
CreateAttribute

Hiermee maakt u een nieuw kenmerk en retourneert u de id, samen met een bericht dat het is gelukt. Zie GitHub-documenten voor meer informatie.

Parameters

Name Sleutel Vereist Type Description
Imitatiegebruiker
 user_name True string

Gebruikersnaam voor de QPPNG-gebruiker, die moet worden geïmiteerd.
Naam
 name True string

Naam van het kenmerk.
Type kenmerk
 valueType True integer

Type kenmerk.

Retouren

Details van een kenmerk dat is gekoppeld aan een entiteit.

Attribute
CreateAttributeSchema

Hiermee maakt u een nieuw lijstkenmerk

Bewerkings-id:
CreateListAttribute

Hiermee maakt u een nieuw kenmerk en retourneert u de id nadat het kenmerkbericht is gemaakt. Raadpleeg de github-documentatie voor meer informatie.

Parameters

Name Sleutel Vereist Type Description
Imitatiegebruiker
 user_name True string

Gebruikersnaam voor de QPPNG-gebruiker, die moet worden geïmiteerd.
Aantal domeinen dat moet worden weergegeven
 _skiptoken True integer

Aantal domeinen dat moet worden overgeslagen uit de vervolgkeuzelijst Domein-id.
Naam
 name True string

Naam van het kenmerk.
Type kenmerk
 valueType True integer

Het type kenmerk moet een lijst zijn voor het lijsttype.
Meerdere waarden
 multiValued boolean

Geeft aan of het kenmerk meerdere waarden kan bevatten.
Beperkte toegang
 limitedAccess boolean

Alleen van toepassing op lijsttype (Geeft aan of het kenmerk beperkte toegang heeft om hiervoor rollen te configureren).
Domein-id
 domainId integer

Domein-id die is gekoppeld aan de bestaande lijst met gegevensbronnen/domeinen. Gebruik het token voor overslaan om 20 items in de vervolgkeuzelijst te doorlopen.

Retouren

Details van een kenmerk dat is gekoppeld aan een entiteit.

Attribute
CreateAttributeSchema

Inchecken en bijwerken initiëren

Bewerkings-id:
InitCheckin

De aanvraag wordt ingecheckt en werkt een al bestaande asset bij in QPPNG. Asset moet vooraf worden uitgecheckt. Gebruik de actie Voor uitchecken. Raadpleeg de github-documentatie voor meer informatie.

Parameters

Name Sleutel Vereist Type Description
Imitatiegebruiker
 user_name True string

Gebruikersnaam voor de QPPNG-gebruiker, die moet worden geïmiteerd.
Secundaire versie maken
 createMinorVersion True boolean

Variable createMinorVersion moet verwijzen naar waar of onwaar voor het maken van een versie voor controle.
Asset-id
 assetId integer

Asset-id voor de asset die moet worden ingecheckt.

Retouren

Body
AssetUploadInfo

Informatie over het downloaden van assets ophalen

Bewerkings-id:
GetAssetDownloadInfo

De aanvraag retourneert informatie over het downloaden van assets die samen met de actie Blob downloaden kunnen worden gebruikt om de assetstroom te downloaden. Raadpleeg de github-documentatie voor meer informatie.

Parameters

Name Sleutel Vereist Type Description
Imitatiegebruiker
 user_name True string

Gebruikersnaam voor de QPPNG-gebruiker, die moet worden geïmiteerd.
Asset-id
 assetId True integer

AssetId moet verwijzen naar de asset van de QPP-server.
Kleine versie
 minorVersion integer

Secundaire versie moet verwijzen naar de secundaire versie van de vereiste asset. Geef 0 op om metagegevens van de nieuwste versie op te halen.
Hoofdversie
 majorVersion integer

Primaire versie moet verwijzen naar de primaire versie van de vereiste asset. Geef null op om metagegevens van de nieuwste versie op te halen.

Retouren

Body
AssetDownloadInfo

Informatie over inhoudstypen ophalen op naam

Bewerkings-id:
GetContentTypesInfoByName

Deze aanvraag wordt gebruikt om informatie over het inhoudstype op te halen op basis van de naam van het inhoudstype. Zie Github Docs voor meer informatie.

Parameters

Name Sleutel Vereist Type Description
Imitatiegebruiker
 user_name True string

Gebruikersnaam voor de QPPNG-gebruiker, die moet worden geïmiteerd.
Naam van inhoudstype
 contentTypeName True string

Naam voor het inhoudstype.

Retouren

response
array of ContentTypeInfo

Is gebruiker een groepslid

Bewerkings-id:
IsGroupMember

Deze aanvraag retourneert waar of onwaar dat een gebruiker lid is van een groep die specifiek is voor de gebruikers-id.

Parameters

Name Sleutel Vereist Type Description
Imitatiegebruiker
 user_name True string

Gebruikersnaam voor de QPPNG-gebruiker, die moet worden geïmiteerd.
Id van QPPNG-gebruiker
 userId True integer

Id van QPPNG-gebruiker.
Id voor groep in QPPNG
 groupId True integer

Id voor groep in QPPNG.

Kassa

Bewerkings-id:
CheckOut

Markeert de asset met de opgegeven assetId als Uitgecheckt. Raadpleeg de Github-documenten voor meer informatie.

Parameters

Name Sleutel Vereist Type Description
Imitatiegebruiker
 user_name True string

Gebruikersnaam voor de QPPNG-gebruiker, die moet worden geïmiteerd.
Asset-id
 assetId True integer

Variabele assetId moet verwijzen naar de asset van de QPP-server.
Kenmerk-id
 attributeId integer

Id van het kenmerk.
Typologie
 type integer

Type van het kenmerk.
Waarde
 attributeValue object

Waarde.

Retouren

Body
Asset

Kenmerken ophalen op naam

Bewerkings-id:
GetAttributesByName

Retourneert alle bestaande kenmerken met metagegevens in QPPNG Server voor opgegeven namen. Zie GitHub-documenten voor meer informatie.

Parameters

Name Sleutel Vereist Type Description
Imitatiegebruiker
 user_name True string

Gebruikersnaam voor de QPPNG-gebruiker, die moet worden geïmiteerd.
Kenmerknamen
 attributeNames True string

Kenmerknaam moet verwijzen naar de kenmerknaam van de QPP-server (door komma's gescheiden, indien meerdere).

Retouren

response
array of Attribute

Kenmerktoewijzing voor inhoudstype bijwerken

Bewerkings-id:
AddAttributeToContentTypes

Kenmerktoewijzing van inhoudstypen en onderliggende items bijwerken met een opgegeven kenmerktoewijzing in de aanvraagbody. Zie GitHub-documenten voor meer informatie.

Parameters

Name Sleutel Vereist Type Description
Imitatiegebruiker
 user_name True string

Gebruikersnaam voor de QPPNG-gebruiker, die moet worden geïmiteerd.
Kenmerk-id
 attributeId True integer

Kenmerk-id's die moeten worden toegewezen.
Id's van inhoudstype
 contentTypeIds True string

Inhoudstypen waaraan deze kenmerken moeten worden toegewezen.

Kenmerkwaarden instellen

Bewerkings-id:
SetAttributeValues

Stel kenmerkwaarden in voor het QPP-platform. Raadpleeg de Github-documentatie voor meer informatie.

Parameters

Name Sleutel Vereist Type Description
Imitatiegebruiker
 user_name True string

Gebruikersnaam voor de QPPNG-gebruiker, die moet worden geïmiteerd.
Asset-id
 assetId True string

QPP-platformasset-id.
Kenmerk-id
 attributeId integer

Id van het kenmerk.
Typologie
 type integer

Type van het kenmerk.
Meerdere waarden
 multiValued boolean

Geeft aan of het kenmerk meerdere waarden heeft.
Waarde
 attributeValue object

Waarde.

Kenmerkwaarden ophalen uit id's

Bewerkings-id:
GetAttributeValues

Kenmerkwaarden ophalen voor door komma's gescheiden id's. Raadpleeg de Github-documentatie voor meer informatie.

Parameters

Name Sleutel Vereist Type Description
Imitatiegebruiker
 user_name True string

Gebruikersnaam voor de QPPNG-gebruiker, die moet worden geïmiteerd.
Asset-id
 assetId True integer

Id voor de asset op QPPNG Platform waarop wordt verwezen.
QPPNG-kenmerk-id's
 attributeIds True string

Kenmerk-id's moeten verwijzen naar de kenmerk-id's van de QPP-server.

Retouren

response
array of AttributeValue

Metagegevens van assets ophalen

Bewerkings-id:
GetAsset

Assetgegevens ophalen voor de opgegeven asset-id. Raadpleeg de Github-documentatie voor meer informatie.

Parameters

Name Sleutel Vereist Type Description
Imitatiegebruiker
 user_name True string

Gebruikersnaam voor de QPPNG-gebruiker, die moet worden geïmiteerd.
Asset-id
 assetId True integer

Id voor de asset op QPPNG Platform waarop wordt verwezen.

Retouren

Body
Asset

Nieuwe check-in initiëren

Bewerkings-id:
InitNewCheckin

Met de aanvraag wordt een lokaal bestand ingecheckt, zoals opgegeven matrix met Qpp-kenmerkwaarden, zoals de naam, verzameling, extensie, enzovoort om een asset in te checken bij QPPNG. Raadpleeg de github-documentatie voor meer informatie.

Parameters

Name Sleutel Vereist Type Description
Imitatiegebruiker
 user_name True string

Gebruikersnaam voor de QPPNG-gebruiker, die moet worden geïmiteerd.
Aantal kenmerken/domeinen om over te slaan
 _skiptoken True integer

Aantal kenmerken/domeinen om over te slaan.
Secundaire versie maken
 createMinorVersion True boolean

Variable createMinorVersion moet verwijzen naar waar of onwaar voor het maken van een versie voor controle.
Kenmerk-id
 attributeId integer

Kenmerk-id.
Type kenmerk
 type integer

Type kenmerk.
Meerdere waarden
 multiValued boolean

Geeft aan of het kenmerk meerdere waarden heeft.
Identiteitsbewijs
 id integer

Id die overeenkomt met de naam, zoals voor thuisverzameling-id 1, wordt gebruikt.
Naam
 name string

Naam voor kenmerk, zoals de naam van het inhoudstype of de naam van de verzameling.
Domein-id
 domainId integer

Domein-id die is gekoppeld aan de bestaande lijst met gegevensbronnen/domeinen. De id voor het domein.
Waarde
 value string

De waarde van het kenmerk dat moet worden ingesteld.
Domeinwaarde-id
 id integer

Id voor de domeinwaarde zelf, bijvoorbeeld id voor een domeinwaarde voor een gebruiker, is de gebruikers-id, omdat de lijst Met gebruikers het domein is.

Retouren

Body
AssetUploadInfo

Onderliggende activarelaties ophalen

Bewerkings-id:
GetChildAssetRelations

Onderliggende activarelaties ophalen voor een bovenliggende asset-id. Zie Github-documenten voor meer informatie.

Parameters

Name Sleutel Vereist Type Description
Imitatiegebruiker
 user_name True string

Gebruikersnaam voor de QPPNG-gebruiker, die moet worden geïmiteerd.
Bovenliggende asset-id
 parentAssetId True integer

Bovenliggende asset-id moet verwijzen naar de bovenliggende asset van de QPP-server.

Retouren

response
array of AssetRelation

Publicatiestatus ophalen

Bewerkings-id:
GetPublishingStatus

Publicatiestatus ophalen voor een bepaalde asset. Raadpleeg de Github-documenten voor meer informatie.

Parameters

Name Sleutel Vereist Type Description
Imitatiegebruiker
 user_name True string

Gebruikersnaam voor de QPPNG-gebruiker, die moet worden geïmiteerd.
Context-id
 contextId True string

Context-id

Retouren

Body
PublishingStatusInfo

Query maken

Bewerkings-id:
CreateQuery

Maak een query met definitie en details in de aanvraagbody. Raadpleeg GitHub-documenten voor meer informatie.

Parameters

Name Sleutel Vereist Type Description
Imitatiegebruiker
 user_name True string

Gebruikersnaam voor de QPPNG-gebruiker, die moet worden geïmiteerd.
Aantal kenmerken dat moet worden overgeslagen
 _skiptoken True integer

Aantal kenmerken dat moet worden overgeslagen in de vervolgkeuzelijst met kenmerken.
Querynaam
 queryName True string

Naam van de query.
Geparametriseerde
 parameterized boolean

Geeft aan of de query is geparameteriseerd.
Kenmerk-id
 attributeId integer

Kenmerk-id voor zoeken.
Type kenmerk
 type integer

Type van het kenmerk dat is geselecteerd voor voorwaarde.
Vergelijkingsoperator
 comparisonOperator integer

Vergelijkingsoperator voor de voorwaarde.
Ontkend
 negated boolean

Geeft aan of de voorwaarde is ontkend.
Te zoeken waarde tegen
 value string

waarde voor zoeken op basis van.
Logische operator
 logicalOperator integer

Logische en OR-operator voor de voorwaarde.
Kolom-id
 columnId True integer

Id van de weergavekolom.
Breedte
 width True integer

Breedte van de weergavekolom.
Kenmerkkolom
 attributeColumn True boolean

Geeft aan of de kolom een kenmerkkolom is.
Beeldmodus
 displayMode True integer

Instelling voor weergavemodus.

Retouren

Zojuist gemaakte query-id.

Zojuist gemaakte query-id
integer

Relaties tussen bovenliggende activa ophalen

Bewerkings-id:
GetParentAssetRelations

Met deze aanvraag wordt de lijst met relaties voor een bovenliggende assetrelatie geretourneerd. Zie GitHub-documenten voor meer informatie.

Parameters

Name Sleutel Vereist Type Description
Imitatiegebruiker
 user_name True string

Gebruikersnaam voor de QPPNG-gebruiker, die moet worden geïmiteerd.
Onderliggende asset-id
 childAssetId True integer

Variabele childAssetId moet verwijzen naar de onderliggende asset van de QPP-server die relatie heeft met bovenliggende en voor wie bovenliggende relaties moeten worden ontdekt.

Retouren

response
array of AssetRelation

Resultaten van gepagineerde query's ophalen met filters

Bewerkings-id:
GetPaginatedQueryResultsWithFilters

Deze aanvraag retourneert gepagineerd query-element en details van een query die is opgeslagen in het systeem met een specifiek filter in de query. Raadpleeg de github-documentatie voor meer informatie.

Parameters

Name Sleutel Vereist Type Description
Imitatiegebruiker
 user_name True string

Gebruikersnaam voor de QPPNG-gebruiker, die moet worden geïmiteerd.
Bestaande QPPNG-query-id
 queryId True integer

Dit verwijst naar een bestaande QPPNG-query-id.
Query-id
 queryId integer

Unieke id van de query.
Querynaam
 queryName string

Naam van de query.
Eigenaar-id
 ownerId integer

Id van de eigenaar van de query.
Geparametriseerde
 parameterized boolean

Geeft aan of de query is geparameteriseerd.
Kolom-id
 columnId True integer

Id van de weergavekolom.
Breedte
 width True integer

Breedte van de weergavekolom.
Kenmerkkolom
 attributeColumn True boolean

Geeft aan of de kolom een kenmerkkolom is.
Kolom-id
 columnId integer

Id van de kolom voor sorteren.
Descending
 descending boolean

Geeft aan of de sorteervolgorde aflopend is.
Kenmerkkolom
 attributeColumn boolean

Geeft aan of de gesorteerde kolom een kenmerkkolom is.
Beeldmodus
 displayMode True integer

Instelling voor weergavemodus.
Kenmerk-id
 attributeId integer

Id van het kenmerk voor groepering.
Descending
 descending boolean

Geeft aan of de groepering in aflopende volgorde is.
Modus Verkennen
 exploreMode integer

De modusinstelling verkennen.
Logische operator
 logicalOperator True integer

Logische operator voor de voorwaarde.
Vergelijkingsoperator
 comparisonOperator True integer

Vergelijkingsoperator voor de voorwaarde.
Ontkend
 negated True boolean

Geeft aan of de voorwaarde is ontkend.
Geparametriseerde
 parameterized True boolean

Geeft aan of de voorwaarde is geparameteriseerd.
Typologie
 type True integer

Type van de voorwaarde.
Kenmerk-id
 attributeId True integer

Kenmerk-id voor zoeken.
Te zoeken waarde tegen
 value True string

waarde voor zoeken op basis van.
Inhoudstype
 contentType integer

Id van het inhoudstype voor de querycontext.
Collections
 collections array of integer

Lijst met verzamelings-id's voor de querycontext.
Recursief
 recursive boolean

Geeft aan of de querycontext recursief is.
Alle versies opnemen
 includeAllVersions boolean

Geeft aan of alle versies zijn opgenomen in de querycontext.
Vertakkingen opnemen
 includeBranches boolean

Geeft aan of vertakkingen zijn opgenomen in de querycontext.
queryResults
 queryResults

Retouren

Antwoordelement voor het weergeven van queryresultaten.

Resultaatelement antwoordquery weergeven
ListResponseQueryResultElement

Token ophalen volgens toekenningstype

Bewerkings-id:
TokenFromAuthWrapper

Met deze aanvraag wordt het token opgehaald voor de opgegeven gebruikersnaam en het opgegeven wachtwoord voor QPPNG. Zie GitHub-documenten voor meer informatie.

Parameters

Name Sleutel Vereist Type Description
Gebruikersnaam
 username True string

Voer de gebruikersnaam van uw QPPNG-omgeving in waarvoor u het token moet ophalen.
Wachtwoord
 password True string

Voer het wachtwoord voor de gebruikersnaam in.

Retouren

Name Pad Type Description
Toegangstoken
 access_token string

Het token dat toegang verleent tot de beveiligde resources.
Verloopt in
 expires_in integer

De duur (in seconden) waarvoor het toegangstoken geldig is.
Vernieuwen verloopt in
 refresh_expires_in integer

De duur (in seconden) waarvoor het vernieuwingstoken geldig is.
Tokentype
 token_type string

Het type token (bijvoorbeeld bearer).
Niet vóór beleid
 not-before-policy integer

De tijd (in seconden) waarvoor het token niet kan worden gebruikt.
Scope
 scope string

Het bereik van het toegangstoken.

Uploaden (blob)

Bewerkings-id:
UploadBlob

Deze aanvraag wordt gebruikt om het bestand te uploaden per invoerstroom. Zie GitHub-documenten voor meer informatie.

Parameters

Name Sleutel Vereist Type Description
Imitatiegebruiker
 user_name True string

Gebruikersnaam voor de QPPNG-gebruiker, die moet worden geïmiteerd.
Bestands-id
 fileIdentifier True string

De bestands-id verwijst naar het type bestand.
context-id
 contextId True string

Context-id verwijst naar resourcegegevens.
Invoerstroomresource
 InputStreamResource True

Invoerstroom voor resource vereist binaire invoer.

Waarden voor kenmerken ophalen op naam

Bewerkings-id:
GetAttributeValuesByName

Kenmerkwaarden ophalen voor door komma's gescheiden namen. Zie GitHub-documenten voor meer informatie.

Parameters

Name Sleutel Vereist Type Description
Imitatiegebruiker
 user_name True string

Gebruikersnaam voor de QPPNG-gebruiker, die moet worden geïmiteerd.
Asset-id
 assetId True integer

AssetId moet verwijzen naar de asset van de QPP-server.
Kenmerknamen
 attributes True string

De tekenreeks kenmerknamen moet verwijzen naar de kenmerknamen van de QPPNG-server, gescheiden door komma's als er meerdere zijn.

Retouren

response
array of AttributeValue

Webhook verwijderen

Bewerkings-id:
Delete-webhook-trigger

Hiermee verwijdert u een al bestaande webhook voor een bepaalde gebeurtenis en wijzigt u het type. Raadpleeg de github-documentatie voor meer informatie.

Parameters

Name Sleutel Vereist Type Description
Imitatiegebruiker
 user_name True string

Gebruikersnaam voor de QPPNG-gebruiker, die moet worden geïmiteerd.
Naam of id
 nameOrId True string

Naam of id voor de bestaande webhook in de omgeving.

Retouren

Body
WebhookSuccessResponse

Werkstroom ophalen op naam

Bewerkings-id:
GetWorkflowByName

Deze aanvraag retourneert alle metagegevens van een opgegeven werkstroom op naam. Zie Github-documenten voor meer informatie.

Parameters

Name Sleutel Vereist Type Description
Imitatiegebruiker
 user_name True string

Gebruikersnaam voor de QPPNG-gebruiker, die moet worden geïmiteerd.
Werkstroomnaam
 workflowName True string

Werkstroomnaam waarvoor metagegevens moeten worden opgehaald.

Retouren

Details van een werkstroom.

Werkproces
Workflow

Triggers

Triggers wanneer een gebeurtenis plaatsvindt voor een al geregistreerde webhook

Registreert een webhook voor een bepaalde gebeurtenis en wijzigingstype. Zie GitHub-documenten voor meer informatie.

Triggers wanneer een gebeurtenis plaatsvindt voor een al geregistreerde webhook

Bewerkings-id:
Webhook-trigger

Registreert een webhook voor een bepaalde gebeurtenis en wijzigingstype. Zie GitHub-documenten voor meer informatie.

Parameters

Name Sleutel Vereist Type Description
Imitatiegebruiker
 user_name True string

Gebruikersnaam voor de QPPNG-gebruiker, die moet worden geïmiteerd.
Webhooknaam
 name True string

Unieke naam voor het beschrijven van het doel en de betekenis van webhooks.
Webhooktype
 type True string

Beschrijf het webhooktype waarnaar wordt geluisterd, zoals Gebeurtenis, enzovoort.
Object
 object True string

Beschrijft het type object dat moet worden geluisterd naar Like ASSET, enzovoort.
Type wijzigen
 changeType True array of string
Filtercriteria
 filter string

Filtercriteria kunnen worden gedefinieerd om het type gebeurtenis te filteren.
Gebruikte versie
 version True string

Versie die wordt gebruikt volgens de webhookservice in het QPPNG-platform.

Retouren

Name Pad Type Description
Gebruikte versie
 version string

Versie die wordt gebruikt volgens de webhookservice in het QPPNG-platform.
Webhooktype
 webhookInfo.type string

Beschrijf het webhooktype waarnaar wordt geluisterd, zoals Gebeurtenis, enzovoort.
Webhook-id
 webhookInfo.id string

Webhook-id.
Webhooknaam
 webhookInfo.name string

Unieke naam om het doel en de betekenis van webhooks te beschrijven.
AuxData
 webhookInfo.auxData string

AuxData indien aanwezig tijdens het registreren.

Definities

PublishingOutputDownloadInfo

Definieert de downloadgegevens van de publicatie-uitvoer.

Name Pad Type Description
attributesMap
 attributesMap object
Direct downloaden
 directDownload boolean

Hiermee wordt gedefinieerd of Direct Download is toegestaan.
Url downloaden
 downloadUrl string

Biedt een download-URL die kan worden gebruikt met de actie Blob downloaden om te downloaden vanaf de bloblocatie.

WebhookSuccessResponse

Name Pad Type Description
ID-kaart
 id string

Hiermee definieert u de id voor het geslaagde antwoord van de webhook.
Toestand
 status string

Hiermee definieert u de status voor het webhook-antwoord.
Message
 message string

Hiermee definieert u het bericht voor het succesantwoord van de webhook.
Versie
 version string

Hiermee definieert u de versie voor het antwoord op het slagen van de webhook.

AttributeValue

Name Pad Type Description
Kenmerk-id
 attributeId integer

Hiermee definieert u de kenmerk-id voor het QPPNG-kenmerk.
Kenmerknaam
 attributeName string

Hiermee definieert u de kenmerknaam voor het QPPNG-kenmerk.
Typologie
 type integer

Hiermee definieert u het type voor het QPPNG-kenmerk.
Meerwaardig
 multiValued boolean

Definieert of het kenmerk meerdere waarden heeft.
Waarde
 attributeValue Value

Waarde.

AssetUploadInfo

Name Pad Type Description
Context-id
 contextId string

Hiermee definieert u de context-id voor het uploaden van assets.
URL uploaden
 uploadUrl string

Hiermee definieert u de upload-URL voor de asset.

Activa

Name Pad Type Description
Asset-ID
 assetId integer

Hiermee definieert u de asset-id voor de QPPNG-asset.
assetVersion
 assetVersion AssetVersion
attribuutWaarden
 attributeValues array of AttributeValue

User

Name Pad Type Description
ID-kaart
 id integer

Gebruikers-id.
Naam
 name string

De naam van de gebruiker.
Domein-id
 domainId integer

Domein-id van de gebruiker.
Bronreferentie
 sourceReference string

Bronreferentie voor de gebruiker.
Onderliggende domeinwaarden
 childDomainValues array of DomainValue

Matrix van onderliggende domeinwaarden.
Heeft kinderen
 hasChildren boolean

Geeft aan of de gebruiker onderliggende items heeft.
Wordt verwijderd
 isDeleted boolean

Geeft aan of de gebruiker is verwijderd.
Is gebruiker
 user boolean

Geeft aan of de entiteit een gebruiker is.
LDAP-profiel-id
 ldapProfileId integer

LDAP-profiel-id voor de gebruiker.
Standaardgebruikersklasse-id
 defaultUserClassId integer

Standaardgebruikersklasse-id.
E-mailadres
 emailAddress string

Het e-mailadres van de gebruiker.
Wordt verwijderd
 deleted boolean

Geeft aan of de gebruiker is verwijderd.
DN-naam van LDAP
 ldapDistinguishedName string

Ldap-DN-naam voor de gebruiker.
Systeemeigen beheerder
 nativeTrustee boolean

Geeft aan of de gebruiker een systeemeigen beheerder is.
Voornaam
 firstName string

De voornaam van de gebruiker.
Achternaam
 lastName string

Achternaam van gebruiker.
Telefoonnummer
 phoneNumber string

Telefoonnummer van gebruiker.
Is ingeschakeld
 enabled boolean

Geeft aan of de gebruiker is ingeschakeld.
Extern geverifieerd
 externallyAuthenticated boolean

Geeft aan of de gebruiker extern is geverifieerd.
Naam voor verificatie
 nameForAuthentication string

Naam voor verificatie.

ListResponseCollectionGroup

Name Pad Type Description
Aantal
 get_count integer

Aantal items in het antwoord.
Volgende koppeling
 get_nextLink string

URL voor de volgende set resultaten.
Waarde
 get_value array of CollectionGroup

Matrix van verzamelingsgroepen.

Waarde

Waarde.

Name Pad Type Description
Waarde
 object

Waarde.

AssetVersion

Name Pad Type Description
Hoofdversie
 majorVersion integer

Primaire versie van de asset.
Kleine versie
 minorVersion integer

Secundaire versie van de asset.
Vertakkings-id
 branchId integer

Versie-id van vertakking.
Systeemnaam
 systemName string

Systeemnaam voor assetversie.

DomainValue

Name Pad Type Description
ID-kaart
 id integer

Domeinwaarde-id.
Naam
 name string

Naam van de domeinwaarde.
Domein-id
 domainId integer

Domein-id van de domeinwaarde.
Bronreferentie
 sourceReference string

Bronreferentie van de domeinwaarde.
Onderliggende domeinwaarden
 childDomainValues string

Matrix van onderliggende domeinwaarden.
Heeft kinderen
 hasChildren boolean

Geeft aan of de domeinwaarde onderliggende items heeft.
Wordt verwijderd
 isDeleted boolean

Geeft aan of de domeinwaarde is verwijderd.

CollectionGroup

Name Pad Type Description
Groeps-id
 groupId integer

Id van de verzamelingsgroep.
groupInfo
 groupInfo GroupInfo
Id van gebruikersklasse overschreven
 overriddenUserClassId integer

Id van de overschreven gebruikersklasse.

GroupInfo

Name Pad Type Description
ID-kaart
 id integer

Groeps-id.
Naam
 name string

Naam van de groep.
Domein-id
 domainId integer

Domein-id van de groep.
Bronreferentie
 sourceReference string

Bronreferentie van de groep.
Onderliggende domeinwaarden
 childDomainValues array of DomainValue

Matrix van onderliggende domeinwaarden.
Heeft kinderen
 hasChildren boolean

Geeft aan of de groep onderliggende items heeft.
Wordt verwijderd
 isDeleted boolean

Geeft aan of de groep is verwijderd.
Is gebruiker
 user boolean

Geeft aan of de groep een gebruiker vertegenwoordigt.
LDAP-profiel-id
 ldapProfileId integer

LDAP-profiel-id.
Standaardgebruikersklasse-id
 defaultUserClassId integer

Id van de standaardgebruikersklasse.
E-mailadres
 emailAddress string

E-mailadres van de groep.
Verwijderd
 deleted boolean

Geeft aan of de groep is verwijderd.
DN-naam van LDAP
 ldapDistinguishedName string

Ldap-DN-naam van de groep.
Systeemeigen beheerder
 nativeTrustee boolean

Geeft aan of de groep een systeemeigen beheerder is.

AssetDownloadInfo

Name Pad Type Description
Context-id
 contextId string

Id van de context.
DOWNLOAD-URL
 downloadUrl string

URL voor het downloaden van de asset.

Werkproces

Details van een werkstroom.

Name Pad Type Description
ID-kaart
 id integer

Unieke id voor de werkstroom.
Naam
 name string

Naam van de werkstroom.
Domein-id
 domainId integer

Id van het domein dat is gekoppeld aan de werkstroom.
Bronreferentie
 sourceReference string

Verwijzing die is gekoppeld aan de bron van de werkstroom.
Onderliggende domeinwaarden
 childDomainValues array of DomainValue

Lijst met onderliggende domeinwaarden die zijn gekoppeld aan de werkstroom.
Heeft kinderen
 hasChildren boolean

Geeft aan of de werkstroom onderliggende elementen heeft.
Wordt verwijderd
 isDeleted boolean

Geeft aan of de werkstroom is gemarkeerd als verwijderd.
Statussen
 statuses array of Status

Lijst met statussen in de werkstroom.
Gemaakt door
 createdBy integer

Gebruikers-id van de maker van de werkstroom.
Aanmaakdatum
 created string

Datum waarop de werkstroom is gemaakt.
Laatst gewijzigd door
 lastModifiedBy integer

Gebruikers-id van de laatste wijzigingsfunctie van de werkstroom.
Datum laatst gewijzigd
 lastModified string

Datum waarop de werkstroom voor het laatst is gewijzigd.
Overgang van beperkte status
 constrainedStatusTransition boolean

Hiermee definieert u of statusovergang is beperkt.
Gebruikersklassen Statusroutering
 statusRoutingUserclasses array of StatusRoutingUserClasses

Lijst met gebruikersklassen voor statusroutering.
Statusovergangen
 statusTransitions array of StatusTransition

Lijst met statusovergangen.

Toestand

Vertegenwoordigt een status.

Name Pad Type Description
ID-kaart
 id integer

Unieke id voor de status.
Naam
 name string

Naam van de status.
Domein-id
 domainId integer

Domein-id voor de status.
Bronreferentie
 sourceReference string

Verwijzing naar de bron van de status.
Onderliggende domeinwaarden
 childDomainValues array of DomainValue

Matrix van onderliggende domeinwaarden.
Heeft kinderen
 hasChildren boolean

Geeft aan of de status onderliggende statussen heeft.
Wordt verwijderd
 isDeleted boolean

Geeft aan of de status is verwijderd.
Werkstroom-id
 workflowId integer

Id van de werkstroom die is gekoppeld aan de status.
Kleur rood
 colorRed integer

Rood onderdeel van de statuskleur.
Kleur groen
 colorGreen integer

Groen onderdeel van de statuskleur.
Kleur blauw
 colorBlue integer

Blauw onderdeel van de statuskleur.
Position
 position integer

Positie van de status.

StatusRoutingUserClasses

Toewijzing van status aan gebruikersklassen voor routering.

Name Pad Type Description
Status-id
 statusId integer

Id van de status voor routering.
Id's van gebruikersklassen routeren
 routingUserClassIds array of integer

Matrix van gebruikersklasse-id's voor routering.
Routering op basis van gebruikersklasse
 userClassBasedRouting boolean

Geeft aan of routering op basis van gebruikersklasse is ingeschakeld.

StatusTransition

Details van een statusovergang binnen een werkstroom.

Name Pad Type Description
Status-id
 statusId integer

Id van de statusovergang.
Status van initiëren van werkstroom
 workflowInitiatingStatus boolean

Geeft aan of de overgang wordt gestart door de werkstroom.
Volgende mogelijke status-id's
 nextPossibleStatusIds array of integer

Id's van de volgende mogelijke statussen na deze overgang.

AssetRelation

Details van een relatie tussen assets.

Name Pad Type Description
ID-kaart
 id integer

Unieke id van de assetrelatie.
Bovenliggende asset-id
 parentAssetId integer

Id van de bovenliggende asset in de relatie.
parentAssetVersion
 parentAssetVersion AssetVersion
Onderliggende asset-id
 childAssetId integer

Id van het onderliggende activum in de relatie.
childAssetVersion
 childAssetVersion AssetVersion
Relatietype-id
 relationTypeId integer

Id van het type relatie.
Relatiestatus
 relationState integer

Status van de relatie.
Vergrendeld naar onderliggende versie
 lockedToChildVersion boolean

Vlag die aangeeft of de relatie is vergrendeld voor de onderliggende versie.
Blokkeren naar huidige versie
 freezeToCurrentVersion boolean

Vlag die aangeeft of de relatie is geblokkeerd voor de huidige versie.
Relationele kenmerken
 relationAttributes array of AttributeValue

Kenmerken die zijn gekoppeld aan de relatie.

Attribute

Details van een kenmerk dat is gekoppeld aan een entiteit.

Name Pad Type Description
ID-kaart
 id integer

Unieke id van het kenmerk.
Naam
 name string

Naam van het kenmerk.
Waardetype
 valueType integer

Type waarde dat het kenmerk bevat.
Door de gebruiker gedefinieerd
 userDefined boolean

Geeft aan of het kenmerk door de gebruiker is gedefinieerd.
Query's uitvoeren
 queryable boolean

Geeft aan of het kenmerk kan worden opgevraagd.
Meerdere waarden
 multiValued boolean

Geeft aan of het kenmerk meerdere waarden kan bevatten.
Wijzigingsniveau
 modificationLevel integer

Niveau van wijziging van het kenmerk.
Aanmaakdatum
 created string

Datum waarop het kenmerk is gemaakt.
Datum laatst gewijzigd
 lastModified string

Datum waarop het kenmerk voor het laatst is gewijzigd.
Maker
 creator integer

Id van de gebruiker die het kenmerk heeft gemaakt.
Laatste wijziging
 lastModifier integer

Id van de gebruiker die het kenmerk het laatst heeft gewijzigd.
Weer te geven
 displayable boolean

Geeft aan of het kenmerk kan worden weergegeven.
Beperkte toegang
 limitedAccess boolean

Geeft aan of het kenmerk beperkte toegang heeft.
Beperkte toegang kan worden gewijzigd
 limitedAccessChangeable boolean

Geeft aan of de instelling voor beperkte toegang kan worden gewijzigd.
Beperkingen die kunnen worden gewijzigd
 constraintsChangeable boolean

Geeft aan of de beperkingen van het kenmerk kunnen worden gewijzigd.
Waardevoorkeuren kunnen worden gewijzigd
 valuePreferencesChangeable boolean

Geeft aan of de waardevoorkeuren kunnen worden gewijzigd.
Booleaanse waardevoorkeuren
 booleanValuePreferences BooleanValuePreferences

Voorkeuren voor booleaanse waarden.
Voorkeuren voor numerieke waarden
 numericValuePreferences NumericValuePreferences

Voorkeuren voor numerieke waarden.
Voorkeuren voor datumwaarden
 dateValuePreferences DateValuePreferences

Voorkeuren voor datumwaarden.
Voorkeuren voor datum/tijd-waarden
 dateTimeValuePreferences DateTimeValuePreferences

Voorkeuren voor Datum/tijd-waarden.
Voorkeuren voor tijdwaarde
 timeValuePreferences TimeValuePreferences

Voorkeuren voor tijdwaarden.
Voorkeuren voor metingswaarde
 measurementValuePreferences MeasurementValuePreferences

Voorkeuren voor meetwaarden.
Voorkeuren voor tekstwaarde
 textValuePreferences TextValuePreferences

Voorkeuren voor tekstwaarden.
Voorkeuren voor lijst met domeinwaarden
 domainValueListPreferences DomainValueListPreferences

Voorkeuren voor lijsten met domeinwaarden.
Voorkeuren voor domeinwaarde
 domainValuePreferences DomainValuePreferences

Voorkeuren voor domeinwaarden.

CreateAttributeSchema

Details van een kenmerk dat is gekoppeld aan een entiteit.

Name Pad Type Description
ID-kaart
 id integer

Unieke id van het kenmerk.
Naam
 name string

Naam van het kenmerk.
Waardetype
 valueType integer

Het type waarde dat het kenmerk 1 bevat voor het teksttype, enzovoort.
Door de gebruiker gedefinieerd
 userDefined boolean

Geeft aan of het kenmerk door de gebruiker is gedefinieerd.
Query's uitvoeren
 queryable boolean

Geeft aan of het kenmerk kan worden opgevraagd.
Meerdere waarden
 multiValued boolean

Geeft aan of het kenmerk meerdere waarden kan bevatten.
Wijzigingsniveau
 modificationLevel integer

Niveau van wijziging van het kenmerk.
Aanmaakdatum
 created string

Datum waarop het kenmerk is gemaakt.
Datum laatst gewijzigd
 lastModified string

Datum waarop het kenmerk voor het laatst is gewijzigd.
Maker
 creator integer

Id van de gebruiker die het kenmerk heeft gemaakt.
Laatste wijziging
 lastModifier integer

Id van de gebruiker die het kenmerk het laatst heeft gewijzigd.
Weer te geven
 displayable boolean

Geeft aan of het kenmerk kan worden weergegeven.
Beperkte toegang
 limitedAccess boolean

Geeft aan of het kenmerk beperkte toegang heeft.
Beperkte toegang kan worden gewijzigd
 limitedAccessChangeable boolean

Geeft aan of de instelling voor beperkte toegang kan worden gewijzigd.
Beperkingen die kunnen worden gewijzigd
 constraintsChangeable boolean

Geeft aan of de beperkingen van het kenmerk kunnen worden gewijzigd.
Waardevoorkeuren kunnen worden gewijzigd
 valuePreferencesChangeable boolean

Geeft aan of de waardevoorkeuren kunnen worden gewijzigd.
Booleaanse waardevoorkeuren
 booleanValuePreferences BooleanValuePreferences

Voorkeuren voor booleaanse waarden.
Voorkeuren voor numerieke waarden
 numericValuePreferences NumericValuePreferences

Voorkeuren voor numerieke waarden.
Voorkeuren voor datumwaarden
 dateValuePreferences DateValuePreferences

Voorkeuren voor datumwaarden.
Voorkeuren voor datum/tijd-waarden
 dateTimeValuePreferences DateTimeValuePreferences

Voorkeuren voor Datum/tijd-waarden.
Voorkeuren voor tijdwaarde
 timeValuePreferences TimeValuePreferences

Voorkeuren voor tijdwaarden.
Voorkeuren voor metingswaarde
 measurementValuePreferences MeasurementValuePreferences

Voorkeuren voor meetwaarden.
Voorkeuren voor tekstwaarde
 textValuePreferences TextValuePreferences

Voorkeuren voor tekstwaarden.
Voorkeuren voor lijst met domeinwaarden
 domainValueListPreferences DomainValueListPreferences

Voorkeuren voor lijsten met domeinwaarden.
Voorkeuren voor domeinwaarde
 domainValuePreferences DomainValuePreferences

Voorkeuren voor domeinwaarden.

ContentTypeInfo

Details van een inhoudstype.

Name Pad Type Description
ID-kaart
 id integer

Unieke id van het inhoudstype.
Naam
 name string

Naam van het inhoudstype.
Domein-id
 domainId integer

Domein-id die is gekoppeld aan het inhoudstype.
Bronreferentie
 sourceReference string

Verwijzing naar de bron van het inhoudstype.
Onderliggende domeinwaarden
 childDomainValues array of DomainValue

Lijst met onderliggende domeinwaarden die zijn gekoppeld aan het inhoudstype.
Heeft kinderen
 hasChildren boolean

Geeft aan of het inhoudstype onderliggende elementen bevat.
Wordt verwijderd
 isDeleted boolean

Geeft aan of het inhoudstype is verwijderd.
Door het systeem gedefinieerd
 systemDefined boolean

Geeft aan of het inhoudstype door het systeem is gedefinieerd.
Kinderen beschikbaar
 childrenAvailable boolean

Geeft aan of onderliggende items beschikbaar zijn voor het inhoudstype.
Extensible
 extensible boolean

Geeft aan of het inhoudstype uitbreidbaar is.

BooleanValuePreferences

Voorkeuren voor booleaanse waarden.

Name Pad Type Description
Booleaanse waarde
 defaultValue BooleanValue

Booleaanse waarde.

Booleaanse waarde

Booleaanse waarde.

Name Pad Type Description
Waarde
 value boolean

De Booleaanse waarde.

NumericValuePreferences

Voorkeuren voor numerieke waarden.

Name Pad Type Description
Numerieke waarde
 minimumPossibleValue NumericValue

Numerieke waarde.
Numerieke waarde
 maximumPossibleValue NumericValue

Numerieke waarde.
Numerieke waarde
 defaultValue NumericValue

Numerieke waarde.

Numerieke waarde

Numerieke waarde.

Name Pad Type Description
Waarde
 value integer

De numerieke waarde.

DateValue

Datumwaarde.

Name Pad Type Description
Waarde
 value string

De datumwaarde.

DateValuePreferences

Voorkeuren voor datumwaarden.

Name Pad Type Description
Datumwaarde
 minimumPossibleValue DateValue

Datumwaarde.
Datumwaarde
 maximumPossibleValue DateValue

Datumwaarde.
Datumwaarde
 defaultValue DateValue

Datumwaarde.

DateTimeValue

Datum/tijd-waarde.

Name Pad Type Description
Waarde
 value string

De datum/tijd-waarde.

DateTimeValuePreferences

Voorkeuren voor Datum/tijd-waarden.

Name Pad Type Description
Datum/tijd-waarde
 minimumPossibleValue DateTimeValue

Datum/tijd-waarde.
Datum/tijd-waarde
 maximumPossibleValue DateTimeValue

Datum/tijd-waarde.
Datum/tijd-waarde
 defaultValue DateTimeValue

Datum/tijd-waarde.

TimeValue

Tijdwaarde.

Name Pad Type Description
Waarde
 value string

De tijdwaarde.

TimeValuePreferences

Voorkeuren voor tijdwaarden.

Name Pad Type Description
Tijdwaarde
 minimumPossibleValue TimeValue

Tijdwaarde.
Tijdwaarde
 maximumPossibleValue TimeValue

Tijdwaarde.
Tijdwaarde
 defaultValue TimeValue

Tijdwaarde.

MeasurementValue

Meetwaarde.

Name Pad Type Description
Waarde
 value double

De meetwaarde.

MeasurementValuePreferences

Voorkeuren voor meetwaarden.

Name Pad Type Description
Maateenheid
 measurementUnit integer

Maateenheid.
Alleen maateenheid kan worden gewijzigd
 onlyMeasurementUnitChangeable boolean

Geeft aan of alleen de maateenheid kan worden gewijzigd.
Meetwaarde
 minimumPossibleValue MeasurementValue

Meetwaarde.
Meetwaarde
 maximumPossibleValue MeasurementValue

Meetwaarde.
Meetwaarde
 defaultValue MeasurementValue

Meetwaarde.

TextValue

Tekstwaarde

Name Pad Type Description
Waarde
 value string

De tekstwaarde.

TextValuePreferences

Voorkeuren voor tekstwaarden.

Name Pad Type Description
Tekstwaarde
 defaultValue TextValue

Tekstwaarde
Maximale lengte mogelijk
 maxLengthPossible integer

Maximale lengte voor tekstwaarde.
Zoeken in tekst is ingeschakeld
 textSearchEnabled boolean

Geeft aan of zoeken in tekst is ingeschakeld.

DomainValueList

Lijst met domeinwaarden.

Name Pad Type Description
Domeinwaarden
 domainValues array of DomainValue

Lijst met domeinwaarden.

DomainValueListPreferences

Voorkeuren voor lijsten met domeinwaarden.

Name Pad Type Description
Lijst met domeinwaarden
 defaultValue DomainValueList

Lijst met domeinwaarden.
Domein-id
 domainId integer

Domein-id die is gekoppeld aan de lijst met domeinwaarden.

DomainValuePreferences

Voorkeuren voor domeinwaarden.

Name Pad Type Description
defaultValue
 defaultValue DomainValue
Domein-id
 domainId integer

Domein-id die is gekoppeld aan de domeinwaarde.

QueryDefinition

Definitie van een query.

Name Pad Type Description
Query-id
 queryId integer

Unieke id van de query.
Querynaam
 queryName string

Naam van de query.
Eigenaar-id
 ownerId integer

Id van de eigenaar van de query.
Geparametriseerde
 parameterized boolean

Geeft aan of de query is geparameteriseerd.
Queryweergave
 queryDisplay QueryDisplay

Weergave-instellingen voor een query.
Queryvoorwaarden
 queryConditions array of QueryCondition

Lijst met queryvoorwaarden.
Querycontext
 queryContext QueryContext

Contextinstellingen voor een query.
queryResults
 queryResults

QueryDisplay

Weergave-instellingen voor een query.

Name Pad Type Description
Kolommen weergeven
 displayColumns array of DisplayColumn

Lijst met weergavekolommen.
Sorteervolgorde
 sorting array of SortInfo

Lijst met sorteerinstellingen.
Beeldmodus
 displayMode integer

Instelling voor weergavemodus.
Groeperingskenmerken
 groupingAttributes array of GroupingInfo

Lijst met groeperingskenmerken.
Modus Verkennen
 exploreMode integer

De modusinstelling verkennen.

QueryCondition

Voorwaarde voor een query.

Name Pad Type Description
Logische operator
 logicalOperator integer

Logische operator voor de voorwaarde.
Vergelijkingsoperator
 comparisonOperator integer

Vergelijkingsoperator voor de voorwaarde.
Ontkend
 negated boolean

Geeft aan of de voorwaarde is ontkend.
Geparametriseerde
 parameterized boolean

Geeft aan of de voorwaarde is geparameteriseerd.
Typologie
 type integer

Type van de voorwaarde.
Kenmerk-id
 attributeId integer

Kenmerk-id voor zoeken.
Te zoeken waarde tegen
 value string

waarde voor zoeken op basis van.

QueryContext

Contextinstellingen voor een query.

Name Pad Type Description
Inhoudstype
 contentType integer

Id van het inhoudstype voor de querycontext.
Collections
 collections array of integer

Lijst met verzamelings-id's voor de querycontext.
Recursief
 recursive boolean

Geeft aan of de querycontext recursief is.
Alle versies opnemen
 includeAllVersions boolean

Geeft aan of alle versies zijn opgenomen in de querycontext.
Vertakkingen opnemen
 includeBranches boolean

Geeft aan of vertakkingen zijn opgenomen in de querycontext.

DisplayColumn

Kolom voor weergave in een query.

Name Pad Type Description
Kolom-id
 columnId integer

Id van de weergavekolom.
Breedte
 width integer

Breedte van de weergavekolom.
Kenmerkkolom
 attributeColumn boolean

Geeft aan of de kolom een kenmerkkolom is.

SortInfo

Sorteerinstellingen voor een query.

Name Pad Type Description
Kolom-id
 columnId integer

Id van de kolom voor sorteren.
Descending
 descending boolean

Geeft aan of de sorteervolgorde aflopend is.
Kenmerkkolom
 attributeColumn boolean

Geeft aan of de gesorteerde kolom een kenmerkkolom is.

GroupingInfo

Groepeerinstellingen voor een query.

Name Pad Type Description
Kenmerk-id
 attributeId integer

Id van het kenmerk voor groepering.
Descending
 descending boolean

Geeft aan of de groepering in aflopende volgorde is.

ListResponseQueryResultElement

Antwoordelement voor het weergeven van queryresultaten.

Name Pad Type Description
Aantal
 get_count integer

Aantal resultaten in het antwoord van de lijst.
Volgende koppeling
 get_nextLink string

Link naar de volgende pagina met resultaten.
Waarde
 get_value array of QueryResultElement

Matrix van queryresultaatelementen.

QueryResultElement

Element in een queryresultaat.

Name Pad Type Description
ID-kaart
 id integer

Unieke id voor het element.
Onderliggend item beschikbaar
 childAvailable boolean

Geeft aan of onderliggende elementen beschikbaar zijn.
Elementtype
 elementType integer

Type van het element.

ListResponseUser

Antwoordelement voor het weergeven van gebruikers.

Name Pad Type Description
Aantal
 get_count integer

Aantal gebruikers in het antwoord op de lijst.
Volgende koppeling
 get_nextLink string

Link naar de volgende pagina met resultaten.
Waarde
 get_value array of User

Matrix van gebruikerselementen.

PublishingStatusInfo

Name Pad Type Description
PublishingFailedException
 publishingFailedException PublishingFailedException

Er is een uitzondering opgetreden bij het publiceren mislukt
publishingOutputDownloadInfo
 publishingOutputDownloadInfo array of PublishingOutputDownloadInfo
Publicatiestatus
 publishingStatus string

De status van het publiceren van de asset, mogelijke retourwaarden zijn PUBLISHING_IN_PROGESS, PUBLISHING_FAILED, PUBLISHING_COMPLETED

PublishingFailedException

Er is een uitzondering opgetreden bij het publiceren mislukt

Name Pad Type Description
Aanvullende informatie
 additionalInfo array of string

Aanvullende informatie met betrekking tot de uitzondering
Gooibaar
 cause Throwable

Basisklasse voor uitzonderingen en fouten
Uitzonderingscode
 exceptionCode string

Code die is gekoppeld aan de uitzondering
Gelokaliseerd bericht
 localizedMessage string

Gelokaliseerd bericht waarin de uitzondering wordt beschreven
Message
 message string

Bericht met een beschrijving van de uitzondering
stackTrace
 stackTrace array of StackTraceElement
Onderdrukt
 suppressed array of Throwable

Gooibaar

Basisklasse voor uitzonderingen en fouten

Name Pad Type Description
Oorzaak
 cause string

De oorzaak van het gooibare
Gelokaliseerd bericht
 localizedMessage string

Gelokaliseerd bericht met een beschrijving van het gooibare bericht
Message
 message string

Bericht met een beschrijving van het gooibare bericht
stackTrace
 stackTrace array of StackTraceElement
Onderdrukt
 suppressed array of string

Andere throwables onderdrukt door deze gooibare

StackTraceElement

Een element dat één stackframe vertegenwoordigt

Name Pad Type Description
Klassenaam
 className string

Naam van de klasse die het uitvoeringspunt bevat
Bestandsnaam
 fileName string

Naam van het bestand met het uitvoeringspunt
Regelnummer
 lineNumber integer

Regelnummer in het bestand met het uitvoeringspunt
Methodenaam
 methodName string

Naam van de methode die het uitvoeringspunt bevat
Systeemeigen methode
 nativeMethod boolean

Geeft aan of de methode een systeemeigen methode is

Groep

Name Pad Type Description
childDomainValues
 childDomainValues array of DomainValue
Standaardgebruikersklasse-id
 defaultUserClassId integer

De standaardgebruikersklasse-id voor de groep.
Verwijderd
 deleted boolean

Geeft aan of de groep is verwijderd.
Domein-id
 domainId integer

De id van het domein waartoe de groep behoort.
E-mailadres
 emailAddress string

Het e-mailadres dat aan de groep is gekoppeld.
Heeft kinderen
 hasChildren boolean

Geeft aan of de groep onderliggende items heeft.
ID-kaart
 id integer

De id van de groep.
Wordt verwijderd
 isDeleted boolean

Geeft aan of de groep is verwijderd.
DN-naam van LDAP
 ldapDistinguishedName string

De DN-naam in LDAP voor de groep.
LDAP-profiel-id
 ldapProfileId integer

De LDAP-profiel-id voor de groep.
Lid-id's
 memberIds array of integer

Een matrix met lid-id's die aan de groep zijn gekoppeld.
Naam
 name string

De naam van de groep.
Systeemeigen beheerder
 nativeTrustee boolean

Geeft aan of de groep een systeemeigen beheerder is.
Bronreferentie
 sourceReference string

De bronreferentie voor de groep.
User
 user boolean

Geeft aan of de groep een gebruiker is.

integer

Dit is het basisgegevenstype Integer.

touw

Dit is het basisgegevenstype 'tekenreeks'.