Get details of an Analytics instance
get
/api/20210901/system
Return information about an Analytics instance. Details such as the service instance key, instance description, and instance owners.
Request
There are no request parameters for this operation.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : System
Type:
object
Details of an Analytics instance.
Show Source
-
description(required): string
Description of the Analytics instance.
-
owners(required): array
owners
List of owners.
-
serviceInstanceKey(required): string
Service instance key.
400 Response
Bad Request (invalid query parameters, malformed headers, and so on).
Root Schema : Error
Type:
Show Source
object
-
code(required): string
Short error code that defines the error, meant for programmatic parsing.
-
message(required): string
Human-readable error string.
Examples
In this example, you obtain information about an Oracle Analytics instance.
cURL Example:
curl -i \ --header 'Authorization: Bearer <token>' \ --request GET 'https://<hostname>/api/20210901/system'
Example of Request Body
Not applicable.
Example of Response Body
Status 200:
{ "serviceInstanceKey": "bootstrap", "description": "My Analytics instance", "owners": [ "Admin" ]}