Jump to

• Request
• Response

Generate Mapping Objects using the Mapping Rules

post

http://{host}:{port}/veridata/v1/services/configuration/cps/mappings

Required Role: Administrator, SuperUser, CommandLineOperator

Generate mapping objects for viewing purpose.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• sourceConnectionId(required): integer (int64)
  Connection Id.
• srcCatalogObjectName: string
• srcFilePattern: string
  Enscribe file pattern of volume.subVolume
• srcSchemaObjectName(required): string
• targetConnectionId(required): integer (int64)
  Connection Id.
• tgtCatalogObjectName: string
• tgtFilePattern: string
  Enscribe file pattern of volume.subVolume
• tgtSchemaObjectName(required): string

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/PatternMapping"
        }
    ],
    "properties":{
        "sourceConnectionId":{
            "type":"integer",
            "description":"Connection Id.",
            "format":"int64"
        },
        "targetConnectionId":{
            "type":"integer",
            "description":"Connection Id.",
            "format":"int64"
        },
        "srcSchemaObjectName":{
            "type":"string"
        },
        "srcCatalogObjectName":{
            "type":"string"
        },
        "tgtSchemaObjectName":{
            "type":"string"
        },
        "tgtCatalogObjectName":{
            "type":"string"
        },
        "srcFilePattern":{
            "type":"string",
            "description":"Enscribe file pattern of volume.subVolume"
        },
        "tgtFilePattern":{
            "type":"string",
            "description":"Enscribe file pattern of volume.subVolume"
        }
    },
    "required":[
        "sourceConnectionId",
        "targetConnectionId",
        "srcSchemaObjectName",
        "tgtSchemaObjectName"
    ],
    "example":{
        "exactName":false,
        "wildCard":[
            {
                "srcLike":true,
                "srcPattern":"EMP%",
                "tgtLike":true,
                "tgtPattern":"EMP%"
            }
        ],
        "excludeViews":false,
        "mapTablePartitionName":true,
        "sourceConnectionId":1023,
        "targetConnectionId":1024,
        "srcSchemaObjectName":"VERIDATA",
        "srcCatalogObjectName":"ORCL1",
        "tgtSchemaObjectName":"VERIDATA_TGT",
        "tgtCatalogObjectName":"ORCL1_TGT"
    }
}

Match All

Show Source

• object PatternMapping

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/PatternMapping"
        }
    ],
    "properties":{
        "sourceConnectionId":{
            "type":"integer",
            "description":"Connection Id.",
            "format":"int64"
        },
        "targetConnectionId":{
            "type":"integer",
            "description":"Connection Id.",
            "format":"int64"
        },
        "srcSchemaObjectName":{
            "type":"string"
        },
        "srcCatalogObjectName":{
            "type":"string"
        },
        "tgtSchemaObjectName":{
            "type":"string"
        },
        "tgtCatalogObjectName":{
            "type":"string"
        },
        "srcFilePattern":{
            "type":"string",
            "description":"Enscribe file pattern of volume.subVolume"
        },
        "tgtFilePattern":{
            "type":"string",
            "description":"Enscribe file pattern of volume.subVolume"
        }
    },
    "required":[
        "sourceConnectionId",
        "targetConnectionId",
        "srcSchemaObjectName",
        "tgtSchemaObjectName"
    ],
    "example":{
        "exactName":false,
        "wildCard":[
            {
                "srcLike":true,
                "srcPattern":"EMP%",
                "tgtLike":true,
                "tgtPattern":"EMP%"
            }
        ],
        "excludeViews":false,
        "mapTablePartitionName":true,
        "sourceConnectionId":1023,
        "targetConnectionId":1024,
        "srcSchemaObjectName":"VERIDATA",
        "srcCatalogObjectName":"ORCL1",
        "tgtSchemaObjectName":"VERIDATA_TGT",
        "tgtCatalogObjectName":"ORCL1_TGT"
    }
}

Example:

{
    "exactName":false,
    "wildCard":[
        {
            "srcLike":true,
            "srcPattern":"EMP%",
            "tgtLike":true,
            "tgtPattern":"EMP%"
        }
    ],
    "excludeViews":false,
    "mapTablePartitionName":true,
    "sourceConnectionId":1023,
    "targetConnectionId":1024,
    "srcSchemaObjectName":"VERIDATA",
    "srcCatalogObjectName":"ORCL1",
    "tgtSchemaObjectName":"VERIDATA_TGT",
    "tgtCatalogObjectName":"ORCL1_TGT"
}

Nested Schema : PatternMapping

Type: object

Show Source

• exactName: boolean
  Default Value: true

  Map Source and Target Tables Using Exact Names. It is required during pattern mapping.
• excludeViews: boolean
  Default Value: false
• mapTablePartitionName: boolean
  Default Value: false

  Map Table Partition with exact name.
• wildCard: object wildCard
  Map Source and Target Tables Using % OR * Wildcard Pattern. % or * should be used either at the start or end of the pattern. This will be used only if the exactName is set to false.

{
    "type":"object",
    "properties":{
        "exactName":{
            "type":"boolean",
            "description":"Map Source and Target Tables Using Exact Names. It is required during pattern mapping.",
            "default":true
        },
        "wildCard":{
            "type":"object",
            "properties":{
                "srcLike":{
                    "type":"boolean",
                    "description":"Where Source Names Like/Not Like.",
                    "default":true
                },
                "srcPattern":{
                    "type":"string",
                    "description":"Source Pattern."
                },
                "tgtLike":{
                    "type":"boolean",
                    "description":"Where Target names Like/Not Like.",
                    "default":true
                },
                "tgtPattern":{
                    "type":"string",
                    "description":"Target Pattern"
                }
            },
            "description":"Map Source and Target Tables Using % OR * Wildcard Pattern. % or * should be used either at the start or end of the pattern. This will be used only if the exactName is set to false."
        },
        "excludeViews":{
            "type":"boolean",
            "default":false
        },
        "mapTablePartitionName":{
            "type":"boolean",
            "description":"Map Table Partition with exact name.",
            "default":false
        }
    }
}

Nested Schema : wildCard

Type: object

Map Source and Target Tables Using % OR * Wildcard Pattern. % or * should be used either at the start or end of the pattern. This will be used only if the exactName is set to false.

Show Source

• srcLike: boolean
  Default Value: true

  Where Source Names Like/Not Like.
• srcPattern: string
  Source Pattern.
• tgtLike: boolean
  Default Value: true

  Where Target names Like/Not Like.
• tgtPattern: string
  Target Pattern

{
    "type":"object",
    "properties":{
        "srcLike":{
            "type":"boolean",
            "description":"Where Source Names Like/Not Like.",
            "default":true
        },
        "srcPattern":{
            "type":"string",
            "description":"Source Pattern."
        },
        "tgtLike":{
            "type":"boolean",
            "description":"Where Target names Like/Not Like.",
            "default":true
        },
        "tgtPattern":{
            "type":"string",
            "description":"Target Pattern"
        }
    },
    "description":"Map Source and Target Tables Using % OR * Wildcard Pattern. % or * should be used either at the start or end of the pattern. This will be used only if the exactName is set to false."
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successfully generated compare pairs.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object MappedObject

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

Nested Schema : MappedObject

Type: object

Show Source

• name: string
  Mapping name . Default is source table name = target table name.
• srcTable(required): srcTable
  Represents a table in compare pair with table and row partitions info, if any.
• tgtTable(required): tgtTable
  Represents a table in compare pair with table and row partitions info, if any.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Mapping name . Default is source table name = target table name."
        },
        "srcTable":{
            "description":"Represents a table in compare pair with table and row partitions info, if any.\n",
            "allOf":[
                {
                    "$ref":"#/components/schemas/Table"
                },
                {
                    "type":"object"
                }
            ]
        },
        "tgtTable":{
            "description":"Represents a table in compare pair with table and row partitions info, if any.\n",
            "allOf":[
                {
                    "$ref":"#/components/schemas/Table"
                },
                {
                    "type":"object"
                }
            ]
        }
    },
    "required":[
        "srcTable",
        "tgtTable"
    ]
}

Nested Schema : srcTable

Represents a table in compare pair with table and row partitions info, if any.

Match All

Represents a table in compare pair with table and row partitions info, if any.

Represents a table in compare pair with table and row partitions info, if any.

Show Source

• object Table
  Defines a table.
• object srcTable-allOf[1]

{
    "description":"Represents a table in compare pair with table and row partitions info, if any.\n",
    "allOf":[
        {
            "$ref":"#/components/schemas/Table"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : tgtTable

Represents a table in compare pair with table and row partitions info, if any.

Match All

Represents a table in compare pair with table and row partitions info, if any.

Represents a table in compare pair with table and row partitions info, if any.

Show Source

• object Table
  Defines a table.
• object tgtTable-allOf[1]

{
    "description":"Represents a table in compare pair with table and row partitions info, if any.\n",
    "allOf":[
        {
            "$ref":"#/components/schemas/Table"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : Table

Type: object

Defines a table.

Show Source

• catalog: string
• filePattern: string
  NSK Encribe file pattern.
• isView: boolean
• name: string
• schema: string
• tablePartition: object tablePartition

{
    "type":"object",
    "description":"Defines a table.",
    "properties":{
        "name":{
            "type":"string"
        },
        "schema":{
            "type":"string"
        },
        "catalog":{
            "type":"string"
        },
        "isView":{
            "type":"boolean"
        },
        "filePattern":{
            "type":"string",
            "description":"NSK Encribe file pattern."
        },
        "tablePartition":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/TablePartition"
                }
            ]
        }
    }
}

Nested Schema : srcTable-allOf[1]

Type: object

Nested Schema : tablePartition

Type: object

Match All

Show Source

• object TablePartition

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/TablePartition"
        }
    ]
}

Nested Schema : TablePartition

Type: object

Show Source

• name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : tgtTable-allOf[1]

Type: object

400 Response

Bad Request.

Body ()

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."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

Example:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

401 Response

Unauthorized.

Body ()

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."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

Example:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

404 Response

Not Found.

Body ()

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."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

Example:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

500 Response

Server Error.

Body ()

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."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

Example:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

Back to Top