FormViews.get

Returns FormView with given id

Responses

🟢200OK

application/json

FormView data

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (FormView)

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

account_type

string <uri>

optional

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

contact_type

string <uri>

optional

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

lead_type

string <uri>

optional

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

string <uri>

optional

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.

owner

string <uri>

required

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

account_type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

contact_type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

hidden_item_ids

object

required

Ids of fields hidden on the form

item_colors

object

required

Field containing json.

lead_type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

name

string

required

Name of the entity and its default text representation.

Example:

string

oppty_type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

owner_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

share_mode

enum<integer>

optional

Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit

Allowed values:

0123

Example:

use_lang

boolean

optional

Boolean value.

Example:

false

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

entity_type_id

string <uuid>

required

Example:

01234567-abcd-dcba-ffff-000000000000

sharing_units

array[string <uri>]

optional

Relations to SalesUnits.

sharing_clients

array[string <uri>]

optional

Relations to Clients.

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",
        "account_type": "http://example.com",
        "contact_type": "http://example.com",
        "lead_type": "http://example.com",
        "oppty_type": "http://example.com",
        "owner": "http://example.com",
        "account_type_id": "01234567-abcd-dcba-ffff-000000000000",
        "contact_type_id": "01234567-abcd-dcba-ffff-000000000000",
        "hidden_item_ids": {},
        "item_colors": {},
        "lead_type_id": "01234567-abcd-dcba-ffff-000000000000",
        "name": "string",
        "oppty_type_id": "01234567-abcd-dcba-ffff-000000000000",
        "owner_id": "01234567-abcd-dcba-ffff-000000000000",
        "share_mode": 0,
        "use_lang": false,
        "revision": 1,
        "entity_type_id": "01234567-abcd-dcba-ffff-000000000000",
        "sharing_units": [
            "http://example.com"
        ],
        "sharing_clients": [
            "http://example.com"
        ]
    }
}

🟠404Record Not Found

🔴500Server Error

Request

Request samples

Responses