Skip to main content
Version: Next

API Reference

API docs by Redocly

LinXmart API (3.3)

Download OpenAPI specification:Download

LinXmart Support: support@linxmart.com.au

The API provides a set of resources for configuring and running LinXmart.

DataProviders

Get all data providers

All data providers in the system will be returned.

path Parameters
version
required
string
Default: "3.3"

The requested API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a data provider

A new data provider is created using the data passed in.

path Parameters
version
required
string
Default: "3.3"

The requested API version

Request Body schema: application/json

The DataProvider object to save.

lastModified
string <date-time>
version
string or null <byte>
id
integer <int32>

The system defined identifier for the data provider

code
required
string [ 1 .. 15 ] characters

A reference code that can uniquely identify the data provider in the system

organisation
required
string [ 1 .. 100 ] characters

The name of the provider organisation

contactName
required
string [ 1 .. 100 ] characters

The full name of the a contact for the organisation

email
required
string [ 1 .. 320 ] characters

The contact's email address for communication

phone
string or null <= 20 characters

The contact's phone number for communication

Responses

Request samples

Content type
application/json
{
  • "lastModified": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "id": 0,
  • "code": "string",
  • "organisation": "string",
  • "contactName": "string",
  • "email": "string",
  • "phone": "string"
}

Response samples

Content type
application/json
{
  • "lastModified": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "id": 0,
  • "code": "string",
  • "organisation": "string",
  • "contactName": "string",
  • "email": "string",
  • "phone": "string"
}

Get a data provider

A single data provider will be returned, based on the id value passed in.

path Parameters
id
required
integer <int32>

The ID of the specific data provider to return.

version
required
string
Default: "3.3"

The requested API version

Responses

Response samples

Content type
application/json
{
  • "lastModified": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "id": 0,
  • "code": "string",
  • "organisation": "string",
  • "contactName": "string",
  • "email": "string",
  • "phone": "string"
}

Update a data provider

Updates an existing data provider using the details passed in the body of the request.

path Parameters
id
required
integer <int32>

The ID of the data provider to update.

version
required
string
Default: "3.3"

The requested API version

Request Body schema: application/json

A DataProvider object containing the updated information.

lastModified
string <date-time>
version
string or null <byte>
id
integer <int32>

The system defined identifier for the data provider

code
required
string [ 1 .. 15 ] characters

A reference code that can uniquely identify the data provider in the system

organisation
required
string [ 1 .. 100 ] characters

The name of the provider organisation

contactName
required
string [ 1 .. 100 ] characters

The full name of the a contact for the organisation

email
required
string [ 1 .. 320 ] characters

The contact's email address for communication

phone
string or null <= 20 characters

The contact's phone number for communication

Responses

Request samples

Content type
application/json
{
  • "lastModified": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "id": 0,
  • "code": "string",
  • "organisation": "string",
  • "contactName": "string",
  • "email": "string",
  • "phone": "string"
}

Delete a data provider

The data provider is marked for deletion and jobs are initiated to end-date all associated event data.

path Parameters
id
required
integer <int32>

The ID of the data provider to delete.

version
required
string
Default: "3.3"

The requested API version

Responses

Gets event types for a data provider

All event types for the specificed data provider are returned.

path Parameters
id
required
integer <int32>

The ID of the specific data provider to return event types for.

version
required
string
Default: "3.3"

The requested API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Envelopes

Get all envelopes

Returns a list of envelope objects for linkage projects that the user has permissions to access.

path Parameters
version
required
string
Default: "3.3"

The requested API version

query Parameters
limit
integer <int32>

The maximum number of items to return.

offset
integer <int32>

The number of items from the beginning to start returning from.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Upload an envelope

Submits a new envelope to the system by loading it into the Inbox. The envelope is not checked at this point for validity; it is simply loaded into the Inbox to be processed at a later time. The request body should contain the envelope zip file using the content type “multipart/form-data” – this is a standard HTTP form file upload. Please ensure you specify the filename as this is used to identify the envelope.

path Parameters
version
required
string
Default: "3.3"

The requested API version

Responses

Get an envelope

Returns a specific envelope object based on the envelope's name. The envelope must exist and the user must have permissions to view it.

Possible status values:

  • 0 = Unknown
  • 1 = Pending
  • 2 = Processing
  • 3 = Failed
  • 4 = Complete

Possible type values:

  • 0 - Unknown
  • 1 - Linkage
  • 2 - Extraction
  • 3 - Deletion
  • 4 - ProbsCalculation
  • 5 - QualityReview
path Parameters
name
required
string

The name of the envelope to retrieve.

version
required
string
Default: "3.3"

The requested API version

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "displayName": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "status": 0,
  • "statusName": "string",
  • "type": 0,
  • "typeName": "string"
}

Get extraction requests for an envelope

Used to return Extraction objects that may be associated with an envelope. The envelope would need to be a request for extraction and the user requires permission to view it.

path Parameters
name
required
string

The name of the envelope to get extractions for.

version
required
string
Default: "3.3"

The requested API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get notifications for an envelope

Used to return Extraction objects that may be associated with an envelope.

path Parameters
name
required
string

The name of the envelope to get notifications.

version
required
string
Default: "3.3"

The requested API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get jobs for an envelope

Used to return Job objects that may be associated with an envelope.

path Parameters
name
required
string

The name of the envelope to get jobs.

version
required
string
Default: "3.3"

The requested API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

EventTypes

Get all event types

All event types in the system will be returned.

path Parameters
version
required
string
Default: "3.3"

The requested API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an event type

A new event type is created using the data passed in, assuming the parent data provider referenced is valid.

path Parameters
version
required
string
Default: "3.3"

The requested API version

Request Body schema: application/json

The EventType object to save.

lastModified
string <date-time>
version
string or null <byte>
id
integer <int32>

The system generated identifier of an event type

dataProviderId
integer <int32>

The id of the parent data provider

code
required
string [ 1 .. 15 ] characters

The code of an event type

description
required
string [ 1 .. 4000 ] characters

A short description of the event type

isAuthoritative
boolean

Flag indicating if each record represents a separate individual

category
required
string [ 1 .. 40 ] characters

An arbitrary categorisation

Array of objects or null (DataSource)

A list of the data sources associated with this event type

Responses

Request samples

Content type
application/json
{
  • "lastModified": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "id": 0,
  • "dataProviderId": 0,
  • "code": "string",
  • "description": "string",
  • "isAuthoritative": true,
  • "category": "string",
  • "dataSources": [
    ]
}

Get an event type

A single event type will be returned, based on the id value passed in.

path Parameters
id
required
integer <int32>

The ID of the specific event type to return.

version
required
string
Default: "3.3"

The requested API version

Responses

Response samples

Content type
application/json
{
  • "lastModified": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "id": 0,
  • "dataProviderId": 0,
  • "code": "string",
  • "description": "string",
  • "isAuthoritative": true,
  • "category": "string",
  • "dataSources": [
    ]
}

Update an event type

Updates an existing event type using the details passed in the body of the request.

path Parameters
id
required
integer <int32>

The ID of the event type to update.

version
required
string
Default: "3.3"

The requested API version

Request Body schema: application/json

An EventType object containing the updated information.

lastModified
string <date-time>
version
string or null <byte>
id
integer <int32>

The system generated identifier of an event type

dataProviderId
integer <int32>

The id of the parent data provider

code
required
string [ 1 .. 15 ] characters

The code of an event type

description
required
string [ 1 .. 4000 ] characters

A short description of the event type

isAuthoritative
boolean

Flag indicating if each record represents a separate individual

category
required
string [ 1 .. 40 ] characters

An arbitrary categorisation

Array of objects or null (DataSource)

A list of the data sources associated with this event type

Responses

Request samples

Content type
application/json
{
  • "lastModified": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "id": 0,
  • "dataProviderId": 0,
  • "code": "string",
  • "description": "string",
  • "isAuthoritative": true,
  • "category": "string",
  • "dataSources": [
    ]
}

Request deletion of an event type

The event type is marked for deletion and a job is initiated to end-date all associated event data.

path Parameters
id
required
integer <int32>

The ID of the event type to delete.

version
required
string
Default: "3.3"

The requested API version

Responses

ExtractionProjects

Get all extraction projects

Returns a list of extraction project objects for linkage projects that the user has permissions to access.

path Parameters
version
required
string
Default: "3.3"

The requested API version

query Parameters
limit
integer <int32>

The maximum number of items to return.

offset
integer <int32>

The number of items from the beginning to start returning from.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an extraction project

Creates a new extraction project for a a specific linkage project. The linkage project ID must be specified in the request object.

path Parameters
version
required
string
Default: "3.3"

The requested API version

Request Body schema: application/json

The ExtractionProject object to save.

lastModified
string <date-time>
version
string or null <byte>
id
string or null

The system generated identifier of the extraction project

projectId
integer <int32>

The ID of the parent linkage project

code
required
string [ 1 .. 60 ] characters

A short alphanumeric code used to identify the extraction project

description
required
string [ 1 .. 200 ] characters

A description of the extraction project

useEnduringLinkageKeys
boolean

A flag indicating if the linkage keys generated should be consistent over time and across the Linkage Project

Responses

Request samples

Content type
application/json
{
  • "lastModified": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "id": "string",
  • "projectId": 0,
  • "code": "string",
  • "description": "string",
  • "useEnduringLinkageKeys": true
}

Response samples

Content type
application/json
{
  • "lastModified": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "id": "string",
  • "projectId": 0,
  • "code": "string",
  • "description": "string",
  • "useEnduringLinkageKeys": true
}

Get an extraction project

Returns a single extraction project object based on the unique code assigned to it. The user must have permissions to view the extraction project.

path Parameters
id
required
string

The ID of the specific extraction project to return.

version
required
string
Default: "3.3"

The requested API version

Responses

Response samples

Content type
application/json
{
  • "lastModified": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "id": "string",
  • "projectId": 0,
  • "code": "string",
  • "description": "string",
  • "useEnduringLinkageKeys": true
}

Get extraction requests for an extraction project

Returns a list of all extractions associated with the extraction project with the specified id.

path Parameters
id
required
string
version
required
string
Default: "3.3"

The requested API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Extractions

Gets all extraction requests

Returns a list of extraction requests for linkage projects that the user has permissions to access.

path Parameters
version
required
string
Default: "3.3"

The requested API version

query Parameters
limit
integer <int32>

The maximum number of items to return.

offset
integer <int32>

The number of items from the beginning to start returning from.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an extraction request

This will request an extraction for a specific event type and return immediately. The extraction is executed as a job when available. All records of the specified event type will participate in the extraction.

path Parameters
version
required
string
Default: "3.3"

The requested API version

Request Body schema: application/json
id
integer <int32>

The primary identifier of the extraction generated by the system

extractionProjectId
required
string [ 1 .. 60 ] characters

The id of the parent extraction project

projectCode
required
string [ 1 .. 20 ] characters

The code of the linkage project that this linkage is a part of

eventTypeCode
required
string [ 1 .. 15 ] characters

The code of the event type that describes the type of data

status
integer <int32> (ExtractionStatus)
Enum: 0 1 2 3
statusName
string or null

Name of the current status of the extraction

createdDateTime
string <date-time>

The date and time that the extraction was created

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "extractionProjectId": "string",
  • "projectCode": "string",
  • "eventTypeCode": "string",
  • "status": 0,
  • "statusName": "string",
  • "createdDateTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "extractionProjectId": "string",
  • "projectCode": "string",
  • "eventTypeCode": "string",
  • "status": 0,
  • "statusName": "string",
  • "createdDateTime": "2019-08-24T14:15:22Z"
}

Get an extraction request

Returns a single extraction request for the id specified, assuming the user has permissions to access it.

Possible status values:

  • 0 = Unknown
  • 1 = Pending
  • 2 = Processing
  • 3 = Failed
  • 4 = Complete
path Parameters
id
required
integer <int32>

The ID of the specific extraction request.

version
required
string
Default: "3.3"

The requested API version

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "extractionProjectId": "string",
  • "projectCode": "string",
  • "eventTypeCode": "string",
  • "status": 0,
  • "statusName": "string",
  • "createdDateTime": "2019-08-24T14:15:22Z"
}

Get results for an extraction request

Returns all result resources for the extraction request id specified.

path Parameters
id
required
integer <int32>
version
required
string
Default: "3.3"

The requested API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ImportFormats

Get all import formats

Returns a list of all import format objects in the system.

path Parameters
version
required
string
Default: "3.3"

The requested API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an import format

Creates a new import format and saves it in the system.

path Parameters
version
required
string
Default: "3.3"

The requested API version

Request Body schema: application/json

The ImportFormat object to save.

lastModified
string <date-time>
version
string or null <byte>
id
integer <int32>

The system generated identifier for the import format

name
required
string [ 1 .. 200 ] characters

A friendly name for the import format

columnType
required
integer <int32> (ColumnType)
Enum: 0 1 2 3
columnTypeName
string or null

Name of the type of columns in the data

required
Array of objects (ImportFormatColumn)

Definitions for all columns

Responses

Request samples

Content type
application/json
{
  • "lastModified": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "id": 0,
  • "name": "string",
  • "columnType": 0,
  • "columnTypeName": "string",
  • "columns": [
    ]
}

Response samples

Content type
application/json
{
  • "lastModified": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "id": 0,
  • "name": "string",
  • "columnType": 0,
  • "columnTypeName": "string",
  • "columns": [
    ]
}

Get an import format

Returns a single import format object based on the unique code assigned to it. The user must have permissions to view the import format.

Possible column type values:

  • 0 = Unknown
  • 1 = FixedWidth
  • 2 = DelimitedByIndex
  • 3 = DelimitedByName
path Parameters
id
required
integer <int32>

The ID of the specific import format to return.

version
required
string
Default: "3.3"

The requested API version

Responses

Response samples

Content type
application/json
{
  • "lastModified": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "id": 0,
  • "name": "string",
  • "columnType": 0,
  • "columnTypeName": "string",
  • "columns": [
    ]
}

Update an import format

Updates an existing import format using the details passed in the body of the request.

path Parameters
id
required
integer <int32>

The ID of the import format to update.

version
required
string
Default: "3.3"

The requested API version

Request Body schema: application/json

A ImportFormat object containing the updated information.

lastModified
string <date-time>
version
string or null <byte>
id
integer <int32>

The system generated identifier for the import format

name
required
string [ 1 .. 200 ] characters

A friendly name for the import format

columnType
required
integer <int32> (ColumnType)
Enum: 0 1 2 3
columnTypeName
string or null

Name of the type of columns in the data

required
Array of objects (ImportFormatColumn)

Definitions for all columns

Responses

Request samples

Content type
application/json
{
  • "lastModified": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "id": 0,
  • "name": "string",
  • "columnType": 0,
  • "columnTypeName": "string",
  • "columns": [
    ]
}

Delete an import format

An import format cannot be deleted if it is being used by an active event type.

path Parameters
id
required
integer <int32>

The ID of the data propvider to delete.

version
required
string
Default: "3.3"

The requested API version

Responses

Jobs

Get all jobs

Returns a list of jobs for linkage projects that the user has permissions to access.

path Parameters
version
required
string
Default: "3.3"

The requested API version

query Parameters
limit
integer <int32>

The maximum number of items to return.

offset
integer <int32>

The number of items from the beginning to start returning from.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a job

Returns a job using its internal identifier.

path Parameters
id
required
integer <int32>

The ID of the job.

version
required
string
Default: "3.3"

The requested API version

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "state": "string",
  • "processingStart": "2019-08-24T14:15:22Z",
  • "processingFinish": "2019-08-24T14:15:22Z",
  • "projectId": 0,
  • "projectName": "string",
  • "dataProviderId": 0,
  • "dataProviderName": "string",
  • "eventTypeId": 0,
  • "stats": [
    ]
}

Linkages

Get all linkage requests

Returns a list of linkage requests for linkage projects that the user has permissions to access.

path Parameters
version
required
string
Default: "3.3"

The requested API version

query Parameters
limit
integer <int32>

The maximum number of items to return.

offset
integer <int32>

The number of items from the beginning to start returning from.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a linkage request

This will request a linkage for a specific data source and return immediately. The linkage is executed by the system in the background.

path Parameters
version
required
string
Default: "3.3"

The requested API version

Request Body schema: application/json
id
integer <int32>

The primary identifier of the linkage, generated by the system

projectCode
string or null

The code of the project that this linkage is a part of

name
string or null

A name to give the linkage, stored as the envelope name

status
integer <int32> (LinkageStatus)
Enum: 0 1 2 3
statusName
string or null

Name of the current status of the linkage

Array of objects or null (LinkageSource)

A list of sources that are used for this particular linkage

createdDateTime
string <date-time>

The date and time that the linkage was created

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "projectCode": "string",
  • "name": "string",
  • "status": 0,
  • "statusName": "string",
  • "linkageSources": [
    ],
  • "createdDateTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectCode": "string",
  • "name": "string",
  • "status": 0,
  • "statusName": "string",
  • "linkageSources": [
    ],
  • "createdDateTime": "2019-08-24T14:15:22Z"
}

Get a linkage request

Returns a specific linkage object based on the linkage request id. The linkage request must exist and the user must have permissions to view it.

Possible status values:

  • 0 = Pending
  • 1 = Processing
  • 2 = Failed
  • 3 = Complete
path Parameters
id
required
integer <int32>

The ID of the linkage request.

version
required
string
Default: "3.3"

The requested API version

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectCode": "string",
  • "name": "string",
  • "status": 0,
  • "statusName": "string",
  • "linkageSources": [
    ],
  • "createdDateTime": "2019-08-24T14:15:22Z"
}

Create a bulk linkage and extraction workflow

This will request a workflow to bulk load multiple data sources and return immediately. The workflow is processed by the system in the background.

path Parameters
version
required
string
Default: "3.3"

The requested API version

Request Body schema: application/json
projectCode
required
string [ 1 .. 20 ] characters

The code of the project that this linkage is a part of

name
required
string [ 1 .. 256 ] characters

A name to give this bulk linkage workflow

required
Array of objects (BulkLinkageEnvelope)

A list of envelopes that will be included in the workflow

extractionProjectId
string or null

The ID of an enduring extraction project that will be used to extract data from all linkage sources on completion of the linkage

Responses

Request samples

Content type
application/json
{
  • "projectCode": "string",
  • "name": "string",
  • "envelopes": [
    ],
  • "extractionProjectId": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectCode": "string",
  • "initiatedOn": "2019-08-24T14:15:22Z",
  • "processingStart": "2019-08-24T14:15:22Z",
  • "processingFinish": "2019-08-24T14:15:22Z",
  • "status": 0,
  • "statusName": "string"
}

MatchProviders

Get all match providers

Returns a list of match provider objects in the system.

path Parameters
version
required
string
Default: "3.3"

The requested API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a match provider

Returns a single match provider object based on the provider name.

path Parameters
providerName
required
string

The name of the match provider to return.

version
required
string
Default: "3.3"

The requested API version

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Get fields supported by a match provider

Returns all fields supported by the named provider.

path Parameters
providerName
required
string

The name of the specific match provider.

version
required
string
Default: "3.3"

The requested API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get comparison types supported by a match provider

Returns all comparison types supported by the named provider.

path Parameters
providerName
required
string

The name of the specific match provider.

version
required
string
Default: "3.3"

The requested API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Notifications

Get a notification

Returns a notification using its internal identifier.

path Parameters
id
required
integer <int32>

The ID of the notification.

version
required
string
Default: "3.3"

The requested API version

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "logLevel": "string",
  • "message": "string",
  • "attachmentFilename": "string",
  • "createdOn": "2019-08-24T14:15:22Z"
}

Download attachment of notification

Some notifications have associated attachments. If a notification does have an attachment, this call will download that attachment.

path Parameters
id
required
integer <int32>

The ID of the specific notification to download the attachment.

version
required
string
Default: "3.3"

The requested API version

Responses

Projects

Get all linkage projects

All linkage projects in the system that the user has permissions to access will be returned.

path Parameters
version
required
string
Default: "3.3"

The requested API version

query Parameters
limit
integer <int32>

The maximum number of items to return.

offset
integer <int32>

The number of items from the beginning to start returning from.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a linkage project

A new linkage project is created using the data passed in. Default match strategies and linkage fields will be created - if these require changing, separate calls to update/remove these will be required.

path Parameters
version
required
string
Default: "3.3"

The requested API version

Request Body schema: application/json

The Project object to save.

lastModified
string <date-time>
version
string or null <byte>
id
integer <int32>

The internal ID of the linkage project

code
required
string [ 1 .. 20 ] characters

The unique code used to identify the linkage project

name
required
string [ 1 .. 100 ] characters

A short name to identify the linkage project

description
required
string [ 1 .. 1000 ] characters

A description for the linkage project

notificationEmail
string or null <= 320 characters

Email address for notifications related to this particular project

isActive
boolean

A flag indicating if the linkage project is active and can be used

object (GroupConfig)

The group configuration defined for a linkage project. Grouping strategies are add-ins, hence the use of a string, but there are 4 built in strategies available: BinaryFileWeightedBestLinkGroupingStrategy - Weighted Best-Link Grouping(Disk) InMemoryWeightedBestLinkGroupingStrategy - Weighted Best-Link Grouping(In-Memory) BinaryFileMergeGroupingStrategy - Merge Grouping(Disk) InMemoryMergeGroupingStrategy - Merge Grouping(In-Memory)

required
Array of objects (EventTypeMember)

A list of event type members that are supported by the linkage project

Array of objects or null (ProjectLink)

A list of other projects that this linkage project links to

Responses

Request samples

Content type
application/json
{
  • "lastModified": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "id": 0,
  • "code": "string",
  • "name": "string",
  • "description": "string",
  • "notificationEmail": "string",
  • "isActive": true,
  • "groupConfig": {
    },
  • "eventTypeMembers": [
    ],
  • "projectLinks": [
    ]
}

Response samples

Content type
application/json
{
  • "lastModified": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "id": 0,
  • "code": "string",
  • "name": "string",
  • "description": "string",
  • "notificationEmail": "string",
  • "isActive": true,
  • "groupConfig": {
    },
  • "eventTypeMembers": [
    ],
  • "projectLinks": [
    ]
}

Get a linkage project

A single linkage project will be returned, based on the id value passed in. By setting the byCode parameter you can specify whether the system should find the project based on either an ID or a Code. If this parameter is not specified, the system will attempt to parse the value as an Integer - if successful, it will find the project by ID, otherwise it will find it by Code.

path Parameters
id
required
string

The ID or code of the specific project to return.

version
required
string
Default: "3.3"

The requested API version

query Parameters
byCode
boolean

An optional flag forcing the system to find the project by its code.

Responses

Response samples

Content type
application/json
{
  • "lastModified": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "id": 0,
  • "code": "string",
  • "name": "string",
  • "description": "string",
  • "notificationEmail": "string",
  • "isActive": true,
  • "groupConfig": {
    },
  • "eventTypeMembers": [
    ],
  • "projectLinks": [
    ]
}

Update a linkage project

Updates an existing project using the details passed in the body of the request.

path Parameters
id
required
integer <int32>

The ID of the project to update.

version
required
string
Default: "3.3"

The requested API version

Request Body schema: application/json

A Project object containing the updated information.

lastModified
string <date-time>
version
string or null <byte>
id
integer <int32>

The internal ID of the linkage project

code
required
string [ 1 .. 20 ] characters

The unique code used to identify the linkage project

name
required
string [ 1 .. 100 ] characters

A short name to identify the linkage project

description
required
string [ 1 .. 1000 ] characters

A description for the linkage project

notificationEmail
string or null <= 320 characters

Email address for notifications related to this particular project

isActive
boolean

A flag indicating if the linkage project is active and can be used

object (GroupConfig)

The group configuration defined for a linkage project. Grouping strategies are add-ins, hence the use of a string, but there are 4 built in strategies available: BinaryFileWeightedBestLinkGroupingStrategy - Weighted Best-Link Grouping(Disk) InMemoryWeightedBestLinkGroupingStrategy - Weighted Best-Link Grouping(In-Memory) BinaryFileMergeGroupingStrategy - Merge Grouping(Disk) InMemoryMergeGroupingStrategy - Merge Grouping(In-Memory)

required
Array of objects (EventTypeMember)

A list of event type members that are supported by the linkage project

Array of objects or null (ProjectLink)

A list of other projects that this linkage project links to

Responses

Request samples

Content type
application/json
{
  • "lastModified": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "id": 0,
  • "code": "string",
  • "name": "string",
  • "description": "string",
  • "notificationEmail": "string",
  • "isActive": true,
  • "groupConfig": {
    },
  • "eventTypeMembers": [
    ],
  • "projectLinks": [
    ]
}

Delete a linkage project

The linkage project is deleted from the system. The physical database back-end remains and must be removed or archived separately (and manually).

path Parameters
id
required
integer <int32>

The ID of the project to delete.

version
required
string
Default: "3.3"

The requested API version

Responses

Get envelopes for a linkage project

All envelopes that are associated with the specified linkage project will be returned.

path Parameters
id
required
integer <int32>

The ID of the specific project to return envelopes for.

version
required
string
Default: "3.3"

The requested API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Download project definition file for a linkage project

The project definition file is used by the Envelope Builder to convert a raw data file into an envelope that can recognised and loaded by the system. A separate project definition file is required for each event type.

path Parameters
id
required
integer <int32>

The ID of the project to download the definition file.

eventTypeCode
required
string

The CODE of the event type to download the definition file.

version
required
string
Default: "3.3"

The requested API version

Responses

Get extraction projects for a linkage project

All extraction projects created for the linkage project will be returned.

path Parameters
id
required
integer <int32>

The ID of the specific project to return extraction projects for.

version
required
string
Default: "3.3"

The requested API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get match configuration for a linkage project

Returns the match configuration for a specific project. Note that when a project is created, a default match configuration is created.

path Parameters
id
required
integer <int32>

The ID of the project to return the match configuration.

version
required
string
Default: "3.3"

The requested API version

Responses

Response samples

Content type
application/json
{
  • "lastModified": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "projectId": 0,
  • "matchProvider": "string",
  • "logType": 0,
  • "strategies": [
    ],
  • "weightCurves": [
    ]
}

Get weight curves for a linkage project

Weight curves are used to map partial agreements from match comparisons to a proportion of weight. Weight curves are referenced by matching fields within a strategy.

path Parameters
id
required
integer <int32>

The ID of the specific project to return the match configuration weight curves.

version
required
string
Default: "3.3"

The requested API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add weight curve to linkage project

Creates a new weight curve for use within the project.

path Parameters
id
required
integer <int32>

The ID of the specific project to add the weight curve to.

version
required
string
Default: "3.3"

The requested API version

Request Body schema: application/json

The WeightCurve object containing the information to add.

weightCurveId
integer <int32>

The internal identifier assigned to the weight curve

code
required
string [ 1 .. 20 ] characters

A user-defined code for referencing the weight curve

name
required
string [ 1 .. 100 ] characters

A name for the weight curve

decimalScale
required
integer <int32>

The granularity of the piecewise linear function

required
Array of objects (WeightCurvePoint)

These points define the piecewise linear function

Responses

Request samples

Content type
application/json
{
  • "weightCurveId": 0,
  • "code": "string",
  • "name": "string",
  • "decimalScale": 0,
  • "points": [
    ]
}

Get a weight curve for a linkage project

Returns a single weight curve using the internal id.

path Parameters
id
required
integer <int32>

The ID of the specific project to return the weight curve.

weightCurveId
required
integer <int32>

The ID of the weight curve to return.

version
required
string
Default: "3.3"

The requested API version

Responses

Response samples

Content type
application/json
{
  • "weightCurveId": 0,
  • "code": "string",
  • "name": "string",
  • "decimalScale": 0,
  • "points": [
    ]
}

Update weight curve for a linkage project

path Parameters
id
required
integer <int32>

The ID of a specific Project containing the weight curve.

weightCurveId
required
integer <int32>

The ID of the Weight Curve to modify.

version
required
string
Default: "3.3"

The requested API version

Request Body schema: application/json

A WeightCurve object containing the updated information.

weightCurveId
integer <int32>

The internal identifier assigned to the weight curve

code
required
string [ 1 .. 20 ] characters

A user-defined code for referencing the weight curve

name
required
string [ 1 .. 100 ] characters

A name for the weight curve

decimalScale
required
integer <int32>

The granularity of the piecewise linear function

required
Array of objects (WeightCurvePoint)

These points define the piecewise linear function

Responses

Request samples

Content type
application/json
{
  • "weightCurveId": 0,
  • "code": "string",
  • "name": "string",
  • "decimalScale": 0,
  • "points": [
    ]
}

Delete a weight curve from a linkage project

The weight curve is deleted from the project and the system.

path Parameters
id
required
integer <int32>

The ID of the Project to remove the weight curve from.

weightCurveId
required
integer <int32>

The ID of the WeightCurve to remove.

version
required
string
Default: "3.3"

The requested API version

Responses

Get match strategies in a linkage project

All match configuration strategies for the linkage project will be returned.

path Parameters
id
required
integer <int32>

The ID of the specific project to return the match configuration strategies.

version
required
string
Default: "3.3"

The requested API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a match strategy for a linkage project

A new match strategy is created with the details passed in. The order parameter of the strategy will determine the order in which it is executed during matching. The smallest order is executed first.

path Parameters
id
required
integer <int32>

The ID of the linkage project.

version
required
string
Default: "3.3"

The requested API version

Request Body schema: application/json

The MatchStrategy object containing the details to add.

lastModified
string <date-time>
version
string or null <byte>
id
integer <int32>

The internally assigned identifier for the strategy

name
required
string [ 1 .. 30 ] characters

The name of the strategy

order
required
integer <int32>

The order in which this strategy should be used in conjunction with other strategies

threshold
required
number <double>

All matching pair scores below this threshold value are discarded

isActive
boolean or null

A flag indicating if the strategy will be used.

required
Array of objects (BlockingField)

The list of fields used for creating blocks in this strategy

required
Array of objects (MatchingField)

The list of fields to match in this strategy

Responses

Request samples

Content type
application/json
{
  • "lastModified": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "id": 0,
  • "name": "string",
  • "order": 0,
  • "threshold": 0.1,
  • "isActive": true,
  • "blockingFields": [
    ],
  • "matchingFields": [
    ]
}

Get a match strategy for a linkage project

If the project and strategy IDs are valid, the match configuration strategy is returned.

path Parameters
id
required
integer <int32>

The ID of the linkage project.

strategyId
required
integer <int32>

The ID of the specific match strategy to return the match configuration strategy.

version
required
string
Default: "3.3"

The requested API version

Responses

Response samples

Content type
application/json
{
  • "lastModified": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "id": 0,
  • "name": "string",
  • "order": 0,
  • "threshold": 0.1,
  • "isActive": true,
  • "blockingFields": [
    ],
  • "matchingFields": [
    ]
}

Update a match strategy for a linkage project

An existing match strategy within a linkage project is updated with a new set of details.

path Parameters
id
required
integer <int32>

The ID of the linkage project.

strategyId
required
integer <int32>

The ID of the strategy to update.

version
required
string
Default: "3.3"

The requested API version

Request Body schema: application/json

The MatchStrategy object containing the new details.

lastModified
string <date-time>
version
string or null <byte>
id
integer <int32>

The internally assigned identifier for the strategy

name
required
string [ 1 .. 30 ] characters

The name of the strategy

order
required
integer <int32>

The order in which this strategy should be used in conjunction with other strategies

threshold
required
number <double>

All matching pair scores below this threshold value are discarded

isActive
boolean or null

A flag indicating if the strategy will be used.

required
Array of objects (BlockingField)

The list of fields used for creating blocks in this strategy

required
Array of objects (MatchingField)

The list of fields to match in this strategy

Responses

Request samples

Content type
application/json
{
  • "lastModified": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "id": 0,
  • "name": "string",
  • "order": 0,
  • "threshold": 0.1,
  • "isActive": true,
  • "blockingFields": [
    ],
  • "matchingFields": [
    ]
}

Delete a match strategy from a linkage project

The match strategy is deleted from the project and the system.

path Parameters
id
required
integer <int32>

The ID of the linkage project.

strategyId
required
integer <int32>

The ID of the strategy to delete.

version
required
string
Default: "3.3"

The requested API version

Responses

Get linkage fields for a linkage project

All linkage fields associated with the linkage project will be returned.

path Parameters
id
required
integer <int32>

The ID of a project to return the available linkage fields.

version
required
string
Default: "3.3"

The requested API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Results

Get all extraction results

Returns a list of result objects for linkage projects that the user has permissions to access.

path Parameters
version
required
string
Default: "3.3"

The requested API version

query Parameters
limit
integer <int32>

The maximum number of items to return.

offset
integer <int32>

The number of items from the beginning to start returning from.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get an extraction result

Returns a specific Result object based on the extraction result id. The extraction result must exist and the user must have permissions to view it.

path Parameters
id
required
integer <int32>

The ID of the specific extraction result to return.

version
required
string
Default: "3.3"

The requested API version

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "extractionId": 0,
  • "name": "string",
  • "sender": "string",
  • "canDownload": true
}

Delete an extraction result

Deletes an extraction result envelope by result id if file exists.

path Parameters
id
required
integer <int32>

The ID of the specific extraction result file to delete.

version
required
string
Default: "3.3"

The requested API version

Responses

Download data for an extraction result

Downloads the envelope created containing the extraction results. It returns a binary file (application/octect-stream) which is a zip file containing the data that was requested in the original extraction.

path Parameters
id
required
integer <int32>

The ID of the specific extraction result to download.

version
required
string
Default: "3.3"

The requested API version

Responses

Workflow

Get all workflows

Returns a list of workflows for linkage projects that the user has permissions to access.

path Parameters
version
required
string
Default: "3.3"

The requested API version

query Parameters
limit
integer <int32>

The maximum number of items to return.

offset
integer <int32>

The number of items from the beginning to start returning from.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a workflow

Returns a single workflow object that includes its current status.

Possible status values:

  • 0 = Unknown
  • 1 = Created
  • 2 = Queued
  • 3 = Processing
  • 4 = Complete
  • 5 = Failed
  • 6 = Cancelled
path Parameters
id
required
integer <int32>

The ID of the workflow.

version
required
string
Default: "3.3"

The requested API version

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectCode": "string",
  • "initiatedOn": "2019-08-24T14:15:22Z",
  • "processingStart": "2019-08-24T14:15:22Z",
  • "processingFinish": "2019-08-24T14:15:22Z",
  • "status": 0,
  • "statusName": "string"
}