VidiRest package

Subpackages

Submodules

VidiRest.apiexception module

members

undoc-members

VidiRest.auditlogapi module

members

undoc-members

VidiRest.collectionapi module

members

undoc-members

VidiRest.configurationapi module

members

undoc-members

VidiRest.indexapi module

class VidiRest.indexapi.IndexAPI(vsapi)

API which allows access to Vidispine’s reindexing

getIndex(index, runasuser=None, return_format='json')
reIndex(index, runasuser=None, return_format='json')
updateIndexStatus(index_type, index_status, priority=None, runasuser=None, return_format='json')

Updated the status of a vidispine index. If the index is ‘FINISHED’ or ‘ABORTED’ the status will not be updated

Parameters

  • index_type – {string} Which index should be updated, E.G ‘item’, ‘collection’, ‘files’

  • index_status – {string} Which status the index should have, ‘IN_PROGRESS’, ‘ABORTED’, ‘PAUSED’

  • priority – {string} How highly the request is priorities. Default in VS is ‘500’, E.G ‘600’

  • runasuser – User who is doing the request

  • return_format – Response format from VS

Returns

VSIndex document

VidiRest.itemapi module

class VidiRest.itemapi.ItemAPI(vsapi)
addEntryToItemACL(item_id, entry_document, runasuser=None, return_format='json')
addEntryToItemACLBulk(item_id, entry_document, runasuser=None, return_format='json')
addEntryToMetadataFieldACL(field_name, metadatafieldacl_document, runasuser=None, return_format='json')
addEntryToMetadataFieldGroupACL(group_name, metadatafieldacl_document, runasuser=None, return_format='json')
addFieldToMetadataFieldGroup(group_name, field_name, query=None, matrix=None, runasuser=None)
addFileToItem(item_id, query=None, matrix=None, runasuser=None, return_format='json')
addFilesToItem(item_id, newessence_document, matrix=None, runasuser=None, return_format='json')
addGroupToMetadataFieldGroup(parent_group_name, child_group_name, runasuser=None)

# Adds the group with the specified name to the group. :param parent_group_name: the parent :param child_group_name: the child :param runasuser: a user to run the query as :return:

addItemToLibrary(item_id, library_id, runasuser=None)

Adds one item to a library. The library should be created with createLibraryFromItemList().

See http://apidoc.vidispine.com/4.3/ref/library.html#add-a-specific-item-to-a-library

Parameters

  • item_id – Item ID

  • library_id – Library ID

  • runasuser – Vidisipine “RunAs” username

Returns

None

addTagToShape(item_id, shape_id, tag_name, runasuser=None, return_format='text')
conformSequenceToItem(sequence_id, seq_title, tag, related_sources, conform_doc, conform_metadata=False, runasuser=None, createthumbnails=False, ingestprofile_groups=None, return_format='json')

Make a call to vidispine :8080/API/conform

Parameters

  • sequence_id – The sequence item id to render

  • seq_title – The title of the new item

  • tag – A comma-separated list of tags to conform to

  • related_sources – A list of item ids to add as related sources

  • conform_doc – A vidispine ConformRequestDocument

  • conform_metadata – Should metadata from the source items be included. Defaults to False

  • runasuser – The user to make the request as. Defaults to the user who instantiated ItemHelper

  • createthumbnails – The job should recreate the thumbnail

  • ingestprofile_groups – A list of user groups whose ingest profiles will be used for transcoding the new item. Default is None, no transcodes.

  • return_format – The format to return. Valid options are xml and json. Defaults to json

Returns

Depends on return_format. Either a parsed json or a Vidispine JobDocument

createItemRelation(item_id1, item_id2, query=None, runasuser=None, return_format='json')
createItemShape(item_id, shape_document, runasuser=None, return_format='json')
createLibrary(itemlist_doc, query=None, matrix=None, runasuser=None, return_format='json')
createOrModifyGlobalMetadataInstance(metadata_document, query=None, matrix=None, runasuser=None, return_format='json')
createOrModifyMetadataField(field_name, metadatafield_document, runasuser=None, return_format='json')
createOrModifyMetadataFieldData(field_name, key, value, query=None, matrix=None, runasuser=None)
createOrModifyMetadataFieldGroup(group_name, mfg_document=None, query=None, matrix=None, runasuser=None)
createOrModifyMetadataFieldGroupData(group_name, key, value, query=None, matrix=None, runasuser=None)
createOrModifyMetadataFieldValues(field_name, simplemetadata_document, query=None, matrix=None, runasuser=None, return_format='json')
createOrModifyShapeTag(tag_name, transcodepreset_document, runasuser=None)
createOrModifyShapeTagStorageRule(tag_name, storagerule_document, query=None, matrix=None, runasuser=None, return_format='json')
createPlaceholder(metadata_document, item_id=None, query=None, runasuser=None, return_format='json')
createPlaceholderShape(item_id, query=None, runasuser=None, return_format='json')
createPostersUsingTimecodes(item_id, vstimecode, query=None, runasuser=None, return_format='json')
createSettingsProfile(importsettings_document, query=None, matrix=None, runasuser=None, return_format='json')
createThumbnailResource(item_id, runasuser=None, return_format='json')
createThumbnailsUsingTimecodes(item_id, vstimecode, query=None, runasuser=None, return_format='json')
deletePoster(resource_id, item_id, time_code, version, runasuser=None, return_format='json')
deleteThumbnailResource(uri, runasuser=None, return_format='json')
doCombinedSearch(itemsearch_document=None, matrix=None, query=None, content=None, runasuser=None, return_format='json')
doImport(url, metadata_document, query=None, matrix=None, runasuser=None, return_format='json')
doImportChunk(chunk_data, total_size, index, id=None, query=None, matrix=None, runasuser=None)
doImportFromStorage(storage_id, file_id, metadata_document, query=None, matrix=None, runasuser=None, return_format='json')
doImportToPlaceholder(item_id, query=None, matrix=None, component='container', ingestprofile_groups=None, ignore_sidecars=False, runasuser=None, return_format='json')
doSearch(itemsearch_document=None, matrix=None, query=None, content=None, runasuser=None, return_format='json')
export(item_id, tag_name, uri, query=None, runasuser=None, return_format='json')
generateImportPassKey(metadata_document, query=None, matrix=None, runasuser=None, return_format='json')
getAccessDotGraph(item_id, runasuser=None)
getAllExternalIds(item_id, query=None, runasuser=None, return_format='json')
getAllGlobalMetadataInstances(query=None, matrix=None, runasuser=None, return_format='json')
getAllItemRelations(item_id, query=None, runasuser=None, return_format='json')
getAllItems(matrix=None, content=None, runasuser=None, return_format='json')
getAllLibraries(query=None, matrix=None, runasuser=None, return_format='json')
getAllMetadataFieldGroups(query=None, runasuser=None, return_format='json')
getAllMetadataFields(query=None, runasuser=None, return_format='json')
getAllNotifications(runasuser=None, return_format='json')
getAllProjections(query=None, runasuser=None, return_format='json')
getAllSettingsProfiles(query=None, matrix=None, runasuser=None, return_format='json')
getAllShapeTagStorageRules(query=None, matrix=None, runasuser=None, return_format='json')
getAllShapeTags(query=None, runasuser=None, return_format='json')
getAllTagsFromShape(item_id, shape_id, query=None, runasuser=None, return_format='json')
getDocumentXML(doc)
getGlobalMetadataGroupInstancesPaginated(group_name, metadata_field_group_search_document, page=1, page_size=10, runasuser=None)

Get global metadata instances paginated.

Parameters

  • group_name – group of the metadata instances

  • metadata_field_group_search_document – a search document

  • page – the page to get

  • page_size – page size

  • runasuser – username to run as

  • return_format – format to retrieve

getGlobalMetadataInstance(instance_uuid, query=None, matrix=None, runasuser=None, return_format='json')
getIncomingProjection(projection_id, runasuser=None, return_format='xml')
getItem(item_id, query=None, content=None, matrix=None, runasuser=None, return_format='json')
getItemACL(item_id, runasuser=None, return_format='json')
getItemACLEntry(item_id, access_id, runasuser=None, return_format='json')
getItemACLMerged(item_id, username, type='GENERIC', permission='NONE', query=None, runasuser=None, return_format='json')
getItemACLMergedGroups(item_id, query=None, runasuser=None, return_format='json')
getItemCollections(item_id, runasuser=None, return_format='json')
getItemContent(item_id, query=None, runasuser=None, return_format='json')
getItemFCPXML(item_id, query=None, matrix=None, runasuser=None, return_format='final-cut-pro')
getItemLibraries(item_id, runasuser=None, return_format='json')

Retrieves the ids of all libraries that includes the item. :param item_id: item ID :param runasuser: Vidisipine “RunAs” username :return: URIListDocument

getItemListCallback(query=None, content=None, matrix=None, runasuser=None, return_format='json')

Triggers an item list job in Vidispine with an optional callback. This is the equivalent of http://apidoc.vidispine.com/latest/ref/item/item.html#creating-an-item-list-job

getItemMetadata(item_id, matrix=None, runasuser=None, return_format='json')
getItemMetadataChanges(item_id, query=None, matrix=None, runasuser=None, return_format='json')
getItemMetadataFieldGroups(item_id, runasuser=None, query=None, matrix=None, return_format='json')
getItemRelation(relation_id, query=None, runasuser=None, return_format='json')
getItemShape(item_id, shape_id, query=None, runasuser=None, return_format='json')
getItemShapeComponent(item_id, shape_id, component_id, runasuser=None, return_format='json')
getItemShapeComponents(item_id, shape_id, runasuser=None, return_format='json')
getItemShapeIdsFromNames(item_id, shape_names, runasuser=None, return_format='json')
getItemShapes(item_id, query=None, matrix=None, runasuser=None, return_format='json')
getItemVersions(item_id, runasuser=None, return_format='json')
getLibrary(library_id, query=None, matrix=None, runasuser=None, return_format='json')
getLibrarySettings(library_id, query=None, matrix=None, runasuser=None, return_format='json')
getMetadataField(field_name, query=None, runasuser=None, return_format='json')
getMetadataFieldACL(field_name, runasuser=None, return_format='json')
getMetadataFieldData(field_name, key, query=None, matrix=None, runasuser=None)
getMetadataFieldGroup(group_name, query=None, runasuser=None, return_format='json')
getMetadataFieldGroupACL(group_name, runasuser=None, return_format='json')
getMetadataFieldGroupACLMerged(group_name, username, runasuser=None, return_format='json')
getMetadataFieldGroupData(group_name, key, query=None, matrix=None, runasuser=None)
getMetadataFieldValues(field_name, query=None, matrix=None, runasuser=None, return_format='json')
getOutgoingProjection(projection_id, runasuser=None, return_format='xml')
getSearchAutoComplete(autocompleterequest_document=None, runasuser=None, return_format='json')
getSearchHistory(query=None, runasuser=None, return_format='json')
getSequence(item_id, type='vidispine', runasuser=None, return_format='xml')
getSequenceExport(item_id, query=None, runasuser=None)
getSettingsProfile(settings_id, query=None, matrix=None, runasuser=None, return_format='json')
getShapeTag(name, runasuser=None, return_format='json')
getShapeTagScript(tag_name, runasuser=None, return_format='javascript')
getShapeTagStorageRule(tag_name, query=None, matrix=None, runasuser=None, return_format='json')
getThumbnailResource(item_id, runasuser=None, return_format='json')
importEssenceVersion(item_id, query=None, runasuser=None, return_format='json')
importNewEssenceRaw(itemid, body, query=None, return_format='json', runasuser=None)
importNewShape(item_id, query=None, runasuser=None, return_format='json')
importSequence(query, essence_mappings_document, runasuser=None, return_format='json')
importSidecar(itemid, body, return_format='json', runasuser=None)
moveMetadataGroupTimeSpan(itemid, query=None, matrix=None, runasuser=None, return_format='json')

>> 3) for att andra start och end pa en annotering, >> run PUT /item/ID/metadata/move?start=2700&end=2940&uuid=$UUID

reIndexItems(query=None, runasuser=None, return_format='json')
recreateThumbnails(item_id, runasuser=None, return_format='json')
removeExternalId(item_id, ext_id, content=None, runasuser=None, return_format='json')
removeFieldFromMetadataFieldGroup(group_name, field_name, runasuser=None)
removeGlobalMetadataInstance(uuid, query=None, matrix=None, runasuser=None, return_format='json')
removeGroupFromMetadataFieldGroup(parent_group_name, child_group_name, runasuser=None)
removeItem(item_id, runasuser=None)
removeItemACLEntry(item_id, access_id, runasuser=None)
removeItemFromLibrary(item_id, library_id, runasuser=None)

Remove one item from a library. The library should be created with createLibraryFromItemList().

http://apidoc.vidispine.com/4.3/ref/library.html#remove-a-specific-item-from-a-library

Parameters

  • item_id – Item ID

  • library_id – Library ID

  • runasuser – Vidisipine “RunAs” username

Returns

None

removeItemMetadataFieldGroup(item_id, group_name, runasuser=None)
removeItemRelation(relation_id, runasuser=None)
removeItemShape(item_id, shape_id, query=None, runasuser=None, return_format='json')
removeItemsinLibrary(library_id, runasuser=None)
removeLibrary(library_id, runasuser=None)
removeMetadataField(field_name, runasuser=None)
removeMetadataFieldACLEntry(field_name, access_id, runasuser=None)
removeMetadataFieldData(field_name, key, query=None, matrix=None, runasuser=None)
removeMetadataFieldGroup(group_name, runasuser=None)
removeMetadataFieldGroupACLEntry(group_name, access_id, runasuser=None)
removeMetadataFieldGroupData(group_name, key, runasuser=None)
removeMetadataFieldValues(field_name, query=None, matrix=None, runasuser=None)
removeProjection(projection_id, runasuser=None, return_format='xml')
removeSettingsProfile(settings_id, runasuser=None)
removeShapeTag(tag_name, runasuser=None)
removeShapeTagScript(tag_name, runasuser=None)
removeShapeTagStorageRule(tag_name, runasuser=None, return_format='text')
removeTagFromShape(item_id, shape_id, tag_name, runasuser=None, return_format='text')
renderSequenceToItem(sequence_id, seq_title, tag, srrd, runasuser=None, ingestprofile_groups=None, return_format='json')
retranscode(item_id, shape_id, tag_name, query=None, runasuser=None, return_format='json')
setExternalId(item_id, ext_id, query=None, runasuser=None, return_format='json')
setIncomingProjection(projection_id, projection_stylesheet, runasuser=None, return_format='xml')
setItemMetadata(item_id, metadata_document, query=None, matrix=None, runasuser=None, content_type='xml', return_format='json')
setItemMetadataFieldGroup(item_id, group_name, query=None, matrix=None, runasuser=None)
setLibrarySettings(library_id, library_settings_doc, runasuser=None)

Set one or multiple settings values on a Vidispine library.

See: http://apidoc.vidispine.com/4.3/ref/library.html#update-library-settings

Parameters

  • library_id – Vidispine library ID

  • library_settings_doc – VSXMLSchema.LibrarySettingsDocument with new settings values

  • runasuser – Vidisipine “RunAs” username

Returns

None, raises on errors

setMetadataFieldGroupToItemsInLibrary(library_id, mfg_name, query=None, matrix=None, runasuser=None, return_format='json')
setMetadataToItemsInLibrary(library_id, metadata_document, query=None, matrix=None, runasuser=None, return_format='xml')
setOutgoingProjection(projection_id, projection_stylesheet, runasuser=None, return_format='xml')
setShapeTagScript(tag_name, script, runasuser=None)
subscribeNotification(item_id, notification_document, runasuser=None, return_format='text')
updateItemRelation(relation_id, query=None, runasuser=None, return_format='json')
updateItemShape(item_id, shape_id, matrix=None, runasuser=None, return_format='json')
updatePlaceholderComponentCount(item_id, shape_id, container=None, video=None, audio=None, runasuser=None, return_format='json')
updateSequence(item_id, sequence_document, type='vidispine', runasuser=None, return_format='xml')
updateSettingsProfile(settings_id, importsettings_document, query=None, matrix=None, runasuser=None, return_format='json')

VidiRest.jobapi module

class VidiRest.jobapi.JobAPI(vsapi)
createNotification(notification_document, runasuser=None, return_format='json')
createOrModifyJobTask(jobtype_id, task_id, jobtask_document, runasuser=None, return_format='json')
createOrModifyJobType(jobtype_id, jobtype_document, runasuser=None, return_format='json')
getAllJobProblems(runasuser=None, return_format='json')
getAllJobTasks(jobtype_id, runasuser=None, return_format='json')
getAllJobTypes(runasuser=None, return_format='json')
getAllJobs(query={}, matrix={}, runasuser=None, return_format='json')
getAllNotifications(runasuser=None, return_format='json')
getJob(job_id, matrix={}, query={'blocking': 'false'}, runasuser=None, return_format='json')
getJobProblem(job_id, runasuser=None, return_format='json')
getJobTask(jobtype_id, task_id, runasuser=None, return_format='json')
getJobType(jobtype_id, runasuser=None, return_format='json')
getNotification(notification_id, runasuser=None, return_format='json')
getNotificationExternalID(notification_id, runasuser=None, return_format='json')
getTaskDefinition(task_type, runasuser=None, return_format='json')
reRun(job_id, runasuser=None, return_format='json')
removeJobTask(jobtype_id, task_id, runasuser=None)
removeJobType(jobtype_id, runasuser=None)
removeNotification(notification_id, runasuser=None)
removeNotificationExternalID(notification_id, runasuser=None)
removeTaskDefinition(taskdef_id, query={}, matrix={}, runasuser=None, return_format='json')
setNotificationExternalID(notification_id, external_id, runasuser=None, return_format='json')
stopAllJobsUseWithCaution(matrix={}, query={'blocking': 'false'}, runasuser=None, return_format='text')
stopJob(job_id, query={'blocking': 'false'}, runasuser=None)
subscribeNotification(job_id, notification_document, runasuser=None, return_format='text')
updateJob(job_id, matrix={}, query={'blocking': 'false'}, runasuser=None, return_format='json')

Allows the updating of jobs

VidiRest.libraryapi module

class VidiRest.libraryapi.LibraryAPI(vsapi)
addEntryToLibraryACL(library_id, entry_document, runasuser=None, return_format='json')
createOrModifyLibraryStorageRule(lib_id, storagerule_document, tag=None, query={}, matrix={}, runasuser=None, return_format='json')
export(library_id, uri=None, tag_name=None, query=None, runasuser=None, return_format='json')
getLibraryACL(library_id, runasuser=None, return_format='json')
getLibraryACLEntry(library_id, access_id, runasuser=None, return_format='json')
getLibraryStorageRule(lib_id, tag, query={}, matrix={}, runasuser=None, return_format='json')
getLibraryStorageRules(lib_id, query={}, matrix={}, runasuser=None, return_format='json')
removeLibraryACLEntry(library_id, access_id, runasuser=None)
removeLibraryStorageRule(lib_id, shape_tag=None, runasuser=None, return_format='text')
setStorageRule(library_id, storagerule_doc, tag=None, runasuser=None, return_format='json')

VidiRest.logger module

class VidiRest.logger.NullHandler(level=0)

Creates a null handler for the logging events, so that if this library is imported and the calling application doesn’t properly handle logging events, we do not produce log files in the directory that application is invoked from. Applications that do handle logging correctly, will have the log entries from this library included.

emit(record)

Do whatever it takes to actually log the specified logging record.

This version is intended to be implemented by subclasses and so raises a NotImplementedError.

VidiRest.logger.getLogger(logger='server')

Handles logging input from this library

VidiRest.logreportapi module

class VidiRest.logreportapi.LogReportAPI(vsapi)

API which allows any call to vidispine, for log reporting

vidiGet(url, query={}, matrix={}, runasuser=None, return_format='xml')

Make a GET call to any url, with query arguments.

VidiRest.resourceapi module

class VidiRest.resourceapi.ResourceAPI(vsapi)
createResource(resource_document, runasuser=None, return_format='json')
getAllResourceTypes(runasuser=None, return_format='json')
getBackupStorages(fcs_id, runasuser=None, return_format='json')
getResource(resource_type, resource_id, runasuser=None, return_format='json')
getResourceStatus(resource_type, resource_id, runasuser=None, return_format='text')
getResourceStatusOnListOfResources(resource_type, runasuser=None, return_format='text')
getResources(resource_type, runasuser=None, return_format='json')
removeResource(resource_type, resource_id, runasuser=None)
setBackupStorages(fcs_id, storage_ids, runasuser=None, return_format='json')
updateResource(resource_type, resource_id, resource_document, runasuser=None, return_format='json')
updateResourceStatus(resource_type, resource_id, new_status, runasuser=None, return_format='json')

VidiRest.storageapi module

class VidiRest.storageapi.StorageAPI(vsapi)
addStorageToGroup(group_name, storage_id, runasuser=None, return_format='text')
copyFileToFile(file_id, destination_storage_id, destination_file_id, priority_of_job, return_format='json', runasuser=None)

Copy file to an existing file on a storage and overwrite the existing file

Parameters

  • file_id – The file id for the file that we are copying from

  • destination_storage_id – Storage id where the file that is going to be overwritten exists

  • destination_file_id – File id of the file that is being overwritten

  • priority_of_job – Priority of the vs job should have

copyStorageFileToNewStorage(current_storage_id, file_id, new_storage_id, priority_of_job=None, runasuser=None, return_format='json', filename=None, keep_original=True, item_id=None)
createFileEntity(storageId, filepath, createOnly=True, state='OPEN', return_format='json', runasuser=None)

Creates a file entity in the database. Does not create any physical files.

createOnly:

  • True: Fail if path file already exists

  • False: Update the existing file if one exists, else create new file entity

fileUri:

  • The absolute file URI

state:

  • Set the state of the file

createOrModifyStorageMethod(storage_id, query={}, runasuser=None, return_format='text')
createOrModifyStorageMethodWithID(storage_id, method_id, query={}, runasuser=None, return_format='json')
createStorage(storage_document, runasuser=None, return_format='json')
createStorageGroup(group_name, runasuser=None, return_format='text')
getAllAutoImportRules(runasuser=None, return_format='json')
getAllFileNotifications(runasuser=None, return_format='json')
getAllNotifications(runasuser=None, return_format='json')
getAllStorageGroups(query={'url': 'false'}, runasuser=None, return_format='json')
getAllStorages(query={}, runasuser=None, return_format='json')
getAllStoragesInGroup(group_name, query={'url': 'false'}, runasuser=None, return_format='json')
getAutoImportRule(storage_id, runasuser=None, return_format='json')
getFileByHash(query={}, matrix={}, runasuser=None, return_format='json')
getFileById(file_id, query={}, matrix={}, runasuser=None, return_format='json')
getFileByPath(storage_id, path, query={}, matrix={}, runasuser=None, return_format='json')
getFileByURI(storage_id, uri, query={}, matrix={}, runasuser=None, return_format='json')
getFileData(file_id, runasuser=None)
getFileStatusInStorage(storage_id, file_id, query={}, matrix={}, runasuser=None, return_format='json')
getFilesInStorage(storage_id, query={}, matrix={}, runasuser=None, return_format='json')
getFreeSpaceOnListOfStorages(query={}, runasuser=None, return_format='text')
getImportableFilesInStorages(query={}, matrix={}, runasuser=None, return_format='json')
getItemFileRelationship(storage_id, file_id, runasuser=None, return_format='json')
getStorage(storage_id, runasuser=None, return_format='json')
getStorageFreeSpace(storage_id, runasuser=None, return_format='text')
getStorageGroup(storagegroup_name, query={'url': 'false'}, runasuser=None, return_format='json')
getStorageMetadata(storage_id, runasuser=None, return_format='json')
getStorageMethods(storage_id, query={}, runasuser=None, return_format='json')
getStorageStatus(storage_id, runasuser=None, return_format='text')
getStorageStatusOnListOfStorages(query, runasuser=None, return_format='text')
moveStorageFileToNewStorage(current_storage_id, file_id, new_storage_id, priority_of_job=None, runasuser=None, return_format='json', filename=None, item_id=None)

Calls copyStorageFileToNewStorage with keep_original=False. Kept as a separate method to keep the interface intact from earlier versions.

notifyStorageOfFile(storage_id, filepath, state='CLOSED', runasuser=None, return_format='json')

Notify Vidispine that there is a file on its storage, and get a file ID.

Ref Vidispine #204

removeAutoImportRule(storage_id, runasuser=None)
removeFileFromStorage(storage_id, file_id, runasuser=None, item_id=None, priority_of_job=None, return_format='json')
removeItemFileRelationship(storage_id, file_id, runasuser=None, return_format='json')
removeStorage(storage_id, runasuser=None)
removeStorageFromGroup(group_name, storage_id, runasuser=None, return_format='text')
removeStorageGroup(group_name, runasuser=None, return_format='text')
removeStorageMetadata(storage_id, key, runasuser=None, return_format='json')
removeStorageMethodWithID(storage_id, method_id, runasuser=None)
removeStorageMethodWithURL(storage_id, matrix={'url': ''}, runasuser=None)
rescanStorage(storage_id, runasuser=None, return_format='json')
restoreFileFromGlacier(storage_id, file_id, expiration_in_days, runasuser=None)

Trigger a request to glacier to initiate a restore. Once restore is complete the file will be put back in CLOSED state.

setAutoImportRule(storage_id, autoimportrule_document, runasuser=None, return_format='json')

for the storageapi.py in VidiRest David Moss @ 14:27

setFileState(storage_id, file_id, state='CLOSED', runasuser=None, return_format='json')

Set file state

setStorageCloseLimit(storage_id, minutes, runasuser=None, return_format='json')
setStorageFilenameScript(storage_id, script, runasuser=None)
setStorageGroupDescription(group_name, description, runasuser=None, return_format='text')
setStorageMetadata(storage_id, key, value, runasuser=None, return_format='json')
updateStorage(storage_id, storage_document, runasuser=None, return_format='json')
updateStorageStatus(storage_id, storage_document, runasuser=None, return_format='json')

VidiRest.storageruleapi module

class VidiRest.storageruleapi.StorageRuleAPI(vsapi)
createOrModifyStorageRule(storagerule_document, resource_name=None, query={}, matrix={}, runasuser=None, return_format='json')
getAllStorageRules(query={}, matrix={}, runasuser=None, return_format='json')
getStorageRule(resource_name, query={}, matrix={}, runasuser=None, return_format='json')
removeStorageRule(resource_name, runasuser=None)

VidiRest.userapi module

class VidiRest.userapi.UserAPI(vsapi)

Helper API for working with Users and Vidispine.

Logs as UserAPI

addUserToGroup(user_name, group_name, runasuser=None, return_format='json')
addUserToMultipleGroups(user_name, grouplist_document, query={'move': 'false'}, runasuser=None, return_format='json')
createGroup(group_name, group_document=None, runasuser=None, return_format='json')
createUser(user_name, real_name=None, password=None, groupList=None, runasuser=None, return_format='json')
doSearch(search_document, query=None, runasuser=None, return_format='json')
getAllGroups(query=None, runasuser=None, return_format='json')
getAllNotifications(runasuser=None, return_format='json')
getAllUsers(runasuser=None, return_format='json')

Gets all users from Vidispine

Kwargs:

runasuser: The user to run the function as.

return_format: The format to return the users as.

getChildGroupsToGroup(group_name, query={'traverse': 'false'}, runasuser=None, return_format='json')
getGroup(group_name, runasuser=None, return_format='json')
getGroupDescription(group_name, runasuser=None)
getGroupMetadata(group_name, runasuser=None, return_format='json')
getGroupMetadataKey(group_name, key, runasuser=None, return_format='text')
getParentGroupsToGroup(group_name, query={'traverse': 'false'}, runasuser=None, return_format='json')
getRoleStatus(group_name, runasuser=None)
getUser(user_name, runasuser=None, return_format='json')

Get a user from Vidispine

Args:

user_name: The username of the person to be looked up.

Kwargs:

runasuser: The user to run the function as.

return_format: The format to return the users as.

getUserGroups(user_name, query=None, traverse=False, runasuser=None, return_format='json')
getUserRoles(user_name, runasuser=None, return_format='json')
getUsersBelongingToGroup(group_name, query=None, runasuser=None, return_format='json')
reEnableUser(user_name, runasuser=None, return_format='json')
removeChildGroupFromGroup(group_name, child_group, runasuser=None)
removeGroup(group_name, runasuser=None)
removeGroupMetadata(group_name, runasuser=None)
removeGroupMetadataKey(group_name, key, runasuser=None)
removeUser(user_name, runasuser=None, hard=False, return_format='json')
removeUserFromGroup(user_name, group_name, runasuser=None, return_format='json')
setChildGroupToGroup(group_name, child_group, runasuser=None)
setGroupDescription(group_name, description, runasuser=None)
setGroupMetadata(group_name, simplemetadata_document, runasuser=None, return_format='json')
setGroupMetadataKey(group_name, key, value, runasuser=None, return_format='text')
setUserPassword(user_name, password, md5_encrypt=False, runasuser=None, return_format='json')
setUserRealName(user_name, real_name, runasuser=None, return_format='json')
setUserUsername(user_name, new_name, runasuser=None, return_format='json')
updateGroup(group_name, group_document, query={}, runasuser=None)
validateUser(user_name, password, md5_encrypt=False)

Validate a user using a username and password Args:

user_name: The user’s username password: The user’s password md5_encrypt: Should the password be sent md5-hashed (Deprecated and ignored since vidispine doesn’t support this mode anymore)

Return:

A boolean indicating whether the username and password is valid.

Module contents