Inputs

Inputs are used to manage the Input configuration of an endpoint.

Inputs are not changed by the API. They have the same values on the return from the API call as they do before the API call. Inputs can be used to pass needed information to the API to enable it to perform its function.

An Input can be created using the same Data Types that are used in the database.

  • Text

  • Integer

  • Object

  • Table Reference

  • Database Link

  • Enum

  • Bool

  • Decimal

  • Email

  • JSON

  • Password

  • Timestamp

  • Storage:

    • File

    • Image Metadata

    • Video Metadata

    • Attachment Metadata

  • Geography:

    • Point

    • Point Collection

    • Path

    • Path Collection

    • Polygon

    • Polygon Collection

Here's a look at the structure of an Input:

  1. Name: this is the title given to the Input.

  2. Required: the default value is "no", this determines whether or not the API needs the Input to work.

  3. Description: this is an optional internal explanation of the Input.

  4. Default Value: this is an optional value that is automatically assigned to the Input.

  5. Structure: the default value is "single", this determines whether or not the API needs a single Input or an array of Inputs.

  6. Nullable: the default value is "no", this determines whether or not the API will allow a value of "null".

  7. API Access: the default value is "public", the other options are "private" and "internal".