Lookup active visible merge candidates by exact record id or number.

GET

/api/workspace/entity/{entityIdOrKey}/record-merge/lookup

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://example.com/api/workspace/entity/example/record-merge/lookup"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/entity/example/record-merge/lookup';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/workspace/entity/example/record-merge/lookup \
  --header 'Authorization: Bearer <token>'

Authorizations

WorkspaceBearer

Parameters

Path Parameters

entityIdOrKey

required

string

Query Parameters

query

string

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Responses

200

application/json

object

Data

Any of:

object
object

Lookup result for details-page merge candidate selection.

object

Candidates

Array<object>

nullable

Compact record candidate used by merge lookup and merge drafts.

object

required

string

Number

string

nullable

DisplayName

required

string

Subtitle

string

nullable

IsArchived

required

boolean

RowVersion

required

string format: uuid

OpenTarget

required

object

TargetCode

string

nullable

Parameters

object

key

additional properties

string

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": null,
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

application/json

object

Data

Any of:

object
object

Lookup result for details-page merge candidate selection.

object

Candidates

Array<object>

nullable

Compact record candidate used by merge lookup and merge drafts.

object

required

string

Number

string

nullable

DisplayName

required

string

Subtitle

string

nullable

IsArchived

required

boolean

RowVersion

required

string format: uuid

OpenTarget

required

object

TargetCode

string

nullable

Parameters

object

key

additional properties

string

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": null,
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Forbidden

application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

application/json

object

Data

Any of:

object
object

Lookup result for details-page merge candidate selection.

object

Candidates

Array<object>

nullable

Compact record candidate used by merge lookup and merge drafts.

object

required

string

Number

string

nullable

DisplayName

required

string

Subtitle

string

nullable

IsArchived

required

boolean

RowVersion

required

string format: uuid

OpenTarget

required

object

TargetCode

string

nullable

Parameters

object

key

additional properties

string

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": null,
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

409

Conflict

application/json

object

Data

Any of:

object
object

Lookup result for details-page merge candidate selection.

object

Candidates

Array<object>

nullable

Compact record candidate used by merge lookup and merge drafts.

object

required

string

Number

string

nullable

DisplayName

required

string

Subtitle

string

nullable

IsArchived

required

boolean

RowVersion

required

string format: uuid

OpenTarget

required

object

TargetCode

string

nullable

Parameters

object

key

additional properties

string

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": null,
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Lookup active visible merge candidates by exact record id or number.

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

Example

400

Example

403

Examplegenerated

404

Example

409

Example

Example^generated