WoodWing Assets Connector v1.0

1. Prerequisites and Additional Steps, Developer Key

2. Connector Action & Tests

Action Name / Method	Search & get assets
Action Description	Search assets in Assets Server. The REST search method gives access to all the powerful search functions provided by the Assets Server search engine. You can execute all possible queries and even use faceted search. Apart from various types of metadata about the assets, the results returned by a search call also contain ready-to-use URLs to the thumbnail, preview and original file. This makes it extremely easy to display rich visual results.
Test Case	Search objects using different filters
Request Body Name	Parameter	Type	Description (Example)
	Query	String	The query to search for, see Searching for files in Assets Server by using a query. Required.
	Append Request Secret	String	Starts
	Number to Return	Number	Number of hits to return. Specify 0 to return no hits, this can be useful if you only want to fetch facets data. Optional. Default is 50.
	Start (First Result)	Number	First hit to be returned. Starting at 0 for the first hit. Used to skip hits to return 'paged' results.
	Sort	String	The sort order of returned hits. Comma-delimited list of fields to sort on. By default, date/time fields and number fields are sorted descending. All other fields are sorted ascending. To explicitly specify sort order, append "-desc" or "-asc: to the field. Some examples: sort=name sort=rating sort=fileSize-asc sort=status,assetModified-asc A special sort case is relevance. This lets the search engine determine sorting based on the relevance of the asset against the search query. Relevance results are always returned descending. Optional. Default is assetCreated-desc.
	Facets	String	Comma-delimited list fields to return facet for. For example: facets=tags,assetDomain Selected values for a facet must be specified with a "facet.<field>.selection" parameter. Do not add selected items to the query since that will cause incorrect facet filtering.
	Facet Field Selection	String	Comma-delimited list of values that should be 'selected' for a given facet. For example: facet.tags.selection=beach facet.assetDomain.selection=image,video Optional.

Action Name / Method	Browse Folders
Action Description	Browse folders. This call is designed to make it possible to browse folders and show their subfolders and collections, similar to how folder browsing works in Assets.
Test Case	Browser the required folder and get the list of assets
Request Body Name	Parameter	Type	Description (Example)
	Path	String	The path to the folder in Assets Server you want to list. Make sure the URL is properly URL-encoded, for example: spaces should often be represented as %20. Required.
	Include Folders	String	Indicates if folders should be returned. Optional. Default is true.
	Include Extensions	Radio button	A comma separated list of file extensions to be returned. Specify 'all' to return all file types. Optional. Default includes all 'container' assets: .collection, .dossier, .task
	Level of folders	String
	Include Asset	String	Indicates if files should be returned. Optional. Default is true, but filtered to only include 'container' assets.

Action Name / Method	Checkout Asset
Action Description	Checks out an asset from the system locking the file for other users
Test Case	Checkout an asset and lock it on Elvis
Request Body Name	Parameter	Type	Description (Example)
	Asset Id	String	The Assets Server id of the asset to be checked out. Required
	Download	Radio Button	When set to true, the asset will be checked out and downloaded from the system. If download is false it will only be checked out. Optional. Default is false.

Action Name / Method	Undo Checkout
Action Description	Undo a checkout for a single asset.
Test Case	Undo the check in activity
Request Body Name	Parameter	Type	Description (Example)
	Asset Id	String	Assets id of the asset that was checked out. Required

Action Name / Method	Update Check-In
Action Description	This call updates an existing asset in Assets Server with a new file. It can also be used to update metadata
Test Case	Updated existing asset with new file
Request Body Name	Parameter	Type	Description (Example)
	Asset Id	String	The Assets Server id of the asset to be updated. Required.
	Partition Id	String
	Rating	String
	Asset Path	String
	Preview State	String
	Status	String

Action Name / Method	Copy Folder or Single Asset
Action Description	Copy Folder or Single Asset
Test Case	Copy asset from one folder to another
Request Body Name	Parameter	Type	Description (Example)
	Source Asset Path	String	provide the source folder path
	Destination Path	String	provide the destination folder path
	Async	String
	Folder Replace Policy	String
	Asset Replace Policy	String
	Flatten Folders	String

Action Name / Method	Create Folder
Action Description	Create one or more folders
Test Case	Create new folder on Elvis portal
Request Body Name	Parameter	Type	Description (Example)
	Folder Path	String	The full folderPath of the folder to be created. This same parameter name can be specified multiple times to create several folders with one call. Required

Action Name / Method	Move/Rename A Folder or Single Asset
Action Description	Move or rename a folder or a single asset. You can combine a rename operation and a move operation. Just specify the new target path. When you move or rename a folder, all assets contained in the folder will also be moved to the new location. The subfolder structure will be kept intact.
Test Case	Move an asset from one folder to another
Request Body Name	Parameter	Type	Description (Example)
	Source	String	Either a folderPath or assetPath of the folder or asset to be moved or renamed. Required
	Target		The folderPath or assetPath to which the folder or asset should be moved or renamed. If the parent folder is the same as in the source path, the asset will be renamed, otherwise it will be moved. Required.
	FolderReplacePolicy	String	Policy used when destination folder already exists. AUTO_RENAME - add '-1' number to destination path. The counter is incremented until a free alternative is found. MERGE - merge source folder into destination using fileReplacePolicy. THROW_EXCEPTION - abort the operation. Optional. If omitted, AUTO_RENAME will be used. Only applies when the source is a folderPath.
	Async	Radio Button	When true, the process will run asynchronous in the background. The call will return immediate with the processId. Optional. By default, the call waits for the process to finish and then returns the processedCount.
	Flatten Folders	Radio Button	When set to true will move all files from source subfolders to directly below the target folder. This will 'flatten' any subfolder structure. Optional. If omitted, folders will not be flattened. Only applies when the source is a folderPath.

Action Name / Method	User Profile
Action Description	Retrieve details about the user authenticated in the current browser session
Test Case
Request Body Name	Parameter	Type	Description (Example)

Action Name / Method	Remove Asset
Action Description	Removes one or more assets, or folders including their content
Test Case	Delete an asset
Request Body Name	Parameter	Type	Description (Example)
	Asset IDs	String	A comma-delimited list of asset ids to be removed.
	Async		When true, the process will run asynchronous in the background. The call will return immediate with the processId. Optional. By default, the call waits for the process to finish and then returns the processedCount

3. Connection Settings and Configuration