GET All Brandbox Assets's Metadata

Returns the list of all brand box data for brand client ID.

Endpoint /v2.09/partnerapi/Brandbox/Assets
Method GET
Request Body Sample N/A

Response Body Sample

{
"@odata.context": "https://apistg.aprimodm.com/v2.0/partnerapi/BrandBox/$metadata#Assets",
"value": [
{
"AssetsID": 153,
"Name": "Accelerating EHR Adoption White Paper",
"Description": "In-depth white paper on how speech recognition accelerates the adoption of EHR by physicians",
"Tags": "",
"Type": "PDF",
"Size": 455,
"IsFavorite": false,
"IsPopular": false,
"IsMarquee": false,
"FolderPath": "Case Studies & White Papers/Clinical Documentation White Papers",
"ErrorCode": 0,
"ErrorMessage": ""
},
. . . .
{
"AssetsID": 3574,
"Name": "omnietest",
"Description": "",
"Tags": " omnietest",
"Type": "Image",
"Size": 9,
"IsFavorite": false,
"IsPopular": false,
"IsMarquee": false,
"FolderPath": "",
"ErrorCode": 0,
"ErrorMessage": ""
}
]
}

OData Query Options

Partner Brandbox OData API supports the following OData Query Options:
• filter
• top
• skip
• order

System Query Option: $filter

Filters a collection of resouces that are addressed by a request URL. $filter is evaluated for each resource in the collection, and only items where the expression evalutaes to be true are inclued in the response.

$filter
Method GET
Sample Query /v2.0/partnerapi/BrandBox/Assets?$filter=FolderPath eq ‘Communications Archive’

Response Body Sample

{
"@odata.context": "https://apistg.aprimodm.com/v2.0/partnerapi/BrandBox/$metadata#Assets",
"value": [
{
"AssetsID": 174,
"Name": "Welcome to Nuance Portal",
"Description": "Nuance channel partners...welcome to the new Nuance Healthcare Channel marketing network, available now on Revenew!",
"Tags": "",
"Type": "PDF",
"Size": 118,
"IsFavorite": false,
"IsPopular": false,
"IsMarquee": false,
"FolderPath": "Communications Archive",
"ErrorCode": 0,
"ErrorMessage": ""
},
. . . .
{
"AssetsID": 183,
"Name": "Get the Marketing Materials You Need on Revenew",
"Description": "Case Studies, Logos, Images, Videos and More Available at the Click of a Button",
"Tags": "",
"Type": "PDF",
"Size": 484,
"IsFavorite": false,
"IsPopular": false,
"IsMarquee": false,
"FolderPath": "Communications Archive",
"ErrorCode": 0,
"ErrorMessage": ""
}
]
}

 

More $filter query examples
/v2.0/partnerapi/BrandBox/Assets?$filter=contains(Type, ‘PDF’)
/v2.0/partnerapi/BrandBox/Assets?$filter=Name eq ‘The Electronic Patient Narrative’
/v2.0/partnerapi/BrandBox/Assets?$filter=IsPopular
/v2.0/partnerapi/BrandBox /Assets?$filter=indexof(FolderPath, ‘Intermediary Main Folder’) gt-1

System Query Option: $top and $skip

The $top system query option requests the number the first n items in the queried collection to be included in the result. The $skip query option requests the first n items in the queried collection to be ommitted in the result.

$top and $skip
Method GET
Sample Query /v2.0/partnerapi/BrandBox/Assets?$skip=4&$top=2

Response Body Sample

{
"@odata.context": "https://apistg.aprimodm.com/v2.0/partnerapi/BrandBox/$metadata#Assets",
"value": [
{
"AssetsID": 159,
"Name": "PowerMic II Getting Started Guide",
"Description": "Guide on how to get started dictating using the PowerMic II",
"Tags": "",
"Type": "PDF",
"Size": 817,
"IsFavorite": false,
"IsPopular": false,
"IsMarquee": false,
"FolderPath": "Product Marketing Assets/PowerMic II",
"ErrorCode": 0,
"ErrorMessage": ""
},
{
"AssetsID": 160,
"Name": "Orthopedics Northwest Case Study",
"Description": "Case study on how Orthopedics Northwest improved patient care, boosted efficiency and reduced overhead with Dragon Medical Practice Edition",
"Tags": "",
"Type": "PDF",
"Size": 288,
"IsFavorite": false,
"IsPopular": false,
"IsMarquee": false,
"FolderPath": "Case Studies & White Papers/DMPE Case Studies",
"ErrorCode": 0,
"ErrorMessage": ""
}
]
}

System Query Option: $orderby

The $orderby system query option allows clients to request resources in either ascending order using asc or descending order using desc. If asc or desc not specified, then the resources will be ordered in ascending order.

$orderby
Method GET
Sample Query /v2.0/partnerapi/BrandBox/Assets?$orderby=Size asc

Response Body Sample

{
"@odata.context": "https://apistg.aprimodm.com/v2.0/partnerapi/BrandBox/$metadata#Assets",
"value": [
{
"AssetsID": 3545,
"Name": "Level 1: Sponsor_Test'Html",
"Description": "",
"Tags": " SpHtml1",
"Type": "Html",
"Size": 0,
"IsFavorite": false,
"IsPopular": false,
"IsMarquee": false,
"FolderPath": "",
"ErrorCode": 0,
"ErrorMessage": ""
},
. . .
{
"AssetsID": 839,
"Name": "Introduction to Nuance Partner Forums - Webinar - ",
"Description": "The webinar from 9.22.14 introducing Nuance Healthcare Partners to the online Discussion Forums. (55 minutes)",
"Tags": "",
"Type": "Video",
"Size": 116148,
"IsFavorite": false,
"IsPopular": false,
"IsMarquee": false,
"FolderPath": "Channel Program Information",
"ErrorCode": 0,
"ErrorMessage": ""
}
]
}
More $orderby query examples
/v2.0/partnerapi/BrandBox/Assets?$orderby=AssetsID desc
/v2.0/partnerapi/BrandBox/Assets?$filter=FolderPath eq’Communications Archive’&$orderby=Type desc, Size desc

GET A Single Assets Metadata

Returns Assets specific information i.e(Name, Description, Tags, Type, IsFavorite, IsPopular, IsMarquee, FolderPath)

Endpoint /v2.0/partnerapi/BrandBox/Assets(assetid)
Method GET
Request Body Sample N/A

Response Body Samplpe

{
"@odata.context":"https://apistg.aprimodm.com/v2.0/partnerapi/BrandBox/$metadata#Assets",
"value":[
{
"AssetsID":156,
"Name":"PowerMic II Product Sheet",
"Description":"Product Sheet that highlights the features and benefits of the PowerMic II",
"Tags":"",
"Type":"PDF",
"Size":226,
"IsFavorite":false,
"IsPopular":false,
"IsMarquee":false,
"FolderPath":"Product Marketing Assets/PowerMic II",
"ErrorCode":0,
"ErrorMessage":""
}
]
}

Download Asset


Returns Assets Files in a Zipped file.

Endpoint /v2.0/partnerapi/BrandBox/Assets(assetid)/download
Method GET
Request Body Sample N/A
Response Body Sample Returns Assets File

Download Asset Tile Image

Returns Assets Thumbnail image in a Zipped file.

Endpoint /v2.0/partnerapi/BrandBox/Assets(assetid)/thumbnail
Method GET
Request Body Sample N/A
Response Body Sample Returns Assets Thumbnail File