Pipeliner API

Getting access, Developing, Testing

Back to Pipeliner

Tasks.batch_create_or_update

Create or update an batch of Tasks

Input

type: object properties: parameters: type: object properties: validation-level: type: integer format: int32 description: >- Specify validation level of Tasks 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 Tasks. 0 - rollback all, 1 - rollback only failed records. title: Parameters data: type: array items: properties: activity_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. call_duration: type: integer format: int32 example: 1 description: >- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. call_outcome_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. description: type: string example: string description: Multi-line text input field. due_date: type: string format: date example: '2019-01-01T00:00:00.000Z' description: Task Due Date information. duration: type: number format: double example: '4.32' 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. priority: type: integer description: 'Integer enum value: 1 - Low, 2 - Medium, 3 - High' example: 1 enum: - 1 - 2 - 3 share_mode: type: integer description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit example: 0 enum: - 0 - 1 - 2 - 3 start_date: type: string format: date example: '2019-01-01T00:00:00.000Z' description: Date information. status: type: integer description: >- Integer enum value: 1 - NotStarted, 2 - InProgress, 3 - Waiting, 4 - Completed, 5 - Deferred example: 1 enum: - 1 - 2 - 3 - 4 - 5 subject: type: string example: string description: Name of the entity and its default text representation. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. sharing_units: type: array description: Relations to SalesUnits. items: type: object description: >- Relation to TaskSharingSalesUnitRelation, see: 'updateTaskSharingSalesUnitRelationInput' object for properties. properties: id: type: string format: uri sharing_clients: type: array description: Relations to Clients. items: type: object description: >- Relation to TaskSharingClientRelation, see: 'updateTaskSharingClientRelationInput' object for properties. properties: id: type: string format: uri account_relations: type: array description: Relations to Accounts. items: type: object description: >- Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties. properties: id: type: string format: uri contact_relations: type: array description: Relations to Contacts. items: type: object description: >- Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties. properties: id: type: string format: uri lead_relations: type: array description: Relations to Leads. items: type: object description: >- Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties. properties: id: type: string format: uri opportunity_relations: type: array description: Relations to Opportunitys. items: type: object description: >- Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties. properties: id: type: string format: uri project_relations: type: array description: Relations to Projects. items: type: object description: >- Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties. properties: id: type: string format: uri quote_relations: type: array description: Relations to Quotes. items: type: object description: >- Relation to ActivityRelation, see: 'updateActivityRelationInput' object for properties. properties: id: type: string format: uri exchange_entity_id: type: string example: string description: '' gapi_entity_id: type: string example: string description: '' o365_entity_id: type: string example: string description: '' task_recurrence: type: object description: >- Relation to TaskRecurrence, see: 'updateTaskRecurrenceInput' object for properties. properties: id: type: string format: uri documents: type: array description: Relations to CloudObjects. items: type: object description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. properties: id: type: string format: uri comments: type: array description: Relations to ActivityComments. items: type: object description: >- Relation to ActivityComment, see: 'updateActivityCommentInput' 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