Create Task
post
/services/{version}/tasks/{task}
Create a new administrative task.
Request
Supported Media Types
- application/json
Path Parameters
-
task: string
Minimum Length:
1
Maximum Length:64
Pattern:^[A-Za-z0-9][A-Za-z0-9_-]*$
Task name, an alpha-numeric character followed by up to 63 alpha-numeric characters, '_' or '-'.
-
version: string
Oracle GoldenGate Service API version.
Allowed Values:[ "v2" ]
Root Schema : Oracle GoldenGate Task
Type:
object
Title:
Show Source
Oracle GoldenGate Task
-
$schema(optional):
Allowed Values:
[ "ogg:task" ]
-
command(optional):
command
-
critical(optional):
boolean
Default Value:
false
Indicates the task is critical to the deployment -
description(optional):
string
Minimum Length:
1
Maximum Length:4095
A description of the task -
enabled(optional):
boolean
Default Value:
true
Indicates if the task is enabled for execution -
maxHistory(optional):
integer
Minimum Value:
1
Maximum Value:1024
Default Value:10
Number of task executions to maintain history for -
restart(optional):
object restart
Control how the task is restarted if it terminates
-
schedule(optional):
schedule
-
status(optional):
Default Value:
stopped
Allowed Values:[ "starting", "running", "stopped", "killed", "abended" ]
Task Status -
timeout(optional):
integer
Minimum Value:
1
Maximum Value:65535
Amount of time in seconds before a running task is cancelled
Nested Schema : command
Match One
Show Source
-
object command-x-oneOf[0]
Start an Extract or Replicat
-
object command-x-oneOf[1]
Stop an Extract or Replicat
-
object command-x-oneOf[2]
Kill an Extract or Replicat
-
object command-x-oneOf[3]
Execute an Extract or Replicat
-
object command-x-oneOf[4]
Synchronize a Replicat
-
object command-x-oneOf[5]
Execute the Monitor Agent
-
object command-x-oneOf[6]
Report on Processes
-
object command-x-oneOf[7]
Report on Process Lag
-
object command-x-oneOf[8]
Report Operating System and database version information
-
object command-x-oneOf[9]
Lists the schemas in the database with names that match the input specification
-
object command-x-oneOf[10]
Lists the tables in the database with names that match the input specification
-
object command-x-oneOf[11]
Lists the checkpoint tables in the database with names that match the input specification
-
object command-x-oneOf[12]
Lists the containers in the database with names that match the input specification
-
object command-x-oneOf[13]
Purge checkpoint history for ER processes
-
object command-x-oneOf[14]
-
object command-x-oneOf[15]
Purge trail files no longer needed
-
object command-x-oneOf[16]
Purge Extract or Replicat tasks
-
object command-x-oneOf[17]
Purge files no longer needed
-
object command-x-oneOf[18]
Updates a database sequence so that initial redo records are available at the time that Extract starts capturing transaction data after the instantiation of the replication environment.
Nested Schema : restart
Type:
object
Control how the task is restarted if it terminates
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:taskRestart" ]
-
delay(optional):
integer
Minimum Value:
0
Maximum Value:3600
Default Value:120
The amount of time, in seconds, to pause between discovering that a process has terminated abnormally and restarting the process. -
disableOnFailure(optional):
boolean
Default Value:
false
If true, the task is disabled when it fails all execution attempts in an execution window. -
enabled(optional):
boolean
Default Value:
false
If set, the task can be restarted if it terminates. -
failures(optional):
integer
Minimum Value:
0
Maximum Value:3600
The number of times the task failed in the current window. -
onSuccess(optional):
boolean
Default Value:
false
If false, the task is only restarted if it fails. -
retries(optional):
integer
Minimum Value:
0
Maximum Value:3600
Default Value:2
The maximum number of times the task should be restarted before aborting retry efforts. -
window(optional):
integer
Minimum Value:
0
Maximum Value:604800
Default Value:7200
The window of time, in seconds, during which retries are counted.
Nested Schema : schedule
Match One
Show Source
-
Allowed Values:
[ "none" ]
Task is not scheduled -
object schedule-x-oneOf[1]
Task is run on a time-based schedule
-
object schedule-x-oneOf[2]
Task is run on an interval
-
object schedule-x-oneOf[3]
Task is run when the Admin Server starts
Nested Schema : command-x-oneOf[0]
Type:
object
Start an Extract or Replicat
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:command" ]
-
after(optional):
after
Directs Extract/Replicat to position its start point at the beginning of the first transaction after the one that has the specified CSN. Any transactions in the data source that have CSN values that are less than, or equal to, the specified one are skipped.
-
at(optional):
at
Directs Extract/Replicat to position its start point at the transaction that has the specified CSN. Any transactions in the data source that have CSN values less than the specified one are skipped.
-
filterDuplicates(optional):
boolean
Default Value:
true
Causes Replicat to ignore transactions that it has already processed. Use when Extract was repositioned to a new start point (using the ATCSN or AFTERCSN) and you are confident that there are duplicate transactions in the trail that could cause Replicat to abend. This option requires the use of a checkpoint table. If the database is Oracle, this option is valid only for Replicat in nonintegrated mode. Integrated mode handles duplicate transactions transparently. The default is true. -
name(optional):
Allowed Values:
[ "start" ]
-
processName(optional):
string
Minimum Length:
1
Maximum Length:8
Pattern:^[*A-Z_$][*A-Z0-9_$]*$
-
processType(optional):
Default Value:
ER
Allowed Values:[ "extract", "replicat", "ER" ]
-
skipTransaction(optional):
boolean
Default Value:
false
Causes Replicat to skip the first transaction after its expected startup position in the trail. All operations from that first transaction are excluded. -
threads(optional):
array threads
Minimum Number of Items:
1
Maximum Number of Items:500
Valid when used with 'skipTransaction', 'at', or 'after' with Replicat in coordinated mode. Starts the specified Replicat thread or threads at the specified location.
Match All
Show Source
Nested Schema : command-x-oneOf[1]
Type:
object
Stop an Extract or Replicat
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:command" ]
-
force(optional):
boolean
Default Value:
false
-
name:
Allowed Values:
[ "stop" ]
-
processName:
string
Minimum Length:
1
Maximum Length:8
Pattern:^[*A-Z_$][*A-Z0-9_$]*$
-
processType(optional):
Default Value:
ER
Allowed Values:[ "extract", "replicat", "ER" ]
Nested Schema : command-x-oneOf[2]
Type:
object
Kill an Extract or Replicat
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:command" ]
-
name:
Allowed Values:
[ "kill" ]
-
processName:
string
Minimum Length:
1
Maximum Length:8
Pattern:^[*A-Z_$][*A-Z0-9_$]*$
-
processType(optional):
Default Value:
ER
Allowed Values:[ "extract", "replicat", "ER" ]
Nested Schema : command-x-oneOf[3]
Type:
object
Execute an Extract or Replicat
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:command" ]
-
name:
Allowed Values:
[ "execute" ]
-
processName:
string
Minimum Length:
1
Maximum Length:8
Pattern:^[A-Z_$][A-Z0-9_$]*$
-
processType(optional):
Default Value:
ER
Allowed Values:[ "extract", "replicat", "ER" ]
Nested Schema : command-x-oneOf[4]
Type:
object
Synchronize a Replicat
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:command" ]
-
name:
Allowed Values:
[ "synchronize" ]
-
processName:
string
Minimum Length:
1
Maximum Length:8
Pattern:^[*A-Z_$][*A-Z0-9_$]*$
-
processType(optional):
Allowed Values:
[ "replicat" ]
Nested Schema : command-x-oneOf[5]
Type:
object
Execute the Monitor Agent
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:command" ]
-
name:
Allowed Values:
[ "execute" ]
-
processName:
Allowed Values:
[ "Monitor Agent" ]
Nested Schema : command-x-oneOf[6]
Type:
object
Report on Processes
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:command" ]
-
name:
Allowed Values:
[ "report" ]
-
reportType:
Allowed Values:
[ "up", "down" ]
Nested Schema : command-x-oneOf[7]
Type:
object
Report on Process Lag
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:command" ]
-
name:
Allowed Values:
[ "report" ]
-
reportType:
Allowed Values:
[ "lag" ]
-
thresholds:
array thresholds
Minimum Number of Items:
1
Maximum Number of Items:2
Nested Schema : command-x-oneOf[8]
Type:
object
Report Operating System and database version information
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:command" ]
-
credentials(optional):
credentials
Credentials for database
-
name:
Allowed Values:
[ "report" ]
-
reportType:
Allowed Values:
[ "versions" ]
Nested Schema : command-x-oneOf[9]
Type:
object
Lists the schemas in the database with names that match the input specification
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:command" ]
-
credentials:
object credentials
Credentials for database
-
name:
Allowed Values:
[ "report" ]
-
qualified(optional):
boolean
Default Value:
true
If true, returned schema names are fully qualified -
reportType:
Allowed Values:
[ "schemas" ]
-
specification:
specification
The name of a schema which can include wildcard characters
Nested Schema : command-x-oneOf[10]
Type:
object
Lists the tables in the database with names that match the input specification
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:command" ]
-
credentials:
object credentials
Credentials for database
-
name:
Allowed Values:
[ "report" ]
-
qualified(optional):
boolean
Default Value:
true
If true, returned table names are fully qualified -
reportType:
Allowed Values:
[ "tables" ]
-
specification:
specification
The name of a table or a group of tables which can include wildcard characters
-
tableType(optional):
Default Value:
any
Allowed Values:[ "any", "checkpoint", "trace" ]
The type of table to list
Nested Schema : command-x-oneOf[11]
Type:
object
Lists the checkpoint tables in the database with names that match the input specification
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:command" ]
-
credentials:
object credentials
Credentials for database
-
name:
Allowed Values:
[ "report" ]
-
reportType:
Allowed Values:
[ "checkpointTables" ]
-
specification:
specification
The name of a checkpoint table or a group of checkpoint tables which can include wildcard characters
Nested Schema : command-x-oneOf[12]
Type:
object
Lists the containers in the database with names that match the input specification
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:command" ]
-
credentials:
object credentials
Credentials for database
-
name:
Allowed Values:
[ "report" ]
-
reportType:
Allowed Values:
[ "containers" ]
-
specification:
string
Minimum Length:
1
Maximum Length:130
Pattern:^([^."]{1,128}|["].{1,128}["])$
The name of a container or a group of containers which can include wildcard characters
Nested Schema : command-x-oneOf[13]
Type:
object
Purge checkpoint history for ER processes
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:command" ]
-
keep:
array keep
Minimum Number of Items:
1
Maximum Number of Items:1
-
name:
Allowed Values:
[ "purge" ]
-
processName:
string
Minimum Length:
1
Maximum Length:8
Pattern:^[*A-Z_$][*A-Z0-9_$]*$
-
processType(optional):
Default Value:
ER
Allowed Values:[ "extract", "replicat", "ER" ]
-
purgeType:
Allowed Values:
[ "checkpoints" ]
Nested Schema : command-x-oneOf[14]
Type:
Show Source
object
-
$schema(optional):
Allowed Values:
[ "ogg:command" ]
-
credentials:
object credentials
Credentials for database
-
keep:
array keep
Minimum Number of Items:
1
Maximum Number of Items:2
-
name:
Allowed Values:
[ "purge" ]
-
purgeType:
Allowed Values:
[ "ddlHistory", "ddlHistoryAlt", "markerHistory" ]
Nested Schema : command-x-oneOf[15]
Type:
object
Purge trail files no longer needed
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:command" ]
-
keep:
array keep
Minimum Number of Items:
1
Maximum Number of Items:1
-
name:
Allowed Values:
[ "purge" ]
-
purgeType:
Allowed Values:
[ "trails" ]
-
trails:
array trails
Minimum Number of Items:
1
Maximum Number of Items:1024
Trails to purge -
useCheckpoints(optional):
boolean
Default Value:
true
Nested Schema : command-x-oneOf[16]
Type:
object
Purge Extract or Replicat tasks
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:command" ]
-
keep:
array keep
Minimum Number of Items:
1
Maximum Number of Items:1
-
name:
Allowed Values:
[ "purge" ]
-
processName:
string
Minimum Length:
1
Maximum Length:8
Pattern:^[*A-Z_$][*A-Z0-9_$]*$
-
processType(optional):
Default Value:
ER
Allowed Values:[ "extract", "replicat", "ER" ]
-
purgeType:
Allowed Values:
[ "tasks" ]
-
useStatus(optional):
boolean
Default Value:
false
Nested Schema : command-x-oneOf[17]
Type:
object
Purge files no longer needed
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:command" ]
-
dumpFiles(optional):
boolean
Default Value:
false
Purge dump files (*.dmp) which are generated when an application abnormally terminates -
keep:
array keep
Minimum Number of Items:
1
Maximum Number of Items:1
-
name:
Allowed Values:
[ "purge" ]
-
purgeType:
Allowed Values:
[ "files" ]
Nested Schema : command-x-oneOf[18]
Type:
object
Updates a database sequence so that initial redo records are available at the time that Extract starts capturing transaction data after the instantiation of the replication environment.
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:command" ]
-
credentials:
object credentials
Credentials for database
-
name:
Allowed Values:
[ "flushSequence" ]
-
sequence:
sequence
The owner and name of a database sequence. The schema name cannot be null. You can use wildcard characters for the sequence name but not for the owner name.
-
trace(optional):
boolean
Default Value:
false
Whether to call the sql procedure to update the sequence with tracing mode on
Nested Schema : after
Directs Extract/Replicat to position its start point at the beginning of the first transaction after the one that has the specified CSN. Any transactions in the data source that have CSN values that are less than, or equal to, the specified one are skipped.
Match One
Show Source
Nested Schema : at
Directs Extract/Replicat to position its start point at the transaction that has the specified CSN. Any transactions in the data source that have CSN values less than the specified one are skipped.
Match One
Show Source
Nested Schema : threads
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
500
Valid when used with 'skipTransaction', 'at', or 'after' with Replicat in coordinated mode. Starts the specified Replicat thread or threads at the specified location.
Show Source
-
Array of:
integer
Minimum Value:
1
Maximum Value:500
Nested Schema : thresholds
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
Show Source
2
Nested Schema : items
Type:
Show Source
object
-
type:
Allowed Values:
[ "info", "critical" ]
-
units:
units
-
value:
integer
Minimum Value:
0
Maximum Value:65535
Nested Schema : credentials
Credentials for database
Default Value:
oracle.doceng.json.BetterJsonNull@575cabf0
Match One
Show Source
Nested Schema : credentials-x-oneOf[0]
Type:
Show Source
object
-
$schema(optional):
Allowed Values:
[ "ogg:credentialsRef" ]
-
alias:
string
Minimum Length:
1
Maximum Length:30
Pattern:^[a-zA-Z][a-zA-Z0-9_#$]*$
-
domain(optional):
string
Minimum Length:
1
Maximum Length:30
Default Value:OracleGoldenGate
Pattern:^[a-zA-Z][a-zA-Z0-9_#$]*$
Nested Schema : credentials
Type:
object
Credentials for database
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:credentialsRef" ]
-
alias:
string
Minimum Length:
1
Maximum Length:30
Pattern:^[a-zA-Z][a-zA-Z0-9_#$]*$
-
domain(optional):
string
Minimum Length:
1
Maximum Length:30
Default Value:OracleGoldenGate
Pattern:^[a-zA-Z][a-zA-Z0-9_#$]*$
Nested Schema : specification
The name of a schema which can include wildcard characters
Match Any
Show Source
Nested Schema : credentials
Type:
object
Credentials for database
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:credentialsRef" ]
-
alias:
string
Minimum Length:
1
Maximum Length:30
Pattern:^[a-zA-Z][a-zA-Z0-9_#$]*$
-
domain(optional):
string
Minimum Length:
1
Maximum Length:30
Default Value:OracleGoldenGate
Pattern:^[a-zA-Z][a-zA-Z0-9_#$]*$
Nested Schema : specification
The name of a table or a group of tables which can include wildcard characters
Match Any
Show Source
Nested Schema : credentials
Type:
object
Credentials for database
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:credentialsRef" ]
-
alias:
string
Minimum Length:
1
Maximum Length:30
Pattern:^[a-zA-Z][a-zA-Z0-9_#$]*$
-
domain(optional):
string
Minimum Length:
1
Maximum Length:30
Default Value:OracleGoldenGate
Pattern:^[a-zA-Z][a-zA-Z0-9_#$]*$
Nested Schema : specification
The name of a checkpoint table or a group of checkpoint tables which can include wildcard characters
Match Any
Show Source
Nested Schema : credentials
Type:
object
Credentials for database
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:credentialsRef" ]
-
alias:
string
Minimum Length:
1
Maximum Length:30
Pattern:^[a-zA-Z][a-zA-Z0-9_#$]*$
-
domain(optional):
string
Minimum Length:
1
Maximum Length:30
Default Value:OracleGoldenGate
Pattern:^[a-zA-Z][a-zA-Z0-9_#$]*$
Nested Schema : items
Type:
Show Source
object
-
type:
Allowed Values:
[ "max" ]
-
units:
units
-
value:
integer
Minimum Value:
1
Maximum Value:500
Nested Schema : credentials
Type:
object
Credentials for database
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:credentialsRef" ]
-
alias:
string
Minimum Length:
1
Maximum Length:30
Pattern:^[a-zA-Z][a-zA-Z0-9_#$]*$
-
domain(optional):
string
Minimum Length:
1
Maximum Length:30
Default Value:OracleGoldenGate
Pattern:^[a-zA-Z][a-zA-Z0-9_#$]*$
Nested Schema : items
Match One
Show Source
-
object items-x-oneOf[0]
Minimum number of hours
-
object items-x-oneOf[1]
Maximum number of hours
-
object items-x-oneOf[2]
Minimum number of days
-
object items-x-oneOf[3]
Maximum number of days
Nested Schema : items-x-oneOf[0]
Type:
object
Minimum number of hours
Show Source
-
type:
Allowed Values:
[ "min" ]
-
units:
Allowed Values:
[ "hours" ]
-
value:
integer
Minimum Value:
1
Maximum Value:1000
Allowed value for hours value
Nested Schema : items-x-oneOf[1]
Type:
object
Maximum number of hours
Show Source
-
type:
Allowed Values:
[ "max" ]
-
units:
Allowed Values:
[ "hours" ]
-
value:
integer
Minimum Value:
1
Maximum Value:1000
Allowed value for hours value
Nested Schema : items-x-oneOf[2]
Type:
object
Minimum number of days
Show Source
-
type:
Allowed Values:
[ "min" ]
-
units:
Allowed Values:
[ "days" ]
-
value:
integer
Minimum Value:
1
Maximum Value:365
Allowed value for days value
Nested Schema : items-x-oneOf[3]
Type:
object
Maximum number of days
Show Source
-
type:
Allowed Values:
[ "max" ]
-
units:
Allowed Values:
[ "days" ]
-
value:
integer
Minimum Value:
1
Maximum Value:365
Allowed value for days value
Nested Schema : trails
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
1024
Trails to purge
Show Source
Nested Schema : items
Match One
Show Source
-
object items-x-oneOf[0]
Minimum number of hours
-
object items-x-oneOf[1]
Minimum number of days
-
object items-x-oneOf[2]
Minimum number of files
Nested Schema : items-x-oneOf[0]
Type:
object
Minimum number of hours
Show Source
-
type:
Allowed Values:
[ "min" ]
-
units:
Allowed Values:
[ "hours" ]
-
value:
integer
Minimum Value:
1
Maximum Value:1000
Allowed value for hours value
Nested Schema : items-x-oneOf[1]
Type:
object
Minimum number of days
Show Source
-
type:
Allowed Values:
[ "min" ]
-
units:
Allowed Values:
[ "days" ]
-
value:
integer
Minimum Value:
1
Maximum Value:365
Allowed value for days value
Nested Schema : items-x-oneOf[2]
Type:
object
Minimum number of files
Show Source
-
type:
Allowed Values:
[ "min" ]
-
units:
Allowed Values:
[ "files" ]
-
value:
integer
Minimum Value:
0
Maximum Value:100
Nested Schema : items
Type:
Show Source
object
-
name:
string
Minimum Length:
1
Maximum Length:2
Pattern:^[A-Za-z*][A-Za-z0-9*]?$
The name of the trail, wildcards allowed -
path(optional):
string
Minimum Length:
1
Maximum Length:4096
The path where trail data is stored
Nested Schema : items
Match One
Show Source
-
object items-x-oneOf[0]
Minimum number of hours
-
object items-x-oneOf[1]
Minimum number of days
Nested Schema : items-x-oneOf[0]
Type:
object
Minimum number of hours
Show Source
-
type:
Allowed Values:
[ "min" ]
-
units:
Allowed Values:
[ "hours" ]
-
value:
integer
Minimum Value:
1
Maximum Value:1000
Allowed value for hours value
Nested Schema : items-x-oneOf[1]
Type:
object
Minimum number of days
Show Source
-
type:
Allowed Values:
[ "min" ]
-
units:
Allowed Values:
[ "days" ]
-
value:
integer
Minimum Value:
1
Maximum Value:365
Allowed value for days value
Nested Schema : items
Match One
Show Source
-
object items-x-oneOf[0]
Minimum number of hours
-
object items-x-oneOf[1]
Minimum number of days
Nested Schema : items-x-oneOf[0]
Type:
object
Minimum number of hours
Show Source
-
type:
Allowed Values:
[ "min" ]
-
units:
Allowed Values:
[ "hours" ]
-
value:
integer
Minimum Value:
1
Maximum Value:1000
Allowed value for hours value
Nested Schema : items-x-oneOf[1]
Type:
object
Minimum number of days
Show Source
-
type:
Allowed Values:
[ "min" ]
-
units:
Allowed Values:
[ "days" ]
-
value:
integer
Minimum Value:
1
Maximum Value:365
Allowed value for days value
Nested Schema : credentials
Type:
object
Credentials for database
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:credentialsRef" ]
-
alias:
string
Minimum Length:
1
Maximum Length:30
Pattern:^[a-zA-Z][a-zA-Z0-9_#$]*$
-
domain(optional):
string
Minimum Length:
1
Maximum Length:30
Default Value:OracleGoldenGate
Pattern:^[a-zA-Z][a-zA-Z0-9_#$]*$
Nested Schema : sequence
The owner and name of a database sequence. The schema name cannot be null. You can use wildcard characters for the sequence name but not for the owner name.
Match Any
Show Source
-
string
Minimum Length:
1
Maximum Length:130
Pattern:^([^."]{1,128}|["].{1,128}["])$
-
string
Minimum Length:
3
Maximum Length:261
Pattern:^([^.*?"]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
-
string
Minimum Length:
5
Maximum Length:392
Pattern:^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
Nested Schema : schedule-x-oneOf[1]
Type:
object
Task is run on a time-based schedule
Show Source
-
days:
days
Days of the week to run the task
-
times:
array times
Minimum Number of Items:
1
Maximum Number of Items:1440
Array of times to run task in 24 hour format HH:MM
Nested Schema : schedule-x-oneOf[3]
Type:
object
Task is run when the Admin Server starts
Show Source
-
autoStart:
Allowed Values:
[ true ]
Indicates task starts with Admin Server -
delay(optional):
integer
Minimum Value:
0
Maximum Value:3600
Default Value:0
Time to wait in seconds before starting task
Nested Schema : days
Days of the week to run the task
Match One
Show Source
-
Allowed Values:
[ "every" ]
-
Allowed Values:
[ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ]
-
array days-x-oneOf[2]
Minimum Number of Items:
1
Maximum Number of Items:7
Nested Schema : times
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
1440
Array of times to run task in 24 hour format HH:MM
Show Source
-
Array of:
string
Minimum Length:
5
Maximum Length:5
Pattern:([01][0-9]|2[0-3]):[0-5][0-9]
Nested Schema : days-x-oneOf[2]
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
Show Source
7
-
Array of:
Allowed Values:
[ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ]
Nested Schema : every
Type:
Show Source
object
-
units:
units
-
value:
integer
Minimum Value:
0
Maximum Value:1024
Example Request (application/json)
{
"description":"Check critical lag every hour",
"enabled":false,
"schedule":{
"every":{
"units":"hours",
"value":1
}
},
"command":{
"name":"report",
"reportType":"lag",
"thresholds":[
{
"type":"critical",
"units":"seconds",
"value":5
}
]
}
}
Response
Supported Media Types
- application/json
201 Response
Task created successfully.
Root Schema : RESTful API Standard Response
Type:
object
Title:
RESTful API Standard Response
Standard Response for all Oracle GoldenGate RESTful API calls
Show Source
-
$schema(optional):
Allowed Values:
[ "api:standardResponse" ]
-
links:
array links
Minimum Number of Items:
0
Maximum Number of Items:16
Oracle GoldenGate links for the request -
messages:
array messages
Minimum Number of Items:
0
Maximum Number of Items:65535
Oracle GoldenGate messages issued during the request -
response(optional):
object response
Oracle GoldenGate document from the request
Nested Schema : links
Type:
array
Minimum Number of Items:
0
Maximum Number of Items:
16
Oracle GoldenGate links for the request
Show Source
Nested Schema : messages
Type:
array
Minimum Number of Items:
0
Maximum Number of Items:
65535
Oracle GoldenGate messages issued during the request
Show Source
Nested Schema : response
Type:
object
Oracle GoldenGate document from the request
Nested Schema : items
Type:
Show Source
object
-
$schema(optional):
Allowed Values:
[ "ogg:link" ]
-
description(optional):
string
Minimum Length:
1
Maximum Length:4095
A human-readable description that provides information and detail specific to this link. -
href:
string
Minimum Length:
2
Maximum Length:4095
Pattern:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
An absolute URI for the link -
mediaType(optional):
string
Minimum Length:
6
Maximum Length:255
Pattern:^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$
Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288) -
rel:
Allowed Values:
[ "alternate", "canonical", "current", "describedby", "describes", "enclosure", "parent", "related", "self", "first", "last", "next", "previous" ]
Relationship of href to the requested link
Nested Schema : items
Type:
Show Source
object
-
$schema(optional):
Allowed Values:
[ "ogg:message" ]
-
code:
string
Minimum Length:
9
Maximum Length:9
Pattern:^OGG[-][0-9]{5}$
The Oracle GoldenGate message code -
issued:
string
Minimum Length:
20
Maximum Length:32
Pattern:^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$
The date and time that the message was issued -
severity:
Allowed Values:
[ "INFO", "WARNING", "ERROR" ]
The severity of the message -
title:
string
Minimum Length:
1
Maximum Length:4095
A human-readable description that provides information and detail specific to this occurence of the information, warning or error. -
type:
string
Minimum Length:
2
Maximum Length:4095
Pattern:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
An absolute URI [RFC3986] to a page that describes the info, warning or error type.
Example Response (application/json)
{
"$schema":"api:standardResponse",
"links":[
{
"href":"http://localhost:11001/services/v2/tasks/ReportLag",
"mediaType":"application/json",
"rel":"canonical"
},
{
"href":"http://localhost:11001/services/v2/tasks/ReportLag",
"mediaType":"application/json",
"rel":"self"
}
],
"messages":[
]
}