API Reference

Base calls for managing assets

You can use the following base calls to perform CRUD actions on assets (database objects). The sections below list a base call for common asset types. DataTable APIs can be POST or GET.

The Default subtype refers to the built-in default subtype for each asset type. For example, Documents.Image.Default refers to the Standard Image subtype, and Documents.Audio.Default refers to the Standard Audio subtype.

Therefore, the following call updates the title of the Standard Image with a unique identifier of ZZ13UH3:

POST or GET /API/DataTable/v2.2/Documents.Image.default:Update?CoreField.Identifier=ZZ13UH3&CoreField.Title:=Tower Bridge

You can modify any call to point to a custom Asset Subtype. For example, if you know the asset belongs to a custom “Event Photo” image subtype, you can update your base call to /API/DataTable/v2.2/Documents.Image.Event-Photo where Documents.Image.Event-Photo is the subtype’s API name. You can retrieve a subtype’s API name from the List all database objects API or the subtype settings in the Orange Logic interface.

Audio

/API/DataTable/v2.2/Documents.Audio.Default

Folders

/API/DataTable/v2.2/Documents.Folder.Default

Images

/API/DataTable/v2.2/Documents.Image.Default

Multimedia

(These are assets that belong to the “Other” asset type.)

/API/DataTable/v2.2/Documents.Multimedia.Default

Videos

/API/DataTable/v2.2/Documents.Video.Default

Virtual folders

/API/DataTable/v2.2/Documents.Virtual-folder.Default

Search all assets

If you are searching for an asset and do not know the asset type that it belongs to, you can use the Documents.All query.

/API/DataTable/v2.2/Documents.All

For example, the following call updates the title of the asset with the unique identifier of CTL898538.

POST or GET /API/DataTable/v2.2/Documents.All:Update?CoreField.Identifier=CTL898538&CoreField.Title:=View of the tower bridge

By default, if you use the Documents.All query, you can only use one of the following fields to retrieve a record:

  • RecordID
  • Unique identifier (CoreField.Identifier)
  • Original file name (CoreField.OriginalFileName)
  • Other number (CoreField.OtherNum) (This field can be used to add existing IDs to a record.)

The read, update, and delete operations only work if only one asset matches the search criterion.

If you want to add another field to the list of accepted Documents.All queries, your Orange Logic administrator can submit a support request and include this ID in the description: 22M0ZH.

You must have the Asset (Read Only) Security Function to use the Documents.All query.

❗

Warning

The Asset (Read Only) Security Function provides access to all assets and bypasses all permissions, restrictions, embargo dates, etc.