Jump to

• Request
• Response

List Configuration Data Types

get

/services/{version}/config/types

Retrieve the collection of configuration variable data types.

Request

Path Parameters

• version: string

  Oracle GoldenGate Service API version.

  Allowed Values: [ "v2" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Collection of configuration variable data types retrieved successfully.

Body ()

Root Schema : Oracle GoldenGate Collection

Type: object

Title: Oracle GoldenGate Collection

Show Source

• $schema(optional):
  Allowed Values: [ "ogg:collection" ]
• items: array items
  Minimum Number of Items: 0

  Maximum Number of Items: 32767

{
    "title":"Oracle GoldenGate Collection",
    "required":[
        "items"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:collection"
            ]
        },
        "items":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "$schema":{
                        "description":"Name of schema for collection item, defaults to this schema",
                        "type":"string",
                        "minLength":1,
                        "maxLength":255,
                        "default":"ogg:collectionItem"
                    },
                    "name":{
                        "description":"Item name",
                        "type":"string",
                        "minLength":1,
                        "maxLength":255
                    },
                    "links":{
                        "description":"Links for item",
                        "minItems":0,
                        "maxItems":16,
                        "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
                        }
                    }
                },
                "required":[
                    "name",
                    "links"
                ],
                "additionalProperties":true
            },
            "minItems":0,
            "maxItems":32767
        }
    },
    "additionalProperties":false
}

Nested Schema : items

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 32767

Show Source

• Array of: object items
  Additional Properties Allowed: true

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "$schema":{
                "description":"Name of schema for collection item, defaults to this schema",
                "type":"string",
                "minLength":1,
                "maxLength":255,
                "default":"ogg:collectionItem"
            },
            "name":{
                "description":"Item name",
                "type":"string",
                "minLength":1,
                "maxLength":255
            },
            "links":{
                "description":"Links for item",
                "minItems":0,
                "maxItems":16,
                "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
                }
            }
        },
        "required":[
            "name",
            "links"
        ],
        "additionalProperties":true
    },
    "minItems":0,
    "maxItems":32767
}

Nested Schema : items

Type: object

Additional Properties Allowed: true

Show Source

• $schema(optional): string
  Minimum Length: 1

  Maximum Length: 255

  Default Value: ogg:collectionItem

  Name of schema for collection item, defaults to this schema
• links: array links
  Minimum Number of Items: 0

  Maximum Number of Items: 16

  Links for item
• name: string
  Minimum Length: 1

  Maximum Length: 255

  Item name

{
    "type":"object",
    "properties":{
        "$schema":{
            "description":"Name of schema for collection item, defaults to this schema",
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "default":"ogg:collectionItem"
        },
        "name":{
            "description":"Item name",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "links":{
            "description":"Links for item",
            "minItems":0,
            "maxItems":16,
            "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
            }
        }
    },
    "required":[
        "name",
        "links"
    ],
    "additionalProperties":true
}

Nested Schema : links

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 16

Links for item

Show Source

• Array of: object items

{
    "description":"Links for item",
    "minItems":0,
    "maxItems":16,
    "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
    }
}

Nested Schema : items

Type: object

Show Source

• $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

{
    "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
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:11001/services/v2/config/types",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11001/services/v2/config/types",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:11001/services/v2/metadata-catalog/types",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:collection",
        "items":[
            {
                "$schema":"ogg:collectionItem",
                "links":[
                    {
                        "href":"http://localhost:11001/services/v2/config/types",
                        "mediaType":"application/json",
                        "rel":"parent"
                    },
                    {
                        "href":"http://localhost:11001/services/v2/config/types/ogg:managedProcessSettings",
                        "mediaType":"application/json",
                        "rel":"canonical"
                    }
                ],
                "name":"ogg:managedProcessSettings"
            },
            {
                "$schema":"ogg:collectionItem",
                "links":[
                    {
                        "href":"http://localhost:11001/services/v2/config/types",
                        "mediaType":"application/json",
                        "rel":"parent"
                    },
                    {
                        "href":"http://localhost:11001/services/v2/config/types/ogg:configDataDescription",
                        "mediaType":"application/json",
                        "rel":"canonical"
                    }
                ],
                "name":"ogg:configDataDescription"
            },
            {
                "$schema":"ogg:collectionItem",
                "links":[
                    {
                        "href":"http://localhost:11001/services/v2/config/types",
                        "mediaType":"application/json",
                        "rel":"parent"
                    },
                    {
                        "href":"http://localhost:11001/services/v2/config/types/custom:config",
                        "mediaType":"application/json",
                        "rel":"canonical"
                    }
                ],
                "name":"custom:config"
            }
        ]
    }
}

Back to Top