Retrieve Assets

get

/mobile/tools/1.0/assets

Returns an array of asset metadata. You can filter the results, page through the results, and specify a sort order. Note that the only types of APIs that this operation returns are custom and connector APIs.

• Request
• Response

Request

Supported Media Types

• application/json

Query Parameters

apiTypes

Type: 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 only
• external: APIs that you can call from custom API implementations, mobile apps, and third-party tools
• custom: Custom APIs
• connector: Connector assets

Default Value

all

assetTypes

Type: 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

Type: 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

Items

• Type: string

filterType

Type: 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 the inTrash attribute set to true.
• NOT_TRASH returns all assets that have the inTrash attribute set to false.
• MAX_INCLUDE returns all assets including those that have the max attribute set to true.
• MAX_EXCLUDE (the default) returns all assets except those that have the max attribute set to true.
• MAX_ONLY returns only the assets that have the max attribute set to true.

fromTime

Type: 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 by deletedOn 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

Type: 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

Items

• Type: string

limit

Type: 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

Type: 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

Type: 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

Type: 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

Type: 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 by deletedOn 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

Type: 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.

Header Parameters

Accept-Language

Type: 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

Supported Media Types

• application/json

200 Response

An array of asset metadata by asset type. Includes pagination information.

Body

An array of asset elements with paging information.

Root Schema : searchAssetPaging

Type: object

An array of asset elements with paging information.

Match All

• Type: object paging
  Additional Properties Allowed:
  The pagination information.
• Type: object searchAssetPaging-allOf[1]
  Additional Properties Allowed:

Nested Schema : paging

Type: object

The pagination information.

Properties

count

Type: integer (int64)

Required: true

The number of elements in this response.

hasMore

Type: boolean

Required: true

Indicates whether the collection has more elements to be retrieved.

limit

Type: 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

Type: array paginationLinksArray

Additional Properties Allowed:

Minimum Number of Items: 0

An array of links for paginated metadata.

totalResults

Type: 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`.

Nested Schema : searchAssetPaging-allOf[1]

Properties

items

Type: items

Additional Properties Allowed:

Nested Schema : paginationLinksArray

Type: array

Minimum Number of Items: 0

An array of links for paginated metadata.

Items

• Type: object Link to the paginated metadata.
  Title: Link to the paginated metadata.
  Additional Properties Allowed:

Nested Schema : Link to the paginated metadata.

Type: object

Title: Link to the paginated metadata.

Properties

href

Type: string

Required: true

Link value.

rel

Required: true

Allowed Values: [ "self", "canonical", "next", "prev", "first", "last" ]

Link type.

Nested Schema : items

Match All

• Type: array searchAssetArray
  Additional Properties Allowed:
  Minimum Number of Items: 0
  An array of asset elements as response data from the search.

Nested Schema : searchAssetArray

Type: array

Minimum Number of Items: 0

An array of asset elements as response data from the search.

Items

• Type: object searchAsset
  Additional Properties Allowed:
  The asset representation for search assets responses.

Nested Schema : searchAsset

Type: object

The asset representation for search assets responses.

Match All

• Type: object assetGet
  Additional Properties Allowed:
  The asset representation for GET requests.
• Type: object searchAsset-allOf[1]
  Additional Properties Allowed:

Nested Schema : assetGet

Type: object

The asset representation for GET requests.

Match All

• Type: object assetUpdate
  Additional Properties Allowed:
  The asset representation for PUT requests.
• Type: object assetIdEtag
  Additional Properties Allowed:
  The asset ID and entity tag (ETag) values.
• Type: object trash
  Additional Properties Allowed:
  Indicator of whether the asset is in the trash.
• Type: object assetGet-allOf[3]
  Additional Properties Allowed:

Nested Schema : searchAsset-allOf[1]

Properties

deployedBy

Type: string

Not currently used.

deployedOn

Type: string

Not currently used.

status

Allowed Values: [ "ACTIVE", "INACTIVE" ]

Nested Schema : assetUpdate

Type: object

The asset representation for PUT requests.

Properties

actionComment

Type: string

desc

Type: string

Maximum Length: 100

max

Type: boolean

Default Value: false

name

Type: string

Required: true

Maximum Length: 100

Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$

namespace

Type: string

Applicable to APIs and implementations only. This value is null for all other asset types.

title

Type: string

Maximum Length: 255

version

Type: string

Maximum Length: 100

Pattern: ^[a-zA-Z0-9][\w.]*$

Asset version.

Nested Schema : assetIdEtag

Type: object

The asset ID and entity tag (ETag) values.

Properties

etag

Type: string

The asset entity tag (ETag) value, which you can use to detect concurrent modification.

id

Type: string

Required: true

Nested Schema : trash

Type: object

Indicator of whether the asset is in the trash.

Properties

inTrash

Type: boolean

Nested Schema : assetGet-allOf[3]

Properties

createdOn

Type: string

deletedBy

Type: string

deletedOn

Type: string

links

Type: array entityLinksArray

Additional Properties Allowed:

Minimum Number of Items: 0

An array of links for an entity's metadata.

modifiedBy

Type: string

modifiedOn

Type: string

published

Type: boolean

An asset draft or published status representation.

Nested Schema : entityLinksArray

Type: array

Minimum Number of Items: 0

An array of links for an entity's metadata.

Items

• Type: object items
  Additional Properties Allowed:
  Link to the entity's metadata.

Nested Schema : items

Type: object

Link to the entity's metadata.

Properties

href

Type: string

Required: true

Link value.

rel

Required: true

Allowed Values: [ "self", "canonical" ]

Link type.