Skip to content
MoltaroMoltaroMoltaro Docs

Return entity definitions and compatible fields for profile configuration.

GET
/api/workspace/admin/record-matching/target-options
curl --request GET \
  --url https://example.com/api/workspace/admin/record-matching/target-options

Authorizations

Section titled “Authorizations”
  • None

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
access_token
string

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

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
Data

Entity definition and compatible primary-table fields available for profile configuration.

object
Entities
Array<object>
nullable

Selectable entity definition for record matching.

object
Id
string
nullable
Name
string
nullable
DisplayName
string
nullable
Fields
Array<object>
nullable

Selectable primary-table field for record matching, including exact normalizers and explicit fuzzy support.

object
Id

Entity-field definition identifier.

string
nullable
Key

Portable technical field key.

string
nullable
DisplayName

Current field label.

string
nullable
FieldType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
Normalizers

Supported exact and fuzzy normalizers.

Array<integer>
nullable
Allowed values: 0 1 2 3
SupportsFuzzy

Whether this field supports fuzzy TextKey comparison.

boolean
FuzzyAlgorithms

Supported fuzzy algorithms when SupportsFuzzy is true.

Array<integer>
nullable
Allowed values: 0
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": {
    "Entities": [
      {
        "Fields": [
          {
            "FieldType": 0,
            "Normalizers": [
              0
            ],
            "FuzzyAlgorithms": [
              0
            ]
          }
        ]
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}