Back to PipelinerOpptyProductRelations.update
Modifies opptyproductrelation or OpptyProductRelations with given id(s)
Input
type: object
properties:
parameters:
type: object
properties:
id:
type: string
format: uuid
description: ID of opptyproductrelation to update
validation-level:
type: integer
format: int32
description: >-
Specify validation level of opptyproductrelation 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:
paired_oppty_product_relation:
type: object
description: >-
Relation to OpptyProductRelation, see:
'updateOpptyProductRelationInput' object for properties.
properties:
id:
type: string
format: uri
amount:
type: number
format: double
example: '4.32'
description: |-
Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.
comment:
type: string
example: string
description: Multi-line text input field.
oppty_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
oppty_product_relation_type_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
paired_oppty_product_relation_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
price:
type: number
format: double
example: '4.32'
description: ''
quantity:
type: number
format: double
example: '4.32'
description: |-
Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.
quote_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
section_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: |-
Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.
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.
revenue_schedule:
type: object
description: >-
Relation to OpptyProductRelationRevenueSchedule, see:
'updateOpptyProductRelationRevenueScheduleInput' 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
- oppty_product_relation_type
- product
- product_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
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.
readOnly: true
oppty_product_relation_type:
type: string
format: uri
description: >-
Relation to OpptyProductRelationType. By default it is returned as URI
to related resource. Using parameter 'expand', it will return full
entity. See: 'OpptyProductRelationType' object for properties.
paired_oppty_product_relation:
type: string
format: uri
description: >-
Relation to OpptyProductRelation. By default it is returned as URI to
related resource. Using parameter 'expand', it will return full
entity. See: 'OpptyProductRelation' object for properties.
product:
type: string
format: uri
description: >-
Relation to Product. By default it is returned as URI to related
resource. Using parameter 'expand', it will return full entity. See:
'Product' object for properties.
readOnly: true
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.
amount:
type: number
format: double
example: '4.32'
description: |-
Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.
comment:
type: string
example: string
description: Multi-line text input field.
oppty_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
oppty_product_relation_type_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
paired_oppty_product_relation_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
price:
type: number
format: double
example: '4.32'
description: ''
product_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
readOnly: true
quantity:
type: number
format: double
example: '4.32'
description: |-
Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.
quote_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
section_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: |-
Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.
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.
revenue_schedule:
type: string
format: uri
description: >-
Relation to OpptyProductRelationRevenueSchedule. By default it is
returned as URI to related resource. Using parameter 'expand', it will
return full entity. See: 'OpptyProductRelationRevenueSchedule' object
for properties.
discount_value:
type: number
format: double
example: 4.32
description: ''
discount_percentage:
type: number
format: double
example: 4.32
description: ''
modified_by_user:
type: string
format: date-time
example: '2019-01-01T00:00:00.000Z'
description: ''
type: object