OnlineForms.get

Returns OnlineForm with given id

Responses

🟢200OK

application/json

OnlineForm data

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (OnlineForm)

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.

string <uri>

optional

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

online_form_type

string <uri>

required

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

product_currency

string <uri>

required

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

product_price_list

string <uri>

optional

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

currency_exchange_rates_list_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

email_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

field_ids

object

required

Field containing json.

online_form_type_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

product_currency_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

product_price_list_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

status

enum<integer>

optional

Integer enum value: 1 - Ok, 2 - Warning, 3 - Error

Allowed values:

123

Example:

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

account_relations

array[string <uri>]

optional

Relations to Accounts.

contact_relations

array[string <uri>]

optional

Relations to Contacts.

lead_relations

array[string <uri>]

optional

Relations to Leads.

opportunity_relations

array[string <uri>]

optional

Relations to Opportunitys.

quote_relations

array[string <uri>]

optional

Relations to Quotes.

project_relations

array[string <uri>]

optional

Relations to Projects.

custom_entity_relations

array[string <uri>]

optional

Relations to CustomEntitys.

lines

array[string <uri>]

optional

Relations to OnlineFormActivityLogLines.

responded_by

string

required

Example:

string

response_date

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",
        "email": "http://example.com",
        "online_form_type": "http://example.com",
        "product_currency": "http://example.com",
        "product_price_list": "http://example.com",
        "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
        "email_id": "01234567-abcd-dcba-ffff-000000000000",
        "field_ids": {},
        "online_form_type_id": "01234567-abcd-dcba-ffff-000000000000",
        "product_currency_id": "01234567-abcd-dcba-ffff-000000000000",
        "product_price_list_id": "01234567-abcd-dcba-ffff-000000000000",
        "status": 1,
        "revision": 1,
        "account_relations": [
            "http://example.com"
        ],
        "contact_relations": [
            "http://example.com"
        ],
        "lead_relations": [
            "http://example.com"
        ],
        "opportunity_relations": [
            "http://example.com"
        ],
        "quote_relations": [
            "http://example.com"
        ],
        "project_relations": [
            "http://example.com"
        ],
        "custom_entity_relations": [
            "http://example.com"
        ],
        "lines": [
            "http://example.com"
        ],
        "responded_by": "string",
        "response_date": "2019-01-01T00:00:00"
    }
}

🟠404Record Not Found

🔴500Server Error

Request

Request samples

Responses