ImportMappingMasks.list

Returns all defined ImportMappingMasks

Request

Query Params

include-deleted

boolean

optional

if enabled, deleted ImportMappingMasks are returned as well

first

integer <int32>

optional

Number of entities to return from beginning of the result set. Max: 100. Default: 30

last

integer <int32>

optional

Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.

before

string

optional

Cursor until which to take entities to result set.

after

string

optional

Cursor after which to start taking entities to result set.

expand

string

optional

Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.

Example:

expand=owner,sales_unit,account_relations.account

order-by

string

optional

Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.

Example:

order-by=created,-modified

filter

object

optional

Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.

filter-op

object

optional

Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].

load-only

string

optional

Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.

Example:

load-only=id,name,owner.id

Responses

🟢200OK

application/json

list of ImportMappingMasks

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

array[object (ImportMappingMask) {16}]

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

owner

string <uri>

required

Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties.

entity_api_name

string

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

entity_type

enum<integer>

required

Integer enum value: 1 - Lead, 2 - Opportunity, 3 - Account, 4 - Contact, 5 - Client, 6 - Product, 7 - ProductPriceListPrice, 8 - CustomEntity

Allowed values:

12345678

Example:

mapping

object

required

Import mapping mask/relation_types in json format

name

string

required

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

owner_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

relation_types

object

optional

Import mapping mask/relation_types in json format

share_mode

enum<integer>

optional

Integer enum value: 1 - Private, 2 - Public, 0 - SelectedUnitsAndUsers

Allowed values:

012

Example:

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

sharing_clients

array[string <uri>]

optional

sharing_units

array[string <uri>]

optional

page_info

object

optional

Page info result set. Please note it is returned only when legacy limit & offset parameters are not used.

start_cursor

string

optional

Start cursor of result set.

Example:

WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==

end_cursor

string

optional

End cursor of result set.

Example:

WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==

has_previous_page

boolean

optional

If result set has previous page (if yes, use start_cursor value in before parameter to load it).

Example:

true

has_next_page

boolean

optional

If result set has next page (if yes, use end_cursor value in after parameter to load it).

Example:

true

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",
            "owner": "http://example.com",
            "entity_api_name": "string",
            "entity_type": 1,
            "mapping": {},
            "name": "string",
            "owner_id": "01234567-abcd-dcba-ffff-000000000000",
            "relation_types": {},
            "share_mode": 0,
            "revision": 1,
            "sharing_clients": [
                "http://example.com"
            ],
            "sharing_units": [
                "http://example.com"
            ]
        }
    ],
    "page_info": {
        "start_cursor": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==",
        "end_cursor": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==",
        "has_previous_page": true,
        "has_next_page": true
    }
}

🔴500Server Error

ImportMappingMasks.list

Request

Request samples

Responses