9A Raptor Document Warehouse (Preview)
The 9A Raptor Document Warehouse is a powerful SaaS solution that brings structure and coherence to information scattered across various business applications. This solution offers a unified and secure way to access, manage, and search for documents.
By leveraging the Raptor API, you can seamlessly automate your document management processes. Perform various actions such as uploading, downloading, tagging, and organizing documents.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | 9altitudes |
| URL | https://www.9altitudes.com |
| support@9altitudes.com |
| Connector Metadata | |
|---|---|
| Publisher | 9altitudes |
| Website | https://9altitudes.com |
| Privacy policy | https://www.9altitudes.com/privacy-policy |
| Categories | Content and Files;Productivity |
9A Raptor Document Warehouse Connector
The 9A Raptor Document Warehouse connector for Power Apps allows you to integrate seamlessly with the 9A Raptor Document Warehouse platform, an intelligent solution that consolidates and manages information across various business applications such as PLM, ERP, CRM, and more. This connector enables you to streamline your document management processes by linking and managing documents across different entities and systems, all from within Power Apps.
The 9A Raptor Document Warehouse is a powerful tool that brings structure and coherence to information spread across multiple business applications. Whether it's documents from Dynamics 365, Teams, or custom Power Platform applications, this solution provides a unified and secure way to access, manage, and search for documents. It ensures that you can find relevant documents linked to any entity, no matter where they were initially created or stored.
Key features of 9A Raptor Document Warehouse include:
- Consolidated Document Management: Manage documents across various applications like PLM, ERP, CRM, and more.
- Dynamic Context-Based Security: Ensure documents are accessible only to the right people based on context and security rules.
- Cross-System Integration: Link documents across different business systems, providing a single source of truth.
- Advanced Search Capabilities: Search and filter documents using multiple dimensions, locations, and attributes.
The 9A Raptor Document Warehouse connector provides a comprehensive set of API endpoints to interact with the platform. Below is a list of available operations:
- GetUserToken: Retrieve a user token to authenticate API requests, using an external system.
- GetUserById: Retrieve user details by their ID.
- QueryUsers: Search for users based on specific criteria.
- DownloadDocument: Download a document by its ID.
- UploadDocument: Upload a document.
- RemoveTagFromDocument: Remove a tag from a document.
- TagDocument: Add a tag to a document.
- AddFieldToDocument: Add a field to a document.
- UpdateFieldOnDocument: Update a specific field on a document.
- AddTemplateToDocument: Add a template to a document.
- QueryDocuments: Search for documents using specific criteria.
- AdvancedSearchQueryDocuments: Perform an advanced search query for documents.
- InsertExternalFile: Upload an external file to the document warehouse.
- GetDocumentMetadata: Retrieve metadata of a document.
- GetDocumentMetadataByFileReference: Get document metadata by file reference.
- DeleteDocument: Delete a document by its ID.
- GetTagByTagId: Retrieve a tag by its ID.
- GetTagByCode: Retrieve a tag by its code.
- GetMultipleTags: Retrieve multiple tags based on criteria.
- QueryTags: Search for tags using specific criteria.
- CreateField: Create a new field for documents.
- GetFieldById: Retrieve a field by its ID.
- GetFieldByCode: Retrieve a field by its code.
- GetTemplateFields: Retrieve all fields associated with a template.
- GetTemplateById: Retrieve a template by its ID.
- GetTemplateByCode: Retrieve a template by its code.
- QueryTemplates: Search for templates using specific criteria.
- AddSiteToStorageProvider: Add a site to a storage provider.
- GetStorageProviderById: Retrieve a storage provider by its ID.
- SetPrimaryStorageProviderOfDocument: Set the primary storage provider of a document.
- SetExternalSource: Set the external source of a document.
- GenerateSiteSubscription: Generate a subscription to a site.
- FindDocument: Find an external document.
- DetachDocument: Detach an external document.
- GetExternalSystemById: Retrieve details of an external system by its ID.
- ResolveContext: Resolve a tag based on business context.
To start using the 9A Raptor Document Warehouse connector in your Power Apps solutions, simply add the connector to your app, authenticate with your external system credentials, and start using the available actions and triggers to manage documents, users, tags, fields, templates, and more.
The 9A Raptor Document Warehouse connector for Power Apps empowers you to efficiently manage documents and related entities across multiple business systems, ensuring smooth workflows and enhanced productivity. With powerful search capabilities and dynamic context-based security, you can ensure that your documents are always accessible and secure.
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
| Add field to document |
Add a field to a document |
| Add Site to Storage Provider |
Add Site to Storage Provider |
| Add template to document |
Add a template to a document |
| Advanced search query documents |
Query documents by advanced search |
| Create field |
Create a new field |
| Delete Document |
Delete document by its id |
| Detach document |
Move SharePoint file to Raptor storage |
| Download document |
Download a document by it's id |
| Find document |
Find document with SharePoint drive id and drive item id |
| Generate site subscriptions |
Generate a subscription for a site ad-hoc |
| Get Document Metadata |
Get document metadata by its id |
| Get Document Metadata By File Reference |
Get document metadata by file reference |
| Get external system by id |
Get an external system by its id |
| Get field by code |
Get a field by its code |
| Get field by id |
Get a field by its id |
| Get multiple tags |
Get multiple selection of tags |
| Get Storage Provider by Id |
Get Storage Provider by Storage Provider Id |
| Get tag by code |
Get tag by its code |
| Get tag by id |
Get tag by tag id |
| Get template by code |
Get a template by its code |
| Get template by id |
Get a template by its id |
| Get template fields |
Get all fields from a template by template id |
| Get user by id |
Get a user by its id |
| Get user token |
Request a user token to use in your actions |
| Insert external file |
Insert url of external file as document |
| Query documents |
Query all documents |
| Query tags |
Query all tags |
| Query templates |
Query all templates |
| Query users |
Query all users |
| Remove tag from document |
Remove a tag from a document using a document id and tag id |
| Resolve context |
Resolves a tag using the entity configuration |
| Set external source |
Set external source for filereference |
| Set Primary Storage Provider Of Document |
Set the primary storage providor of a document |
| Tag Document |
Add a tag to a document using a document id and tag id |
| Update field on document |
Update a field that's on a document |
| Upload document |
Upload a document to Raptor Document Warehouse |
Add a field to a document
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token used for authentication |
|
Document Id
|
documentId | True | string |
Id of the document |
|
Method Of Action
|
method | string |
Method to use when calling the api |
|
|
Id
|
id | string |
id |
|
|
Name
|
name | string |
name |
|
|
Value
|
value | string |
value |
|
|
Number Value
|
numberValue | integer |
numberValue |
|
|
Is Required
|
isRequired | boolean |
isRequired |
|
|
Field Type
|
fieldType | integer |
fieldType |
|
|
Users
|
users | array of string |
users |
Returns
Add Site to Storage Provider
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token used for authentication |
|
Id
|
id | True | string |
Id |
|
path
|
path | string |
path |
|
|
tagContext
|
tagContext | array of string |
tagContext |
Returns
Add a template to a document
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token used for authentication |
|
Template Id
|
templateId | True | string |
Id of the template |
|
body
|
body | array of string |
Returns
Query documents by advanced search
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token used for authentication |
|
body
|
body | string |
body |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
result
|
result | array of object |
result |
|
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 |
|
isRequired
|
result.fields.isRequired | boolean |
isRequired |
|
fieldType
|
result.fields.fieldType | integer |
fieldType |
|
users
|
result.fields.users | array of |
users |
|
templateId
|
result.templateId | string |
templateId |
|
validationStatus
|
result.validationStatus | integer |
validationStatus |
|
id
|
result.id | string |
id |
|
fileReferenceId
|
result.fileReferenceId | string |
fileReferenceId |
|
fileId
|
result.fileReference.fileId | string |
fileId |
|
name
|
result.fileReference.name | string |
name |
|
ext
|
result.fileReference.ext | string |
ext |
|
size
|
result.fileReference.size | integer |
size |
|
uploaderId
|
result.fileReference.uploaderId | string |
uploaderId |
|
uploader
|
result.fileReference.uploader | string |
uploader |
|
created
|
result.fileReference.created | string |
created |
|
mimeType
|
result.fileReference.mimeType | string |
mimeType |
|
version
|
result.fileReference.version | integer |
version |
|
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 |
|
isDeleted
|
result.fileReference.isDeleted | boolean |
isDeleted |
|
name
|
result.name | string |
name |
|
uploadTimestamp
|
result.uploadTimestamp | string |
uploadTimestamp |
|
total
|
total | string |
total |
Create a new field
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token used for authentication |
|
Method Of Action
|
method | string |
Method to use when calling the api |
|
|
id
|
id | string |
id |
|
|
tenantId
|
tenantId | string |
tenantId |
|
|
code
|
code | string |
code |
|
|
fieldType
|
fieldType | integer |
fieldType |
|
|
isRequired
|
isRequired | boolean |
isRequired |
|
|
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 |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
code
|
code | string |
code |
|
fieldType
|
fieldType | integer |
fieldType |
|
isRequired
|
isRequired | boolean |
isRequired |
|
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 |
Delete document by its id
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token used for authentication |
|
Id
|
id | True | string |
Id |
Returns
Move SharePoint file to Raptor storage
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token used for authentication |
|
azureDirectoryId
|
azureDirectoryId | string |
azureDirectoryId |
|
|
driveId
|
driveId | string |
driveId |
|
|
driveItemId
|
driveItemId | string |
driveItemId |
Returns
Download a document by it's id
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token used for authentication |
|
Id
|
id | True | string |
Id of document |
Returns
Downloaded document
- Document Content
- object
Find document with SharePoint drive id and drive item id
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token used for authentication |
|
Azure Directory Id
|
azureDirectoryId | True | string |
Azure directory id |
|
Drive Id
|
driveId | True | string |
Drive id |
|
Drive Item Id
|
driveItemId | True | string |
Drive item id |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
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 |
|
isRequired
|
fields.isRequired | boolean |
isRequired |
|
fieldType
|
fields.fieldType | integer |
fieldType |
|
users
|
fields.users | array of |
users |
|
templateId
|
templateId | string |
templateId |
|
validationStatus
|
validationStatus | integer |
validationStatus |
|
id
|
id | string |
id |
|
fileReferenceId
|
fileReferenceId | string |
fileReferenceId |
|
fileId
|
fileReference.fileId | string |
fileId |
|
name
|
fileReference.name | string |
name |
|
ext
|
fileReference.ext | string |
ext |
|
size
|
fileReference.size | integer |
size |
|
uploaderId
|
fileReference.uploaderId | string |
uploaderId |
|
uploader
|
fileReference.uploader | string |
uploader |
|
created
|
fileReference.created | string |
created |
|
mimeType
|
fileReference.mimeType | string |
mimeType |
|
version
|
fileReference.version | integer |
version |
|
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 |
|
isDeleted
|
fileReference.isDeleted | boolean |
isDeleted |
|
name
|
name | string |
name |
|
uploadTimestamp
|
uploadTimestamp | string |
uploadTimestamp |
Generate a subscription for a site ad-hoc
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token used for authentication |
|
Storage Provider Id
|
storageProviderId | True | string |
Id of the storage provider |
|
Content Type
|
Content-Type | string |
Content type |
|
|
Body
|
body | string |
Body |
Returns
Get document metadata by its id
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token used for authentication |
|
Id
|
id | True | string |
Id |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
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 |
|
fileId
|
fileReference.fileId | string |
fileId |
|
name
|
fileReference.name | string |
name |
|
ext
|
fileReference.ext | string |
ext |
|
size
|
fileReference.size | integer |
size |
|
uploaderId
|
fileReference.uploaderId | string |
uploaderId |
|
uploader
|
fileReference.uploader | string |
uploader |
|
created
|
fileReference.created | string |
created |
|
mimeType
|
fileReference.mimeType | string |
mimeType |
|
version
|
fileReference.version | integer |
version |
|
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 |
|
isDeleted
|
fileReference.isDeleted | boolean |
isDeleted |
|
name
|
name | string |
name |
|
uploadTimestamp
|
uploadTimestamp | string |
uploadTimestamp |
Get document metadata by file reference
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token used for authentication |
|
File Reference Id
|
fileReferenceId | True | string |
Id of the file reference |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
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 |
Get an external system by its id
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token used for authentication |
|
External System Id
|
externalSystemId | True | string |
External system id |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
name
|
name | string |
name |
|
hasUserUI
|
hasUserUI | boolean |
hasUserUI |
Get a field by its code
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token used for authentication |
|
Code
|
code | True | string |
Code |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
code
|
code | string |
code |
|
fieldType
|
fieldType | integer |
fieldType |
|
isRequired
|
isRequired | boolean |
isRequired |
|
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 |
Get a field by its id
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token used for authentication |
|
Field Id
|
fieldId | True | string |
Field id |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
code
|
code | string |
code |
|
fieldType
|
fieldType | integer |
fieldType |
|
isRequired
|
isRequired | boolean |
isRequired |
|
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 |
Get multiple selection of tags
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token used for authentication |
|
ids
|
ids | array of string |
ids |
|
|
providerId
|
providerId | string |
providerId |
|
|
externalEntityName
|
externalEntityName | string |
externalEntityName |
|
|
code
|
code | string |
code |
|
|
requiredTagRelations
|
requiredTagRelations | array of string |
requiredTagRelations |
|
|
providerId
|
providerId | string |
providerId |
|
|
relationTagId
|
relationTagId | string |
relationTagId |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
providerId
|
providerId | string |
providerId |
|
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 |
|
isDeleted
|
isDeleted | boolean |
isDeleted |
|
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 |
Get Storage Provider by Storage Provider Id
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token used for authentication |
|
Id
|
id | True | string |
Id |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
name
|
name | string |
name |
|
baseUri
|
baseUri | string |
baseUri |
|
siteConfigurations
|
siteConfigurations | array of object |
siteConfigurations |
|
id
|
siteConfigurations.id | string |
id |
|
path
|
siteConfigurations.path | string |
path |
|
tagContext
|
siteConfigurations.tagContext | array of string |
tagContext |
|
isActive
|
isActive | boolean |
isActive |
|
directoryId
|
directoryId | string |
directoryId |
|
lastSubscriptionExpiryCheck
|
lastSubscriptionExpiryCheck | string |
lastSubscriptionExpiryCheck |
Get tag by its code
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token used for authentication |
|
Code
|
code | True | string |
Code |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
providerId
|
providerId | string |
providerId |
|
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 |
|
isDeleted
|
isDeleted | boolean |
isDeleted |
|
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 |
Get tag by tag id
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token used for authentication |
|
Tag Id
|
tagId | True | string |
Id of the tag |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
providerId
|
providerId | string |
providerId |
|
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 |
|
isDeleted
|
isDeleted | boolean |
isDeleted |
|
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 |
Get a template by its code
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token used for authentication |
|
Code
|
code | True | string |
Code |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
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 |
|
children
|
children | array of object |
children |
|
id
|
children.id | string |
id |
|
tenantId
|
children.tenantId | string |
tenantId |
|
masterTemplateId
|
children.masterTemplateId | string |
masterTemplateId |
|
templateId
|
children.templateId | string |
templateId |
|
isRequired
|
children.isRequired | boolean |
isRequired |
|
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 |
|
children
|
children.template.children | array of object |
children |
|
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 |
|
isRequired
|
children.template.children.isRequired | boolean |
isRequired |
|
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 |
Get a template by its id
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token used for authentication |
|
Template Id
|
templateId | True | string |
Id of the template |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
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 |
|
children
|
children | array of object |
children |
|
id
|
children.id | string |
id |
|
tenantId
|
children.tenantId | string |
tenantId |
|
masterTemplateId
|
children.masterTemplateId | string |
masterTemplateId |
|
templateId
|
children.templateId | string |
templateId |
|
isRequired
|
children.isRequired | boolean |
isRequired |
|
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 |
|
children
|
children.template.children | array of object |
children |
|
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 |
|
isRequired
|
children.template.children.isRequired | boolean |
isRequired |
|
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 |
Get all fields from a template by template id
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token used for authentication |
|
Template Id
|
templateId | True | string |
Id of the template |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
code
|
code | string |
code |
|
fieldType
|
fieldType | integer |
fieldType |
|
isRequired
|
isRequired | boolean |
isRequired |
|
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 |
Get a user by its id
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token used for authentication |
|
User Id
|
userId | True | string |
User id |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
status
|
status | integer |
status |
|
displayName
|
displayName | string |
displayName |
|
primaryEmail
|
primaryEmail | string |
primaryEmail |
|
firstName
|
firstName | string |
firstName |
|
surname
|
surname | string |
surname |
|
culture
|
culture | string |
culture |
|
roles
|
roles | array of string |
roles |
|
isSystemUser
|
isSystemUser | boolean |
isSystemUser |
|
manager
|
manager | string |
manager |
Request a user token to use in your actions
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
External System Id
|
externalSystemID | True | string |
Id of external system |
|
Secret
|
secret | True | string |
Secret of external system |
|
External User Name
|
externalUserName | True | string |
User name used for external system |
Returns
Token to authenticate to a Raptor tenant
- Token
- string
Insert url of external file as document
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token used for authentication |
|
Filename
|
filename | string |
Filename |
|
|
body
|
body | string |
body |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
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 |
Query all documents
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token used for authentication |
|
obligatoryTags
|
obligatoryTags | array of string |
obligatoryTags |
|
|
tagsInHierarchy
|
tagsInHierarchy | array of string |
tagsInHierarchy |
|
|
id
|
id | string |
id |
|
|
name
|
name | string |
name |
|
|
value
|
value | string |
value |
|
|
numberValue
|
numberValue | integer |
numberValue |
|
|
isRequired
|
isRequired | boolean |
isRequired |
|
|
fieldType
|
fieldType | integer |
fieldType |
|
|
users
|
users | array of string |
users |
|
|
operator
|
operator | string |
operator |
|
|
id
|
id | string |
id |
|
|
name
|
name | string |
name |
|
|
value
|
value | string |
value |
|
|
numberValue
|
numberValue | integer |
numberValue |
|
|
isRequired
|
isRequired | boolean |
isRequired |
|
|
fieldType
|
fieldType | integer |
fieldType |
|
|
users
|
users | array of string |
users |
|
|
excludeTagsInHierarchy
|
excludeTagsInHierarchy | array of string |
excludeTagsInHierarchy |
|
|
orderBy
|
orderBy | integer |
orderBy |
|
|
languageCode
|
languageCode | integer |
languageCode |
|
|
includeTotalCount
|
includeTotalCount | boolean |
includeTotalCount |
|
|
name
|
name | string |
name |
|
|
containsName
|
containsName | string |
containsName |
|
|
orderAscending
|
orderAscending | boolean |
orderAscending |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
result
|
result | array of object |
result |
|
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 |
|
isRequired
|
result.fields.isRequired | boolean |
isRequired |
|
fieldType
|
result.fields.fieldType | integer |
fieldType |
|
users
|
result.fields.users | array of string |
users |
|
templateId
|
result.templateId | string |
templateId |
|
validationStatus
|
result.validationStatus | integer |
validationStatus |
|
id
|
result.id | string |
id |
|
fileReferenceId
|
result.fileReferenceId | string |
fileReferenceId |
|
fileId
|
result.fileReference.fileId | string |
fileId |
|
name
|
result.fileReference.name | string |
name |
|
ext
|
result.fileReference.ext | string |
ext |
|
size
|
result.fileReference.size | integer |
size |
|
uploaderId
|
result.fileReference.uploaderId | string |
uploaderId |
|
uploader
|
result.fileReference.uploader | string |
uploader |
|
created
|
result.fileReference.created | string |
created |
|
mimeType
|
result.fileReference.mimeType | string |
mimeType |
|
version
|
result.fileReference.version | integer |
version |
|
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 |
|
isDeleted
|
result.fileReference.isDeleted | boolean |
isDeleted |
|
name
|
result.name | string |
name |
|
uploadTimestamp
|
result.uploadTimestamp | string |
uploadTimestamp |
|
total
|
total | string |
total |
Query all tags
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token used for authentication |
|
code
|
code | string |
code |
|
|
providerId
|
providerId | string |
providerId |
|
|
parentTagId
|
parentTagId | string |
parentTagId |
|
|
directParentTagId
|
directParentTagId | string |
directParentTagId |
|
|
languageCode
|
languageCode | integer |
languageCode |
|
|
hasNoParentTag
|
hasNoParentTag | boolean |
hasNoParentTag |
|
|
orderBy
|
orderBy | integer |
orderBy |
|
|
includeTotalCount
|
includeTotalCount | boolean |
includeTotalCount |
|
|
name
|
name | string |
name |
|
|
containsName
|
containsName | string |
containsName |
|
|
orderAscending
|
orderAscending | boolean |
orderAscending |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
result
|
result | array of object |
result |
|
id
|
result.id | string |
id |
|
tenantId
|
result.tenantId | string |
tenantId |
|
providerId
|
result.providerId | string |
providerId |
|
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 |
|
isDeleted
|
result.isDeleted | boolean |
isDeleted |
|
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 |
|
total
|
total | integer |
total |
Query all templates
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token used for authentication |
|
languageCode
|
languageCode | integer |
languageCode |
|
|
contextTags
|
contextTags | array of string |
contextTags |
|
|
orderBy
|
orderBy | integer |
orderBy |
|
|
name
|
name | string |
name |
|
|
containsName
|
containsName | string |
containsName |
|
|
orderAscending
|
orderAscending | boolean |
orderAscending |
|
|
continuationToken
|
continuationToken | string |
continuationToken |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
result
|
result | array of object |
result |
|
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 |
|
children
|
result.children | array of object |
children |
|
id
|
result.children.id | string |
id |
|
tenantId
|
result.children.tenantId | string |
tenantId |
|
masterTemplateId
|
result.children.masterTemplateId | string |
masterTemplateId |
|
templateId
|
result.children.templateId | string |
templateId |
|
isRequired
|
result.children.isRequired | boolean |
isRequired |
|
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 |
|
total
|
total | integer |
total |
Query all users
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token used for authentication |
|
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 |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
result
|
result | array of object |
result |
|
id
|
result.id | string |
id |
|
tenantId
|
result.tenantId | string |
tenantId |
|
status
|
result.status | integer |
status |
|
displayName
|
result.displayName | string |
displayName |
|
primaryEmail
|
result.primaryEmail | string |
primaryEmail |
|
firstName
|
result.firstName | string |
firstName |
|
surname
|
result.surname | string |
surname |
|
culture
|
result.culture | string |
culture |
|
roles
|
result.roles | array of string |
roles |
|
isSystemUser
|
result.isSystemUser | boolean |
isSystemUser |
|
manager
|
result.manager | string |
manager |
|
total
|
total | integer |
total |
Remove a tag from a document using a document id and tag id
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token used for authentication |
|
Document Id
|
documentId | True | string |
Id of the document |
|
Tag Id
|
tagId | True | string |
Id of the tag |
Returns
Resolves a tag using the entity configuration
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token used for authentication |
|
source
|
source | string |
source |
|
|
entityName
|
entityName | string |
entityName |
|
|
legalEntity
|
legalEntity | string |
legalEntity |
|
|
fields
|
fields | string |
fields |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
tenantId
|
tenantId | string |
tenantId |
|
providerId
|
providerId | string |
providerId |
|
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 |
|
isDeleted
|
isDeleted | boolean |
isDeleted |
|
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 |
Set external source for filereference
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token used for authentication |
|
File Reference Id
|
fileReferenceId | True | string |
Id of the file reference |
|
Body
|
body | string |
Body |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
fileId
|
fileId | string |
fileId |
|
name
|
name | string |
name |
|
ext
|
ext | string |
ext |
|
size
|
size | integer |
size |
|
uploaderId
|
uploaderId | string |
uploaderId |
|
uploader
|
uploader | string |
uploader |
|
created
|
created | string |
created |
|
mimeType
|
mimeType | string |
mimeType |
|
version
|
version | integer |
version |
|
externalSourceUrl
|
externalSourceUrl | string |
externalSourceUrl |
|
streamAvailable
|
streamAvailable | boolean |
streamAvailable |
|
primaryStorageProvider
|
primaryStorageProvider | string |
primaryStorageProvider |
|
id
|
id | string |
id |
|
changedOn
|
changedOn | string |
changedOn |
|
changedBy
|
changedBy | string |
changedBy |
|
isDeleted
|
isDeleted | boolean |
isDeleted |
Set the primary storage providor of a document
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token used for authentication |
|
File Reference Id
|
fileReferenceId | True | string |
Id of the file reference |
|
Storage Provider Id
|
storageProviderId | True | string |
Id of the storage provider |
|
Remove Raptor Storage
|
removeRaptorStorage | boolean |
Remove Raptor storage |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
fileId
|
fileId | string |
fileId |
|
name
|
name | string |
name |
|
ext
|
ext | string |
ext |
|
size
|
size | integer |
size |
|
uploaderId
|
uploaderId | string |
uploaderId |
|
uploader
|
uploader | string |
uploader |
|
created
|
created | string |
created |
|
mimeType
|
mimeType | string |
mimeType |
|
version
|
version | integer |
version |
|
externalSourceUrl
|
externalSourceUrl | string |
externalSourceUrl |
|
streamAvailable
|
streamAvailable | boolean |
streamAvailable |
|
primaryStorageProvider
|
primaryStorageProvider | string |
primaryStorageProvider |
|
id
|
id | string |
id |
|
changedOn
|
changedOn | string |
changedOn |
|
changedBy
|
changedBy | string |
changedBy |
|
isDeleted
|
isDeleted | boolean |
isDeleted |
Add a tag to a document using a document id and tag id
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token used for authentication |
|
Document Id
|
documentId | True | string |
Id of the document |
|
Tag Id
|
tagId | True | string |
Id of the tag |
|
Retag
|
reTag | boolean |
Should we retag the document |
Returns
Update a field that's on a document
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token used for authentication |
|
Document Id
|
documentId | True | string |
Id of the document |
|
id
|
id | string |
id |
|
|
name
|
name | string |
name |
|
|
value
|
value | string |
value |
|
|
numberValue
|
numberValue | integer |
numberValue |
|
|
isRequired
|
isRequired | boolean |
isRequired |
|
|
fieldType
|
fieldType | integer |
fieldType |
|
|
users
|
users | array of string |
users |
Returns
Upload a document to Raptor Document Warehouse
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token
|
exa-auth-plugin | True | string |
Token used for authentication |
|
Name
|
name | string |
Name |
|
|
Content Type
|
Content-Type | string |
Content type |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
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 |
This is the type 'object'.
This is the basic data type 'string'.