Get a list of Orchestrated Systems
get
/access-governance/service-administration/20250331/orchestratedSystems
Returns all active/inactive orchestrated systems and their details, with support for pagination.
Request
Query Parameters
-
displayName: array[string]
Collection Format:
multi
A filter to return only resources that match the given display names. -
isIdentityCollectionSupported: boolean
A filter to return Orchestrated Systems where identity are managed using identity collection.
-
isOrchestratedSystemActivated: boolean
A filter to return Orchestrated Systems that are activated.
-
isSchemaDiscoverySupported: boolean
A filter to return Orchestrated Systems that support schema discovery operation.
-
keywordContains: array[string]
Collection Format:
multi
Maximum Number of Items:5
The list of keywords to filter on from the following fields: displayName, lifecycleState. -
lifecycleState: array[string]
Collection Format:
multi
A filter to return only orchestrated systems that match the given lifecycle states.-
Allowed Values:
[ "ACTIVE", "INACTIVE" ]
-
-
limit: integer
Minimum Value:
1
Maximum Value:1000
The maximum number of items to return.Default Value:10
-
mode: array[string]
Collection Format:
multi
A filter to return only orchestrated systems based onthe given modes.-
Allowed Values:
[ "AUTHORITATIVE", "NONAUTHORITATIVE", "BOTH", "NONE" ]
-
-
orchestratedSystemType: array[string]
Collection Format:
multi
A filter to return only orchestrated systems that match the given types.-
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" ]
-
-
ownerId: string
A filter to return only resources that are owned by the user.
-
page: string
Minimum Length:
1
A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. -
sortBy: string
The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.Default Value:
timeCreated
Allowed Values:[ "timeCreated", "displayName" ]
-
sortOrder: string
The sort order to use, either 'ASC' or 'DESC'.Allowed Values:
[ "ASC", "DESC" ]
Header Parameters
-
opc-request-id: string
The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash.
Response
Supported Media Types
- application/json
200 Response
A paginated list of Orchestrated System summaries
Headers
-
opc-next-page: string
For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : OrchestratedSystemCollection
Type:
object
Results of an Orchestrated System search. Contains both OrchestratedSystemSummary items and other data.
Show Source
-
items(required):
array items
List of Orchestrated Systems.
Nested Schema : items
Type:
array
List of Orchestrated Systems.
Show Source
-
Array of:
object OrchestratedSystemSummary
Summary of the Orchestrated System.
Nested Schema : OrchestratedSystemSummary
Type:
object
Summary of the Orchestrated System.
Show Source
-
category:
string
Allowed Values:
[ "GOVERNANCE_SYSTEM", "CLOUD_SERVICE_PROVIDER", "DIRECTORY_INTEGRATIONS", "DATABASE_MANAGEMENT", "SAAS_APPLICATIONS", "ORACLE_APPLICATIONS", "EXPRESS" ]
Possible category of a Template. -
createdBy:
string
Minimum Length:
0
Maximum Length:255
A user identifier that created the Orchestrated System. -
displayName:
string
Orchestrated System Identifier, can be renamed.
-
id(required):
string
Unique identifier that is immutable on creation.
-
lastModifiedBy:
string
Minimum Length:
0
Maximum Length:255
A user identifier that last modified the Orchestrated System. -
lifecycleState(required):
string
Allowed Values:
[ "ACTIVE", "INACTIVE" ]
The current state of the Orchestrated System. -
mode:
string
Allowed Values:
[ "AUTHORITATIVE", "NONAUTHORITATIVE", "BOTH", "NONE" ]
Mode of the Orchestrated System. It can support AUTHORITATIVE, NONAUTHORITATIVE or BOTH -
name:
string
A user-friendly Name provided while creation
-
timeCreated:
string(date-time)
The time the Orchestrated System was created. An RFC3339 formatted datetime string.
-
timeLastModified:
string(date-time)
The time the the Orchestrated System was last modified. An RFC3339 formatted datetime string.
-
type(required):
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
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
Error Information.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing.
-
message(required):
string
A human-readable error string.
401 Response
Unauthorized
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
Error Information.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing.
-
message(required):
string
A human-readable error string.
404 Response
Not Found
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
Error Information.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing.
-
message(required):
string
A human-readable error string.
429 Response
Too Many Requests
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
Error Information.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing.
-
message(required):
string
A human-readable error string.
500 Response
Internal Server Error
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
Error Information.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing.
-
message(required):
string
A human-readable error string.
Default Response
Unknown Error
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
Error Information.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing.
-
message(required):
string
A human-readable error string.