1. Prerequisites and Additional Steps, Developer Key
2. Connector Action & Tests
|
Action Name / Method |
Search Asset |
||
|---|---|---|---|
|
Action Description |
Search & get asset |
||
|
Test Case |
Search & get asset |
||
|
Request Body Name |
Parameter |
Type |
Description (Example) |
|
SearchField |
Search Criteria |
String |
Specify the searching criteria e.g Starts/Ends/Contains |
|
SearchField |
Value |
String |
Specify any keyword to find |
|
SearchField |
Custom Search Identifier |
String |
User can specify any custom defined field name here e.g oneteg |
|
SearchField |
Search Identifier |
String |
List of predefined fields |
|
Action Name / Method |
Get Metadata |
||
|---|---|---|---|
|
Action Description |
Retrieves metadata details of any asset |
||
|
Test Case |
Retrieves metadata details of any asset |
||
|
Request Body Name |
Parameter |
Type |
Description (Example) |
|
|
Asset ID |
String |
Specify the asset identifier e.g 21 |
|
Action Name / Method |
Get Asset |
||
|---|---|---|---|
|
Action Description |
Retrieves contents of any asset |
||
|
Test Case |
Retrieves contents of any asset |
||
|
Request Body Name |
Parameter |
Type |
Description (Example) |
|
|
Asset ID |
String |
Specify the asset identifier e.g 21 |
|
Action Name / Method |
Get Publications |
||
|---|---|---|---|
|
Action Description |
Retrieves data of publications, categories, action properties and other type of data |
||
|
Test Case |
Get list of Brands (Publications) |
||
|
Request Body Name |
Parameter |
Type |
Description (Example) |
|
|
IDs |
String |
Specify id of any object |
|
|
Request Info |
String |
Specify the request type of which the data retrieves e.g. publications, categories |
|
Action Name / Method |
Get Custom Properties |
||
|---|---|---|---|
|
Action Description |
Returns the global and publication-specific custom properties |
||
|
Test Case |
Returns the global and publication-specific custom properties |
||
|
Request Body Name |
Parameter |
Type |
Description (Example) |
|
Action Name / Method |
Update Metadata |
||
|---|---|---|---|
|
Action Description |
Update asset metadata properties |
||
|
Test Case |
Update asset name value |
||
|
Request Body Name |
Parameter |
Type |
Description (Example) |
|
|
Asset ID |
String |
Specify asset id for updating the metadata property |
|
BasicMetaData |
Property Identifier |
String |
Specify property name e.g Name |
|
BasicMetaData |
Property Value |
String |
Specify property value e.g <new name of the asset> |
|
Action Name / Method |
Create Object |
||
|---|---|---|---|
|
Action Description |
Creates new objects (article, image, layout) in the database |
||
|
Test Case |
Create new image |
||
|
Request Body Name |
Parameter |
Type |
Description (Example) |
|
|
Asset ID |
String |
Specify asset id for updating the metadata property |
|
BasicMetaData |
Property Identifier |
String |
Specify property name e.g Name |
|
BasicMetaData |
Property Value |
String |
Specify property value e.g <new name of the asset> |
|
Files |
Property Identifier |
String |
Specify property name e.g Name |
|
Files |
Property Value |
String |
Specify property value e.g <new name of the asset> |
|
Publication |
Property Identifier |
String |
Specify property name e.g Name |
|
Publication |
Property Value |
String |
Specify property value e.g <new name of the asset> |
|
Category |
Property Identifier |
String |
Specify property name e.g Name |
|
Category |
Property Value |
String |
Specify property value e.g <new name of the asset> |
3. Connection Settings and Configuration
|
Settings Parameters |
Value |
Description |
Required (Y/N) |
Default Value |
|---|---|---|---|---|
|
Connector |
Woodwing Studio |
Connector Name |
Y |
Woodwing Studio |
|
Endpoint |
|
Endpoint required for performing CRUD |
Y |
|
|
User Name |
woodwing |
User id for authentication |
Y |
|
