Recycle Bin API

Recycle Bin API

Introduction

This API allows you to manage the recycle bin.

Please note that this API is only meant for managing assets that are already in the recycle bin. If the recycle bin feature is enabled for a an Organizatino, deleting an asset via the Archive API will put the asset in the recycle bin instead of permanently deleting it.

Authentication

A suite user token obtained via the login API must be provided in the request headers as either a bearer token or by using the userToken header.

Bearer token: Authorization: Bearer <user-token>

User token: userToken <user-token>

Check if Recycle Bin is enabled

Checks whether the Recycle Bin feature is enabled for a given Organization.

Path

/api/recyclebin

Request

Method: GET
Parameters:

Name
Value
Requirement
Description
action
isRecycleBinEnabled
Mandatory

organizationId
Number
Mandatory
Icareus Suite Organization ID

Example

curl -i -H userToken\:\ <user-token> -XGET https\://suiterc.icareus.com/api/recyclebin\?action\=isRecycleBinEnabled\&organizationId\=2631609

https://suiterc.icareus.com/api/recyclebin?action=isRecycleBinEnabled&organizationId=2631609

Response

A successful response will have the HTTP Status code of 200, and failed requests will have a non-200 status code.

  1. {
  2.   "status": "ok",
  3.   "isRecycleBinEnabled": true
  4. }

Get Assets

List all assets in the recycle bin for a given Organization.

Path

/api/recyclebin

Request

Method: GET
Parameters:

Name
Value
Requirement
Description
action
getAssets
Mandatory

organizationId
Number
Mandatory
Icareus Suite Organization ID

Example

curl -i -H userToken\:\ <user-token> -XGET https\://suiterc.icareus.com/api/recyclebin\?action\=getAssets\&organizationId\=2631609

https://suiterc.icareus.com/api/recyclebin?action=getAssets&organizationId=2631609

Response

A successful response will have the HTTP Status code of 200, and failed requests will have a non-200 status code.

  1. {
  2.   "assets": [
  3.     {
  4.       "id": 11487501,
  5.       "title": "recycle bin test asset",
  6.       "imageUrl": "https://suiterc.icareus.com/image/image_gallery?img_id=11487702",
  7.       "deletedAt": "05.04.2023 11:19:19 (UTC)",
  8.       "deletedAt_ms": 1680693559000
  9.     }
  10.   ],
  11.   "status": "ok"
  12. }

Recover an asset from the Recycle Bin

This action allows you to fetch a list of all the assets currently in the Recycle Bin of the provided Organization.

Path

/api/recyclebin

Request

Method: GET
Parameters:

Name
Value
Requirement
Description
action
recoverAsset
Mandatory

organizationId
Number
Mandatory
Icareus Suite Organization ID
assetId
Number
Mandatory
ID of the Asset you wish to recover from the Recycle Bin.

Example

curl -i -H userToken\:\ <user-token> -XGET https\://suiterc.icareus.com/api/recyclebin\?action\=recoverAsset\&organizationId\=2631609\&assetId\=11487501

https://suiterc.icareus.com/api/recyclebin?action=recoverAsset&organizationId=2631609&assetId=11487501

Response

A successful response will have the HTTP Status code of 200, and failed requests will have a non-200 status code.

A successful response will include the asset as a JSON object along with the "status":"ok".

  1. {
  2.   "asset": {
  3.     "coverImageSmall": "",
  4.     "spokenLanguages": "",
  5.     "chapters": {
  6.     },
  7.     "ingress": {
  8.     },
  9.     "linkedAssets": {
  10.       "linkadAudioAssets": [],
  11.       "linkedImageAssets": [],
  12.       "linkedAssets": []
  13.     },
  14.     "episodeNumber": 0,
  15.     "releaseYear": 0,
  16.     "created": 1680599199000,
  17.     "description": {
  18.     },
  19.     "thumbnailMedium": "https://suiterc.icareus.com/image/image_gallery?img_id=11487702",
  20.     "userAccess": [],
  21.     "groups": "",
  22.     "programName": {
  23.     },
  24.     "coverImageLarge": "",
  25.     "productionCompany": "",
  26.     "isPublicContentRight": true,
  27.     "bannerImageLarge": "",
  28.     "isPodcastAsset": false,
  29.     "seasonNumber": 0,
  30.     "properties": "",
  31.     "isProtected": false,
  32.     "director": "",
  33.     "coverImageMedium": "",
  34.     "teams": [],
  35.     "podcasts": [],
  36.     "createdBy": 3931601,
  37.     "externalData": {
  38.       "data": "",
  39.       "label": "",
  40.       "url": ""
  41.     },
  42.     "ownership": "",
  43.     "bannerImageMedium": "",
  44.     "series": [],
  45.     "transcodingStatus": 1,
  46.     "accessControl": {
  47.     },
  48.     "contentLanguages": [],
  49.     "publishEnd": 2524608000000,
  50.     "folders": [],
  51.     "publishReady": true,
  52.     "contentTypes": [],
  53.     "date": 1680599160000,
  54.     "downloadable": false,
  55.     "publisher": "",
  56.     "id": 11487501,
  57.     "createdByName": "poopak papadopoulos",
  58.     "locations": [],
  59.     "thumbnailSmall": "https://suiterc.icareus.com/image/image_gallery?img_id=11487703",
  60.     "name": {
  61.       "en_US": "recycle bin test asset"
  62.     },
  63.     "actors": "",
  64.     "license": "",
  65.     "bannerImageSmall": "",
  66.     "tags": "",
  67.     "subtitles": [],
  68.     "presets": [
  69.       {
  70.         "fileId": 11487504,
  71.         "presetId": 0,
  72.         "description": "master",
  73.         "name": "master",
  74.         "dlUrl": "https://suiterc.icareus.com/s3files/10154/2631617/1035701.mp4/1.0.mp4",
  75.         "url": ""
  76.       },
  77.       {
  78.         "fileId": 11487803,
  79.         "presetId": 1447301,
  80.         "description": "Audio 96K mp3",
  81.         "name": "Audio 96K mp3",
  82.         "dlUrl": "https://suiterc.icareus.com/s3files/10154/2631617/1035801.mp3/1.0.mp3",
  83.         "url": ""
  84.       },
  85.       {
  86.         "fileId": 11488103,
  87.         "presetId": 3204101,
  88.         "description": "Fallback (Master size and bitrate)",
  89.         "name": "Fallback (Master size and bitrate)",
  90.         "dlUrl": "https://suiterc.icareus.com/s3files/10154/2631617/1035901.mp4/1.0.mp4",
  91.         "url": ""
  92.       }
  93.     ],
  94.     "contentRatings": [],
  95.     "pages": [],
  96.     "isPublic": false,
  97.     "duration": 60,
  98.     "thumbnailLarge": "https://suiterc.icareus.com/image/image_gallery?img_id=11487701",
  99.     "groupItemIds": ""
  100.   },
  101.   "status": "ok"
  102. }

Permanently delete an asset from the Recycle Bin

This action allows you to permanently delete an asset from the Recycle Bin.

Path

/api/recyclebin

Request

Method: GET
Parameters:

Name
Value
Requirement
Description
action
deleteAsset
Mandatory

organizationId
Number
Mandatory
Icareus Suite Organization ID
assetId
Number
Mandatory
ID of the Asset you wish to delete from the Recycle Bin.

Example

curl -i -H userToken\:\ <user-token> -XGET https\://suiterc.icareus.com/api/recyclebin\?action\=deleteAsset\&organizationId\=2631609\&assetId\=11371501

https://suiterc.icareus.com/api/recyclebin?action=deleteAsset&organizationId=2631609&assetId=11371501

Response

A successful response will have the HTTP Status code of 200, and failed requests will have a non-200 status code.

  1. {
  2.   "message": "asset-permanently-deleted",
  3.   "assetId": 11371501,
  4.   "status": "ok"
  5. }

Empty the Recycle Bin

This action will permanently delete all assets from the Recycle Bin.

Path

/api/recyclebin

Request

Method: GET
Parameters:

Name
Value
Requirement
Description
action
emptyRecycleBin
Mandatory

organizationId
Number
Mandatory
Icareus Suite Organization ID

Example

curl -i -H userToken\:\ <user-token> -XGET https\://suiterc.icareus.com/api/recyclebin\?action\=emptyRecycleBin\&organizationId\=2631609

https://suiterc.icareus.com/api/recyclebin?action=emptyRecycleBin&organizationId=2631609

Response

A successful response will have the HTTP Status code of 200, and failed requests will have a non-200 status code.

  1. {
  2.   "message": "assets-deleted",
  3.   "status": "ok"
  4. }






    

    • Related Articles
      • 

    • Managing Videos
      Introduction VIdeos are the core of Icareus Suite. The management of videos is described in this chapter. Managing Video Assets Add New Videos to Cloud Icareus offers four (4) ways to add content on the platform: Manually via Icareus Suite web user ...
      • 

    • Recycle Bin
      Introduction Recycle Bin is used to view deleted Video Assets. When Video is deleted it is moved to Recycle Bin and stays there until it is permanently deleted. Recycle Bin is calculated to your storage quota Restoring Assets Assets in recycle bin ...
      • 

    • Teams API
      INTRODUCTION Teams API allows creating and editing Teams. AUTHENTICATION A suite user token obtained via the login API must be provided in the request headers as a bearer token. Authorization: Bearer <user-token> GET TEAMS Provides a way to get a ...
      • 

    • Analytics API (ENG)
      INTRODUCTION This API stores video access/usage statistics for the linear channels and vod items. API PATH /api/analytics API METHODS ADDING NEW RECORD Adds a new analytics record of either on-demand video usage or linear channel viewing statistics ...
      • 

    • OEMBED API (ENG)
      INTRODUCTION This API is used to query for oEmbed objects for video page URL(s) on Icareus Suite sites. Note Suite oEmbed API only supports JSON responses for now API PATH /api/oembed API GET OEMBED OBJECT REQUEST /api/oembed Parameters: Name Value ...
      •