REST API for Oracle Integration

Retrieve a QuickStart App by ID

get

/ic/api/process/v1/quickStartApps/{quickStartAppId}

Retrieves details for a QuickStart App based on the specified ID, including the name, description, Id and type of the QuickStart App.

Request

Path Parameters

quickStartAppId(required): string

The QuickStart App ID

Response

Supported Media Types

application/json
application/xml;qs=0.9

200 Response

Success. Retrieve QuickStart App.

Root Schema : quickStartApp

Type: object

the representation of a Quick Start Application

401 Response

Unauthorized

404 Response

QuickStart App is not found.

500 Response

Error in retrieving QuickStart App

Examples

The following example shows how to retrieve details of a QuickStart app by submitting a GET request on the REST resource.

Send Request

The following example shows the contents of the send request:

https://example.com/ic/api/process/<version>/quickStartApps/<quickStartAppId>

Where,

example.com is the host where Oracle Integration is running.
<version> is the REST API version.
<quickStartAppId> is the ID of the QuickStart Apps. To retrieve available QuickStart Apps, see Retrieve QuickStart Apps

Example of Response Header

Status Code: 200 OK
Date:   Mon, 03 Apr 2017 09:39:39GMT 
Content-Type:  application/json

Example of Response Body

{
  "name": "Loan Application",
  "description": "This loan application starts with the loan applicant submitting a form. The loan applicant and appraiser upload supporting documentation and then the Loan Department and Finance Departments review and approve.",
  "type": "ORACLE",
  "links": [
    {
      "href": "http://example.com:7001/ic/api/process/v1/quickStartApps/Loan%20Application",
      "rel": "self"
    },
    {
      "href": "http://example.com:7001/ic/api/process/v1/quickStartApps/Loan%20Application",
      "rel": "canonical"
    },
    {
      "href": "http://example.com:7001/ic/api/process/v1/",
      "rel": "parent"
    }
  ]
}