Post Form Inputs

POST

https://app.hindsiteind.com/api/v2/form_inputs

POST

/api/v2/form_inputs

curl -X POST https://app.hindsiteind.com/api/v2/form_inputs \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "form_step_id": "string",
  "instruction_input_id": "string"
}'

201Created

{
  "id": "string",
  "input": "string",
  "unformatted_date_input": "string",
  "selected_multi_options": [
    {
      "id": "string",
      "value": "string",
      "colour": "string",
      "instruction_option_id": "string",
      "created_at": 1,
      "updated_at": 1
    }
  ],
  "selected_input_records": [
    {
      "id": "string",
      "title": "string",
      "recordable_id": "string",
      "recordable_type": "string",
      "created_at": 1,
      "updated_at": 1
    }
  ],
  "failed_validations": [
    "string"
  ],
  "prefix": "string",
  "suffix": "string",
  "instruction_input_title": "string",
  "instruction_input_id": "string",
  "attachments": [
    {
      "id": "string",
      "content": {
        "id": 1,
        "original": "string",
        "versions": [
          "string"
        ],
        "thumbnails": [
          "string"
        ],
        "title": "string",
        "created_at": 1,
        "updated_at": 1
      },
      "excluded_from_export": true,
      "created_at": 1,
      "updated_at": 1
    }
  ],
  "form_step_id": "string",
  "created_at": 1,
  "updated_at": 1,
  "conditional": true,
  "condition_met": true,
  "instruction_row_id": "string"
}

Authentication

AuthorizationBearer

OAuth 2.0 Client Credentials Flow. To obtain an access token:

Request API credentials from HINDSITE support to receive your client_id and client_secret
Make a POST request to obtain an access token:

POST https://app.hindsiteind.com/oauth/token
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET

The response will contain your access token:

{
  "access_token": "your_access_token_here",
  "token_type": "Bearer",
  "expires_in": 7200,
  "created_at": 1234567890
}

Include the token in subsequent API requests:

Authorization: Bearer your_access_token_here

Request

This endpoint expects an object.

form_step_idstringRequired

instruction_input_idstringRequired

inputstringOptional

Response

created FormInput

idstringOptional

ULID

inputstringOptional

unformatted_date_inputstringOptional

selected_multi_optionslist of objectsOptional

selected_input_recordslist of objectsOptional

failed_validationslist of stringsOptional

prefixstringOptional

suffixstringOptional

instruction_input_titlestringOptional

instruction_input_idstringOptional

ULID

attachmentslist of objectsOptional

form_step_idstringOptional

ULID

created_atlongOptional

Unix timestamp (seconds since epoch)

updated_atlongOptional

Unix timestamp (seconds since epoch)

conditionalbooleanOptional

True when the input only applies if another input’s answer meets its precondition (see InstructionInput.precondition)

condition_metbooleanOptional

Whether the answer to the triggering input currently meets this input’s precondition. Always true for inputs that are not conditional; a conditional input with condition_met false does not currently apply.

instruction_row_idstring or nullOptional

ULID of the table row this input is a cell of, on tabular steps (see InstructionStep.table). Null for regular inputs.