Data Matching

Everything about Data Matching

Create a New DataMatchingDefinition

SecurityapiKey
Request
Request Body schema: application/json
required
object (GoldenRecordConfiguration)
name
required
string <= 30 characters

Human readable name.

object (ReportConfiguration)
type
required
string (MatchingType)
Enum: "DEDUPLICATION" "LINKAGE"
object (Workspace)
xmlDukeConfiguration
required
string

Duke XML matching configuration

Responses
200

OK

400

The sent request is malformed.

post/datamatchingdefinitions
Request samples
application/json
{
  • "name": "string",
  • "type": "DEDUPLICATION",
  • "xmlDukeConfiguration": "string",
  • "reportConfiguration": {
    },
  • "goldenRecordConfiguration": {
    },
  • "workspace": {
    }
}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "creatorUsername": "string",
  • "creatorOrganization": "string",
  • "createdAt": "string",
  • "lastModifiedAt": "string",
  • "type": "DEDUPLICATION",
  • "xmlDukeConfiguration": "string",
  • "reportConfiguration": {
    },
  • "goldenRecordConfiguration": {
    },
  • "workspace": {
    }
}

Delete a DataMatchingDefinition

SecurityapiKey
Request
path Parameters
id
required
string

id

Responses
200

OK

400

The sent request is malformed.

403

Permission denied.

delete/datamatchingdefinitions/{id}
Request samples 
Response samples 
application/json
{
  • "status": 0,
  • "path": "string",
  • "timestamp": "string",
  • "error": "string",
  • "message": "string"
}
Read a Page of Existing DataMatchingDefinitions
SecurityapiKey 
Request 
query Parameters
matchingType
string (MatchingType) 
Type of the matching configuration.


 Enum: "DEDUPLICATION" "LINKAGE"  
 Example:  matchingType=DEDUPLICATION
page
integer <int32>   >= 0 
 Default:  0
Number of the page that will be retrieved.


 
pageSize
integer <int32>   >= 1 
 Default:  20
Number of items to be returned on the page.


 
workspaceId
string
ID of the workspace


 
Responses 
200
OK


400
The sent request is malformed.


403
Permission denied.


get/datamatchingdefinitions
Request samples 
Response samples 
application/json
{
  • "page": 0,
  • "pageSize": 0,
  • "numberOfPages": 0,
  • "total": 0,
  • "values": [
    ]
}
Read an Existing DataMatchingDefinition
SecurityapiKey 
Request 
path Parameters
id
required
string
id


 
Responses 
200
OK


400
The sent request is malformed.


403
Permission denied.


get/datamatchingdefinitions/{id}
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "name": "string",
  • "creatorUsername": "string",
  • "creatorOrganization": "string",
  • "createdAt": "string",
  • "lastModifiedAt": "string",
  • "type": "DEDUPLICATION",
  • "xmlDukeConfiguration": "string",
  • "reportConfiguration": {
    },
  • "goldenRecordConfiguration": {
    },
  • "workspace": {
    }
}
Update a DataMatchingDefinition
SecurityapiKey 
Request 
path Parameters
id
required
string
id


 
Request Body schema: application/json
required
object (GoldenRecordConfiguration) 
 
name
required
string  <= 30 characters 
Human readable name.


 
object (ReportConfiguration) 
 
type
required
string (MatchingType) 
 Enum: "DEDUPLICATION" "LINKAGE"  
object (Workspace) 
 
xmlDukeConfiguration
required
string
Duke XML matching configuration


 
Responses 
200
OK


400
The sent request is malformed.


403
Permission denied.


put/datamatchingdefinitions/{id}
Request samples 
application/json
{
  • "name": "string",
  • "type": "DEDUPLICATION",
  • "xmlDukeConfiguration": "string",
  • "reportConfiguration": {
    },
  • "goldenRecordConfiguration": {
    },
  • "workspace": {
    }
}
Response samples 
application/json
{
  • "id": "string",
  • "name": "string",
  • "creatorUsername": "string",
  • "creatorOrganization": "string",
  • "createdAt": "string",
  • "lastModifiedAt": "string",
  • "type": "DEDUPLICATION",
  • "xmlDukeConfiguration": "string",
  • "reportConfiguration": {
    },
  • "goldenRecordConfiguration": {
    },
  • "workspace": {
    }
}