REST API Reference for Oracle Mobile Cloud Enterprise - Tooling APIs

All REST Endpoints

APIs

Use this API to retrieve information about APIs, and to create, retrieve, and modify custom APIs.

Add API: Method: post
Path: /mobile/tools/1.0/apis
Associate Backend with API: Method: put
Path: /mobile/tools/1.0/mobilebackends/{id}/apis/{apiId}
Delete Backend API Association: Method: delete
Path: /mobile/tools/1.0/mobilebackends/{id}/apis/{apiId}
Download Implementation Scaffold: Method: get
Path: /mobile/tools/1.0/apis/{id}/scaffold
Retrieve API: Method: get
Path: /mobile/tools/1.0/apis/{id}
Retrieve API Dependencies: Method: get
Path: /mobile/tools/1.0/apis/{id}/dependencies
Retrieve APIs: Method: get
Path: /mobile/tools/1.0/apis
Retrieve Backend APIs: Method: get
Path: /mobile/tools/1.0/mobilebackends/{id}/apis
Retrieve Implementations: Method: get
Path: /mobile/tools/1.0/apis/{id}/implementations
Set Default Implementation: Method: put
Path: /mobile/tools/1.0/apis/{id}/implementations/default/{implId}
Update API: Method: put
Path: /mobile/tools/1.0/apis/{id}
Upload Implementation Archive: Method: post
Path: /mobile/tools/1.0/apis/{id}/implementations
Validate RAML and Prepare Payload: Method: post
Path: /mobile/tools/1.0/apis/raml

Artifacts

Use this API to get artifact binary data.

Retrieve Artifact Binary Data: Method: get
Path: /mobile/tools/1.0/artifacts/{artifactId}

Assets

Use this API to query about and get artifacts as well as to trash, restore, and purge artifacts.

Purge Assets From Trash: Method: post
Path: /mobile/tools/1.0/assets/purging
Restore Assets From Trash: Method: post
Path: /mobile/tools/1.0/assets/untrashing
Retrieve Asset Purge Dependencies: Method: post
Path: /mobile/tools/1.0/assets/purgeDependencies
Retrieve Asset Trash Dependencies: Method: post
Path: /mobile/tools/1.0/assets/trashDependencies
Retrieve Assets: Method: get
Path: /mobile/tools/1.0/assets
Retrieve Dependencies for Restoring Trashed Asset: Method: post
Path: /mobile/tools/1.0/assets/untrashDependencies
Retrieve Packaging Dependencies: Method: post
Path: /mobile/tools/1.0/assets/packageDependencies
Trash Assets: Method: post
Path: /mobile/tools/1.0/assets/trashing

Backends

Use this API to create, retrieve, and modify backends.

Add Backend: Method: post
Path: /mobile/tools/1.0/mobilebackends
Associate Backend with API: Method: put
Path: /mobile/tools/1.0/mobilebackends/{id}/apis/{apiId}
Associate Backend with Collection: Method: put
Path: /mobile/tools/1.0/mobilebackends/{id}/collections/{colId}
Delete Backend API Association: Method: delete
Path: /mobile/tools/1.0/mobilebackends/{id}/apis/{apiId}
Delete Backend Collection Association: Method: delete
Path: /mobile/tools/1.0/mobilebackends/{id}/collections/{colId}
Retrieve Backend: Method: get
Path: /mobile/tools/1.0/mobilebackends/{id}
Retrieve Backend APIs: Method: get
Path: /mobile/tools/1.0/mobilebackends/{id}/apis
Retrieve Backend Collections: Method: get
Path: /mobile/tools/1.0/mobilebackends/{id}/collections
Retrieve Backend Dependencies: Method: get
Path: /mobile/tools/1.0/mobilebackends/{id}/dependencies
Retrieve Backends: Method: get
Path: /mobile/tools/1.0/mobilebackends
Update Backend: Method: put
Path: /mobile/tools/1.0/mobilebackends/{id}

Custom API Implementations

Use this API to create, retrieve, and modify custom API implementations.

Download Implementation Scaffold: Method: get
Path: /mobile/tools/1.0/apis/{id}/scaffold
Retrieve Implementation Dependencies: Method: get
Path: /mobile/tools/1.0/implementations/{implementationId}/dependencies
Retrieve Implementations: Method: get
Path: /mobile/tools/1.0/apis/{id}/implementations
Set Default Implementation: Method: put
Path: /mobile/tools/1.0/apis/{id}/implementations/default/{implId}
Upload Implementation Archive: Method: post
Path: /mobile/tools/1.0/apis/{id}/implementations

Environment

Use this API to get information about the environment.

Packages

Use this API to import and export data.

Export Package: Method: post
Path: /mobile/tools/1.0/export/package
Install Package: Method: post
Path: /mobile/tools/1.0/import/package/install
Retrieve Packaging Dependencies: Method: post
Path: /mobile/tools/1.0/assets/packageDependencies
Upload Package: Method: post
Path: /mobile/tools/1.0/import/package/upload

Policies

Use this API to create, read, and delete environment policies.

Add Policy: Method: put
Path: /mobile/tools/1.0/policies
Delete Policy: Method: delete
Path: /mobile/tools/1.0/policies/{policyName}
Download Policies File: Method: get
Path: /mobile/tools/1.0/policies/export
Import Policies File: Method: post
Path: /mobile/tools/1.0/policies/import
Retrieve Policy: Method: get
Path: /mobile/tools/1.0/policies/{policyName}
Retrieve Policy by Name: Method: get
Path: /mobile/tools/1.0/policies
Set Multiple Policies: Method: patch
Path: /mobile/tools/1.0/policies

Storage Collections

Use this API to create, retrieve, and modify storage collections.

Add Collection: Method: post
Path: /mobile/tools/1.0/collections
Associate Backend with Collection: Method: put
Path: /mobile/tools/1.0/mobilebackends/{id}/collections/{colId}
Delete Backend Collection Association: Method: delete
Path: /mobile/tools/1.0/mobilebackends/{id}/collections/{colId}
Delete Collection Grant: Method: delete
Path: /mobile/tools/1.0/collections/{id}/grants
Retrieve Backend Collections: Method: get
Path: /mobile/tools/1.0/mobilebackends/{id}/collections
Retrieve Collection: Method: get
Path: /mobile/tools/1.0/collections/{id}
Retrieve Collection Dependencies: Method: get
Path: /mobile/tools/1.0/collections/{id}/dependencies
Retrieve Collection Grants: Method: get
Path: /mobile/tools/1.0/collections/{id}/grants
Retrieve Collections: Method: get
Path: /mobile/tools/1.0/collections
Update Collection: Method: put
Path: /mobile/tools/1.0/collections/{id}
Update Collection Grants: Method: put
Path: /mobile/tools/1.0/collections/{id}/grants