Get a Timeflow by ID.

Request

Security

ApiKeyAuth

Path

timeflowIdstring, non-emptyrequired

The ID of the timeflow.

curl -i -X GET \
  'https://help-api.delphix.com/_mock/data-control-tower/continuous-data/22.0.0/continuous-data-apis-dct-22.0.0/timeflows/{timeflowId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json

idstring

The Timeflow ID.

Example:"timeflow-123"

engine_idstring

The ID of the engine the timeflow belongs to.

Example:"1"

namespacestring or null

Alternate namespace for this object, for replicated and restored timeflows.

Example:"NAMESPACE-1"

namespace_idstring or null

The namespace id of this timeflows.

Example:"1-NAMESPACE-1"

namespace_namestring or null

The namespace name of this timeflows.

Example:"test-engine-1"

is_replicaboolean

Is this a replicated object.

Example:true

namestring

The timeflow's name.

Example:"DB_PROVISION@2023-01-25T09:00:30"

dataset_idstring

The ID of the timeflow's dSource or VDB.

Example:"dataset-123"

creation_typestring

The source action that created the timeflow.

Enum:"INITIAL""INDETERMINATE""REFRESH""ROLLBACK""TEMPORARY""TRANSFORMATION""V2P""PDB_PLUG""ORACLE_LIVE_SOURCE_RESYNC""SOURCE_CONTINUITY"

Example:"REFRESH"

parent_snapshot_idstring

The ID of the timeflow's parent snapshot.

Example:"snapshot-123"

parent_point_locationstring

The location on the parent timeflow from which this timeflow was provisioned. This will not be present for timeflows derived from linked sources.

Example:"1178883"

parent_point_timestampstring, (date-time)

The timestamp on the parent timeflow from which this timeflow was provisioned. This will not be present for timeflows derived from linked sources.

Example:"2021-05-01T08:51:34.148Z"

parent_point_timeflow_idstring

A reference to the parent timeflow from which this timeflow was provisioned. This will not be present for timeflows derived from linked sources.

Example:"timeflow-123"

parent_vdb_idstring

The ID of the parent VDB. This is mutually exclusive with parent_dsource_id.

Example:"dataset-123"

parent_dsource_idstring

The ID of the parent dSource. This is mutually exclusive with parent_vdb_id.

Example:"dataset-123"

source_vdb_idstring

The ID of the source VDB. This is mutually exclusive with source_dsource_id.

Example:"dataset-123"

source_dsource_idstring

The ID of the source dSource. This is mutually exclusive with source_vdb_id.

Example:"dataset-123"

source_data_timestampstring, (date-time)

The timestamp on the root ancestor timeflow from which this timeflow originated. This logical time acts as reference to the origin source data.

Example:"2021-05-01T08:51:34.148Z"

oracle_incarnation_idstring

Oracle-specific incarnation identifier for this timeflow.

Example:"123"

oracle_cdb_timeflow_idstring

A reference to the mirror CDB timeflow if this is a timeflow for a PDB.

Example:"cdb-123"

oracle_tde_uuidstring

The unique identifier for timeflow-specific TDE objects that reside outside of Delphix storage.

Example:"tde-indentifier"

mssql_database_guidstring

MSSQL-specific recovery branch identifier for this timeflow.

Example:"DATABASE-1"

is_activeboolean

Whether this timeflow is currently active or not.

Example:false

creation_timestampstring, (date-time)

The time when the timeflow was created.

Example:"2021-05-01T08:51:34.000Z"

activation_timestampstring, (date-time)

The time when this timeflow became active.

Example:"2021-05-01T08:51:34.000Z"

tagsArray of objects(Tag)

Response

{
  "id": "timeflow-123",
  "engine_id": "1",
  "namespace": "NAMESPACE-1",
  "namespace_id": "1-NAMESPACE-1",
  "namespace_name": "test-engine-1",
  "is_replica": true,
  "name": "DB_PROVISION@2023-01-25T09:00:30",
  "dataset_id": "dataset-123",
  "creation_type": "REFRESH",
  "parent_snapshot_id": "snapshot-123",
  "parent_point_location": "1178883",
  "parent_point_timestamp": "2021-05-01T08:51:34.148Z",
  "parent_point_timeflow_id": "timeflow-123",
  "parent_vdb_id": "dataset-123",
  "parent_dsource_id": "dataset-123",
  "source_vdb_id": "dataset-123",
  "source_dsource_id": "dataset-123",
  "source_data_timestamp": "2021-05-01T08:51:34.148Z",
  "oracle_incarnation_id": "123",
  "oracle_cdb_timeflow_id": "cdb-123",
  "oracle_tde_uuid": "tde-indentifier",
  "mssql_database_guid": "DATABASE-1",
  "is_active": false,
  "creation_timestamp": "2021-05-01T08:51:34.000Z",
  "activation_timestamp": "2021-05-01T08:51:34.000Z",
  "tags": [
    { … }
  ]
}