Legacy SDK Compatibility

We have aimed to make the new SDK largely compatible with the legacy SDK, but there have been some necessary changes. Some service methods have not been implemented due to the functionality not being available via the Flex REST API, whilst the script context object has some functionality removed.

Context methods

The context object available to script has had a number of methods renamed for clarity:

Old Method New Method
getDateVariable getWorkflowDateVariable
getMioObject getFlexObject
getNumberVariable getWorkflowNumberVariable
getStringVariable getWorkflowStringVariable
removeVariable removeWorkflowVariable
setDateVariable setWorkflowDateVariable
setDateListVariable setWorkflowDateListVariable
setNumberVariable setWorkflowNumberVariable
setStringVariable setWorkflowStringVariable

Please note getMioObject() in the legacy scripting framework used to return whatever Flex object class was being executed upon, whereas now it returns a simpler com.ooyala.flex.model.object.FlexObject instance.

The following methods are not available in the new Groovy context:

  • removeObjectId
  • setObjectId

Service Methods

The following table documents the missing SDK methods. Please contact your Flex representative if you require any of the unimplemented functionality.

Class New Action Name
AccountPropertyService getAccountProperty(String key)
AccountService deleteProperty(Long accountId,Long propertyId)
getAccount(String name)
getAccountMetadata(Account account)
getAccountVariant(Long accountId, Long variantId)
getAccountWorkspace(Long accountId)
getConfiguration(Long accountId, String accept)
getProperty(Long accountId, Long propertyId)
updateAccount(Long accountId, AccountUpdate accountUpdate)
updateAccountVariant(Long accountId, Long variantId, VariantUpdate variantUpdate)
updateProperty(Long accountId, Long propertyId, AccountPropertyUpdate propertyUpdate)
deleteAccountVariant(Long accountId,Long variantId)
getAccountWorkspace(Long accountId)
ActionService getActionConfiguration(Action action)
JobService getJobConfiguration(Job job)
getJobVariables(Long jobId)
scheduleJob(Job job)
scheduleJob(long jobId)
MetadataDefinitionService getMetadataDefinition(Long metadataDefinitionId)
getObjectTypes(String variableTypeName)
getVariable(Long metadataDefinitionId, Long variableId)
updateMetadataDefinition(Long metadataDefinitionId, MetadataDefinitionUpdate metadataDefinitionUpdate)
ObjectReferenceService getObjectReferenceByExternalId(String externalIdKey, String externalIdValue)
ObjectService addVariableComment(Long objectId, Long variableInstanceId, String comment)
deleteAttachment(Long objectId, Long attachmentId)
deleteVariableComment(Long objectId, Long variableInstanceId, Long commentId)
disable(Long objectId)
enable(Long objectId)
getAttachment(Long objectId, Long attachmentId)
getObjectExternalId(Long objectId, String externalIdKey)
getObjectExternalIds(Long objectId)
getVariableComments(Long objectId, Long variableInstanceId)
removeComment(Long objectId, Long commentId)
updateAttachment(Long objectId, Long attachmentId, AttachmentUpdate update)
updateComment(Long objectId, Long commentId, CommentUpdate comment)
TaxonomyService getChildTaxon(long taxonomyId, long parentTaxonId, String name)
getChildTaxons(Taxon parentTaxon)
UserDefinedObjectService addVariableComment(Long objectId, Long variableInstanceId, String comment)
delete(String pluralName, Long id)
deleteVariableComment(Long objectId, Long variableInstanceId, Long commentId)
getComment(String pluralName, Long id, Long commentId)
getFollowers(String pluralName, Long id, APIQuery apiQuery)
getHistory(String pluralName, Long id, EventAPIQuery eventAPIQuery)
getObjectVariableOptions(String pluralName, Long objectId, Long variableId, PathSegment matrixParam)
getUserDefinedObjectHierarchy(Long objectId)
getVariableComments(Long objectId, Long variableInstanceId)
removeComment(String pluralName, Long id, Long commentId)
updateComment(Long objectId, Long commentId, CommentUpdate comment)
updateUserDefinedObject(String pluralName, Long id, UserDefinedObjectUpdate userDefinedObjectUpdate)
UserDefinedObjectTypeService getRelationships(Long userDefinedObjectTypeId)
getUserDefinedObjectType(Long userDefinedObjectTypeId, String context)
getUserDefinedObjectTypeHierarchy(Long userDefinedObjectTypeId, String context)
getUserDefinedObjectTypeIcon(Long userDefinedObjectTypeId)
UserService setDefaultWorkspace(Long userId, UserDefaultWorkspace userDefaultWorkspace)
updateUserImage(Long userId, File imageFile, String imageDescription)
WizardService getWizardConfiguration(Wizard wizard)
WorkflowDefinitionService getWorkflowDefinition(Long workflowDefinitionId)
updateWorkflowDefinition(Long workflowDefinitionId, WorkflowDefinitionUpdate workflowDefinitionUpdate)
WorkflowService getStructure(Long workflowId)
getWorkflow(Long workflowId, boolean includeVariables)
getWorkflowSignals(Long workflowId)
getWorkflowVariables(Long workflowId)
getStructure(Long workflowId)
signalWorkflow(Long workflowId, NewSignal signal)