Back to PipelinerActivityRelations.update
Modifies activityrelation or ActivityRelations with given id(s)
Input
type: object
properties:
parameters:
type: object
properties:
id:
type: string
format: uuid
description: ID of activityrelation to update
validation-level:
type: integer
format: int32
description: >-
Specify validation level of activityrelation 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:
project_objective:
type: object
description: >-
Relation to ProjectObjective, see: 'updateProjectObjectiveInput'
object for properties.
properties:
id:
type: string
format: uri
account_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
activity_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: |-
Relation to single abstract entity instance.
E.g. Relation to Lead/Oppty
contact_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
lead_oppty_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: |-
Relation to single abstract entity instance.
E.g. Relation to Lead/Oppty
project_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
project_objective_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
quote_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
sort_order:
type: integer
format: int32
example: 1
description: |-
Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.
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
- activity_id
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
account:
type: string
format: uri
description: >-
Relation to Account. By default it is returned as URI to related
resource. Using parameter 'expand', it will return full entity. See:
'Account' object for properties.
appointment:
type: string
format: uri
description: >-
Relation to Appointment. By default it is returned as URI to related
resource. Using parameter 'expand', it will return full entity. See:
'Appointment' object for properties.
task:
type: string
format: uri
description: >-
Relation to Task. By default it is returned as URI to related
resource. Using parameter 'expand', it will return full entity. See:
'Task' object for properties.
contact:
type: string
format: uri
description: >-
Relation to Contact. By default it is returned as URI to related
resource. Using parameter 'expand', it will return full entity. See:
'Contact' object for properties.
lead:
type: string
format: uri
description: >-
Relation to Lead. By default it is returned as URI to related
resource. Using parameter 'expand', it will return full entity. See:
'Lead' object for properties.
oppty:
type: string
format: uri
description: >-
Relation to Opportunity. By default it is returned as URI to related
resource. Using parameter 'expand', it will return full entity. See:
'Opportunity' object for properties.
project:
type: string
format: uri
description: >-
Relation to Project. By default it is returned as URI to related
resource. Using parameter 'expand', it will return full entity. See:
'Project' object for properties.
project_objective:
type: string
format: uri
description: >-
Relation to ProjectObjective. By default it is returned as URI to
related resource. Using parameter 'expand', it will return full
entity. See: 'ProjectObjective' object for properties.
quote:
type: string
format: uri
description: >-
Relation to Quote. By default it is returned as URI to related
resource. Using parameter 'expand', it will return full entity. See:
'Quote' object for properties.
account_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
activity_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: |-
Relation to single abstract entity instance.
E.g. Relation to Lead/Oppty
contact_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
lead_oppty_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: |-
Relation to single abstract entity instance.
E.g. Relation to Lead/Oppty
project_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
project_objective_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
quote_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
sort_order:
type: integer
format: int32
example: 1
description: |-
Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.
revision:
type: integer
format: int32
example: 1
description: Revision when entity was lastly changed.
type: object