REST API Reference

Back Next

Connector data types

When you submit a request for connector metadata, data type is included in the response. Data types for connector attributes are returned in REST API responses using a numeric value.

The following example shows a response with the type value of 2:

      {
        "name": "database",
        "label": "",
        "id": "",
        "value": "",
        "type": 2,
        "isMandatory": true,
        "visible": false,
        "list": []
      },

The type value of 2 means the database attribute can only contain alphabetic characters.

The following table lists the numeric values that might be included in the response and the corresponding data type:

Value	Data Type	Description
1	NUMERIC_TYPE	Attribute value can only contain numbers.
2	ALPHABET_TYPE	Attribute value can only contain alphabetic characters.
3	NUMERIC_TYPE/ALPHABET_TYPE	Attribute value can only contain numbers or alphabetic characters.
4	SYMBOLS_TYPE	Attribute value can only contain symbols.
5	NUMERIC_TYPE/SYMBOLS_TYPE	Attribute value can only contain numbers and symbols.
6	ALPHABET_TYPE/SYMBOLS_TYPE	Attribute value can only contain alphabetic characters and symbols.
7	NUMERIC_TYPE/ALPHABET_TYPE/SYMBOLS_TYPE	Attribute value can only contain alphabetic characters, numbers, and symbols.
8	LIST_TYPE	Attribute value can only contain values from a predefined list.
9	NUMERIC_TYPE/LIST_TYPE	Attribute value can only contain values from a predefined list and the value contains only numbers.
10	ALPHABET_TYPE/LIST_TYPE	Attribute value can only contain values from a predefined list and the value contains only numbers.
11	NUMERIC_TYPE/ALPHABET_TYPE/LIST_TYPE	Attribute value can only contain values from a predefined list and the value contains only alphabetic characters and numbers.
12	SYMBOLS_TYPE/LIST_TYPE	Attribute value can only contain values from a predefined list and the value contains only symbols.
13	NUMERIC_TYPE/SYMBOLS_TYPE/LIST_TYPE	Attribute value can only contain values from a predefined list and the value contains only numbers and symbols.
14	ALPHABET_TYPE/SYMBOLS_TYPE/LIST_TYPE	Attribute value can only contain values from a predefined list and the value contains only alphabetic characters and symbols.
15	NUMERIC_TYPE/ALPHABET_TYPE/SYMBOLS_TYPE/LIST_TYPE	Attribute value can only contain values from a predefined list and the value contains only alphabetic characters, numbers, and symbols.
16	BOOLEAN	Attribute value is a boolean.
32	PASSWORD	Attribute value is a password.