Back to PipelinerEmailSequenceActivityLogs.create
Creates new emailsequenceactivitylog
Input
type: object
properties:
parameters:
type: object
properties:
validation-level:
type: integer
format: int32
description: >-
Specify validation level of emailsequenceactivitylog 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.
title: Parameters
data:
required:
- application_id
- email_sequence_id
- start_time
- status
properties:
modified:
type: string
format: date-time
example: '2019-01-01T00:00:00.000Z'
description: Last modification time.
readOnly: true
created:
type: string
format: date-time
example: '2019-01-01T00:00:00.000Z'
description: Creation time.
readOnly: true
actor_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
application_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
email_sequence_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
end_time:
type: string
format: date-time
example: '2019-01-01T00:00:00.000Z'
description: Datetime information.
is_test_run:
type: boolean
example: false
description: Boolean value.
start_time:
type: string
format: date-time
example: '2019-01-01T00:00:00.000Z'
description: Datetime information.
status:
type: integer
description: 'Integer enum value: 1 - Ok, 2 - Warning, 3 - Error'
example: 1
enum:
- 1
- 2
- 3
type: object
title: Data
Output
type: object
properties:
success:
type: boolean
example: true
description: True when response succeeded, false on error.
data:
required:
- is_delete_protected
- id
- application
- email_sequence
- application_id
- email_sequence_id
- start_time
- status
properties:
is_delete_protected:
type: boolean
example: false
description: >-
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.
readOnly: true
id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Unique identifier of entity.
readOnly: true
is_deleted:
type: boolean
example: false
description: Specifies if the entity is considered deleted.
readOnly: true
modified:
type: string
format: date-time
example: '2019-01-01T00:00:00.000Z'
description: Last modification time.
readOnly: true
created:
type: string
format: date-time
example: '2019-01-01T00:00:00.000Z'
description: Creation time.
readOnly: true
actor:
type: string
format: uri
description: >-
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.
application:
type: string
format: uri
description: >-
Relation to Application. By default it is returned as URI to related
resource. Using parameter 'expand', it will return full entity. See:
'Application' object for properties.
email_sequence:
type: string
format: uri
description: >-
Relation to EmailSequence. By default it is returned as URI to related
resource. Using parameter 'expand', it will return full entity. See:
'EmailSequence' object for properties.
actor_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
application_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
email_sequence_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
end_time:
type: string
format: date-time
example: '2019-01-01T00:00:00.000Z'
description: Datetime information.
is_test_run:
type: boolean
example: false
description: Boolean value.
start_time:
type: string
format: date-time
example: '2019-01-01T00:00:00.000Z'
description: Datetime information.
status:
type: integer
description: 'Integer enum value: 1 - Ok, 2 - Warning, 3 - Error'
example: 1
enum:
- 1
- 2
- 3
lines:
type: array
description: Relations to EmailSequenceActivityLogLines.
items:
type: string
format: uri
description: >-
Relation to EmailSequenceActivityLogLine. By default it is returned
as URI to related resource. Using parameter 'expand', it will return
full entity. See: 'EmailSequenceActivityLogLine' object for
properties.
record_name:
type: string
example: string
description: ''
record_email:
type: string
example: string
description: ''
type: object