List Trail Sequences
/services/{version}/trails/{trail}/sequences
Required Role: User
Retrieve a collection of all sequences that exist for a specific trail.
Request
-
trail(required): string
Minimum Length:
2Maximum Length:512Pattern:^[a-zA-Z0-9_#$-]*$The name of the Trail. This corresponds to the
trailNameproperty in theogg:trailresource or the trail filesystem path.A trail name can be either a human-friendly name like
HumanResourcesor a two-character name plus a query parameter called 'path' whose value is the URI-encoded trail filesystem path, likeea?path=north%2Femployees. When a short name and a URI-encoded path is used for the trail name, it must match thenameandpathproperties in the correspondingogg:trailresource.A trail called
HumanResourceswith the path/name set tonorth/employees/eacan be referred to as eitherHumanResourcesorea?path=north%2Femployees, but the canonical name is always the human-friendly name.POST operations accept only the human-friendly name.
-
version(required): string
Oracle GoldenGate Service API version.
Allowed Values:[ "v2" ]
Response
- application/json
200 Response
Collection of Trail Sequences retrieved successfully.
objectOracle GoldenGate Collection-
$schema:
Allowed Values:
[ "ogg:collection" ] -
items(required):
array items
Minimum Number of Items:
0Maximum Number of Items:32767
array032767-
Array of:
object items
Additional Properties Allowed:
true
objecttrue-
$schema:
string
Minimum Length:
1Maximum Length:255Default Value:ogg:collectionItemName of schema for collection item, defaults to this schema -
links(required):
array links
Minimum Number of Items:
1Maximum Number of Items:16Links for item -
name(required):
string
Minimum Length:
1Maximum Length:255Item name -
status:
status
Item status
array116object-
$schema:
Allowed Values:
[ "ogg:link" ] -
description:
string
Minimum Length:
1Maximum Length:4095A human-readable description that provides information and detail specific to this link. -
href(required):
string
Minimum Length:
2Maximum Length:4095Pattern:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$An absolute URI for the link -
mediaType:
string
Minimum Length:
6Maximum Length:255Pattern:^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288) -
rel(required):
Allowed Values:
[ "alternate", "canonical", "current", "describedby", "describes", "enclosure", "parent", "related", "self", "first", "last", "next", "previous", "ogg://service" ]Relationship of href to the requested link
{
"$schema":"api:standardResponse",
"links":[
{
"rel":"canonical",
"href":"http://localhost:9012/services/v2/trails/aa/sequences?path=dir1%2FT_EXT1",
"mediaType":"application/json"
},
{
"rel":"self",
"href":"http://localhost:9012/services/v2/trails/aa/sequences?path=dir1%2FT_EXT1",
"mediaType":"application/json"
},
{
"rel":"describedby",
"href":"http://localhost:9012/services/v2/metadata-catalog/sequences",
"mediaType":"application/schema+json"
}
],
"messages":[
],
"response":{
"items":[
{
"links":[
{
"rel":"parent",
"href":"http://localhost:9012/services/v2/trails/aa/sequences?path=dir1%2FT_EXT1",
"mediaType":"application/json"
},
{
"rel":"canonical",
"href":"http://localhost:9012/services/v2/trails/aa/sequences/0?path=dir1%2FT_EXT1",
"mediaType":"application/json"
}
],
"$schema":"ogg:collectionItem",
"name":"0"
},
{
"links":[
{
"rel":"parent",
"href":"http://localhost:9012/services/v2/trails/aa/sequences?path=dir1%2FT_EXT1",
"mediaType":"application/json"
},
{
"rel":"canonical",
"href":"http://localhost:9012/services/v2/trails/aa/sequences/1?path=dir1%2FT_EXT1",
"mediaType":"application/json"
}
],
"$schema":"ogg:collectionItem",
"name":"1"
},
{
"links":[
{
"rel":"parent",
"href":"http://localhost:9012/services/v2/trails/aa/sequences?path=dir1%2FT_EXT1",
"mediaType":"application/json"
},
{
"rel":"canonical",
"href":"http://localhost:9012/services/v2/trails/aa/sequences/2?path=dir1%2FT_EXT1",
"mediaType":"application/json"
}
],
"$schema":"ogg:collectionItem",
"name":"2"
}
],
"$schema":"ogg:collection"
}
}