Logo Help Center

Elvis 4 REST API - checkout

Elvis 4 REST API - checkout

GET/POST

http://yourserver.com/services/checkout/<assetId>
    ?download=<true>

What does it do?

Checks out an asset from the system locking the file for other users.

Parameters

assetId

The Elvis id of the asset to be checked out.

Required

download

When set to true, the asset will be checked out and downloaded from the system. If download is false it will only be checked out.

Optional. Default is false.

Examples

Checkout

The following checks out an asset in Elvis

checkout

http://demo.elvisdam.com/services/checkout/FpERTjYia2X81GoYQi7btF

This will return the checkout metadata in the response:

{
  "checkedOut" : 1393923342735,
  "checkedOutBy" : "admin"
  "checkedOutOnClient" : "webclient"
}

Checkout with download

The following checks out an asset and downloads or shows it in the browser.

checkout

http://demo.elvisdam.com/services/checkout/FpERTjYia2X81GoYQi7btF?download=true
Was this article helpful?
0 out of 0 found this helpful / Created: / Updated:
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.