FieldMappings.create - PipelinerCRM

Creates new FieldMapping

Request

Query Params

validation-level

integer <int32>

optional

Specify validation level of FieldMapping on create. 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.

Body Params application / json

is_system

boolean

required

Boolean value.

Example:

false

mapping

string <binary>

optional

Example:

blob

operation

enum<integer>

optional

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

Allowed values:

123456

Example:

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

documents

array [object {1}]

optional

Relations to CloudObjects.

string <uri>

optional

Example

{
    "is_system": false,
    "mapping": "blob",
    "operation": 1,
    "revision": 1,
    "documents": [
        {
            "id": "http://example.com"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/json

Creation confirmation. Returns created FieldMapping

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (FieldMapping)

optional

is_delete_protected

boolean

read-onlyrequired

Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.

Example:

false

string <uuid>

read-onlyrequired

Unique identifier of entity.

Example:

01234567-abcd-dcba-ffff-000000000000

is_deleted

boolean

read-onlyoptional

Specifies if the entity is considered deleted.

Example:

false

modified

string <date-time>

read-onlyoptional

Last modification time.

Example:

2019-01-01T00:00:00

created

string <date-time>

read-onlyoptional

Creation time.

Example:

2019-01-01T00:00:00

is_system

boolean

required

Boolean value.

Example:

false

mapping

string <binary>

optional

Example:

blob

operation

enum<integer>

optional

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

Allowed values:

123456

Example:

source_entity_api_name

string

optional

Example:

string

target_entity_api_name

string

optional

Example:

string

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

source_entity_name

string

required

Example:

string

target_entity_name

string

required

Example:

string

documents

array[string <uri>]

optional

Relations to CloudObjects.

Example

{
    "success": true,
    "data": {
        "is_delete_protected": false,
        "id": "01234567-abcd-dcba-ffff-000000000000",
        "is_deleted": false,
        "modified": "2019-01-01T00:00:00",
        "created": "2019-01-01T00:00:00",
        "is_system": false,
        "mapping": "blob",
        "operation": 1,
        "source_entity_api_name": "string",
        "target_entity_api_name": "string",
        "revision": 1,
        "source_entity_name": "string",
        "target_entity_name": "string",
        "documents": [
            "http://example.com"
        ]
    }
}

🔴500Server Error