Get object mappings
get
https://{your_site_interface}/opa-hub/api/12.2.35/deployments/{deployment-name}/versions/{deployment-version-versionNo}/mappings
This operation will get a deployment version's top-level (global) object for the input and output mappings.
Request
Path Parameters
-
deployment-name(required): string
The name of the deployment.
-
deployment-version-versionNo(required): integer(int64)
The version number for the deployment version.
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
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.
Response
Supported Media Types
- application/json
200 Response
The request was successfully completed.
Root Schema : deploymentMappings
Type:
Show Source
object
-
inputMapping: array
inputMapping
Read Only:
true
If the serviceType is 'WebService', 'EngagementCloud', or 'EngagementCloudV2', the entities and table names for this input mapping. -
outputMapping: array
outputMapping
Read Only:
true
If the serviceType is 'WebService', 'EngagementCloud', or 'EngagementCloudV2', the entities and table names for this output mapping. -
serviceName: string
Read Only:
true
The connection name. -
serviceType: string
Read Only:
true
The connection type. Values include ServiceCloud, WebService, EngagementCloud, and EngagementCloudV2.
Nested Schema : inputMapping
Type:
array
Read Only:
true
If the serviceType is 'WebService', 'EngagementCloud', or 'EngagementCloudV2', the entities and table names for this input mapping.
Show Source
Nested Schema : outputMapping
Type:
array
Read Only:
true
If the serviceType is 'WebService', 'EngagementCloud', or 'EngagementCloudV2', the entities and table names for this output mapping.
Show Source
Nested Schema : deploymentMappingsInput
Type:
Show Source
object
-
entityId: string
Read Only:
true
The entity name. -
tableName: string
Read Only:
true
The table name.
Nested Schema : deploymentMappingsOutput
Type:
Show Source
object
-
entityId: string
Read Only:
true
The entity name. -
tableName: string
Read Only:
true
The table name.