1. Oracle GoldenGate Microservices REST APIs
  2. Tasks
  3. Administration Service
  4. Trails

Create Trail

post

/services/{version}/trails/{trail}

Required Role: Administrator

Create a Trail.

Request

Supported Media Types
Path Parameters
  • Minimum Length: 2
    Maximum Length: 512
    Pattern: ^[a-zA-Z0-9_#$-]*$

    The name of the Trail. This corresponds to the trailName property in the ogg:trail resource or the trail filesystem path.

    A trail name can be either a human-friendly name like HumanResources or a two-character name plus a query parameter called 'path' whose value is the URI-encoded trail filesystem path, like ea?path=north%2Femployees. When a short name and a URI-encoded path is used for the trail name, it must match the name and path properties in the corresponding ogg:trail resource.

    A trail called HumanResources with the path/name set to north/employees/ea can be referred to as either HumanResources or ea?path=north%2Femployees, but the canonical name is always the human-friendly name.

    POST operations accept only the human-friendly name.

  • Oracle GoldenGate Service API version.

    Allowed Values: [ "v2" ]
Body ()
Root Schema : Oracle GoldenGate Trail
Type: object
Title: Oracle GoldenGate Trail
Show Source
  • Allowed Values: [ "ogg:trail" ]
  • Minimum Length: 1
    Maximum Length: 4095
    Description for the trail
  • Minimum Length: 2
    Maximum Length: 2
    Pattern: ^[A-Za-z][A-Za-z0-9]$
    The two-character name of the trail
  • Minimum Value: 0
    Maximum Value: 2147483647
    Offset in trail sequence file
  • Minimum Length: 1
    Maximum Length: 4096
    The path where trail data is stored
  • processRef
    Minimum Number of Items: 1
    Maximum Number of Items: 5000
    List of all processes associated with this trail
  • Default Value: false
    Indicates if trail is local or remote
  • Minimum Value: 0
    Maximum Value: 999999999
    Default Value: 0
    Trail beginning sequence number
  • sequenceLastArchived
    Minimum Number of Items: 1
    Maximum Number of Items: 128
    Last sequence number archived (Managed Trails only)
  • Default Value: 9
    Allowed Values: [ "6", "9" ]
    Number of digits in sequence file name
  • Default Value: false
    Indicates sequence number length will change
  • Minimum Value: 0
    Maximum Value: 999999999
    Default Value: 0
    Maximum trail sequence number that exists in the deployment
  • Minimum Value: 0
    Maximum Value: 999999999
    Default Value: 0
    Maximum trail sequence number in use
  • Minimum Value: 0
    Maximum Value: 999999999
    Default Value: 0
    Minimum trail sequence number that exists in the deployment
  • Minimum Value: 0
    Maximum Value: 999999999
    Default Value: 0
    Minimum trail sequence number in use
  • Minimum Value: 1
    Maximum Value: 2000
    Default Value: 500
    The maximum size, in megabytes, of a file in the trail.
  • Minimum Value: 0
    Maximum Value: 18446744073709552000
    Bytes consumed by all trail sequences
  • Minimum Length: 3
    Maximum Length: 512
    Pattern: ^[a-zA-Z0-9_#$/-]*$
    The optional 'user-friendly' name for the trail
Match Any
Show Source
Nested Schema : processRef
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 5000
List of all processes associated with this trail
Show Source
Nested Schema : sequenceLastArchived
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 128
Last sequence number archived (Managed Trails only)
Show Source
Nested Schema : items
Type: object
A reference to an OGG process associated with this managed trail
Show Source
Nested Schema : processName
Match Any
Show Source
  • Minimum Length: 1
    Maximum Length: 8
    Pattern: ^[A-Z_$][A-Z0-9_$]*$
  • Minimum Length: 1
    Maximum Length: 32
    Pattern: ^[A-Za-z][A-Za-z0-9-_.]*$
Nested Schema : items
Type: object
Show Source
Nested Schema : archiveTarget
The location where the trail sequences were archived
Match One
Show Source
Nested Schema : archiveTarget-x-oneOf[1]
Type: object
OCI Object Storage Bucket
Show Source
Nested Schema : archiveTarget-x-oneOf[2]
Type: object
S3-compatible object storage bucket
Show Source
Nested Schema : authentication
Match One
Show Source
Nested Schema : authentication-x-oneOf[0]
Type: object
Authentication using a named profile from the default profile configuration file
Show Source
Nested Schema : authentication-x-oneOf[1]
Type: object
Authentication for OCI using an instance principal
Show Source
Nested Schema : authentication-x-oneOf[2]
Type: object
Authentication for OCI using an API signing key for a user
Show Source
Nested Schema : authentication
Match One
Show Source
Nested Schema : authentication-x-oneOf[0]
Type: object
Authentication using a named profile from the default profile configuration file
Show Source
Nested Schema : authentication-x-oneOf[1]
Type: object
S3 Authentication using secrets
Show Source
Example Request (application/json)
{
    "$schema":"ogg:trail",
    "trailName":"HumanResources",
    "name":"ea",
    "path":"north",
    "sizeMB":"2000"
}
Back to Top

Response

Supported Media Types

201 Response

Trail created successfully.

Body ()
Root Schema : RESTful API Standard Response
Type: object
Title: RESTful API Standard Response
Standard Response for all Oracle GoldenGate RESTful API calls
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: object
Show Source
  • Allowed Values: [ "ogg:message" ]
  • Minimum Length: 9
    Maximum Length: 9
    Pattern: ^OGG[-][0-9]{5}$
    The Oracle GoldenGate message code
  • 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
  • Allowed Values: [ "INFO", "WARNING", "ERROR" ]
    The severity of the message
  • 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.
  • 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)
{
}
Back to Top