1. Oracle GoldenGate 19c Microservices Architecture REST API
  2. Tasks
  3. Administrative Server
  4. Tasks

Retrieve Task

get

/services/{version}/tasks/{task}

Retrieve the details for a task.

Request

Path Parameters
  • 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 '-'.

  • Oracle GoldenGate Service API version.

    Allowed Values: [ "v2" ]
Back to Top

Response

Supported Media Types

200 Response

Task details retrieved successfully.

Body ()
Root Schema : Oracle GoldenGate Task
Type: object
Title: Oracle GoldenGate Task
Show Source
Nested Schema : command
Match One
Show Source
Nested Schema : restart
Type: object
Control how the task is restarted if it terminates
Show Source
Nested Schema : schedule
Match One
Show Source
Nested Schema : command-x-oneOf[0]
Type: object
Start an Extract or Replicat
Show Source
  • Allowed Values: [ "ogg:command" ]
  • 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
    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.
  • 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.
  • Allowed Values: [ "start" ]
  • Minimum Length: 1
    Maximum Length: 8
    Pattern: ^[*A-Z_$][*A-Z0-9_$]*$
  • Default Value: ER
    Allowed Values: [ "extract", "replicat", "ER" ]
  • 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
    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
Nested Schema : command-x-oneOf[2]
Type: object
Kill an Extract or Replicat
Show Source
Nested Schema : command-x-oneOf[3]
Type: object
Execute an Extract or Replicat
Show Source
Nested Schema : command-x-oneOf[4]
Type: object
Synchronize a Replicat
Show Source
Nested Schema : command-x-oneOf[5]
Type: object
Execute the Monitor Agent
Show Source
Nested Schema : command-x-oneOf[6]
Type: object
Report on Processes
Show Source
Nested Schema : command-x-oneOf[7]
Type: object
Report on Process Lag
Show Source
Nested Schema : command-x-oneOf[8]
Type: object
Report Operating System and database version information
Show Source
Nested Schema : command-x-oneOf[9]
Type: object
Lists the schemas in the database with names that match the input specification
Show Source
Nested Schema : command-x-oneOf[10]
Type: object
Lists the tables in the database with names that match the input specification
Show Source
Nested Schema : command-x-oneOf[11]
Type: object
Lists the checkpoint tables in the database with names that match the input specification
Show Source
Nested Schema : command-x-oneOf[12]
Type: object
Lists the containers in the database with names that match the input specification
Show Source
Nested Schema : command-x-oneOf[13]
Type: object
Purge checkpoint history for ER processes
Show Source
Nested Schema : command-x-oneOf[14]
Type: object
Show Source
Nested Schema : command-x-oneOf[15]
Type: object
Purge trail files no longer needed
Show Source
Nested Schema : command-x-oneOf[16]
Type: object
Purge Extract or Replicat tasks
Show Source
Nested Schema : command-x-oneOf[17]
Type: object
Purge files no longer needed
Show Source
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
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
  • Minimum Value: 0
    Maximum Value: 9.223372036854776E18
    Normal format
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: [0-9]+[.][0-9]+
    Alternate format
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
  • Minimum Value: 0
    Maximum Value: 9.223372036854776E18
    Normal format
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: [0-9]+[.][0-9]+
    Alternate format
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
Nested Schema : command-x-oneOf[0]-allOf[5]
Match Any
Show Source
Nested Schema : thresholds
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 2
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : units
Match One
Show Source
  • Allowed Values: [ "seconds" ]
  • Allowed Values: [ "minutes" ]
  • Allowed Values: [ "hours" ]
Nested Schema : credentials
Credentials for database
Default Value: oracle.doceng.json.BetterJsonNull@575cabf0
Match One
Show Source
Nested Schema : credentials-x-oneOf[0]
Type: object
Show Source
Nested Schema : credentials
Type: object
Credentials for database
Show Source
Nested Schema : specification
The name of a schema which can include wildcard characters
Match Any
Show Source
  • Minimum Length: 1
    Maximum Length: 130
    Pattern: ^([^."]{1,128}|["].{1,128}["])$
  • Minimum Length: 3
    Maximum Length: 261
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
Nested Schema : credentials
Type: object
Credentials for database
Show Source
Nested Schema : specification
The name of a table or a group of tables which can include wildcard characters
Match Any
Show Source
  • Minimum Length: 3
    Maximum Length: 261
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
  • Minimum Length: 5
    Maximum Length: 392
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
Nested Schema : credentials
Type: object
Credentials for database
Show Source
Nested Schema : specification
The name of a checkpoint table or a group of checkpoint tables which can include wildcard characters
Match Any
Show Source
  • Minimum Length: 3
    Maximum Length: 261
    Pattern: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
  • Minimum Length: 5
    Maximum Length: 392
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
Nested Schema : credentials
Type: object
Credentials for database
Show Source
Nested Schema : keep
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 1
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : units
Match One
Show Source
  • Allowed Values: [ "checkpoints" ]
Nested Schema : credentials
Type: object
Credentials for database
Show Source
Nested Schema : keep
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 2
Show Source
Nested Schema : items
Match One
Show Source
Nested Schema : items-x-oneOf[0]
Type: object
Minimum number of hours
Show Source
  • Allowed Values: [ "min" ]
  • Allowed Values: [ "hours" ]
  • 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
  • Allowed Values: [ "max" ]
  • Allowed Values: [ "hours" ]
  • 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
Nested Schema : items-x-oneOf[3]
Type: object
Maximum number of days
Show Source
Nested Schema : keep
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 1
Show Source
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
Nested Schema : items-x-oneOf[0]
Type: object
Minimum number of hours
Show Source
  • Allowed Values: [ "min" ]
  • Allowed Values: [ "hours" ]
  • 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
Nested Schema : items-x-oneOf[2]
Type: object
Minimum number of files
Show Source
Nested Schema : items
Type: object
Show Source
  • Minimum Length: 1
    Maximum Length: 2
    Pattern: ^[A-Za-z*][A-Za-z0-9*]?$
    The name of the trail, wildcards allowed
  • Minimum Length: 1
    Maximum Length: 4096
    The path where trail data is stored
Nested Schema : keep
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 1
Show Source
Nested Schema : items
Match One
Show Source
Nested Schema : items-x-oneOf[0]
Type: object
Minimum number of hours
Show Source
  • Allowed Values: [ "min" ]
  • Allowed Values: [ "hours" ]
  • 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
Nested Schema : keep
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 1
Show Source
Nested Schema : items
Match One
Show Source
Nested Schema : items-x-oneOf[0]
Type: object
Minimum number of hours
Show Source
  • Allowed Values: [ "min" ]
  • Allowed Values: [ "hours" ]
  • 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
Nested Schema : credentials
Type: object
Credentials for database
Show Source
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
  • Minimum Length: 1
    Maximum Length: 130
    Pattern: ^([^."]{1,128}|["].{1,128}["])$
  • Minimum Length: 3
    Maximum Length: 261
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
  • 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 of the week to run the task
  • 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[2]
Type: object
Task is run on an interval
Show Source
Nested Schema : schedule-x-oneOf[3]
Type: object
Task is run when the Admin Server starts
Show Source
  • Allowed Values: [ true ]
    Indicates task starts with Admin Server
  • 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" ]
  • 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
  • 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: 7
Show Source
  • Allowed Values: [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ]
Nested Schema : every
Type: object
Show Source
Nested Schema : units
Match One
Show Source
  • Allowed Values: [ "minutes" ]
  • Allowed Values: [ "hours" ]
  • Allowed Values: [ "days" ]
  • Allowed Values: [ "weeks" ]
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"
        },
        {
            "href":"http://localhost:11001/services/v2/metadata-catalog/task",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:task",
        "command":{
            "name":"report",
            "reportType":"lag",
            "thresholds":[
                {
                    "type":"critical",
                    "units":"seconds",
                    "value":5
                }
            ]
        },
        "description":"Check critical lag every hour",
        "enabled":true,
        "restart":{
            "enabled":false
        },
        "schedule":{
            "every":{
                "units":"hours",
                "value":1
            }
        },
        "status":"stopped"
    }
}
Back to Top