COcoevera
Online Form

OnlineForms.create

Creates a OnlineForm record.

post/entities/OnlineForms

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.

currency_exchange_rates_list_idstring uuid

Id of the currency exchange rate list applied to product line items at submission time.

email_idstring uuid

Id of the linked email record, when available.

field_idsobject required

Ids of the fields included in the form when this submission was captured, as a JSON array of field ids (UUIDs).

online_form_type_idstring uuid required

Id of the online form definition.

product_currency_idstring uuid

Id of the selected currency.

product_price_list_idstring uuid

Id of the selected price list.

status1 | 2 | 3 | 4 | 5

Overall result of processing the submission: the most severe status among its activity log lines, Error when a step failed.

Integer enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired

revisioninteger

Revision when entity was lastly changed.

Example request

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

Response

The created OnlineForm 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",
    "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
    "email_id": "01234567-abcd-dcba-ffff-000000000000",
    "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,
    "responded_by": "string",
    "response_date": "2019-01-01T00:00:00"
  }
}

Changes

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