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.
Specifies that this value is encrypted and will not be returned by a GET
method. It may be specified in a POST
for update.
Specifies that the contents of this field can be written once, during creation, and may not be modified thereafter.
Specifies that a value must be specified for this field.
Specifies that this value may be read by a GET
, but is ignored during a POST
.
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:
The name of one of the partitions to associate.
Type: string
The runtime name of one of the partitions to associate.
Type: string
The name of the other partition to associate.
Type: string
The runtime name of the other partition to associate.
Type: string
Arbitrary properties. May include jdbcSystemResource and jdbcSystemResourceOverride properties.
Type: array
The DissociatePartitions entity includes the names of two partitions to dissociate and arbitrary properties.
The properties of the DissociatePartitions entity are as follows:
The name of one of the partitions to dissociate.
Type: string
The runtime name of one of the partitions to dissociate.
Type: string
The name of the other partition to dissociate.
Type: string
The runtime name of the other partition to dissociate.
Type: string
Arbitrary properties. These may include jdbcSystemResource and jdbcSystemResourceOverride properties.
Type: array
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:
The name of the environment.
Type: string
Constraints: Immutable
Create an environment from an orchestration.
Type: Orchestration
Constraints: Immutable
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:
The name of the partition.
Type: string
Constraints: Immutable
The name of the runtime on which the partition exists.
Type: string
Constraints: Immutable
The FailoverGroup entity has a cluster name and group lists for updateFailoverGroup action.
The properties of the FailoverGroupUpdate entity are as follows:
The cluster name.
Type: string
Constraints: Immutable
A list of group lists.
Type: array
A MigratePartition entity includes a runtime name, a phase and arbitrary properties.
The properties of the MigratePartition entity are as follows:
The phase.
Type: string
Constraints: Immutable
Arbitrary properties passed to a plugin.
Type: array
Constraints: Immutable
Name of the runtime on which the partition exists.
Type: string
Constraints: Immutable
The Orchestration entity includes the name and args for the environment to be created.
The properties of the Orchestration entity are as follows:
Arbitrary properties. These may include the username and password that are required to connect to the runtime.
Type: array
The name of the environment.
Type: string
Constraints: Immutable
A PDB entity includes name, id, status and create date.
The properties of the PDB entity are as follows:
The creation date of the PDB.
Type: string
Constraints: Read Only
The id of the PDB.
Type: string
Constraints: Immutable
The name of the PDB.
Type: string
Constraints: Immutable
The status of the PDB. (Not used, reserved for future use)
Type: string
Constraints: Immutable
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:
Property Confidential String value.
Type: string
Property Properties value.
Type: array
Constraints: Immutable
Property String values.
Type: array
The QuiescePartition entity includes arbitrary properties for the quiescing action.
The properties of the QuiescePartition entity are as follows:
The phase.
Type: string
Constraints: Immutable
Arbitrary properties passed to a plugin.
Type: array
The QuiesceRuntime entity includes the phase and arbitrary properties for the quiescing action.
The properties of the QuiesceRuntime entity are as follows:
The phase.
Type: string
Constraints: Immutable
Arbitrary properties passed to a plugin.
Type: array
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:
The name of the plugin.
Type: string
Constraints: Immutable
The server relative pathname to the jar file containing the plugin.
Type: string
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:
The hostname of the Runtime.
Type: string
Constraints: Immutable
The name of the Runtime.
Type: string
Constraints: Immutable
The port of the Runtime.
Type: string
Constraints: Immutable
Arbitrary properties. These may include the username and password that are required to connect to the runtime.
Type: array
Constraints: Immutable
The protocol of the Runtime.
Type: string
Constraints: Immutable
The type of the Runtime.
Type: string
Constraints: Immutable
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:
The ID of the partition.
Type: string
Constraints: Read Only
The name of the partition.
Type: string
Constraints: Immutable
Arbitrary properties passed to a plugin.
Type: array
The type of the partition. (Not used, reserved for future use)
Type: string
Constraints: Read Only
The ScaleRuntime entity includes a factor and arbitrary properties for a scaling action.
The properties of the ScaleRuntime entity are as follows:
Arbitrary properties passed to a plugin.
Type: array
The scale factor number.
Type: string
Constraints: Immutable
The Service entity includes the name, the type and a reference to the environment.
The properties of the Service entity are as follows:
The environment name of the service.
Type: string
Constraints: Immutable
The identity domain of the service.
Type: string
Constraints: Immutable
The name of the service.
Type: string
Constraints: Immutable
The services's top level directory.
Type: string
The service's two task.
Type: string
The type of the service.
Type: string
Constraints: Immutable
Universally unique identifier of the service.
Type: string
Constraints: Immutable
The StartPartition entity includes arbitrary properties for starting an action.
The properties of the StartPartition entity are as follows:
The phase.
Type: string
Constraints: Immutable
Arbitrary properties passed to a plugin.
Type: array
The StartRuntime entity includes the phase and arbitrary properties for a starting action.
The properties of the StartRuntime entity are as follows:
The phase.
Type: string
Constraints: Immutable
Arbitrary properties passed to a plugin.
Type: array
The SyncOptions entity includes the sync and interval values.
The properties of the SyncOptions entity are as follows:
Periodic sync on/off value.
Type: string
Constraints: Immutable
Periodic sync interval in hours.
Type: string
Constraints: Immutable
The Task entity includes the status of the task.
The properties of the Task entity are as follows:
The task error if available.
Type: string
Constraints: Read Only
The task progress.
Type: string
Constraints: Read Only
The task status.
Type: string
Constraints: Read Only
The Tenant entity includes the top level directory, ID and name of the tenant.
The properties of the Tenant entity are as follows:
The ID of the tenant.
Type: string
Constraints: Immutable
The name of the tenant.
Type: string
Constraints: Immutable
The tenant's top level directory for partitions.
Type: string
Universally unique identifier of the tenant.
Type: string
Constraints: Immutable
A Version entity describes a version of the lifecycle resources.
The properties of the Version entity are as follows:
True
if this is the default version.
Type: boolean
Constraints: Read Only
Type: string
The lifecycle of this version: active
or deprecated
Type: string
Constraints: Read Only
The name of this version.
Type: string
Constraints: Read Only