9A Raptor Dokumentenlager
Das 9A Raptor Document Warehouse ist eine leistungsstarke SaaS-Lösung, die Struktur und Kohärenz zu Informationen bringt, die über verschiedene Geschäftsanwendungen verteilt sind. Diese Lösung bietet eine einheitliche und sichere Möglichkeit, auf Dokumente zuzugreifen, sie zu verwalten und nach Dokumenten zu suchen.
Durch die Nutzung der Raptor-API können Sie Ihre Dokumentverwaltungsprozesse nahtlos automatisieren. Führen Sie verschiedene Aktionen aus, z. B. Hochladen, Herunterladen, Kategorisieren und Organisieren von Dokumenten.
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 | 9altitudes |
| URL | https://www.9altitudes.com |
| support@9altitudes.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | 9altitudes |
| Webseite | https://9altitudes.com |
| Datenschutzrichtlinie | https://www.9altitudes.com/privacy-policy |
| Kategorien | Inhalt und Dateien; Produktivität |
9A Raptor Document Warehouse Connector
Überblick
Mit dem 9A Raptor Document Warehouse Connector für Power Apps können Sie nahtlos in die 9A Raptor Document Warehouse-Plattform integriert werden, eine intelligente Lösung, die Informationen in verschiedenen Geschäftsanwendungen wie PLM, ERP, CRM und mehr konsolidiert und verwaltet. Mit diesem Connector können Sie Ihre Dokumentverwaltungsprozesse optimieren, indem Sie Dokumente über verschiedene Entitäten und Systeme hinweg verknüpfen und verwalten– alles in Power Apps.
Was ist 9A Raptor Document Warehouse?
Das 9A Raptor Document Warehouse ist ein leistungsfähiges Tool, das Struktur und Kohärenz zu Informationen bringt, die sich auf mehrere Geschäftsanwendungen verteilen. Unabhängig davon, ob es sich um Dokumente aus Dynamics 365, Teams oder benutzerdefinierten Power Platform-Anwendungen handelt, bietet diese Lösung eine einheitliche und sichere Möglichkeit, auf Dokumente zuzugreifen, sie zu verwalten und nach Dokumenten zu suchen. Es stellt sicher, dass Sie relevante Dokumente finden können, die mit jeder Entität verknüpft sind, unabhängig davon, wo sie ursprünglich erstellt oder gespeichert wurden.
Zu den wichtigsten Features von 9A Raptor Document Warehouse gehören:
- Konsolidierte Dokumentenverwaltung: Verwalten von Dokumenten in verschiedenen Anwendungen wie PLM, ERP, CRM und mehr.
- Dynamische Context-Based Sicherheit: Stellen Sie sicher, dass Dokumente nur für die richtigen Personen zugänglich sind, basierend auf Kontext- und Sicherheitsregeln.
- Systemübergreifende Integration: Verknüpfen von Dokumenten über verschiedene Geschäftssysteme hinweg und bieten eine einzige Quelle der Wahrheit.
- Erweiterte Suchfunktionen: Suchen und Filtern von Dokumenten mit mehreren Dimensionen, Speicherorten und Attributen.
API-Endpunkte
Der 9A Raptor Document Warehouse-Connector bietet einen umfassenden Satz von API-Endpunkten für die Interaktion mit der Plattform. Nachfolgend finden Sie eine Liste der verfügbaren Vorgänge:
Benutzerverwaltung
- GetUserToken: Abrufen eines Benutzertokens zum Authentifizieren von API-Anforderungen mithilfe eines externen Systems.
- GetUserById: Abrufen von Benutzerdetails anhand ihrer ID.
- QueryUsers: Suchen Sie anhand bestimmter Kriterien nach Benutzern.
Dokumentenverwaltung
- DownloadDocument: Laden Sie ein Dokument anhand ihrer ID herunter.
- UploadDocument: Hochladen eines Dokuments.
- RemoveTagFromDocument: Entfernen eines Tags aus einem Dokument.
- TagDocument: Hinzufügen eines Tags zu einem Dokument.
- AddFieldToDocument: Hinzufügen eines Felds zu einem Dokument.
- UpdateFieldOnDocument: Aktualisieren eines bestimmten Felds in einem Dokument.
- AddTemplateToDocument: Hinzufügen einer Vorlage zu einem Dokument.
- QueryDocuments: Suchen Sie anhand bestimmter Kriterien nach Dokumenten.
- AdvancedSearchQueryDocuments: Durchführen einer erweiterten Suchabfrage für Dokumente.
- InsertExternalFile: Laden Sie eine externe Datei in das Dokumentlager hoch.
- GetDocumentMetadata: Abrufen von Metadaten eines Dokuments.
- GetDocumentMetadataByFileReference: Abrufen von Dokumentmetadaten nach Dateiverweis.
- DeleteDocument: Löschen eines Dokuments anhand seiner ID.
Tagverwaltung
- GetTagByTagId: Abrufen eines Tags anhand seiner ID.
- GetTagByCode: Rufen Sie ein Tag anhand des Codes ab.
- GetMultipleTags: Abrufen mehrerer Tags basierend auf Kriterien.
- QueryTags: Suchen Sie anhand bestimmter Kriterien nach Tags.
Feldverwaltung
- CreateField: Erstellen eines neuen Felds für Dokumente.
- GetFieldById: Abrufen eines Felds anhand seiner ID.
- GetFieldByCode: Abrufen eines Felds anhand seines Codes.
- GetTemplateFields: Abrufen aller Felder, die einer Vorlage zugeordnet sind.
Vorlagenverwaltung
- GetTemplateById: Abrufen einer Vorlage anhand der ID.
- GetTemplateByCode: Abrufen einer Vorlage anhand des Codes.
- QueryTemplates: Suchen Sie mithilfe bestimmter Kriterien nach Vorlagen.
Speicherverwaltung
- AddSiteToStorageProvider: Hinzufügen einer Website zu einem Speicheranbieter.
- GetStorageProviderById: Abrufen eines Speicheranbieters anhand seiner ID.
- SetPrimaryStorageProviderOfDocument: Legen Sie den primären Speicheranbieter eines Dokuments fest.
- SetExternalSource: Legen Sie die externe Quelle eines Dokuments fest.
- GenerateSiteSubscription: Generieren eines Abonnements für eine Website.
- FindDocument: Suchen eines externen Dokuments.
- DetachDocument: Trennen Sie ein externes Dokument.
Systemintegration
- GetExternalSystemById: Rufen Sie Details eines externen Systems anhand der ID ab.
- ResolveContext: Auflösen eines Tags basierend auf dem Geschäftskontext.
Erste Schritte
Um mit der Verwendung des 9A Raptor Document Warehouse-Connectors in Ihren Power Apps-Lösungen zu beginnen, fügen Sie einfach den Connector zu Ihrer App hinzu, authentifizieren Sie sich mit Ihren Anmeldeinformationen für das externe System, und beginnen Sie mit der Verwendung der verfügbaren Aktionen und Trigger zum Verwalten von Dokumenten, Benutzern, Tags, Feldern, Vorlagen und mehr.
Conclusion
Der 9A Raptor Document Warehouse Connector für Power Apps ermöglicht es Ihnen, Dokumente und verwandte Entitäten in mehreren Geschäftssystemen effizient zu verwalten, um reibungslose Workflows und eine höhere Produktivität sicherzustellen. Mit leistungsstarken Suchfunktionen und dynamischer kontextbasierter Sicherheit können Sie sicherstellen, dass Ihre Dokumente immer zugänglich und sicher sind.
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Abfragen von Benutzern |
Alle Benutzer abfragen |
| Abfragen von Dokumenten |
Alle Dokumente abfragen |
| Abfragetags |
Alle Tags abfragen |
| Abfragevorlagen |
Alle Vorlagen abfragen |
| Abrufen des externen Systems nach ID |
Abrufen eines externen Systems durch die externe System-ID |
| Abrufen des Speicheranbieters nach ID |
Abrufen des Speicheranbieters mithilfe der Speicheranbieter-ID |
| Abrufen eines Benutzertokens |
Anfordern eines Benutzertokens zur Verwendung in Ihren Aktionen |
| Abrufen mehrerer Tags |
Abrufen mehrerer Markierungen |
| Abrufen oder Erstellen eines Tags |
Erstellt ein Tag oder ruft es ab, wenn ein Tag mit einem übereinstimmenden Code vorhanden ist. |
| Abrufen von Dokumentmetadaten |
Abrufen von Dokumentmetadaten mithilfe der Dokument-ID |
| Abrufen von Dokumentmetadaten nach Dateireferenz |
Abrufen von Dokumentmetadaten anhand einer Dateireferenz-ID |
| Benutzer nach ID abrufen |
Abrufen eines Benutzers anhand seiner ID |
| Dokument herunterladen |
Herunterladen eines Dokuments anhand der ID |
| Dokument hochladen |
Hochladen eines Dokuments in Raptor Document Warehouse |
| Dokument löschen |
Dokument anhand der ID löschen |
| Dokument suchen |
Suchen eines Dokuments mit SharePoint-Laufwerk-ID und Laufwerkelement-ID |
| Dokument trennen |
Verschieben der SharePoint-Datei in den Raptor-Speicher |
| Dokumentvorlage hinzufügen |
Hinzufügen einer Vorlage zu einem Dokument |
| Erstellen von Websiteabonnements |
Generieren eines Abonnements für eine Website ad-hoc |
| Erweiterte Suche |
Durchsuchen von Dokumenten mithilfe einer erweiterten Suchabfrage |
| Externe Datei einfügen |
Url der externen Datei als Dokument einfügen |
| Externe Quelle festlegen |
Festlegen der externen Quelle für filereference |
| Feld erstellen |
Erstellen eines neuen Felds |
| Feld im Dokument aktualisieren |
Aktualisieren eines Felds, das sich in einem Dokument befindet |
| Feld nach Code abrufen |
Abrufen eines Felds anhand des Codes |
| Feld nach ID abrufen |
Abrufen eines Felds nach der Feld-ID |
| Feld zum Dokument hinzufügen |
Hinzufügen eines Felds zu einem Dokument |
| Festlegen des primären Speicheranbieters für das Dokument |
Festlegen des primären Speicher-Providors für ein Dokument |
| Kontext auflösen |
Löst ein Tag mithilfe der Entitätskonfiguration auf. |
| Tag aus Dokument entfernen |
Entfernen eines Tags aus einem Dokument mithilfe einer Dokument-ID und Tag-ID |
| Tag nach Code abrufen |
Tag anhand des Codes abrufen |
| Tag nach ID abrufen |
Abrufen eines Tags mit der ID |
| Tagdokument |
Hinzufügen eines Tags zu einem Dokument mithilfe einer Dokument-ID und Tag-ID |
| Vorlage nach Code abrufen |
Abrufen einer Vorlage anhand des Vorlagencodes |
| Vorlage nach ID abrufen |
Abrufen einer Vorlage anhand der ID |
| Vorlagenfelder abrufen |
Abrufen aller Felder aus einer Vorlage |
| Website zum Speicheranbieter hinzufügen |
Hinzufügen einer SharePoint-Website zu einem Speicheranbieter |
Abfragen von Benutzern
Alle Benutzer abfragen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
excludeActiveUsers
|
excludeActiveUsers | boolean |
excludeActiveUsers |
|
|
excludeInactiveUsers
|
excludeInactiveUsers | boolean |
excludeInactiveUsers |
|
|
excludeNormalUsers
|
excludeNormalUsers | boolean |
excludeNormalUsers |
|
|
excludeSystemUsers
|
excludeSystemUsers | boolean |
excludeSystemUsers |
|
|
containsEmail
|
containsEmail | string |
containsEmail |
|
|
roleIds
|
roleIds | array of string |
roleIds |
|
|
name
|
name | string |
name |
|
|
containsName
|
containsName | string |
containsName |
|
|
orderAscending
|
orderAscending | boolean |
orderAscending |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Ergebnis
|
result | array of object |
Ergebnis |
|
id
|
result.id | string |
id |
|
tenantId
|
result.tenantId | string |
tenantId |
|
status
|
result.status | integer |
status |
|
Anzeigename
|
result.displayName | string |
Anzeigename |
|
primaryEmail
|
result.primaryEmail | string |
primaryEmail |
|
Vorname
|
result.firstName | string |
Vorname |
|
Familienname
|
result.surname | string |
Familienname |
|
Kultur
|
result.culture | string |
Kultur |
|
roles
|
result.roles | array of string |
roles |
|
isSystemUser
|
result.isSystemUser | boolean |
isSystemUser |
|
Leiter
|
result.manager | string |
Leiter |
|
gesamt
|
total | integer |
gesamt |
Abfragen von Dokumenten
Alle Dokumente abfragen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
obligatoryTags
|
obligatoryTags | array of string |
obligatoryTags |
|
|
tagsInHierarchy
|
tagsInHierarchy | array of string |
tagsInHierarchy |
|
|
fieldQueryExpression
|
fieldQueryExpression | object |
fieldQueryExpression |
|
|
excludeTagsInHierarchy
|
excludeTagsInHierarchy | array of string |
excludeTagsInHierarchy |
|
|
includeTotalCount
|
includeTotalCount | boolean |
includeTotalCount |
|
|
name
|
name | string |
name |
|
|
containsName
|
containsName | string |
containsName |
|
|
sortieren nach
|
orderBy | integer |
0 = Nothing, 1 = Name, 2 = Größe, 3 = Uploadzeit |
|
|
orderAscending
|
orderAscending | boolean |
orderAscending |
|
|
continuationToken
|
continuationToken | string |
continuationToken |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Ergebnis
|
result | array of object |
Ergebnis |
|
tags
|
result.tags | array of string |
tags |
|
explicitTags
|
result.explicitTags | array of string |
explicitTags |
|
fields
|
result.fields | array of object |
fields |
|
id
|
result.fields.id | string |
id |
|
value
|
result.fields.value | string |
value |
|
templateId
|
result.templateId | string |
templateId |
|
validationStatus
|
result.validationStatus | integer |
validationStatus |
|
id
|
result.id | string |
id |
|
fileReferenceId
|
result.fileReferenceId | string |
fileReferenceId |
|
name
|
result.fileReference.name | string |
name |
|
Extern
|
result.fileReference.ext | string |
Extern |
|
size
|
result.fileReference.size | integer |
size |
|
uploaderId
|
result.fileReference.uploaderId | string |
uploaderId |
|
Uploader
|
result.fileReference.uploader | string |
Uploader |
|
erstellt
|
result.fileReference.created | string |
erstellt |
|
mimeType
|
result.fileReference.mimeType | string |
mimeType |
|
Ausgabe
|
result.fileReference.version | integer |
Ausgabe |
|
externalSourceUrl
|
result.fileReference.externalSourceUrl | string |
externalSourceUrl |
|
streamAvailable
|
result.fileReference.streamAvailable | boolean |
streamAvailable |
|
id
|
result.fileReference.id | string |
id |
|
changedOn
|
result.fileReference.changedOn | string |
changedOn |
|
changedBy
|
result.fileReference.changedBy | string |
changedBy |
|
name
|
result.name | string |
name |
|
uploadTimestamp
|
result.uploadTimestamp | string |
uploadTimestamp |
|
gesamt
|
total | string |
gesamt |
Abfragetags
Alle Tags abfragen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
parentTagId
|
parentTagId | string |
parentTagId |
|
|
directParentTagId
|
directParentTagId | string |
directParentTagId |
|
|
hasNoParentTag
|
hasNoParentTag | boolean |
hasNoParentTag |
|
|
includeTotalCount
|
includeTotalCount | boolean |
includeTotalCount |
|
|
name
|
name | string |
name |
|
|
containsName
|
containsName | string |
containsName |
|
|
orderAscending
|
orderAscending | boolean |
orderAscending |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Ergebnis
|
result | array of object |
Ergebnis |
|
id
|
result.id | string |
id |
|
tenantId
|
result.tenantId | string |
tenantId |
|
Anbieter-ID
|
result.providerId | string |
Anbieter-ID |
|
parentTagId
|
result.parentTagId | string |
parentTagId |
|
parentHierarchy
|
result.parentHierarchy | array of string |
parentHierarchy |
|
labels
|
result.labels | array of object |
labels |
|
languageId
|
result.labels.languageId | integer |
languageId |
|
value
|
result.labels.value | string |
value |
|
tagRelations
|
result.tagRelations | array of string |
tagRelations |
|
Code
|
result.code | string |
Code |
|
externalEntityName
|
result.syncDetails.externalEntityName | string |
externalEntityName |
|
source
|
result.syncDetails.source | string |
source |
|
primaryIdFields
|
result.syncDetails.primaryIdFields | array of string |
primaryIdFields |
|
primaryIdFormat
|
result.syncDetails.primaryIdFormat | string |
primaryIdFormat |
|
primaryIdFieldValues
|
result.syncDetails.primaryIdFieldValues | array of string |
primaryIdFieldValues |
|
lastSyncedOn
|
result.syncDetails.lastSyncedOn | string |
lastSyncedOn |
|
excludeFromSearch
|
result.excludeFromSearch | boolean |
excludeFromSearch |
|
gesamt
|
total | integer |
gesamt |
Abfragevorlagen
Alle Vorlagen abfragen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
languageCode
|
languageCode | integer |
languageCode |
|
|
contextTags
|
contextTags | array of string |
contextTags |
|
|
sortieren nach
|
orderBy | integer |
sortieren nach |
|
|
name
|
name | string |
name |
|
|
containsName
|
containsName | string |
containsName |
|
|
orderAscending
|
orderAscending | boolean |
orderAscending |
|
|
continuationToken
|
continuationToken | string |
continuationToken |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Ergebnis
|
result | array of object |
Ergebnis |
|
id
|
result.id | string |
id |
|
name
|
result.name | string |
name |
|
tenantId
|
result.tenantId | string |
tenantId |
|
Code
|
result.code | string |
Code |
|
labels
|
result.labels | array of object |
labels |
|
languageId
|
result.labels.languageId | integer |
languageId |
|
value
|
result.labels.value | string |
value |
|
fields
|
result.fields | array of string |
fields |
|
Untergeordnetes Element
|
result.children | array of object |
Untergeordnetes Element |
|
id
|
result.children.id | string |
id |
|
tenantId
|
result.children.tenantId | string |
tenantId |
|
masterTemplateId
|
result.children.masterTemplateId | string |
masterTemplateId |
|
templateId
|
result.children.templateId | string |
templateId |
|
erforderlich
|
result.children.isRequired | boolean |
erforderlich |
|
template
|
result.children.template | string |
template |
|
relatedTags
|
result.relatedTags | array of string |
relatedTags |
|
contextTags
|
result.contextTags | array of string |
contextTags |
|
sequenceNumber
|
result.sequenceNumber | integer |
sequenceNumber |
|
additionalProp1
|
result.additionalProp1 | string |
additionalProp1 |
|
additionalProp2
|
result.additionalProp2 | string |
additionalProp2 |
|
additionalProp3
|
result.additionalProp3 | string |
additionalProp3 |
|
continuationToken
|
continuationToken | string |
continuationToken |
|
gesamt
|
total | integer |
gesamt |
Abrufen des externen Systems nach ID
Abrufen eines externen Systems durch die externe System-ID
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
Externe System-ID
|
externalSystemId | True | string |
Id des externen Systems |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
name
|
name | string |
name |
|
hasUserUI
|
hasUserUI | boolean |
hasUserUI |
Abrufen des Speicheranbieters nach ID
Abrufen des Speicheranbieters mithilfe der Speicheranbieter-ID
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
Id
|
id | True | string |
Id |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string |
id |
|
name
|
name | string |
name |
|
baseUri
|
baseUri | string |
baseUri |
|
siteConfigurations
|
siteConfigurations | array of object |
siteConfigurations |
|
id
|
siteConfigurations.id | string |
id |
|
Pfad
|
siteConfigurations.path | string |
Pfad |
|
tagContext
|
siteConfigurations.tagContext | array of string |
tagContext |
|
isActive
|
isActive | boolean |
isActive |
|
directoryId
|
directoryId | string |
directoryId |
|
lastSubscriptionExpiryCheck
|
lastSubscriptionExpiryCheck | string |
lastSubscriptionExpiryCheck |
Abrufen eines Benutzertokens
Anfordern eines Benutzertokens zur Verwendung in Ihren Aktionen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Externe System-ID
|
externalSystemID | True | string |
ID des externen Systems |
|
Geheim
|
secret | True | string |
Geheimnis des externen Systems |
|
Externer Benutzername
|
externalUserName | True | string |
Benutzername, der für externes System verwendet wird |
Gibt zurück
Token für die Authentifizierung bei einem Raptor-Mandanten
- Token
- string
Abrufen mehrerer Tags
Abrufen mehrerer Markierungen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
Ausweise
|
ids | array of string |
Array von Tag-IDs |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
Anbieter-ID
|
providerId | string |
Anbieter-ID |
|
parentTagId
|
parentTagId | string |
parentTagId |
|
parentHierarchy
|
parentHierarchy | array of string |
parentHierarchy |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
value
|
labels.value | string |
value |
|
tagRelations
|
tagRelations | array of string |
tagRelations |
|
Code
|
code | string |
Code |
|
externalEntityName
|
syncDetails.externalEntityName | string |
externalEntityName |
|
source
|
syncDetails.source | string |
source |
|
primaryIdFields
|
syncDetails.primaryIdFields | array of string |
primaryIdFields |
|
primaryIdFormat
|
syncDetails.primaryIdFormat | string |
primaryIdFormat |
|
primaryIdFieldValues
|
syncDetails.primaryIdFieldValues | array of string |
primaryIdFieldValues |
|
lastSyncedOn
|
syncDetails.lastSyncedOn | string |
lastSyncedOn |
|
excludeFromSearch
|
excludeFromSearch | boolean |
excludeFromSearch |
Abrufen oder Erstellen eines Tags
Erstellt ein Tag oder ruft es ab, wenn ein Tag mit einem übereinstimmenden Code vorhanden ist.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
method
|
method | True | string |
method |
|
Code
|
code | string |
Code |
|
|
languageId
|
languageId | integer |
languageId |
|
|
value
|
value | string |
Bezeichnungswert |
|
|
parentTagId
|
parentTagId | string |
ID des übergeordneten Tags |
Abrufen von Dokumentmetadaten
Abrufen von Dokumentmetadaten mithilfe der Dokument-ID
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
Id
|
id | True | string |
Id |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
tags
|
tags | array of string |
tags |
|
explicitTags
|
explicitTags | array of string |
explicitTags |
|
fields
|
fields | array of |
fields |
|
templateId
|
templateId | string |
templateId |
|
validationStatus
|
validationStatus | integer |
validationStatus |
|
id
|
id | string |
id |
|
fileReferenceId
|
fileReferenceId | string |
fileReferenceId |
|
Datei-ID
|
fileReference.fileId | string |
Datei-ID |
|
name
|
fileReference.name | string |
name |
|
Extern
|
fileReference.ext | string |
Extern |
|
size
|
fileReference.size | integer |
size |
|
uploaderId
|
fileReference.uploaderId | string |
uploaderId |
|
Uploader
|
fileReference.uploader | string |
Uploader |
|
erstellt
|
fileReference.created | string |
erstellt |
|
mimeType
|
fileReference.mimeType | string |
mimeType |
|
Ausgabe
|
fileReference.version | integer |
Ausgabe |
|
externalSourceUrl
|
fileReference.externalSourceUrl | string |
externalSourceUrl |
|
streamAvailable
|
fileReference.streamAvailable | boolean |
streamAvailable |
|
id
|
fileReference.id | string |
id |
|
changedOn
|
fileReference.changedOn | string |
changedOn |
|
changedBy
|
fileReference.changedBy | string |
changedBy |
|
name
|
name | string |
name |
|
uploadTimestamp
|
uploadTimestamp | string |
uploadTimestamp |
Abrufen von Dokumentmetadaten nach Dateireferenz
Abrufen von Dokumentmetadaten anhand einer Dateireferenz-ID
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
Dateireferenz-ID
|
fileReferenceId | True | string |
ID des Dateiverweises |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
tags
|
tags | array of string |
tags |
|
explicitTags
|
explicitTags | array of string |
explicitTags |
|
fields
|
fields | array of |
fields |
|
templateId
|
templateId | string |
templateId |
|
validationStatus
|
validationStatus | integer |
validationStatus |
|
id
|
id | string |
id |
|
fileReferenceId
|
fileReferenceId | string |
fileReferenceId |
|
fileReference
|
fileReference | string |
fileReference |
|
name
|
name | string |
name |
|
uploadTimestamp
|
uploadTimestamp | string |
uploadTimestamp |
Benutzer nach ID abrufen
Abrufen eines Benutzers anhand seiner ID
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
Benutzer-ID
|
userId | True | string |
Benutzer-ID |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
status
|
status | integer |
status |
|
Anzeigename
|
displayName | string |
Anzeigename |
|
primaryEmail
|
primaryEmail | string |
primaryEmail |
|
Vorname
|
firstName | string |
Vorname |
|
Familienname
|
surname | string |
Familienname |
|
Kultur
|
culture | string |
Kultur |
|
roles
|
roles | array of string |
roles |
|
isSystemUser
|
isSystemUser | boolean |
isSystemUser |
|
Leiter
|
manager | string |
Leiter |
Dokument herunterladen
Herunterladen eines Dokuments anhand der ID
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
Id
|
id | True | string |
ID des Dokuments |
Gibt zurück
Heruntergeladenes Dokument
- Dokumentinhalt
- object
Dokument hochladen
Hochladen eines Dokuments in Raptor Document Warehouse
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
Name
|
name | True | string |
Name |
|
Inhaltstyp
|
Content-Type | True | string |
Inhaltstyp |
|
Dateiinhalt
|
body | True | binary |
Binärer Inhalt des Dokuments |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
tags
|
tags | array of string |
tags |
|
fields
|
fields | array of object |
fields |
|
id
|
fields.id | string |
id |
|
value
|
fields.value | string |
value |
|
templateId
|
templateId | string |
templateId |
|
validationStatus
|
validationStatus | integer |
validationStatus |
|
id
|
id | string |
id |
|
fileReferenceId
|
fileReferenceId | string |
fileReferenceId |
|
name
|
name | string |
name |
|
uploadTimestamp
|
uploadTimestamp | string |
uploadTimestamp |
Dokument löschen
Dokument anhand der ID löschen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
Id
|
id | True | string |
Id |
Dokument suchen
Suchen eines Dokuments mit SharePoint-Laufwerk-ID und Laufwerkelement-ID
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
Azure Directory-ID
|
azureDirectoryId | True | string |
Azure-Verzeichnis-ID |
|
Laufwerk-ID
|
driveId | True | string |
Laufwerk-ID |
|
Laufwerkelement-ID
|
driveItemId | True | string |
Laufwerkelement-ID |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
tags
|
tags | array of string |
tags |
|
fields
|
fields | array of object |
fields |
|
id
|
fields.id | string |
id |
|
name
|
fields.name | string |
name |
|
value
|
fields.value | string |
value |
|
numberValue
|
fields.numberValue | string |
numberValue |
|
erforderlich
|
fields.isRequired | boolean |
erforderlich |
|
fieldType
|
fields.fieldType | integer |
fieldType |
|
Nutzer
|
fields.users | array of |
Nutzer |
|
templateId
|
templateId | string |
templateId |
|
validationStatus
|
validationStatus | integer |
validationStatus |
|
id
|
id | string |
id |
|
fileReferenceId
|
fileReferenceId | string |
fileReferenceId |
|
Datei-ID
|
fileReference.fileId | string |
Datei-ID |
|
name
|
fileReference.name | string |
name |
|
Extern
|
fileReference.ext | string |
Extern |
|
size
|
fileReference.size | integer |
size |
|
uploaderId
|
fileReference.uploaderId | string |
uploaderId |
|
Uploader
|
fileReference.uploader | string |
Uploader |
|
erstellt
|
fileReference.created | string |
erstellt |
|
mimeType
|
fileReference.mimeType | string |
mimeType |
|
Ausgabe
|
fileReference.version | integer |
Ausgabe |
|
externalSourceUrl
|
fileReference.externalSourceUrl | string |
externalSourceUrl |
|
streamAvailable
|
fileReference.streamAvailable | boolean |
streamAvailable |
|
primaryStorageProvider
|
fileReference.primaryStorageProvider | string |
primaryStorageProvider |
|
id
|
fileReference.id | string |
id |
|
changedOn
|
fileReference.changedOn | string |
changedOn |
|
changedBy
|
fileReference.changedBy | string |
changedBy |
|
name
|
name | string |
name |
|
uploadTimestamp
|
uploadTimestamp | string |
uploadTimestamp |
Dokument trennen
Verschieben der SharePoint-Datei in den Raptor-Speicher
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
azureDirectoryId
|
azureDirectoryId | string |
azureDirectoryId |
|
|
driveId (Laufwerks-ID)
|
driveId | string |
driveId (Laufwerks-ID) |
|
|
driveItemId
|
driveItemId | string |
driveItemId |
Dokumentvorlage hinzufügen
Hinzufügen einer Vorlage zu einem Dokument
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
Vorlagen-ID
|
templateId | True | string |
ID der Vorlage |
|
body
|
body | True | array of string |
Erstellen von Websiteabonnements
Generieren eines Abonnements für eine Website ad-hoc
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
Speicheranbieter-ID
|
storageProviderId | True | string |
ID des Speicheranbieters |
|
Inhaltstyp
|
Content-Type | string |
Inhaltstyp |
|
|
Body
|
body | True | string |
Body |
Erweiterte Suche
Durchsuchen von Dokumenten mithilfe einer erweiterten Suchabfrage
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
|
object |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Ergebnis
|
result | array of object |
Ergebnis |
|
tags
|
result.tags | array of string |
tags |
|
explicitTags
|
result.explicitTags | array of string |
explicitTags |
|
fields
|
result.fields | array of object |
fields |
|
id
|
result.fields.id | string |
id |
|
name
|
result.fields.name | string |
name |
|
value
|
result.fields.value | string |
value |
|
numberValue
|
result.fields.numberValue | integer |
numberValue |
|
erforderlich
|
result.fields.isRequired | boolean |
erforderlich |
|
fieldType
|
result.fields.fieldType | integer |
fieldType |
|
Nutzer
|
result.fields.users | array of |
Nutzer |
|
templateId
|
result.templateId | string |
templateId |
|
validationStatus
|
result.validationStatus | integer |
validationStatus |
|
id
|
result.id | string |
id |
|
fileReferenceId
|
result.fileReferenceId | string |
fileReferenceId |
|
Datei-ID
|
result.fileReference.fileId | string |
Datei-ID |
|
name
|
result.fileReference.name | string |
name |
|
Extern
|
result.fileReference.ext | string |
Extern |
|
size
|
result.fileReference.size | integer |
size |
|
uploaderId
|
result.fileReference.uploaderId | string |
uploaderId |
|
Uploader
|
result.fileReference.uploader | string |
Uploader |
|
erstellt
|
result.fileReference.created | string |
erstellt |
|
mimeType
|
result.fileReference.mimeType | string |
mimeType |
|
Ausgabe
|
result.fileReference.version | integer |
Ausgabe |
|
externalSourceUrl
|
result.fileReference.externalSourceUrl | string |
externalSourceUrl |
|
streamAvailable
|
result.fileReference.streamAvailable | boolean |
streamAvailable |
|
id
|
result.fileReference.id | string |
id |
|
changedOn
|
result.fileReference.changedOn | string |
changedOn |
|
changedBy
|
result.fileReference.changedBy | string |
changedBy |
|
name
|
result.name | string |
name |
|
uploadTimestamp
|
result.uploadTimestamp | string |
uploadTimestamp |
|
gesamt
|
total | string |
gesamt |
Externe Datei einfügen
Url der externen Datei als Dokument einfügen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
Dateiname
|
filename | True | string |
Dateiname |
|
body
|
body | string |
body |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
tags
|
tags | array of |
tags |
|
fields
|
fields | array of |
fields |
|
templateId
|
templateId | string |
templateId |
|
validationStatus
|
validationStatus | integer |
validationStatus |
|
id
|
id | string |
id |
|
fileReferenceId
|
fileReferenceId | string |
fileReferenceId |
|
fileReference
|
fileReference | string |
fileReference |
|
name
|
name | string |
name |
|
uploadTimestamp
|
uploadTimestamp | string |
uploadTimestamp |
Externe Quelle festlegen
Festlegen der externen Quelle für filereference
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
Dateireferenz-ID
|
fileReferenceId | True | string |
ID des Dateiverweises |
|
Body
|
body | True | string |
Body |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Datei-ID
|
fileId | string |
Datei-ID |
|
name
|
name | string |
name |
|
Extern
|
ext | string |
Extern |
|
size
|
size | integer |
size |
|
uploaderId
|
uploaderId | string |
uploaderId |
|
Uploader
|
uploader | string |
Uploader |
|
erstellt
|
created | string |
erstellt |
|
mimeType
|
mimeType | string |
mimeType |
|
Ausgabe
|
version | integer |
Ausgabe |
|
externalSourceUrl
|
externalSourceUrl | string |
externalSourceUrl |
|
streamAvailable
|
streamAvailable | boolean |
streamAvailable |
|
primaryStorageProvider
|
primaryStorageProvider | string |
primaryStorageProvider |
|
id
|
id | string |
id |
|
changedOn
|
changedOn | string |
changedOn |
|
changedBy
|
changedBy | string |
changedBy |
Feld erstellen
Erstellen eines neuen Felds
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
Action-Methode
|
method | string |
Methode, die beim Aufrufen der API verwendet werden soll |
|
|
id
|
id | string |
id |
|
|
tenantId
|
tenantId | string |
tenantId |
|
|
Code
|
code | string |
Code |
|
|
fieldType
|
fieldType | integer |
fieldType |
|
|
erforderlich
|
isRequired | boolean |
erforderlich |
|
|
isReadOnly
|
isReadOnly | boolean |
isReadOnly |
|
|
defaultValue
|
defaultValue | string |
defaultValue |
|
|
languageId
|
languageId | integer |
languageId |
|
|
value
|
value | string |
value |
|
|
validatingRegExp
|
validatingRegExp | string |
validatingRegExp |
|
|
languageId
|
languageId | integer |
languageId |
|
|
value
|
value | string |
value |
|
|
rowAmount
|
rowAmount | integer |
rowAmount |
|
|
parentTagId
|
parentTagId | string |
parentTagId |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
Code
|
code | string |
Code |
|
fieldType
|
fieldType | integer |
fieldType |
|
erforderlich
|
isRequired | boolean |
erforderlich |
|
isReadOnly
|
isReadOnly | boolean |
isReadOnly |
|
defaultValue
|
defaultValue | string |
defaultValue |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
value
|
labels.value | string |
value |
|
validatingRegExp
|
validatingRegExp | string |
validatingRegExp |
|
validationMessage
|
validationMessage | array of object |
validationMessage |
|
languageId
|
validationMessage.languageId | integer |
languageId |
|
value
|
validationMessage.value | string |
value |
|
rowAmount
|
rowAmount | integer |
rowAmount |
|
parentTagId
|
parentTagId | string |
parentTagId |
Feld im Dokument aktualisieren
Aktualisieren eines Felds, das sich in einem Dokument befindet
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
Dokument-ID
|
documentId | True | string |
ID des Dokuments |
|
id
|
id | string |
id |
|
|
value
|
value | string |
value |
Feld nach Code abrufen
Abrufen eines Felds anhand des Codes
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
Code
|
code | True | string |
Tagcode |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
Code
|
code | string |
Code |
|
fieldType
|
fieldType | integer |
fieldType |
|
erforderlich
|
isRequired | boolean |
erforderlich |
|
isReadOnly
|
isReadOnly | boolean |
isReadOnly |
|
defaultValue
|
defaultValue | string |
defaultValue |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
value
|
labels.value | string |
value |
|
validatingRegExp
|
validatingRegExp | string |
validatingRegExp |
|
validationMessage
|
validationMessage | array of object |
validationMessage |
|
languageId
|
validationMessage.languageId | integer |
languageId |
|
value
|
validationMessage.value | string |
value |
|
rowAmount
|
rowAmount | integer |
rowAmount |
|
parentTagId
|
parentTagId | string |
parentTagId |
Feld nach ID abrufen
Abrufen eines Felds nach der Feld-ID
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
Feld-ID
|
fieldId | True | string |
Feld-ID |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
Code
|
code | string |
Code |
|
fieldType
|
fieldType | integer |
fieldType |
|
erforderlich
|
isRequired | boolean |
erforderlich |
|
isReadOnly
|
isReadOnly | boolean |
isReadOnly |
|
defaultValue
|
defaultValue | string |
defaultValue |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
value
|
labels.value | string |
value |
|
validatingRegExp
|
validatingRegExp | string |
validatingRegExp |
|
validationMessage
|
validationMessage | array of object |
validationMessage |
|
languageId
|
validationMessage.languageId | integer |
languageId |
|
value
|
validationMessage.value | string |
value |
|
rowAmount
|
rowAmount | integer |
rowAmount |
|
parentTagId
|
parentTagId | string |
parentTagId |
Feld zum Dokument hinzufügen
Hinzufügen eines Felds zu einem Dokument
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
Dokument-ID
|
documentId | True | string |
ID des Dokuments |
|
Action-Methode
|
method | string |
Methode, die beim Aufrufen der API verwendet werden soll |
|
|
Id
|
id | string |
id |
|
|
Wert
|
value | string |
value |
Festlegen des primären Speicheranbieters für das Dokument
Festlegen des primären Speicher-Providors für ein Dokument
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
Dateireferenz-ID
|
fileReferenceId | True | string |
ID des Dateiverweises |
|
Speicheranbieter-ID
|
storageProviderId | True | string |
ID des Speicheranbieters |
|
Raptorspeicher entfernen
|
removeRaptorStorage | boolean |
Entfernen des Raptorspeichers |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Datei-ID
|
fileId | string |
Datei-ID |
|
name
|
name | string |
name |
|
Extern
|
ext | string |
Extern |
|
size
|
size | integer |
size |
|
uploaderId
|
uploaderId | string |
uploaderId |
|
Uploader
|
uploader | string |
Uploader |
|
erstellt
|
created | string |
erstellt |
|
mimeType
|
mimeType | string |
mimeType |
|
Ausgabe
|
version | integer |
Ausgabe |
|
externalSourceUrl
|
externalSourceUrl | string |
externalSourceUrl |
|
streamAvailable
|
streamAvailable | boolean |
streamAvailable |
|
primaryStorageProvider
|
primaryStorageProvider | string |
primaryStorageProvider |
|
id
|
id | string |
id |
|
changedOn
|
changedOn | string |
changedOn |
|
changedBy
|
changedBy | string |
changedBy |
Kontext auflösen
Löst ein Tag mithilfe der Entitätskonfiguration auf.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
source
|
source | string |
source |
|
|
entityName
|
entityName | string |
entityName |
|
|
legalEntity
|
legalEntity | string |
legalEntity |
|
|
fields
|
fields | string |
fields |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
Anbieter-ID
|
providerId | string |
Anbieter-ID |
|
parentTagId
|
parentTagId | string |
parentTagId |
|
parentHierarchy
|
parentHierarchy | array of string |
parentHierarchy |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
value
|
labels.value | string |
value |
|
tagRelations
|
tagRelations | array of string |
tagRelations |
|
Code
|
code | string |
Code |
|
externalEntityName
|
syncDetails.externalEntityName | string |
externalEntityName |
|
source
|
syncDetails.source | string |
source |
|
primaryIdFields
|
syncDetails.primaryIdFields | array of string |
primaryIdFields |
|
primaryIdFormat
|
syncDetails.primaryIdFormat | string |
primaryIdFormat |
|
primaryIdFieldValues
|
syncDetails.primaryIdFieldValues | array of string |
primaryIdFieldValues |
|
lastSyncedOn
|
syncDetails.lastSyncedOn | string |
lastSyncedOn |
|
excludeFromSearch
|
excludeFromSearch | boolean |
excludeFromSearch |
Tag aus Dokument entfernen
Entfernen eines Tags aus einem Dokument mithilfe einer Dokument-ID und Tag-ID
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
Dokument-ID
|
documentId | True | string |
ID des Dokuments |
|
Tag-ID
|
tagId | True | string |
ID des Tags |
Tag nach Code abrufen
Tag anhand des Codes abrufen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
Code
|
code | True | string |
Tagcode |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
Anbieter-ID
|
providerId | string |
Anbieter-ID |
|
parentTagId
|
parentTagId | string |
parentTagId |
|
parentHierarchy
|
parentHierarchy | array of string |
parentHierarchy |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
value
|
labels.value | string |
value |
|
tagRelations
|
tagRelations | array of string |
tagRelations |
|
Code
|
code | string |
Code |
|
externalEntityName
|
syncDetails.externalEntityName | string |
externalEntityName |
|
source
|
syncDetails.source | string |
source |
|
primaryIdFields
|
syncDetails.primaryIdFields | array of string |
primaryIdFields |
|
primaryIdFormat
|
syncDetails.primaryIdFormat | string |
primaryIdFormat |
|
primaryIdFieldValues
|
syncDetails.primaryIdFieldValues | array of string |
primaryIdFieldValues |
|
lastSyncedOn
|
syncDetails.lastSyncedOn | string |
lastSyncedOn |
|
excludeFromSearch
|
excludeFromSearch | boolean |
excludeFromSearch |
Tag nach ID abrufen
Abrufen eines Tags mit der ID
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
Tag-ID
|
tagId | True | string |
ID des Tags |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
Anbieter-ID
|
providerId | string |
Anbieter-ID |
|
parentTagId
|
parentTagId | string |
parentTagId |
|
parentHierarchy
|
parentHierarchy | array of string |
parentHierarchy |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
value
|
labels.value | string |
value |
|
tagRelations
|
tagRelations | array of string |
tagRelations |
|
Code
|
code | string |
Code |
|
externalEntityName
|
syncDetails.externalEntityName | string |
externalEntityName |
|
source
|
syncDetails.source | string |
source |
|
primaryIdFields
|
syncDetails.primaryIdFields | array of string |
primaryIdFields |
|
primaryIdFormat
|
syncDetails.primaryIdFormat | string |
primaryIdFormat |
|
primaryIdFieldValues
|
syncDetails.primaryIdFieldValues | array of string |
primaryIdFieldValues |
|
lastSyncedOn
|
syncDetails.lastSyncedOn | string |
lastSyncedOn |
|
excludeFromSearch
|
excludeFromSearch | boolean |
excludeFromSearch |
Tagdokument
Hinzufügen eines Tags zu einem Dokument mithilfe einer Dokument-ID und Tag-ID
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
Dokument-ID
|
documentId | True | string |
ID des Dokuments |
|
Tag-ID
|
tagId | True | string |
ID des Tags |
|
Retagieren
|
reTag | boolean |
Sollte das Dokument neu markiert werden |
Vorlage nach Code abrufen
Abrufen einer Vorlage anhand des Vorlagencodes
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
Code
|
code | True | string |
Tagcode |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string |
id |
|
name
|
name | string |
name |
|
tenantId
|
tenantId | string |
tenantId |
|
Code
|
code | string |
Code |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
value
|
labels.value | string |
value |
|
fields
|
fields | array of string |
fields |
|
Untergeordnetes Element
|
children | array of object |
Untergeordnetes Element |
|
id
|
children.id | string |
id |
|
tenantId
|
children.tenantId | string |
tenantId |
|
masterTemplateId
|
children.masterTemplateId | string |
masterTemplateId |
|
templateId
|
children.templateId | string |
templateId |
|
erforderlich
|
children.isRequired | boolean |
erforderlich |
|
id
|
children.template.id | string |
id |
|
name
|
children.template.name | string |
name |
|
tenantId
|
children.template.tenantId | string |
tenantId |
|
Code
|
children.template.code | string |
Code |
|
labels
|
children.template.labels | array of object |
labels |
|
languageId
|
children.template.labels.languageId | integer |
languageId |
|
value
|
children.template.labels.value | string |
value |
|
fields
|
children.template.fields | array of string |
fields |
|
Untergeordnetes Element
|
children.template.children | array of object |
Untergeordnetes Element |
|
id
|
children.template.children.id | string |
id |
|
tenantId
|
children.template.children.tenantId | string |
tenantId |
|
masterTemplateId
|
children.template.children.masterTemplateId | string |
masterTemplateId |
|
templateId
|
children.template.children.templateId | string |
templateId |
|
erforderlich
|
children.template.children.isRequired | boolean |
erforderlich |
|
relatedTags
|
children.template.relatedTags | array of string |
relatedTags |
|
contextTags
|
children.template.contextTags | array of string |
contextTags |
|
sequenceNumber
|
children.template.sequenceNumber | integer |
sequenceNumber |
|
relatedTags
|
relatedTags | array of string |
relatedTags |
|
contextTags
|
contextTags | array of string |
contextTags |
|
sequenceNumber
|
sequenceNumber | integer |
sequenceNumber |
Vorlage nach ID abrufen
Abrufen einer Vorlage anhand der ID
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
Vorlagen-ID
|
templateId | True | string |
ID der Vorlage |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string |
id |
|
name
|
name | string |
name |
|
tenantId
|
tenantId | string |
tenantId |
|
Code
|
code | string |
Code |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
value
|
labels.value | string |
value |
|
fields
|
fields | array of string |
fields |
|
Untergeordnetes Element
|
children | array of object |
Untergeordnetes Element |
|
id
|
children.id | string |
id |
|
tenantId
|
children.tenantId | string |
tenantId |
|
masterTemplateId
|
children.masterTemplateId | string |
masterTemplateId |
|
templateId
|
children.templateId | string |
templateId |
|
erforderlich
|
children.isRequired | boolean |
erforderlich |
|
id
|
children.template.id | string |
id |
|
name
|
children.template.name | string |
name |
|
tenantId
|
children.template.tenantId | string |
tenantId |
|
Code
|
children.template.code | string |
Code |
|
labels
|
children.template.labels | array of object |
labels |
|
languageId
|
children.template.labels.languageId | integer |
languageId |
|
value
|
children.template.labels.value | string |
value |
|
fields
|
children.template.fields | array of string |
fields |
|
Untergeordnetes Element
|
children.template.children | array of object |
Untergeordnetes Element |
|
id
|
children.template.children.id | string |
id |
|
tenantId
|
children.template.children.tenantId | string |
tenantId |
|
masterTemplateId
|
children.template.children.masterTemplateId | string |
masterTemplateId |
|
templateId
|
children.template.children.templateId | string |
templateId |
|
erforderlich
|
children.template.children.isRequired | boolean |
erforderlich |
|
relatedTags
|
children.template.relatedTags | array of string |
relatedTags |
|
contextTags
|
children.template.contextTags | array of string |
contextTags |
|
sequenceNumber
|
children.template.sequenceNumber | integer |
sequenceNumber |
|
relatedTags
|
relatedTags | array of string |
relatedTags |
|
contextTags
|
contextTags | array of string |
contextTags |
|
sequenceNumber
|
sequenceNumber | integer |
sequenceNumber |
Vorlagenfelder abrufen
Abrufen aller Felder aus einer Vorlage
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
Vorlagen-ID
|
templateId | True | string |
ID der Vorlage |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
Code
|
code | string |
Code |
|
fieldType
|
fieldType | integer |
fieldType |
|
erforderlich
|
isRequired | boolean |
erforderlich |
|
isReadOnly
|
isReadOnly | boolean |
isReadOnly |
|
defaultValue
|
defaultValue | string |
defaultValue |
|
labels
|
labels | array of object |
labels |
|
languageId
|
labels.languageId | integer |
languageId |
|
value
|
labels.value | string |
value |
|
validatingRegExp
|
validatingRegExp | string |
validatingRegExp |
|
validationMessage
|
validationMessage | array of object |
validationMessage |
|
languageId
|
validationMessage.languageId | integer |
languageId |
|
value
|
validationMessage.value | string |
value |
|
rowAmount
|
rowAmount | integer |
rowAmount |
|
parentTagId
|
parentTagId | string |
parentTagId |
Website zum Speicheranbieter hinzufügen
Hinzufügen einer SharePoint-Website zu einem Speicheranbieter
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Für die Authentifizierung verwendete Token (siehe 'Benutzertoken abrufen') |
|
Id
|
id | True | string |
Id |
|
Pfad
|
path | string |
Pfad |
|
|
tagContext
|
tagContext | array of string |
tagContext |
Definitionen
Objekt
Dies ist der Typ „Objekt“.
Schnur
Dies ist der grundlegende Datentyp "string".