ルート・スキーマ: RESTful API Standard Response
型: object
タイトル: RESTful API Standard Response
すべてのOracle GoldenGate RESTful APIコールの標準レスポンス
ソースの表示
{
"title":"RESTful API Standard Response",
"description":"Standard Response for all Oracle GoldenGate RESTful API calls",
"required":[
"messages",
"links"
],
"type":"object",
"properties":{
"$schema":{
"enum":[
"api:standardResponse"
]
},
"response":{
"description":"Oracle GoldenGate document from the request",
"type":"object"
},
"messages":{
"description":"Oracle GoldenGate messages issued during the request",
"type":"array",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:message"
]
},
"type":{
"description":"An absolute URI [RFC3986] to a page that describes the info, warning or error type.",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":2,
"maxLength":4095
},
"title":{
"description":"A human-readable description that provides information and detail specific to this occurence of the information, warning or error.",
"type":"string",
"minLength":1,
"maxLength":4095
},
"code":{
"description":"The Oracle GoldenGate message code",
"type":"string",
"pattern":"^OGG[-][0-9]{5}$",
"minLength":9,
"maxLength":9
},
"severity":{
"description":"The severity of the message",
"enum":[
"INFO",
"WARNING",
"ERROR"
]
},
"issued":{
"description":"The date and time that the message was issued",
"type":"string",
"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])$",
"minLength":20,
"maxLength":32
}
},
"required":[
"type",
"title",
"code",
"severity",
"issued"
],
"additionalProperties":false
},
"minItems":0,
"maxItems":65535
},
"links":{
"description":"Oracle GoldenGate links for the request",
"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
},
"minItems":0,
"maxItems":16
}
},
"additionalProperties":false
}
ネストされたスキーマ: links
型: array
最小アイテム数: 0
最大アイテム数: 16
リクエストのOracle GoldenGateリンク
ソースの表示
{
"description":"Oracle GoldenGate links for the request",
"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
},
"minItems":0,
"maxItems":16
}
ネストされたスキーマ: messages
型: array
最小アイテム数: 0
最大アイテム数: 65535
リクエストの間に発行されるGoldenGateメッセージ
ソースの表示
{
"description":"Oracle GoldenGate messages issued during the request",
"type":"array",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:message"
]
},
"type":{
"description":"An absolute URI [RFC3986] to a page that describes the info, warning or error type.",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":2,
"maxLength":4095
},
"title":{
"description":"A human-readable description that provides information and detail specific to this occurence of the information, warning or error.",
"type":"string",
"minLength":1,
"maxLength":4095
},
"code":{
"description":"The Oracle GoldenGate message code",
"type":"string",
"pattern":"^OGG[-][0-9]{5}$",
"minLength":9,
"maxLength":9
},
"severity":{
"description":"The severity of the message",
"enum":[
"INFO",
"WARNING",
"ERROR"
]
},
"issued":{
"description":"The date and time that the message was issued",
"type":"string",
"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])$",
"minLength":20,
"maxLength":32
}
},
"required":[
"type",
"title",
"code",
"severity",
"issued"
],
"additionalProperties":false
},
"minItems":0,
"maxItems":65535
}
ネストされたスキーマ: response
型: object
リクエストのOracle GoldenGateドキュメント
ネストされたスキーマ: items
型: object
ソースの表示
- $schema:
- description: string
最小長: 1
最大長: 4095
このリンク固有の情報と詳細を提供する、人が読むための説明。
- href: string
最小長: 2
最大長: 4095
パターン: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
リンクの絶対URI
- mediaType: string
- 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
}
ネストされたスキーマ: items
型: object
ソースの表示
- $schema:
指定できる値: [ "ogg:message" ]
- code: string
最小長: 9
最大長: 9
パターン: ^OGG[-][0-9]{5}$
Oracle GoldenGateメッセージ・コード
- issued: string
最小長: 20
最大長: 32
パターン: ^[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])$
メッセージが発行された日時
- severity:
指定できる値: [ "INFO", "WARNING", "ERROR" ]
メッセージの重大度
- title: string
最小長: 1
最大長: 4095
この情報、警告またはエラーに固有の情報と詳細を提供する、人が読むための説明。
- type: string
最小長: 2
最大長: 4095
パターン: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
情報、警告またはエラーのタイプを説明するページの絶対URI [RFC3986]。
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:message"
]
},
"type":{
"description":"An absolute URI [RFC3986] to a page that describes the info, warning or error type.",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":2,
"maxLength":4095
},
"title":{
"description":"A human-readable description that provides information and detail specific to this occurence of the information, warning or error.",
"type":"string",
"minLength":1,
"maxLength":4095
},
"code":{
"description":"The Oracle GoldenGate message code",
"type":"string",
"pattern":"^OGG[-][0-9]{5}$",
"minLength":9,
"maxLength":9
},
"severity":{
"description":"The severity of the message",
"enum":[
"INFO",
"WARNING",
"ERROR"
]
},
"issued":{
"description":"The date and time that the message was issued",
"type":"string",
"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])$",
"minLength":20,
"maxLength":32
}
},
"required":[
"type",
"title",
"code",
"severity",
"issued"
],
"additionalProperties":false
}