Pipeliner API

Getting access, Developing, Testing

Back to Pipeliner

ImportMappingMasks.batch_create_or_update

Create or update an batch of ImportMappingMasks

Input

type: object properties: parameters: type: object properties: validation-level: type: integer format: int32 description: >- Specify validation level of ImportMappingMasks on change. 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. rollback-method: type: integer format: int32 description: >- Specify rollback method for ImportMappingMasks. 0 - rollback all, 1 - rollback only failed records. title: Parameters data: type: array items: properties: entity_type: type: integer description: >- Integer enum value: 1 - Lead, 2 - Opportunity, 3 - Account, 4 - Contact, 5 - Client, 6 - Product, 7 - ProductPriceListPrice example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 mapping: type: object description: Import mapping mask in json format name: type: string example: string description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. share_mode: type: integer description: >- Integer enum value: 1 - Private, 2 - Public, 0 - SelectedUnitsAndUsers example: 0 enum: - 0 - 1 - 2 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. sharing_clients: type: array description: '' items: type: object description: >- Relation to Client, see: 'updateClientInput' object for properties. properties: id: type: string format: uri sharing_units: type: array description: '' items: type: object description: >- Relation to SalesUnit, see: 'updateSalesUnitInput' object for properties. properties: id: type: string format: uri id: description: ID of object to update. type: string format: uuid type: object title: Data

Output

type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - properties: http_status: description: HTTP status code type: integer example: 400 code: description: Internal API error code type: integer example: 117 name: description: Name of the API error type: string example: ERROR_PARAMETER_INVALID message: description: Description of the API error type: string success: description: Always false on error. type: boolean example: false required: - success - http_status