Retrieve Assets
/mobile/tools/1.0/assets
Request
- application/json
-
apiTypes(optional): string
A comma-delimited list of the type of APIs to return. Note that the only types of APIs that this operation returns are custom and connector APIs. If you don't provide this parameter, then all assets are returned.
Allowed values:
internal
: APIs that you can call from custom API implementations onlyexternal
: APIs that you can call from custom API implementations, mobile apps, and third-party toolscustom
: Custom APIsconnector
: Connector assets
Default Value:all
-
assetTypes(optional): string
A comma-delimited list of the types of assets to return. If this parameter isn't provided, then the operation returns all assets. Multiple values can be provided as comma-separated string. Allowed asset types: [ API | MobileBackend | Connector | APIImplementation | Client | StorageCollection | Package].
-
exclude(optional): array
Collection Format:
multi
Expression to exclude from the result the elements that have IDs in the list. Example:exclude=57165555-aa10-4838-938a-354c2b3a287sa&exclude=57165555-aa10-4838-938a-354c2b3a287s
-
filterType(optional): string
Allowed Values: [NOT_PUBLISHED, PUBLISHED, NOT_TRASH, TRASH, MAX_EXCLUDE, MAX_INCLUDE, MAX_ONLY].
Filter assets by the following filter types. You can provide multiple values as a comma-separated string. For example,
filterType=NOT_PUBLISHED,NOT_TRASH,MAX_ONLY
.PUBLISHED
returns all assets that are in the published state.NOT_PUBLISHED
returns all assets that aren't in the published state.TRASH
returns all assets that have theinTrash
attribute set totrue
.NOT_TRASH
returns all assets that have theinTrash
attribute set tofalse
.MAX_INCLUDE
returns all assets including those that have themax
attribute set totrue
.MAX_EXCLUDE
(the default) returns all assets except those that have themax
attribute set totrue
.MAX_ONLY
returns only the assets that have themax
attribute set totrue
.
-
fromTime(optional): string
Include only the assets that have been modified or deleted on or after the specified time. Example:
2016-03-03T15:13:39.419Z
.Filters by
modifiedOn
for assets that haven't been trashed and bydeletedOn
for trashed assests.Supported values:
- Number of milliseconds since January 1, 1970, 00:00:00 GMT
- Date in ISO 8601 format
- Relative value, such as -1s, -1m, and -1h
-
id(optional): array
Collection Format:
multi
Expression to return only the elements that have IDs in the list. Example:id=93079180-bb00-4838-938a-753c2b3a957a&id=57165555-aa10-4838-938a-354c2b3a287s
-
limit(optional): integer(int64)
The maximum number of items to return. If the total number of items to return is greater than the limit, then the response returns a link to get the next set of items.
-
offset(optional): integer(int64)
The index where you want to start browsing the list of items. If you don't specify an offset, then the offset defaults to 0, which is the first item in the list. The response contains the offset used and a link to get the previous set of items.
-
orderBy(optional): string
The sort order for the results. The default sort order is ascending by name. When you specify a sort order with pagination, the next and previous links respect the ordering. Multiple values can be provided as a comma-separated string. Format: `orderBy=attr[:("asc"|"desc")] [,attr[:("asc"|"desc")]]`, where the `attr` parameter can be one of [ name | version | modifiedOn | createdOn | deletedOn | deletedBy ]. Example: `orderBy=name:asc,modifiedOn:desc`Default Value:
name:asc
-
q(optional): string
Performs a case-insensitive search for assets that have a name, display name, or description that contains the string that's provided in this parameter. For example,
q=myApi
. This parameter doesn't support query languages. -
toTime(optional): string
Include only the assets that have been modified or deleted on or before the specified time. Example:
2016-03-03T15:13:39.419Z
.Filters by
modifiedOn
for assets that haven't been trashed and bydeletedOn
for trashed assests.Supported values:
- Number of milliseconds since January 1, 1970, 00:00:00 GMT
- Date in ISO 8601 format
- Relative value, such as -1s, -1m, and -1h
-
totalResults(optional): boolean
Reserved for enabling the total number of available elements in the response. This parameter is ignored because the total elements count always is available and is provided in the response.
-
Accept-Language(optional): string
Indicates the preferred set of natural languages to use for the response. The results are sorted based on the language. Example:
da, en-gb;q=0.8, en;q=0.7
.
Response
- application/json
200 Response
object
-
object paging
The pagination information.
-
object searchAssetPaging-allOf[1]
object
-
count:
integer(int64)
The number of elements in this response.
-
hasMore:
boolean
Indicates whether the collection has more elements to be retrieved.
-
limit(optional):
integer(int64)
The maximum number of items returned. If the total number of items to return is greater than the limit, then the response returns a link to get the next set of items.
-
links(optional):
array paginationLinksArray
Minimum Number of Items:
0
An array of links for paginated metadata. -
totalResults(optional):
integer(int64)
The total number of elements on the server side that satisfy the request. This attribute is returned only when the request includes the `totalResults` query parameter with a value of `true`.
array
0
-
Array of:
object Link to the paginated metadata.
Title:
Link to the paginated metadata.
object
Link to the paginated metadata.
-
href:
string
Link value.
-
rel:
Allowed Values:
[ "self", "canonical", "next", "prev", "first", "last" ]
Link type.
-
array searchAssetArray
Minimum Number of Items:
0
An array of asset elements as response data from the search.
array
0
-
Array of:
object searchAsset
The asset representation for search assets responses.
object
-
object assetGet
The asset representation for GET requests.
-
object searchAsset-allOf[1]
object
-
object assetUpdate
The asset representation for PUT requests.
-
object assetIdEtag
The asset ID and entity tag (ETag) values.
-
object trash
Indicator of whether the asset is in the trash.
-
object assetGet-allOf[3]
object
-
deployedBy(optional):
string
Not currently used.
-
deployedOn(optional):
string
Not currently used.
-
status(optional):
Allowed Values:
[ "ACTIVE", "INACTIVE" ]
object
-
actionComment(optional):
string
-
desc(optional):
string
Maximum Length:
100
-
max(optional):
boolean
Default Value:
false
-
name:
string
Maximum Length:
100
Pattern:^[a-zA-Z][a-zA-Z0-9_]*$
-
namespace(optional):
string
Applicable to APIs and implementations only. This value is null for all other asset types.
-
title(optional):
string
Maximum Length:
255
-
version(optional):
string
Maximum Length:
100
Pattern:^[a-zA-Z0-9][\w.]*$
Asset version.
object
-
etag(optional):
string
The asset entity tag (ETag) value, which you can use to detect concurrent modification.
-
id:
string
object
-
createdOn(optional):
string
-
deletedBy(optional):
string
-
deletedOn(optional):
string
-
links(optional):
array entityLinksArray
Minimum Number of Items:
0
An array of links for an entity's metadata. -
modifiedBy(optional):
string
-
modifiedOn(optional):
string
-
published(optional):
boolean
An asset draft or published status representation.
array
0
-
Array of:
object items
Link to the entity's metadata.
object
-
href:
string
Link value.
-
rel:
Allowed Values:
[ "self", "canonical" ]
Link type.