REST API for GoldenGate Veridata

Retrieve Profiles

get

http://{host}:{port}/veridata/v1/services/configuration/profiles

Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator

Get all Profiles.

Request

Query Parameters

description: string

description like.
name: string

name like.

There's no request body for this operation.

Response

Supported Media Types

application/json
*/*

200 Response

Profiles returned successfully.

Root Schema : schema

Type: array

Show Source

Array of: Profile

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Profile"
    }
}

Nested Schema : Profile

Match All

Show Source

object BaseObject

{
    "allOf":[
        {
            "$ref":"#/components/schemas/BaseObject"
        }
    ]
}

Nested Schema : BaseObject

Type: object

Show Source

createdOn: string (date-time)

Pattern: YYYY-MM-DDTHH:mm:ss.sssZ

Example: 2024-02-03T10:15:30Z
description: string

Object Description.
id: integer (int64)

Object Id.
name: string

Object Name.
updatedOn: string (date-time)

Pattern: YYYY-MM-DDTHH:mm:ss.sssZ

Example: 2024-02-03T10:15:30Z

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Object Id.",
            "format":"int64"
        },
        "name":{
            "type":"string",
            "description":"Object Name."
        },
        "description":{
            "type":"string",
            "description":"Object Description."
        },
        "createdOn":{
            "type":"string",
            "format":"date-time",
            "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
            "example":"2024-02-03T10:15:30Z"
        },
        "updatedOn":{
            "type":"string",
            "format":"date-time",
            "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
            "example":"2024-02-03T10:15:30Z"
        }
    }
}

400 Response

Bad Request.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    }
}

401 Response

Unauthorized.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    }
}

404 Response

Not Found.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    }
}

500 Response

Server Error.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    }
}