@vidispine/vdt-api

0.13.0

access.listEntityAccess

APIdoc

GET /API/${entityType}/${entityId}/access/

access.listEntityAccess(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entityType string
obj.entityId string
Returns
Promise<Object>:

access.createEntityAccess

APIdoc

POST /API/${entityType}/${entityId}/access/

access.createEntityAccess(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entityType string
obj.entityId string
obj.accessControlDocument Object
Returns
Promise<Object>:

access.getEntityAccess

APIdoc

GET /API/${entityType}/${entityId}/access/${accessId}

access.getEntityAccess(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entityType string
obj.entityId string
obj.accessId string
Returns
Promise<Object>:

access.getEntityAccessMerged

APIdoc

GET /API/${entityType}/${entityId}/merged-access/

access.getEntityAccessMerged(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entityType string
obj.entityId string
Returns
Promise<Object>:

access.getEntityAccessMergedGroup

APIdoc

GET /API/${entityType}/${entityId}/merged-access/group

access.getEntityAccessMergedGroup(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entityType string
obj.entityId string
Returns
Promise<Object>:

access.removeEntityAccess

APIdoc

DELETE /API/${entityType}/${entityId}/access/${accessId}

access.removeEntityAccess(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entityType string
obj.entityId string
obj.accessId string
Returns
Promise<Object>:

access.updateEntityOwner

APIdoc

PUT /API/${entityType}/${entityId}/access/owner/${userName}

access.updateEntityOwner(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entityType string
obj.entityId string
obj.userName string
Returns
Promise<Object>:

access.createEntityAccessBulk

APIdoc

POST /API/${entityType}/${entityId}/access/bulk

access.createEntityAccessBulk(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entityType string
obj.entityId string
obj.accessControlListDocument Object
Returns
Promise<Object>:

access.removeEntityAccessBulk

APIdoc

DELETE /API/${entityType}/${entityId}/access/bulk

access.removeEntityAccessBulk(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entityType string
obj.entityId string
obj.accessControlListDocument Object
Returns
Promise<Object>:

access.getEntityAccessGraph

APIdoc

GET /API/${entityType}/${entityId}/access/graph

access.getEntityAccessGraph(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entityType string
obj.entityId string
Returns
Promise<Object>:

access.getEntityAccessGraphDot

APIdoc

GET /API/${entityType}/${entityId}/access/graph/dot

access.getEntityAccessGraphDot(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entityType string
obj.entityId string
Returns
Promise<Object>:

access.createItemAllAccess

APIdoc

GET /API/item/access/

access.createItemAllAccess(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.accessControlDocument Object
Returns
Promise<Object>:

access.removeItemAllAccess

APIdoc

DELETE /API/item/access/

access.removeItemAllAccess(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

access.getImportAccess

APIdoc

GET /API/import/access/

access.getImportAccess(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

access.updateImportAccessGroup

APIdoc

PUT /API/import/access/group/${groupName}

access.updateImportAccessGroup(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.groupName string
Returns
Promise<Object>:

access.removeImportAccessGroup

APIdoc

DELETE /API/import/access/group/${groupName}

access.removeImportAccessGroup(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.groupName string
Returns
Promise<Object>:

analyzepreset.listAnalyzePreset

n/a

GET /API/analyze-preset

analyzepreset.listAnalyzePreset(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

analyzepreset.getAnalyzePreset

n/a

GET /API/analyze-preset/${presetName}

analyzepreset.getAnalyzePreset(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

auditlog.listAuditLog

APIdoc

GET /API/log

auditlog.listAuditLog(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

auditlog.listAuditLog

APIdoc

GET /API/log/export

auditlog.listAuditLog(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

autoimport.listAutoImport

APIdoc

GET /API/storage/auto-import/

autoimport.listAutoImport(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

autoimport.updateAutoImport

APIdoc

PUT /API/storage/${storageId}/auto-import/

autoimport.updateAutoImport(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.storageId string
obj.autoImportRuleDocument Object
Returns
Promise<Object>:

autoimport.getAutoImport

APIdoc

GET /API/storage/${storageId}/auto-import/

autoimport.getAutoImport(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.storageId string
Returns
Promise<Object>:

autoimport.removeAutoImport

APIdoc

DELETE /API/storage/${storageId}/auto-import/

autoimport.removeAutoImport(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.storageId string
Returns
Promise<Object>:

autoimport.enableAutoImport

APIdoc

PUT /API/storage/${storageId}/auto-import/enable

autoimport.enableAutoImport(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.storageId string
Returns
Promise<Object>:

autoimport.disableAutoImport

APIdoc

PUT /API/storage/${storageId}/auto-import/disable

autoimport.disableAutoImport(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.storageId string
Returns
Promise<Object>:

autoprojection.listAutoProjection

APIdoc

GET /API/auto-projection

autoprojection.listAutoProjection(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

autoprojection.listDisabledAutoProjection

APIdoc

GET /API/auto-projection/disable

autoprojection.listDisabledAutoProjection(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

autoprojection.listEnabledAutoProjection

APIdoc

GET /API/auto-projection/enable

autoprojection.listEnabledAutoProjection(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

autoprojection.getAutoProjection

APIdoc

GET /API/auto-projection/${projectionName}

autoprojection.getAutoProjection(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.projectionName string
Returns
Promise<Object>:

autoprojection.createAutoProjection

APIdoc

PUT /API/auto-projection/${projectionName}

autoprojection.createAutoProjection(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.projectionName string
obj.autoProjectionRuleDocument Object
Returns
Promise<Object>:

autoprojection.removeAutoProjection

APIdoc

DELETE /API/auto-projection/${projectionName}

autoprojection.removeAutoProjection(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.projectionName string
Returns
Promise<Object>:

autoprojection.enableAutoProjection

APIdoc

PUT /API/auto-projection/${projectionName}/enable

autoprojection.enableAutoProjection(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.projectionName string
Returns
Promise<Object>:

autoprojection.disableAutoProjection

APIdoc

PUT /API/auto-projection/${projectionName}/disable

autoprojection.disableAutoProjection(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.projectionName string
Returns
Promise<Object>:

bulkymetadata.listItemBulkyMetadata

APIdoc

GET /API/item/${itemId}/metadata/bulky

bulkymetadata.listItemBulkyMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
Returns
Promise<Object>:

bulkymetadata.listShapeBulkyMetadata

APIdoc

GET /API/item/${itemId}/shape/${shapeId}/metadata/bulky

bulkymetadata.listShapeBulkyMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
obj.shapeId string
Returns
Promise<Object>:

bulkymetadata.updateAllItemBulkyMetadata

APIdoc

PUT /API/item/${itemId}/metadata/bulky

bulkymetadata.updateAllItemBulkyMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
obj.bulkyMetadataDocument Object
Returns
Promise<Object>:

bulkymetadata.updateAllShapeBulkyMetadata

APIdoc

PUT /API/item/${itemId}/shape/${shapeId}/metadata/bulky

bulkymetadata.updateAllShapeBulkyMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
obj.shapeId string
obj.bulkyMetadataDocument Object
Returns
Promise<Object>:

bulkymetadata.removeAllItemBulkyMetadata

APIdoc

DELETE /API/item/${itemId}/metadata/bulky

bulkymetadata.removeAllItemBulkyMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
Returns
Promise<Object>:

bulkymetadata.removeAllShapeBulkyMetadata

APIdoc

DELETE /API/item/${itemId}/shape/${shapeId}/metadata/bulky

bulkymetadata.removeAllShapeBulkyMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
obj.shapeId string
Returns
Promise<Object>:

bulkymetadata.getItemBulkyMetadata

APIdoc

GET /API/item/${itemId}/metadata/bulky/${key}

bulkymetadata.getItemBulkyMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
obj.key string
Returns
Promise<Object>:

bulkymetadata.getShapeBulkyMetadata

APIdoc

GET /API/item/${itemId}/shape/${shapeId}/metadata/bulky/${key}

bulkymetadata.getShapeBulkyMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
obj.shapeId string
obj.key string
Returns
Promise<Object>:

bulkymetadata.updateItemBulkyMetadata

APIdoc

PUT /API/item/${itemId}/metadata/bulky/${key}

bulkymetadata.updateItemBulkyMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
obj.key string
obj.value string
obj.headers Object
Returns
Promise<Object>:

bulkymetadata.updateShapeBulkyMetadata

APIdoc

PUT /API/item/${itemId}/shape/${shapeId}/metadata/bulky/${key}

bulkymetadata.updateShapeBulkyMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
obj.shapeId string
obj.key string
obj.value string
Returns
Promise<Object>:

bulkymetadata.removeItemBulkyMetadata

APIdoc

DELETE /API/item/${itemId}/metadata/bulky/${key}

bulkymetadata.removeItemBulkyMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
obj.key string
Returns
Promise<Object>:

bulkymetadata.removeShapeBulkyMetadata

APIdoc

DELETE /API/item/${itemId}/shape/${shapeId}/metadata/bulky/${key}

bulkymetadata.removeShapeBulkyMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
obj.shapeId string
obj.key string
Returns
Promise<Object>:

collection.listCollection

APIdoc

GET /API/collection/

collection.listCollection(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

collection.getCollection

APIdoc

GET /API/collection/${collectionId}/

collection.getCollection(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.collectionId string
Returns
Promise<Object>:

collection.getCollectionMetadata

APIdoc

GET /API/collection/${collectionId}/metadata

collection.getCollectionMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.collectionId string
Returns
Promise<Object>:

collection.updateCollectionMetadata

APIdoc

collection.updateCollectionMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.collectionId string
obj.metadataDocument Object
Returns
Promise<Object>:

collection.getCollectionAncestor

APIdoc

GET /API/collection/${collectionId}/ancestor

collection.getCollectionAncestor(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.collectionId string
Returns
Promise<Object>:

collection.listCollectionHistory

APIdoc

GET /API/collection/history

collection.listCollectionHistory(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

collection.getCollectionItem

APIdoc

GET /API/collection/${collectionId}/item

collection.getCollectionItem(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.collectionId string
Returns
Promise<Object>:

collection.searchCollection

APIdoc

PUT /API/collection/

collection.searchCollection(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemSearchDocument Object
Returns
Promise<Object>:

collection.searchCollectionItem

APIdoc

PUT /API/collection/${collectionId}/item

collection.searchCollectionItem(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.collectionId string
obj.searchDocument Object
Returns
Promise<Object>:

collection.createCollection

APIdoc

POST /API/collection

collection.createCollection(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.collectionDocument Object
obj.queryParams Object
Returns
Promise<Object>:

collection.removeCollection

APIdoc

DELETE /API/collection/${collectionId}/

collection.removeCollection(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.collectionId string
Returns
Promise<Object>:

collection.removeCollectionList

APIdoc

DELETE /API/collection

collection.removeCollectionList(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.queryParams Object
Returns
Promise<Object>:

collection.renameCollection

APIdoc

PUT /API/collection/${collectionId}/rename

collection.renameCollection(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.collectionId string
Returns
Promise<Object>:

collection.addCollectionEntity

APIdoc

PUT /API/collection/${collectionId}/${entityId}

collection.addCollectionEntity(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.collectionId string
obj.entityId string
Returns
Promise<Object>:

collection.removeCollectionEntity

APIdoc

DELETE /API/collection/${collectionId}/${entityId}

collection.removeCollectionEntity(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.collectionId string
obj.entityId string
Returns
Promise<Object>:

collection.updateCollection

APIdoc

PUT /API/collection/${collectionId}/

collection.updateCollection(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.collectionId string
obj.collectionDocument Object
Returns
Promise<Object>:

collection.orderCollection

APIdoc

POST /API/collection/${collectionId}/order

collection.orderCollection(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.collectionId string
obj.collectionReorderDocument Object
Returns
Promise<Object>:

collection.markFolderCollection

APIdoc

PUT /API/collection/${collectionId}/map-to-folder

collection.markFolderCollection(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.collectionId string
Returns
Promise<Object>:

collection.unMarkFolderCollection

APIdoc

DELETE /API/collection/${collectionId}/map-to-folder

collection.unMarkFolderCollection(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.collectionId string
Returns
Promise<Object>:

collection.updateFolderCollection

APIdoc

PUT /API/collection/${collectionId}/folder-name

collection.updateFolderCollection(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.collectionId string
obj.queryParams Object
Returns
Promise<Object>:

collection.listCollectionMetadataLock

APIdoc

collection.listCollectionMetadataLock(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.collectionId string
Returns
Promise<Object>:

collection.createCollectionMetadataLock

APIdoc

collection.createCollectionMetadataLock(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.collectionId string
Returns
Promise<Object>:

collection.getCollectionMetadataLock

APIdoc

collection.getCollectionMetadataLock(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.collectionId string
Returns
Promise<Object>:

collection.updateCollectionMetadataLock

APIdoc

collection.updateCollectionMetadataLock(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.collectionId string
Returns
Promise<Object>:

collection.removeCollectionMetadataLock

APIdoc

collection.removeCollectionMetadataLock(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.collectionId string
Returns
Promise<Object>:

component.listComponent

APIdoc

GET /API/item/${itemId}/shape/${shapeId}/component

component.listComponent(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
obj.shapeId string
Returns
Promise<Object>:

component.getComponent

APIdoc

GET /API/item/${itemId}/shape/${shapeId}/component/${componentId}

component.getComponent(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
obj.shapeId string
obj.componentId string
Returns
Promise<Object>:

component.removeComponent

APIdoc

DELETE /API/item/${itemId}/shape/${shapeId}/component/${componentId}

component.removeComponent(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
obj.shapeId string
obj.componentId string
Returns
Promise<Object>:

component.createComponent

APIdoc

POST /API/item/${itemId}/shape/${shapeId}/component

component.createComponent(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
obj.shapeId string
obj.queryParams Object
Returns
Promise<Object>:

component.createComponentPlaceholder

APIdoc

POST /API/item/${itemId}/shape/${shapeId}/component/placeholder

component.createComponentPlaceholder(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
obj.shapeId string
obj.queryParams Object
Returns
Promise<Object>:

component.moveComponent

APIdoc

POST /API/item/${itemId}/shape/${shapeId}/component/${componentId}/move/item/${targetItemId}/shape/${targetShapeId}/component/${targetComponentId}

component.moveComponent(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
obj.shapeId string
obj.componentId string
obj.targetItemId string
obj.targetShapeId string
obj.targetComponentId string
Returns
Promise<Object>:

component.moveComponentToShape

APIdoc

POST /API/item/${itemId}/shape/${shapeId}/component/${componentId}/move/item/${targetItemId}/shape/${targetShapeId}

component.moveComponentToShape(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
obj.shapeId string
obj.componentId string
obj.targetItemId string
obj.targetShapeId string
Returns
Promise<Object>:

component.copyComponent

APIdoc

POST /API/item/${itemId}/shape/${shapeId}/component/${componentId}/copy/item/${targetItemId}/shape/${targetShapeId}/component/${targetComponentId}

component.copyComponent(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
obj.shapeId string
obj.componentId string
obj.targetItemId string
obj.targetShapeId string
obj.targetComponentId string
Returns
Promise<Object>:

component.copyComponentToShape

APIdoc

POST /API/item/${itemId}/shape/${shapeId}/component/${componentId}/copy/item/${targetItemId}/shape/${targetShapeId}

component.copyComponentToShape(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
obj.shapeId string
obj.componentId string
obj.targetItemId string
obj.targetShapeId string
Returns
Promise<Object>:

component.addComponentFile

APIdoc

PUT /API/item/${itemId}/shape/${shapeId}/component/${componentId}/file/${fileId}

component.addComponentFile(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
obj.shapeId string
obj.componentId string
obj.fileId string
Returns
Promise<Object>:

component.removeComponentFile

APIdoc

PUT /API/item/${itemId}/shape/${shapeId}/component/${componentId}/file/${fileId}

component.removeComponentFile(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
obj.shapeId string
obj.componentId string
obj.fileId string
Returns
Promise<Object>:

configuration.getConfiguration

APIdoc

GET /API/configuration/

configuration.getConfiguration(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

configuration.getPropertiesConfiguration

APIdoc

GET /API/configuration/properties

configuration.getPropertiesConfiguration(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

configuration.updatePropertiesConfiguration

APIdoc

PUT /API/configuration/properties

configuration.updatePropertiesConfiguration(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.configurationPropertyDocument Object
Returns
Promise<Object>:

configuration.updateAllPropertiesConfiguration

APIdoc

POST /API/configuration/properties

configuration.updateAllPropertiesConfiguration(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.configurationPropertyListDocument Object
Returns
Promise<Object>:

configuration.removePropertiesConfiguration

APIdoc

DELETE /API/configuration/properties/${key}

configuration.removePropertiesConfiguration(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.key string
Returns
Promise<Object>:

configuration.getIndexingConfiguration

APIdoc

GET /API/configuration/indexing

configuration.getIndexingConfiguration(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

configuration.updateIndexingConfiguration

APIdoc

PUT /API/configuration/indexing

configuration.updateIndexingConfiguration(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.indexingConfigurationDocument Object
Returns
Promise<Object>:

configuration.getFtpPoolConfiguration

APIdoc

GET /API/configuration/ftp-pool

configuration.getFtpPoolConfiguration(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

configuration.updateFtpPoolConfiguration

APIdoc

PUT /API/configuration/ftp-pool

configuration.updateFtpPoolConfiguration(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.ftpPoolConfigurationDocument Object
Returns
Promise<Object>:

configuration.removeFtpPoolConfiguration

APIdoc

DELETE /API/configuration/ftp-pool

configuration.removeFtpPoolConfiguration(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

configuration.getJobPoolConfiguration

APIdoc

GET /API/configuration/job-pool

configuration.getJobPoolConfiguration(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

configuration.updateJobPoolConfiguration

APIdoc

PUT /API/configuration/job-pool

configuration.updateJobPoolConfiguration(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.jobPoolListDocument Object
Returns
Promise<Object>:

configuration.removeAllJobPoolConfiguration

APIdoc

DELETE /API/configuration/job-pool

configuration.removeAllJobPoolConfiguration(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

configuration.removeJobPoolConfiguration

APIdoc

DELETE /API/configuration/job-pool/${jobPoolPriority}

configuration.removeJobPoolConfiguration(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.jobPoolPriority string
Returns
Promise<Object>:

configuration.getMetricsConfiguration

APIdoc

GET /API/configuration/metrics

configuration.getMetricsConfiguration(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

configuration.updateMetricsConfiguration

APIdoc

PUT /API/configuration/metrics

configuration.updateMetricsConfiguration(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.metricsConfigurationDocument Object
Returns
Promise<Object>:

configuration.getPathAliasConfiguration

APIdoc

GET /API/configuration/path-alias

configuration.getPathAliasConfiguration(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

configuration.updatePathAliasConfiguration

APIdoc

PUT /API/configuration/path-alias

configuration.updatePathAliasConfiguration(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.pathAliasConfigurationDocument Object
Returns
Promise<Object>:

configuration.getLogReportConfiguration

APIdoc

GET /API/configuration/logreport

configuration.getLogReportConfiguration(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

configuration.updateLogReportConfiguration

APIdoc

PUT /API/configuration/logreport

configuration.updateLogReportConfiguration(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.logReportConfigurationDocument Object
Returns
Promise<Object>:

configuration.getDatabasePurgingConfiguration

APIdoc

GET /API/configuration/purging

configuration.getDatabasePurgingConfiguration(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

configuration.updateDatabasePurgingConfiguration

APIdoc

PUT /API/configuration/purging

configuration.updateDatabasePurgingConfiguration(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.databasePurgingConfigurationDocument Object
Returns
Promise<Object>:

configuration.removeDatabasePurgingConfiguration

APIdoc

DELETE /API/configuration/purging

configuration.removeDatabasePurgingConfiguration(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

configuration.getCorsConfiguration

APIdoc

GET /API/configuration/cors

configuration.getCorsConfiguration(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

configuration.updateCorsConfiguration

APIdoc

PUT /API/configuration/cors

configuration.updateCorsConfiguration(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.corsConfigurationDocument Object
Returns
Promise<Object>:

configuration.getAuthConfiguration

APIdoc

GET /API/configuration/auth

configuration.getAuthConfiguration(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

configuration.updateAuthConfiguration

APIdoc

PUT /API/configuration/auth

configuration.updateAuthConfiguration(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.oAuth2ConfigurationDocument Object
Returns
Promise<Object>:

configuration.removeAuthConfiguration

APIdoc

DELETE /API/configuration/auth

configuration.removeAuthConfiguration(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

configuration.getJobPriorityConfiguration

APIdoc

GET /API/configuration/job-priority

configuration.getJobPriorityConfiguration(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

configuration.updateJobPriorityConfiguration

APIdoc

PUT /API/configuration/job-priority

configuration.updateJobPriorityConfiguration(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.jobPriorityConfigurationDocument Object
Returns
Promise<Object>:

configuration.removeJobPriorityConfiguration

APIdoc

DELETE /API/configuration/job-priority

configuration.removeJobPriorityConfiguration(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

configuration.getBulkyMetadataConfiguration

APIdoc

GET /API/configuration/bulkymetadata

configuration.getBulkyMetadataConfiguration(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

configuration.updateBulkyMetadataConfiguration

APIdoc

PUT /API/configuration/bulkymetadata

configuration.updateBulkyMetadataConfiguration(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.bulkyMetadataConfigurationDocument Object
Returns
Promise<Object>:

conform.createConform

APIdoc

POST /API/conform

conform.createConform(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.conformRequestDocument Object
Returns
Promise<Object>:

conform.createConformItem

APIdoc

POST /API/item/${itemId}/timeline/${timelineFormat}/conform

conform.createConformItem(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
obj.timelineFormat string
obj.conformRequestDocument Object
Returns
Promise<Object>:

debug.echo

APIdoc

PUT /APInoauth/debug/echo

debug.echo(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.xmlDocument Object
Returns
Promise<Object>:

deletionlock.listDeletionLock

APIdoc

GET /API/deletion-lock

deletionlock.listDeletionLock(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

deletionlock.getDeletionLock

APIdoc

GET /API/deletion-lock/${lockId}

deletionlock.getDeletionLock(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.lockId string
Returns
Promise<Object>:

deletionlock.updateDeletionLock

APIdoc

PUT /API/deletion-lock/${lockId

deletionlock.updateDeletionLock(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.lockId string
obj.deletionLockDocument Object
Returns
Promise<Object>:

deletionlock.removeDeletionLock

APIdoc

DELETE /API/deletion-lock/${lockId}

deletionlock.removeDeletionLock(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.lockId string
Returns
Promise<Object>:

deletionlock.listEntityDeletionLock

APIdoc

GET /API/${entity}/${entityId}/deletion-lock/

deletionlock.listEntityDeletionLock(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entity string
obj.entityId string
Returns
Promise<Object>:

deletionlock.createEntityDeletionLock

APIdoc

POST /API/${entity}/${entityId}/deletion-lock/

deletionlock.createEntityDeletionLock(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entity string
obj.entityId string
obj.deletionLockDocument Object
Returns
Promise<Object>:

deletionlock.getEntityDeletionLock

APIdoc

GET /API/${entity}/${entityId}/deletion-lock/${lockId}

deletionlock.getEntityDeletionLock(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entity string
obj.entityId string
obj.lockId string
Returns
Promise<Object>:

deletionlock.updateEntityDeletionLock

APIdoc

PUT /API/${entity}/${entityId}/deletion-lock/${lockId}

deletionlock.updateEntityDeletionLock(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entity string
obj.entityId string
obj.lockId string
obj.deletionLockDocument Object
Returns
Promise<Object>:

deletionlock.removeEntityDeletionLock

APIdoc

DELETE /API/${entity}/${entityId}/deletion-lock/${lockId}

deletionlock.removeEntityDeletionLock(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entity string
obj.entityId string
obj.lockId string
Returns
Promise<Object>:

documentmetadata.listDocumentMetadata

APIdoc

GET /API/document/

documentmetadata.listDocumentMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

documentmetadata.searchDocumentMetadata

APIdoc

PUT /API/document/

documentmetadata.searchDocumentMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemSearchDocument Object
Returns
Promise<Object>:

documentmetadata.getDocumentMetadata

APIdoc

GET /API/document/${documentMetadataName}

documentmetadata.getDocumentMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.documentMetadataName string
Returns
Promise<Object>:

documentmetadata.updateDocumentMetadata

APIdoc

PUT /API/document/${documentMetadataName}

documentmetadata.updateDocumentMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.documentMetadataName string
obj.metadataDocument Object
Returns
Promise<Object>:

documentmetadata.getDocumentMetadataChanges

APIdoc

GET /API/document/${documentMetadataName}/changes

documentmetadata.getDocumentMetadataChanges(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.documentMetadataName string
Returns
Promise<Object>:

documentmetadata.removeDocumentMetadata

APIdoc

DELETE /API/document/${documentMetadataName}

documentmetadata.removeDocumentMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.documentMetadataName string
Returns
Promise<Object>:

errorlog.listErrorLogs

APIdoc

GET /API/error

errorlog.listErrorLogs(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

exportlocation.listExportLocation

APIdoc

GET /API/export-location

exportlocation.listExportLocation(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

exportlocation.getExportLocation

APIdoc

GET /API/export-location/${locationName}

exportlocation.getExportLocation(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.locationName string
Returns
Promise<Object>:

exportlocation.updateExportLocation

APIdoc

PUT /API/export-location/${locationName}

exportlocation.updateExportLocation(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.locationName string
obj.exportLocationDocument Object
Returns
Promise<Object>:

exportlocation.removeExportLocation

APIdoc

DELETE /API/export-location/${locationName}

exportlocation.removeExportLocation(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.locationName string
Returns
Promise<Object>:

exportlocation.getExportLocationScript

APIdoc

GET /API/export-location/${locationName}/script

exportlocation.getExportLocationScript(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.locationName string
Returns
Promise<Object>:

exportlocation.updateExportLocationScript

APIdoc

PUT /API/export-location/${locationName}/script

exportlocation.updateExportLocationScript(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.locationName string
obj.exportScript string
Returns
Promise<Object>:

exporttemplate.listExportTemplate

APIdoc

GET /API/export-template

exporttemplate.listExportTemplate(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

exporttemplate.getExportTemplate

APIdoc

GET /API/export-template/${templateName}

exporttemplate.getExportTemplate(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.templateName string
Returns
Promise<Object>:

exporttemplate.getExportTemplate

APIdoc

DELTE /API/export-template/${templateName}

exporttemplate.getExportTemplate(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.templateName string
Returns
Promise<Object>:

exporttemplate.createExportTemplate

APIdoc

PUT /API/export-template/${templateName}

exporttemplate.createExportTemplate(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.templateName string
obj.exportTemplateDocument string
Returns
Promise<Object>:

exporttemplate.updateExportTemplate

APIdoc

PUT /API/export-template/${templateName}

exporttemplate.updateExportTemplate(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.templateName string
obj.exportTemplateDocument string
Returns
Promise<Object>:

exporttemplate.getExportTemplateGraph

APIdoc

GET /API/export-template/${templateName}/graph

exporttemplate.getExportTemplateGraph(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.templateName string
Returns
Promise<Object>:

exporttemplate.getExportTemplateGraphDot

APIdoc

GET /API/export-template/${templateName}/graph/dot

exporttemplate.getExportTemplateGraphDot(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.templateName string
Returns
Promise<Object>:

exporttemplate.createExportTemplateTest

APIdoc

POST /API/export-template/test

exporttemplate.createExportTemplateTest(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

exporttemplate.createExportTemplateTestRender

APIdoc

PUT /API/export-template/test

exporttemplate.createExportTemplateTestRender(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

externalid.listExternalIdNamespace

APIdoc

GET /API/external-id

externalid.listExternalIdNamespace(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

externalid.getExternalIdNamespace

APIdoc

GET /API/external-id/${idName}

externalid.getExternalIdNamespace(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.idName string
Returns
Promise<Object>:

externalid.updateExternalIdNamespace

APIdoc

PUT /API/external-id/${idName}

externalid.updateExternalIdNamespace(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.idName string
obj.externalIdentifierNamespaceDocument Object
Returns
Promise<Object>:

externalid.removeExternalIdNamespace

APIdoc

DELETE /API/external-id/${idName}

externalid.removeExternalIdNamespace(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.idName string
Returns
Promise<Object>:

externalid.listExternalId

APIdoc

GET /API/${getEntityTypeUrl(entityType)}/${entityId}/external-id/

externalid.listExternalId(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entityType string
obj.entityId string
Returns
Promise<Object>:

externalid.createExternalId

APIdoc

PUT /API/${getEntityTypeUrl(entityType)}/${entityId}/external-id/${externalId}

externalid.createExternalId(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entityType string
obj.entityId string
obj.externalId string
Returns
Promise<Object>:

externalid.removeExternalId

APIdoc

PUT /API/${getEntityTypeUrl(entityType)}/${entityId}/external-id/${externalId}

externalid.removeExternalId(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entityType string
obj.entityId string
obj.externalId string
Returns
Promise<Object>:

externalid.removeAllExternalId

APIdoc

DELETE /API/${getEntityTypeUrl(entityType)}/${entityId}/external-id

externalid.removeAllExternalId(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entityType string
obj.entityId string
Returns
Promise<Object>:

fieldgroup.listFieldGroup

APIdoc

GET /API/metadata-field/field-group/

fieldgroup.listFieldGroup(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

fieldgroup.getFieldGroup

APIdoc

GET /API/metadata-field/field-group/${groupName}/

fieldgroup.getFieldGroup(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.groupName string
Returns
Promise<Object>:

fieldgroup.updateFieldGroup

APIdoc

PUT /API/metadata-field/field-group/${groupName}

fieldgroup.updateFieldGroup(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.groupName string
obj.metadataFieldGroupDocument Object
Returns
Promise<Object>:

fieldgroup.removeFieldGroup

APIdoc

DELETE /API/metadata-field/field-group/${groupName}

fieldgroup.removeFieldGroup(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.groupName string
Returns
Promise<Object>:

fieldgroup.updateFieldGroupField

APIdoc

PUT /API/metadata-field/field-group/${groupName}/${fieldName}

fieldgroup.updateFieldGroupField(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.groupName string
obj.fieldName string
Returns
Promise<Object>:

fieldgroup.removeFieldGroupField

APIdoc

DELETE /API/metadata-field/field-group/${groupName}/${fieldName}

fieldgroup.removeFieldGroupField(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.groupName string
obj.fieldName string
Returns
Promise<Object>:

fieldgroup.updateFieldGroupChild

APIdoc

PUT /API/metadata-field/field-group/${groupName}/group/${childGroupName}

fieldgroup.updateFieldGroupChild(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.groupName string
obj.childGroupName string
Returns
Promise<Object>:

fieldgroup.removeFieldGroupChild

APIdoc

DELETE /API/metadata-field/field-group/${groupName}/group/${childGroupName}

fieldgroup.removeFieldGroupChild(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.groupName string
obj.childGroupName string
Returns
Promise<Object>:

fieldgroup.searchFieldGroup

APIdoc

PUT /API/metadata-field/field-group/

fieldgroup.searchFieldGroup(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.metadataFieldGroupSearchDocument Object
Returns
Promise<Object>:

fieldgroup.getSimpleMetadata

APIdoc

GET /API/metadata-field/field-group/metadata

fieldgroup.getSimpleMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.groupName string
Returns
Promise<Object>:

fieldgroup.listFieldGroupAccess

APIdoc

GET /API/metadata-field/field-group/${groupName}/access

fieldgroup.listFieldGroupAccess(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.groupName string
Returns
Promise<Object>:

fieldgroup.createFieldGroupAccess

APIdoc

POST /API/metadata-field/field-group/${groupName}/access

fieldgroup.createFieldGroupAccess(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.groupName string
obj.metadataFieldAccessControlDocument Object
Returns
Promise<Object>:

fieldgroup.removeFieldGroupAccess

APIdoc

DELETE /API/metadata-field/field-group/${groupName}/access/${accessId}

fieldgroup.removeFieldGroupAccess(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.groupName string
obj.accessId string
Returns
Promise<Object>:

fieldgroup.listFieldGroupMergedAccess

APIdoc

GET /API/metadata-field/field-group/merged-access

fieldgroup.listFieldGroupMergedAccess(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

fieldgroup.getFieldGroupMergedAccess

APIdoc

GET /API/metadata-field/field-group/${groupName}/merged-access

fieldgroup.getFieldGroupMergedAccess(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.groupName string
Returns
Promise<Object>:

file.listFile

APIdoc

GET /API/storage/file/

file.listFile(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

file.listFileStorage

APIdoc

GET /API/storage/${storageId}/file/

file.listFileStorage(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.storageId string
Returns
Promise<Object>:

file.listFileImportable

APIdoc

GET /API/storage/file/importable/

file.listFileImportable(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

file.listFileStorageImportable

APIdoc

GET

file.listFileStorageImportable(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.storageId string
Returns
Promise<Object>:

file.getFile

APIdoc

GET /API/storage/file/${fileId}/

file.getFile(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.fileId string
Returns
Promise<Object>:

file.createFileRaw

APIdoc

POST /API/storage/${storageId}/file/data

file.createFileRaw(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.storageId string
obj.file Object
Returns
Promise<Object>:

file.getFileRaw

APIdoc

GET /API/storage/file/${fileId}/data

file.getFileRaw(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.fileId string
Returns
Promise<Object>:

file.updateFileRaw

APIdoc

POST /API/storage/file/${fileId}/data/

file.updateFileRaw(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.fileId string
obj.file Object
Returns
Promise<Object>:

file.createFileImport

APIdoc

POST /API/storage/file/${fileId}/import/

file.createFileImport(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.fileId string
Returns
Promise<Object>:

file.createFileImportAssetMap

APIdoc

POST /API/storage/file/${fileId}/import/assetmap

file.createFileImportAssetMap(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.fileId string
obj.metadataDocument Object
Returns
Promise<Object>:

file.createFilePathImportAssetMap

APIdoc

POST /API/storage/${storageId}/file/import/assetmap

file.createFilePathImportAssetMap(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.storageId string
obj.metadataDocument Object
Returns
Promise<Object>:

file.createFileImportPath

APIdoc

POST /API/storage/${storageId}/import/

file.createFileImportPath(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.storageId string
obj.metadataDocument Object
Returns
Promise<Object>:

file.createFileMove

APIdoc

POST /API/storage/file/${fileId}/storage/${targetStorageId}/

file.createFileMove(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.fileId string
obj.targetStorageId string
Returns
Promise<Object>:

file.removeFile

APIdoc

DELETE /API/storage/file/${fileId}

file.removeFile(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.fileId string
Returns
Promise<Object>:

file.createFileEntity

APIdoc

POST /API/storage/${storageId}/file/

file.createFileEntity(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.storageId string
obj.fileDocument Object
Returns
Promise<Object>:

file.removeFileEntity

APIdoc

DELETE /API/storage/file/${fileId}/entity

file.removeFileEntity(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.fileId string
Returns
Promise<Object>:

file.createFilePath

APIdoc

POST /API/storage/file/${fileId}/path/

file.createFilePath(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.fileId string
Returns
Promise<Object>:

file.updateFileState

APIdoc

PUT /API/storage/file/${fileId}/state/${state}

file.updateFileState(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.fileId string
obj.state string
Returns
Promise<Object>:

file.updateFileHash

APIdoc

PUT /API/storage/file/${fileId}/hash/${hash}

file.updateFileHash(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.fileId string
obj.hash string
Returns
Promise<Object>:

file.abandonFile

APIdoc

PUT /API/storage/file/${fileId}/abandon

file.abandonFile(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.fileId string
Returns
Promise<Object>:

file.reindexFile

APIdoc

PUT /API/storage/file/${fileId}/re-index

file.reindexFile(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.fileId string
Returns
Promise<Object>:

file.createFileTemporaryCredentials

APIdoc

POST /API/storage/file/${fileId}/uri

file.createFileTemporaryCredentials(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.fileId string
Returns
Promise<Object>:

file.analyzeFile

APIdoc

POST /API/storage/file/${fileId}/analyze

file.analyzeFile(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.fileId string
Returns
Promise<Object>:

file.analyzeFileImp

APIdoc

POST /API/storage/file/${fileId}/analyze/imp

file.analyzeFileImp(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.fileId string
Returns
Promise<Object>:

file.listFileShapes

APIdoc

GET /API/storage/file/${fileId}/shape

file.listFileShapes(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.fileId string
Returns
Promise<Object>:

globalmetadata.listGlobalMetadata

APIdoc

GET /API/metadata

globalmetadata.listGlobalMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

globalmetadata.updateGlobalMetadata

APIdoc

PUT /API/metadata

globalmetadata.updateGlobalMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.metadataDocument Object
Returns
Promise<Object>:

globalmetadata.getGlobalMetadata

APIdoc

GET /API/metadata/${uuid}

globalmetadata.getGlobalMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.uuid string
Returns
Promise<Object>:

globalmetadata.removeGlobalMetadata

APIdoc

DELETE /API/metadata/${uuid}

globalmetadata.removeGlobalMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.uuid string
Returns
Promise<Object>:

group.listGroup

APIdoc

GET /API/group/

group.listGroup(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

group.getGroup

APIdoc

GET /API/group/${groupName}

group.getGroup(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.groupName string
Returns
Promise<Object>:

group.updateGroup

APIdoc

PUT /API/group/${groupName}/

group.updateGroup(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.groupName string
obj.groupDocument Object
Returns
Promise<Object>:

group.removeGroup

APIdoc

DELETE /API/group/${groupName}

group.removeGroup(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.groupName string
Returns
Promise<Object>:

group.removeGroupList

APIdoc

DELETE /API/group/

group.removeGroupList(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

group.searchGroup

APIdoc

PUT /API/group/

group.searchGroup(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.groupSearchDocument Object
Returns
Promise<Object>:

group.getGroupRoleStatus

APIdoc

GET API/group/${groupName}/role

group.getGroupRoleStatus(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.groupName string
Returns
Promise<Object>:

group.getGroupDescription

APIdoc

GET /API/group/${groupName}/description

group.getGroupDescription(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.groupName string
Returns
Promise<Object>:

group.updateGroupDescription

APIdoc

PUT /API/group/${groupName}/description

group.updateGroupDescription(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.groupName string
obj.description string
Returns
Promise<Object>:

group.getGroupParents

APIdoc

GET /API/group/${groupName}/parents/

group.getGroupParents(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.groupName string
Returns
Promise<Object>:

group.getGroupChildren

APIdoc

GET /API/group/${groupName}/children/

group.getGroupChildren(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.groupName string
Returns
Promise<Object>:

group.addGroupChildren

APIdoc

PUT /API/group/${groupName}/group/${childGroupName}

group.addGroupChildren(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.groupName string
obj.childGroupName string
Returns
Promise<Object>:

group.removeGroupChildren

APIdoc

DELETE /API/group/${groupName}/group/${childGroupName}

group.removeGroupChildren(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.groupName string
obj.childGroupName string
Returns
Promise<Object>:

group.getGroupUser

APIdoc

GET /API/group/${groupName}/users/

group.getGroupUser(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.groupName string
Returns
Promise<Object>:

group.addGroupUser

APIdoc

PUT /API/group/${groupName}/user/${userName}

group.addGroupUser(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.groupName string
obj.userName string
Returns
Promise<Object>:

group.removeGroupUser

APIdoc

DELETE /API/group/${groupName}/user/${userName}

group.removeGroupUser(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.groupName string
obj.userName string
Returns
Promise<Object>:

vsimport.createImportUri

APIdoc

POST /API/import/

vsimport.createImportUri(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.metadataDocument Object
Returns
Promise<Object>:

vsimport.getImportStorage

APIdoc

GET /API/import/storage

vsimport.getImportStorage(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

vsimport.createImportRaw

APIdoc

POST /API/import/raw/

vsimport.createImportRaw(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.file Object
Returns
Promise<Object>:

vsimport.createImportRawNoAuth

APIdoc

POST /APInoauth/import/raw/

vsimport.createImportRawNoAuth(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.file Object
Returns
Promise<Object>:

vsimport.createImportRawPasskey

APIdoc

POST /API/import/raw-passkey/

vsimport.createImportRawPasskey(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.metadataDocument Object
Returns
Promise<Object>:

vsimport.createImportImp

APIdoc

POST /API/import/imp/

vsimport.createImportImp(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.metadataDocument Object
Returns
Promise<Object>:

vsimport.createImportPlaceholder

APIdoc

POST /API/import/placeholder/

vsimport.createImportPlaceholder(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.metadataDocument Object
Returns
Promise<Object>:

vsimport.createImportComponent

APIdoc

POST /API/import/placeholder/${itemId}/${component}/

vsimport.createImportComponent(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
obj.component string
Returns
Promise<Object>:

vsimport.createImportComponentRaw

APIdoc

POST /API/import/placeholder/${itemId}/${component}/raw/

vsimport.createImportComponentRaw(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
obj.component string
obj.file Object
Returns
Promise<Object>:

vsimport.createImportComponentRawNoAuth

APIdoc

POST /APInoauth/import/placeholder/${itemId}/${component}/raw/

vsimport.createImportComponentRawNoAuth(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
obj.component string
obj.file Object
Returns
Promise<Object>:

vsimport.createImportItem

APIdoc

POST /API/import/placeholder/${itemId}/

vsimport.createImportItem(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
obj.placeholderImportRequestDocument Object
Returns
Promise<Object>:

vsimport.createImportItemPasskey

APIdoc

POST /API/import/placeholder/${itemId}/raw-passkey/

vsimport.createImportItemPasskey(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
Returns
Promise<Object>:

vsimport.createImportItemAdoptFile

APIdoc

POST /API/import/placeholder/${itemId}/${component}/adopt/${fileId}/

vsimport.createImportItemAdoptFile(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
obj.component string
obj.fileId string
Returns
Promise<Object>:

vsimport.createImportItemSidecar

APIdoc

POST /API/import/sidecar/${itemId}/

vsimport.createImportItemSidecar(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
Returns
Promise<Object>:

vsimport.createImportItemSidecarRaw

APIdoc

POST /API/import/sidecar/${itemId}/raw/

vsimport.createImportItemSidecarRaw(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
obj.file Object
Returns
Promise<Object>:

importsettings.listImportSettings

APIdoc

GET /API/import/settings

importsettings.listImportSettings(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

importsettings.createImportSettings

APIdoc

POST /API/import/settings

importsettings.createImportSettings(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.importSettingsDocument Object
Returns
Promise<Object>:

importsettings.getImportSettings

APIdoc

GET /API/import/settings/${settingsId}

importsettings.getImportSettings(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.settingsId string
Returns
Promise<Object>:

importsettings.updateImportSettings

APIdoc

PUT /API/import/settings/${settingsId}

importsettings.updateImportSettings(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.settingsId string
obj.importSettingsDocument Object
Returns
Promise<Object>:

importsettings.removeImportSettings

APIdoc

DELETE /API/import/settings/${settingsId}

importsettings.removeImportSettings(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.settingsId string
Returns
Promise<Object>:

item.listItem

APIdoc

GET /API/item/

item.listItem(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

item.getItem

APIdoc

GET /API/item/${itemId}/

item.getItem(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
Returns
Promise<Object>:

item.getItemUri

APIdoc

GET /API/item/${itemId}/uri

item.getItemUri(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
Returns
Promise<Object>:

item.removeItem

APIdoc

DELETE /API/item/${itemId}/

item.removeItem(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
Returns
Promise<Object>:

item.removeItemList

APIdoc

DELETE /API/item/

item.removeItemList(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

item.searchItem

APIdoc

PUT /API/item/

item.searchItem(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemSearchDocument Object
Returns
Promise<Object>:

item.updateItemMetadata

APIdoc

PUT /API/item/metadata

item.updateItemMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
obj.metadataDocument Object
Returns
Promise<Object>:

item.getItemMetadata

APIdoc

GET /API/item/metadata

item.getItemMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
Returns
Promise<Object>:

item.createThumbnail

APIdoc

POST /API/item/${itemId}/thumbnail

item.createThumbnail(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
Returns
Promise<Object>:

item.createTranscode

APIdoc

POST /API/item/${itemId}/transcode

item.createTranscode(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
Returns
Promise<Object>:

item.createExport

APIdoc

POST /API/item/${itemId}/export

item.createExport(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
Returns
Promise<Object>:

item.createExportImp

APIdoc

POST /API/item/${itemId}/export/imp

item.createExportImp(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
Returns
Promise<Object>:

item.listItemRelation

APIdoc

GET /API/item/${itemId}/relation

item.listItemRelation(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
Returns
Promise<Object>:

item.createItemRelation

APIdoc

POST /API/item/${itemId}/relation/${relationItemId}

item.createItemRelation(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
obj.relationItemId string
Returns
Promise<Object>:

item.createItemRelationList

APIdoc

POST /API/relation/

item.createItemRelationList(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemRelationListDocument string
Returns
Promise<Object>:

item.removeItemRelation

APIdoc

DELETE /API/item/${itemId}/relation/${relationItemId}

item.removeItemRelation(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
obj.relationItemId string
Returns
Promise<Object>:

item.removeAllItemRelation

APIdoc

DELETE /API/item/${itemId}/relation/

item.removeAllItemRelation(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
Returns
Promise<Object>:

item.createRelation

APIdoc

POST /API/relation

item.createRelation(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemRelationListDocument Object
Returns
Promise<Object>:

item.getRelation

APIdoc

GET /API/relation/${relationId}/

item.getRelation(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.relationId string
Returns
Promise<Object>:

item.updateRelation

APIdoc

PUT /API/relation/${relationId}/

item.updateRelation(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.relationId string
Returns
Promise<Object>:

item.removeRelation

APIdoc

DELETE /API/relation/${relationId}/

item.removeRelation(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.relationId string
Returns
Promise<Object>:

item.getItemSearchHistory

APIdoc

GET /API/item/history

item.getItemSearchHistory(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

item.reindexItem

APIdoc

PUT /API/item/${itemId}/re-index

item.reindexItem(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
Returns
Promise<Object>:

item.createItemList

APIdoc

POST /API/item/list

item.createItemList(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

item.listItemCollection

APIdoc

GET /API/item/${itemId}/collections

item.listItemCollection(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
Returns
Promise<Object>:

item.listItemLibrary

APIdoc

GET /API/item/${itemId}/library

item.listItemLibrary(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
Returns
Promise<Object>:

item.createItemLock

APIdoc

POST /API/item/${itemId}/lock

item.createItemLock(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
Returns
Promise<Object>:

item.getItemLock

APIdoc

GET /API/item/${itemId}/lock

item.getItemLock(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
Returns
Promise<Object>:

item.removeItemLock

APIdoc

DELETE /API/item/${itemId}/lock

item.removeItemLock(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
Returns
Promise<Object>:

item.updateItemLock

APIdoc

PUT /API/item/${itemId}/lock

item.updateItemLock(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
Returns
Promise<Object>:

item.listItemMetadataLock

APIdoc

GET /API/item/${itemId}/metadata-lock

item.listItemMetadataLock(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
Returns
Promise<Object>:

item.createItemMetadataLock

APIdoc

POST /API/item/${itemId}/metadata-lock

item.createItemMetadataLock(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
Returns
Promise<Object>:

item.getItemMetadataLock

APIdoc

GET /API/item/${itemId}/metadata-lock/${lockId}

item.getItemMetadataLock(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
obj.lockId string
Returns
Promise<Object>:

item.updateItemMetadataLock

APIdoc

PUT /API/item/${itemId}/metadata-lock/${lockId}

item.updateItemMetadataLock(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
obj.lockId string
Returns
Promise<Object>:

item.removeItemMetadataLock

APIdoc

DELETE /API/item/${itemId}/metadata-lock/${lockId}

item.removeItemMetadataLock(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
obj.lockId string
Returns
Promise<Object>:

item.getItemLoudness

APIdoc

GET /API/item/${itemId}/loudness

item.getItemLoudness(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
Returns
Promise<Object>:

item.getItemLoudnessInterval

APIdoc

PUT /API/item/${itemId}/loudness

item.getItemLoudnessInterval(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
Returns
Promise<Object>:

item.getItemWaveformValue

APIdoc

GET /API/item/${itemId}/waveform/values

item.getItemWaveformValue(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
Returns
Promise<Object>:

item.getItemWaveformImage

APIdoc

GET /API/item/${itemId}/waveform/image

item.getItemWaveformImage(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
Returns
Promise<Object>:

item.getItemWaveformImageUri

APIdoc

GET /API/item/${itemId}/waveform/imageURI

item.getItemWaveformImageUri(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
Returns
Promise<Object>:

item.getItemWaveformImageUri

APIdoc

GET /API/item/${itemId}/analyze

item.getItemWaveformImageUri(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
obj.analyzeJobDocument Object
Returns
Promise<Object>:

item.getItemWaveformImageAllTracks

APIdoc

GET /API/item/${itemId}/waveform/alltracks

item.getItemWaveformImageAllTracks(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemId string
Returns
Promise<Object>:

javascript.test

APIdoc

POST /API/javascript/test

javascript.test(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.javascriptDocument Object
Returns
Promise<Object>:

job.listJob

APIdoc

GET /API/job/

job.listJob(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

job.searchJob

APIdoc

PUT /API/job/search

job.searchJob(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.jobSearchDocument Object
Returns
Promise<Object>:

job.getJob

APIdoc

GET /API/job/${jobId}

job.getJob(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.jobId string
Returns
Promise<Object>:

job.createJob

APIdoc

POST /API/job

job.createJob(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.simpleMetadataDocument Object
Returns
Promise<Object>:

job.duplicateJob

APIdoc

POST /API/job/${jobId}/re-run

job.duplicateJob(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.jobId string
Returns
Promise<Object>:

job.modifyJob

APIdoc

PUT /API/job/${jobId}

job.modifyJob(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.jobId string
Returns
Promise<Object>:

job.abortJob

APIdoc

DELETE /API/job/${jobId}

job.abortJob(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.jobId string
Returns
Promise<Object>:

job.deleteJob

APIdoc

DELETE /API/job/

job.deleteJob(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

job.listJobNotification

APIdoc

job.listJobNotification(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

library.listLibrary

APIdoc

GET /API/library/

library.listLibrary(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

library.createLibrary

APIdoc

POST /API/library/

library.createLibrary(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.itemListDocument Object
Returns
Promise<Object>:

library.removeLibrary

APIdoc

DELETE /API/library/${libraryId}

library.removeLibrary(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.libraryId string
Returns
Promise<Object>:

library.removeLibraryList

APIdoc

DELETE /API/library

library.removeLibraryList(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

library.getLibrary

APIdoc

GET /API/library/${libraryId}

library.getLibrary(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.libraryId string
Returns
Promise<Object>:

library.updateLibrary

APIdoc

PUT /API/library/${libraryId}

library.updateLibrary(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.libraryId string
obj.itemListDocument Object
Returns
Promise<Object>:

library.addLibraryItem

APIdoc

DELETE /API/library/${libraryId}/${itemId}

library.addLibraryItem(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.libraryId string
obj.itemId string
Returns
Promise<Object>:

library.removeLibraryItem

APIdoc

PUT /API/library/${libraryId}/${itemId}

library.removeLibraryItem(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.libraryId string
obj.itemId string
Returns
Promise<Object>:

library.updateLibraryItemMetadata

APIdoc

PUT /API/library/${libraryId}/item-metadata

library.updateLibraryItemMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.libraryId string
obj.metadataDocument Object
Returns
Promise<Object>:

library.getLibrarySettings

APIdoc

GET /API/library/${libraryId}/settings

library.getLibrarySettings(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.libraryId string
Returns
Promise<Object>:

library.updateLibrarySettings

APIdoc

PUT /API/library/${libraryId}/settings

library.updateLibrarySettings(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.libraryId string
obj.librarySettingsDocument Object
Returns
Promise<Object>:

library.getLibraryBatch

APIdoc

POST /API/library/${libraryId}/list

library.getLibraryBatch(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.libraryId string
Returns
Promise<Object>:

license.createLicense

APIdoc

POST /API/license

license.createLicense(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.file Object
Returns
Promise<Object>:

metadata.updateEntityMetadata

APIdoc

PUT /API/${entity}/${entityId}/metadata

metadata.updateEntityMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entity string
obj.entityId string
Returns
Promise<Object>:

metadata.moveEntityMetadata

APIdoc

PUT /API/${entity}/${entityId}/metadata/move

metadata.moveEntityMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entity string
obj.entityId string
Returns
Promise<Object>:

metadata.listEntityMetadataChange

APIdoc

GET /API/${entity}/${entityId}/metadata/changes

metadata.listEntityMetadataChange(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entity string
obj.entityId string
Returns
Promise<Object>:

metadata.getEntityMetadataChange

APIdoc

GET /API/${entity}/${entityId}/metadata/changes/${changesetId}

metadata.getEntityMetadataChange(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entity string
obj.entityId string
obj.changesetId string
Returns
Promise<Object>:

metadata.previousEntityMetadataChange

APIdoc

GET /API/${entity}/${entityId}/metadata/changes/${changesetId}/compareTo/previous

metadata.previousEntityMetadataChange(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entity string
obj.entityId string
obj.changesetId string
Returns
Promise<Object>:

metadata.compareEntityMetadataChange

APIdoc

GET /API/${entity}/${entityId}/metadata/changes/${changesetId}/compareTo/${fromChangesetId}

metadata.compareEntityMetadataChange(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entity string
obj.entityId string
obj.changesetId string
obj.fromChangesetId string
Returns
Promise<Object>:

metadata.updateEntityMetadataChange

APIdoc

PUT /API/${entity}/${entityId}/metadata/changes/${changesetId}/

metadata.updateEntityMetadataChange(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entity string
obj.entityId string
obj.changesetId string
obj.metadataDocument Object
Returns
Promise<Object>:

metadata.updateAllEntityMetadataChange

APIdoc

PUT /API/${entity}/${entityId}/metadata/changes

metadata.updateAllEntityMetadataChange(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entity string
obj.entityId string
obj.metadataChangeSetDocument Object
Returns
Promise<Object>:

metadata.trimAllEntityMetadataChange

APIdoc

PUT /API/${entity}/${entityId}/metadata/changes/trim

metadata.trimAllEntityMetadataChange(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entity string
obj.entityId string
Returns
Promise<Object>:

metadata.trimEntityMetadataChange

APIdoc

PUT /API/${entity}/${entityId}/metadata/changes/${changesetId}/trim

metadata.trimEntityMetadataChange(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entity string
obj.entityId string
obj.changesetId string
Returns
Promise<Object>:

metadata.removeEntityMetadataChange

APIdoc

DELETE /API/${entity}/${entityId}/metadata/changes/${changesetId}

metadata.removeEntityMetadataChange(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entity string
obj.entityId string
obj.changesetId string
Returns
Promise<Object>:

metadata.updateEntityMetadataEntry

APIdoc

PUT /API/${entity}/${entityId}/metadata/entry/${uuid}

metadata.updateEntityMetadataEntry(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entity string
obj.entityId string
obj.uuid string
obj.metadataEntryDocument Object
Returns
Promise<Object>:

metadata.updateAllEntityMetadataEntry

APIdoc

PUT /API/${entity}/${entityId}/metadata/entry/

metadata.updateAllEntityMetadataEntry(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entity string
obj.entityId string
obj.metadataEntryListDocument Object
Returns
Promise<Object>:

metadata.getEntityMetadataGraph

APIdoc

GET /API/${entity}/${entityId}/metadata/graph

metadata.getEntityMetadataGraph(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entity string
obj.entityId string
Returns
Promise<Object>:

metadata.getEntityMetadataGraphDot

APIdoc

GET /API/${entity}/${entityId}/metadata/graph/dot

metadata.getEntityMetadataGraphDot(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entity string
obj.entityId string
Returns
Promise<Object>:

metadata.getEntityMetadata

APIdoc

GET /API/${entity}/${entityId}/metadata

metadata.getEntityMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entity string
obj.entityId string
Returns
Promise<Object>:

metadata.getMetadata

APIdoc

GET /API/metadata/${metadataUuid}/

metadata.getMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.metadataUuid string
Returns
Promise<Object>:

metadata.removeMetadata

APIdoc

DELETE /API/metadata/${metadataUuid}/

metadata.removeMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.metadataUuid string
Returns
Promise<Object>:

metadata.getMetadataGlobal

APIdoc

GET /API/metadata/

metadata.getMetadataGlobal(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

metadata.updateMetadataGlobal

APIdoc

PUT /API/metadata/

metadata.updateMetadataGlobal(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.metadataDocument Object
Returns
Promise<Object>:

metadata.getSimpleMetadata

APIdoc

GET /API/${entityType}/${entityId}/metadata

metadata.getSimpleMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entityType string
obj.entityId string
Returns
Promise<Object>:

metadata.getSimpleMetadataSubpath

APIdoc

`GET /API/${entityType}/${entityId}/metadata/${subpath}

metadata.getSimpleMetadataSubpath(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entityType string
obj.entityId string
obj.subpath string
Returns
Promise<Object>:

metadata.updateSimpleMetadata

APIdoc

`PUT /API/${entityType}/${entityId}/metadata

metadata.updateSimpleMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entityType string
obj.entityId string
obj.simpleMetadataDocument Object
Returns
Promise<Object>:

metadata.updateSimpleMetadataSubpath

APIdoc

PUT /API/${entityType}/${entityId}/metadata/${subpath}

metadata.updateSimpleMetadataSubpath(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.subpath string
obj.entityType string
obj.entityId string
obj.simpleMetadataDocument Object
Returns
Promise<Object>:

metadata.removeSimpleMetadata

APIdoc

DELETE /API/${entityType}/${entityId}/metadata

metadata.removeSimpleMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entityType string
obj.entityId string
Returns
Promise<Object>:

metadata.getSimpleMetadataKey

APIdoc

GET /API/${entityType}/${entityId}/metadata/${key}

metadata.getSimpleMetadataKey(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entityType string
obj.entityId string
obj.key string
Returns
Promise<Object>:

metadata.removeSimpleMetadataKey

APIdoc

DELETE /API/${entityType}/${entityId}/metadata/${key}

metadata.removeSimpleMetadataKey(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entityType string
obj.entityId string
obj.key string
Returns
Promise<Object>:

metadata.updateSimpleMetadataKey

APIdoc

PUT /API/${entityType}/${entityId}/metadata/${key}

metadata.updateSimpleMetadataKey(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entityType string
obj.entityId string
obj.key string
obj.value string
Returns
Promise<Object>:

metadatadataset.listMetadataDataset

APIdoc

GET /API/metadata/dataset

metadatadataset.listMetadataDataset(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

metadatadataset.getMetadataDataset

APIdoc

GET /API/metadata/dataset/${datasetId}

metadatadataset.getMetadataDataset(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.datasetId string
Returns
Promise<Object>:

metadatadataset.updateMetadataMigration

APIdoc

PUT /API/metadata/dataset/${datasetId}

metadatadataset.updateMetadataMigration(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.datasetId string
obj.body Object
Returns
Promise<Object>:

metadatadataset.removeMetadataDataset

APIdoc

DELETE /API/metadata/dataset/${datasetId}

metadatadataset.removeMetadataDataset(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.datasetId string
Returns
Promise<Object>:

metadatafield.listMetadataField

APIdoc

GET /API/metadata-field/

metadatafield.listMetadataField(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

metadatafield.getMetadataField

APIdoc

GET /API/metadata-field/${fieldName}/

metadatafield.getMetadataField(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.fieldName string
Returns
Promise<Object>:

metadatafield.updateMetadataField

APIdoc

PUT /API/metadata-field/${fieldName}

metadatafield.updateMetadataField(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.fieldName string
obj.metadataFieldDocument Object
Returns
Promise<Object>:

metadatafield.removeMetadataField

APIdoc

DELETE /API/metadata-field/${fieldName}

metadatafield.removeMetadataField(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.fieldName string
Returns
Promise<Object>:

metadatafield.getMetadataFieldValues

APIdoc

GET /API/metadata-field/${fieldName}/values/

metadatafield.getMetadataFieldValues(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.fieldName string
Returns
Promise<Object>:

metadatafield.getMetadataFieldAllowedValues

APIdoc

GET/POST /API/metadata-field/${fieldName}/allowed-values/

metadatafield.getMetadataFieldAllowedValues(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.fieldName string
obj.metadataFieldValueConstraintListDocument Object
Returns
Promise<Object>:

metadatafield.updateMetadataFieldValues

APIdoc

PUT /API/metadata-field/${fieldName}/values

metadatafield.updateMetadataFieldValues(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.fieldName string
obj.simpleMetadataDocument Object
Returns
Promise<Object>:

metadatafield.getSimpleMetadata

APIdoc

GET /API/metadata-field/${fieldName}/metadata

metadatafield.getSimpleMetadata(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.fieldName string
Returns
Promise<Object>:

metadatafield.listMetadataFieldAccess

APIdoc

GET /API/metadata-field/${fieldName}/access

metadatafield.listMetadataFieldAccess(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.fieldName string
Returns
Promise<Object>:

metadatafield.createMetadataFieldAccess

APIdoc

POST /API/metadata-field/${fieldName}/access

metadatafield.createMetadataFieldAccess(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.fieldName string
obj.metadataFieldAccessControlDocument Object
Returns
Promise<Object>:

metadatafield.removeMetadataFieldAccess

APIdoc

DELETE /API/metadata-field/${fieldName}/access/${accessId}

metadatafield.removeMetadataFieldAccess(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.fieldName string
obj.accessId string
Returns
Promise<Object>:

metadatafield.listMetadataFieldMergedAccess

APIdoc

GET /API/metadata-field/merged-access

metadatafield.listMetadataFieldMergedAccess(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

metadatafield.getMetadataFieldMergedAccess

APIdoc

GET /API/metadata-field/${fieldName}/merged-access

metadatafield.getMetadataFieldMergedAccess(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.fieldName string
Returns
Promise<Object>:

metadatalock.listEntityMetadataLock

APIdoc

GET /API/${entity}/${entityId}/metadata-lock

metadatalock.listEntityMetadataLock(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entity string
obj.entityId string
Returns
Promise<Object>:

metadatalock.createEntityMetadataLock

APIdoc

POST /API/${entity}/${entityId}/metadata-lock/

metadatalock.createEntityMetadataLock(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entity string
obj.entityId string
Returns
Promise<Object>:

metadatalock.getEntityMetadataLock

APIdoc

GET /API/${entity}/${entityId}/metadata-lock/${lockId}

metadatalock.getEntityMetadataLock(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entity string
obj.entityId string
obj.lockId string
Returns
Promise<Object>:

metadatalock.updateEntityMetadataLock

APIdoc

PUT /API/${entity}/${entityId}/metadata-lock/${lockId}

metadatalock.updateEntityMetadataLock(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entity string
obj.entityId string
obj.lockId string
Returns
Promise<Object>:

metadatalock.removeEntityMetadataLock

APIdoc

DELETE /API/${entity}/${entityId}/metadata-lock/${lockId}

metadatalock.removeEntityMetadataLock(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entity string
obj.entityId string
obj.lockId string
Returns
Promise<Object>:

metadatamigration.listMetadataMigration

APIdoc

GET /API/metadata/migration

metadatamigration.listMetadataMigration(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

metadatamigration.getMetadataMigration

APIdoc

GET /API/metadata/migration/${migrationId}

metadatamigration.getMetadataMigration(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.migrationId string
Returns
Promise<Object>:

metadatamigration.createMetadataMigration

APIdoc

POST /API/metadata/migration

metadatamigration.createMetadataMigration(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.metadataSchemaMigrationDocument Object
Returns
Promise<Object>:

metadataschema.getMetadataSchema

APIdoc

GET /API/metadata-schema

metadataschema.getMetadataSchema(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

metadataschema.updateMetadataSchema

APIdoc

PUT /API/metadata-schema

metadataschema.updateMetadataSchema(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.metadataSchemaDocument Object
Returns
Promise<Object>:

metadataschema.removeMetadataSchema

APIdoc

DELETE /API/metadata-schema

metadataschema.removeMetadataSchema(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

metadataschema.getMetadataSchemaGroup

APIdoc

GET /API/metadata-schema${groupName}

metadataschema.getMetadataSchemaGroup(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.groupName string
Returns
Promise<Object>:

metadataschema.updateMetadataSchemaGroup

APIdoc

PUT /API/metadata-schema${groupName}

metadataschema.updateMetadataSchemaGroup(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.groupName string
obj.metadataSchemaGroupDocument Object
Returns
Promise<Object>:

metadataschema.removeMetadataSchemaGroup

APIdoc

DELETE /API/metadata-schema${groupName}

metadataschema.removeMetadataSchemaGroup(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.groupName string
Returns
Promise<Object>:

metadataschema.getTerseMetadataSchema

APIdoc

GET /API/metadata-field/terse-schema

metadataschema.getTerseMetadataSchema(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

noauth.isOnline

GET /APInoauth/is-online/

noauth.isOnline(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

noauth.getSelfTest

APIdoc

GET /APInoauth/selftest/

noauth.getSelfTest(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

noauth.createInit

POST /APIinit/

noauth.createInit(obj: Object): Promise<Object>
Parameters
obj (Object)
Returns
Promise<Object>:

noauth.getFileRaw

noauth.getFileRaw(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.path string
Returns
Promise<Object>:

notification.listNotification

APIdoc

GET /API/${entityType}/notification/

notification.listNotification(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entityType string
Returns
Promise<Object>:

notification.listNotificationEntity

APIdoc

GET /API/${entityType}/${entityId}/notification/

notification.listNotificationEntity(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entityType string
obj.entityId string
Returns
Promise<Object>:

notification.getNotification

APIdoc

GET /API/${entityType}/notification/${notificationId}

notification.getNotification(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entityType string
obj.notificationId string
Returns
Promise<Object>:

notification.updateNotification

APIdoc

PUT /API/${entityType}/notification/${notificationId}

notification.updateNotification(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entityType string
obj.notificationId string
obj.notificationDocument Object
Returns
Promise<Object>:

notification.createNotification

APIdoc

POST /API/${entityType}/notification/

notification.createNotification(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entityType string
obj.notificationDocument Object
Returns
Promise<Object>:

notification.removeNotification

APIdoc

DELETE /API/${entityType}/notification/${notificationId}

notification.removeNotification(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entityType string
obj.notificationId string
Returns
Promise<Object>:

notification.getNotificationEntity

APIdoc

GET /API/${entityType}/${entityId}/notification/${notificationId}

notification.getNotificationEntity(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entityId string
obj.entityType string
obj.notificationId string
Returns
Promise<Object>:

notification.updateNotificationEntity

APIdoc

PUT /API/${entityType}/${entityId}/notification/${notificationId}

notification.updateNotificationEntity(obj: Object): Promise<Object>
Parameters
obj (Object)
Name Description
obj.entityId string
obj.entityType string
obj.notificationId string
obj.notificationDocument Object
Returns
Promise<Object>: