1. Oracle Access Governance REST APIs
  2. Tasks
  3. OrchestratedSystems

Get an Orchestrated System

get

/access-governance/service-administration/20250331/orchestratedSystems/{orchestratedSystemId}

Returns details of an orchestrated system with a given ID.

Request

Path Parameters
Header Parameters
  • The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash.
Back to Top

Response

Supported Media Types

200 Response

Retrieves the Orchestrated System for the given id
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : OrchestratedSystem
Type: object
Summary of the Orchestrated System.
Show Source
Nested Schema : AggregatedOrchestratedSystemStatus
Type: object
Status of the Orchestrated System.
Show Source
Nested Schema : CompartmentCollection
Type: object
List of compartment
Show Source
Nested Schema : DomainCollection
Type: object
List of values (domains for OCI).
Show Source
Nested Schema : OrchestratedSystemMetaData
Type: object
Orchestrated System metadata.
Show Source
Nested Schema : User
Type: object
Owner of a resource.
Show Source
Nested Schema : ConnectionStatus
Type: object
Status of the agent connection
Show Source
Nested Schema : DataLoadStatus
Type: object
Status of the data load
Show Source
Nested Schema : AggregatedOrchestratedSystemStatusError
Type: object
Aggregate Orchestrated System Status Error Information.
Show Source
Nested Schema : items
Type: array
List of compartment summaries
Show Source
Nested Schema : CompartmentSummary
Type: object
The summary of compartment
Show Source
Nested Schema : items
Type: array
List of values.
Show Source
Nested Schema : Domain
Type: object
A domain for an OCI system.
Show Source
Nested Schema : NotificationSettings
Type: object
Setting to enable notification of target events to user
Show Source
Nested Schema : emailCollection
Type: array
List of emails of the users to be notified.
Show Source
Nested Schema : notificationUserCollection
Type: array
List of ids of the users to be notified.
Show Source
Nested Schema : NotificationUser
Type: object
User to be notified.
Show Source

400 Response

Bad Request
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error Information.
Show Source

401 Response

Unauthorized
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error Information.
Show Source

404 Response

Not Found
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error Information.
Show Source

429 Response

Too Many Requests
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error Information.
Show Source

500 Response

Internal Server Error
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error Information.
Show Source

Default Response

Unknown Error
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error Information.
Show Source
Back to Top

Examples

The following example shows how to retrieve an Orchestrated System by submitting a GET request.

cURL Example - Without Query Parameters

curl -i -X GET \
   -H "Authorization:Bearer <your access token>" \ 
'${service-instance-url}/access-governance/service-administration/${versionId}/orchestratedSystems/${orchestratedSystemId}'

Sample GET command using REST Client

curl -i -X GET \
   -H "Authorization:Bearer <your access token>" \ 
'${service-instance-url}/access-governance/service-administration/20250331/orchestratedSystems/51f7bxxb-0xxf-46e2-xxee-cxxxxefebdxa'

Example of the Response Body

The following example shows the contents of the response body in JSON format:

{
    "id": "51f7bxxb-0xxf-46e2-xxee-cxxxxefebdxa",
    "name": "UA EHR",
    "displayName": "UA EHR",
    "lifecycleState": "ACTIVE",
    "timeCreated": "2024-09-03T07:26:36.148Z",
    "createdBy": "BCLARK@TESTMAIL",
    "aggregatedOrchestratedSystemStatus": {
        "aggregatedStatus": "DRAFT",
        "dataLoadStatus": null,
        "connectionStatus": null
    },
    "timeLastModified": "2024-09-03T07:26:40.000Z",
    "lastModifiedBy": "AG_System",
    "type": "CERNERMILLENNIUM",
    "category": "ABC_APPLICATIONS",
    "mode": "NONAUTHORITATIVE",
    "primaryOwner": {
        "id": "globalId.xxxxxc3-eedc-xdxa-b6d4-6c0fxxxxbad2.18.02exxbbb4bxxxxxxbxxaa046b3ceb16a",
        "displayName": "Bell Clark",
        "isPrimary": true
    },
    "domains": null
}
Back to Top