3 Getting Started

Quick Start

Set up your environment and retrieve your first task list for Oracle Integration using the REST API by performing the following tasks.

Prerequisites

· Access to Performance Analytics.

· Appropriate user privileges to access the services.

· Technical and functional knowledge to understand and execute the REST APIs and configuration knowledge.

· Knowledge of REST concepts, JSON, browser-based REST client.

· Knowledge of an interactive and automatic tool for verifying the APIs such as Postman.

Obtain Account Information

The account creation e-mail from Oracle contains the identity domain name for the Oracle Performance Analytics Instance. If you do not have this information, then contact your Service Administrator.

Authentication

Ensure that you have the appropriate log-in credentials for accessing the Oracle Performance Analytics service, and the appropriate role for creating, managing, and deleting service instances.

Getting Authentication

To get authentication, follow these steps:

1. Log in to Admin Console.

For more information, see Admin Console.

2. Go to Component Details and click AUTH tab.

The Client ID and Client Password details are displayed.

3. Copy Client ID and Client Password.

4. Open Postman or relevant API tools. Select POST method and paste the URL: https://ip:port/oauth2/v1/token.

Replace the ip:port with the tenant URL or domain name.

5. Click the Authorization tab. Go to the Type field and select Basic Auth from the drop-down list. The User Name and Password fields are displayed.

6. Enter the User Name and Password that you have copied in step-3.

7. Go to the Body tab. Select request format as: x-www-form-urlencoded.

8. Enter the KEY and Value fields as mentioned in the table:

The following table explains the KEY and VALUE details.

Table 2: KEY-VALUE Details

KEY	VALUE
grant_type	client_credentials
scope	urn:opc:idm:__myscopes__

9. Click the Header tab. The Header details are displayed.

10. Enter the details explained in the following table:

Table 3: KEY-VALUE Details

KEY	VALUE
Postman-Token	client_credentials
scope	urn:opc:idm:__myscopes__
Content-Type	application/x-www-form-urlencoded
Content -Length	<calculated when request is sent>
Host	<calculated when request is sent>
User-Agent	PostmanRuntime/7.28.0
Accept	/
Accept-Encoding	gzip,deflate,br
Connection	keep-alive

11. Click Send. An Authorization token is generated in the Response body. For example, <eyJ4NXQjUzI1NiI6Ikk3cWxndm1Kal...>

This Authentication Key is valid for a stipulated time.

12. Copy only the Authorization token details.

Status Codes

When you call any of the Oracle Integration REST resources, the Response header returns one of the standard HTTP status codes defined in the following table.

Table 4: HTTP Status Codes and Descriptions

HTTP Status Code	Description
200 OK	The request was successfully completed. A 200 status is returned for a successful GET or POST Method.
201 Created	The request has been fulfilled and resulted in a new resource being created. The response includes a Location header containing the canonical URI for the newly created resource. A 201 status is returned from a synchronous resource creation or an asynchronous resource creation that completed before the response was returned.
202 Accepted	The request has been accepted for processing, but the processing has not been completed. The request may or may not eventually be acted upon, as it may be disallowed at the time processing actually takes place. A 202 may be returned if an operation is still in progress or does not complete in a reasonable amount of time. The response contains a Location header of a job resource that the client should poll to determine when the job has finished. The response also returns an entity that contains the current state of the job.
400 Bad Request	The request could not be processed because it contains missing or invalid information (such as, a validation error on an input field, a missing required value, and so on).
401 Unauthorized	The request is not authorized. The authentication credentials included with this request are missing or invalid.
403 Forbidden	The user cannot be authenticated. The user does not have authorization to perform this request.
404 Not Found	The request includes a resource URI that does not exist.
405 Method Not Allowed	The HTTP verb specified in the request (DELETE, GET, POST, PUT) is not supported for this request URI.
406 Not Acceptable	The resource identified by this request is not capable of generating a representation corresponding to one of the media types in the Accept header of the request. For example, the client's Accept header request XML be returned, but the resource can only return JSON.
415 Not Acceptable	The client's ContentType header is not correct (for example, the client attempts to send the request in XML, but the resource can only accept JSON).
500 Internal Server Error	The server encountered an unexpected condition that prevented it from fulfilling the request.
503 Service Unavailable	The server is unable to handle the request due to temporary overloading or maintenance of the server. The Oracle Integration REST web application is not currently running.