Update a deployment
patch
https://{your_site_interface}/opa-hub/api/12.2.35/deployments/{deployment-name}
This operation will update a deployment.
Request
Path Parameters
-
deployment-name(required): string
The name of the deployment.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
activeVersionNo: integer
(int64)
-
compatibilityMode: string
Allowed Values:
[ "latest", "current", "previous" ]
Compatibility for the currently-active deployment. -
debugLoggingState: object
deploymentDebugLoggingStatePatch
-
services: array
services
The services to which the deployment may be activated.
-
workspace: string
The workspace which the deployment is a member.
-
workspaceReferences: string
Allowed Values:
[ "current", "all" ]
Workspace references for the currently-active deployment.
Nested Schema : deploymentDebugLoggingStatePatch
Type:
Show Source
object
-
duration: number
(double)
The duration debug logging for the deployment is to be enabled.
-
state: string
The state of debug logging for the deployment.
Nested Schema : services
Type:
array
The services to which the deployment may be activated.
Show Source
-
Array of:
string
Allowed Values:
[ "interview", "webserviceAssess", "webserviceInterview", "chatservice" ]
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 : deployment
Type:
Show Source
object
-
activeVersion: object
deploymentVersion
-
activeVersionNo: integer
(int64)
-
compatibilityMode(required): string
Allowed Values:
[ "latest", "current", "previous" ]
Compatibility for the currently-active deployment. -
debugLoggingState: object
deploymentDebugLoggingState
-
debugLogs: object
deploymentDebugLogs
-
description: string
The description of the deployment.
-
errors: array
errors
Read Only:
true
Runtime errors for deployment. -
kind: string
Read Only:
true
The kind of the currently-active deployment. -
logs: object
deploymentLogs
-
name(required): string
The name of the deployment.
-
referencesTo: object
referencesTo
-
services: array
services
The services to which the deployment may be activated.
-
serviceURLs: object
deploymentServiceURLs
-
versions: object
deploymentVersions
-
workspace: string
The workspace which the deployment is a member.
-
workspaceReferences: string
Allowed Values:
[ "current", "all" ]
Workspace references for the currently-active deployment.
Nested 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 : deploymentDebugLoggingState
Type:
Show Source
object
-
endDate: string
(date-time)
Read Only:
true
The date debug logging for the deployment will expire. -
maxLogs: number
(double)
Read Only:
true
The maximum number of debug logs that can be stored for the deployment. -
state(required): string
The state of debug logging for the deployment.
Nested Schema : services
Type:
array
The services to which the deployment may be activated.
Show Source
-
Array of:
string
Allowed Values:
[ "interview", "webserviceAssess", "webserviceInterview", "chatservice" ]
Nested Schema : deploymentServiceURLs
Type:
Show Source
object
-
interview: string
Read Only:
true
The start-session URL for the deployment's interview. -
webservice: string
Read Only:
true
The URL for the deployment's web services.
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
Nested Schema : deploymentDebugLog
Type:
Show Source
object
-
content: object
deploymentDebugLogContent
-
date: string
(date-time)
Read Only:
true
The date the debug log was created. -
deploymentVersion: number
(double)
Read Only:
true
The deployment version that initiated the debug log. -
events: object
deploymentDebugEvents
-
function: string
Read Only:
true
The name of the function that initiated the debug log. -
outcome: string
Read Only:
true
The outcome of the debug log. -
product: string
Read Only:
true
The name of the product that initiated the debug log. -
uid: string
Read Only:
true
The unique identifier generated by the system for the debug log.
Nested Schema : deploymentDebugLogContent
Type:
Show Source
object
-
base64: string
(byte)
Read Only:
true
The binary content of the debug log as a base-64 encoded string.Example:QmFzZS02NCBkYXRhLg==
-
fileName: string
Read Only:
true
The name of the debug log data file. -
mimeType: string
Read Only:
true
The MIME type of the debug log data file.
Nested Schema : debugEvent
Type:
Show Source
object
-
content: object
debugEventContent
-
contentFileName: string
Read Only:
true
The name of the debug event data file. -
contentMimeType: string
Read Only:
true
The MIME type of the debug event data file. -
date: string
(date-time)
Read Only:
true
The date and time the event occurred. -
description: string
Read Only:
true
The description of the event. -
id: number
(double)
Read Only:
true
The unqiue identifier for the debug event. -
name: string
Read Only:
true
The name of the event. -
outcome: string
Read Only:
true
The outcome of the event.
Nested Schema : debugEventContent
Type:
Show Source
object
-
base64: string
(byte)
Read Only:
true
The binary content of the debug event data file as a base-64 encoded string.Example:QmFzZS02NCBkYXRhLg==
-
fileName: string
Read Only:
true
The name of the debug event data file. -
mimeType: string
Read Only:
true
The MIME type of the debug event data file.
Nested Schema : deploymentLog
Type:
Show Source
object
-
activeVersion: integer
(int64)
Read Only:
true
The active deployment version, or empty if there is no active deployment version. -
date: string
(date-time)
Read Only:
true
The date and time at which the activation occurred. -
description: string
Read Only:
true
A description of the activated or deactivated deployment version. -
services: array
services
Read Only:
true
The services to which the deployment version has been activated. -
updatedBy: string
Read Only:
true
The user name of the person performing the action.
Nested Schema : services
Type:
array
Read Only:
true
The services to which the deployment version has been activated.
Show Source
-
Array of:
string
Allowed Values:
[ "interview", "webserviceAssess", "webserviceInterview", "chatservice" ]
Nested Schema : referencesToDeployments
Type:
Show Source
object
-
entries: array
entries
Read Only:
true
An array of deployment references, - hiddenEntries: integer (int64)
-
totalEntries: integer
(int64)
Read Only:
true
The total number of references to this deployment.
Nested Schema : referencesToProjects
Type:
Show Source
object
-
entries: array
entries
Read Only:
true
An array of project references, - hiddenEntries: integer (int64)
-
totalEntries: integer
(int64)
Read Only:
true
The total number of references to this project.
Nested Schema : referencesToDeploymentItem
Type:
Show Source
object
-
activeFlag: boolean
Read Only:
true
Whether this deployment version is the active version. -
environment: string
Read Only:
true
The environment for this deployment version. Only populated when environments are active. -
fingerprint: string
Read Only:
true
The fingerprint of this deployment version. -
kind: string
Read Only:
true
Allowed Values:[ "opm", "flow", "decision" ]
The kind of the deployment version. -
name: string
Read Only:
true
The name of the deployment. -
versionNo: integer
(int64)
Read Only:
true
The deployment version. -
workspace: string
The workspace which the deployment is a member.
Nested Schema : referencesToProjectItem
Type:
Show Source
object
-
environment: string
Read Only:
true
The environment for this project version. Only populated when environments are active. -
fingerprint: string
Read Only:
true
The fingerprint of this project version. -
kind: string
Read Only:
true
Allowed Values:[ "opm", "flow", "decision" ]
The kind of the project version. -
name: string
Read Only:
true
The name of the project. -
versionNo: integer
(int64)
Read Only:
true
The project version. -
workspace: string
The workspace which the project is a member.
400 Response
The request could not be processed because it contains missing or invalid information.
404 Response
The requested resource does not exist.
409 Response
The request could not be completed due to a conflict with the current state of the resource.
410 Response
The requested resource is no longer available.