Woodwingassetsconnector v1.1 | OneTeg Documentation

Version 1.1

Connector Overview: This page documents all 22 actions for the Woodwingassetsconnector v1.1.

General (21)

GET Browse

/browse

Retrieve a list of items in a specified folder path.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Path`	The folder path to browse, for example '/images'.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Bulk Update

/updatebulk

Update metadata for multiple assets matching a search query.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Q`	A search query string to select assets to update.
`Metadata`	A JSON string containing the metadata fields and values to apply.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Checkout

/checkout/{assetid}

Checkout an asset by its ID to lock it for editing, preventing others from modifying it simultaneously.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Assetid`	Asset Id
`Response Type`	The response format expected from the API (e.g. application/json).

POST Copy

/copy

Copy an asset or folder from a source path to a target path.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Source`	The source path of the asset or folder to copy.
`Target`	The destination path where the copy will be created.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Create

/create

Upload a new asset by providing the file data and filename.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Filedata`	The file content as a base64-encoded string or binary data.
`Filename`	The name of the file to create.

POST Create Auth Key

/createAuthKey

Generate an authorization key for a subject to access specific assets until a given timestamp.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Subject`	The subject (user or application) for which the auth key is created.
`Assetids`	Comma-separated list of asset IDs the key grants access to.
`Validuntil`	The Unix timestamp (seconds) until which the key remains valid.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Create Folder

/createFolder

Create a new folder at the specified path.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Path`	The full path for the new folder, for example '/projects/newfolder'.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Create Relation

/createRelation

Establish a relation between two assets with a specified relation type.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Relationtype`	The type of relation to create, such as 'parent' or 'child'.
`Target1id`	The ID of the first asset in the relation.
`Target2id`	The ID of the second asset in the relation.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Log Usage Stats

/logUsage

Log usage statistics for an asset, recording an action, insert size, and page URL.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Assetid`	The ID of the asset being used.
`Action`	The action performed on the asset, such as 'view' or 'download'.
`Insertsize`	The size of the inserted content in bytes or other units.
`Pageurl`	The URL of the page where the usage occurred.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Login

/apilogin

Authenticate with the Woodwing Assets system using a username and password.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Username`	The username for login.
`Password`	The corresponding password.

POST Logout

/logout

End the current session and invalidate the authentication token.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Move/Rename

/move

Move or rename an asset or folder from a source path to a target path.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Source`	The current path of the item to move or rename.
`Target`	The new path for the item.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Profile

/profile

Retrieve the profile information of the currently authenticated user.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Remove

/remove

Delete one or more assets by their IDs.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Ids`	Comma-separated list of asset IDs to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Remove Relation

/removeRelation

Delete one or more asset relations by their relation IDs.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Relationids`	Comma-separated list of relation IDs to remove.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Revoke Auth Keys

/revokeAuthKey

Revoke one or more authorization keys, making them invalid.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Keys`	Comma-separated list of authorization key values to revoke.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Search

/search

Search for assets using a query string and optionally specify which metadata fields to return.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Q`	A search query string, for example 'type:image AND author:john'.
`Metadatatoreturn`	Comma-separated list of metadata field names to include in the results.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Undo Checkout

/undocheckout/{assetid}

Undo a checkout for a specific asset, releasing the lock without saving changes.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Assetid`	Asset Id
`Response Type`	The response format expected from the API (e.g. application/json).

POST Update Auth Key

/updateAuthKey

Update the authentication key used for API access. Use this action to refresh or change the current auth key.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Key`	The new authentication key value to set.
`Requestupload`	Whether to request an upload session immediately after updating the key.
`Importfolderpath`	The import folder path to associate with the updated authentication key.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Update/Check-in

/update

Update an asset or check it back in after editing. Use this action to save changes to an existing asset.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The unique identifier of the asset to update or check in.
`Metadata`	A JSON string containing the metadata fields and values to apply.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Versioning and History

/asset/history

Retrieve the version history and change log of an asset. Use this action to review past modifications or restore a previous version.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The unique identifier of the asset whose history is requested.
`Detaillevel`	The level of detail to include in the history, with higher values providing more information.
`Actions`	A comma-separated list of action types to filter the history by.
`Response Type`	The response format expected from the API (e.g. application/json).

Download

GET Download Asset

x-oneteg-downloader-path-without-authorization

Download an asset from a given URL using configurable timeout and retry settings.

Parameters

Parameter Name	Description
`HTTP Method`	The HTTP method to use for the download, typically 'GET'.
`Download Url`	The URL from which to download the asset.
`Asset Name`	The name to assign to the downloaded file.
`Try Count`	Number of download retry attempts.
`Read Timeout (seconds)`	Read timeout in seconds for the download.
`Connection Timeout (seconds)`	Connection timeout in seconds for the download.
`Load File Content As Output`	This toggle enables you to load file content as the step output. Supported formats include JSON, XML, YML/YAML, CSV, TXT, and other text-based file types. Note that images, PDF files, and other binary formats cannot be loaded. Additionally, there is a file size limit for this feature; please check the logs for details.
`Follow Redirects`	Enable or disable following URL redirects. If it is enabled, it will follow the URL redirects.
`headers`	Additional HTTP header name/value pairs to include in the request.