Skip to main content

ModifyHttpDataSourceInput

fields

  • connectionSettings optional PartialHttpConnectionSettingsInput

    The HTTP Data Source's new connection settings. If not provided this property will not be modified.

    The HTTP Data Source connection settings.

    • connectionSettings.basicAuth optional HttpBasicAuthInput

      The HTTP Basic authentication settings for uploading new data.

      If this parameter is not provided, anyone with the URL to your tables will be able to upload data. While it's OK to test without HTTP Basic authentication, we recommend enabling it. If not provided this property will not be modified.

      The fields for specifying an HTTP Data Source's Basic authentication settings.

      • connectionSettings.basicAuth.username required String

        The username for HTTP Basic authentication that must be included in the Authorization header when uploading new data.

      • connectionSettings.basicAuth.password required String

        The password for HTTP Basic authentication that must be included in the Authorization header when uploading new data.

    • connectionSettings.basicAuthEnabled optional Boolean

      Set this to false to disable HTTP Basic authentication. Any previously stored HTTP Basic authentication settings will be cleared out. If not provided this property will not be modified.

    • connectionSettings.tables optional array of HttpDataSourceTableInput

      The HTTP Data Source's tables. If not provided this property will not be modified.

      The fields for specifying an HTTP Data Source's table.

      • connectionSettings.tables.name required String

        The name of the table

      • connectionSettings.tables.columns required array of HttpDataSourceColumnInput

        All the columns present in the table

        The fields for specifying a column in an HTTP Data Source's table.

        • connectionSettings.tables.columns.name required String

          The column name. It has to be unique within a Table.

        • connectionSettings.tables.columns.type required ColumnType

          The column type.

          The Propel data types.

          • BOOLEAN

            True or false.

          • STRING

            A variable-length string.

          • FLOAT

            A 32-bit signed double-precision floating point number.

          • DOUBLE

            A 64-bit signed double-precision floating point number.

          • INT8

            An 8-bit signed integer, with a minimum value of -2⁷ and a maximum value of 2⁷-1.

          • INT16

            A 16-bit signed integer, with a minimum value of -2¹⁵ and a maximum value of 2¹⁵-1.

          • INT32

            A 32-bit signed integer, with a minimum value of -2³¹ and a maximum value of 2³¹-1.

          • INT64

            A 64-bit signed integer, with a minimum value of -2⁶³ and a maximum value of 2⁶³-1.

          • DATE

            A date without a timestamp. For example, "YYYY-MM-DD".

          • TIMESTAMP

            A date with a timestamp. For example, "yyy-MM-dd HH:mm:ss".

        • connectionSettings.tables.columns.nullable required Boolean

          Whether the column's type is nullable or not.

  • description optional String

    The HTTP Data Source's new description. If not provided this property will not be modified.

  • idOrUniqueName required idOrUniqueName

    The ID or unique name of the HTTP Data Source to modify.

    The ID or unique name input.

    If both ID and unique name are provided, the ID will take precedence.

  • uniqueName optional String

    The HTTP Data Source's new unique name. If not provided this property will not be modified.