sams.api.produce – Production API

sams.api.produce.assets – Assets

The Assets Admin API allows to create, update or delete Assets.

This service and resource is intended to be used by external clients. To access Assets inside the SAMS application, use the sams.assets module instead

Asset Resource

endpoint name

‘produce/assets’

resource title

‘Asset’

resource url

[POST] ‘/produce/assets’

item url

[PATCH, DELETE] ‘/produce/assets/<ObjectId>’

schema

sams_client.schemas.assets.IAsset

Lock Asset

endpoint name

‘produce/assets/lock’

resource title

‘Lock Asset’

item url

[PATCH] ‘/produce/assets/lock/<ObjectId>’

Unlock Asset

endpoint name

‘produce/assets/unlock’

resource title

‘Unlock Asset’

item url

[PATCH] ‘/produce/assets/unlock/<ObjectId>’

Unlock Assets by User Session

endpoint name

‘produce/assets/unlock_user_session’

resource title

‘Unlock Asset by Session’

item url

[PATCH] ‘/produce/assets/unlock_user_session’

url args

  • external_user_id: <str>

  • external_session_id: <str>

Generate Rendition for Image Asset

endpoint name

‘produce/assets/images’

resource title

‘Generate Image Rendition’

item url

[POST] ‘/produce/assets/images/<ObjectId>’

url args

  • str: width [optional*]

  • str: height [optional*]

  • bool: keep_proportions [optional]

[*] Must supply at least a width and/or height in the url arguments