REST API Reference for Oracle Mobile Cloud Enterprise - Tooling APIs

Retrieve Implementations

get

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

Returns an array of custom API implementation metadata. 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 ID for the custom API implementation.

Query Parameters

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

Response

Supported Media Types

application/json

200 Response

An array of API implementations.

Body

An array of API implementation elements with paging information.

Root Schema : apiImplementationDetailedPaging

Type: object

An array of API implementation elements with paging information.

Match All

Type: object paging

Additional Properties Allowed:

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

Properties

items: Type: array apiImplementationArray

Additional Properties Allowed:

Minimum Number of Items: 0

An array of API implementations with artifact information.

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

Type: array

Minimum Number of Items: 0

An array of API implementations with artifact information.

Items

Type: object apiImplementationGet

Additional Properties Allowed:

The API implementation service details.

Nested Schema : apiImplementationGet

Type: object

The API implementation service details.

Match All

Type: object assetGet

Additional Properties Allowed:

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

Properties

api: Type: object assetShortQualified

Additional Properties Allowed:

An asset's information in qualified short form, which includes type and qualifiers.
artifacts: Type: array artifactArray

Additional Properties Allowed:

Minimum Number of Items: 0

An array of artifact information.

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

Type: object

An asset's information in qualified short form, which includes type and qualifiers.

Match All

Type: object assetShort

Additional Properties Allowed:

Asset information (short form).
Type: object assetQualifiers

Additional Properties Allowed:

Asset type name and qualifiers.

Nested Schema : artifactArray

Type: array

Minimum Number of Items: 0

An array of artifact information.

Items

Type: object artifact

Additional Properties Allowed:

The artifact information.

Nested Schema : assetShort

Type: object

Asset information (short form).

Properties

id: Type: string

Asset identifier.
name: Type: string

Asset name.
namespace: Type: string

Asset namespace.
version: Type: string

Maximum Length: 100

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

Asset version.

Nested Schema : assetQualifiers

Type: object

Asset type name and qualifiers.

Properties

qualifier: Type: string

The asset qualifier. It may contain multiple values separated by commas (`,`).
type: Allowed Values: [ "MobileBackend", "API", "APIImplementation", "Connector", "StorageCollection", "Role" ]

Nested Schema : artifact

Type: object

The artifact information.

Properties

downloadLink: Type: string

The link to download the artifact.
id: Type: string

Required: true

The artifact's ID.
name: Type: string

Required: true

Maximum Length: 255

The name of the artifact.
properties: Type: object properties

Additional Properties Allowed: { "type":"string" }

Nested Schema : properties

Type: object

Additional Properties Allowed

Type: string