Timeflows

Retrieve the list of timeflows.

SecurityApiKeyAuth
Request
query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

Example: limit=50
cursor
string [ 1 .. 4096 ] characters

Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.

sort
string or null

The field to sort results by. A property name with a prepended '-' signifies descending order.

Enum: "id" "-id" "engine_id" "-engine_id" "namespace" "-namespace" "name" "-name" "dataset_id" "-dataset_id" "creation_type" "-creation_type" "parent_snapshot_id" "-parent_snapshot_id" "parent_point_location" "-parent_point_location" "parent_point_timestamp" "-parent_point_timestamp" "parent_point_timeflow_id" "-parent_point_timeflow_id" "source_data_timestamp" "-source_data_timestamp" "oracle_incarnation_id" "-oracle_incarnation_id" "oracle_cdb_timeflow_id" "-oracle_cdb_timeflow_id" "oracle_tde_uuid" "-oracle_tde_uuid" "mssql_database_guid" "-mssql_database_guid" "creation_timestamp" "-creation_timestamp" "activation_timestamp" "-activation_timestamp" "parent_vdb_id" "-parent_vdb_id" "parent_dsource_id" "-parent_dsource_id" "source_vdb_id" "-source_vdb_id" "source_dsource_id" "-source_dsource_id"
Example: sort=id
Responses
200

OK

get/timeflows
Response samples
application/json
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Get a Timeflow by ID.

SecurityApiKeyAuth
Request
path Parameters
timeflowId
required
string non-empty

The ID of the timeflow.

Responses
200

OK

get/timeflows/{timeflowId}
Response samples
application/json
{
  • "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": [
    ]
}

Delete a timeflow.

SecurityApiKeyAuth
Request
path Parameters
timeflowId
required
string non-empty

The ID of the timeflow.

Responses
202

OK

delete/timeflows/{timeflowId}
Response samples
application/json
{
  • "job": {
    }
}

Update values of a timeflow.

SecurityApiKeyAuth
Request
path Parameters
timeflowId
required
string non-empty

The ID of the timeflow.

Request Body schema: application/json

The new data to update a timeflow.

name
string [ 1 .. 1024 ] characters

The name of the timeflow.

Responses
202

OK

patch/timeflows/{timeflowId}
Request samples
application/json
{
  • "name": "Latest on parent refresh #02"
}
Response samples
application/json
{
  • "job": {
    }
}

Returns the count of TimeFlow snapshots of the Timeflow aggregated by day.

SecurityApiKeyAuth
Request
path Parameters
timeflowId
required
string non-empty

The ID of the timeflow.

query Parameters
timezone
string

The timezone in which the snapshot timestamps are to be interpreted. This property gets precedence over timezone_offset. If the timezone in this property is unknown to the application, the timezone_offset is used as fallback to interpret the snapshot timestamps.

timezone_offset
integer [ -64800 .. 64800 ]

The offset in seconds of timezone in which the snapshot timestamps are to be interpreted. This property is used as fallback to interpret the snapshot timestamps if timezone is not valid.

Responses
200

OK

get/timeflows/{timeflowId}/timeflowSnapshotDayRange
Response samples
application/json
{
  • "items": [
    ]
}

Get tags for a Timeflow.

SecurityApiKeyAuth
Request
path Parameters
timeflowId
required
string non-empty

The ID of the timeflow.

Responses
200

Ok

get/timeflows/{timeflowId}/tags
Response samples
application/json
{
  • "tags": [
    ]
}

Create tags for a Timeflow.

SecurityApiKeyAuth
Request
path Parameters
timeflowId
required
string non-empty

The ID of the timeflow.

Request Body schema: application/json
required

Tags information for Timeflow.

required
Array of objects (Tag) [ 1 .. 1000 ] items unique

Array of tags with key value pairs

Responses
201

Created

post/timeflows/{timeflowId}/tags
Request samples
application/json
{
  • "tags": [
    ]
}
Response samples
application/json
{
  • "tags": [
    ]
}

Delete tags for a Timeflow.

SecurityApiKeyAuth
Request
path Parameters
timeflowId
required
string non-empty

The ID of the timeflow.

Request Body schema: application/json

The parameters to delete tags

key
string [ 1 .. 4000 ] characters

Key of the tag

value
string [ 1 .. 4000 ] characters

Value of the tag

Array of objects (Tag) [ 1 .. 1000 ] items unique

List of tags to be deleted

Responses
204

No Content

post/timeflows/{timeflowId}/tags/delete
Request samples
application/json

Delete all tags for given object - No request body required

{ }

Search timeflows.

SecurityApiKeyAuth
Request
query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

Example: limit=50
cursor
string [ 1 .. 4096 ] characters

Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.

sort
string or null

The field to sort results by. A property name with a prepended '-' signifies descending order.

Enum: "id" "-id" "engine_id" "-engine_id" "namespace" "-namespace" "name" "-name" "dataset_id" "-dataset_id" "creation_type" "-creation_type" "parent_snapshot_id" "-parent_snapshot_id" "parent_point_location" "-parent_point_location" "parent_point_timestamp" "-parent_point_timestamp" "parent_point_timeflow_id" "-parent_point_timeflow_id" "source_data_timestamp" "-source_data_timestamp" "oracle_incarnation_id" "-oracle_incarnation_id" "oracle_cdb_timeflow_id" "-oracle_cdb_timeflow_id" "oracle_tde_uuid" "-oracle_tde_uuid" "mssql_database_guid" "-mssql_database_guid" "creation_timestamp" "-creation_timestamp" "activation_timestamp" "-activation_timestamp" "parent_vdb_id" "-parent_vdb_id" "parent_dsource_id" "-parent_dsource_id" "source_vdb_id" "-source_vdb_id" "source_dsource_id" "-source_dsource_id"
Example: sort=id
Request Body schema: application/json

A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension.

Filter Expression Overview

Note: All keywords are case-insensitive

Comparison Operators

Operator Description Example
CONTAINS Substring or membership testing for string and list attributes respectively. field3 CONTAINS 'foobar', field4 CONTAINS TRUE
IN Tests if field is a member of a list literal. List can contain a maximum of 100 values field2 IN ['Goku', 'Vegeta']
GE Tests if a field is greater than or equal to a literal value field1 GE 1.2e-2
GT Tests if a field is greater than a literal value field1 GT 1.2e-2
LE Tests if a field is less than or equal to a literal value field1 LE 9000
LT Tests if a field is less than a literal value field1 LT 9.02
NE Tests if a field is not equal to a literal value field1 NE 42
EQ Tests if a field is equal to a literal value field1 EQ 42

Search Operator

The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically SEARCH '12' would match an item with an attribute with an integer value of 123.

Logical Operators

Ordered by precedence.

Operator Description Example
NOT Logical NOT (Right associative) NOT field1 LE 9000
AND Logical AND (Left Associative) field1 GT 9000 AND field2 EQ 'Goku'
OR Logical OR (Left Associative) field1 GT 9000 OR field2 EQ 'Goku'

Grouping

Parenthesis () can be used to override operator precedence.

For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo')

Literal Values

Literal Description Examples
Nil Represents the absence of a value nil, Nil, nIl, NIL
Boolean true/false boolean true, false, True, False, TRUE, FALSE
Number Signed integer and floating point numbers. Also supports scientific notation. 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2
String Single or double quoted "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar'
Datetime Formatted according to RFC3339 2018-04-27T18:39:26.397237+00:00
List Comma-separated literals wrapped in square brackets [0], [0, 1], ['foo', "bar"]

Limitations

  • A maximum of 8 unique identifiers may be used inside a filter expression.
filter_expression
string [ 5 .. 50000 ] characters
Responses
200

OK

post/timeflows/search
Request samples
application/json

An example of a nested Object comparison testing that at least one repository has a version which is equal to 19.0.0.

{
  • "filter_expression": "repositories CONTAINS {version eq '19.0.0'}"
}
Response samples
application/json
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Repair a Timeflow.

SecurityApiKeyAuth
Request
path Parameters
timeflowId
required
string non-empty

The ID of the timeflow.

Request Body schema: application/json
required

Timeflow repair information.

host
required
string [ 1 .. 256 ] characters

Hostname of the remote host.

port
integer <int32> [ 1 .. 65535 ]
Default: 22

Port to connect to remote host.

username
required
string [ 1 .. 256 ] characters

Username to connect to remote host.

directory
required
string [ 1 .. 2048 ] characters

Location of the missing logs on the host.

start_location
required
string [ 1 .. 20 ] characters

The database specific identifier specifying the start location of the missing log.

end_location
required
string [ 1 .. 20 ] characters

The database specific identifier specifying the end location of the missing log.

use_engine_public_key
boolean

Whether to use public key authentication.

password
string [ 1 .. 255 ] characters

The password of the user to connect to remote host machine.

key_pair_private_key
string [ 1 .. 256 ] characters

The private key of the key pair credentials.

key_pair_public_key
string [ 1 .. 256 ] characters

The public key of the key pair credentials.

vault_id
string [ 1 .. 256 ] characters

The DCT id or name of the vault from which to read the host credentials.

hashicorp_vault_engine
string [ 1 .. 256 ] characters

Vault engine name where the credential is stored.

hashicorp_vault_secret_path
string [ 1 .. 256 ] characters

Path in the vault engine where the credential is stored.

hashicorp_vault_username_key
string [ 1 .. 256 ] characters

Key for the username in the key-value store.

hashicorp_vault_secret_key
string [ 1 .. 256 ] characters

Key for the password in the key-value store.

azure_vault_name
string [ 1 .. 256 ] characters

Azure key vault name (ORACLE, ASE and MSSQL_DOMAIN_USER only).

azure_vault_username_key
string [ 1 .. 256 ] characters

Azure vault key for the username in the key-value store (ORACLE, ASE and MSSQL_DOMAIN_USER only).

azure_vault_secret_key
string [ 1 .. 256 ] characters

Azure vault key for the password in the key-value store (ORACLE, ASE and MSSQL_DOMAIN_USER only).

cyberark_vault_query_string
string [ 1 .. 256 ] characters

Query to find a credential in the CyberArk vault.

use_kerberos_authentication
boolean

Whether to use kerberos authentication.

object (SSHVerificationStrategy)

Mechanism to use for ssh host verification.

Responses
200

Ok

post/timeflows/{timeflowId}/repair
Request samples
application/json
{
  • "host": "test.host.com",
  • "port": 22,
  • "username": "username",
  • "directory": "folder1/folder2",
  • "start_location": "123456",
  • "end_location": "654321",
  • "use_engine_public_key": true,
  • "password": "password",
  • "key_pair_private_key": "private key",
  • "key_pair_public_key": "public key",
  • "vault_id": "my-vault",
  • "hashicorp_vault_engine": "kv",
  • "hashicorp_vault_secret_path": "oracle-env",
  • "hashicorp_vault_username_key": "username",
  • "hashicorp_vault_secret_key": "secret",
  • "azure_vault_name": "azure_vault",
  • "azure_vault_username_key": "username",
  • "azure_vault_secret_key": "secret",
  • "cyberark_vault_query_string": "Safe=Test;Folder=Test;Object=Test",
  • "use_kerberos_authentication": true,
  • "sshVerificationStrategy": {
    }
}
Response samples
application/json
{
  • "job": {
    }
}
➔ Next to Environments