2 Entities

The following sections describe the data models on which the REST resources operate. These data models describe the information exchanged in REST resources.

The descriptions of these data models in this section include a description of the constraints that apply to each data field.

Constraints on Data Fields

Confidential

Specifies that this value is encrypted and will not be returned by a GET method. It may be specified in a POST for update.

Immutable

Specifies that the contents of this field can be written once, during creation, and may not be modified thereafter.

Not Null

Specifies that a value must be specified for this field.

Read Only

Specifies that this value may be read by a GET, but is ignored during a POST.

AssociatePartitions

The AssociatePartitions entity includes the names of two partitions to associate with each other and arbitrary properties.

The properties of the AssociatePartitions entity are as follows:

partition1Name

The name of one of the partitions to associate.

Type: string

partition1RuntimeName

The runtime name of one of the partitions to associate.

Type: string

partition2Name

The name of the other partition to associate.

Type: string

partition2RuntimeName

The runtime name of the other partition to associate.

Type: string

properties

Arbitrary properties. May include jdbcSystemResource and jdbcSystemResourceOverride properties.

Type: array

Deprovision

The Deprovision entity represents the logical container for tenant resources, that is, partitions, PDBs and Services.

The properties of the Deprovision entity are as follows:

orchestration

Create an environment from an orchestration.

Type: Orchestration

Constraints: Immutable

DissociatePartitions

The DissociatePartitions entity includes the names of two partitions to dissociate and arbitrary properties.

The properties of the DissociatePartitions entity are as follows:

partition1Name

The name of one of the partitions to dissociate.

Type: string

partition1RuntimeName

The runtime name of one of the partitions to dissociate.

Type: string

partition2Name

The name of the other partition to dissociate.

Type: string

partition2RuntimeName

The runtime name of the other partition to dissociate.

Type: string

properties

Arbitrary properties. These may include jdbcSystemResource and jdbcSystemResourceOverride properties.

Type: array

Environment

The Environment entity includes the environment name and represents the logical container for tenant resources, that is, partitions, PDBs and Services.

The properties of the Environment entity are as follows:

name

The name of the environment.

Type: string

Constraints: Immutable

orchestration

Create an environment from an orchestration.

Type: Orchestration

Constraints: Immutable

EnvironmentPartition

The EnvironmentPartition entity includes the name and runtime name, and represents a logical partition added to the environment.

The properties of the EnvironmentPartition entity are as follows:

name

The name of the partition.

Type: string

Constraints: Immutable

runtimeName

The name of the runtime on which the partition exists.

Type: string

Constraints: Immutable

MigratePartition

A MigratePartition entity includes a runtime name, a phase and arbitrary properties.

The properties of the MigratePartition entity are as follows:

phase

The phase.

Type: string

Constraints: Immutable

properties

Arbitrary properties passed to a plugin.

Type: array

Constraints: Immutable

runtimeName

Name of the runtime on which the partition exists.

Type: string

Constraints: Immutable

Orchestration

The Orchestration entity includes the name and args for the environment to be created.

The properties of the Orchestration entity are as follows:

args

Arbitrary properties. These may include the username and password that are required to connect to the runtime.

Type: array

name

The name of the environment.

Type: string

Constraints: Immutable

PDB

A PDB entity includes name, id, status and create date.

The properties of the PDB entity are as follows:

creationDate

The creation date of the PDB.

Type: string

Constraints: Read Only

id

The id of the PDB.

Type: string

Constraints: Immutable

name

The name of the PDB.

Type: string

Constraints: Immutable

status

The status of the PDB. (Not used, reserved for future use)

Type: string

Constraints: Immutable

Property

A Property entity holds a named property, where the value can be a String, a confidential String, or a list of Properties.

The properties of the Property entity are as follows:

confidentialValue

Property Confidential String value.

Type: string

properties

Property Properties value.

Type: array

Constraints: Immutable

values

Property String values.

Type: array

QuiescePartition

The QuiescePartition entity includes arbitrary properties for the quiescing action.

The properties of the QuiescePartition entity are as follows:

phase

The phase.

Type: string

Constraints: Immutable

properties

Arbitrary properties passed to a plugin.

Type: array

QuiesceRuntime

The QuiesceRuntime entity includes the phase and arbitrary properties for the quiescing action.

The properties of the QuiesceRuntime entity are as follows:

phase

The phase.

Type: string

Constraints: Immutable

properties

Arbitrary properties passed to a plugin.

Type: array

RegisterPlugin

The RegisterPlugin entity includes the name and relative path to a Java archive on a server file system.

The properties of the RegisterPlugin entity are as follows:

name

The name of the plugin.

Type: string

Constraints: Immutable

path

The server relative pathname to the jar file containing the plugin.

Type: string

RestartPartition

The RestartPartition entity includes arbitrary properties for restarting a partition.

The properties of the RestartPartition entity are as follows:

phase

The phase.

Type: string

Constraints: Immutable

properties

Arbitrary properties passed to a plugin.

Type: array

Runtime

The Runtime entity includes the name, type, host and port for a physical runtime. It can also include arbitrary properties.

The properties of the Runtime entity are as follows:

hostName

The hostname of the Runtime.

Type: string

Constraints: Immutable

name

The name of the Runtime.

Type: string

Constraints: Immutable

port

The port of the Runtime.

Type: string

Constraints: Immutable

properties

Arbitrary properties. These may include the username and password that are required to connect to the runtime.

Type: array

Constraints: Immutable

protocol

The protocol of the Runtime.

Type: string

Constraints: Immutable

type

The type of the Runtime.

Type: string

Constraints: Immutable

RuntimePartition

The RuntimePartitions entity includes the name and ID of the partition on a physical runtime. It can also include arbitrary properties.

The properties of the RuntimePartition entity are as follows:

id

The ID of the partition.

Type: string

Constraints: Read Only

name

The name of the partition.

Type: string

Constraints: Immutable

properties

Arbitrary properties passed to a plugin.

Type: array

type

The type of the partition. (Not used, reserved for future use)

Type: string

Constraints: Read Only

ScaleRuntime

The ScaleRuntime entity includes a factor and arbitrary properties for a scaling action.

The properties of the ScaleRuntime entity are as follows:

properties

Arbitrary properties passed to a plugin.

Type: array

scaleFactor

The scale factor number.

Type: string

Constraints: Immutable

Service

The Service entity includes the name, the type and a reference to the environment.

The properties of the Service entity are as follows:

environmentRef

The environment name of the service.

Type: string

Constraints: Immutable

identityDomain

The identity domain of the service.

Type: string

Constraints: Immutable

name

The name of the service.

Type: string

Constraints: Immutable

topLevelDir

The services's top level directory.

Type: string

twoTask

The service's two task.

Type: string

type

The type of the service.

Type: string

Constraints: Immutable

uuid

Universally unique identifier of the service.

Type: string

Constraints: Immutable

StartPartition

The StartPartition entity includes arbitrary properties for starting an action.

The properties of the StartPartition entity are as follows:

phase

The phase.

Type: string

Constraints: Immutable

properties

Arbitrary properties passed to a plugin.

Type: array

StartRuntime

The StartRuntime entity includes the phase and arbitrary properties for a starting action.

The properties of the StartRuntime entity are as follows:

phase

The phase.

Type: string

Constraints: Immutable

properties

Arbitrary properties passed to a plugin.

Type: array

Task

The Task entity includes the status of the task.

The properties of the Task entity are as follows:

error

The task error if available.

Type: string

Constraints: Read Only

progress

The task progress.

Type: string

Constraints: Read Only

status

The task status.

Type: string

Constraints: Read Only

Tenant

The Tenant entity includes the top level directory, ID and name of the tenant.

The properties of the Tenant entity are as follows:

id

The ID of the tenant.

Type: string

Constraints: Immutable

name

The name of the tenant.

Type: string

Constraints: Immutable

topLevelDir

The tenant's top level directory for partitions.

Type: string

uuid

Universally unique identifier of the tenant.

Type: string

Constraints: Immutable

Version

A Version entity describes a version of the lifecycle resources.

The properties of the Version entity are as follows:

isLatest

True if this is the default version.

Type: boolean

Constraints: Read Only

lifecycle

Type: string

state

The lifecycle of this version: active or deprecated

Type: string

Constraints: Read Only

version

The name of this version.

Type: string

Constraints: Read Only