v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Field

FieldMappings.update

Modifies FieldMapping or FieldMappings with given id(s)

patch/entities/FieldMappings/{id}

Path parameters

idstring uuid required

ID of FieldMapping to update

Query parameters

validation-levelinteger

Specify validation level of FieldMapping on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

Request body

is_systemboolean

True when the mapping is shipped by the platform and cannot be deleted by the user.

mappingstring binary

Default field-to-field mapping template applied when no per-type-pair mapping matches.

operation1 | 2 | 3 | 4 | 5 | 6

Field whose values are strictly defined with an enumeration of values.

Integer enum value: 1 - Default, 2 - Qualification, 3 - FollowUp, 4 - Parent, 5 - QualificationAndAutocreate, 6 - Conversion

type_mappingsstring binary

Per-type-pair field mappings: each entry binds a set of source/target type ids and the field-to-field mapping that applies when both types match.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "mapping": "blob",
  "operation": 1,
  "type_mappings": "blob",
  "revision": 1
}

Response

Modification confirmation. Returns resulting FieldMapping

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "mapping": "blob",
    "operation": 1,
    "source_entity_api_name": "string",
    "target_entity_api_name": "string",
    "type_mappings": "blob",
    "revision": 1,
    "source_entity_name": "string",
    "target_entity_name": "string"
  }
}