COcoevera
Form

FormViews.create

Creates a FormView record.

post/entities/FormViews

Request

Query parameters

validation-levelinteger

Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

Request body

modifiedstring date-time

Last modification time.

createdstring date-time

Creation time.

account_type_idstring uuid

Id of the account type the form view applies to. Set when the form view targets accounts.

contact_type_idstring uuid

Id of the contact type the form view applies to. Set when the form view targets contacts.

hidden_item_idsobject required

Ids of fields and webresources hidden from the form for this view.

item_colorsobject required

Per-item color overrides for fields and webresources in the form, keyed by item id.

lead_type_idstring uuid

Id of the lead type the form view applies to. Set when the form view targets leads.

namestring required

Name of the entity and its default text representation.

oppty_type_idstring uuid

Id of the opportunity type.

owner_idstring uuid required

Id of the owning user.

share_mode0 | 1 | 2 | 3

Who besides the owner can use the form view: nobody (Private, the default), the users and sales units in sharing_clients and sharing_units (Standard), or all users (AllView to view, AllEdit to also edit).

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

use_langboolean

When true, the form view name is treated as a translation key and localized in the UI; otherwise the literal name is shown.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "modified": "2019-01-01T00:00:00",
  "created": "2019-01-01T00:00:00",
  "account_type_id": "01234567-abcd-dcba-ffff-000000000000",
  "contact_type_id": "01234567-abcd-dcba-ffff-000000000000",
  "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",
  "revision": 1
}

Response

The created FormView record.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "account_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "contact_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "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",
    "revision": 1,
    "entity_type_id": "01234567-abcd-dcba-ffff-000000000000"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.