MetadataPreviewResponse

Response containing metadata preview

externalIdstringrequired

External ID used

externalUrlstring | nullnullable

External URL (link to provider's page)

fields object[]required

Field-by-field preview

Array [

currentValue

Current value in database

fieldstringrequired

Field name

proposedValue

Proposed value from plugin

reasonstring | nullnullable

Human-readable reason for status

statusFieldApplyStatus (string)required

Apply status

Possible values: [will_apply, locked, no_permission, unchanged, not_provided]

]

pluginIdstring<uuid>required

Plugin that provided the metadata

pluginNamestringrequired

Plugin name

summary objectrequired

Summary counts

lockedintegerrequired

Number of fields that are locked

Possible values: >= 0

noPermissionintegerrequired

Number of fields with no permission

Possible values: >= 0

notProvidedintegerrequired

Number of fields not provided

Possible values: >= 0

unchangedintegerrequired

Number of fields that are unchanged

Possible values: >= 0

willApplyintegerrequired

Number of fields that will be applied

Possible values: >= 0

MetadataPreviewResponse

{
  "externalId": "string",
  "externalUrl": "string",
  "fields": [
    {
      "field": "string",
      "reason": "string",
      "status": "will_apply"
    }
  ],
  "pluginId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "pluginName": "string",
  "summary": {
    "locked": 0,
    "noPermission": 0,
    "notProvided": 0,
    "unchanged": 0,
    "willApply": 0
  }
}