SearchService may be called using the SearchName parameter. This endpoint is used for accessing searches that are available on the config manager. These may be inspected in the Digizuite DAM Center. Note that some of them are hidden because they should not be changed. This section provides documentation on some of the most commenly used searches, but we refer the reader to the config manager area in the Digizuite DAM center for more searches.LogOnWithAccesKeyOptions is for generating a product specific accesskey for a user. It takes an accesskey and a json object. The json object contains a productGuid which is the guid for the product, a Boolean called UseVersionedMetadata for controlling the versioned metadata and a language id. This endpoint is for generating product and/or language specific access keys. An example usage of this could be setting metadata on a specific language rather than default English. GetAssets is used for fetching information about assets. This is a search on the Digizuite product.
URL : /SearchService.js
Method : POST
Auth required : NOYes
Required parameters
| Name | Example | Description |
|---|---|---|
| SearchName | GetAssets | Fixed parameter that identifies the endpoint search. |
| accessKey |
| 2d8319f4- |
| 7a57- |
| 4ca0- |
| a027-c44c2f259aac | AccessKey for API |
Optional parameters
| Name | Example | Description |
|---|---|---|
| sAssetId | 100 | ID of an asset in Digizuite |
| sChannelFolderId | 100 | ID of a channel in Digizuite. Use this for getting assets that are published to a specific channel |
| sCatalogFolderId | 100 | ID of catalog folder ID. Use this for getting assets in a specific catalog. |
| sAssetType | 4 | Filter for asset type, see GetAssetTypes |
sDateBetween | sDateBetween="10/5/2017"& sDateBetween_end="17/5/2017" | Filter for upload date |
| freetext | "test" | Search in title, description and keywords for the input. This can be modified to search on more fields. |
| sort | sortDateDesc | Defines what the result should be sorted on. Can be one value or a comma seperated list of values. The list of possible values are:
|
cUrl data example
| Info | ||
|---|---|---|
| ||
--data "methodSearchName=LogOnAccessKeyOptionsGetAssets&accessKeyaccesskey=caf31b4bfaa9987b-4e437b2d-45f747de-a8aaab3a-87cc490b652792993146a802&optionssAssetId={"dez.productGuid" : "AC045BF0-C538-4397-BC13-EF6A61DF6A82", "dez.useversionedmetadata" : "0", "dez.setmembersystemlanguage": "3"}"3119" |
Success Response
Code : 200 OK
Content example
| Code Block | ||
|---|---|---|
| ||
{
"success": true,
"error": "",
"total": "true1",
"items": [{
"itemId": "23624",
"accessKey": "2d8319f4-7a57-4ca0-a027-c44c2f259aac",
"memberId": "23",
"itemid": "3154",
"languageId": "3"
}
"totalCases": "1",
"assetId": "3119",
"itemId": "23624",
"assetType": "4",
"fileSize": "4318504",
"name": "",
"thumb": "https://mm-dam.dev.digizuite.com/dmm3bwsv3/3119_3_11_4_11_0_faa9987b-7b2d-47de-ab3a-92993146a802_False.jpg?mptdid=96310",
"downloadSource": "https://mm-dam.dev.digizuite.com/dmm3bwsv3/3119_0_11_4_44_0_faa9987b-7b2d-47de-ab3a-92993146a802_True_.jpg",
"imagePreview": "https://mm-dam.dev.digizuite.com/dmm3bwsv3/3119_2_11_4_11_0_faa9987b-7b2d-47de-ab3a-92993146a802_False.jpg?mptdid=96309",
"videoPreview": "https://mm-dam.dev.digizuite.com/dmm3bwsv3/3119_10079_11_4_11_0_faa9987b-7b2d-47de-ab3a-92993146a802_False.mp4?mptdid=0",
"videoPoster": "https://mm-dam.dev.digizuite.com/dmm3bwsv3/3119_2_11_4_11_0_faa9987b-7b2d-47de-ab3a-92993146a802_False.jpg?mptdid=96309",
"sourceLocationPath": "\\\\DZ-DEV-APP01\\mmdev\\dmm\\Assets\\1-10000\\3101-3200\\3119\\3119_.jpg",
"importDate": "2017-12-19T15:54:23.990+01:00",
"importedBy": "SuperAdministrator",
"assetVersionId": "",
"isPublic": "1",
"neverExpire": "1",
"endDate": "2017-12-19T15:54:24.060+01:00",
"published": "1",
"writeAccess": "1",
"readAccess": "1",
"displayAssetId": 3119,
"displayitemId": 23624,
"displayName": "",
"displayAssetType": "4",
"displayFileSize": "4318504",
"displayImportedBy": "SuperAdministrator",
"displayImportDate": "2017-12-19T15:54:23.990+01:00"
}]
} |
Error Response
Code : 200 OK
Content example
| Code Block |
|---|
{
"success": false,
"falsetotal": 0,
"error": "Access DeniedA critical exception occurred while we executed the search.\r\n",
"items": null,
"warnings": [{
"accessKeySeverity": ""150,
"memberIdCode": "0"420,
"languageIdDescription": "0" A critical exception occurred while we executed the search."
} ]
} |