Freigeben über


Fuxsy-ADSKFusionManagePaid (Unabhängiger Herausgeber) (Vorschau)

Weitere Informationen finden Sie unter :www.fuxsy.eu

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Dienstleistung Class Regions
Copilot Studio Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Logik-Apps Norm Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche:
     – Azure Government-Regionen
     - Azure China-Regionen
     - US Department of Defense (DoD)
Power Apps Premium Alle Power Apps-Regionen mit Ausnahme der folgenden:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Power Automate Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Kontakt
Name Fuxsy s.r.o.
URL http://fuxsy.eu/
Email support@fuxsy.eu
Connectormetadaten
Herausgeber Fuxsy.eu
Webseite http://fuxsy.eu/
Datenschutzrichtlinie http://fuxsy.eu/
Kategorien Daten;IT-Vorgänge

Drosselungsgrenzwerte

Name Aufrufe Verlängerungszeitraum
API-Aufrufe pro Verbindung 100 60 Sekunden

Aktionen

Anlage erstellen

Erstellt oder lädt eine neue Anlage für ein bestimmtes Element hoch.

Anlagendetails

Ruft detaillierte Informationen zu einer bestimmten Anlage ab.

Anlagenliste

Ruft eine Liste aller Anlagen für ein bestimmtes Element ab.

Anlagenordner erstellen

Erstellt einen neuen Anlagenordner für ein bestimmtes Element.

Arbeitsbereichselemente

Ruft eine Liste aller Elemente innerhalb eines bestimmten Arbeitsbereichs ab.

Arbeitsbereichsliste

Ruft eine Liste aller Arbeitsbereiche im Mandanten ab.

Ausstehende Arbeit des Benutzers

Ruft herausragende Arbeit für den angemeldeten Benutzer über die API ab. Der @me Parameter wird verwendet, um auf den aktuell angemeldeten Benutzer zu verweisen, und es ist nicht möglich, einen anderen Benutzer auszuwählen.

Benutzer in Gruppe

Ruft eine Liste der Benutzer und deren Details für eine bestimmte Gruppe ab.

Benutzeransichten basierende Zugriffsebene

Ruft eine Liste aller Benutzeransichten ab (benutzerdefinierter Filter von Elementen innerhalb eines Arbeitsbereichs).

Benutzeransichtsdetails

Ruft detaillierte Informationen zur Ansicht eines bestimmten Benutzers ab.

Benutzerberechtigungsdetails

Ruft die Berechtigungsdetails für einen bestimmten Benutzer innerhalb eines bestimmten Arbeitsbereichs basierend auf der bereitgestellten Berechtigungs-ID ab.

Benutzerdetails

Ruft detaillierte Informationen zum angegebenen Benutzer ab. Wenn @me sie verwendet wird, gibt die API Details zum Benutzer zurück, der den API-Aufruf vornimmt.

Benutzerliste

Ruft eine Liste aller Benutzer im Mandanten mit der Option zum Filtern nach Status ab.

Benutzerliste der Berechtigungen

Ruft eine Liste aller Berechtigungen ab, die einem bestimmten Benutzer zugewiesen sind.

Berechtigungsdetails

Ruft detaillierte Informationen zu einer bestimmten Berechtigung ab.

Berechtigungsliste

Ruft eine Liste aller berechtigungen ab, die im Mandanten verfügbar sind.

Berichtdownload

Ruft detaillierte Informationen zu einem Bericht/Downloads des Berichts ab.

Details zum Bericht

Ruft die vollständigen Konfigurationsdetails des Berichts ab.

Element, wo verwendet wird

Ruft eine Liste ab, in der das bestimmte Element verwendet wird.

Element erstellen

Erstellt ein neues Element innerhalb eines bestimmten Arbeitsbereichs.

Element PrintView

Generiert eine Druckansicht eines bestimmten Elements.

Element printView List

Ruft eine Liste der verfügbaren Druckansichten ab.

Element verwaltete Elemente erstellen

Ordnet ein neues verwaltetes Element einem bestimmten Element zu.

Elementabschnittsliste

Ruft eine Liste aller Abschnitte auf der Registerkarte "Elementdetails" ab.

Elementaktualisierungsdetails

Aktualisiert die Details eines bestimmten Elements, wobei alle details entfernt werden, die nicht angegeben sind.

Elementaktualisierungsdetails - teilweise

Aktualisiert teilweise die Details eines bestimmten Elements, wobei alle nicht angegebenen Details beibehalten werden.

Elementbeziehungen-Liste

Ruft eine Liste aller Beziehungselemente ab, die einem bestimmten Element zugeordnet sind.

Elementbeziehungselement erstellen

Erstellt eine neue Beziehung für ein bestimmtes Element.

Elementbeziehungselementdetails V1

Ruft eine Liste der Beziehungen für ein bestimmtes Element ab.

Elementdetails

Ruft detaillierte Informationen zu einem bestimmten Element ab.

Elementfelddetails

Zeigt detaillierte Informationen zum angegebenen Feld in einem Elementraster an.

Elementfeldtypen

Stellt eine Liste aller verfügbaren Feldtypen bereit.

Elementlistenfelder

Ruft eine Liste aller Felder innerhalb des Rasters ab.

Elementprotokoll

Ruft detaillierte Protokollinformationen für ein bestimmtes Element ab.

Elementrasterzeilen

Ruft eine Liste von Zeilen und Feldern für ein bestimmtes Element ab, einschließlich ihrer Werte.

Elementrasterzeilenaktualisierung

Aktualisiert eine oder mehrere Zeilen für ein bestimmtes Element.

Elementänderungsprotokoll

Ruft detaillierte Informationen zu Änderungen ab, die an einem bestimmten Element vorgenommen wurden.

Elementübergang

Führt einen Übergang für ein bestimmtes Element aus. Gibt 403 zurück, auch wenn dies erfolgreich war.

Gruppendetails

Ruft detaillierte Informationen zu einer bestimmten Gruppe ab.

Gruppenliste

Ruft eine Liste aller im Mandanten verfügbaren Gruppen ab.

Konfigurierte Arbeitsbereichsansichtsliste

Ruft eine Liste aller konfigurierten Ansichten für einen bestimmten Arbeitsbereich ab.

Liste der Arbeitsbereichselementregisterkarten

Ruft eine Liste aller konfigurierten Registerkarten für einen bestimmten Arbeitsbereich ab.

Liste der Elementdetails

Ruft eine Liste aller felder ab, die auf der Registerkarte "Elementdetails" verfügbar sind.

Liste der verwalteten Elemente für Elemente

Ruft eine Liste der verwalteten Elemente ab, die einem bestimmten Element zugeordnet sind.

Picklist-Details

Ruft Details von Picklist-Nachschlagevorgängen ab.

Skript "Neu erstellen"

Erstellt ein neues Skript des angegebenen Typs.

Skriptdetails

Ruft den Inhalt und die Details eines bestimmten Skripts ab.

Skriptliste

Ruft eine Liste aller Skripts innerhalb des Mandanten ab.

Suchwert im gesamten Mandanten

Sucht nach einem Wert für alle Elemente im gesamten Mandanten.

Verfügbare Übergänge

Ruft eine Liste der verfügbaren Übergänge für ein bestimmtes Element basierend auf dem angemeldeten Benutzer ab.

Version zum Erstellen von Anlagen

Erstellt eine neue Version einer vorhandenen Anlage.

Verwaltete Elemente für Elemente

Ruft eine Liste der verwalteten Elemente ab, die einem bestimmten Element zugeordnet sind.

Zeile "Element erstellen"

Erstellt eine neue Zeile für ein bestimmtes Element im Raster.

Übergänge der Arbeitsbereichsliste

Ruft eine Liste der verfügbaren Übergänge für einen bestimmten Arbeitsbereich ab.

Übersicht über die Registerkarte "Elemente"

Ruft eine Liste von Datensätzen und Feldern für eine bestimmte Registerkarte ab.

Anlage erstellen

Erstellt oder lädt eine neue Anlage für ein bestimmtes Element hoch.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs an, um Details abzurufen.
WorkspaceID True integer

Die ID des Arbeitsbereichs, für den Sie Details abrufen möchten, können über den GET Workspace List API-Aufruf abgerufen werden.

Gibt die ID des Elements an, um Details abzurufen.
ItemID True integer

Die ID des Elements, für das Sie Details abrufen möchten, kann über den GET Item List API-Aufruf abgerufen werden.

Gibt den Medientyp des Anforderungstexts an.
Content-Type string

Gibt den Medientyp des Anforderungstexts an. In diesem Fall wird erwartet, dass der Anforderungstext im JSON-Format vorliegt.

request123
request123

Anlagendetails

Ruft detaillierte Informationen zu einer bestimmten Anlage ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Elements an, um Details abzurufen.
WorkspaceID True integer

Die ID des Arbeitsbereichs, für den Sie Details abrufen möchten, können über den GET Workspace List API-Aufruf abgerufen werden.

Gibt die ID des Elements an, um Details abzurufen.
ItemID True integer

Die ID des Elements, für das Sie Details abrufen möchten, kann über den GET Item List API-Aufruf abgerufen werden.

Gibt die ID der Anlage an, um Details abzurufen.
AttachmentID True integer

Die ID der Anlage, für die Sie Details abrufen möchten, kann über den GET Attachments List API-Aufruf abgerufen werden.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.fileUrl.type string
type
type string

Anlagenliste

Ruft eine Liste aller Anlagen für ein bestimmtes Element ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs an, um Details abzurufen.
WorkspaceID True integer

Die ID des Arbeitsbereichs, für den Sie Details abrufen möchten, können über den GET Workspace List API-Aufruf abgerufen werden.

Gibt die ID des Elements an, um Details abzurufen.
ItemID True integer

Die ID des Elements, für das Sie Details abrufen möchten, kann über den GET Item List API-Aufruf abgerufen werden.

Gibt das Zu sortierende Feld in aufsteigender Reihenfolge an.
asc string

Gibt das Feld an, nach dem die Ergebnisse in aufsteigender Reihenfolge sortiert werden sollen. Verwenden Sie z. B. "Name", um Ergebnisse nach dem Namensfeld in aufsteigender Reihenfolge zu sortieren.

Gibt den in der Antwort erwarteten Medientyp an.
Accept string

Gibt den Medientyp an, den der Client in der Antwort erwartet. In diesem Fall fordert der Client die Antwort im Format von Massenanlagendaten im JSON-Format an.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.attachments.items.properties.created.properties.timeStamp.type string
type
properties.attachments.items.properties.created.properties.user.properties.email.type string
type
properties.attachments.items.properties.created.properties.user.properties.image.properties.large.type string
type
properties.attachments.items.properties.created.properties.user.properties.image.properties.medium.type string
type
properties.attachments.items.properties.created.properties.user.properties.image.properties.small.type string
type
properties.attachments.items.properties.created.properties.user.properties.image.type string
type
properties.attachments.items.properties.created.properties.user.properties.link.type string
type
properties.attachments.items.properties.created.properties.user.properties.status.type string
type
properties.attachments.items.properties.created.properties.user.properties.title.type string
type
properties.attachments.items.properties.created.properties.user.properties.urn.type string
type
properties.attachments.items.properties.created.properties.user.type string
type
properties.attachments.items.properties.created.type string
type
properties.attachments.items.properties.description.type string
type
properties.attachments.items.properties.folder.properties.id.type string
type
properties.attachments.items.properties.folder.properties.name.type string
type
properties.attachments.items.properties.folder.type string
type
properties.attachments.items.properties.id.type string
type
properties.attachments.items.properties.markups.properties.count.type string
type
properties.attachments.items.properties.markups.properties.deleted.type string
type
properties.attachments.items.properties.markups.properties.link.type string
type
properties.attachments.items.properties.markups.type string
type
properties.attachments.items.properties.name.type string
type
properties.attachments.items.properties.resourceName.type string
type
properties.attachments.items.properties.selfLink.type string
type
properties.attachments.items.properties.size.type string
type
properties.attachments.items.properties.status.properties.description.type string
type
properties.attachments.items.properties.status.properties.label.type string
type
properties.attachments.items.properties.status.properties.name.type string
type
properties.attachments.items.properties.status.type string
type
properties.attachments.items.properties.thumbnails.properties.large.type string
type
properties.attachments.items.properties.thumbnails.properties.medium.type string
type
properties.attachments.items.properties.thumbnails.properties.small.type string
type
properties.attachments.items.properties.thumbnails.type string
type
properties.attachments.items.properties.type.properties.extension.type string
type
properties.attachments.items.properties.type.properties.fileType.type string
type
properties.attachments.items.properties.type.properties.iconImage.type string
type
properties.attachments.items.properties.type.properties.id.type string
type
properties.attachments.items.properties.type.properties.viewable.type string
type
properties.attachments.items.properties.type.type string
type
properties.attachments.items.properties.url.type string
type
properties.attachments.items.properties.urn.type string
type
properties.attachments.items.properties.version.type string
required
properties.attachments.items.required array of string
type
properties.attachments.items.type string
type
properties.attachments.type string
type
properties.item.properties.deleted.type string
type
properties.item.properties.link.type string
type
properties.item.properties.title.type string
type
properties.item.properties.urn.type string
type
properties.item.type string
type
type string

Anlagenordner erstellen

Erstellt einen neuen Anlagenordner für ein bestimmtes Element.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs an, der die Elemente enthält.
WorkspaceID True integer

Die ID des Arbeitsbereichs, der die Elemente enthält, kann über den GET Workspace List API-Aufruf abgerufen werden.

Gibt die ID des Elements an, das die Anlage enthält.
ItemID True integer

Die ID des Elements, das die Anlage enthält, kann über den GET Item List API-Aufruf abgerufen werden.

Gibt den Medientyp des Anforderungstexts an.
Content-Type string

Gibt den Medientyp des Anforderungstexts an. In diesem Fall wird erwartet, dass der Anforderungstext im JSON-Format vorliegt.

request123
request123

Arbeitsbereichselemente

Ruft eine Liste aller Elemente innerhalb eines bestimmten Arbeitsbereichs ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs an, der die Elemente enthält.
WorkspaceID True integer

Die ID des Arbeitsbereichs, der die Elemente enthält, kann über den GET Workspace List API-Aufruf abgerufen werden.

Gibt die maximale Anzahl von Elementen an, die in der Antwort zurückgegeben werden sollen.
limit string

Gibt die maximale Anzahl von Elementen an, die in der Antwort zurückgegeben werden sollen. Dies wird verwendet, um die Größe des Resultsets einzuschränken.

Gibt den in der Antwort erwarteten Medientyp an.
Accept string

Gibt den Medientyp an, den der Client in der Antwort erwartet. In diesem Fall fordert der Client die Antwort im Format von Massenelementendaten im JSON-Format an.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.__self__.type string
type
properties.first.properties.count.type string
type
properties.first.properties.deleted.type string
type
properties.first.properties.link.type string
type
properties.first.properties.title.type string
type
properties.first.type string
type
properties.items.items.properties.__self__.type string
type
properties.items.items.properties.audit.properties.deleted.type string
type
properties.items.items.properties.audit.properties.link.type string
type
properties.items.items.properties.audit.type string
type
properties.items.items.properties.bom.properties.deleted.type string
type
properties.items.items.properties.bom.properties.link.type string
type
properties.items.items.properties.bom.type string
type
properties.items.items.properties.currentState.properties.deleted.type string
type
properties.items.items.properties.currentState.properties.link.type string
type
properties.items.items.properties.currentState.properties.title.type string
type
properties.items.items.properties.currentState.properties.urn.type string
type
properties.items.items.properties.currentState.type string
type
properties.items.items.properties.deleted.type string
type
properties.items.items.properties.flatBom.properties.deleted.type string
type
properties.items.items.properties.flatBom.properties.link.type string
type
properties.items.items.properties.flatBom.type string
type
properties.items.items.properties.itemLocked.type string
type
properties.items.items.properties.latestRelease.type string
type
properties.items.items.properties.lifecycle.properties.deleted.type string
type
properties.items.items.properties.lifecycle.properties.link.type string
type
properties.items.items.properties.lifecycle.properties.title.type string
type
properties.items.items.properties.lifecycle.properties.urn.type string
type
properties.items.items.properties.lifecycle.type string
type
properties.items.items.properties.milestones.properties.deleted.type string
type
properties.items.items.properties.milestones.properties.link.type string
type
properties.items.items.properties.milestones.type string
type
properties.items.items.properties.nestedBom.properties.count.type string
type
properties.items.items.properties.nestedBom.properties.deleted.type string
type
properties.items.items.properties.nestedBom.properties.link.type string
type
properties.items.items.properties.nestedBom.type string
type
properties.items.items.properties.owners.properties.deleted.type string
type
properties.items.items.properties.owners.properties.link.type string
type
properties.items.items.properties.owners.type string
type
properties.items.items.properties.root.properties.deleted.type string
type
properties.items.items.properties.root.properties.link.type string
type
properties.items.items.properties.root.properties.title.type string
type
properties.items.items.properties.root.properties.urn.type string
type
properties.items.items.properties.root.type string
type
properties.items.items.properties.sections.items.properties.fields.items.properties.__self__.type string
type
properties.items.items.properties.sections.items.properties.fields.items.properties.defaultValue.type string
type
properties.items.items.properties.sections.items.properties.fields.items.properties.formulaField.type string
type
properties.items.items.properties.sections.items.properties.fields.items.properties.isSystemField.type string
type
properties.items.items.properties.sections.items.properties.fields.items.properties.title.type string
type
properties.items.items.properties.sections.items.properties.fields.items.properties.type.properties.deleted.type string
type
properties.items.items.properties.sections.items.properties.fields.items.properties.type.properties.link.type string
type
properties.items.items.properties.sections.items.properties.fields.items.properties.type.properties.title.type string
type
properties.items.items.properties.sections.items.properties.fields.items.properties.type.properties.urn.type string
type
properties.items.items.properties.sections.items.properties.fields.items.properties.type.type string
type
properties.items.items.properties.sections.items.properties.fields.items.properties.urn.type string
type
properties.items.items.properties.sections.items.properties.fields.items.properties.value.type string
required
properties.items.items.properties.sections.items.properties.fields.items.required array of string
type
properties.items.items.properties.sections.items.properties.fields.items.type string
type
properties.items.items.properties.sections.items.properties.fields.type string
type
properties.items.items.properties.sections.items.properties.link.type string
type
properties.items.items.properties.sections.items.properties.sectionLocked.type string
type
properties.items.items.properties.sections.items.properties.title.type string
required
properties.items.items.properties.sections.items.required array of string
type
properties.items.items.properties.sections.items.type string
type
properties.items.items.properties.sections.type string
type
properties.items.items.properties.sectionsLink.type string
type
properties.items.items.properties.title.type string
type
properties.items.items.properties.urn.type string
type
properties.items.items.properties.whereUsed.properties.count.properties.type.type string
type
properties.items.items.properties.whereUsed.properties.count.properties.value.type string
type
properties.items.items.properties.whereUsed.properties.count.type string
type
properties.items.items.properties.whereUsed.properties.link.type string
type
properties.items.items.properties.whereUsed.type string
type
properties.items.items.properties.workflowReference.type string
type
properties.items.items.properties.workingHasChanged.type string
type
properties.items.items.properties.workingVersion.type string
type
properties.items.items.properties.workspace.properties.deleted.type string
type
properties.items.items.properties.workspace.properties.link.type string
type
properties.items.items.properties.workspace.properties.title.type string
type
properties.items.items.properties.workspace.properties.type.type string
type
properties.items.items.properties.workspace.properties.urn.type string
type
properties.items.items.properties.workspace.type string
required
properties.items.items.required array of string
type
properties.items.items.type string
type
properties.items.type string
type
properties.last.properties.count.type string
type
properties.last.properties.deleted.type string
type
properties.last.properties.link.type string
type
properties.last.properties.title.type string
type
properties.last.type string
type
properties.limit.type string
type
properties.next.properties.count.type string
type
properties.next.properties.deleted.type string
type
properties.next.properties.link.type string
type
properties.next.properties.title.type string
type
properties.next.type string
type
properties.offset.type string
type
properties.totalCount.type string
type
type string

Arbeitsbereichsliste

Ruft eine Liste aller Arbeitsbereiche im Mandanten ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die maximale Anzahl von Elementen an, die in der Antwort zurückgegeben werden sollen.
limit string

Gibt die maximale Anzahl von Elementen an, die in der Antwort zurückgegeben werden sollen. Dies wird verwendet, um die Größe des Resultsets einzuschränken.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.__self__.type string
type
properties.first.properties.count.type string
type
properties.first.properties.deleted.type string
type
properties.first.properties.link.type string
type
properties.first.properties.title.type string
type
properties.first.type string
type
properties.items.items.properties.category.properties.displayOrder.type string
type
properties.items.items.properties.category.properties.icon.type string
type
properties.items.items.properties.category.properties.name.type string
type
properties.items.items.properties.category.type string
type
properties.items.items.properties.deleted.type string
type
properties.items.items.properties.displayOrder.type string
type
properties.items.items.properties.link.type string
type
properties.items.items.properties.permissions.items.type string
type
properties.items.items.properties.permissions.type string
type
properties.items.items.properties.systemName.type string
type
properties.items.items.properties.title.type string
type
properties.items.items.properties.urn.type string
required
properties.items.items.required array of string
type
properties.items.items.type string
type
properties.items.type string
type
properties.last.properties.count.type string
type
properties.last.properties.deleted.type string
type
properties.last.properties.link.type string
type
properties.last.properties.title.type string
type
properties.last.type string
type
properties.limit.type string
type
properties.offset.type string
type
properties.totalCount.type string
type
type string

Ausstehende Arbeit des Benutzers

Ruft herausragende Arbeit für den angemeldeten Benutzer über die API ab. Der @me Parameter wird verwendet, um auf den aktuell angemeldeten Benutzer zu verweisen, und es ist nicht möglich, einen anderen Benutzer auszuwählen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Benutzers an, um Details abzurufen.
UserID True string

Die ID des Benutzers, für den Sie Details abrufen möchten, können über den GET Users List API-Aufruf abgerufen werden.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.__self__.type string
type
properties.count.type string
type
properties.lastRecalculateStarted.type string
type
properties.lastRecalculateUpdate.type string
type
properties.outstandingWork.items.properties.delegated.type string
type
properties.outstandingWork.items.properties.escalated.type string
type
properties.outstandingWork.items.properties.item.properties.deleted.type string
type
properties.outstandingWork.items.properties.item.properties.link.type string
type
properties.outstandingWork.items.properties.item.properties.title.type string
type
properties.outstandingWork.items.properties.item.properties.urn.type string
type
properties.outstandingWork.items.properties.item.type string
type
properties.outstandingWork.items.properties.milestoneDate.type string
type
properties.outstandingWork.items.properties.milestoneStatus.type string
type
properties.outstandingWork.items.properties.workflowStateName.type string
type
properties.outstandingWork.items.properties.workflowStateSetDate.type string
type
properties.outstandingWork.items.properties.workflowUser.properties.email.type string
type
properties.outstandingWork.items.properties.workflowUser.properties.image.properties.large.type string
type
properties.outstandingWork.items.properties.workflowUser.properties.image.properties.medium.type string
type
properties.outstandingWork.items.properties.workflowUser.properties.image.properties.small.type string
type
properties.outstandingWork.items.properties.workflowUser.properties.image.type string
type
properties.outstandingWork.items.properties.workflowUser.properties.link.type string
type
properties.outstandingWork.items.properties.workflowUser.properties.status.type string
type
properties.outstandingWork.items.properties.workflowUser.properties.title.type string
type
properties.outstandingWork.items.properties.workflowUser.properties.urn.type string
type
properties.outstandingWork.items.properties.workflowUser.type string
type
properties.outstandingWork.items.properties.workspace.properties.deleted.type string
type
properties.outstandingWork.items.properties.workspace.properties.link.type string
type
properties.outstandingWork.items.properties.workspace.properties.title.type string
type
properties.outstandingWork.items.properties.workspace.properties.type.type string
type
properties.outstandingWork.items.properties.workspace.properties.urn.type string
type
properties.outstandingWork.items.properties.workspace.type string
required
properties.outstandingWork.items.required array of string
type
properties.outstandingWork.items.type string
type
properties.outstandingWork.type string
type
properties.recalculating.type string
type
type string

Benutzer in Gruppe

Ruft eine Liste der Benutzer und deren Details für eine bestimmte Gruppe ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID der Gruppe an, für die Details abgerufen werden sollen.
GroupID True integer

Die ID der Gruppe, für die Sie Details abrufen möchten, kann über den GET Groups List API-Aufruf abgerufen werden.

Gibt den Startindex zum Abrufen von Elementen in einem paginierten Resultset an.
offset string

Gibt den Ausgangspunkt oder Index an, aus dem Elemente in einem paginierten Resultset abgerufen werden sollen. Nützlich, um eine bestimmte Anzahl von Elementen in der Liste zu überspringen.

Gibt die maximale Anzahl von Elementen an, die in der Antwort zurückgegeben werden sollen.
limit string

Gibt die maximale Anzahl von Elementen an, die in der Antwort zurückgegeben werden sollen. Dies wird verwendet, um die Größe des Resultsets einzuschränken.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.__self__.type string
type
properties.first.properties.count.type string
type
properties.first.properties.deleted.type string
type
properties.first.properties.link.type string
type
properties.first.properties.title.type string
type
properties.first.type string
type
properties.items.items.properties.__self__.type string
aboutMe
properties.items.items.properties.aboutMe object
type
properties.items.items.properties.active.type string
type
properties.items.items.properties.address1.type string
type
properties.items.items.properties.address2.type string
type
properties.items.items.properties.analyticsId.type string
type
properties.items.items.properties.batchNotifyPref.type string
type
properties.items.items.properties.cellular.type string
type
properties.items.items.properties.city.type string
type
properties.items.items.properties.consumeLicense.type string
type
properties.items.items.properties.country.type string
dashboardCharts
properties.items.items.properties.dashboardCharts object
type
properties.items.items.properties.dateFormat.type string
Delegationen
properties.items.items.properties.delegations array of string
type
properties.items.items.properties.displayName.type string
type
properties.items.items.properties.displayNameExtended.type string
type
properties.items.items.properties.email.type string
type
properties.items.items.properties.enforce2fa.type string
type
properties.items.items.properties.entitlement.type string
externalAuthReservationToken
properties.items.items.properties.externalAuthReservationToken object
type
properties.items.items.properties.externalAuthUserId.type string
type
properties.items.items.properties.fax.type string
type
properties.items.items.properties.firstName.type string
type
properties.items.items.properties.id.type string
Industrie
properties.items.items.properties.industry object
type
properties.items.items.properties.interfaceStyle.type string
type
properties.items.items.properties.interfaceStyleMandated.type string
type
properties.items.items.properties.lastAccessTime.type string
type
properties.items.items.properties.lastLicenseTimeIssued.type string
type
properties.items.items.properties.lastLoginTime.type string
type
properties.items.items.properties.lastMowUpdateDate.type string
type
properties.items.items.properties.lastName.type string
type
properties.items.items.properties.lastRecalculateStarted.type string
type
properties.items.items.properties.lastRecalculateUpdate.type string
type
properties.items.items.properties.ldapEnabled.type string
type
properties.items.items.properties.licenseFeatureId.type string
type
properties.items.items.properties.licenseType.properties.deleted.type string
type
properties.items.items.properties.licenseType.properties.description.type string
type
properties.items.items.properties.licenseType.properties.link.type string
type
properties.items.items.properties.licenseType.properties.title.type string
type
properties.items.items.properties.licenseType.properties.type.type string
type
properties.items.items.properties.licenseType.properties.urn.type string
type
properties.items.items.properties.licenseType.type string
type
properties.items.items.properties.loginName.type string
type
properties.items.items.properties.mappedToOxygen.type string
type
properties.items.items.properties.organization.type string
type
properties.items.items.properties.phone.type string
type
properties.items.items.properties.plmSearchCrawlerUser.type string
type
properties.items.items.properties.postal.type string
type
properties.items.items.properties.regularUser.type string
type
properties.items.items.properties.reset.type string
signupUrl
properties.items.items.properties.signupUrl object
type
properties.items.items.properties.stateProv.type string
surveyDone
properties.items.items.properties.surveyDone object
type
properties.items.items.properties.tenantAdmin.type string
type
properties.items.items.properties.thumbnailPref.type string
type
properties.items.items.properties.timezone.type string
type
properties.items.items.properties.title.type string
type
properties.items.items.properties.twoFactorAuthEnabled.type string
type
properties.items.items.properties.uomPref.type string
type
properties.items.items.properties.urn.type string
type
properties.items.items.properties.userActive.type string
type
properties.items.items.properties.userId.type string
type
properties.items.items.properties.userInactive.type string
type
properties.items.items.properties.userNumber.type string
type
properties.items.items.properties.userStatus.type string
type
properties.items.items.properties.wfNotifyPref.type string
required
properties.items.items.required array of string
type
properties.items.items.type string
type
properties.items.type string
type
properties.last.properties.count.type string
type
properties.last.properties.deleted.type string
type
properties.last.properties.link.type string
type
properties.last.properties.title.type string
type
properties.last.type string
type
properties.limit.type string
type
properties.offset.type string
type
properties.totalCount.type string
type
type string

Benutzeransichten basierende Zugriffsebene

Ruft eine Liste aller Benutzeransichten ab (benutzerdefinierter Filter von Elementen innerhalb eines Arbeitsbereichs).

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs an, der die Benutzeransichten enthält.
WorkspaceID True integer

Die ID des Arbeitsbereichs, der die Benutzeransichten enthält, kann über den GET Workspace List API-Aufruf abgerufen werden.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.__self__.type string
type
properties.links.items.properties.deleted.type string
type
properties.links.items.properties.link.type string
type
properties.links.items.properties.title.type string
type
properties.links.items.properties.urn.type string
required
properties.links.items.required array of string
type
properties.links.items.type string
type
properties.links.type string
type
type string

Benutzeransichtsdetails

Ruft detaillierte Informationen zur Ansicht eines bestimmten Benutzers ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs an, der das Element enthält.
WorkspaceID True integer

Die ID des Arbeitsbereichs, der das Element enthält, kann über den GET Workspace List API-Aufruf abgerufen werden.

Gibt die ID des Elements an, um Details abzurufen.
ItemID True integer

Die ID des Elements, für das Sie Details abrufen möchten, kann über den GET Item List API-Aufruf abgerufen werden.

Gibt die ID der Benutzeransicht an, um Details abzurufen.
ViewID True integer

Die ID der Benutzeransicht, für die Sie Details abrufen möchten, können über den API-Aufruf der GET-Benutzeransichten abgerufen werden.

Gibt das Zu sortierende Feld in aufsteigender Reihenfolge an.
asc string

Gibt das Feld an, nach dem die Ergebnisse in aufsteigender Reihenfolge sortiert werden sollen.

Gibt das Zu sortierende Feld in absteigender Reihenfolge an.
desc string

Gibt das Feld an, nach dem die Ergebnisse in absteigender Reihenfolge sortiert werden sollen.

Gibt die Seitenzahl der abzurufenden Ergebnisse an.
page string

Gibt die Seitenzahl der abzurufenden Ergebnisse an. Wird zum Paginieren durch große Datasets verwendet.

Gibt die Anzahl der Elemente an, die pro Seite in einer paginierten Antwort zurückgegeben werden sollen.
size string

Gibt die Anzahl der Elemente an, die pro Seite in einer paginierten Antwort zurückgegeben werden sollen. Auf diese Weise können Clients die Größe des Resultsets steuern.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.__self__.type string
type
properties.columns.items.properties.displayName.type string
type
properties.columns.items.properties.id.type string
type
properties.columns.items.properties.index.type string
required
properties.columns.items.required array of string
type
properties.columns.items.type string
type
properties.columns.type string
items
properties.items array of string
type
properties.pageNumber.type string
type
properties.pageSize.type string
type
properties.sortingColumns.items.properties.id.type string
type
properties.sortingColumns.items.properties.index.type string
type
properties.sortingColumns.items.properties.order.type string
required
properties.sortingColumns.items.required array of string
type
properties.sortingColumns.items.type string
type
properties.sortingColumns.type string
type
properties.total.type string
type
properties.urn.type string
type
type string

Benutzerberechtigungsdetails

Ruft die Berechtigungsdetails für einen bestimmten Benutzer innerhalb eines bestimmten Arbeitsbereichs basierend auf der bereitgestellten Berechtigungs-ID ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs an, um Details abzurufen.
WorkspaceID True integer

Die ID des Arbeitsbereichs, für den Sie Details abrufen möchten, können über den GET Workspace List API-Aufruf abgerufen werden.

Gibt die ID des Benutzers an, um Details abzurufen.
UserID True string

Die ID des Benutzers, für den Sie Details abrufen möchten, können über den GET Users List API-Aufruf abgerufen werden.

Gibt die ID der Berechtigung zum Abrufen von Details an.
PermissionID True integer

Die ID der Berechtigung, für die Sie Details abrufen möchten, können über den API-Aufruf der GET-Berechtigungsliste abgerufen werden.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.__self__.type string
type
properties.id.type string
type
properties.longName.type string
type
properties.shortName.type string
type
properties.urn.type string
type
type string

Benutzerdetails

Ruft detaillierte Informationen zum angegebenen Benutzer ab. Wenn @me sie verwendet wird, gibt die API Details zum Benutzer zurück, der den API-Aufruf vornimmt.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Benutzers an, um Details abzurufen.
UserID True string

Die ID des Benutzers, für den Sie Details abrufen möchten, können über den GET Users List API-Aufruf abgerufen werden.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.__self__.type string
aboutMe
properties.aboutMe object
type
properties.active.type string
type
properties.address1.type string
type
properties.address2.type string
type
properties.alerts.items.properties.acknowledged.type string
type
properties.alerts.items.properties.deleted.type string
type
properties.alerts.items.properties.link.type string
type
properties.alerts.items.properties.message.type string
type
properties.alerts.items.properties.priority.type string
type
properties.alerts.items.properties.title.type string
type
properties.alerts.items.properties.type.type string
type
properties.alerts.items.properties.urgent.type string
type
properties.alerts.items.properties.urn.type string
required
properties.alerts.items.required array of string
type
properties.alerts.items.type string
type
properties.alerts.type string
type
properties.analyticsId.type string
type
properties.batchNotifyPref.type string
Handy
properties.cellular object
type
properties.city.type string
type
properties.consumeLicense.type string
type
properties.country.type string
dashboardCharts
properties.dashboardCharts object
type
properties.dateFormat.type string
items
properties.delegations.items string
type
properties.displayName.type string
type
properties.displayNameExtended.type string
type
properties.email.type string
type
properties.enforce2fa.type string
type
properties.entitlement.type string
externalAuthReservationToken
properties.externalAuthReservationToken object
type
properties.externalAuthUserId.type string
Fax
properties.fax object
type
properties.firstName.type string
type
properties.groups.items.properties.link.type string
type
properties.groups.items.properties.longName.type string
type
properties.groups.items.properties.shortName.type string
type
properties.groups.items.properties.urn.type string
required
properties.groups.items.required array of string
type
properties.groups.items.type string
type
properties.groups.type string
type
properties.id.type string
type
properties.image.properties.large.type string
type
properties.image.properties.medium.type string
type
properties.image.properties.small.type string
type
properties.image.type string
Industrie
properties.industry object
type
properties.interfaceStyle.type string
type
properties.interfaceStyleMandated.type string
type
properties.lastAccessTime.type string
type
properties.lastLicenseTimeIssued.type string
type
properties.lastLoginTime.type string
type
properties.lastMowUpdateDate.type string
type
properties.lastName.type string
type
properties.lastRecalculateStarted.type string
type
properties.lastRecalculateUpdate.type string
type
properties.ldapEnabled.type string
licenseFeatureId
properties.licenseFeatureId object
type
properties.licenseType.properties.deleted.type string
type
properties.licenseType.properties.description.type string
type
properties.licenseType.properties.link.type string
type
properties.licenseType.properties.title.type string
type
properties.licenseType.properties.type.type string
type
properties.licenseType.properties.urn.type string
type
properties.licenseType.type string
type
properties.loginName.type string
type
properties.mappedToOxygen.type string
type
properties.organization.type string
phone
properties.phone object
type
properties.plmSearchCrawlerUser.type string
type
properties.postal.type string
type
properties.preferences.type string
type
properties.regularUser.type string
type
properties.reset.type string
type
properties.showEnableFullAccess.type string
signupUrl
properties.signupUrl object
type
properties.stateProv.type string
type
properties.surveyDone.type string
type
properties.tenantAdmin.type string
type
properties.thumbnailPref.type string
type
properties.timezone.type string
type
properties.title.type string
type
properties.twoFaEnabled.type string
type
properties.twoFactorAuthEnabled.type string
type
properties.uomPref.type string
type
properties.urn.type string
type
properties.userActive.type string
type
properties.userId.type string
type
properties.userInactive.type string
type
properties.userNumber.type string
type
properties.userStatus.type string
type
properties.wfNotifyPref.type string
type
type string

Benutzerliste

Ruft eine Liste aller Benutzer im Mandanten mit der Option zum Filtern nach Status ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt an, ob nur aktive Benutzer angezeigt werden sollen.
activeOnly string

Wenn dieser Wert auf "true" festgelegt ist, werden nur Benutzer angezeigt, die derzeit aktiv sind.

mappedOnly
mappedOnly string

Wenn "true" festgelegt ist, werden nur Benutzer angezeigt, die zugeordnet sindOnly

Sortiert die Ergebnisse alphabetisch in aufsteigender oder absteigender Reihenfolge.
sort string

Sortiert die Ergebnisse alphabetisch entweder aufsteigend oder absteigend je nach angegebenem Wert.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.users.items.properties.deleted.type string
type
properties.users.items.properties.link.type string
type
properties.users.items.properties.title.type string
type
properties.users.items.properties.urn.type string
required
properties.users.items.required array of string
type
properties.users.items.type string
type
properties.users.type string
type
type string

Benutzerliste der Berechtigungen

Ruft eine Liste aller Berechtigungen ab, die einem bestimmten Benutzer zugewiesen sind.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Benutzers an, für den Details abgerufen werden sollen.
UserID True string

Die ID des Benutzers, für den Sie Details abrufen möchten, können über den GET Users List API-Aufruf abgerufen werden.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.permissions.items.properties.deleted.type string
type
properties.permissions.items.properties.link.type string
type
properties.permissions.items.properties.name.type string
type
properties.permissions.items.properties.title.type string
type
properties.permissions.items.properties.urn.type string
required
properties.permissions.items.required array of string
type
properties.permissions.items.type string
type
properties.permissions.type string
type
type string

Berechtigungsdetails

Ruft detaillierte Informationen zu einer bestimmten Berechtigung ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID der Berechtigung zum Abrufen von Details an.
PermissionID True integer

Die ID der Berechtigung, für die Sie Details abrufen möchten, können über den API-Aufruf der GET-Berechtigungsliste abgerufen werden.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.__self__.type string
type
properties.id.type string
type
properties.longName.type string
type
properties.shortName.type string
type
properties.urn.type string
type
type string

Berechtigungsliste

Ruft eine Liste aller berechtigungen ab, die im Mandanten verfügbar sind.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.permissions.items.properties.deleted.type string
type
properties.permissions.items.properties.link.type string
type
properties.permissions.items.properties.name.type string
type
properties.permissions.items.properties.title.type string
type
properties.permissions.items.properties.urn.type string
required
properties.permissions.items.required array of string
type
properties.permissions.items.type string
type
properties.permissions.type string
type
type string

Berichtdownload

Ruft detaillierte Informationen zu einem Bericht/Downloads des Berichts ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs an, um Details abzurufen.
WorkspaceID True integer

Die ID des Arbeitsbereichs, für den Sie Details abrufen möchten, können über den GET Workspace List API-Aufruf abgerufen werden.

Gibt die ID des herunterzuladenden Berichts an.
ReportID True integer

Die ID des Berichts, den Sie herunterladen möchten.

Gibt die Seitenzahl der abzurufenden Ergebnisse an.
page string

Gibt die Seitenzahl der abzurufenden Ergebnisse an. Wird zum Paginieren durch große Datasets verwendet.

Gibt das Zu sortierende Feld in aufsteigender Reihenfolge an.
asc string

Gibt das Feld an, nach dem die Ergebnisse in aufsteigender Reihenfolge sortiert werden sollen.

Gibt das Zu sortierende Feld in absteigender Reihenfolge an.
desc string

Gibt das Feld an, nach dem die Ergebnisse in absteigender Reihenfolge sortiert werden sollen.

Gibt die Anzahl der Elemente an, die pro Seite in einer paginierten Antwort zurückgegeben werden sollen.
size string

Gibt die Anzahl der Elemente an, die pro Seite in einer paginierten Antwort zurückgegeben werden sollen. Auf diese Weise können Clients die Größe des Resultsets steuern.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.__self__.type string
type
properties.columns.items.properties.displayName.type string
type
properties.columns.items.properties.id.type string
type
properties.columns.items.properties.index.type string
required
properties.columns.items.required array of string
type
properties.columns.items.type string
type
properties.columns.type string
type
properties.items.items.properties.fields.items.properties.id.type string
type
properties.items.items.properties.fields.items.properties.value.type string
required
properties.items.items.properties.fields.items.required array of string
type
properties.items.items.properties.fields.items.type string
type
properties.items.items.properties.fields.type string
type
properties.items.items.properties.index.type string
type
properties.items.items.properties.item.properties.deleted.type string
type
properties.items.items.properties.item.properties.link.type string
type
properties.items.items.properties.item.properties.urn.type string
type
properties.items.items.properties.item.type string
required
properties.items.items.required array of string
type
properties.items.items.type string
type
properties.items.type string
type
properties.pageNumber.type string
type
properties.pageSize.type string
type
properties.sortingColumns.items.properties.id.type string
type
properties.sortingColumns.items.properties.index.type string
type
properties.sortingColumns.items.properties.order.type string
required
properties.sortingColumns.items.required array of string
type
properties.sortingColumns.items.type string
type
properties.sortingColumns.type string
type
properties.total.type string
type
properties.urn.type string
type
type string

Details zum Bericht

Ruft die vollständigen Konfigurationsdetails des Berichts ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Berichts an, um Details abzurufen.
ReportID True integer

Die ID des Berichts, zu dem Sie Details abrufen möchten.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.reportDefinition.properties.hasOrphanFields.type string
type
properties.reportDefinition.properties.id.type string
type
properties.reportDefinition.properties.isChartReport.type string
type
properties.reportDefinition.properties.modifiedDate.type string
type
properties.reportDefinition.properties.name.type string
type
properties.reportDefinition.properties.owner.type string
type
properties.reportDefinition.properties.workspaceId.type string
type
properties.reportDefinition.type string
type
properties.reportResult.properties.columnKey.items.properties.label.type string
type
properties.reportResult.properties.columnKey.items.properties.value.type string
required
properties.reportResult.properties.columnKey.items.required array of string
type
properties.reportResult.properties.columnKey.items.type string
type
properties.reportResult.properties.columnKey.type string
type
properties.reportResult.properties.row.items.properties.fields.properties.entry.items.properties.fieldData.properties.dataType.type string
type
properties.reportResult.properties.row.items.properties.fields.properties.entry.items.properties.fieldData.properties.label.type string
type
properties.reportResult.properties.row.items.properties.fields.properties.entry.items.properties.fieldData.properties.value.type string
type
properties.reportResult.properties.row.items.properties.fields.properties.entry.items.properties.fieldData.type string
type
properties.reportResult.properties.row.items.properties.fields.properties.entry.items.properties.key.type string
required
properties.reportResult.properties.row.items.properties.fields.properties.entry.items.required array of string
type
properties.reportResult.properties.row.items.properties.fields.properties.entry.items.type string
type
properties.reportResult.properties.row.items.properties.fields.properties.entry.type string
type
properties.reportResult.properties.row.items.properties.fields.type string
type
properties.reportResult.properties.row.items.properties.rowId.type string
required
properties.reportResult.properties.row.items.required array of string
type
properties.reportResult.properties.row.items.type string
type
properties.reportResult.properties.row.type string
type
properties.reportResult.properties.totalResultCount.type string
type
properties.reportResult.type string
type
type string

Element, wo verwendet wird

Ruft eine Liste ab, in der das bestimmte Element verwendet wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs an, der die Elemente enthält.
WorkspaceID True integer

Die ID des Arbeitsbereichs, der die Elemente enthält, kann über den GET Workspace List API-Aufruf abgerufen werden.

Gibt die ID des elements an, das in der BOM verwendet wird.
ItemID True integer

Die ID des elements, das in BOM verwendet wird, kann über den GET Item List API-Aufruf abgerufen werden.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.__self__.type string
type
properties.config.properties.bias.type string
type
properties.config.properties.bomViewDate.type string
type
properties.config.properties.viewDef.properties.deleted.type string
type
properties.config.properties.viewDef.properties.link.type string
type
properties.config.properties.viewDef.properties.urn.type string
type
properties.config.properties.viewDef.type string
type
properties.config.type string
type
properties.edges.items.properties.child.type string
type
properties.edges.items.properties.depth.type string
type
properties.edges.items.properties.edgeId.type string
type
properties.edges.items.properties.edgeLink.type string
fields
properties.edges.items.properties.fields array of string
type
properties.edges.items.properties.itemNumber.type string
type
properties.edges.items.properties.lastNode.type string
type
properties.edges.items.properties.parent.type string
required
properties.edges.items.required array of string
type
properties.edges.items.type string
type
properties.edges.type string
type
properties.first.properties.count.type string
type
properties.first.properties.deleted.type string
type
properties.first.properties.link.type string
type
properties.first.properties.title.type string
type
properties.first.type string
type
properties.last.properties.count.type string
type
properties.last.properties.deleted.type string
type
properties.last.properties.link.type string
type
properties.last.properties.title.type string
type
properties.last.type string
type
properties.limit.type string
type
properties.nodes.items.properties.bomItems.type string
type
properties.nodes.items.properties.bomRoot.type string
type
properties.nodes.items.properties.fields.items.properties.isSystemField.type string
type
properties.nodes.items.properties.fields.items.properties.title.type string
type
properties.nodes.items.properties.fields.items.properties.value.type string
required
properties.nodes.items.properties.fields.items.required array of string
type
properties.nodes.items.properties.fields.items.type string
type
properties.nodes.items.properties.fields.type string
type
properties.nodes.items.properties.item.properties.deleted.type string
type
properties.nodes.items.properties.item.properties.link.type string
type
properties.nodes.items.properties.item.properties.title.type string
type
properties.nodes.items.properties.item.properties.urn.type string
type
properties.nodes.items.properties.item.properties.version.type string
type
properties.nodes.items.properties.item.type string
required
properties.nodes.items.required array of string
type
properties.nodes.items.type string
type
properties.nodes.type string
type
properties.offset.type string
type
properties.root.type string
type
properties.totalCount.type string
type
type string

Element erstellen

Erstellt ein neues Element innerhalb eines bestimmten Arbeitsbereichs.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs für die Elementerstellung an.
WorkspaceID True integer

Die ID des Arbeitsbereichs, in dem Sie ein Element erstellen möchten, kann über den GET Workspace List API-Aufruf abgerufen werden.

Gibt den Medientyp des Anforderungstexts an.
Content-Type string

Gibt den Medientyp des Anforderungstexts an. In diesem Fall wird erwartet, dass der Anforderungstext im JSON-Format vorliegt.

request123
request123

Element PrintView

Generiert eine Druckansicht eines bestimmten Elements.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs an, der die Elemente enthält.
WorkspaceID True integer

Die ID des Arbeitsbereichs, der die Elemente enthält, kann über den GET Workspace List API-Aufruf abgerufen werden.

Gibt die ID des Elements zum Erstellen einer Druckansicht an.
ItemID True integer

Die ID des Elements, für das Sie eine Druckansicht erstellen, kann über den GET Item List API-Aufruf abgerufen werden.

Gibt die ID der Druckansicht an.
PrintViewID True string

Die ID der Printview, Beispiel: "APV-123"

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.__self__.type string
type
properties.hide.type string
type
properties.printName.type string
type
properties.urn.type string
type
type string

Element printView List

Ruft eine Liste der verfügbaren Druckansichten ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs zum Abrufen der Druckansichtsliste an.
WorkspaceID True integer

Die ID des Arbeitsbereichs, für den Sie die Liste der Druckansichten drucken möchten, kann über den GET Workspace List API-Aufruf abgerufen werden.

Gibt an, ob Ergebnisse in aufsteigender Reihenfolge sortiert werden sollen.
asc string

Gibt an, ob die Ergebnisse in aufsteigender Reihenfolge sortiert werden sollen. Verwenden Sie 'true' für aufsteigende Elemente, oder lassen Sie sie für die Standardsortierung leer.

Gibt an, ob Ergebnisse in absteigender Reihenfolge sortiert werden sollen.
desc string

Gibt an, ob die Ergebnisse in absteigender Reihenfolge sortiert werden sollen. Verwenden Sie "true" für absteigende Elemente, oder lassen Sie sie für die Standardsortierung leer.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.__self__.type string
type
properties.links.items.properties.deleted.type string
type
properties.links.items.properties.hidden.type string
type
properties.links.items.properties.link.type string
type
properties.links.items.properties.title.type string
type
properties.links.items.properties.type.type string
type
properties.links.items.properties.urn.type string
required
properties.links.items.required array of string
type
properties.links.items.type string
type
properties.links.type string
type
type string

Element verwaltete Elemente erstellen

Ordnet ein neues verwaltetes Element einem bestimmten Element zu.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs an, der das Element enthält.
WorkspaceID True integer

Die ID des Arbeitsbereichs, der das Element enthält, kann über den GET Workspace List API-Aufruf abgerufen werden.

Gibt die ID des Elements an, das die Registerkarte des verwalteten Elements enthält.
ItemID True integer

Die ID des Elements, das die Registerkarte des verwalteten Elements enthält, kann über den GET Item List API-Aufruf abgerufen werden.

Gibt den in der Antwort erwarteten Medientyp an.
Accept string

Gibt den Medientyp an, den der Client in der Antwort erwartet. In diesem Fall fordert der Client die Antwort im Format der Massendaten betroffener Elemente im JSON-Format an.

request123
request123

Elementabschnittsliste

Ruft eine Liste aller Abschnitte auf der Registerkarte "Elementdetails" ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs zum Abrufen von Elementdetailsabschnitten an.
WorkspaceID True integer

Die ID des Arbeitsbereichs, für den Sie die Konfiguration der Elementdetailsektionen abrufen möchten, kann über den GET Workspace List API-Aufruf abgerufen werden.

Gibt zurück

Gegenstände
200_sections

Elementaktualisierungsdetails

Aktualisiert die Details eines bestimmten Elements, wobei alle details entfernt werden, die nicht angegeben sind.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs an, der das Element enthält.
WorkspaceID True integer

Die ID des Arbeitsbereichs, der das Element enthält, kann über den GET Workspace List API-Aufruf abgerufen werden.

Gibt die ID des Elements an, das Details aktualisiert werden soll.
ItemID True integer

Die ID des Elements, für das Sie Elementdetails aktualisieren möchten, kann über den GET Item List API-Aufruf abgerufen werden.

Gibt den Medientyp des Anforderungstexts an.
Content-Type string

Gibt den Medientyp des Anforderungstexts an. In diesem Fall wird erwartet, dass der Anforderungstext im JSON-Format vorliegt.

request123
request123

Elementaktualisierungsdetails - teilweise

Aktualisiert teilweise die Details eines bestimmten Elements, wobei alle nicht angegebenen Details beibehalten werden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs an, der das Element enthält.
WorkspaceID True integer

Die ID des Arbeitsbereichs, der das Element enthält, kann über den GET Workspace List API-Aufruf abgerufen werden.

Gibt die ID des Elements an, das Details aktualisiert werden soll.
ItemID True integer

Die ID des Elements, für das Sie Elementdetails aktualisieren möchten, kann über den GET Item List API-Aufruf abgerufen werden.

Gibt den Medientyp des Anforderungstexts an.
Content-Type string

Gibt den Medientyp des Anforderungstexts an. In diesem Fall wird erwartet, dass der Anforderungstext im JSON-Format vorliegt.

request123
request123

Elementbeziehungen-Liste

Ruft eine Liste aller Beziehungselemente ab, die einem bestimmten Element zugeordnet sind.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs an, der das Element enthält.
WorkspaceID True integer

Die ID des Arbeitsbereichs, der das Element enthält, kann über den GET Workspace List API-Aufruf abgerufen werden.

Gibt die ID des Elements an, das die Registerkarte "Beziehungen" enthält.
ItemID True integer

Die ID des Elements, das die Registerkarte "Beziehungen" enthält, kann über den GET Item List API-Aufruf abgerufen werden.

Gibt zurück

Elementbeziehungselement erstellen

Erstellt eine neue Beziehung für ein bestimmtes Element.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs an, der das Element enthält.
WorkspaceID True integer

Die ID des Arbeitsbereichs, der das Element enthält, kann über den GET Workspace List API-Aufruf abgerufen werden.

Gibt die ID des Elements zum Erstellen einer neuen Beziehung an.
ItemID True integer

Die ID des Elements, für das Sie eine neue Beziehung erstellen (verknüpfen sie mit einem anderen Element), kann über den GET Item List API-Aufruf abgerufen werden.

Gibt die Position eines bestimmten Elements innerhalb eines Arbeitsbereichs an.
content-location string

Gibt die Position eines bestimmten Elements innerhalb eines Arbeitsbereichs an. Der Wert enthält Platzhalter wie :WorkspaceID und :ItemID, die durch tatsächliche IDs ersetzt werden müssen.

request123
request123

Elementbeziehungselementdetails V1

Ruft eine Liste der Beziehungen für ein bestimmtes Element ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs an, der die Elemente enthält.
WorkspaceID True integer

Die ID des Arbeitsbereichs, der die Elemente enthält, kann über den GET Workspace List API-Aufruf abgerufen werden.

Gibt die ID des Elements an, um Beziehungsdetails abzurufen.
ItemID True integer

Die ID des Elements, für das Sie Beziehungsdetails abrufen möchten, kann über den GET Item List API-Aufruf abgerufen werden.

Gibt die Seitenzahl für den Ergebnisabruf an.
page string

Gibt die Seitenzahl der abzurufenden Ergebnisse an. Wird zum Paginieren durch große Datasets verwendet.

Gibt die Anzahl der Elemente pro Seite in einer paginierten Antwort an.
size string

Gibt die Anzahl der Elemente an, die pro Seite in einer paginierten Antwort zurückgegeben werden sollen. Auf diese Weise können Clients die Größe des Resultsets steuern.

Gibt das Feld an, das zum Sortieren der Ergebnisse verwendet wird.
sort string

Gibt das Feld an, nach dem die Ergebnisse sortiert werden sollen. Beispiel: 'createdOn' zum Sortieren nach Erstellungsdatum.

Gibt die Sortierrichtung der Ergebnisse an.
sortDirection string

Gibt die Sortierrichtung an. Verwenden Sie 'ASC' für aufsteigende und 'DESC' für absteigend. Beispiel: "ASC", um in aufsteigender Reihenfolge zu sortieren.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.list.properties.item-relationship.items.properties.description.type string
type
properties.list.properties.item-relationship.items.properties.direction.properties.label.type string
type
properties.list.properties.item-relationship.items.properties.direction.properties.value.type string
type
properties.list.properties.item-relationship.items.properties.direction.type string
type
properties.list.properties.item-relationship.items.properties.item.properties.description.type string
type
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.deleted.type string
type
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.dmsID.type string
type
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.latest.type string
type
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.lifecycleState.properties.effectivity.type string
type
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.lifecycleState.properties.stateID.type string
type
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.lifecycleState.properties.stateName.type string
type
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.lifecycleState.type string
type
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.timeStamp.type string
type
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.version.type string
type
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.versionID.type string
type
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.workflowState.properties.stateId.type string
type
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.workflowState.properties.stateName.type string
type
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.workflowState.type string
type
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.working.type string
type
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.workspaceID.type string
type
properties.list.properties.item-relationship.items.properties.item.properties.details.type string
type
properties.list.properties.item-relationship.items.properties.item.properties.id.type string
type
properties.list.properties.item-relationship.items.properties.item.properties.metaFields.items.properties.fieldData.properties.dataType.type string
type
properties.list.properties.item-relationship.items.properties.item.properties.metaFields.items.properties.fieldData.properties.value.type string
type
properties.list.properties.item-relationship.items.properties.item.properties.metaFields.items.properties.fieldData.type string
type
properties.list.properties.item-relationship.items.properties.item.properties.metaFields.items.properties.key.type string
required
properties.list.properties.item-relationship.items.properties.item.properties.metaFields.items.required array of string
type
properties.list.properties.item-relationship.items.properties.item.properties.metaFields.items.type string
type
properties.list.properties.item-relationship.items.properties.item.properties.metaFields.type string
type
properties.list.properties.item-relationship.items.properties.item.properties.uri.type string
type
properties.list.properties.item-relationship.items.properties.item.type string
type
properties.list.properties.item-relationship.items.properties.type.properties.label.type string
type
properties.list.properties.item-relationship.items.properties.type.properties.value.type string
type
properties.list.properties.item-relationship.items.properties.type.type string
required
properties.list.properties.item-relationship.items.required array of string
type
properties.list.properties.item-relationship.items.type string
type
properties.list.properties.item-relationship.type string
type
properties.list.type string
type
type string

Elementdetails

Ruft detaillierte Informationen zu einem bestimmten Element ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs an, der das Element enthält.
WorkspaceID True integer

Die ID des Arbeitsbereichs, der das Element enthält, kann über den GET Workspace List API-Aufruf abgerufen werden.

Gibt die ID des Elements an, um Details abzurufen.
ItemID True integer

Die ID des Elements, für das Sie Details abrufen möchten, kann über den GET Item List API-Aufruf abgerufen werden.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.__self__.type string
type
properties.audit.properties.deleted.type string
type
properties.audit.properties.link.type string
type
properties.audit.type string
type
properties.bom.properties.deleted.type string
type
properties.bom.properties.link.type string
type
properties.bom.type string
type
properties.currentState.properties.deleted.type string
type
properties.currentState.properties.link.type string
type
properties.currentState.properties.title.type string
type
properties.currentState.properties.urn.type string
type
properties.currentState.type string
type
properties.deleted.type string
type
properties.flatBom.properties.deleted.type string
type
properties.flatBom.properties.link.type string
type
properties.flatBom.type string
type
properties.itemLocked.type string
type
properties.latestRelease.type string
type
properties.lifecycle.properties.deleted.type string
type
properties.lifecycle.properties.link.type string
type
properties.lifecycle.properties.title.type string
type
properties.lifecycle.properties.urn.type string
type
properties.lifecycle.type string
type
properties.milestones.properties.deleted.type string
type
properties.milestones.properties.link.type string
type
properties.milestones.type string
type
properties.nestedBom.properties.count.type string
type
properties.nestedBom.properties.deleted.type string
type
properties.nestedBom.properties.link.type string
type
properties.nestedBom.type string
type
properties.owners.properties.deleted.type string
type
properties.owners.properties.link.type string
type
properties.owners.type string
type
properties.revertible.type string
type
properties.root.properties.deleted.type string
type
properties.root.properties.link.type string
type
properties.root.properties.title.type string
type
properties.root.properties.urn.type string
type
properties.root.type string
type
properties.sections.items.properties.fields.items.properties.__self__.type string
type
properties.sections.items.properties.fields.items.properties.defaultValue.type string
type
properties.sections.items.properties.fields.items.properties.formulaField.type string
type
properties.sections.items.properties.fields.items.properties.isSystemField.type string
type
properties.sections.items.properties.fields.items.properties.title.type string
type
properties.sections.items.properties.fields.items.properties.type.properties.deleted.type string
type
properties.sections.items.properties.fields.items.properties.type.properties.link.type string
type
properties.sections.items.properties.fields.items.properties.type.properties.title.type string
type
properties.sections.items.properties.fields.items.properties.type.properties.urn.type string
type
properties.sections.items.properties.fields.items.properties.type.type string
type
properties.sections.items.properties.fields.items.properties.urn.type string
type
properties.sections.items.properties.fields.items.properties.value.type string
required
properties.sections.items.properties.fields.items.required array of string
type
properties.sections.items.properties.fields.items.type string
type
properties.sections.items.properties.fields.type string
type
properties.sections.items.properties.link.type string
type
properties.sections.items.properties.sectionLocked.type string
type
properties.sections.items.properties.title.type string
required
properties.sections.items.required array of string
type
properties.sections.items.type string
type
properties.sections.type string
type
properties.sectionsLink.type string
type
properties.title.type string
type
properties.urn.type string
type
properties.whereUsed.properties.count.properties.type.type string
type
properties.whereUsed.properties.count.properties.value.type string
type
properties.whereUsed.properties.count.type string
type
properties.whereUsed.properties.link.type string
type
properties.whereUsed.type string
type
properties.workflowReference.type string
type
properties.workingHasChanged.type string
type
properties.workingVersion.type string
type
properties.workspace.properties.deleted.type string
type
properties.workspace.properties.link.type string
type
properties.workspace.properties.title.type string
type
properties.workspace.properties.type.type string
type
properties.workspace.properties.urn.type string
type
properties.workspace.type string
type
type string

Elementfelddetails

Zeigt detaillierte Informationen zum angegebenen Feld in einem Elementraster an.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs an, der die Elemente enthält.
WorkspaceID True integer

Die ID des Arbeitsbereichs, der die Elemente enthält, kann über den GET Workspace List API-Aufruf abgerufen werden.

Gibt die ID des Rasterfelds für den Detailabruf an.
FieldID True integer

Die ID des Rasterfelds, für das Sie Details abrufen möchten.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.__self__.type string
type
properties.defaultValue.type string
type
properties.description.type string
type
properties.label.type string
type
properties.type.properties.deleted.type string
type
properties.type.properties.link.type string
type
properties.type.properties.title.type string
type
properties.type.properties.urn.type string
type
properties.type.type string
type
properties.urn.type string
type
type string

Elementfeldtypen

Stellt eine Liste aller verfügbaren Feldtypen bereit.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.field-types.items.properties.deleted.type string
type
properties.field-types.items.properties.link.type string
type
properties.field-types.items.properties.title.type string
type
properties.field-types.items.properties.urn.type string
required
properties.field-types.items.required array of string
type
properties.field-types.items.type string
type
properties.field-types.type string
type
type string

Elementlistenfelder

Ruft eine Liste aller Felder innerhalb des Rasters ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs für den Abruf von Rasterfelddetails an.
WorkspaceID True integer

Die ID des Arbeitsbereichs, für den Sie Rasterfelddetails abrufen möchten, können über den GET Workspace List API-Aufruf abgerufen werden.

Gibt den in der Antwort erwarteten Medientyp an.
Accept string

Gibt den Medientyp an, den der Client in der Antwort erwartet. In diesem Fall fordert der Client die Antwort im JSON-Format an.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.__self__.type string
type
properties.fields.items.properties.__self__.type string
defaultValue
properties.fields.items.properties.defaultValue object
type
properties.fields.items.properties.derived.type string
type
properties.fields.items.properties.description.type string
type
properties.fields.items.properties.displayLength.type string
type
properties.fields.items.properties.displayOrder.type string
type
properties.fields.items.properties.editability.type string
fieldLength
properties.fields.items.properties.fieldLength object
fieldPrecision
properties.fields.items.properties.fieldPrecision object
fieldValidators
properties.fields.items.properties.fieldValidators object
type
properties.fields.items.properties.formulaField.type string
Eigenschaften
properties.fields.items.properties.gridFieldAggregationInfo.properties object
type
properties.fields.items.properties.gridFieldAggregationInfo.type string
label
properties.fields.items.properties.label object
type
properties.fields.items.properties.name.type string
type
properties.fields.items.properties.picklist.type string
type
properties.fields.items.properties.picklistFieldDefinition.type string
type
properties.fields.items.properties.type.properties.deleted.type string
type
properties.fields.items.properties.type.properties.link.type string
type
properties.fields.items.properties.type.properties.title.type string
type
properties.fields.items.properties.type.properties.urn.type string
type
properties.fields.items.properties.type.type string
Maßeinheit
properties.fields.items.properties.unitOfMeasure object
type
properties.fields.items.properties.urn.type string
Validatoren
properties.fields.items.properties.validators object
type
properties.fields.items.properties.visibility.type string
visibleOnPreview
properties.fields.items.properties.visibleOnPreview object
required
properties.fields.items.required array of string
type
properties.fields.items.type string
type
properties.fields.type string
type
type string

Elementprotokoll

Ruft detaillierte Protokollinformationen für ein bestimmtes Element ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs an, der das Element enthält.
WorkspaceID True integer

Die ID des Arbeitsbereichs, der das Element enthält, kann über den GET Workspace List API-Aufruf abgerufen werden.

Gibt die ID des Elements an, für das ein Protokoll abgerufen werden soll.
ItemID True integer

Die ID des Elements, für das Sie ein Protokoll abrufen möchten, kann über den GET Item List API-Aufruf abgerufen werden.

Gibt den Startindex zum Abrufen von Elementen in einem paginierten Resultset an.
offset string

Gibt den Ausgangspunkt oder Index an, aus dem Elemente in einem paginierten Resultset abgerufen werden sollen. Nützlich, um eine bestimmte Anzahl von Elementen in der Liste zu überspringen.

Gibt die maximale Anzahl von Elementen an, die in der Antwort zurückgegeben werden sollen.
limit string

Gibt die maximale Anzahl von Elementen an, die in der Antwort zurückgegeben werden sollen. Dies wird verwendet, um die Größe des Resultsets einzuschränken.

Gibt das Zu sortierende Feld in aufsteigender Reihenfolge an.
asc string

Gibt das Feld an, nach dem die Ergebnisse in aufsteigender Reihenfolge sortiert werden sollen. Wenn Sie z. B. "timeStamp" verwenden, werden die Ergebnisse nach dem Zeitpunkt sortiert, zu dem sie erstellt oder geändert wurden.

Gibt das Zu sortierende Feld in absteigender Reihenfolge an.
desc string

Gibt das Feld an, nach dem die Ergebnisse in absteigender Reihenfolge sortiert werden sollen. Wenn Sie z. B. "timeStamp" verwenden, werden die Ergebnisse nach dem Zeitpunkt sortiert, zu dem sie erstellt oder geändert wurden.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.__self__.type string
type
properties.first.properties.count.type string
type
properties.first.properties.deleted.type string
type
properties.first.properties.link.type string
type
properties.first.properties.title.type string
type
properties.first.type string
type
properties.items.items.properties.__self__.type string
longName
properties.items.items.properties.action.properties.longName object
notifyPermission
properties.items.items.properties.action.properties.notifyPermission object
type
properties.items.items.properties.action.properties.shortName.type string
type
properties.items.items.properties.action.type string
type
properties.items.items.properties.actionInvoker.type string
type
properties.items.items.properties.description.type string
type
properties.items.items.properties.details.type string
type
properties.items.items.properties.timeStamp.type string
type
properties.items.items.properties.urn.type string
type
properties.items.items.properties.user.properties.email.type string
type
properties.items.items.properties.user.properties.image.properties.large.type string
type
properties.items.items.properties.user.properties.image.properties.medium.type string
type
properties.items.items.properties.user.properties.image.properties.small.type string
type
properties.items.items.properties.user.properties.image.type string
type
properties.items.items.properties.user.properties.link.type string
type
properties.items.items.properties.user.properties.status.type string
type
properties.items.items.properties.user.properties.title.type string
type
properties.items.items.properties.user.properties.urn.type string
type
properties.items.items.properties.user.type string
required
properties.items.items.required array of string
type
properties.items.items.type string
type
properties.items.type string
type
properties.last.properties.count.type string
type
properties.last.properties.deleted.type string
type
properties.last.properties.link.type string
type
properties.last.properties.title.type string
type
properties.last.type string
type
properties.limit.type string
type
properties.next.properties.count.type string
type
properties.next.properties.deleted.type string
type
properties.next.properties.link.type string
type
properties.next.properties.title.type string
type
properties.next.type string
type
properties.offset.type string
type
properties.totalCount.type string
type
type string

Elementrasterzeilen

Ruft eine Liste von Zeilen und Feldern für ein bestimmtes Element ab, einschließlich ihrer Werte.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs an, der die Elemente enthält.
WorkspaceID True integer

Die ID des Arbeitsbereichs, der die Elemente enthält, kann über den GET Workspace List API-Aufruf abgerufen werden.

Gibt die ID des Elements an, um Details abzurufen.
ItemID True integer

Die ID des Elements, für das Sie Details abrufen möchten, kann über den GET Item List API-Aufruf abgerufen werden.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.aggregations.items.properties.__self__.type string
type
properties.aggregations.items.properties.isSystemField.type string
type
properties.aggregations.items.properties.title.type string
type
properties.aggregations.items.properties.type.properties.deleted.type string
type
properties.aggregations.items.properties.type.properties.link.type string
type
properties.aggregations.items.properties.type.properties.title.type string
type
properties.aggregations.items.properties.type.properties.urn.type string
type
properties.aggregations.items.properties.type.type string
type
properties.aggregations.items.properties.urn.type string
type
properties.aggregations.items.properties.value.type string
required
properties.aggregations.items.required array of string
type
properties.aggregations.items.type string
type
properties.aggregations.type string
Eigenschaften
properties.rows.items.properties.metaFieldTableBean.properties.dataMap.properties object
type
properties.rows.items.properties.metaFieldTableBean.properties.dataMap.type string
type
properties.rows.items.properties.metaFieldTableBean.type string
type
properties.rows.items.properties.rowData.items.properties.__self__.type string
type
properties.rows.items.properties.rowData.items.properties.formulaField.type string
type
properties.rows.items.properties.rowData.items.properties.isSystemField.type string
type
properties.rows.items.properties.rowData.items.properties.title.type string
type
properties.rows.items.properties.rowData.items.properties.type.properties.deleted.type string
type
properties.rows.items.properties.rowData.items.properties.type.properties.link.type string
type
properties.rows.items.properties.rowData.items.properties.type.properties.urn.type string
type
properties.rows.items.properties.rowData.items.properties.type.type string
type
properties.rows.items.properties.rowData.items.properties.urn.type string
type
properties.rows.items.properties.rowData.items.properties.value.type string
required
properties.rows.items.properties.rowData.items.required array of string
type
properties.rows.items.properties.rowData.items.type string
type
properties.rows.items.properties.rowData.type string
type
properties.rows.items.properties.rowID.type string
required
properties.rows.items.required array of string
type
properties.rows.items.type string
type
properties.rows.type string
type
type string

Elementrasterzeilenaktualisierung

Aktualisiert eine oder mehrere Zeilen für ein bestimmtes Element.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs an, der die Elemente enthält.
WorkspaceID True integer

Die ID des Arbeitsbereichs, der die Elemente enthält, kann über den GET Workspace List API-Aufruf abgerufen werden.

Gibt die ID des Elements an, das die Rasterregisterkarte enthält.
ItemID True integer

Die ID des Elements, das die Rasterregisterkarte enthält, kann über den GET Item List API-Aufruf abgerufen werden.

Gibt die ID der zu aktualisierenden Zeile an.
RowID True integer

Die ID der Zeile, die Sie aktualisieren möchten.

Gibt den Medientyp des Anforderungstexts an.
Content-Type string

Gibt den Medientyp des Anforderungstexts an. In diesem Fall wird erwartet, dass der Anforderungstext im JSON-Format vorliegt.

request123
request123

Elementänderungsprotokoll

Ruft detaillierte Informationen zu Änderungen ab, die an einem bestimmten Element vorgenommen wurden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs an, der das Element enthält.
WorkspaceID True integer

Die ID des Arbeitsbereichs, der das Element enthält, kann über den GET Workspace List API-Aufruf abgerufen werden.

Gibt die ID des Elements an, um ein Protokoll abzurufen.
ItemID True integer

Die ID des Elements, für das Sie ein Protokoll abrufen möchten, kann über den GET Item List API-Aufruf abgerufen werden.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.__self__.type string
type
properties.first.properties.count.type string
type
properties.first.properties.deleted.type string
type
properties.first.properties.link.type string
type
properties.first.properties.title.type string
type
properties.first.type string
type
properties.items.items.properties.__self__.type string
longName
properties.items.items.properties.action.properties.longName object
type
properties.items.items.properties.action.properties.notifyPermission.properties.deleted.type string
type
properties.items.items.properties.action.properties.notifyPermission.properties.link.type string
type
properties.items.items.properties.action.properties.notifyPermission.properties.title.type string
type
properties.items.items.properties.action.properties.notifyPermission.properties.urn.type string
type
properties.items.items.properties.action.properties.notifyPermission.type string
type
properties.items.items.properties.action.properties.shortName.type string
type
properties.items.items.properties.action.type string
type
properties.items.items.properties.actionInvoker.type string
type
properties.items.items.properties.description.type string
FeldName
properties.items.items.properties.details.items.properties.fieldName object
type
properties.items.items.properties.details.items.properties.newValue.type string
oldValue
properties.items.items.properties.details.items.properties.oldValue object
type
properties.items.items.properties.details.items.properties.type.properties.deleted.type string
type
properties.items.items.properties.details.items.properties.type.properties.link.type string
type
properties.items.items.properties.details.items.properties.type.properties.urn.type string
type
properties.items.items.properties.details.items.properties.type.type string
required
properties.items.items.properties.details.items.required array of string
type
properties.items.items.properties.details.items.type string
type
properties.items.items.properties.details.type string
type
properties.items.items.properties.timeStamp.type string
type
properties.items.items.properties.urn.type string
type
properties.items.items.properties.user.properties.email.type string
type
properties.items.items.properties.user.properties.image.properties.large.type string
type
properties.items.items.properties.user.properties.image.properties.medium.type string
type
properties.items.items.properties.user.properties.image.properties.small.type string
type
properties.items.items.properties.user.properties.image.type string
type
properties.items.items.properties.user.properties.link.type string
type
properties.items.items.properties.user.properties.status.type string
type
properties.items.items.properties.user.properties.title.type string
type
properties.items.items.properties.user.properties.urn.type string
type
properties.items.items.properties.user.type string
required
properties.items.items.required array of string
type
properties.items.items.type string
type
properties.items.type string
type
properties.last.properties.count.type string
type
properties.last.properties.deleted.type string
type
properties.last.properties.link.type string
type
properties.last.properties.title.type string
type
properties.last.type string
type
properties.limit.type string
type
properties.next.properties.count.type string
type
properties.next.properties.deleted.type string
type
properties.next.properties.link.type string
type
properties.next.properties.title.type string
type
properties.next.type string
type
properties.offset.type string
type
properties.totalCount.type string
type
type string

Elementübergang

Führt einen Übergang für ein bestimmtes Element aus. Gibt 403 zurück, auch wenn dies erfolgreich war.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs an, der das Element enthält.
WorkspaceID True integer

Die ID des Arbeitsbereichs, der das Element enthält, kann über den GET Workspace List API-Aufruf abgerufen werden.

Gibt die ID des Elements zum Ausführen eines Übergangs an.
ItemID True integer

Die ID des Elements, für das Sie einen Übergang durchführen möchten, kann über den GET Item List API-Aufruf abgerufen werden.

Gibt die ID des auszuführenden Workflowübergangs an.
WorkflowID True integer

Die ID des Workflowübergangs, den Sie ausführen möchten.

Gibt den Speicherort der Ressource oder des Inhalts an.
content-location True string

Gibt den Speicherort der Ressource oder des Inhalts an. Dies muss eine gültige URL oder ein gültiger Pfad sein, von der der Inhalt gehostet oder abgerufen wird.

request123
request123

Gruppendetails

Ruft detaillierte Informationen zu einer bestimmten Gruppe ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID der Gruppe an, um Details abzurufen.
GroupID True integer

Die ID der Gruppe, für die Sie Details abrufen möchten, kann über den GET Groups List API-Aufruf abgerufen werden.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.__self__.type string
type
properties.exclusiveGroup.type string
type
properties.isSystemManaged.type string
type
properties.mappedToOxygen.type string
type
properties.minUserCount.type string
type
properties.restrictIp.type string
type
properties.shortName.type string
type
properties.urn.type string
type
type string

Gruppenliste

Ruft eine Liste aller im Mandanten verfügbaren Gruppen ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt den Index an, der mit dem Abrufen von Elementen aus einem paginierten Resultset beginnt.
offset string

Gibt den Ausgangspunkt oder Index an, aus dem Elemente in einem paginierten Resultset abgerufen werden sollen. Nützlich, um eine bestimmte Anzahl von Elementen in der Liste zu überspringen.

Gibt die maximale Anzahl von Elementen an, die in der Antwort zurückgegeben werden sollen.
limit string

Gibt die maximale Anzahl von Elementen an, die in der Antwort zurückgegeben werden sollen. Dies wird verwendet, um die Größe des Resultsets einzuschränken.

Sortiert die Ergebnisse alphabetisch in aufsteigender oder absteigender Reihenfolge.
sort string

Sortiert die Ergebnisse alphabetisch entweder aufsteigend oder absteigend je nach angegebenem Wert.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.__self__.type string
type
properties.groups.items.properties.__self__.type string
type
properties.groups.items.properties.exclusiveGroup.type string
type
properties.groups.items.properties.invariantName.type string
type
properties.groups.items.properties.isSystemManaged.type string
type
properties.groups.items.properties.longName.type string
type
properties.groups.items.properties.mappedToOxygen.type string
type
properties.groups.items.properties.minUserCount.type string
type
properties.groups.items.properties.restrictIp.type string
type
properties.groups.items.properties.shortName.type string
type
properties.groups.items.properties.urn.type string
required
properties.groups.items.required array of string
type
properties.groups.items.type string
type
properties.groups.type string
type
type string

Konfigurierte Arbeitsbereichsansichtsliste

Ruft eine Liste aller konfigurierten Ansichten für einen bestimmten Arbeitsbereich ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs an, der die konfigurierte Ansicht enthält.
WorkspaceID True integer

Die ID des Arbeitsbereichs, der die konfigurierte Ansicht enthält, kann über den GET Workspace List API-Aufruf abgerufen werden.

Gibt die ID eines Elements innerhalb des Arbeitsbereichs an.
ItemID True integer

Die ID eines Elements innerhalb des Arbeitsbereichs kann über den GET Item List API-Aufruf abgerufen werden.

Gibt zurück

Name Pfad Typ Beschreibung
type
items.properties.deleted.type string
type
items.properties.link.type string
type
items.properties.title.type string
type
items.properties.urn.type string
required
items.required array of string
type
items.type string
type
type string

Liste der Arbeitsbereichselementregisterkarten

Ruft eine Liste aller konfigurierten Registerkarten für einen bestimmten Arbeitsbereich ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs an, der das Element enthält.
WorkspaceID True integer

Die ID des Arbeitsbereichs, der das Element enthält, kann über den GET Workspace List API-Aufruf abgerufen werden.

Gibt die ID des Elements an, um die Registerkartenliste abzurufen.
ItemID True integer

Die ID des Elements, für das Sie eine Registerkartenliste abrufen möchten, kann über den GET Item List API-Aufruf abgerufen werden.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.__self__.type string
type
properties.tabs.items.properties.name.type string
sectionCounts
properties.tabs.items.properties.sectionCounts object
type
properties.tabs.items.properties.totalCount.type string
required
properties.tabs.items.required array of string
type
properties.tabs.items.type string
type
properties.tabs.type string
type
type string

Liste der Elementdetails

Ruft eine Liste aller felder ab, die auf der Registerkarte "Elementdetails" verfügbar sind.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs für den Abruf von Felddetails an.
WorkspaceID True integer

Die ID des Arbeitsbereichs, für den Sie Felddetails abrufen möchten, können über den GET Workspace List API-Aufruf abgerufen werden.

Gibt den in der Antwort erwarteten Medientyp an.
Accept string

Gibt den Medientyp an, den der Client in der Antwort erwartet. In diesem Fall fordert der Client die Antwort im JSON-Format an.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.__self__.type string
type
properties.fields.items.properties.__self__.type string
type
properties.fields.items.properties.defaultValue.type string
type
properties.fields.items.properties.derived.type string
type
properties.fields.items.properties.derivedFieldSource.properties.__self__.type string
type
properties.fields.items.properties.derivedFieldSource.properties.title.type string
type
properties.fields.items.properties.derivedFieldSource.properties.type.properties.deleted.type string
type
properties.fields.items.properties.derivedFieldSource.properties.type.properties.link.type string
type
properties.fields.items.properties.derivedFieldSource.properties.type.properties.title.type string
type
properties.fields.items.properties.derivedFieldSource.properties.type.properties.urn.type string
type
properties.fields.items.properties.derivedFieldSource.properties.type.type string
type
properties.fields.items.properties.derivedFieldSource.properties.urn.type string
type
properties.fields.items.properties.derivedFieldSource.type string
type
properties.fields.items.properties.derivedFields.items.properties.__self__.type string
type
properties.fields.items.properties.derivedFields.items.properties.title.type string
type
properties.fields.items.properties.derivedFields.items.properties.type.properties.deleted.type string
type
properties.fields.items.properties.derivedFields.items.properties.type.properties.link.type string
type
properties.fields.items.properties.derivedFields.items.properties.type.properties.title.type string
type
properties.fields.items.properties.derivedFields.items.properties.type.properties.urn.type string
type
properties.fields.items.properties.derivedFields.items.properties.type.type string
type
properties.fields.items.properties.derivedFields.items.properties.urn.type string
required
properties.fields.items.properties.derivedFields.items.required array of string
type
properties.fields.items.properties.derivedFields.items.type string
type
properties.fields.items.properties.derivedFields.type string
type
properties.fields.items.properties.description.type string
displayLength
properties.fields.items.properties.displayLength object
type
properties.fields.items.properties.displayOrder.type string
type
properties.fields.items.properties.editability.type string
fieldLength
properties.fields.items.properties.fieldLength object
fieldPrecision
properties.fields.items.properties.fieldPrecision object
fieldValidators
properties.fields.items.properties.fieldValidators array of string
type
properties.fields.items.properties.formulaField.type string
label
properties.fields.items.properties.label object
type
properties.fields.items.properties.name.type string
Auswahlliste
properties.fields.items.properties.picklist object
picklistFieldDefinition
properties.fields.items.properties.picklistFieldDefinition object
type
properties.fields.items.properties.pivotLink.type string
type
properties.fields.items.properties.type.properties.deleted.type string
type
properties.fields.items.properties.type.properties.link.type string
type
properties.fields.items.properties.type.properties.title.type string
type
properties.fields.items.properties.type.properties.urn.type string
type
properties.fields.items.properties.type.type string
Maßeinheit
properties.fields.items.properties.unitOfMeasure object
type
properties.fields.items.properties.urn.type string
Validatoren
properties.fields.items.properties.validators object
type
properties.fields.items.properties.visibility.type string
type
properties.fields.items.properties.visibleOnPreview.type string
required
properties.fields.items.required array of string
type
properties.fields.items.type string
type
properties.fields.type string
type
type string

Liste der verwalteten Elemente für Elemente

Ruft eine Liste der verwalteten Elemente ab, die einem bestimmten Element zugeordnet sind.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs an, der das Element enthält.
WorkspaceID True integer

Die ID des Arbeitsbereichs, der das Element enthält, kann über den GET Workspace List API-Aufruf abgerufen werden.

Gibt die ID des Elements an, das die Registerkarte des verwalteten Elements enthält.
ItemID True integer

Die ID des Elements, das die Registerkarte des verwalteten Elements enthält, kann über den GET Item List API-Aufruf abgerufen werden.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.__self__.type string
type
properties.affectedItems.items.properties.__self__.type string
type
properties.affectedItems.items.properties.item.properties.deleted.type string
type
properties.affectedItems.items.properties.item.properties.link.type string
type
properties.affectedItems.items.properties.item.properties.title.type string
type
properties.affectedItems.items.properties.item.properties.urn.type string
type
properties.affectedItems.items.properties.item.type string
type
properties.affectedItems.items.properties.linkedFields.items.properties.__self__.type string
type
properties.affectedItems.items.properties.linkedFields.items.properties.isSystemField.type string
type
properties.affectedItems.items.properties.linkedFields.items.properties.title.type string
type
properties.affectedItems.items.properties.linkedFields.items.properties.type.properties.deleted.type string
type
properties.affectedItems.items.properties.linkedFields.items.properties.type.properties.link.type string
type
properties.affectedItems.items.properties.linkedFields.items.properties.type.properties.title.type string
type
properties.affectedItems.items.properties.linkedFields.items.properties.type.properties.urn.type string
type
properties.affectedItems.items.properties.linkedFields.items.properties.type.type string
type
properties.affectedItems.items.properties.linkedFields.items.properties.uom.type string
type
properties.affectedItems.items.properties.linkedFields.items.properties.uomConverted.type string
type
properties.affectedItems.items.properties.linkedFields.items.properties.urn.type string
type
properties.affectedItems.items.properties.linkedFields.items.properties.value.type string
required
properties.affectedItems.items.properties.linkedFields.items.required array of string
type
properties.affectedItems.items.properties.linkedFields.items.type string
type
properties.affectedItems.items.properties.linkedFields.type string
type
properties.affectedItems.items.properties.type.type string
type
properties.affectedItems.items.properties.urn.type string
required
properties.affectedItems.items.required array of string
type
properties.affectedItems.items.type string
type
properties.affectedItems.type string
type
type string

Picklist-Details

Ruft Details von Picklist-Nachschlagevorgängen ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die benutzerdefinierte ID der Auswahlliste/Suche für den Detailabruf an.
PicklistID True string

Die benutzerdefinierte ID der Auswahlliste/Suche, für die Sie Details abrufen möchten.

Gibt den Startindex zum Abrufen von Elementen in einem paginierten Resultset an.
offset string

Gibt den Ausgangspunkt oder Index an, aus dem Elemente in einem paginierten Resultset abgerufen werden sollen. Nützlich, um eine bestimmte Anzahl von Elementen in der Liste zu überspringen.

Gibt die maximale Anzahl von Elementen an, die in der Antwort zurückgegeben werden sollen.
limit string

Gibt die maximale Anzahl von Elementen an, die in der Antwort zurückgegeben werden sollen. Dies wird verwendet, um die Größe des Resultsets einzuschränken.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.__self__.type string
type
properties.first.properties.count.type string
type
properties.first.properties.deleted.type string
type
properties.first.properties.link.type string
type
properties.first.properties.title.type string
type
properties.first.properties.urn.type string
type
properties.first.type string
type
properties.items.items.properties.link.type string
type
properties.items.items.properties.title.type string
required
properties.items.items.required array of string
type
properties.items.items.type string
type
properties.items.type string
type
properties.last.properties.count.type string
type
properties.last.properties.deleted.type string
type
properties.last.properties.link.type string
type
properties.last.properties.title.type string
type
properties.last.properties.urn.type string
type
properties.last.type string
type
properties.limit.type string
type
properties.offset.type string
type
properties.totalCount.type string
type
properties.urn.type string
type
type string

Skript "Neu erstellen"

Erstellt ein neues Skript des angegebenen Typs.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt den Medientyp des Anforderungstexts an.
Content-Type True string

Gibt den Medientyp des Anforderungstexts an. In diesem Fall wird erwartet, dass der Anforderungstext im JSON-Format vorliegt.

request123
request123

Skriptdetails

Ruft den Inhalt und die Details eines bestimmten Skripts ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt den eindeutigen Bezeichner des Skripts an.
ScriptID True integer

Der eindeutige Bezeichner des Skripts, das abgerufen oder bearbeitet werden soll. Dies ist ein erforderlicher Parameter, und Sie müssen eine gültige ScriptID als ganze Zahl im Anforderungspfad angeben.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.__self__.type string
type
properties.code.type string
abhängigVon
properties.dependsOn array of string
type
properties.displayName.type string
type
properties.scriptType.type string
type
properties.uniqueName.type string
type
properties.urn.type string
type
properties.version.type string
type
type string

Skriptliste

Ruft eine Liste aller Skripts innerhalb des Mandanten ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt das Feld an, um die Ergebnisse zu sortieren.
orderBy string

Gibt das Feld an, nach dem die Ergebnisse sortiert werden sollen. Beispielsweise sortiert die Verwendung von "scriptType" die Ergebnisse basierend auf dem Skripttyp. Dieser Parameter funktioniert in Verbindung mit "asc" oder "desc", um die Sortierrichtung zu definieren.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.__self__.type string
type
properties.scripts.items.properties.__self__.type string
type
properties.scripts.items.properties.dependsOn.items.properties.deleted.type string
type
properties.scripts.items.properties.dependsOn.items.properties.link.type string
type
properties.scripts.items.properties.dependsOn.items.properties.title.type string
type
properties.scripts.items.properties.dependsOn.items.properties.urn.type string
required
properties.scripts.items.properties.dependsOn.items.required array of string
type
properties.scripts.items.properties.dependsOn.items.type string
type
properties.scripts.items.properties.dependsOn.type string
type
properties.scripts.items.properties.displayName.type string
type
properties.scripts.items.properties.scriptType.type string
type
properties.scripts.items.properties.uniqueName.type string
type
properties.scripts.items.properties.urn.type string
type
properties.scripts.items.properties.version.type string
required
properties.scripts.items.required array of string
type
properties.scripts.items.type string
type
properties.scripts.type string
type
type string

Suchwert im gesamten Mandanten

Sucht nach einem Wert für alle Elemente im gesamten Mandanten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt den Suchbegriff zum Abfragen von Mandantendaten an.
query string

Der zu verwendende Suchbegriff zum Abfragen der Mandantendaten.

Gibt die maximale Anzahl von Elementen an, die in der Antwort zurückgegeben werden sollen.
limit string

Gibt die maximale Anzahl von Elementen an, die in der Antwort zurückgegeben werden sollen. Dies wird verwendet, um die Größe des Resultsets einzuschränken.

Gibt die Sortierreihenfolge für die Ergebnisse an.
sort string

Gibt die Sortierreihenfolge für die Ergebnisse an. Verwenden Sie "asc" für aufsteigende und "desc" für absteigend. Beispiel: "createdOn asc" zum Sortieren nach Erstellungsdatum in aufsteigender Reihenfolge.

Gibt den in der Antwort erwarteten Medientyp an.
Accept string

Gibt den Medientyp an, den der Client in der Antwort erwartet. In diesem Fall fordert der Client die Antwort im Format von Massenelementendaten im JSON-Format an.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.__self__.type string
type
properties.first.properties.count.type string
type
properties.first.properties.deleted.type string
type
properties.first.properties.link.type string
type
properties.first.properties.title.type string
type
properties.first.type string
type
properties.items.items.properties.__self__.type string
type
properties.items.items.properties.audit.properties.deleted.type string
type
properties.items.items.properties.audit.properties.link.type string
type
properties.items.items.properties.audit.type string
type
properties.items.items.properties.bom.properties.deleted.type string
type
properties.items.items.properties.bom.properties.link.type string
type
properties.items.items.properties.bom.type string
type
properties.items.items.properties.currentState.properties.deleted.type string
type
properties.items.items.properties.currentState.properties.link.type string
type
properties.items.items.properties.currentState.properties.title.type string
type
properties.items.items.properties.currentState.properties.urn.type string
type
properties.items.items.properties.currentState.type string
type
properties.items.items.properties.deleted.type string
type
properties.items.items.properties.flatBom.properties.deleted.type string
type
properties.items.items.properties.flatBom.properties.link.type string
type
properties.items.items.properties.flatBom.type string
type
properties.items.items.properties.itemLocked.type string
type
properties.items.items.properties.latestRelease.type string
type
properties.items.items.properties.lifecycle.properties.deleted.type string
type
properties.items.items.properties.lifecycle.properties.link.type string
type
properties.items.items.properties.lifecycle.properties.title.type string
type
properties.items.items.properties.lifecycle.properties.urn.type string
type
properties.items.items.properties.lifecycle.type string
type
properties.items.items.properties.milestones.properties.deleted.type string
type
properties.items.items.properties.milestones.properties.link.type string
type
properties.items.items.properties.milestones.type string
type
properties.items.items.properties.nestedBom.properties.count.type string
type
properties.items.items.properties.nestedBom.properties.deleted.type string
type
properties.items.items.properties.nestedBom.properties.link.type string
type
properties.items.items.properties.nestedBom.type string
type
properties.items.items.properties.owners.properties.deleted.type string
type
properties.items.items.properties.owners.properties.link.type string
type
properties.items.items.properties.owners.type string
type
properties.items.items.properties.root.properties.deleted.type string
type
properties.items.items.properties.root.properties.link.type string
type
properties.items.items.properties.root.properties.title.type string
type
properties.items.items.properties.root.properties.urn.type string
type
properties.items.items.properties.root.type string
type
properties.items.items.properties.sections.items.properties.fields.items.properties.__self__.type string
type
properties.items.items.properties.sections.items.properties.fields.items.properties.defaultValue.type string
type
properties.items.items.properties.sections.items.properties.fields.items.properties.formulaField.type string
type
properties.items.items.properties.sections.items.properties.fields.items.properties.isSystemField.type string
type
properties.items.items.properties.sections.items.properties.fields.items.properties.title.type string
type
properties.items.items.properties.sections.items.properties.fields.items.properties.type.properties.deleted.type string
type
properties.items.items.properties.sections.items.properties.fields.items.properties.type.properties.link.type string
type
properties.items.items.properties.sections.items.properties.fields.items.properties.type.properties.title.type string
type
properties.items.items.properties.sections.items.properties.fields.items.properties.type.properties.urn.type string
type
properties.items.items.properties.sections.items.properties.fields.items.properties.type.type string
type
properties.items.items.properties.sections.items.properties.fields.items.properties.urn.type string
type
properties.items.items.properties.sections.items.properties.fields.items.properties.value.type string
required
properties.items.items.properties.sections.items.properties.fields.items.required array of string
type
properties.items.items.properties.sections.items.properties.fields.items.type string
type
properties.items.items.properties.sections.items.properties.fields.type string
type
properties.items.items.properties.sections.items.properties.link.type string
type
properties.items.items.properties.sections.items.properties.sectionLocked.type string
type
properties.items.items.properties.sections.items.properties.title.type string
required
properties.items.items.properties.sections.items.required array of string
type
properties.items.items.properties.sections.items.type string
type
properties.items.items.properties.sections.type string
type
properties.items.items.properties.sectionsLink.type string
type
properties.items.items.properties.title.type string
type
properties.items.items.properties.urn.type string
type
properties.items.items.properties.whereUsed.properties.count.properties.type.type string
type
properties.items.items.properties.whereUsed.properties.count.properties.value.type string
type
properties.items.items.properties.whereUsed.properties.count.type string
type
properties.items.items.properties.whereUsed.properties.link.type string
type
properties.items.items.properties.whereUsed.type string
type
properties.items.items.properties.workflowReference.type string
type
properties.items.items.properties.workingHasChanged.type string
type
properties.items.items.properties.workingVersion.type string
type
properties.items.items.properties.workspace.properties.deleted.type string
type
properties.items.items.properties.workspace.properties.link.type string
type
properties.items.items.properties.workspace.properties.title.type string
type
properties.items.items.properties.workspace.properties.type.type string
type
properties.items.items.properties.workspace.properties.urn.type string
type
properties.items.items.properties.workspace.type string
required
properties.items.items.required array of string
type
properties.items.items.type string
type
properties.items.type string
type
properties.last.properties.count.type string
type
properties.last.properties.deleted.type string
type
properties.last.properties.link.type string
type
properties.last.properties.title.type string
type
properties.last.type string
type
properties.limit.type string
type
properties.offset.type string
type
properties.totalCount.type string
type
type string

Verfügbare Übergänge

Ruft eine Liste der verfügbaren Übergänge für ein bestimmtes Element basierend auf dem angemeldeten Benutzer ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs zum Abrufen verfügbarer Übergänge an.
WorkspaceID True integer

Die ID des Arbeitsbereichs, für den Sie eine Liste der verfügbaren Übergänge abrufen möchten, kann über den GET Workspace List API-Aufruf abgerufen werden.

Gibt zurück

Name Pfad Typ Beschreibung
type
items.properties.__self__.type string
type
items.properties.actionScript.properties.deleted.type string
type
items.properties.actionScript.properties.link.type string
type
items.properties.actionScript.properties.title.type string
type
items.properties.actionScript.properties.urn.type string
type
items.properties.actionScript.type string
Genehmigenden
items.properties.approvers array of string
type
items.properties.comments.type string
type
items.properties.conditionScript.properties.deleted.type string
type
items.properties.conditionScript.properties.link.type string
type
items.properties.conditionScript.properties.title.type string
type
items.properties.conditionScript.properties.urn.type string
type
items.properties.conditionScript.type string
type
items.properties.customLabel.type string
delegatorUsers
items.properties.delegatorUsers array of string
type
items.properties.escalationPermission.properties.deleted.type string
type
items.properties.escalationPermission.properties.link.type string
type
items.properties.escalationPermission.properties.title.type string
type
items.properties.escalationPermission.properties.urn.type string
type
items.properties.escalationPermission.type string
type
items.properties.fromState.properties.deleted.type string
type
items.properties.fromState.properties.link.type string
type
items.properties.fromState.properties.title.type string
type
items.properties.fromState.properties.urn.type string
type
items.properties.fromState.type string
type
items.properties.hidden.type string
type
items.properties.ignoreEscalatedPreconditions.type string
type
items.properties.labelPositionA.type string
type
items.properties.labelPositionB.type string
type
items.properties.name.type string
type
items.properties.notifyPerformers.type string
type
items.properties.passwordEnabled.type string
type
items.properties.permission.properties.deleted.type string
type
items.properties.permission.properties.link.type string
type
items.properties.permission.properties.title.type string
type
items.properties.permission.properties.urn.type string
type
items.properties.permission.type string
Punkte
items.properties.points object
type
items.properties.sendEmail.type string
type
items.properties.showInOutstanding.type string
type
items.properties.toState.properties.deleted.type string
type
items.properties.toState.properties.link.type string
type
items.properties.toState.properties.title.type string
type
items.properties.toState.properties.urn.type string
type
items.properties.toState.type string
type
items.properties.urn.type string
type
items.properties.validationScript.properties.deleted.type string
type
items.properties.validationScript.properties.link.type string
type
items.properties.validationScript.properties.title.type string
type
items.properties.validationScript.properties.urn.type string
type
items.properties.validationScript.type string
type
items.properties.workspace.properties.deleted.type string
type
items.properties.workspace.properties.link.type string
type
items.properties.workspace.properties.title.type string
type
items.properties.workspace.properties.type.type string
type
items.properties.workspace.properties.urn.type string
type
items.properties.workspace.type string
required
items.required array of string
type
items.type string
type
type string

Version zum Erstellen von Anlagen

Erstellt eine neue Version einer vorhandenen Anlage.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs an, der das Element enthält.
WorkspaceID True integer

Die ID des Arbeitsbereichs, der das Element enthält, kann über den GET Workspace List API-Aufruf abgerufen werden.

Gibt die ID des Elements an, das die Anlage enthält.
ItemID True integer

Die ID des Elements, das die Anlage enthält, kann über den GET Item List API-Aufruf abgerufen werden.

Gibt die ID der Anlage an, um eine neue Version zu erstellen.
AttachmentID True integer

Die ID der Anlage, für die Sie eine neue Version erstellen möchten, kann über den GET Attachments List API-Aufruf abgerufen werden.

Gibt den Medientyp des Anforderungstexts an.
Content-Type string

Gibt den Medientyp des Anforderungstexts an. In diesem Fall wird erwartet, dass der Anforderungstext im JSON-Format vorliegt.

request123
request123

Verwaltete Elemente für Elemente

Ruft eine Liste der verwalteten Elemente ab, die einem bestimmten Element zugeordnet sind.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs an, um Details abzurufen.
WorkspaceID True integer

Die ID des Arbeitsbereichs, für den Sie Details abrufen möchten, können über den GET Workspace List API-Aufruf abgerufen werden.

Gibt die ID des Elements an, um Details abzurufen.
ItemID True integer

Die ID des Elements, für das Sie Details abrufen möchten, kann über den GET Item List API-Aufruf abgerufen werden.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.__self__.type string
type
properties.affectedItems.items.properties.__self__.type string
type
properties.affectedItems.items.properties.item.properties.deleted.type string
type
properties.affectedItems.items.properties.item.properties.link.type string
type
properties.affectedItems.items.properties.item.properties.title.type string
type
properties.affectedItems.items.properties.item.properties.urn.type string
type
properties.affectedItems.items.properties.item.type string
type
properties.affectedItems.items.properties.linkedFields.items.properties.__self__.type string
type
properties.affectedItems.items.properties.linkedFields.items.properties.isSystemField.type string
type
properties.affectedItems.items.properties.linkedFields.items.properties.title.type string
type
properties.affectedItems.items.properties.linkedFields.items.properties.type.properties.deleted.type string
type
properties.affectedItems.items.properties.linkedFields.items.properties.type.properties.link.type string
type
properties.affectedItems.items.properties.linkedFields.items.properties.type.properties.title.type string
type
properties.affectedItems.items.properties.linkedFields.items.properties.type.properties.urn.type string
type
properties.affectedItems.items.properties.linkedFields.items.properties.type.type string
type
properties.affectedItems.items.properties.linkedFields.items.properties.uom.type string
type
properties.affectedItems.items.properties.linkedFields.items.properties.uomConverted.type string
type
properties.affectedItems.items.properties.linkedFields.items.properties.urn.type string
type
properties.affectedItems.items.properties.linkedFields.items.properties.value.type string
required
properties.affectedItems.items.properties.linkedFields.items.required array of string
type
properties.affectedItems.items.properties.linkedFields.items.type string
type
properties.affectedItems.items.properties.linkedFields.type string
type
properties.affectedItems.items.properties.type.type string
type
properties.affectedItems.items.properties.urn.type string
required
properties.affectedItems.items.required array of string
type
properties.affectedItems.items.type string
type
properties.affectedItems.type string
type
type string

Zeile "Element erstellen"

Erstellt eine neue Zeile für ein bestimmtes Element im Raster.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs an, der das Element enthält.
WorkspaceID True integer

Die ID des Arbeitsbereichs, der das Element enthält, kann über den GET Workspace List API-Aufruf abgerufen werden.

Gibt die ID des Elements zum Erstellen einer Rasterzeile an.
ItemID True integer

Die ID des Elements, für das Sie eine Rasterzeile erstellen möchten, kann über den GET Item List API-Aufruf abgerufen werden.

Gibt den Medientyp des Anforderungstexts an.
Content-Type string

Gibt den Medientyp des Anforderungstexts an. In diesem Fall wird erwartet, dass der Anforderungstext im JSON-Format vorliegt.

request123
request123

Übergänge der Arbeitsbereichsliste

Ruft eine Liste der verfügbaren Übergänge für einen bestimmten Arbeitsbereich ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs zum Abrufen der Übergangsliste an.
WorkspaceID True integer

Die ID des Arbeitsbereichs, für den Sie eine Liste des Übergangs abrufen möchten, kann über den GET Workspace List API-Aufruf abgerufen werden.

Gibt die ID eines Elements innerhalb des Arbeitsbereichs an.
ItemID True integer

Die ID eines Elements innerhalb des Arbeitsbereichs kann über den GET Item List API-Aufruf abgerufen werden.

Gibt zurück

Name Pfad Typ Beschreibung
type
items.properties.__self__.type string
type
items.properties.actionScript.properties.deleted.type string
type
items.properties.actionScript.properties.link.type string
type
items.properties.actionScript.properties.title.type string
type
items.properties.actionScript.properties.urn.type string
type
items.properties.actionScript.type string
type
items.properties.approvers.type string
type
items.properties.comments.type string
type
items.properties.customLabel.type string
type
items.properties.delegatorUsers.type string
type
items.properties.escalationPermission.properties.deleted.type string
type
items.properties.escalationPermission.properties.link.type string
type
items.properties.escalationPermission.properties.title.type string
type
items.properties.escalationPermission.properties.urn.type string
type
items.properties.escalationPermission.type string
type
items.properties.fromState.properties.deleted.type string
type
items.properties.fromState.properties.link.type string
type
items.properties.fromState.properties.title.type string
type
items.properties.fromState.properties.urn.type string
type
items.properties.fromState.type string
type
items.properties.hidden.type string
type
items.properties.ignoreEscalatedPreconditions.type string
type
items.properties.labelPositionA.type string
type
items.properties.labelPositionB.type string
type
items.properties.name.type string
type
items.properties.notifyPerformers.type string
type
items.properties.passwordEnabled.type string
type
items.properties.permission.properties.deleted.type string
type
items.properties.permission.properties.link.type string
type
items.properties.permission.properties.title.type string
type
items.properties.permission.properties.urn.type string
type
items.properties.permission.type string
Punkte
items.properties.points object
type
items.properties.sendEmail.type string
type
items.properties.showInOutstanding.type string
type
items.properties.toState.properties.deleted.type string
type
items.properties.toState.properties.link.type string
type
items.properties.toState.properties.title.type string
type
items.properties.toState.properties.urn.type string
type
items.properties.toState.type string
type
items.properties.urn.type string
type
items.properties.workspace.properties.deleted.type string
type
items.properties.workspace.properties.link.type string
type
items.properties.workspace.properties.title.type string
type
items.properties.workspace.properties.type.type string
type
items.properties.workspace.properties.urn.type string
type
items.properties.workspace.type string
required
items.required array of string
type
items.type string
type
type string

Übersicht über die Registerkarte "Elemente"

Ruft eine Liste von Datensätzen und Feldern für eine bestimmte Registerkarte ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gibt die ID des Arbeitsbereichs an, der das Element enthält.
WorkspaceID True integer

Die ID des Arbeitsbereichs, der das Element enthält, kann über den GET Workspace List API-Aufruf abgerufen werden.

Gibt die ID des Elements zum Abrufen von Datensätzen und Feldern für eine Registerkarte/Ansicht an.
ItemID True integer

Die ID des Elements, für das Sie eine Liste von Datensätzen und Feldern für eine bestimmte Registerkarte/Ansicht abrufen möchten, kann über den GET Item List API-Aufruf abgerufen werden.

Gibt die ID der Registerkarte/Ansicht für den Detailabruf an.
ViewID True integer

Die ID der Registerkarte/Ansicht, für die Sie Details abrufen möchten.

Gibt zurück

Name Pfad Typ Beschreibung
type
properties.__self__.type string
type
properties.first.properties.count.type string
type
properties.first.properties.deleted.type string
type
properties.first.properties.link.type string
type
properties.first.properties.title.type string
type
properties.first.type string
type
properties.items.items.properties.__self__.type string
longName
properties.items.items.properties.action.properties.longName object
notifyPermission
properties.items.items.properties.action.properties.notifyPermission object
type
properties.items.items.properties.action.properties.shortName.type string
type
properties.items.items.properties.action.type string
type
properties.items.items.properties.actionInvoker.type string
type
properties.items.items.properties.description.type string
type
properties.items.items.properties.details.type string
type
properties.items.items.properties.timeStamp.type string
type
properties.items.items.properties.urn.type string
type
properties.items.items.properties.user.properties.email.type string
type
properties.items.items.properties.user.properties.image.properties.large.type string
type
properties.items.items.properties.user.properties.image.properties.medium.type string
type
properties.items.items.properties.user.properties.image.properties.small.type string
type
properties.items.items.properties.user.properties.image.type string
type
properties.items.items.properties.user.properties.link.type string
type
properties.items.items.properties.user.properties.status.type string
type
properties.items.items.properties.user.properties.title.type string
type
properties.items.items.properties.user.properties.urn.type string
type
properties.items.items.properties.user.type string
required
properties.items.items.required array of string
type
properties.items.items.type string
type
properties.items.type string
type
properties.last.properties.count.type string
type
properties.last.properties.deleted.type string
type
properties.last.properties.link.type string
type
properties.last.properties.title.type string
type
properties.last.type string
type
properties.limit.type string
type
properties.offset.type string
type
properties.totalCount.type string
type
type string

Definitionen

200_sections

Name Pfad Typ Beschreibung
name
name string
Beschreibung
description string
type
type string
displayOrder
displayOrder integer
sectionType
sectionType string
fields
fields array of object
link
fields.link string
Urne
fields.urn string
title
fields.title string
gelöscht
fields.deleted boolean
type
fields.type string
sectionLocked
sectionLocked boolean
pimSection
pimSection boolean
__selbst__
__self__ string
Urne
urn string
matrizen
matrices array of object
__selbst__
matrices.__self__ string
Urne
matrices.urn string
width
matrices.width integer
height
matrices.height integer
columnNames
matrices.columnNames array of string
rowNames
matrices.rowNames array of string
fields
matrices.fields array of array
items
matrices.fields array of object
link
matrices.fields.link string
Urne
matrices.fields.urn string
title
matrices.fields.title string
gelöscht
matrices.fields.deleted boolean
type
matrices.fields.type string

ApiV3Workspaces-WorkspaceID-Items-ItemID-Views10Get200ApplicationJsonResponse

Name Pfad Typ Beschreibung
Gegenstände
string