Back to PipelinerEntityScorings.create
Creates new entityscoring
Input
type: object
properties:
parameters:
type: object
properties:
validation-level:
type: integer
format: int32
description: >-
Specify validation level of entityscoring 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:
- entity_type
- is_enabled
- name
- settings
- sort_order
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
entity_type:
type: integer
description: >-
Integer enum value: 1 - Lead, 2 - Account, 3 - Contact, 4 -
Opportunity, 5 - Task, 6 - Appointment, 7 - OpptyProductRelation, 8 -
Project, 9 - Quote
example: 1
enum:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
is_enabled:
type: boolean
example: false
description: Boolean value.
name:
type: string
example: string
description: Name of the entity and its default text representation.
settings:
type: object
description: Entity scoring definition in json format.
sort_order:
type: integer
format: int32
example: 1
description: |-
Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.
use_lang:
type: boolean
example: false
description: Boolean value.
revision:
type: integer
format: int32
example: 1
description: Revision when entity was lastly changed.
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
- entity_type
- is_enabled
- name
- settings
- sort_order
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
entity_type:
type: integer
description: >-
Integer enum value: 1 - Lead, 2 - Account, 3 - Contact, 4 -
Opportunity, 5 - Task, 6 - Appointment, 7 - OpptyProductRelation, 8 -
Project, 9 - Quote
example: 1
enum:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
is_enabled:
type: boolean
example: false
description: Boolean value.
name:
type: string
example: string
description: Name of the entity and its default text representation.
settings:
type: object
description: Entity scoring definition in json format.
sort_order:
type: integer
format: int32
example: 1
description: |-
Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.
use_lang:
type: boolean
example: false
description: Boolean value.
revision:
type: integer
format: int32
example: 1
description: Revision when entity was lastly changed.
type: object