Back to PipelinerEntityFitnesses.update
Modifies entityfitness or EntityFitnesses with given id(s)
Input
type: object
properties:
parameters:
type: object
properties:
id:
type: string
format: uuid
description: ID of entityfitness to update
validation-level:
type: integer
format: int32
description: >-
Specify validation level of entityfitness on update. 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.
required:
- id
title: Parameters
data:
properties:
revision:
type: integer
format: int32
example: 1
description: Revision when entity was lastly changed.
indicator_relations:
type: array
description: Relations to EntityFitnessIndicators.
items:
type: object
description: >-
Relation to EntityFitnessIndicator, see:
'updateEntityFitnessIndicatorInput' object for properties.
properties:
id:
type: string
format: uri
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_id
- entity_type
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
lead_type:
type: string
format: uri
description: >-
Relation to LeadType. By default it is returned as URI to related
resource. Using parameter 'expand', it will return full entity. See:
'LeadType' object for properties.
oppty_type:
type: string
format: uri
description: >-
Relation to OpportunityType. By default it is returned as URI to
related resource. Using parameter 'expand', it will return full
entity. See: 'OpportunityType' object for properties.
lead_type_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
oppty_type_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.
indicator_relations:
type: array
description: Relations to EntityFitnessIndicators.
items:
type: string
format: uri
description: >-
Relation to EntityFitnessIndicator. By default it is returned as URI
to related resource. Using parameter 'expand', it will return full
entity. See: 'EntityFitnessIndicator' object for properties.
entity_type_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: ''
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
type: object