Etere Api
Etere API web services.
The following operations are supported. For a formal definition, please review the Service Description.
-
About
About Etere Api -
ConvertFrameToSmpte
Convert frame to smpte format (hh:mm:ss:ff) -
CreateFilesForImport
Generate an XML and XSLT file containing the related strings to be imported into asset metadata -
CreateNewAssetVersion
Create a new asset version -
CreateNewStory
Create new story -
DecryptEtereValue
decrypts an ether string with a specific internal protocol -
DeleteAssetArtistByAssetId
Delete the artist from the asset according to the user rights according to the user rights. -
DeleteAssetByCode
Delete the asset according to the user rights according to the user rights. -
DeleteAssetById
Delete the asset according to the user rights according to the user rights. -
DeleteAssetEDLById
Delete the EDL data satisfying an id filter according to the user rights.
_user: Login name of the executor.
_pwd: Password of the executor.
_IdAsset: ID of the target asset.
_version: Number of EDL to be queried (from 1 to 9). -
DeleteAssetGenreByAssetId
Delete the genre from the asset according to the user rights according to the user rights. -
DeleteSegment
Delete segment -
EncryptEtereValue
endecrypts an ether string with a specific internal protocol -
EtConfig
Returns the system data configuration for other web api.
outputFormat 0 for xml or 1 for json -
F90FileImport
It transmits to ETEREF90 the file to import and his typology
coduser: Valid Etere channel number
import_type: Valid values are F90GENERICXMLIMPORT or F90GENERICTXTIMPORT or F90CUSIMPVTVSCHEDULEXML
reference_date: Reference date of the import, is the date to import
file_name: File name of the file
file_data: Data of the file. It contents the entire data file -
GetActiveRundownsList
Returns the list of active rundowns. -
GetArtistByText
Artists list,the search is carried out using a text filter -
GetAssetByCode
Returns the existing asset satisfying an id filter according to the user rights. -
GetAssetById
Returns the existing asset satisfying an id filter according to the user rights. -
GetAssetById_AllData
Returns the existing asset with all data satisfying an id filter according to the user rights. -
GetAssetById_ExtendedData
Returns the existing asset with extended data satisfying an id filter according to the user rights. -
GetAssetEDLById
Returns the EDL data satisfying an id filter according to the user rights. -
GetAssetEDLFlexiById
Returns the EDL data and flexi metadata satisfying an id filter according to the user rights. -
GetAssetExplodedEDLById
Returns the exploded EDL data satisfying an id filter according to the user rights. -
GetAssetFlexiById
Returns the existing asset with flexi metadata satisfying an id filter according to the user rights. -
GetAssetFlexiMetadataList
Generate an XML file containing the list of used asset flexi metadata -
GetAssetListByAllTableFullText
Returns the list of existing assets satisfying a filter according to the user rights.
Simple search using a word - example: test
Search using more words - example: "My description"
Search using character (*) - example: "test*"
Search using operators (AND,OR) - example: test AND code
Search using operator (NEAR) - example: test NEAR code
-
GetAssetListByAllTableFullTextExResult
Returns the list of existing assets (all fields) satisfying a filter according to the user rights.
Simple search using a word - example: test
Search using more words - example: "My description"
Search using character (*) - example: "test*"
Search using operators (AND,OR) - example: test AND code
Search using operator (NEAR) - example: test NEAR code
-
GetAssetListByAllTableFullTextWithSuppInfo
Returns the list of existing assets with support information satisfying a filter according to the user rights.
Simple search using a word - example: test
Search using more words - example: "My description"
Search using character (*) - example: "test*"
Search using operators (AND,OR) - example: test AND code
Search using operator (NEAR) - example: test NEAR code
-
GetAssetListByArtist
Asset list with a certain artist,search by Id -
GetAssetListByArtistName
Asset list with a certain artist, search by name, surname or description -
GetAssetListByCode
Returns the list of existing assets satisfying a code filter according to the user rights. -
GetAssetListByCode_ExtendedData
Returns the extended list of existing assets satisfying a code filter according to the user rights. -
GetAssetListByFlexiMetadataItem
Returns the list of existing assets satisfying a flexi metadata filter according to the user rights. -
GetAssetListByFullText
Returns the list of existing assets satisfying a filter according to the user rights.
Simple search using a word - example: test
Search using more words - example: "My description"
Search using character (*) - example: "test*"
Search using operators (AND,OR) - example: test AND code
Search using operator (NEAR) - example: test NEAR code
-
GetAssetListByFullTextExResult
Returns the list of existing assets (all fields) satisfying a filter according to the user rights.
Simple search using a word - example: test
Search using more words - example: "My description"
Search using character (*) - example: "test*"
Search using operators (AND,OR) - example: test AND code
Search using operator (NEAR) - example: test NEAR code
-
GetAssetListByType
Returns the list of existing assets satisfying a type filter according to the user rights. -
GetAssetListByType_ExtendedData
Returns the extended list of existing assets satisfying a type filter according to the user rights. -
GetAvailableMetadeviceList
Retrieves the device list -
GetCodecsList
Returns the active codecs list. -
GetCountriesList
Returns all countries list. -
GetDailyRunDataByDay
Returns the schedule list of the day according to the available columns filter. -
GetFullArtistByID
Artists list,the search is carried out using the id of artist -
GetLTORackNameList
Get the list of all LTO rack name. -
GetListMissingMaterials
Returns the list of missing materials. -
GetListMissingMaterialsByHour
Returns the list of missing materials by hour.
CodUser=0 for all channel -
GetMamKeyPads
Get Mam Keypads -
GetMamKeywords
Get Mam Keywords -
GetMamKeywordsFromKeypads
Get Mam Keywords from keypds description -
GetMamKeywordsFromKeypadsId
Get Mam Keywords from Keypads Id -
GetMemoryBookmark
Get the Memory bookmarks data by period. -
GetMemoryBookmarkByAssetID
Get the Memory bookmarks data by period and asset id. -
GetMetaFilePath
Get MetaFile path. -
GetMetafileFileDataByMetafileFileId
Retrieves data for a given metafile file identifier in metadevice with a given description. -
GetMetafileFileIdsListByMetadeviceDescription
Retrieves the list of metafile file identifiers in a metadevice with a given description. -
GetMetafileListByAssetAndDevice
Retrieves the metafile list of an asset in a given device. -
GetMetafileListByAssetId
Retrieves the metafile list of an asset. -
GetRolesList
Returns all roles list. -
GetScheduledEvent
Get the list of the scheduled events. -
GetScheduledEventsWithSupport
List of the scheduled events with support data -
GetSegmentById
Get segment from Id -
GetSmpteItemList
Returns all available smpte code and description. -
GetStationsList
Returns all available stations. -
GetStoriesList
Returns the list of the stories.
Simple search using a word - example: test
Search using more words - example: "My description"
Search using character (*) - example: "test*"
Search using operators (AND,OR) - example: test AND code
Search using operator (NEAR) - example: test NEAR code
-
GetThumbnailById
Get address for the asset thumbnail based on the asset ID -
GetTypeList
Returns the list of existing types. -
GetTypeUsedPropertiesList
Returns the list of the used Type properties. -
GetVersion
Get version of etere api -
GetVideoStandard
Get the station video standard format. -
IS_CensureProfanity
Returns supplied text with profanities replaced by asterisks.
Parameters:
text: text to parse.
language: text language (one between italiano, english, portuguese, francais, spanish, deutsch, japanese, russian, thai, korean, hebrew, arabic, portugueseun, chinese, greek, vietnamese, chinese_simplified, bahasa, rumenian, georgian, burmese).
Returns:
Supplied text with profanities replaced by asterisks. -
IS_GetProfanitiesList
Returns a list of profanities found in supplied text.
Parameters:
text: text to parse.
language: text language (one between italiano, english, portuguese, francais, spanish, deutsch, japanese, russian, thai, korean, hebrew, arabic, portugueseun, chinese, greek, vietnamese, chinese_simplified, bahasa, rumenian, georgian, burmese).
Returns:
Space separated list of profanities found in supplied text. -
IS_ProcessProfanities
Process text for profanities.
Parameters:
operationMode: if 1 operates as CensureProfanity, if 2 operate as GetProfanitiesList. text: text to parse.
language: text language (one between italiano, english, portuguese, francais, spanish, deutsch, japanese, russian, thai, korean, hebrew, arabic, portugueseun, chinese, greek, vietnamese, chinese_simplified, bahasa, rumenian, georgian, burmese).
Returns:
if operationMode=1 the result of CensureProfanity, if operationMode=2 the result of GetProfanitiesList. -
LoadStory
Load story -
LoadStoryTemplateCategoryList
NZ Story template category list.
_categoryType: 0=All categories; 1=Only categories assigned to stories -
LoadStoryTemplateList
NZ Story template -
ReadListFileStatusForImport
List of file status XML and XSLT generated to be imported into asset metadata -
SetLTOTapeLocation
Set LTO tape location.
Rackname must be a valid Etere Lto (ie. server\ltovendor ltomodel)
Slot location number parameter set to 99 for Lto offline.In this case locNumberId=0 and slotLocationNr=0 -
SetMetaFileFromPath
Set metafile from file path.
_idCodec is the Codec ID
_xmlFile Contanis the file data
_idAsset To link the metafile to the asset (default=0 not linked)
_fileID Is the file identification (default=blank and self-generated by the system). -
SetMetadeviceStatus
Set the metadevice status (1=on 0=off) -
UpdateStory
Update story -
WF_AbortWorkflow
Execute abort of the workflow instance class and asset id according to the user rights. -
WF_AbortWorkflowByAssetCode
Aborts workflow on asset with the given code and installation -
WF_AbortWorkflowMD
Aborts a metadevice related workflow -
WF_ExecuteWorkflow
Execute the workflow instance class and asset id according to the user rights. -
WF_ExecuteWorkflowByAssetCode
Executes workflow on asset with the given code and installation -
WF_ExecuteWorkflowMD
Executes a metadevice related workflow -
WF_GetAvailableWorkflows
Returns all available workflow according to the user rights. -
WF_GetWorkflowStatus
Returns the status of a workflow instance class and asset id according to the user rights. -
WF_GetWorkflowStatusByAssetCode
Returns workflow status on asset with the given code and installation -
WF_GetWorkflowStatusMD
Returns the status of a metadevice related workflow -
WF_ResetWorkflow
Execute reset of the workflow instance class and asset id according to the user rights. -
WF_ResetWorkflowByAssetCode
Reset workflow on asset with the given code and installation -
WriteAsset
Create or update single asset -
WriteSegment
Create or update an existing segment, to create a segment the id must have value 0 -
WriteType
Create or update the types with properties