Jump to

• Request
• Response

Get all connections

get

https://{your_site_interface}/opa-hub/api/12.2.40/connections

This operation will get all connections.

Request

Query Parameters

• expand: string
  Comma separated list of named resources to expand, or "all" to expand all
• fields: string
  Comma separated list of fields to be returned
• links: string
  Comma separated list of links to be returned, or "none" to omit links
• q: string
  A JSON object for filtering matching property values within the collection

There's no request body for this operation.

Security

• Authorization: apiKey
  Type: apiKey

  Description: Obtain a bearer token from https://{your_site_interface}/opa-hub/api/12.2.17/auth and use it in the Authorization header as: Bearer {token}.
• oauth2_opa: oauth2
  Type: oauth2

  Description: POST the OAuth2 Client Credentials parameters to https://{your_site_interface}/opa-hub/api/12.2.17/auth and use the access token from the response in the Authorization header.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The request was successfully completed.

Body ()

Root Schema : connections

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/connection"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : items

Type: array

Show Source

• Array of: object connection

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/connection"
    }
}

Nested Schema : connection

Type: object

Show Source

• accessNamedRecordList: object accessNamedRecordList
• genericProvider: object connectionGenericProvider
• integrationCloud: object connectionIntegrationCloud
• interviewExtensionData: object connectionInterviewExtensionData
• lastStatus: object connectionLastStatus
• metadata: object connectionMetadata
• namedRecordLists: array namedRecordLists
• serviceCloud: object connectionServiceCloud
• serviceName(required): string
  The service name.
• serviceType(required): string
  Allowed Values: [ "ServiceCloud", "WebService", "MetadataOnly", "GenericProvider", "IntegrationCloud", "EngagementCloud", "InterviewExtensionData" ]

  The type of service.
• status: object connectionStatus
• webService: object connectionWebService
• workspaces: array workspaces
  A list of one or more workspaces of which this connection is a member.

{
    "type":"object",
    "properties":{
        "serviceName":{
            "type":"string",
            "description":"The service name."
        },
        "serviceType":{
            "type":"string",
            "description":"The type of service.",
            "enum":[
                "ServiceCloud",
                "WebService",
                "MetadataOnly",
                "GenericProvider",
                "IntegrationCloud",
                "EngagementCloud",
                "InterviewExtensionData"
            ]
        },
        "workspaces":{
            "type":"array",
            "description":"A list of one or more workspaces of which this connection is a member.",
            "items":{
                "type":"string"
            }
        },
        "lastStatus":{
            "description":"The most recently known status of the connection",
            "$ref":"#/components/schemas/connectionLastStatus"
        },
        "namedRecordLists":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/connectionAListOfDefinitionsForNamedRecordListsThatCanBeRetrievedThroughThisConnection."
            }
        },
        "metadata":{
            "description":"Container for MetadataOnly-specific connections.",
            "nullable":true,
            "$ref":"#/components/schemas/connectionMetadata"
        },
        "serviceCloud":{
            "description":"Container for B2C Service-specific connections.",
            "nullable":true,
            "$ref":"#/components/schemas/connectionServiceCloud"
        },
        "webService":{
            "description":"Container for Web service (Connector framework) connections.",
            "nullable":true,
            "$ref":"#/components/schemas/connectionWebService"
        },
        "integrationCloud":{
            "description":"Container for Oracle Integration connections.",
            "nullable":true,
            "$ref":"#/components/schemas/connectionIntegrationCloud"
        },
        "genericProvider":{
            "description":"Container for Web service (Generic provider) connections.",
            "nullable":true,
            "$ref":"#/components/schemas/connectionGenericProvider"
        },
        "status":{
            "readOnly":true,
            "$ref":"#/components/schemas/connectionStatus"
        },
        "accessNamedRecordList":{
            "readOnly":true,
            "$ref":"#/components/schemas/accessNamedRecordList"
        },
        "interviewExtensionData":{
            "description":"Container for Web service (Interview extension) connections.",
            "nullable":true,
            "$ref":"#/components/schemas/connectionInterviewExtensionData"
        }
    },
    "additionalProperties":false,
    "required":[
        "serviceType",
        "serviceName"
    ]
}

Nested Schema : accessNamedRecordList

Type: object

Show Source

• expiry: number (double)
  Timestamp (milliseconds since epoch) until data is considered invalid. 0 indicates dynamic data that should not be cached.
• hasMore: boolean
  true if there are more records to be retrieved in a sequence. Use offset parameter to access from a given starting point.
• idField: string
  Field name that identifies records
• nameField: string
  Field name for display of records
• records: array records
  List of records for query. List will be empty for a preflight request on dynamic data. Non-dynamic data always returns entire list regardless of query parameters.

{
    "type":"object",
    "properties":{
        "expiry":{
            "type":"number",
            "format":"double",
            "description":"Timestamp (milliseconds since epoch) until data is considered invalid. 0 indicates dynamic data that should not be cached."
        },
        "nameField":{
            "type":"string",
            "description":"Field name for display of records"
        },
        "idField":{
            "type":"string",
            "description":"Field name that identifies records"
        },
        "hasMore":{
            "type":"boolean",
            "description":"true if there are more records to be retrieved in a sequence. Use offset parameter to access from a given starting point."
        },
        "records":{
            "type":"array",
            "description":"List of records for query. List will be empty for a preflight request on dynamic data. Non-dynamic data always returns entire list regardless of query parameters.",
            "items":{
                "$ref":"#/components/schemas/accessNamedRecordListNamedRecordListItem"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : connectionGenericProvider

Type: object

Show Source

• url(required): string
  The URL of the target connection.
• username: string
  The connection username.

{
    "type":"object",
    "properties":{
        "url":{
            "type":"string",
            "description":"The URL of the target connection."
        },
        "username":{
            "type":"string",
            "description":"The connection username."
        }
    },
    "additionalProperties":false,
    "required":[
        "url"
    ]
}

Nested Schema : connectionIntegrationCloud

Type: object

Show Source

• authType: string
  Authentication Type for Integration Cloud; Basic / OAuth
• idcsClientId: string
  The IDCS client Id
• idcsScope: string
  The IDCS client scope
• idcsUrl: string
  The IDCS URL of the target IC connection
• url(required): string
  The URL of the target connection.
• username: string
  The connection username.

{
    "type":"object",
    "properties":{
        "url":{
            "type":"string",
            "description":"The URL of the target connection."
        },
        "username":{
            "type":"string",
            "description":"The connection username."
        },
        "idcsUrl":{
            "type":"string",
            "description":"The IDCS URL of the target IC connection"
        },
        "idcsClientId":{
            "type":"string",
            "description":"The IDCS client Id"
        },
        "idcsScope":{
            "type":"string",
            "description":"The IDCS client scope"
        },
        "authType":{
            "type":"string",
            "description":"Authentication Type for Integration Cloud; Basic / OAuth"
        }
    },
    "additionalProperties":false,
    "required":[
        "url"
    ]
}

Nested Schema : connectionInterviewExtensionData

Type: object

Show Source

• authenticationMethod: string
  Allowed Values: [ "None", "Basic", "AccessToken" ]

  The method of authentication the connection will use with the URL.'None' to pass through authorization header from interview extension (if supplied), 'Basic' for HTTP basic authentication, 'AccessToken' to use the access token for an authorization provider on the interview's workspace
• clientCertificateName: string
  The name of the client certificate to present.
• healthCheckUrl: string
  The optional url to use to health check this connection.
• url(required): string
  The URL of the target connection.
• useCustomRootCertificatesFlag: boolean
  Default Value: false

  Indicate whether the web service connection should use the custom root certificate store.
• username: string
  The connection username. Required if the useHTTBasicAuth property is true

{
    "type":"object",
    "properties":{
        "url":{
            "type":"string",
            "description":"The URL of the target connection."
        },
        "useCustomRootCertificatesFlag":{
            "type":"boolean",
            "description":"Indicate whether the web service connection should use the custom root certificate store.",
            "default":false
        },
        "clientCertificateName":{
            "type":"string",
            "description":"The name of the client certificate to present.",
            "nullable":true
        },
        "username":{
            "type":"string",
            "description":"The connection username. Required if the useHTTBasicAuth property is true",
            "nullable":true
        },
        "healthCheckUrl":{
            "type":"string",
            "description":"The optional url to use to health check this connection.",
            "nullable":true
        },
        "authenticationMethod":{
            "type":"string",
            "description":"The method of authentication the connection will use with the URL.'None' to pass through authorization header from interview extension (if supplied), 'Basic' for HTTP basic authentication, 'AccessToken' to use the access token for an authorization provider on the interview's workspace",
            "enum":[
                "None",
                "Basic",
                "AccessToken"
            ]
        }
    },
    "additionalProperties":false,
    "required":[
        "url"
    ]
}

Nested Schema : connectionLastStatus

Type: object

Show Source

• detail: string
  Read Only: true

  The most recent detailed status of the connection.
• okFlag: boolean
  Read Only: true

  True if the connection most recent test succeeded, otherwise false.
• summary: string
  Read Only: true

  Allowed Values: [ "No service", "No password", "Access test failed", "Access test passed", "Not supported", "Pending" ]

  The most recent summary status of the connection.
• timestamp: string (date-time)
  Read Only: true

  The date and time of the most recent status test.

{
    "type":"object",
    "properties":{
        "timestamp":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time of the most recent status test.",
            "readOnly":true
        },
        "okFlag":{
            "type":"boolean",
            "description":"True if the connection most recent test succeeded, otherwise false.",
            "readOnly":true
        },
        "summary":{
            "type":"string",
            "description":"The most recent summary status of the connection.",
            "readOnly":true,
            "enum":[
                "No service",
                "No password",
                "Access test failed",
                "Access test passed",
                "Not supported",
                "Pending"
            ]
        },
        "detail":{
            "type":"string",
            "description":"The most recent detailed status of the connection.",
            "readOnly":true
        }
    },
    "additionalProperties":false
}

Nested Schema : connectionMetadata

Type: object

Show Source

• schemaVersion: string
  Read Only: true

  The parsed version of the schema. Valid values are 12.0, 12.1, 12.2, 12.2.1, 12.2.2, 12.2.5, 12.2.9 and 12.2.13.
• staticMetadata(required): string
  The static data for the metadata-only connection.
• usesObsoleteVersion: boolean
  Read Only: true

  Indicates whether this connection uses an obsolete version.

{
    "type":"object",
    "properties":{
        "staticMetadata":{
            "type":"string",
            "description":"The static data for the metadata-only connection."
        },
        "schemaVersion":{
            "type":"string",
            "description":"The parsed version of the schema. Valid values are 12.0, 12.1, 12.2, 12.2.1, 12.2.2, 12.2.5, 12.2.9 and 12.2.13.",
            "readOnly":true
        },
        "usesObsoleteVersion":{
            "type":"boolean",
            "description":"Indicates whether this connection uses an obsolete version.",
            "readOnly":true
        }
    },
    "additionalProperties":false,
    "required":[
        "staticMetadata"
    ]
}

Nested Schema : namedRecordLists

Type: array

Show Source

• Array of: object connectionAListOfDefinitionsForNamedRecordListsThatCanBeRetrievedThroughThisConnection.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/connectionAListOfDefinitionsForNamedRecordListsThatCanBeRetrievedThroughThisConnection."
    }
}

Nested Schema : connectionServiceCloud

Type: object

Show Source

• clientCertificateName: string
  The name of the client certificate to present.
• url(required): string
  The URL of the target connection.
• useCustomRootCertificatesFlag: boolean
  Default Value: false

  Indicate whether the B2C service connection should use the custom root certificate store.
• username: string
  The connection username.

{
    "type":"object",
    "properties":{
        "url":{
            "type":"string",
            "description":"The URL of the target connection."
        },
        "useCustomRootCertificatesFlag":{
            "type":"boolean",
            "description":"Indicate whether the B2C service connection should use the custom root certificate store.",
            "default":false
        },
        "clientCertificateName":{
            "type":"string",
            "description":"The name of the client certificate to present.",
            "nullable":true
        },
        "username":{
            "type":"string",
            "description":"The connection username."
        }
    },
    "additionalProperties":false,
    "required":[
        "url"
    ]
}

Nested Schema : connectionStatus

Type: object

Show Source

• detail: string
  Read Only: true

  The detailed status of the connection.
• okFlag: boolean
  Read Only: true

  True if the connection test succeeded, otherwise false.
• summary: string
  Read Only: true

  Allowed Values: [ "No service", "No password", "Access test failed", "Access test passed" ]

  The summary status of the connection.
• timestamp: string (date-time)
  Read Only: true

  The date and time of the test.

{
    "type":"object",
    "properties":{
        "timestamp":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time of the test.",
            "readOnly":true
        },
        "okFlag":{
            "type":"boolean",
            "description":"True if the connection test succeeded, otherwise false.",
            "readOnly":true
        },
        "summary":{
            "type":"string",
            "description":"The summary status of the connection.",
            "readOnly":true,
            "enum":[
                "No service",
                "No password",
                "Access test failed",
                "Access test passed"
            ]
        },
        "detail":{
            "type":"string",
            "description":"The detailed status of the connection.",
            "readOnly":true
        }
    },
    "additionalProperties":false
}

Nested Schema : connectionWebService

Type: object

Show Source

• bearerTokenName: string
  Provide OAUTH bearer token in HTTP header on Load, Save, GetCheckpoint, SetCheckpoint and ExecuteQuery actions.
• clientCertificateName: string
  The name of the client certificate to present.
• cookieParameterName: string
  The name of the cookie to provide as a parameter in the request context on Load, Save, GetCheckpoint, SetCheckpoint and ExecuteQuery actions.
• linkedApiClient: string
  Read Only: true

  The name of the API client generated when the connection was created. Applicable to Oracle Fusion connections only.
• schemaVersion(required): string
  The version of the schema for the connection. Valid values are: 12.0, 12.1, 12.2, 12.2.1, 12.2.2, 12.2.5, 12.2.9, and 12.2.13.
• soapActionPattern: string
  Parameterize the SOAPAction HTTP header for non-standard SOAP services.
• url(required): string
  The URL of the target connection.
• useCustomRootCertificatesFlag: boolean
  Default Value: false

  Indicate whether the web service connection should use the custom root certificate store.
• username: string
  The connection username. Required if the useWSS property is MetadataOnly or All.
• usesObsoleteVersion: boolean
  Read Only: true

  Indicates whether this connection uses an obsolete version.
• useWSS: string
  Default Value: All

  Allowed Values: [ "None", "All", "MetadataOnly" ]

  The Web Service Security level.
• useWSSTimestampFlag: boolean
  Default Value: false

  True to send the WSSecurity timestamp parameter with a 5 minute expiry. False to not send the WSSecurity timestamp parameter.

{
    "type":"object",
    "properties":{
        "url":{
            "type":"string",
            "description":"The URL of the target connection."
        },
        "useCustomRootCertificatesFlag":{
            "type":"boolean",
            "description":"Indicate whether the web service connection should use the custom root certificate store.",
            "default":false
        },
        "clientCertificateName":{
            "type":"string",
            "description":"The name of the client certificate to present.",
            "nullable":true
        },
        "username":{
            "type":"string",
            "description":"The connection username. Required if the useWSS property is MetadataOnly or All.",
            "nullable":true
        },
        "schemaVersion":{
            "type":"string",
            "description":"The version of the schema for the connection. Valid values are: 12.0, 12.1, 12.2, 12.2.1, 12.2.2, 12.2.5, 12.2.9, and 12.2.13."
        },
        "useWSS":{
            "type":"string",
            "description":"The Web Service Security level.",
            "enum":[
                "None",
                "All",
                "MetadataOnly"
            ],
            "default":"All"
        },
        "useWSSTimestampFlag":{
            "type":"boolean",
            "description":"True to send the WSSecurity timestamp parameter with a 5 minute expiry. False to not send the WSSecurity timestamp parameter.",
            "default":false
        },
        "bearerTokenName":{
            "type":"string",
            "description":"Provide OAUTH bearer token in HTTP header on Load, Save, GetCheckpoint, SetCheckpoint and ExecuteQuery actions.",
            "nullable":true
        },
        "soapActionPattern":{
            "type":"string",
            "description":"Parameterize the SOAPAction HTTP header for non-standard SOAP services.",
            "nullable":true
        },
        "linkedApiClient":{
            "type":"string",
            "description":"The name of the API client generated when the connection was created. Applicable to Oracle Fusion connections only.",
            "readOnly":true
        },
        "usesObsoleteVersion":{
            "type":"boolean",
            "description":"Indicates whether this connection uses an obsolete version.",
            "readOnly":true
        },
        "cookieParameterName":{
            "type":"string",
            "description":"The name of the cookie to provide as a parameter in the request context on Load, Save, GetCheckpoint, SetCheckpoint and ExecuteQuery actions.",
            "nullable":true
        }
    },
    "additionalProperties":false,
    "required":[
        "schemaVersion",
        "url"
    ]
}

Nested Schema : workspaces

Type: array

A list of one or more workspaces of which this connection is a member.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of one or more workspaces of which this connection is a member.",
    "items":{
        "type":"string"
    }
}

Nested Schema : records

Type: array

List of records for query. List will be empty for a preflight request on dynamic data. Non-dynamic data always returns entire list regardless of query parameters.

Show Source

• Array of: object accessNamedRecordListNamedRecordListItem
  Additional Properties Allowed: true

{
    "type":"array",
    "description":"List of records for query. List will be empty for a preflight request on dynamic data. Non-dynamic data always returns entire list regardless of query parameters.",
    "items":{
        "$ref":"#/components/schemas/accessNamedRecordListNamedRecordListItem"
    }
}

Nested Schema : accessNamedRecordListNamedRecordListItem

Type: object

Additional Properties Allowed: true

Nested Schema : connectionAListOfDefinitionsForNamedRecordListsThatCanBeRetrievedThroughThisConnection.

Type: object

Show Source

• config: object connectionConfig
  Additional Properties Allowed: true
• idField: string
  Read Only: true

  The identity field of records of the named record list.
• name: string
  The name of the named record list.
• nameField: string
  Read Only: true

  The name field of records of the named record list.
• updated: string (date-time)
  Read Only: true

  The data and time of the most recent update.
• updatedBy: string
  Read Only: true

  The user who last updated the named record list.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the named record list."
        },
        "nameField":{
            "type":"string",
            "description":"The name field of records of the named record list.",
            "readOnly":true
        },
        "idField":{
            "type":"string",
            "description":"The identity field of records of the named record list.",
            "readOnly":true
        },
        "updated":{
            "type":"string",
            "format":"date-time",
            "description":"The data and time of the most recent update.",
            "readOnly":true
        },
        "updatedBy":{
            "type":"string",
            "description":"The user who last updated the named record list.",
            "readOnly":true
        },
        "config":{
            "description":"Configuration properties for the named record list",
            "$ref":"#/components/schemas/connectionConfig"
        }
    },
    "additionalProperties":false
}

Nested Schema : connectionConfig

Type: object

Additional Properties Allowed: true

Back to Top