Jump to

• Request
• Response

Create deployments

post

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

This operation will create deployments.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Additional Properties Allowed: true

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/deploymentPost"
            }
        }
    },
    "additionalProperties":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object deploymentPost

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/deploymentPost"
    }
}

Nested Schema : deploymentPost

Type: object

Show Source

• compatibilityMode(required): string
  Allowed Values: [ "latest", "current", "previous" ]

  Compatibility for the currently-active deployment.
• description: string
  The description of the deployment.
• name(required): string
  The name of the deployment.
• services: array services
  The services to which the deployment may be activated.
• versions(required): object deploymentVersionsPost
• workspace(required): string
  The workspace which the deployment is a member.
• workspaceReferences: string
  Allowed Values: [ "current", "all" ]

  Workspace references for the currently-active deployment.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the deployment."
        },
        "description":{
            "type":"string",
            "description":"The description of the deployment."
        },
        "compatibilityMode":{
            "type":"string",
            "description":"Compatibility for the currently-active deployment.",
            "enum":[
                "latest",
                "current",
                "previous"
            ]
        },
        "workspace":{
            "type":"string",
            "description":"The workspace which the deployment is a member."
        },
        "services":{
            "type":"array",
            "description":"The services to which the deployment may be activated.",
            "items":{
                "type":"string",
                "enum":[
                    "interview",
                    "webserviceAssess",
                    "webserviceInterview",
                    "chatservice"
                ]
            }
        },
        "workspaceReferences":{
            "type":"string",
            "description":"Workspace references for the currently-active deployment.",
            "enum":[
                "current",
                "all"
            ]
        },
        "versions":{
            "$ref":"#/components/schemas/deploymentVersionsPost"
        }
    },
    "required":[
        "compatibilityMode",
        "workspace",
        "versions",
        "name"
    ]
}

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" ]

{
    "type":"array",
    "description":"The services to which the deployment may be activated.",
    "items":{
        "type":"string",
        "enum":[
            "interview",
            "webserviceAssess",
            "webserviceInterview",
            "chatservice"
        ]
    }
}

Nested Schema : deploymentVersionsPost

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/deploymentVersionPost"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : items

Type: array

Show Source

• Array of: object deploymentVersionPost

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/deploymentVersionPost"
    }
}

Nested Schema : deploymentVersionPost

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 deploymentVersionDataSourcePost
• description(required): string
  The description for this deployment version.
• project: object deploymentVersionProjectPost
• snapshot: object snapshotPost

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"The description for this deployment version."
        },
        "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/deploymentVersionDataSourcePost"
        },
        "snapshot":{
            "$ref":"#/components/schemas/snapshotPost"
        },
        "project":{
            "description":"The project version that this deployment is based on",
            "$ref":"#/components/schemas/deploymentVersionProjectPost"
        }
    },
    "additionalProperties":false,
    "required":[
        "activeVersionFlag",
        "description"
    ]
}

Nested Schema : deploymentVersionDataSourcePost

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"
    ]
}

Nested Schema : deploymentVersionProjectPost

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

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"
    ]
}

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

201 Response

The request has been fulfilled and resulted in a new resource being created.

Body ()

Root Schema : deployments

Type: object

Additional Properties Allowed: true

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/deployment"
            }
        }
    },
    "additionalProperties":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object deployment

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/deployment"
    }
}

Nested Schema : deployment

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the deployment."
        },
        "description":{
            "type":"string",
            "description":"The description of the deployment."
        },
        "compatibilityMode":{
            "type":"string",
            "description":"Compatibility for the currently-active deployment.",
            "enum":[
                "latest",
                "current",
                "previous"
            ]
        },
        "activeVersionNo":{
            "type":"integer",
            "format":"int64",
            "description":""
        },
        "workspace":{
            "type":"string",
            "description":"The workspace which the deployment is a member."
        },
        "services":{
            "type":"array",
            "description":"The services to which the deployment may be activated.",
            "items":{
                "type":"string",
                "enum":[
                    "interview",
                    "webserviceAssess",
                    "webserviceInterview",
                    "chatservice"
                ]
            }
        },
        "serviceURLs":{
            "description":"URLs for activated services.",
            "readOnly":true,
            "$ref":"#/components/schemas/deploymentServiceURLs"
        },
        "errors":{
            "type":"array",
            "description":"Runtime errors for deployment.",
            "readOnly":true,
            "items":{
                "type":"string"
            }
        },
        "workspaceReferences":{
            "type":"string",
            "description":"Workspace references for the currently-active deployment.",
            "enum":[
                "current",
                "all"
            ]
        },
        "kind":{
            "type":"string",
            "description":"The kind of the currently-active deployment.",
            "readOnly":true
        },
        "activeVersion":{
            "readOnly":true,
            "$ref":"#/components/schemas/deploymentVersion"
        },
        "versions":{
            "$ref":"#/components/schemas/deploymentVersions"
        },
        "logs":{
            "readOnly":true,
            "$ref":"#/components/schemas/deploymentLogs"
        },
        "debugLoggingState":{
            "description":"State of debug logging for the deployment",
            "$ref":"#/components/schemas/deploymentDebugLoggingState"
        },
        "debugLogs":{
            "readOnly":true,
            "$ref":"#/components/schemas/deploymentDebugLogs"
        },
        "referencesTo":{
            "readOnly":true,
            "$ref":"#/components/schemas/referencesTo"
        }
    },
    "required":[
        "compatibilityMode",
        "name"
    ]
}

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

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "state":{
            "type":"string",
            "description":"The state of debug logging for the deployment."
        },
        "endDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date debug logging for the deployment will expire.",
            "readOnly":true
        },
        "maxLogs":{
            "type":"number",
            "format":"double",
            "description":"The maximum number of debug logs that can be stored for the deployment.",
            "readOnly":true
        }
    },
    "additionalProperties":false,
    "required":[
        "state"
    ]
}

Nested Schema : deploymentDebugLogs

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/deploymentDebugLog"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : errors

Type: array

Read Only: true

Runtime errors for deployment.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Runtime errors for deployment.",
    "readOnly":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : deploymentLogs

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/deploymentLog"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : referencesTo

Type: object

Show Source

• deployments: object referencesToDeployments
• projects: object referencesToProjects

{
    "type":"object",
    "properties":{
        "deployments":{
            "description":"The object containing deployment reference information.",
            "readOnly":true,
            "$ref":"#/components/schemas/referencesToDeployments"
        },
        "projects":{
            "description":"The object containing project reference information.",
            "readOnly":true,
            "$ref":"#/components/schemas/referencesToProjects"
        }
    },
    "additionalProperties":false
}

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" ]

{
    "type":"array",
    "description":"The services to which the deployment may be activated.",
    "items":{
        "type":"string",
        "enum":[
            "interview",
            "webserviceAssess",
            "webserviceInterview",
            "chatservice"
        ]
    }
}

Nested Schema : deploymentServiceURLs

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "interview":{
            "type":"string",
            "description":"The start-session URL for the deployment's interview.",
            "readOnly":true
        },
        "webservice":{
            "type":"string",
            "description":"The URL for the deployment's web services.",
            "readOnly":true
        }
    },
    "additionalProperties":false
}

Nested Schema : deploymentVersions

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/deploymentVersion"
            }
        }
    },
    "additionalProperties":false
}

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

Nested Schema : items

Type: array

Show Source

• Array of: object deploymentDebugLog

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/deploymentDebugLog"
    }
}

Nested Schema : deploymentDebugLog

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "uid":{
            "type":"string",
            "description":"The unique identifier generated by the system for the debug log.",
            "readOnly":true
        },
        "outcome":{
            "type":"string",
            "description":"The outcome of the debug log.",
            "readOnly":true
        },
        "date":{
            "type":"string",
            "format":"date-time",
            "description":"The date the debug log was created.",
            "readOnly":true
        },
        "product":{
            "type":"string",
            "description":"The name of the product that initiated the debug log.",
            "readOnly":true
        },
        "function":{
            "type":"string",
            "description":"The name of the function that initiated the debug log.",
            "readOnly":true
        },
        "deploymentVersion":{
            "type":"number",
            "format":"double",
            "description":"The deployment version that initiated the debug log.",
            "readOnly":true
        },
        "events":{
            "readOnly":true,
            "$ref":"#/components/schemas/deploymentDebugEvents"
        },
        "content":{
            "readOnly":true,
            "$ref":"#/components/schemas/deploymentDebugLogContent"
        }
    },
    "additionalProperties":false
}

Nested Schema : deploymentDebugLogContent

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "fileName":{
            "type":"string",
            "description":"The name of the debug log data file.",
            "readOnly":true
        },
        "mimeType":{
            "type":"string",
            "description":"The MIME type of the debug log data file.",
            "readOnly":true
        },
        "base64":{
            "type":"string",
            "format":"byte",
            "description":"The binary content of the debug log as a base-64 encoded string.",
            "readOnly":true,
            "example":"QmFzZS02NCBkYXRhLg=="
        }
    },
    "additionalProperties":false
}

Nested Schema : deploymentDebugEvents

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/debugEvent"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : items

Type: array

Show Source

• Array of: object debugEvent

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/debugEvent"
    }
}

Nested Schema : debugEvent

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"number",
            "format":"double",
            "description":"The unqiue identifier for the debug event.",
            "readOnly":true
        },
        "date":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time the event occurred.",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "description":"The name of the event.",
            "readOnly":true
        },
        "description":{
            "type":"string",
            "description":"The description of the event.",
            "readOnly":true
        },
        "outcome":{
            "type":"string",
            "description":"The outcome of the event.",
            "readOnly":true
        },
        "contentMimeType":{
            "type":"string",
            "description":"The MIME type of the debug event data file.",
            "readOnly":true
        },
        "contentFileName":{
            "type":"string",
            "description":"The name of the debug event data file.",
            "readOnly":true
        },
        "content":{
            "readOnly":true,
            "$ref":"#/components/schemas/debugEventContent"
        }
    },
    "additionalProperties":false
}

Nested Schema : debugEventContent

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "fileName":{
            "type":"string",
            "description":"The name of the debug event data file.",
            "readOnly":true
        },
        "mimeType":{
            "type":"string",
            "description":"The MIME type of the debug event data file.",
            "readOnly":true
        },
        "base64":{
            "type":"string",
            "format":"byte",
            "description":"The binary content of the debug event data file as a base-64 encoded string.",
            "readOnly":true,
            "example":"QmFzZS02NCBkYXRhLg=="
        }
    },
    "additionalProperties":false
}

Nested Schema : items

Type: array

Show Source

• Array of: object deploymentLog

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/deploymentLog"
    }
}

Nested Schema : deploymentLog

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "date":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time at which the activation occurred.",
            "readOnly":true
        },
        "description":{
            "type":"string",
            "description":"A description of the activated or deactivated deployment version.",
            "readOnly":true
        },
        "updatedBy":{
            "type":"string",
            "description":"The user name of the person performing the action.",
            "readOnly":true
        },
        "services":{
            "type":"array",
            "description":"The services to which the deployment version has been activated.",
            "readOnly":true,
            "items":{
                "type":"string",
                "enum":[
                    "interview",
                    "webserviceAssess",
                    "webserviceInterview",
                    "chatservice"
                ]
            }
        },
        "activeVersion":{
            "type":"integer",
            "format":"int64",
            "description":"The active deployment version, or empty if there is no active deployment version.",
            "readOnly":true
        }
    },
    "additionalProperties":false
}

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" ]

{
    "type":"array",
    "description":"The services to which the deployment version has been activated.",
    "readOnly":true,
    "items":{
        "type":"string",
        "enum":[
            "interview",
            "webserviceAssess",
            "webserviceInterview",
            "chatservice"
        ]
    }
}

Nested Schema : referencesToDeployments

Type: object

Show Source

• entries: array entries
  Read Only: true

  An array of deployment references,
• hiddenEntries: integer (int64)
  Read Only: true

  The number of hidden references to this deployment, due to permissions.
• totalEntries: integer (int64)
  Read Only: true

  The total number of references to this deployment.

{
    "type":"object",
    "properties":{
        "totalEntries":{
            "type":"integer",
            "format":"int64",
            "description":"The total number of references to this deployment.",
            "readOnly":true
        },
        "hiddenEntries":{
            "type":"integer",
            "format":"int64",
            "description":"The number of hidden references to this deployment, due to permissions.",
            "readOnly":true
        },
        "entries":{
            "type":"array",
            "description":"An array of deployment references,",
            "readOnly":true,
            "items":{
                "description":"Describes a single deployment version that refers to this deployment.",
                "$ref":"#/components/schemas/referencesToDeploymentItem"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : referencesToProjects

Type: object

Show Source

• entries: array entries
  Read Only: true

  An array of project references,
• hiddenEntries: integer (int64)
  Read Only: true

  The number of hidden references to this project, due to permissions.
• totalEntries: integer (int64)
  Read Only: true

  The total number of references to this project.

{
    "type":"object",
    "properties":{
        "totalEntries":{
            "type":"integer",
            "format":"int64",
            "description":"The total number of references to this project.",
            "readOnly":true
        },
        "hiddenEntries":{
            "type":"integer",
            "format":"int64",
            "description":"The number of hidden references to this project, due to permissions.",
            "readOnly":true
        },
        "entries":{
            "type":"array",
            "description":"An array of project references,",
            "readOnly":true,
            "items":{
                "description":"Describes a single deployment version that refers to this deployment.",
                "$ref":"#/components/schemas/referencesToProjectItem"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : entries

Type: array

Read Only: true

An array of deployment references,

Show Source

• Array of: object referencesToDeploymentItem

{
    "type":"array",
    "description":"An array of deployment references,",
    "readOnly":true,
    "items":{
        "description":"Describes a single deployment version that refers to this deployment.",
        "$ref":"#/components/schemas/referencesToDeploymentItem"
    }
}

Nested Schema : referencesToDeploymentItem

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the deployment.",
            "readOnly":true
        },
        "versionNo":{
            "type":"integer",
            "format":"int64",
            "description":"The deployment version.",
            "readOnly":true
        },
        "fingerprint":{
            "type":"string",
            "description":"The fingerprint of this deployment version.",
            "readOnly":true
        },
        "kind":{
            "type":"string",
            "description":"The kind of the deployment version.",
            "readOnly":true,
            "enum":[
                "opm",
                "flow",
                "decision"
            ]
        },
        "activeFlag":{
            "type":"boolean",
            "description":"Whether this deployment version is the active version.",
            "readOnly":true
        },
        "environment":{
            "type":"string",
            "description":"The environment for this deployment version. Only populated when environments are active.",
            "readOnly":true
        },
        "workspace":{
            "type":"string",
            "description":"The workspace which the deployment is a member."
        }
    },
    "additionalProperties":false
}

Nested Schema : entries

Type: array

Read Only: true

An array of project references,

Show Source

• Array of: object referencesToProjectItem

{
    "type":"array",
    "description":"An array of project references,",
    "readOnly":true,
    "items":{
        "description":"Describes a single deployment version that refers to this deployment.",
        "$ref":"#/components/schemas/referencesToProjectItem"
    }
}

Nested Schema : referencesToProjectItem

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the project.",
            "readOnly":true
        },
        "versionNo":{
            "type":"integer",
            "format":"int64",
            "description":"The project version.",
            "readOnly":true
        },
        "fingerprint":{
            "type":"string",
            "description":"The fingerprint of this project version.",
            "readOnly":true
        },
        "kind":{
            "type":"string",
            "description":"The kind of the project version.",
            "readOnly":true,
            "enum":[
                "opm",
                "flow",
                "decision"
            ]
        },
        "environment":{
            "type":"string",
            "description":"The environment for this project version. Only populated when environments are active.",
            "readOnly":true
        },
        "workspace":{
            "type":"string",
            "description":"The workspace which the project is a member."
        }
    },
    "additionalProperties":false
}

Nested Schema : items

Type: array

Show Source

• Array of: object deploymentVersion

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/deploymentVersion"
    }
}

400 Response

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

409 Response

The request could not be completed due to a conflict with the current state of the resource.

Back to Top