Get active deployment version
get
https://{your_site_interface}/opa-hub/api/12.2.35/deployments/{deployment-name}/activeVersion
This operation will get the active deployment version.
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.
Response
Supported Media Types
- application/json
200 Response
The request was successfully completed.
Root Schema : deploymentVersion
Type:
Show Source
object
-
activeVersionFlag(required): boolean
True if this version is the currently-active version of this deployment, otherwise false. Only one version of a deployment may be active at any one time.
-
addedBy: string
Read Only:
true
The user name of the authorized user who uploaded this deployment version. -
canUseCompatibilityMode: boolean
Read Only:
true
Whether or not this deployment can be put into compatibility mode. -
componentVersion: string
Read Only:
true
The component version of Policy Modeling used to generate this deployment snapshot, extracted from the snapshot data. -
dataSource: object
deploymentVersionDataSource
-
date: string
(date-time)
Read Only:
true
The date and time that this deployment version was uploaded. -
description(required): string
The description for this deployment version.
-
kind: string
Allowed Values:
[ "opm", "decision", "flow" ]
The type of the deployment. -
locales: object
locales
-
mappings: object
deploymentMappings
-
opaVersion: string
Read Only:
true
The version of Policy Modeling used to generate this deployment snapshot, extracted from the snapshot data. -
operations: array
operations
Generic integration operations associated with the deployment version.
-
project: object
deploymentVersionProject
-
projectDefinition: object
projectDefinition
-
snapshot: object
snapshot
-
urlParameters: object
urlParameters
-
versionNo: integer
(int64)
Read Only:
true
The auto-generated version number for this deployment version.
Nested Schema : deploymentVersionDataSource
Type:
Show Source
object
-
name: string
The name of the data source.
-
type: string
Allowed Values:
[ "RightNow", "MetadataOnlyService", "WebService", "GenericProvider", "IntegrationCloud" ]
The type of data source.
Nested Schema : locales
Type:
Show Source
object
-
available(required): array
available
An array of all the available locales for this policy model.
-
default-locale(required): string
The default locale for this policy model.
Nested 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 : operations
Type:
array
Generic integration operations associated with the deployment version.
Show Source
Nested Schema : deploymentVersionProject
Type:
Show Source
object
-
name(required): string
The name of the project.
-
version(required): integer
(int64)
The version of the project.
Nested Schema : projectDefinition
Type:
Show Source
object
-
definition: object
definition
Read Only:
true
Additional Properties Allowed:true
The Decision service or Flow project -
scheme: object
scheme
Read Only:
true
Additional Properties Allowed:true
The Flow Scheme. Only supplied for Flow deployments.
Nested Schema : snapshot
Type:
Show Source
object
-
base64(required): string
(byte)
The zipped project to be deployed, as base-64 encoded data.Example:
QmFzZS02NCBkYXRhLg==
Nested Schema : urlParameters
Type:
Show Source
object
-
properties: object
urlParametersProperties
Additional Properties Allowed:
true
-
type(required): string
Allowed Values:
[ "global", "containmentRelationship", "boolean", "text", "number", "currency", "date", "datetime", "time of day" ]
The object type. The root object will always be of type 'global'.
Nested Schema : available
Type:
array
An array of all the available locales for this policy model.
Show Source
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.
Nested Schema : deploymentVersionOperation
Type:
Show Source
object
-
href: string
Read Only:
true
-
operationName: string
Read Only:
true
-
operationRegistered: boolean
Read Only:
true
Nested Schema : definition
Type:
object
Read Only:
true
Additional Properties Allowed:
true
The Decision service or Flow project
Nested Schema : scheme
Type:
object
Read Only:
true
Additional Properties Allowed:
true
The Flow Scheme. Only supplied for Flow deployments.
Nested Schema : urlParametersProperties
Type:
object
Additional Properties Allowed:
true
404 Response
The requested resource does not exist.
410 Response
The requested resource is no longer available.