4AllPortal Connector v1.0
1. Prerequisites and Additional Steps, Developer Key
Log into 4AllPortal Portal with the correct credentials for Digital Asset Management, Product Information Management System, Brand Shop, or any other module.
Select the API keys option to view all the available API keys:
To check “user name” , click on the User that you are going to use the API Key with.
Also, get the API Key information for the user you have selected.
2. Connector Action & Tests
Action Name / Method | Search Asset | ||
|---|---|---|---|
Action Description | Search & get object from relevant module | ||
Test Case | Search objects using different filters | ||
Request Body Name | Parameter | Type | Description (Example) |
| Domain Name | String | Digital Asset Management |
SearchField | Search Criteria | String | Starts |
SearchField | Value | String | car |
SearchField | Search Identifier | String | name |
Action Name / Method | Get Asset | ||
|---|---|---|---|
Action Description | Get object content data from relevant module | ||
Test Case | Get asset by providing the asset id and retrieve its contents | ||
Request Body Name | Parameter | Type | Description (Example) |
| Asset Id | String | Identifier of any object/product/asset |
| Domain | String | Domain selection e.g Digital Asset Management |
Action Name / Method | Get Metadata | ||
|---|---|---|---|
Action Description | Get Metadata of any Object | ||
Test Case | Get metadata of an object by providing the object id and used that data with other steps | ||
Request Body Name | Parameter | Type | Description (Example) |
| Asset Id | String | Identifier of any object/product/asset |
| Domain | String | Domain selection e.g Digital Asset Management |
| Fields | String | Specify comma separated fields to filter from whole metadata objects e.g name, brand |
Action Name / Method | Create Asset | ||
|---|---|---|---|
Action Description | Create new object | ||
Test Case | Create new asset on DAM module | ||
Request Body Name | Parameter | Type | Description (Example) |
| Asset Path | String | Specify file path to upload while creating new asset |
| Asset Name | String | Specify asset name |
| Folder Name | String | Specify folder path e.g General/Job/2022 |
Action Name / Method | Update Metadata | ||
|---|---|---|---|
Action Description | Update object metadata | ||
Test Case | Update metadata of any object | ||
Request Body Name | Parameter | Type | Description (Example) |
| Asset Id | String | Specify asset identifier e.g 593e9a1f-54c5-4371-9358-5b3d93025b1b |
Update Metadata Field | Field Identifier | String | brand |
Update Metadata Field | Field Value | String | coke |
Action Name / Method | Get All Field Metadata | ||
|---|---|---|---|
Action Description | Get all metadata values of relevant 4All Portal domain e.g. Health App, Play Mobil | ||
Test Case | Get all metadata field record of different modules | ||
Request Body Name | Parameter | Type | Description (Example) |
| Domain | String | Domain selection e.g Digital Asset Management |
| Id | String | Specify identifier of any specific metadata section to select from the main object e.g Marketing |
