Projects | Assets

Get project assets

Get project assets by asset IDs

get/api/Projects/Assets/GetAssets

Request

  • Base URL: https://api.omnium.no (the document declares no server; this is the origin it was published from)
  • URL: https://api.omnium.no/api/Projects/Assets/GetAssets
  • Auth: API key in header Authorization

Query parameters

assetIdsstring[] nullable

Response

Returning assets

parentIdstring nullable

Optional - ID of parent media or directory

assetIdstring nullable

Optional - ID of asset. If not provided, an id will be generated

assetTypestring nullable

Optional - Type of asset. Free text, except the built-in value "External": an external asset is link-only. It is never copied to Omnium storage, Url mirrors ExternalUrl, and the file is always served live from the external host so a change at the source shows on every product without re-import. Use it for files you do not want Omnium to download, such as certification marks shared by many products. External assets cannot be the main image, so do not point MainImageUrl at one. Changing an already uploaded asset to "External" switches Url to the external url and leaves the old copy in storage.

sortOrderinteger nullable

Optional - Item sort index. Default is position in list

urlstring nullable

Calculated: Omnium url. For "External" assets this is the ExternalUrl itself, since they are not copied to Omnium storage.

externalUrlstring nullable

External URL (original URL, will be uploaded and Omnium url will be added to Url). If FileName is not provided, externalUrl has to contain the file extension (e.g. .jpg). For "External" assets the url is kept as-is and never uploaded; use https, since an http image is blocked as mixed content in browsers.

fileNamestring nullable

Preferred file name, used when uploaded to Omnium. Required to contain the correct file extension. File name and path from external URL will be used as fallback if null.

isMainImageboolean

If true, asset will be used as main image on parent item

namestring nullable

Optional - Asset name

descriptionstring nullable

Optional - Asset description

altTextstring nullable

Optional - Image alternative text

purposestring nullable

Optional - Asset purpose or use

forceUploadboolean nullable

Force upload external url to Omnium (if both external and internal url exists)

fileLoaderTypestring nullable

Calculated - the service that serves the file, for assets that are not reachable through a plain url. Pass it as the serviceType to /api/Files/{serviceType}/Download, together with Url as the path, to download the file. Empty for assets stored in Omnium, which are downloaded from Url directly.

createdstring date-time

Date created

modifiedstring date-time

Date modified

contentTypestring nullable

Calculated - File type, e.g. image/jpg

lengthinteger

Calculated - File size in bytes

Changes

No recorded changes to this operation across all 1 revision of this API.