Describe Catalog Item
get
/services/{version}/metadata-catalog/{resource}
Use this endpoint to describe a single item in the metadata catalog. A list of items in the metadata catalog is obtained using the Retrieve Catalog endpoint.
Request
Path Parameters
-
resource: string
Minimum Length:
1
Maximum Length:64
Name of the item in the metadata catalog.
-
version: string
Oracle GoldenGate Service API version.
Allowed Values:[ "v2" ]
Response
Supported Media Types
- application/json
- application/schema+json
200 Response
The metadata catalog item was retrieved successfully.
Root Schema : Oracle GoldenGate RESTful API
Type:
object
Title:
Show Source
Oracle GoldenGate RESTful API
-
$schema(optional):
Allowed Values:
[ "api:catalogItem" ]
-
links:
array links
Minimum Number of Items:
0
Maximum Number of Items:16
-
name:
string
Minimum Length:
1
Maximum Length:255
Nested Schema : links
Type:
array
Minimum Number of Items:
0
Maximum Number of Items:
Show Source
16
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
Example Response (application/json)
{
"$schema":"api:catalogItem",
"links":[
{
"href":"http://localhost:11001/services/v2/metadata-catalog/extract",
"mediaType":"application/json",
"rel":"canonical"
},
{
"href":"http://localhost:11001/services/v2/metadata-catalog/extract",
"mediaType":"application/schema+json",
"rel":"alternate"
},
{
"href":"http://localhost:11001/services/v2/metadata-catalog",
"mediaType":"application/json",
"rel":"parent"
},
{
"href":"http://localhost:11001/services/v2/extracts/%7Bextract%7D",
"mediaType":"application/json",
"rel":"describes"
},
{
"href":"http://localhost:11001/services/v2/metadata-catalog/extract",
"mediaType":"application/json",
"rel":"self"
}
],
"name":"extract"
}