The function ASSET_STATE takes a Detailed Asset and returns the state of the Asset.

This function takes a Detailed Asset as input. It returns a String containing the state of the Asset: "DRAFT", "PENDING", or "ACTIVE".


ASSET_STATE(detailed_asset) -> state



detailed_asset (required, type: Detailed Asset)
Any Detailed Asset.
Note that a Detailed Asset is a subcategory of an Asset, and that the ASSET_STATE function will not accept a general Asset as input, only a Detailed Asset.

Return Values

state(type: string)

The state of the Detailed Asset: "DRAFT", "PENDING", or "ACTIVE".

  • "DRAFT" means the Asset has been declared but hasn't been fully received yet.
  • "PENDING" is the state after the Asset has been fully received, but the server side processing is not yet finished.
  • "ACTIVE" is a fully queryable Asset.


Assume the example has access to the following Detailed Asset, detailed_asset:

detailed_asset -> {  
 "id": "9d65de10-e1d5-4439-93c1-70434bec96a0",  
 "assetKey": "dc3ea11e-a294-40db-b47d-d3891d850710",  
 "organizationId": "15a00ea3-6980-48ea-8e8c-651ddff1f0bf",  
 "displayName": "placekitten.jpeg",  
 "description": null,  
 "type": "image/jpeg",  
 "size": 6483,  
 "version": 0,  
 "expiration": 600000,  
 "visibility": "GLOBAL",  
 "state": "ACTIVE",  
 "scope": "APP",  
 "region": "us-west-2",  
 "createdTime": "2021-12-15T00:44:50.459Z",  
 "modifiedTime": "2021-12-15T00:44:52.076Z",  
 "deletedTime": null,  
 "validationErrors": null,  
 "extraInfo": null,  
 "downloadUrl": "",  
 "thumbnailUrl": ""  

The following example takes the Detailed Asset defined above and returns its state. Note that this matches the value of the state property given above:

ASSET_STATE(detailed_asset) -> "ACTIVE"