REST API Reference for Oracle Mobile Cloud Enterprise - Tooling APIs

Retrieve API

get

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

Returns the API metadata.

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

The identifier of the API.

Response

Supported Media Types

application/json

200 Response

API metadata.

Headers

ETag: Type: string

The ETag corresponds to the state of the API (that is, the value increments by one on each change operation). You can use this ETag with the `If-Match` HTTP header on a request.

Body

The API representation for GET requests.

Root Schema : apiGet

Type: object

The API representation for GET requests.

Match All

Type: object apiShort

Additional Properties Allowed:

The short API definition representation.
Type: object apiGet-allOf[1]

Additional Properties Allowed:

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 : apiGet-allOf[1]

Properties

apiDefn: Type: array stringArray

Additional Properties Allowed:

Minimum Number of Items: 0

An array of string values.
businessObjectsDefn: Type: string
category: Allowed Values: [ "CUSTOM", "PLATFORM", "SYSTEM", "CONNECTOR" ]
security: Type: object apiSecurity

Additional Properties Allowed:

The API security for POST and PUT requests.

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

Nested Schema : stringArray

Type: array

Minimum Number of Items: 0

An array of string values.

Items

Type: string

Nested Schema : apiSecurity

Type: object

The API security for POST and PUT requests.

Properties

access: Type: object securityAccess

Additional Properties Allowed:

Access details.
endpoints: Type: array endpointSecurityArray

Additional Properties Allowed:

Minimum Number of Items: 0

An array of endpoint security elements.
loginType: Allowed Values: [ "ENTERPRISE", "IDENTITYPROVIDER" ]

If the `required` attribute has a value of `true`, then the default is `ENTERPRISE`.
required: Type: boolean

Required: true

When `true`, either security access or a social identity provider configuration is required.

Nested Schema : securityAccess

Type: object

Access details.

Properties

all: Type: boolean
roles: Type: array stringArray

Additional Properties Allowed:

Minimum Number of Items: 0

An array of string values.

Nested Schema : endpointSecurityArray

Type: array

Minimum Number of Items: 0

An array of endpoint security elements.

Items

Type: object endpointSecurity

Additional Properties Allowed:

The API security for POST and PUT requests.

Nested Schema : endpointSecurity

Type: object

The API security for POST and PUT requests.

Properties

access: Type: object securityAccess

Additional Properties Allowed:

Access details.
method: Type: string

Required: true
resource: Type: string

Required: true

404 Response

An API with specified ID doesn't exist.

Body

Root Schema : error

Type: object

Properties

detail: Type: string

Required: true

Message that provides the error details.
o:ecid: Type: string

Required: true

Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.
o:errorCode: Type: string

Required: true

The service's error code.
o:errorDetails: Type: object errorDetails

Additional Properties Allowed:
o:errorPath: Type: string

Required: true

The relative point in the API path where the error occurred.
status: Type: integer (int64)

Required: true

HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.
title: Type: string

Required: true

Summary of the problem.
type: Type: string

Required: true

The URI to the link that provides details about the HTTP status code.

Nested Schema : errorDetails

Type: object

Properties

detail: Type: string

Required: true
o:errorDetails: Type: object errorDetails

Additional Properties Allowed:
title: Type: string

Required: true

Summary of the problem.
type: Type: string

Required: true

The URI to the link that provides details about the HTTP status code.