Vidispine
Vidispine REST API
Introduction and data model
Entities in Vidispine
Item
Shape
Component
File and storage
Library
Collection
RESTful API
Some basics in the RESTful API
Common elements in the API
Identifiers
Boolean operators
Text/plain formatting
Time representation
Time bases
Time codes
Time intervals
Time durations
Time span
Content paths
Paths
Aliases
Constants
Items and Metadata
Imports
Importing items
Steps of import operation
Transcoding
Notifications
Adjusting import
Exports
Exporting items
Export locations
Export templates
Item metadata
Fields
Field groups
Metadata schema
Hierarchical metadata
Metadata inheritance
Versioning
Structure of metadata
Metadata defined by the systems
Searching for items (and collections)
Searching in Vidispine
Search history
Queries
Filters
Joins
Highlighting
Sorting
Faceting
Spell checking
Autocompletion
Search Boost
Caching
Search result caching
Metadata projections
Projections
XSLT 2.0
Job Information
Auto-projection rules
Auto-projection using JavaScript
Auto-projection using XSLT
Metadata migrations
Migration operations
Migration definition
Metadata datasets
Defining the dataset
Create the dataset
Configure metadata fields
Updating metadata
Validation of metadata values
Retrieving allowed values
Subtitles
Subtitle metadata fields and groups
Rendering subtitles in a sequence
SCC support
TTML support
Examples
Creating fields/groups, modifying and moving metadata
Defining a metadata schema
Collections and Libraries
Collections
Creating collections
Searching for collections
Ordering collections
Update collection content
Partial update collection content
Metadata on collection to entity relations
Collections as folders
Representative thumbnails
Libraries
Creating libraries
Automatic deletion
Self-refreshing libraries
Restricting access to items
Storage rules on libraries
Shapes, Components and Transcoding
Item shapes
Shapes
Essence versions
Transcoding
Thumbnailing
Analyzing media
Shape tags and presets
Transcode presets
Scripting transcode presets
Transcode preset elements
Custom settings
Common presets
H264
AVC-Intra
ProRes
XDCAM IMX-30/40/50
XDCAM HD422
DV
DNxHD
RED
Storages and Files
Storages
Storages
Storage methods
Files
Items and storages
File hashing
Throttling storage I/O
Throttling transfer to and from a storage
Temporary storages for transcoder output
Storage credentials
Storage method URIs
The
universal
storage method
Automatic import
Import using a specific transcoder resource
Setting a user for jobs started as a result of an auto import rule
Importing with a metadata file of an external format
Disable automatic import rules
Sidecar auto import
Title as metadata
Applying file name filters to auto import rules
Auto import of image sequences
Storage rules
Resolving storage rules
Examples
Filenames
Using a tree structure for files
Storage name rules
Naming files on storage
Image sequences
Overview
Importing image sequences
Detection of image sequences
Sequence URIs
Sequence patterns
URI’s, URL’s, and Special Characters
File paths
API calls
Jobs and Task Definitions
Jobs
Creating jobs
Concurrency
Job problems
Job tasks
Custom job types
JavaScript tasks
The job object
Pausing job execution
Vidinet job execution
Example: Update item metadata on import
Example: Update item metadata on import using XML
Task groups
Creating a task group
Task group criteria
Task group priority
Job problems
Notifications
Resources
Actions
Triggers
Job filtering
Job types
Job metadata
Filters
Resources
Transcoders
Adding a transcoder
Using multiple transcoders
How transcoders perform jobs
Transcoder job limit
The transcoder’s configuration file
Operations overview
Transcoder discovery
Adding a transcoder directory
Supported URIs
External transcoders
How it works
Adding an external transcoder
Using an external transcoder
Thumbnail resources
Adding a thumbnail resource
Reading thumbnails
Thumbnail resource permissions
How thumbnails are saved on disk
Vidispine Server Agent
How to install VSA
Connecting to Vidispine
Adding a share
VSA and S3 credentials
Vidinet services
Adding a service
Import using Vidinet
Transcoding using Vidinet
Quality control using Vidinet
Using Vidinet services from JavaScript
Transcoding using AWS Elemental MediaConvert
Timelines and sequences
Projects and sequences
Item sequences
Projects and project versions
Project and sequence import and export
Sequences definitions
SequenceDocument
Users, Groups, and Access control
Example
Access control for items, libraries, collections
Overview
Access levels
Priority
Revoking access
Operation
Access control for metadata fields
Permission levels
User authentication
Run-As option
Token authentication
Use access keys
Apache Shiro Integration
LDAP
User authentication
User and group synchronization
Troubleshooting
Multi-site
Multi-site
Site names
Multi site setup
Site rules
Conflicts
Miscellaneous Topics
Deletion lock
Adding locks
Lock expiration
Working with multiple locks
Lock inheritance
Transient metadata
Examples
Monitoring
StatsD
Filtering metrics
Tagged metrics
JMX
Metrics
Indexing
Job
Solr
Elasticsearch
Storage
Resource
Agent
Transfer
Service
Transcoder
Broker
Cluster
Configuration and Integration
Search backend
Solr
Elasticsearch
System configuration
Indexing configuration
Metrics configuration
FTP pool configuration
Database purging
CORS configuration
Configuration properties
System properties
External identifiers
Priority
Example: The UUID namespace
License handling
How it works
Master-slave licensing
Slave management and monitoring
Redundancy and timeouts
Using JavaScript to extend operations
Common JavaScript functions
Debugging JavaScript
Interfacing with the JavaScript engine manually
Add generic JavaScript code
Archive Integration
Creating an archive storage
Amazon Glacier
Atempo Digital Archive Integration
Front Porch Diva Integration
S3 Event Notifications
Configure S3 notifications
Configure the storage
Signiant Integration
General system configuration
Storage configuration
Aspera Integration
Source storage configuration
Destination storage configuration
Aspera FASP Integration
Transfer type
Storage configuration
FileCatalyst Integration
Transfer type
Storage configuration
MXFserver Integration
Set up
Usage
EVS IP Director Integration
Example
StorNext Integration
Storage configuration
StorNext Metadata
Cerify integration
Installation
Usage
Output
FIMS implementation
Codecs and formats
CloudConvert Integration
How to use
Source file access
Conversion parameters
CloudConvert callback
Enable CloudConvert using JavaScript
EIDR Integration
Setup
EIDR synchronization
Troubleshooting
Troubleshooting and obtaining information
Self test
Tests
Test results
Running the test
Error log report
Usage
Programmatically retrieving log files
Standalone Vidispine
Installing distribution-specific packages
Install the packages
Initialize the database
Start the services
Configure Vidispine
Quick setup
Service configuration
The vidispine service user
Service dependencies
Setting JVM options
Clustering
Quick cluster setup
Upgrading
Upgrading Vidispine
Upgrading from GlassFish
Server configuration
Environment variables
Additional settings
Package reference
Packages
Optional packages
Files
API Reference
Access controls
Managing access controls
Managing access controls in bulk
Default access controls
Viewing applied access controls
Access visualization
Audit trails
Examining the log
Collections
Managing collections
Collection content
Collection metadata
Searching for collections
Ordering collections
Folder mapped collections
Deletion Locks
Get Deletion Locks
Managing Deletion Locks
Configuration
Configuration resources
Indexing settings
Metrics settings
Path alias configuration
Job pool configuration
FTP pool configuration
LogReport configuration
CORS configuration
Database purging configuration
Configuration properties
Export locations
Managing export locations
Export location script
External identifiers
Managing external id namespaces
Managing external ids
Groups and roles
Managing groups
Group information
Group-to-group relations
Group-to-user relations
Imports
Importing an item
Placeholder imports
Importing sidecar files
Import settings
Managing import settings
Items
Exports
Items
Retrieving item information
Item locks
Item-to-item relations
Item sequences
Shapes
Shape analysis
Shape components
Thumbnails
Transcoding
Item conform
Timeline
JavaScript
Testing scripts
JavaScript sessions
Jobs
Managing jobs
Job problem conditions
Job states
Job types
Job metadata
Libraries
Managing libraries
Library settings
Library content
Listing library items in batch
License
Version and license
Slave management and monitoring
Metadata
Auto-projection rules
Bulky metadata
Global metadata
Document metadata
Key-value metadata
Metadata
Re-indexing metadata
Metadata locks
Metadata fields
Metadata field access controls
Metadata field groups
Metadata datasets
Metadata migrations
Metadata projections
Metadata schema
Subtitles
Miscellaneous
Stitching images
Time zone
Troubleshooting
WADL
Callback
Return the current user
Notifications
Actions
Triggers
Notifications
Projects and versions
Projects
Project versions
Version definitions
Assets in project version definition
Version definition extradata
Inspecting project files
Importing projects and sequences
Exporting projects and sequences
Quota rules
Managing quota rules
Resources
Resource types
Resources
Resource status
Scheduling requests
States of scheduled requests
Managing scheduled requests
Search
Search items and collections
Search shapes
Search files
Autocompletion
Optimize index
Self tests
Running the test
Shape tags
Managing shape tags
Tags of a shape
Transcode preset scripts
Sites
Managing sites
Site rules
Managing site rules
Storages
Auto-import rules
Files
Storages
Storage groups
Storage name rules
Storage rules
Task definitions
Task definitions
Custom job types
Task definition scripts
Job graphs
Task groups
Task groups
Task group transcoders
Key-value metadata
Transfers
Overview
Managing transfers
Transfer log
Examining the log
Users
Users
User access keys
User aliases
User authentication tokens
Vidinet
Cost estimation
Vidispine logs
Retrieving log files
Log retrieval jobs
Upload of logs to Vidispine
Vidispine services
Vidispine services
Service status
Stack trace
Vidispine Server Agents
Managing VSAs
XML Schema
xmlSchema.xsd
common.xsd
transcoder.xsd
Release Notes
Prerequisites
Upgrade notes
General
Upgrading from 4.15 to 4.16
Upgrading from 4.14 to 4.15
Upgrading from 4.13 to 4.14
Upgrading from 4.12 to 4.13
Upgrading from 4.11 to 4.12
Upgrading from 4.10 to 4.11
Upgrading from 4.9 to 4.10
Upgrading from 4.8 to 4.9
Upgrading from 4.7 to 4.8
Upgrading from 4.6 to 4.7
Upgrading from 4.5 to 4.6
Upgrading from 4.4 to 4.5
Upgrading from 4.3 to 4.4
Upgrading from 4.2 to 4.3
Upgrading from 4.1 to 4.2
Upgrading from 4.0 to 4.1
4.16
4.16.5
4.16.4
4.16.3
4.16.2
4.16.1
4.16
4.15
4.15.4
4.15.3
4.15.2
4.15.1
4.15
4.14
4.14.6
4.14.5
4.14.4
4.14.3
4.14.2
4.14.1
4.14
4.13
4.13.4
4.13.3
4.13.2
4.13.1
4.13
4.12
4.12.5
4.12.4
4.12.3
4.12.2
4.12.1
4.12
4.11
4.11.3
4.11.2
4.11.1
4.11
4.10
4.10.4
4.10.3
4.10.2
4.10.1
4.10
4.9
4.9.3
4.9.2
4.9.1
4.9
4.8
4.8.3
4.8.2
4.8.1
4.8
4.7
4.7.4
4.7.3
4.7.2
4.7.1
4.7
4.6
4.6.5
4.6.4
4.6.3
4.6.2
4.6.1
4.6
4.5
4.5.9
4.5.8
4.5.7
4.5.6
4.5.5
4.5.4
4.5.3
4.5.2
4.5.1
4.5
4.4
4.4.4
4.4.3
4.4.2
4.4.1
4.4
4.3
4.3.8
4.3.7
4.3.6
4.3.5
4.3.4
4.3.3
4.3.2
4.3.1
4.3
4.2
4.2.16
4.2.15
4.2.14
4.2.13
4.2.12
4.2.11
4.2.10
4.2.9
4.2.8
4.2.7
4.2.6
4.2.5
4.2.4
4.2.3
4.2.2
4.2.1
4.2
Vidispine REST API
Docs
»
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
P
|
R
|
S
|
T
|
U
|
V
|
W
|
X
|
Z
A
additionalHash
reserved key
alwaysGenerateThumbnails
configuration property
api.dataType() (api method)
api.delete() (api method)
api.get() (api method)
api.getInfo() (api method)
api.header() (api method)
api.input() (api method)
api.path() (api method)
api.post() (api method)
api.put() (api method)
api.queryParam() (api method)
api.rich() (api method)
api.timeout() (api method)
api.user() (api method)
apiNoauthUri
configuration property
apiUri
configuration property
auditTrailPurgingDirectory
configuration property
auditTrailPurgingTime
configuration property
autoRemoveExpiredDeletionLocks
configuration property
azureSasValidTime
configuration property
B
bulkyMetadataKeysToIgnore
configuration property
C
cerifyPriority
job metadata key
changeLogForcePurgingTime
configuration property
changeLogPurgingTime
configuration property
checksumMode
job metadata key
closeLimit
reserved key
clusterName
configuration property
com.vidispine.credentials.dir
com.vidispine.site
compressDocumentMessages
configuration property
concurrentJobs
configuration property
configuration property
alwaysGenerateThumbnails
apiNoauthUri
apiUri
auditTrailPurgingDirectory
auditTrailPurgingTime
autoRemoveExpiredDeletionLocks
azureSasValidTime
bulkyMetadataKeysToIgnore
changeLogForcePurgingTime
changeLogPurgingTime
clusterName
compressDocumentMessages
concurrentJobs
defaultIngestStorage
defaultTranscoder
disableATime
disableMetadataSchema
disableSequenceChecker
disableSiteCrunching
disableThumbnailGeneration
disableThumbnailReindexing
elasticsearchPath
,
[1]
enableTranscoderHashing
enableTranscoderTransfer
fileGrowingTimeout
fileHashAlgorithm
fileHashExecutionTime
fileHierarchy
fileNotGrowingTimeout
fileSequenceStart
fileTempKeyDuration
firstLastModifiedAsCreationTime
glacierArchiveDescription
groupImportableFiles
indexCollectionItemOrder
indexFieldGroups
indexTimespans
itemDeleteExecutionTime
itemDeleteInterval
itemDeleteIntervalShort
jobExclusiveStepMaxWait
jobPurgingDirectory
jobPurgingTime
jobRetryCount
keepEmptyDirectories
keepMissingFiles
ldapAuthentication
legacyTransientFieldTypes
libraryExpireTime
libraryUpdateInterval
localFSTimeData
maxFileMetadataLength
maxSearchResults
maxTranscoderUnavailableTime
mediaCheckInterval
parseFileMetadata
parseXMP
passwordHashAlgorithm
s3ConcurrentParts
s3ConnectionTimeout
s3CredentialType
s3MaxErrorRetry
s3PartSize
s3PartSizeIncrease
s3ProxyValidTime
s3SocketTimeout
signiantManagerHost
signiantManagerPassword
signiantManagerUser
simpleImageProcessor
skipLibraryIndexUpdates
slaveLicenseProxy
solrAutoSoftCommit
solrCollection
solrCommitInterval
solrPath
solrPingAttempts
solrPingTimeout
solrQueryTimeout
solrSoftCommitInterval
solrUpdateQueueSize
statsPerSecond
storageRuleDisableArchiveSources
stornextFileMetadata
stsAssumeRole
stsCredentialDuration
stsRegion
syncVxaDeletes
syncVxaFileChanges
thumbnailHierarchy
transcoderNonblockingStatusInterval
trustArchivedFiles
useAzureProxy
useLucene
useMutableRangeWrites
useS3Proxy
useSegmentFiles
useVxaHash
useVxaMimeType
userTokenDefaultInterval
userTokenMaxInterval
userTokenRefreshInterval
validatexml
xmpIgnoreElements
zkHost
constants
storage states
storage types
context.getChannel() (context method)
context.getComponent() (context method)
context.getExtension() (context method)
context.getFileId() (context method)
context.getItem() (context method)
context.getJobId() (context method)
context.getJobMetadata() (context method)
context.getJobType() (context method)
context.getOriginalComponentFilename() (context method)
context.getOriginalFilename() (context method)
context.getShape() (context method)
context.getStorage() (context method)
context.getTags() (context method)
D
defaultIngestStorage
configuration property
defaultTranscoder
configuration property
deleteFileIfNotFound
reserved key
deleteFileIfReadOnly
reserved key
detectRenamedFiles
reserved key
disableATime
configuration property
disabledSidecarExtensions
reserved key
disableMetadataSchema
configuration property
disableSequenceChecker
configuration property
disableSiteCrunching
configuration property
disableThumbnailGeneration
configuration property
disableThumbnailReindexing
configuration property
E
elasticsearchPath
configuration property
,
[1]
enableTranscoderHashing
configuration property
enableTranscoderTransfer
configuration property
environment variable
com.vidispine.credentials.dir
,
[1]
com.vidispine.license.dir
com.vidispine.license.tmpdir
com.vidispine.log.dir
com.vidispine.site
,
[1]
com.vidispine.xml.prefix
vidispine.identifier.format
,
[1]
excludeFilter
reserved key
F
file.getAllMetadata() (file method)
file.getMetadata() (file method)
file.setMetadata() (file method)
fileGrowingTimeout
configuration property
fileHashAlgorithm
configuration property
fileHashExecutionTime
configuration property
fileHierarchy
configuration property
fileListBatchSize
reserved key
fileNotGrowingTimeout
configuration property
fileSequenceStart
configuration property
fileTempKeyDuration
configuration property
firstLastModifiedAsCreationTime
configuration property
G
glacierArchiveDescription
configuration property
groupImportableFiles
configuration property
H
hashingThreadCount
reserved key
hashMode
reserved key
http.uri(uri):() (http method)
I
ignoreSidecarImport
reserved key
indexCollectionItemOrder
configuration property
indexFieldGroups
configuration property
indexTimespans
configuration property
itemDeleteExecutionTime
configuration property
itemDeleteInterval
configuration property
itemDeleteIntervalShort
configuration property
J
job metadata key
cerifyPriority
checksumMode
lastSmpteTimeCode
smpteTimeCode
job.containsKey() (job method)
job.deleteData() (job method)
job.fail() (job method)
job.fatalFail() (job method)
job.getData() (job method)
job.getDataOrDefault() (job method)
job.getId() (job method)
job.getKeys() (job method)
job.getUser() (job method)
job.log() (job method)
job.setData() (job method)
job.vidinetCost() (job method)
job.vidinetJob() (job method)
job.wait() (job method)
jobExclusiveStepMaxWait
configuration property
jobPurgingDirectory
configuration property
jobPurgingTime
configuration property
jobRetryCount
configuration property
K
keepEmptyDirectories
configuration property
reserved key
keepMissingFiles
configuration property
reserved key
L
lastSmpteTimeCode
job metadata key
ldapAuthentication
configuration property
legacyTransientFieldTypes
configuration property
libraryExpireTime
configuration property
libraryUpdateInterval
configuration property
localFSTimeData
configuration property
logger.json() (logger method)
logger.log() (logger method)
lostLimit
reserved key
M
maxFileMetadataLength
configuration property
maxSearchResults
configuration property
maxTranscoderUnavailableTime
configuration property
mediaCheckInterval
configuration property
metadatahelper.createMetadata() (metadatahelper method)
metadatahelper.createMetadataGroup() (metadatahelper method)
metadatahelper.createMetadataTimespan() (metadatahelper method)
metadatahelper.generateMetadataField() (metadatahelper method)
metadatahelper.log() (metadatahelper method)
metadatahelper.metadataToStr() (metadatahelper method)
N
noDefaultHash
reserved key
P
parseFileMetadata
configuration property
parseXMP
configuration property
passwordHashAlgorithm
configuration property
probeFileBeforeClosing
reserved key
R
refreshInterval
reserved key
refreshOnStart
reserved key
reserved key
additionalHash
closeLimit
deleteFileIfNotFound
deleteFileIfReadOnly
detectRenamedFiles
disabledSidecarExtensions
excludeFilter
fileListBatchSize
hashMode
hashingThreadCount
ignoreSidecarImport
keepEmptyDirectories
keepMissingFiles
lostLimit
noDefaultHash
probeFileBeforeClosing
refreshInterval
refreshOnStart
sqsEndpoint
sqsName
statsPerSecond
toAppearLimit
verifyHashAfterTransfer
vxaId
S
s3ConcurrentParts
configuration property
s3ConnectionTimeout
configuration property
s3CredentialType
configuration property
s3MaxErrorRetry
configuration property
s3PartSize
configuration property
s3PartSizeIncrease
configuration property
s3ProxyValidTime
configuration property
s3SocketTimeout
configuration property
shell.exec() (shell method)
signiantManagerHost
configuration property
signiantManagerPassword
configuration property
signiantManagerUser
configuration property
simpleImageProcessor
configuration property
skipLibraryIndexUpdates
configuration property
slaveLicenseProxy
configuration property
smpteTimeCode
job metadata key
solrAutoSoftCommit
configuration property
solrCollection
configuration property
solrCommitInterval
configuration property
solrPath
configuration property
solrPingAttempts
configuration property
solrPingTimeout
configuration property
solrQueryTimeout
configuration property
solrSoftCommitInterval
configuration property
solrUpdateQueueSize
configuration property
sqsEndpoint
reserved key
sqsName
reserved key
statsPerSecond
configuration property
reserved key
storage states
constants
storage types
constants
storageRuleDisableArchiveSources
configuration property
stornextFileMetadata
configuration property
stsAssumeRole
configuration property
stsCredentialDuration
configuration property
stsRegion
configuration property
syncVxaDeletes
configuration property
syncVxaFileChanges
configuration property
T
thumbnailHierarchy
configuration property
toAppearLimit
reserved key
transcoderNonblockingStatusInterval
configuration property
trustArchivedFiles
configuration property
U
useAzureProxy
configuration property
useLucene
configuration property
useMutableRangeWrites
configuration property
userTokenDefaultInterval
configuration property
userTokenMaxInterval
configuration property
userTokenRefreshInterval
configuration property
useS3Proxy
configuration property
useSegmentFiles
configuration property
useVxaHash
configuration property
useVxaMimeType
configuration property
V
validatexml
configuration property
verifyHashAfterTransfer
reserved key
vidispine.identifier.format
vxaId
reserved key
W
wrapper.getBulkyMetadata() (wrapper method)
wrapper.getMetadata() (wrapper method)
wrapper.getOldBulkyMetadata() (wrapper method)
,
[1]
wrapper.getOldMetadata() (wrapper method)
wrapper.getShape() (wrapper method)
wrapper.getShapeMetadata() (wrapper method)
wrapper.setMetadata() (wrapper method)
X
xmpIgnoreElements
configuration property
Z
zkHost
configuration property