Class Index

Classes


CheckIn

Upload a new version of an asset into MediaBeacon
Defined in: checkIn.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
CheckIn(id, message, file, replaceName, replaceMetadata, verbose, fields)
Upload a new version of an asset into MediaBeacon
Class Detail
CheckIn(id, message, file, replaceName, replaceMetadata, verbose, fields)
Upload a new version of an asset into MediaBeacon
Parameters:
id
the id of the asset to upload a new version for
message
the message for the new version
file
the file needs to be added to the body of the POST in the form data with the name "file"
replaceName Optional, Default: false
replace the name of the asset with the attached files name?
replaceMetadata Optional, Default: false
replace the metadata with the metadata of the attached file?
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/checkIn

Parameters:
id=201629401
file={{FILE DATA IN POST BODY}}
verbose=true

Response:
 [
    {
		 "id": 201629401,
		 "name": "heic0006a_orig.tif",
		 "path": "upload/here/heic0006a_orig.tif",
		 "height": 746,
		 "width": 1500,
		 "bytes": 1459026,
		 "lastModified": 1508187662000,
		 "mimeType": "image/tiff",
		 "previews": {
			 "thumbnail": "../servlet/jb.view?table=thumbnails&col=thumbnails&id=pe_323031363239343031",
			 "viewex": "../servlet/jb.view?table=viewex&col=viewex&id=pe_323031363239343031",
			 "downloadUrl": "../servlet/dload?id=pe_323031363239343031"
		 }
	 }
 ]

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