Document toolboxDocument toolbox

Vidispine

Common elements in the API [VC 21.3 GEN]

Owned by Andreas Schmidt
Aug 31, 2021
2 min read

Identifiers

Most entities in Vidispine are identified by a Site ID. A Site ID is a string of the form: { site } - { serial } (example: ATL-3033 ). Note that a Site ID is not unique within the system, there could be both an item and a job with the Site ID VX-195, thus Site IDs are only unique within the entity type.

See also External identifiers.

  • site is by the following regular expression form: [_A-Za-z][_A-Za-z0-9]*. The default site name is VX. This can be overridden with the Java system property com.vidispine.site.

  • serial is of the following regular expression form: [1-9][0-9]*

  • site is maximum 10 characters, and case sensitive

Long identifiers

In order to avoid confusion with non unique identifiers, it is possible to have Site IDs displayed as ITEM-VX-1, JOB-VX-1, STORAGE-VX-3, etc. To do this, add the Java system property vidispine.identifier.format with the value full. After this is done, a re-index of items and collections should be started. Now identifiers presented in the system will be of the form described above.

Boolean operators

XML elements to handle boolean expressions:

or

<or>
  <matching-expression />
  ...
</or>

and

<and>
  <matching-expression />
  ...
</and>

not

<not>
  <matching-expression />
</not>

Text/plain formatting

CR LF

CRLF is used in text/plain representation when several values are returned, such as tuples or lists. CRLF is represented by the two bytes 0d 0a in hexadecimal notation.

Tabbed tuples

Tabbed tuples are used in text/plain representation when several values are returned, such as tuples or lists. Tabbed tuples delimits each value by the tab character, 09 in hexadecimal notation. Together with CR LF it is used to create lists of tuples. Users should ignore any output after the last defined element in the tuple, more elements may be returned in future versions of the API.