REST API Reference for Oracle Mobile Cloud Enterprise - Tooling APIs

Retrieve Backend APIs

get

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

Returns an array of metadata about the custom APIs 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

Items

Type: string

filterType

Type: string

Allowed Values: [NOT_PUBLISHED, PUBLISHED, NOT_TRASH, TRASH, ENTERPRISE, IDENTITYPROVIDER, BO_EXCLUDE, BO_INCLUDE, BO_ONLY].

Filter APIs by the following filter types. You can provide multiple values as a comma-separated string. For example, filterType=NOT_TRASH,ENTERPRISE.

IDENTITYPROVIDER returns all APIs that have the loginType attribute set to IDENTITYPROVIDER
ENTERPRISE returns all APIs that have the loginType attribute set to ENTERPRISE.
BO_INCLUDE (default) returns all APIs including those with the hasBusinessObjects attribute set to true.
BO_EXCLUDE returns all APIS except those that have the hasBusinessObjects attribute set to true.
BO_ONLY returns only APIs with the hasBusinessObjects attribute set to true.
TRASH returns all APIs that have the inTrash attribute set to true.
NOT_TRASH returns all APIs that have the inTrash attribute set to false.
PUBLISHED returns all APIs that are in the published state.
NOT_PUBLISHED returns all APIs that aren't in the published state.

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 ordering for the query operations. The default sort order is ascending by name. When you use ordering with paging, the next and previous links MUST respect the ordering. Multiple values may be provided as a comma-separated string. The format: orderBy=attr[:("asc"|"desc")] [,attr[:("asc"|"desc")]], where the attr parameter may contain any attribute of entity [ 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 APIs 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 API metadata with pagination information.

Body

An array of the APIs' metadata with paging information.

Root Schema : apiPaging

Type: object

An array of the APIs' metadata with paging information.

Match All

Type: object paging

Additional Properties Allowed:

The pagination information.
Type: object apiPaging-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 : apiPaging-allOf[1]

Properties

items: Type: array apiArray

Additional Properties Allowed:

Minimum Number of Items: 0

An array of metadata about the APIs.

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

Type: array

Minimum Number of Items: 0

An array of metadata about the APIs.

Items

Type: object apiShort

Additional Properties Allowed:

The short API definition representation.

Nested Schema : apiShort

Type: object

The short API definition representation.

Match All

Type: object assetGet

Additional Properties Allowed:

The asset representation for GET requests.
Type: object apiShort-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 : apiShort-allOf[1]

Properties

basePath: Type: string

The API base path in the format `/mobile/custom/{apiName}`.
hasBusinessObjects: Type: boolean

Default Value: false

Indicates whether the API is associated with API Express resources (business objects).
icon: Type: object icon

Additional Properties Allowed:

Information about the icon that's associated with the API or connector.

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.

Nested Schema : icon

Type: object

Information about the icon that's associated with the API or connector.

Properties

id: Type: string

Required: true
url: Type: string

Required: true