Jump to

• Request
• Response

Get object mappings

get

https://{your_site_interface}/opa-hub/api/12.2.35/deployments/{deployment-name}/activeVersion/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.

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The request was successfully completed.

Body ()

Root Schema : deploymentMappings

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "serviceName":{
            "type":"string",
            "description":"The connection name.",
            "readOnly":true
        },
        "serviceType":{
            "type":"string",
            "description":"The connection type. Values include ServiceCloud, WebService, EngagementCloud, and EngagementCloudV2.",
            "readOnly":true
        },
        "inputMapping":{
            "type":"array",
            "description":"If the serviceType is 'WebService', 'EngagementCloud', or 'EngagementCloudV2', the entities and table names for this input mapping.",
            "readOnly":true,
            "items":{
                "description":"The entities and table names for this input mapping.",
                "readOnly":true,
                "$ref":"#/components/schemas/deploymentMappingsInput"
            }
        },
        "outputMapping":{
            "type":"array",
            "description":"If the serviceType is 'WebService', 'EngagementCloud', or 'EngagementCloudV2', the entities and table names for this output mapping.",
            "readOnly":true,
            "items":{
                "description":"The entities and table names for this output mapping.",
                "readOnly":true,
                "$ref":"#/components/schemas/deploymentMappingsOutput"
            }
        }
    },
    "additionalProperties":false
}

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

• Array of: object deploymentMappingsInput

{
    "type":"array",
    "description":"If the serviceType is 'WebService', 'EngagementCloud', or 'EngagementCloudV2', the entities and table names for this input mapping.",
    "readOnly":true,
    "items":{
        "description":"The entities and table names for this input mapping.",
        "readOnly":true,
        "$ref":"#/components/schemas/deploymentMappingsInput"
    }
}

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

• Array of: object deploymentMappingsOutput

{
    "type":"array",
    "description":"If the serviceType is 'WebService', 'EngagementCloud', or 'EngagementCloudV2', the entities and table names for this output mapping.",
    "readOnly":true,
    "items":{
        "description":"The entities and table names for this output mapping.",
        "readOnly":true,
        "$ref":"#/components/schemas/deploymentMappingsOutput"
    }
}

Nested Schema : deploymentMappingsInput

Type: object

Show Source

• entityId: string
  Read Only: true

  The entity name.
• tableName: string
  Read Only: true

  The table name.

{
    "type":"object",
    "properties":{
        "entityId":{
            "type":"string",
            "description":"The entity name.",
            "readOnly":true
        },
        "tableName":{
            "type":"string",
            "description":"The table name.",
            "readOnly":true
        }
    },
    "additionalProperties":false
}

Nested Schema : deploymentMappingsOutput

Type: object

Show Source

• entityId: string
  Read Only: true

  The entity name.
• tableName: string
  Read Only: true

  The table name.

{
    "type":"object",
    "properties":{
        "entityId":{
            "type":"string",
            "description":"The entity name.",
            "readOnly":true
        },
        "tableName":{
            "type":"string",
            "description":"The table name.",
            "readOnly":true
        }
    },
    "additionalProperties":false
}

Back to Top