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
      • 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
    • 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
    • Subtitles
      • Subtitle metadata fields and groups
      • Rendering subtitles in a sequence
      • 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
      • 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 method URIs
    • Automatic import
      • Importing with a metadata file of an external format
      • 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
    • URI’s, URL’s, and Special Characters
      • File paths
      • API calls
  • Jobs and Task Definitions
    • Jobs
      • Creating jobs
      • Concurrency
      • Job problems
      • Job tasks
    • JavaScript tasks
      • The job object
      • Pausing 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
      • 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
      • How thumbnails are saved on disk
    • Vidispine Server Agent
      • How to install VSA
      • Adding a share
  • 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
      • Apache Shiro Integration
    • LDAP
      • User authentication
      • User and group synchronization
      • Troubleshooting
  • Multi-site
    • Multi-site
      • Site names
      • Multi site setup
      • Site rules
      • Conflicts
  • Monitoring
    • StatsD
      • Filtering metrics
      • Tagged metrics
    • JMX
    • Metrics
      • Indexing
      • Job
      • Solr
      • Storage
      • Transfer
      • Service
      • Transcoder
  • Configuration and Integration
    • System configuration
      • Indexing configuration
      • Metrics configuration
      • FTP pool configuration
      • Database purging
      • 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
      • 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
    • 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
  • 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
      • Files
  • API Reference
    • Access controls
      • Managing access controls
      • Default access controls
      • Viewing applied access controls
    • Audit trails
      • Examining the log
    • Collections
      • Managing collections
      • Collection content
      • Collection metadata
      • Searching for collections
      • Ordering collections
      • Folder mapped collections
    • Configuration
      • Indexing settings
      • Metrics settings
      • Path alias configuration
      • Job pool configuration
      • FTP pool configuration
      • LogReport 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 migrations
      • Metadata projections
      • Metadata schema
      • TTML
    • Miscellaneous
      • Stitching images
      • Time zone
      • Troubleshooting
    • Notifications
      • Actions
      • Triggers
      • Notifications
    • Projects and versions
      • Projects
      • Project versions
      • Version definitions
      • Assets in project version definition
      • 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
      • Job graphs
    • Task groups
      • Task groups
      • Task group transcoders
      • Key-value metadata
    • Transfers
      • Overview
      • Managing transfers
    • Users
      • Managing users
      • User information
      • User credentials
      • Group-to-user relations
      • User/group visualization
    • Vidispine logs
      • Retrieving log files
      • Log retrieval jobs
      • Upload of logs to Vidispine
    • XML Schema
      • xmlSchema.xsd
      • common.xsd
  • Release Notes
    • Prerequisites
      • Important notes
      • Limitations
    • Upgrade notes
      • General
      • 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.5
      • 4.5
    • 4.4
      • 4.4.2
      • 4.4.1
      • 4.4
    • 4.3
      • 4.3.6
      • 4.3.5
      • 4.3.4
      • 4.3.3
      • 4.3.2
      • 4.3.1
      • 4.3
    • 4.2
      • 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 »
  • Items and Metadata

Items and MetadataΒΆ

This chapter describes the Item, the central entity in the Vidispine data model, and how metadata (information about the item) can be associated with the item.

  • 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
    • 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
  • 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
  • Subtitles
    • Subtitle metadata fields and groups
    • Rendering subtitles in a sequence
    • TTML support
  • Examples
    • Creating fields/groups, modifying and moving metadata
    • Defining a metadata schema
Next Previous

© Copyright 2014-2015, Vidispine AB.