Create or replace connections
put
https://{your_site_interface}/opa-hub/api/12.2.34/connections
This operation will create or replace connections.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Nested Schema : connectionPut
Type:
Show Source
object
-
genericProvider: object
connectionGenericProviderPut
-
integrationCloud: object
connectionIntegrationCloudPut
-
interviewExtensionData: object
connectionInterviewExtensionDataPut
-
lastStatus: object
connectionLastStatusPut
-
metadata: object
connectionMetadataPut
-
serviceCloud: object
connectionServiceCloudPut
-
serviceName(required): string
The service name.
-
serviceType(required): string
Allowed Values:
[ "ServiceCloud", "WebService", "MetadataOnly", "GenericProvider", "IntegrationCloud", "EngagementCloud", "InterviewExtensionData", "EngagementCloudV2" ]
The type of service. -
webService: object
connectionWebServicePut
-
workspaces(required): array
workspaces
A list of one or more workspaces of which this connection is a member.
Nested Schema : connectionGenericProviderPut
Type:
Show Source
object
-
password: string
(password)
The connection password. Write-only property.
-
url(required): string
The URL of the target connection.
-
username: string
The connection username.
Nested Schema : connectionIntegrationCloudPut
Type:
Show Source
object
-
authType: string
Authentication Type for Integration Cloud; Basic / OAuth
-
idcsClientId: string
The IDCS client Id
-
idcsScope: string
The IDCS client scope
-
idcsSecret: string
The IDCS client secret. Write-only property.
-
idcsUrl: string
The IDCS URL of the target IC connection
-
password: string
(password)
The connection password. Write-only property.
-
url(required): string
The URL of the target connection.
-
username: string
The connection username.
Nested Schema : connectionInterviewExtensionDataPut
Type:
Show Source
object
-
authenticationMethod(required): 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.
-
password: string
(password)
The connection password. Write-only property. Required if the useHTTBasicAuth property is true.
-
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
Nested Schema : connectionMetadataPut
Type:
Show Source
object
-
staticMetadata(required): string
The static data for the metadata-only connection.
Nested Schema : connectionServiceCloudPut
Type:
Show Source
object
-
clientCertificateName: string
The name of the client certificate to present.
-
cxSiteName(required): string
Internal. Write-only property.
-
password: string
(password)
The connection password. Write-only property.
- rnSharedSecret: string (password)
- sharedSecret: string (password)
-
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(required): string
The connection username.
Nested Schema : connectionWebServicePut
Type:
Show Source
object
-
anonymousEnabled: boolean
Whether or not this connection can be used anonymously.
-
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.
-
password: string
(password)
The connection password. Write-only property. Required if the useWSS property is MetadataOnly or All.
-
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.
-
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.
Nested Schema : workspaces
Type:
array
A list of one or more workspaces of which this connection is a member.
Show Source
Security
-
Authorization: apiKey
Type:
apiKey
Description:Obtain a bearer token from https://{your_site_interface}/opa-hub/api/{API_version}/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/{API_version}/auth and use the access token from the response in the Authorization header.
Response
Supported Media Types
- application/json
201 Response
The request has been fulfilled and resulted in a new resource being created.
Nested Schema : connection
Type:
Show Source
object
-
genericProvider: object
connectionGenericProvider
-
integrationCloud: object
connectionIntegrationCloud
-
interviewExtensionData: object
connectionInterviewExtensionData
-
lastStatus: object
connectionLastStatus
-
metadata: object
connectionMetadata
-
serviceCloud: object
connectionServiceCloud
-
serviceName(required): string
The service name.
-
serviceType(required): string
Allowed Values:
[ "ServiceCloud", "WebService", "MetadataOnly", "GenericProvider", "IntegrationCloud", "EngagementCloud", "InterviewExtensionData", "EngagementCloudV2" ]
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.
Nested Schema : connectionGenericProvider
Type:
Show Source
object
-
url(required): string
The URL of the target connection.
-
username: string
The connection username.
Nested Schema : connectionIntegrationCloud
Type:
Show Source
object
-
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.
Nested Schema : connectionInterviewExtensionData
Type:
Show Source
object
-
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
Nested Schema : connectionLastStatus
Type:
Show Source
object
-
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.
Nested Schema : connectionMetadata
Type:
Show Source
object
-
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.
Nested Schema : connectionServiceCloud
Type:
Show Source
object
-
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.
Nested Schema : connectionStatus
Type:
Show Source
object
-
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.
Nested Schema : connectionWebService
Type:
Show Source
object
-
anonymousEnabled: boolean
Whether or not this connection can be used anonymously.
-
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 Sales and Fusion Service 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.
Nested Schema : workspaces
Type:
array
A list of one or more workspaces of which this connection is a member.
Show Source
400 Response
The request could not be processed because it contains missing or invalid information.