Oracle GoldenGate 19c Microservices Architecture REST API

カタログ・アイテムの説明

get

/services/{version}/metadata-catalog/{resource}

このエンドポイントを使用して、メタデータ・カタログ内の1つのアイテムについて説明します。メタデータ・カタログ内のアイテムのリストは、カタログの取得エンドポイントを使用して入手します。

リクエスト

パス・パラメータ

resource: string

最小長: 1

最大長: 64

メタデータ・カタログ内のアイテムの名前。
version: string

Oracle GoldenGateサービスのAPIバージョン。

指定できる値: [ "v2" ]

先頭に戻る

レスポンス

サポートされるメディア・タイプ

application/json
application/schema+json

200レスポンス

メタデータ・カタログのアイテムが正常に取得されました。

ルート・スキーマ: Oracle GoldenGate RESTful API

型: object

タイトル: Oracle GoldenGate RESTful API

ソースの表示

$schema(optional):

指定できる値: [ "api:catalogItem" ]
links: array links

最小アイテム数: 0

最大アイテム数: 16
name: string

最小長: 1

最大長: 255

{
    "title":"Oracle GoldenGate RESTful API",
    "required":[
        "name",
        "links"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "api:catalogItem"
            ]
        },
        "name":{
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "links":{
            "minItems":0,
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "$schema":{
                        "enum":[
                            "ogg:link"
                        ]
                    },
                    "rel":{
                        "description":"Relationship of href to the requested link",
                        "enum":[
                            "alternate",
                            "canonical",
                            "current",
                            "describedby",
                            "describes",
                            "enclosure",
                            "parent",
                            "related",
                            "self",
                            "first",
                            "last",
                            "next",
                            "previous"
                        ]
                    },
                    "href":{
                        "description":"An absolute URI for the link",
                        "type":"string",
                        "pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
                        "minLength":2,
                        "maxLength":4095
                    },
                    "mediaType":{
                        "description":"Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288)",
                        "type":"string",
                        "pattern":"^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$",
                        "minLength":6,
                        "maxLength":255
                    },
                    "description":{
                        "description":"A human-readable description that provides information and detail specific to this link.",
                        "type":"string",
                        "minLength":1,
                        "maxLength":4095
                    }
                },
                "required":[
                    "rel",
                    "href"
                ],
                "additionalProperties":false
            },
            "maxItems":16
        }
    },
    "additionalProperties":false
}

ネストされたスキーマ: links

型: array

最小アイテム数: 0

最大アイテム数: 16

ソースの表示

配列: object items

{
    "minItems":0,
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "$schema":{
                "enum":[
                    "ogg:link"
                ]
            },
            "rel":{
                "description":"Relationship of href to the requested link",
                "enum":[
                    "alternate",
                    "canonical",
                    "current",
                    "describedby",
                    "describes",
                    "enclosure",
                    "parent",
                    "related",
                    "self",
                    "first",
                    "last",
                    "next",
                    "previous"
                ]
            },
            "href":{
                "description":"An absolute URI for the link",
                "type":"string",
                "pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
                "minLength":2,
                "maxLength":4095
            },
            "mediaType":{
                "description":"Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288)",
                "type":"string",
                "pattern":"^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$",
                "minLength":6,
                "maxLength":255
            },
            "description":{
                "description":"A human-readable description that provides information and detail specific to this link.",
                "type":"string",
                "minLength":1,
                "maxLength":4095
            }
        },
        "required":[
            "rel",
            "href"
        ],
        "additionalProperties":false
    },
    "maxItems":16
}

ネストされたスキーマ: items

型: object

ソースの表示

$schema(optional):

指定できる値: [ "ogg:link" ]
description(optional): string

最小長: 1

最大長: 4095

このリンク固有の情報と詳細を提供する、人が読むための説明。
href: string

最小長: 2

最大長: 4095

パターン: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$

リンクの絶対URI
mediaType(optional): string

最小長: 6

最大長: 255

パターン: ^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$

メディア・タイプ - RFC 4288 (https://tools.ietf.org/html/rfc4288)を参照
rel:

指定できる値: [ "alternate", "canonical", "current", "describedby", "describes", "enclosure", "parent", "related", "self", "first", "last", "next", "previous" ]

hrefとリクエスト対象のリンクlinkの関係

{
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:link"
            ]
        },
        "rel":{
            "description":"Relationship of href to the requested link",
            "enum":[
                "alternate",
                "canonical",
                "current",
                "describedby",
                "describes",
                "enclosure",
                "parent",
                "related",
                "self",
                "first",
                "last",
                "next",
                "previous"
            ]
        },
        "href":{
            "description":"An absolute URI for the link",
            "type":"string",
            "pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
            "minLength":2,
            "maxLength":4095
        },
        "mediaType":{
            "description":"Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288)",
            "type":"string",
            "pattern":"^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$",
            "minLength":6,
            "maxLength":255
        },
        "description":{
            "description":"A human-readable description that provides information and detail specific to this link.",
            "type":"string",
            "minLength":1,
            "maxLength":4095
        }
    },
    "required":[
        "rel",
        "href"
    ],
    "additionalProperties":false
}

レスポンスの例(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"
}

先頭に戻る