Assets
Manage Assets
The tenant that the caller is acting upon.
Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$
The page number to be retrieved where the size of the pages must be specified by the pageSize
parameter. The number of the first page is 1.
1
The number of documents being retrieved on the page.
60
Fields to sort the response data by following the order of the parameters from left to right. Can contain multiple fields in the following format: field name:sort direction
, separated by a comma. The colon preceding the sort direction
parameter is optional, and the descending order is taken only if it is equal to desc
or DESC
. The ascending order is assumed in any other case.
name,metadata.createdAt:desc
A standard query parameter is used to search for specific values.
- Searching for items by string-based properties:
- By a field value:
q=access:PUBLIC
, whereaccess
is the field name, andPUBLIC
is its desired value.
- By a field value:
- Searching for items by a number-based property:
- With a specific value:
q=details.bytes:200
- With a value greater than:
q=details.bytes:>200
- With a value lower than:
q=details.bytes:<200
- With a value greater than or equal to:
q=details.bytes:>=200
- With a value lower than or equal to:
q=details.bytes:<=200
- With a value within a range of values:
q=details.bytes:(>=100 AND <=200)
, wheredetails.bytes
is the name of a number-based field, and200
is its querying value.
- With a specific value:
- Searching for items by a date-based property: All numer-based property queries are also valid for dates. In that case, the date should be placed within double quotes:
q=metadata.createdAt:(>="2021-05-18T07:27:27.455Z" AND <"2021-05-20T07:27:27.455Z")
- Searching for items with a nonexistent or empty property:
q=details.filename:null
, wheredetails.filename
is the field that has its value set tonull
. - Searching for items with an existing property:
q=details:exists
, wheredetails
is the field that has a non-empty value. - Searching for items by multiple specific values:
q=id:(5c3325baa9812100098ff48f,5c3325d1a9812100098ff494)
, whereid
is the field name, and strings within the brackets are the desired values. - Searching for items by multiple fields:
q=id:5c3325baa9812100098ff48f access:PUBLIC
, whereid
andaccess
are field names. All objects that contain the specified values are returned. Multiple fields (separated by spaces) can be specified. Multiple values for each field can also be specified in a format presented earlier. - Searching for items with string-based properties conforming to a regex:
q=id:~ABCD12
orq=id:(~AB CD)
- in the case of searching for strings with a space, whereid
is the name of the field andABCD12
orAB CD
are its querying regular expressions.
name:{name}
To get information how many entities meet the filtering requirements, the X-Total-Count
header has been introduced. The header is optional and its default value is false
. If the header is provided and it is set to true
, then the total count is returned in the X-Total-Count
response header. In both cases (X-Total-Count true
, false
or not provided), the response body has the same format (array of entities). This means that the information about the total count is returned only on demand, provided that the X-Total-Count header is present in a request.
false
GET /media/{tenant}/assets HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"id": "123e06ecf0452c2d6c0b81390",
"type": "BLOB",
"access": "PUBLIC",
"url": "https://api.emporix/tenant/id/download",
"details": {
"filename": "public.txt",
"mimeType": "text/plain"
},
"refIds": [
{
"id": "123e06ecf0452c2d6c0b81392",
"type": "CATEGORY"
}
],
"metadata": {
"createdAt": "2022-03-31T13:18:02.379Z",
"modifiedAt": "2022-03-31T13:18:02.379Z",
"version": 1
}
},
{
"id": "123e06ecf0452c2d6c0b81390",
"type": "LINK",
"access": "PUBLIC",
"url": "https://emporix.io/docs/index.html",
"metadata": {
"createdAt": "2022-03-31T13:18:02.379Z",
"modifiedAt": "2022-03-31T13:18:02.379Z",
"version": 1
},
"refIds": [
{
"id": "123e06ecf0452c2d6c0b81392",
"type": "CATEGORY"
}
]
}
]
Creates a new asset for the tenant. An asset represents a digital (max 10MB) object in the system, for example a video, image, or a document.
To create an asset of the
BLOB
type, use themultipart/form-data
request body.To create an asset of the
LINK
type, use theapplication/json
request body.
Required scopes
media.asset_manage
The tenant that the caller is acting upon.
Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$
Content of the file. The max file size is 10MB.
Asset Json creation payload
POST /media/{tenant}/assets HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 317
{
"file": {
"externalValue": "https://res.cloudinary.com/saas-ag/image/upload/v1695804155/emporix-logo-white-2f5e621206edefea6015fb4793959376_nswfbz.png"
},
"body": {
"type": "BLOB",
"access": "PUBLIC",
"refIds": [
{
"id": "123e06ecf0452c2d6c0b81392",
"type": "CATEGORY"
}
],
"details": {
"filename": "theBestImage",
"mimeType": "image/jpg"
}
}
}
{
"id": "53ac81fd0cce8b26b36f3492"
}
The tenant that the caller is acting upon.
Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$
Unique identifier of an asset.
GET /media/{tenant}/assets/{assetId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"id": "123e06ecf0452c2d6c0b81390",
"type": "LINK",
"access": "PUBLIC",
"url": "https://emporix.io/docs/index.html",
"refIds": [
{
"id": "123e06ecf0452c2d6c0b81392",
"type": "CATEGORY"
}
],
"metadata": {
"createdAt": "2022-03-31T13:18:02.379Z",
"modifiedAt": "2022-03-31T13:18:02.379Z",
"version": 1
}
}
The tenant that the caller is acting upon.
Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$
Unique identifier of an asset.
Content of the file.
Asset Json update payload
PUT /media/{tenant}/assets/{assetId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 342
{
"file": {
"externalValue": "https://res.cloudinary.com/saas-ag/image/upload/v1695804155/emporix-logo-white-2f5e621206edefea6015fb4793959376_nswfbz.png"
},
"body": {
"type": "BLOB",
"access": "PUBLIC",
"refIds": [
{
"id": "123e06ecf0452c2d6c0b81392",
"type": "CATEGORY"
}
],
"details": {
"filename": "theBestImage",
"mimeType": "image/jpg"
},
"metadata": {
"version": 1
}
}
}
No content
The tenant that the caller is acting upon.
Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$
Unique identifier of an asset.
DELETE /media/{tenant}/assets/{assetId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
The tenant that the caller is acting upon.
Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$
Unique identifier of an asset.
GET /media/{tenant}/assets/{assetId}/download HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Ynl0ZXM=
Was this helpful?