Netxconnector v1.0

Version 1.0

Connector Overview: This page documents all 5 actions for the Netxconnector v1.0.

Asset (4)

GET GET asset original

/api/file/asset/{assetId}/{fileName}

GET asset original

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.

queryParams

Additional query string name/value pairs to append to the request URL.

Assetid

The unique identifier of the asset whose original file you want to download.

Filename

The name of the file to retrieve, as stored in the asset record.

Response Type

The response format expected from the API (e.g. application/json).

Options (1)

Option Name

Description

Value

Additional options value to customize the request, such as version or rendition parameters.

GET GET asset thumbnail

/api/file/asset/{assetId}/thumbnail.jpg

GET asset thumbnail

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.

queryParams

Additional query string name/value pairs to append to the request URL.

Assetid

The unique identifier of the asset whose thumbnail you want to fetch.

Response Type

The response format expected from the API (e.g. application/json).

Options (1)

Option Name

Description

Value

Additional options value to customize the thumbnail request, such as size or format preferences.

POST Import Asset

/api/import/asset

Import Asset

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.

queryParams

Additional query string name/value pairs to append to the request URL.

Response Type

The response format expected from the API (e.g. application/json).

Options (3)

Option Name

Description

File

The file data to upload, typically provided as a binary stream or multipart form data.

Filename

The desired filename for the imported asset, which may be used as the asset's display name.

Folderid

The identifier of the target folder where the asset should be placed after import.

POST Version Asset

/api/rpc/api/import/asset/{assetId}/version

Version Asset

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.

queryParams

Additional query string name/value pairs to append to the request URL.

Assetid

The unique identifier of the asset to which the new version will be added.

Response Type

The response format expected from the API (e.g. application/json).

Options (2)

Option Name

Description

File

The file data for the new version, uploaded as binary content.

Filename

The filename for the new version, which may override the asset's current filename.

Rpc

POST callAMethod

/api/rpc

Gets one or more assets using their unique identifiers

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.

queryParams

Additional query string name/value pairs to append to the request URL.

Response Type

The response format expected from the API (e.g. application/json).

Options (4)

Option Name

Description

Id

An identifier for the RPC request, used to correlate requests and responses.

Jsonrpc

The JSON-RPC version string, typically "2.0".

Method

The name of the method to invoke on the server.

Params

An array of parameters to pass to the method, as specified by the method's definition.