gethttp://{networkName}.admin.fyre.co/services/frontline/api/v4/assetManager//{network}/assetLibrary/{library}/assets
Search for assets.
name | required | type | description |
---|---|---|---|
network | true | string | Livefyre Network ID. |
library | true | string | Livefyre Asset Library ID. Every network has a default Asset Library with the same ID as the network. |
name | required | type | description |
---|---|---|---|
query | false | string | Full-text search term. Searches text content of the post, author display name and author username. |
folder | false | string | Filter assets by folder ID. Find all assets in this folder. |
folderTree | false | string | Filter assets recursively by folder ID. Find all assets in this folder and any subfolders. |
generator | false | string | Filter by the service that generated the content (e.g. twitter.com, instagram.com). |
via | false | integer | Filter by how the content was added to asset manager. |
rights | false | integer | Filter by rights request status. |
tags | false | string | Filter by tags. |
limit | false | integer | Number of Assets to return per batch. Default is 50. |
since | false | string | Used for paging. Pass this value into the since parameter in the request to get the next batch of values when sorting ascending. |
until | false | string | Used for paging. Pass this value into the since parameter in the request to get the next batch of values when sorting descending. |
Successful search.
property | type | description |
---|---|---|
assets | array | |
assets.[] | object | |
assets.[].id | string | The Asset ID. |
assets.[].library | object | The Asset Library the Asset belongs to. |
assets.[].library.id | string | |
assets.[].createdAt | string | The time the content was originally published, as an ISO 8601 string. |
assets.[].updatedAt | string | The time the content was updated, as an ISO 8601 string. |
assets.[].folders | array | |
assets.[].folders.[] | object | |
assets.[].folders.[].id | string | |
assets.[].folders.[].path | string | Slash-delimited location of the folder in the hierarchy. Path elements are folder IDs. |
assets.[].folders.[].label | string | |
assets.[].folders.[].inherit | boolean | True if this folder inherits the parent folders permissions. |
assets.[].folders.[].deleted | boolean | True if the folder is deleted. Deleted folders are not included in search results. |
assets.[].content | object | |
assets.[].content.id | string | The foreign ID of the content (e.g. Instagram's ID for Instagram content). |
assets.[].content.attachment | array | |
assets.[].content.attachment.[] | object | An embeddable object, such as a video or photo. |
assets.[].content.attachment.[].version | string | The oEmbed version number. This must be 1.0. |
assets.[].content.attachment.[].type | string | The Oembed type. Valid values are:
|
assets.[].content.attachment.[].link | object | |
assets.[].content.attachment.[].link.href | string | |
assets.[].content.attachment.[].url | object | The URL of the content. For photos, this should be embeddable in an |
assets.[].content.attachment.[].url.href | string | |
assets.[].content.attachment.[].html | string | The HTML required to display the resource. This may be a video player for video or arbitrary content for rich. |
assets.[].content.attachment.[].thumbnail_url | object | |
assets.[].content.attachment.[].thumbnail_url.href | string | |
assets.[].content.attachment.[].height | integer | |
assets.[].content.attachment.[].width | integer | |
assets.[].content.attachment.[].thumbnail_height | integer | |
assets.[].content.attachment.[].thumbnail_width | integer | |
assets.[].content.attachment.[].provider_name | string | |
assets.[].content.attachment.[].provider_url | string | |
assets.[].content.attachment.[].author_name | string | |
assets.[].content.attachment.[].author_url | object | |
assets.[].content.attachment.[].author_url.href | string | |
assets.[].content.content | string | The text content. |
assets.[].content.generator | object | The service or system where the content was originally published (e.g. twitter.com for tweets). |
assets.[].content.generator.id | string | The Livefyre generator ID. Commonly used generators are:
|
assets.[].content.attributedTo | object | |
assets.[].content.attributedTo.id | string | |
assets.[].content.attributedTo.username | string | |
assets.[].content.attributedTo.url | object | |
assets.[].content.attributedTo.url.href | string | |
assets.[].content.attributedTo.displayName | string | |
assets.[].content.attributedTo.icon | object | |
assets.[].content.attributedTo.icon.url | object | |
assets.[].content.attributedTo.icon.url.href | string | |
assets.[].content.twitter | object | Twitter-specific content. |
assets.[].content.twitter.retweets | integer | Count of retweets. |
assets.[].content.twitter.favorites | integer | Count of favorites. |
assets.[].safe_tags | array | SAFE content analysis tags. |
assets.[].safe_tags.[] | string | |
paging | object | |
paging.prev | string | Used in paging when sorting descending. Should be used in the since parameter in the next request. |
paging.hasPrev | boolean | Used in paging when sorting descending. True if there is more content. |
paging.next | string | Used in paging when sorting ascending. Should be used in the until parameter in the next request. |
paging.hasNext | boolean | Used in paging when sorting ascending. True if there is more content. |
paging.total | integer | Total items matching the search. |
paging.totalItems | integer | Alias for total. Deprecated. |
{
"assets": [
{
"library": {
"id": "example.fyre.co"
},
"createdAt": "2016-01-15T01:47:47.660Z",
"updatedAt": "2016-01-15T01:47:47.660Z",
"folders": [],
"content": {
"published": "2016-01-15T01:47:35.000Z",
"content": "Asset Manager is great! <a target=\"_blank\" href=\"https://t.co/T3hYROVul2\" title=\"\" rel=\"nofollow\">t.co/T3hYROVul2</a>",
"attributedTo": {
"id": "435430712",
"displayName": "Jonathan Klaassen",
"username": "jaklaassen",
"description": "",
"location": "",
"url": {
"href": "https://twitter.com/jaklaassen"
},
"icon": {
"displayName": "jaklaassen",
"url": {
"href": "https://pbs.twimg.com/profile_images/572868817777197056/AuKGdis0_normal.jpeg"
}
}
},
"attachment": [
{
"thumbnail_height": 150,
"link": {
"href": "http://twitter.com/jaklaassen/status/687813347992047623/photo/1"
},
"width": 300,
"author_url": {
"href": "http://twitter.com/jaklaassen"
},
"type": "photo",
"url": {
"href": "https://pbs.twimg.com/media/CYuamFyWcAAOo92.jpg:large"
},
"version": "1.0",
"title": "Jonathan Klaassen on Twitter",
"thumbnail_width": 150,
"thumbnail_url": {
"href": "https://pbs.twimg.com/media/CYuamFyWcAAOo92.jpg:thumb"
},
"height": 225,
"author_name": "jaklaassen",
"provider_url": {
"href": "http://twitter.com"
},
"provider_name": "Twitter"
}
],
"lang": "en",
"twitter": {
"retweets": 0,
"favorites": 0
},
"generator": {
"id": "twitter.com"
},
"id": "687813347992047623"
},
"id": "twitter.com.687813347992047623.example.fyre.co"
}
],
"paging": {
"hasPrev": true,
"total": 842045,
"totalItems": 842045
}
}
There was a validation error.
Invalid authentication
posthttp://{networkName}.admin.fyre.co/services/frontline/api/v4/assetManager//{network}/assetLibrary/{library}/assets
Add or update assets.
name | required | type | description |
---|---|---|---|
network | true | string | Livefyre Network ID. |
library | true | string | Livefyre Asset Library ID. Every network has a default Asset Library with the same ID as the network. |
Content-Type: application/json
property | type | description |
---|---|---|
add | array | Assets to add to the Asset Library. |
add.[] | object | |
add.[].id | string | The foreign ID of the content (e.g. Instagram's ID for Instagram content). |
add.[].generator | object | The service or system where the content was originally published (e.g. twitter.com for tweets). |
add.[].generator.id | string | The Livefyre generator ID. Commonly used generators are:
|
add.[].content | object | |
add.[].content.id | string | The foreign ID of the content (e.g. Instagram's ID for Instagram content). |
add.[].content.attachment | array | |
add.[].content.attachment.[] | object | An embeddable object, such as a video or photo. |
add.[].content.attachment.[].version | string | The oEmbed version number. This must be 1.0. |
add.[].content.attachment.[].type | string | The Oembed type. Valid values are:
|
add.[].content.attachment.[].link | object | |
add.[].content.attachment.[].link.href | string | |
add.[].content.attachment.[].url | object | The URL of the content. For photos, this should be embeddable in an |
add.[].content.attachment.[].url.href | string | |
add.[].content.attachment.[].html | string | The HTML required to display the resource. This may be a video player for video or arbitrary content for rich. |
add.[].content.attachment.[].thumbnail_url | object | |
add.[].content.attachment.[].thumbnail_url.href | string | |
add.[].content.attachment.[].height | integer | |
add.[].content.attachment.[].width | integer | |
add.[].content.attachment.[].thumbnail_height | integer | |
add.[].content.attachment.[].thumbnail_width | integer | |
add.[].content.attachment.[].provider_name | string | |
add.[].content.attachment.[].provider_url | string | |
add.[].content.attachment.[].author_name | string | |
add.[].content.attachment.[].author_url | object | |
add.[].content.attachment.[].author_url.href | string | |
add.[].content.content | string | The text content. |
add.[].content.generator | object | The service or system where the content was originally published (e.g. twitter.com for tweets). |
add.[].content.generator.id | string | The Livefyre generator ID. Commonly used generators are:
|
add.[].content.attributedTo | object | |
add.[].content.attributedTo.id | string | |
add.[].content.attributedTo.username | string | |
add.[].content.attributedTo.url | object | |
add.[].content.attributedTo.url.href | string | |
add.[].content.attributedTo.displayName | string | |
add.[].content.attributedTo.icon | object | |
add.[].content.attributedTo.icon.url | object | |
add.[].content.attributedTo.icon.url.href | string | |
add.[].content.twitter | object | Twitter-specific content. |
add.[].content.twitter.retweets | integer | Count of retweets. |
add.[].content.twitter.favorites | integer | Count of favorites. |
add.[].folders | array | A list of Asset Folders to add the Asset to. |
add.[].folders.[] | string | |
remove | array | IDs of Assets to remove from the Asset Library. |
remove.[] | string |
Successful search.
property | type | description |
---|---|---|
added | array | The added Assets. |
added.[] | object | |
added.[].id | string | The Asset ID. |
added.[].library | object | The Asset Library the Asset belongs to. |
added.[].library.id | string | |
added.[].createdAt | string | The time the content was originally published, as an ISO 8601 string. |
added.[].updatedAt | string | The time the content was updated, as an ISO 8601 string. |
added.[].folders | array | |
added.[].folders.[] | object | |
added.[].folders.[].id | string | |
added.[].folders.[].path | string | Slash-delimited location of the folder in the hierarchy. Path elements are folder IDs. |
added.[].folders.[].label | string | |
added.[].folders.[].inherit | boolean | True if this folder inherits the parent folders permissions. |
added.[].folders.[].deleted | boolean | True if the folder is deleted. Deleted folders are not included in search results. |
added.[].content | object | |
added.[].content.id | string | The foreign ID of the content (e.g. Instagram's ID for Instagram content). |
added.[].content.attachment | array | |
added.[].content.attachment.[] | object | An embeddable object, such as a video or photo. |
added.[].content.attachment.[].version | string | The oEmbed version number. This must be 1.0. |
added.[].content.attachment.[].type | string | The Oembed type. Valid values are:
|
added.[].content.attachment.[].link | object | |
added.[].content.attachment.[].link.href | string | |
added.[].content.attachment.[].url | object | The URL of the content. For photos, this should be embeddable in an |
added.[].content.attachment.[].url.href | string | |
added.[].content.attachment.[].html | string | The HTML required to display the resource. This may be a video player for video or arbitrary content for rich. |
added.[].content.attachment.[].thumbnail_url | object | |
added.[].content.attachment.[].thumbnail_url.href | string | |
added.[].content.attachment.[].height | integer | |
added.[].content.attachment.[].width | integer | |
added.[].content.attachment.[].thumbnail_height | integer | |
added.[].content.attachment.[].thumbnail_width | integer | |
added.[].content.attachment.[].provider_name | string | |
added.[].content.attachment.[].provider_url | string | |
added.[].content.attachment.[].author_name | string | |
added.[].content.attachment.[].author_url | object | |
added.[].content.attachment.[].author_url.href | string | |
added.[].content.content | string | The text content. |
added.[].content.generator | object | The service or system where the content was originally published (e.g. twitter.com for tweets). |
added.[].content.generator.id | string | The Livefyre generator ID. Commonly used generators are:
|
added.[].content.attributedTo | object | |
added.[].content.attributedTo.id | string | |
added.[].content.attributedTo.username | string | |
added.[].content.attributedTo.url | object | |
added.[].content.attributedTo.url.href | string | |
added.[].content.attributedTo.displayName | string | |
added.[].content.attributedTo.icon | object | |
added.[].content.attributedTo.icon.url | object | |
added.[].content.attributedTo.icon.url.href | string | |
added.[].content.twitter | object | Twitter-specific content. |
added.[].content.twitter.retweets | integer | Count of retweets. |
added.[].content.twitter.favorites | integer | Count of favorites. |
added.[].safe_tags | array | SAFE content analysis tags. |
added.[].safe_tags.[] | string | |
removed | array | IDs of the removed Assets. |
removed.[] | string |
There was a validation error.
Invalid authentication
gethttp://{networkName}.admin.fyre.co/services/frontline/api/v4/assetManager//{network}/assetLibrary/{library}/asset/{asset}
Get an asset
name | required | type | description |
---|---|---|---|
network | true | string | Livefyre Network ID. |
library | true | string | Livefyre Asset Library ID. Every network has a default Asset Library with the same ID as the network. |
asset | true | string | The Asset ID. |
Success
property | type | description |
---|---|---|
id | string | The Asset ID. |
library | object | The Asset Library the Asset belongs to. |
library.id | string | |
createdAt | string | The time the content was originally published, as an ISO 8601 string. |
updatedAt | string | The time the content was updated, as an ISO 8601 string. |
folders | array | |
folders.[] | object | |
folders.[].id | string | |
folders.[].path | string | Slash-delimited location of the folder in the hierarchy. Path elements are folder IDs. |
folders.[].label | string | |
folders.[].inherit | boolean | True if this folder inherits the parent folders permissions. |
folders.[].deleted | boolean | True if the folder is deleted. Deleted folders are not included in search results. |
content | object | |
content.id | string | The foreign ID of the content (e.g. Instagram's ID for Instagram content). |
content.attachment | array | |
content.attachment.[] | object | An embeddable object, such as a video or photo. |
content.attachment.[].version | string | The oEmbed version number. This must be 1.0. |
content.attachment.[].type | string | The Oembed type. Valid values are:
|
content.attachment.[].link | object | |
content.attachment.[].link.href | string | |
content.attachment.[].url | object | The URL of the content. For photos, this should be embeddable in an |
content.attachment.[].url.href | string | |
content.attachment.[].html | string | The HTML required to display the resource. This may be a video player for video or arbitrary content for rich. |
content.attachment.[].thumbnail_url | object | |
content.attachment.[].thumbnail_url.href | string | |
content.attachment.[].height | integer | |
content.attachment.[].width | integer | |
content.attachment.[].thumbnail_height | integer | |
content.attachment.[].thumbnail_width | integer | |
content.attachment.[].provider_name | string | |
content.attachment.[].provider_url | string | |
content.attachment.[].author_name | string | |
content.attachment.[].author_url | object | |
content.attachment.[].author_url.href | string | |
content.content | string | The text content. |
content.generator | object | The service or system where the content was originally published (e.g. twitter.com for tweets). |
content.generator.id | string | The Livefyre generator ID. Commonly used generators are:
|
content.attributedTo | object | |
content.attributedTo.id | string | |
content.attributedTo.username | string | |
content.attributedTo.url | object | |
content.attributedTo.url.href | string | |
content.attributedTo.displayName | string | |
content.attributedTo.icon | object | |
content.attributedTo.icon.url | object | |
content.attributedTo.icon.url.href | string | |
content.twitter | object | Twitter-specific content. |
content.twitter.retweets | integer | Count of retweets. |
content.twitter.favorites | integer | Count of favorites. |
safe_tags | array | SAFE content analysis tags. |
safe_tags.[] | string |
{
"library": {
"id": "example.fyre.co"
},
"createdAt": "2016-01-15T01:47:47.660Z",
"updatedAt": "2016-01-15T01:47:47.660Z",
"folders": [],
"content": {
"published": "2016-01-15T01:47:35.000Z",
"content": "Asset Manager is great! <a target=\"_blank\" href=\"https://t.co/T3hYROVul2\" title=\"\" rel=\"nofollow\">t.co/T3hYROVul2</a>",
"attributedTo": {
"id": "435430712",
"displayName": "Jonathan Klaassen",
"username": "jaklaassen",
"description": "",
"location": "",
"url": {
"href": "https://twitter.com/jaklaassen"
},
"icon": {
"displayName": "jaklaassen",
"url": {
"href": "https://pbs.twimg.com/profile_images/572868817777197056/AuKGdis0_normal.jpeg"
}
}
},
"attachment": [
{
"thumbnail_height": 150,
"link": {
"href": "http://twitter.com/jaklaassen/status/687813347992047623/photo/1"
},
"width": 300,
"author_url": {
"href": "http://twitter.com/jaklaassen"
},
"type": "photo",
"url": {
"href": "https://pbs.twimg.com/media/CYuamFyWcAAOo92.jpg:large"
},
"version": "1.0",
"title": "Jonathan Klaassen on Twitter",
"thumbnail_width": 150,
"thumbnail_url": {
"href": "https://pbs.twimg.com/media/CYuamFyWcAAOo92.jpg:thumb"
},
"height": 225,
"author_name": "jaklaassen",
"provider_url": {
"href": "http://twitter.com"
},
"provider_name": "Twitter"
}
],
"lang": "en",
"twitter": {
"retweets": 0,
"favorites": 0
},
"generator": {
"id": "twitter.com"
},
"id": "687813347992047623"
},
"id": "twitter.com.687813347992047623.example.fyre.co"
}
There was a validation error.
Invalid authentication
gethttp://{networkName}.admin.fyre.co/services/frontline/api/v4/assetManager//{network}/assetLibrary/{library}/folders
name | required | type | description |
---|---|---|---|
network | true | string | Livefyre Network ID. |
library | true | string | Livefyre Asset Library ID. Every network has a default Asset Library with the same ID as the network. |
name | required | type | description |
---|---|---|---|
id | false | array | Filter Asset by ID. |
path | false | array | Filter Asset Folders by parent path(s). Defaults to '/', which returns top-level folders. |
limit | false | integer | Number of Assets to return per batch. Default is 50. |
since | false | string | Used for paging. Pass this value into the since parameter in the request to get the next batch of values when sorting ascending. |
until | false | string | Used for paging. Pass this value into the since parameter in the request to get the next batch of values when sorting descending. |
Success
property | type | description |
---|---|---|
folders | array | |
folders.[] | object | |
folders.[].id | string | |
folders.[].path | string | Slash-delimited location of the folder in the hierarchy. Path elements are folder IDs. |
folders.[].label | string | |
folders.[].children | array | An array of child Asset Folder IDs. |
folders.[].children.[] | string | |
folders.[].inherit | boolean | True if this folder inherits the parent folders permissions. |
folders.[].deleted | boolean | True if the folder is deleted. Deleted folders are not included in search results. |
{
"folders": [
{
"id": "1",
"children": [
"2",
"3"
],
"label": "My Folder",
"path": "/",
"inherit": false
}
]
}
There was a validation error.
Invalid authentication
posthttp://{networkName}.admin.fyre.co/services/frontline/api/v4/assetManager//{network}/assetLibrary/{library}/folders
Create, update or delete Asset Folders.
name | required | type | description |
---|---|---|---|
network | true | string | Livefyre Network ID. |
library | true | string | Livefyre Asset Library ID. Every network has a default Asset Library with the same ID as the network. |
Content-Type: application/json
Success
property | type | description |
---|---|---|
folders | array | The affected folders. |
folders.[] | object | |
folders.[].id | string | |
folders.[].path | string | Slash-delimited location of the folder in the hierarchy. Path elements are folder IDs. |
folders.[].label | string | |
folders.[].inherit | boolean | True if this folder inherits the parent folders permissions. |
folders.[].deleted | boolean | True if the folder is deleted. Deleted folders are not included in search results. |
There was a validation error.
Invalid authentication
gethttp://{networkName}.admin.fyre.co/services/frontline/api/v4/assetManager//{network}/assetLibrary/{library}/folder/{folder}
Get an Asset Folder.
name | required | type | description |
---|---|---|---|
network | true | string | Livefyre Network ID. |
library | true | string | Livefyre Asset Library ID. Every network has a default Asset Library with the same ID as the network. |
folder | true | string | Folder ID. |
Success
property | type | description |
---|---|---|
folder | object | |
folder.id | string | |
folder.path | string | Slash-delimited location of the folder in the hierarchy. Path elements are folder IDs. |
folder.label | string | |
folder.children | array | An array of child Asset Folder IDs. |
folder.children.[] | string | |
folder.inherit | boolean | True if this folder inherits the parent folders permissions. |
folder.deleted | boolean | True if the folder is deleted. Deleted folders are not included in search results. |
{
"folder": {
"id": "1",
"children": [
"2",
"3"
],
"label": "My Folder",
"path": "/",
"inherit": false
}
}
There was a validation error.
Invalid authentication
gethttp://{networkName}.admin.fyre.co/services/frontline/api/v4/assetManager//{network}/assetLibrary/{library}/folder/{folder}/permissions
List Permissions for an AssetFolder.
name | required | type | description |
---|---|---|---|
network | true | string | Livefyre Network ID. |
library | true | string | Livefyre Asset Library ID. Every network has a default Asset Library with the same ID as the network. |
folder | true | string | Folder ID. |
Success
property | type | description |
---|---|---|
permissions | array | |
permissions.[] | object | Describes a grant of authorization for some subjects to perform some action on some resource or resource group |
permissions.[].id | string | |
permissions.[].rType | string | Resource Type |
permissions.[].operation | string | |
permissions.[].rId | string | Resource ID Pattern to which the permission applies |
permissions.[].role | object | |
permissions.[].group | stringnull | |
permissions.[].user | object |
{
"permissions": [
{
"id": "1",
"rId": "urn:livefyre:example.fyre.co:assetLibrary=example.fyre.co:assetFolder=1",
"rType": "assetFolder",
"operation": "view",
"role": {
"id": "asset_folder_owner",
"name": "Asset Folder Owner"
},
"group": null,
"user": {
"id": "urn:livefyre:exmaple.fyre.co:user=system",
"name": "System User"
}
}
]
}
There was a validation error.
Invalid authentication
posthttp://{networkName}.admin.fyre.co/services/frontline/api/v4/assetManager//{network}/assetLibrary/{library}/folder/{folder}/permissions
Add or remove Permissions for an AssetFolder.
name | required | type | description |
---|---|---|---|
network | true | string | Livefyre Network ID. |
library | true | string | Livefyre Asset Library ID. Every network has a default Asset Library with the same ID as the network. |
folder | true | string | Folder ID. |
Content-Type: application/json
property | type | description |
---|---|---|
create | array | |
create.[] | object | Describes a grant of authorization for some subjects to perform some action on some resource or resource group |
create.[].id | string | |
create.[].rType | string | Resource Type |
create.[].operation | string | |
create.[].rId | string | Resource ID Pattern to which the permission applies |
create.[].role | object | |
create.[].group | stringnull | |
create.[].user | object | |
remove | array | |
remove.[] | object | Describes a grant of authorization for some subjects to perform some action on some resource or resource group |
remove.[].id | string | |
remove.[].rType | string | Resource Type |
remove.[].operation | string | |
remove.[].rId | string | Resource ID Pattern to which the permission applies |
remove.[].role | object | |
remove.[].group | stringnull | |
remove.[].user | object |
Success
There was a validation error.
Invalid authentication
posthttp://{networkName}.admin.fyre.co/services/frontline/api/v4/assetManager//{network}/assetLibrary/{library}/folder/{folder}/assets
Add or remove Assets from an Asset Folder
name | required | type | description |
---|---|---|---|
network | true | string | Livefyre Network ID. |
library | true | string | Livefyre Asset Library ID. Every network has a default Asset Library with the same ID as the network. |
folder | true | string | Folder ID. |
Content-Type: application/json
property | type | description |
---|---|---|
assign | array | Asset IDs to add to the Folder. |
assign.[] | string | |
remove | array | Asset IDs to remove from the Folder. |
remove.[] | string |
Success
property | type | description |
---|---|---|
assign | array | |
assign.[] | object | |
assign.[].id | string | The Asset ID that was modified |
assign.[].status | integer | The HTTP status code for this update. 200 is success. |
remove | array | |
remove.[] | object | |
remove.[].id | string | The Asset ID that was modified |
remove.[].status | integer | The HTTP status code for this update. 200 is success. |
{
"assign": [
{
"id": "1",
"status": 200
}
]
}
There was a validation error.
Invalid authentication
gethttp://{networkName}.admin.fyre.co/services/frontline/api/v4/assetManager//{network}/assetLibrary/{library}/attributes
Search for attributes that have been assigned to Assets in the Library.
name | required | type | description |
---|---|---|---|
network | true | string | Livefyre Network ID. |
library | true | string | Livefyre Asset Library ID. Every network has a default Asset Library with the same ID as the network. |
name | required | type | description |
---|---|---|---|
key | true | string | The key to retrieve Attributes for. |
Successful search.
property | type | description |
---|---|---|
attributes | array | |
attributes.[] | object | |
attributes.[].key | string | The type of the attribute. |
attributes.[].value | string | The value of the attribute. |
{
"attributes": [
{
"key": "tag",
"value": "photo"
}
]
}
There was a validation error.
Invalid authentication
posthttp://{networkName}.admin.fyre.co/services/frontline/api/v4/assetManager//{network}/assetLibrary/{library}/attributes
Add or remove Attributes from Assets.
name | required | type | description |
---|---|---|---|
network | true | string | Livefyre Network ID. |
library | true | string | Livefyre Asset Library ID. Every network has a default Asset Library with the same ID as the network. |
Content-Type: application/json
property | type | description |
---|---|---|
assets | array | IDs of the Assets to modify. |
assets.[] | string | |
add | array | Add this Attribute. |
add.[] | object | |
add.[].key | string | The type of the attribute. |
add.[].value | string | The value of the attribute. |
set | array | Remove all Attributes with this key and add this Attribute. |
set.[] | object | |
set.[].key | string | The type of the attribute. |
set.[].value | string | The value of the attribute. |
remove | array | Remove this Attribute. |
remove.[] | object | |
remove.[].key | string | The type of the attribute. |
remove.[].value | string | The value of the attribute. |
Success.
property | type | description |
---|---|---|
result | array | HTTP status codes for each Asset in the request. 200 is success. |
result.[] | integer | |
assets | array | The modified Assets. |
assets.[] | object | |
assets.[].id | string | The Asset ID. |
assets.[].library | object | The Asset Library the Asset belongs to. |
assets.[].library.id | string | |
assets.[].createdAt | string | The time the content was originally published, as an ISO 8601 string. |
assets.[].updatedAt | string | The time the content was updated, as an ISO 8601 string. |
assets.[].folders | array | |
assets.[].folders.[] | object | |
assets.[].folders.[].id | string | |
assets.[].folders.[].path | string | Slash-delimited location of the folder in the hierarchy. Path elements are folder IDs. |
assets.[].folders.[].label | string | |
assets.[].folders.[].inherit | boolean | True if this folder inherits the parent folders permissions. |
assets.[].folders.[].deleted | boolean | True if the folder is deleted. Deleted folders are not included in search results. |
assets.[].content | object | |
assets.[].content.id | string | The foreign ID of the content (e.g. Instagram's ID for Instagram content). |
assets.[].content.attachment | array | |
assets.[].content.attachment.[] | object | An embeddable object, such as a video or photo. |
assets.[].content.attachment.[].version | string | The oEmbed version number. This must be 1.0. |
assets.[].content.attachment.[].type | string | The Oembed type. Valid values are:
|
assets.[].content.attachment.[].link | object | |
assets.[].content.attachment.[].link.href | string | |
assets.[].content.attachment.[].url | object | The URL of the content. For photos, this should be embeddable in an |
assets.[].content.attachment.[].url.href | string | |
assets.[].content.attachment.[].html | string | The HTML required to display the resource. This may be a video player for video or arbitrary content for rich. |
assets.[].content.attachment.[].thumbnail_url | object | |
assets.[].content.attachment.[].thumbnail_url.href | string | |
assets.[].content.attachment.[].height | integer | |
assets.[].content.attachment.[].width | integer | |
assets.[].content.attachment.[].thumbnail_height | integer | |
assets.[].content.attachment.[].thumbnail_width | integer | |
assets.[].content.attachment.[].provider_name | string | |
assets.[].content.attachment.[].provider_url | string | |
assets.[].content.attachment.[].author_name | string | |
assets.[].content.attachment.[].author_url | object | |
assets.[].content.attachment.[].author_url.href | string | |
assets.[].content.content | string | The text content. |
assets.[].content.generator | object | The service or system where the content was originally published (e.g. twitter.com for tweets). |
assets.[].content.generator.id | string | The Livefyre generator ID. Commonly used generators are:
|
assets.[].content.attributedTo | object | |
assets.[].content.attributedTo.id | string | |
assets.[].content.attributedTo.username | string | |
assets.[].content.attributedTo.url | object | |
assets.[].content.attributedTo.url.href | string | |
assets.[].content.attributedTo.displayName | string | |
assets.[].content.attributedTo.icon | object | |
assets.[].content.attributedTo.icon.url | object | |
assets.[].content.attributedTo.icon.url.href | string | |
assets.[].content.twitter | object | Twitter-specific content. |
assets.[].content.twitter.retweets | integer | Count of retweets. |
assets.[].content.twitter.favorites | integer | Count of favorites. |
assets.[].safe_tags | array | SAFE content analysis tags. |
assets.[].safe_tags.[] | string |
There was a validation error.
Invalid authentication