Class Index

Classes


CheckOut

Check out an asset or cancel the check out of an asset
Defined in: checkOut.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
CheckOut(action, ids, resolver, verbose, fields)
This endpoint can check out assets so other users cannot modify them, and it can also cancel the check out of assets
Class Detail
CheckOut(action, ids, resolver, verbose, fields)
This endpoint can check out assets so other users cannot modify them, and it can also cancel the check out of assets
Parameters:
action Optional
either 'checkout' or 'cancel'. This action is applied to all assets defined by the ids array or the resolver.
ids Optional
The asset id's
resolver Optional
A resolver url
verbose Optional, Default: false
Setting this to true will collect a variety of default values for each asset.
fields Optional
An array of field id's to collect the values for each asset
Returns:
[{assetInfo}, ... ]
/wf/restapi/v2/checkOut

Parameters:
action=checkout
ids=[201629401]
fields=["http://mediabeacon.com/ns/default/1.0/ checkoutUser"]

Response:
 [
 {
    "id": 201629401,
    "fields": {
      "http://mediabeacon.com/ns/default/1.0/ checkoutUser": "john.doe"
    }
  }
 ]
/wf/restapi/v2/checkout

Parameters:
action=cancel
ids=[201629401]
fields=["http://mediabeacon.com/ns/default/1.0/ checkoutUser"]

Response:
 [
 {
    "id": 201629401,
    "fields": {
      "http://mediabeacon.com/ns/default/1.0/ checkoutUser": null
    }
  }
 ]

Documentation generated by JsDoc Toolkit 2.4.0 on Fri Dec 15 2023 01:44:01 GMT-0600 (CST)