OpptyProductRelations.get

Returns OpptyProductRelation with given id

Responses

🟢200OK

application/json

OpptyProductRelation data

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (OpptyProductRelation)

optional

is_delete_protected

boolean

read-onlyrequired

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.

Example:

false

string <uuid>

read-onlyrequired

Unique identifier of entity.

Example:

01234567-abcd-dcba-ffff-000000000000

is_deleted

boolean

read-onlyoptional

Specifies if the entity is considered deleted.

Example:

false

modified

string <date-time>

read-onlyoptional

Last modification time.

Example:

2019-01-01T00:00:00

created

string <date-time>

read-onlyoptional

Creation time.

Example:

2019-01-01T00:00:00

currency_exchange_rates_list

string <uri>

optional

Relation to CurrencyExchangeRatesList. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CurrencyExchangeRatesList' object for properties.

online_form_field

string <uri>

optional

Relation to Field. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Field' object for properties.

online_form

string <uri>

optional

Relation to OnlineForm. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OnlineForm' object for properties.

oppty

string <uri>

read-onlyoptional

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.

oppty_product_relation_type

string <uri>

required

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

string <uri>

optional

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

string <uri>

read-onlyrequired

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.

quote

string <uri>

optional

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

number <double>

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

4.32

comment

string

optional

Multi-line text input field.

Example:

string

currency_exchange_rates_list_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

online_form_field_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

online_form_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

oppty_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

oppty_product_relation_type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

paired_oppty_product_relation_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

price

number <double>

optional

Example:

4.32

product_id

string <uuid>

read-onlyrequired

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

quantity

number <double>

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

4.32

quote_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

section_id

string <uuid>

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

01234567-abcd-dcba-ffff-000000000000

sort_order

integer <int32>

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

revenue_schedule

string <uri>

optional

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

number <double>

optional

Example:

4.32

discount_percentage

number <double>

optional

Example:

4.32

modified_by_user

string <date-time>

optional

Example:

2019-01-01T00:00:00

Example

{
  "success": true,
  "data": {
    "is_delete_protected": false,
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "is_deleted": false,
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "currency_exchange_rates_list": "http://example.com",
    "online_form_field": "http://example.com",
    "online_form": "http://example.com",
    "oppty": "http://example.com",
    "oppty_product_relation_type": "http://example.com",
    "paired_oppty_product_relation": "http://example.com",
    "product": "http://example.com",
    "quote": "http://example.com",
    "amount": "4.32",
    "comment": "string",
    "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
    "online_form_field_id": "01234567-abcd-dcba-ffff-000000000000",
    "online_form_id": "01234567-abcd-dcba-ffff-000000000000",
    "oppty_id": "01234567-abcd-dcba-ffff-000000000000",
    "oppty_product_relation_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "paired_oppty_product_relation_id": "01234567-abcd-dcba-ffff-000000000000",
    "price": "4.32",
    "product_id": "01234567-abcd-dcba-ffff-000000000000",
    "quantity": "4.32",
    "quote_id": "01234567-abcd-dcba-ffff-000000000000",
    "section_id": "01234567-abcd-dcba-ffff-000000000000",
    "sort_order": 1,
    "revision": 1,
    "revenue_schedule": "http://example.com",
    "discount_value": 4.32,
    "discount_percentage": 4.32,
    "modified_by_user": "2019-01-01T00:00:00"
  }
}

🟠404Record Not Found

🔴500Server Error

OpptyProductRelations.get

Request

Request samples

Responses