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 : OrchestratedSystemSummary
Type: object
Summary of the Orchestrated System.
Show Source
  • Allowed Values: [ "GOVERNANCE_SYSTEM", "CLOUD_SERVICE_PROVIDER", "DIRECTORY_INTEGRATIONS", "DATABASE_MANAGEMENT", "SAAS_APPLICATIONS", "ORACLE_APPLICATIONS", "EXPRESS" ]
    Possible category of a Template.
  • Minimum Length: 0
    Maximum Length: 255
    A user identifier that created the Orchestrated System.
  • Orchestrated System Identifier, can be renamed.
  • Unique identifier that is immutable on creation.
  • Minimum Length: 0
    Maximum Length: 255
    A user identifier that last modified the Orchestrated System.
  • Allowed Values: [ "ACTIVE", "INACTIVE" ]
    The current state of the Orchestrated System.
  • Allowed Values: [ "AUTHORITATIVE", "NONAUTHORITATIVE", "BOTH", "NONE" ]
    Mode of the Orchestrated System. It can support AUTHORITATIVE, NONAUTHORITATIVE or BOTH
  • A user-friendly Name provided while creation
  • The time the Orchestrated System was created. An RFC3339 formatted datetime string.
  • The time the the Orchestrated System was last modified. An RFC3339 formatted datetime string.
  • Allowed Values: [ "OIG", "OCI", "AZUREAD", "DBUMORADB", "SALESFORCE", "SERVICENOW", "EBSUM", "EBSHRMS", "FA", "MSFTAD", "OID", "OUD", "DBUMMYSQL", "DBUMDB2", "MSTEAMS", "ELOQUA", "NETSUITE", "DBUMMSSQL", "EXPRESSFLATFILE", "GRC", "SIEBELUM", "PRIMAVERA", "PEOPLESOFT", "DBATORACLE", "ARCONPAM", "CERNERMILLENNIUM", "DBATMYSQL", "DBATMSSQL", "CERNERHI", "ZOOM", "JIRA", "WORKDAY", "SAPARIBA", "SUCCESSFACTORS", "SAPS4HANA", "SAPFIELDGLASS", "BEYONDTRUST", "ORACLEEPM" ]
    Possible type for the Orchestrated System.

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