Jump to

• Request
• Response
• Examples

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 Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

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.

{
    "description":"Details of an Analytics instance.",
    "properties":{
        "serviceInstanceKey":{
            "type":"string",
            "description":"Service instance key."
        },
        "description":{
            "type":"string",
            "description":"Description of the Analytics instance."
        },
        "owners":{
            "type":"array",
            "description":"List of owners.",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "serviceInstanceKey",
        "description",
        "owners"
    ]
}

Nested Schema : owners

Type: array

List of owners.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of owners.",
    "items":{
        "type":"string"
    }
}

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

Back to Top

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" ]}

Back to Top