Model: WorkRequestFormFieldUpdateRequest

1 min

Model Parameters

WorkRequestFormFieldUpdateRequest
- objectWorkRequestRequestFormFieldBriefTypePayload
  - typestring<brief>required
    Example
    brief
    Description
    Type of the form field
    Allowed
    brief
  - valuesWorkRequestAttachmentBriefRequest[]required
    Description
    Brief value payload
    - typestring<attachment_brief>required
      Example
      attachment_brief
      Allowed
      attachment_brief
    - valueobjectrequired
      - keystringrequired
        Example
        6dzf4ds4fds4f4564dzsfd
        Description
        Unique identifier of the file upload session. This should be the value of upload_meta_fields.key retrieved using the /v3/upload-url endpoint
      - namestringrequired
        Example
        Sample-name
        Description
        Name of the attachment brief
- objectWorkRequestRequestFormFieldCheckboxTypePayload
  - typestring<checkbox>required
    Example
    checkbox
    Description
    Type of the form field
    Allowed
    checkbox
  - valuesstring[]required
    Example
    [ "63342902e84c7544973c07ce", "633429b2e84c7544973c07e7" ]
    Description
    Unique identifiers of the choices
- objectWorkRequestRequestFormFieldCurrencyNumberTypePayload
  - typestring<currency_number>required
    Example
    currency_number
    Description
    Type of the form field
    Allowed
    currency_number
  - valuesstring[]required
    Example
    [ "123.45" ]
    Description
    Currency amount for the form field
- objectWorkRequestRequestFormFieldDateTypePayload
  - typestring<date>required
    Example
    date
    Description
    Type of the form field
    Allowed
    date
  - valuesstring[]required
    Example
    [ "2022-04-30T06:00:00.00Z" ]
    Description
    Date and time, in ISO 8601 UTC format
- objectWorkRequestRequestFormFieldDropdownTypePayload
  - typestring<dropdown>required
    Example
    dropdown
    Description
    Type of the form field
    Allowed
    dropdown
  - valuesstring[]required
    Example
    [ "63342902e84c7544973c07ce" ]
    Description
    Unique identifier of the choice for the form field
- objectWorkRequestRequestFormFieldFileTypePayload
  - typestring<file>required
    Example
    file
    Description
    Type of the form field
    Allowed
    file
  - valuesobject[]required
    Example
    [ { "key": "123456/789654", "name": "My File" } ]
    Description
    uploaded file values
    - keystringrequired
      Description
      Unique identifier of the file upload session. This is the upload_meta_fields.key field was retrieved from the /v3/upload-url endpoint.
    - namestringrequired
      Description
      Name for the file
      Min Length
      1
- objectWorkRequestRequestFormFieldLabelTypePayload
  - typestring<label>required
    Example
    label
    Description
    Type of the form field
    Allowed
    label
  - valuesstring[]required
    Example
    [ "63342902e84c7544973c07ce" ]
    Description
    Unique identifiers of label values for the form field
- objectWorkRequestRequestFormFieldPercentageNumberTypePayload
  - typestring<percentage_number>required
    Example
    percentage_number
    Description
    Type of the form field
    Allowed
    percentage_number
  - valuesstring[]required
    Example
    [ "123.456" ]
    Description
    Value for the form field
- objectWorkRequestRequestFormFieldRadioButtonTypePayload
  - typestring<radio_button>required
    Example
    radio_button
    Description
    Type of the form field
    Allowed
    radio_button
  - valuesstring[]required
    Example
    [ "63342902e84c7544973c07ce" ]
    Description
    Unique identifier of the choice for the form field
- objectWorkRequestRequestFormFieldRichtextTypePayload
  - typestring<richtext>required
    Example
    richtext
    Description
    Type of the form field
    Allowed
    richtext
  - valuesstring[]required
    Example
    [ "<h1>hello world</h1>" ]
    Description
    Value of the form field
- objectWorkRequestRequestFormFieldSimpleNumberTypePayload
  - typestring<simple_number>required
    Example
    simple_number
    Description
    Type of the form field
    Allowed
    simple_number
  - valuesstring[]required
    Example
    [ "123.456" ]
    Description
    Value of the form field
- objectWorkRequestRequestFormFieldTextAreaTypePayload
  - typestring<text_area>required
    Example
    text_area
    Description
    Type of the form field
    Allowed
    text_area
  - valuesstring[]required
    Example
    [ "Hello world" ]
    Description
    Value of the form field
- objectWorkRequestRequestFormFieldTextTypePayload
  - typestring<text>required
    Example
    text
    Description
    Type of the form field
    Allowed
    text
  - valuesstring[]required
    Example
    [ "Hello world" ]
    Description
    Value of the form field