1. REST API Reference for Oracle Mobile Cloud Enterprise - Tooling APIs
  2. Tasks
  3. Backends

Retrieve Backend Collections

get

/mobile/tools/1.0/mobilebackends/{id}/collections

Returns an array of metadata about the storage collections that are associated with the backend. You can filter the results, page through the results, and specify a sort order.

Request

Supported Media Types
  • application/json
Path Parameters
id
Type: string
Required: true
The identifier of the backend.
Query Parameters
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
filterType
Type: string
Allowed Values: [NOT_PUBLISHED, PUBLISHED, NOT_TRASH, TRASH, MAX_EXCLUDE, MAX_INCLUDE, MAX_ONLY].

Filter collections 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 collections that are in the published state.
  • NOT_PUBLISHED returns all collections that aren't in the published state.
  • TRASH returns all collections that have the inTrash attribute set to true.
  • NOT_TRASH returns all collections that have the inTrash attribute set to false.
  • MAX_INCLUDE returns all collections including those that have the max attribute set to true.
  • MAX_EXCLUDE (the default) returns all collections except those that have the max attribute set to true.
  • MAX_ONLY returns only the collections 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
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`
q
Type: string
Performs a case-insensitive search for collections that have a name, display name, or description that contains the string that's provided in this parameter. For example, q=myCollection. 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 the storage collections' metadata with pagination information.
Body
An array of storage collection elements with paging information.
Root Schema : mosCollectionPaging
Type: object
An array of storage collection elements with paging information.
Nested Schema : paging
Type: object
The pagination information.
Nested Schema : mosCollectionPaging-allOf[1]
Nested Schema : paginationLinksArray
Type: array
Minimum Number of Items: 0
An array of links for paginated metadata.
Nested Schema : Link to the paginated metadata.
Type: object
Title: Link to the paginated metadata.
Nested Schema : mosCollectionArray
Type: array
Minimum Number of Items: 0
An array of the storage collections' metadata.
Nested Schema : mosCollectionGet
Type: object
The storage collection representation for GET requests.
Nested Schema : assetGet
Type: object
The asset representation for GET requests.
Nested Schema : mosCollectionGet-allOf[1]
Nested Schema : assetUpdate
Type: object
The asset representation for PUT requests.
Nested Schema : assetIdEtag
Type: object
The asset ID and entity tag (ETag) values.
Nested Schema : trash
Type: object
Indicator of whether the asset is in the trash.
Nested Schema : assetGet-allOf[3]
Nested Schema : entityLinksArray
Type: array
Minimum Number of Items: 0
An array of links for an entity's metadata.
Nested Schema : items
Type: object
Link to the entity's metadata.