Jump to

• Request
• Response

Update active deployment version

patch

https://{your_site_interface}/opa-hub/api/12.2.35/deployments/{deployment-name}/activeVersion

This operation will update the active deployment version.

Request

Path Parameters

• deployment-name(required): string
  The name of the deployment.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• dataSource: object deploymentVersionDataSourcePatch

{
    "type":"object",
    "properties":{
        "activeVersionFlag":{
            "type":"boolean",
            "description":"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."
        },
        "dataSource":{
            "description":"Data service used by this deployment version, extracted from the snapshot data.",
            "$ref":"#/components/schemas/deploymentVersionDataSourcePatch"
        }
    },
    "additionalProperties":false,
    "required":[
        "activeVersionFlag"
    ]
}

Nested Schema : deploymentVersionDataSourcePatch

Type: object

Show Source

• name(required): string
  The name of the data source.
• type: string
  Allowed Values: [ "RightNow", "MetadataOnlyService", "WebService", "GenericProvider", "IntegrationCloud" ]

  The type of data source.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the data source.",
            "nullable":true
        },
        "type":{
            "type":"string",
            "description":"The type of data source.",
            "nullable":true,
            "enum":[
                "RightNow",
                "MetadataOnlyService",
                "WebService",
                "GenericProvider",
                "IntegrationCloud"
            ]
        }
    },
    "additionalProperties":false,
    "required":[
        "name"
    ]
}

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 : deploymentVersion

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"The description for this deployment version."
        },
        "versionNo":{
            "type":"integer",
            "format":"int64",
            "description":"The auto-generated version number for this deployment version.",
            "readOnly":true
        },
        "addedBy":{
            "type":"string",
            "description":"The user name of the authorized user who uploaded this deployment version.",
            "readOnly":true
        },
        "activeVersionFlag":{
            "type":"boolean",
            "description":"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."
        },
        "dataSource":{
            "description":"Data service used by this deployment version, extracted from the snapshot data.",
            "$ref":"#/components/schemas/deploymentVersionDataSource"
        },
        "opaVersion":{
            "type":"string",
            "description":"The version of Policy Modeling used to generate this deployment snapshot, extracted from the snapshot data.",
            "readOnly":true
        },
        "date":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time that this deployment version was uploaded.",
            "readOnly":true
        },
        "snapshot":{
            "$ref":"#/components/schemas/snapshot"
        },
        "kind":{
            "type":"string",
            "description":"The type of the deployment.",
            "enum":[
                "opm",
                "decision",
                "flow"
            ]
        },
        "project":{
            "description":"The project version that this deployment is based on",
            "$ref":"#/components/schemas/deploymentVersionProject"
        },
        "urlParameters":{
            "readOnly":true,
            "$ref":"#/components/schemas/urlParameters"
        },
        "locales":{
            "readOnly":true,
            "$ref":"#/components/schemas/locales"
        },
        "operations":{
            "type":"array",
            "description":"Generic integration operations associated with the deployment version.",
            "items":{
                "description":"An interview operation",
                "$ref":"#/components/schemas/deploymentVersionOperation"
            }
        },
        "componentVersion":{
            "type":"string",
            "description":"The component version of Policy Modeling used to generate this deployment snapshot, extracted from the snapshot data.",
            "readOnly":true
        },
        "canUseCompatibilityMode":{
            "type":"boolean",
            "description":"Whether or not this deployment can be put into compatibility mode.",
            "readOnly":true
        },
        "mappings":{
            "readOnly":true,
            "$ref":"#/components/schemas/deploymentMappings"
        },
        "projectDefinition":{
            "readOnly":true,
            "$ref":"#/components/schemas/projectDefinition"
        }
    },
    "additionalProperties":false,
    "required":[
        "activeVersionFlag",
        "description"
    ]
}

Nested Schema : deploymentVersionDataSource

Type: object

Show Source

• name: string
  The name of the data source.
• type: string
  Allowed Values: [ "RightNow", "MetadataOnlyService", "WebService", "GenericProvider", "IntegrationCloud" ]

  The type of data source.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the data source.",
            "nullable":true
        },
        "type":{
            "type":"string",
            "description":"The type of data source.",
            "nullable":true,
            "enum":[
                "RightNow",
                "MetadataOnlyService",
                "WebService",
                "GenericProvider",
                "IntegrationCloud"
            ]
        }
    },
    "additionalProperties":false
}

Nested Schema : locales

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "default-locale":{
            "type":"string",
            "description":"The default locale for this policy model."
        },
        "available":{
            "type":"array",
            "description":"An array of all the available locales for this policy model.",
            "items":{
                "type":"string"
            }
        }
    },
    "additionalProperties":false,
    "required":[
        "available",
        "default-locale"
    ]
}

Nested 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 : operations

Type: array

Generic integration operations associated with the deployment version.

Show Source

• Array of: object deploymentVersionOperation

{
    "type":"array",
    "description":"Generic integration operations associated with the deployment version.",
    "items":{
        "description":"An interview operation",
        "$ref":"#/components/schemas/deploymentVersionOperation"
    }
}

Nested Schema : deploymentVersionProject

Type: object

Show Source

• name(required): string
  The name of the project.
• version(required): integer (int64)
  The version of the project.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the project."
        },
        "version":{
            "type":"integer",
            "format":"int64",
            "description":"The version of the project."
        }
    },
    "additionalProperties":false,
    "required":[
        "name",
        "version"
    ]
}

Nested Schema : projectDefinition

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "definition":{
            "type":"object",
            "description":"The Decision service or Flow project",
            "additionalProperties":true,
            "readOnly":true
        },
        "scheme":{
            "type":"object",
            "description":"The Flow Scheme. Only supplied for Flow deployments.",
            "additionalProperties":true,
            "readOnly":true
        }
    },
    "additionalProperties":false
}

Nested Schema : snapshot

Type: object

Show Source

• base64(required): string (byte)
  The zipped project to be deployed, as base-64 encoded data.

  Example: QmFzZS02NCBkYXRhLg==

{
    "type":"object",
    "properties":{
        "base64":{
            "type":"string",
            "format":"byte",
            "description":"The zipped project to be deployed, as base-64 encoded data.",
            "example":"QmFzZS02NCBkYXRhLg=="
        }
    },
    "additionalProperties":false,
    "required":[
        "base64"
    ]
}

Nested Schema : urlParameters

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"The object type. The root object will always be of type 'global'.",
            "enum":[
                "global",
                "containmentRelationship",
                "boolean",
                "text",
                "number",
                "currency",
                "date",
                "datetime",
                "time of day"
            ]
        },
        "properties":{
            "description":"If the type is 'global' or 'containmentRelationship', the attributes and relationships contained by this entity.",
            "$ref":"#/components/schemas/urlParametersProperties"
        }
    },
    "additionalProperties":false,
    "required":[
        "type"
    ]
}

Nested Schema : available

Type: array

An array of all the available locales for this policy model.

Show Source

• Array of: string

{
    "type":"array",
    "description":"An array of all the available locales for this policy model.",
    "items":{
        "type":"string"
    }
}

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
}

Nested Schema : deploymentVersionOperation

Type: object

Show Source

• href: string
  Read Only: true
• operationName: string
  Read Only: true
• operationRegistered: boolean
  Read Only: true

{
    "type":"object",
    "properties":{
        "operationName":{
            "type":"string",
            "readOnly":true
        },
        "href":{
            "type":"string",
            "readOnly":true
        },
        "operationRegistered":{
            "type":"boolean",
            "readOnly":true
        }
    },
    "additionalProperties":false
}

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

400 Response

The request could not be processed because it contains missing or invalid information.

404 Response

The requested resource does not exist.

410 Response

The requested resource is no longer available.

Back to Top