Snap-in developmentReferences

Inputs

Inputs are settings for a snap-in that allows behavior customization. They’re scoped to either an organization or a user. Organization-scoped inputs remain common for the organization, while user-scoped settings need to be set for each user. Each input’s schema maps to field descriptor. Snap-ins don’t support inputs of type date, timestamp or array of booleans. Refer to schema field descriptor example for other supported global types:

1{
2  "description": "string",
3  "is_filterable": true,
4  "is_pii": true,
5  "is_required": true,
6  "mfz": {},
7  "name": "string",
8  "origin": "string",
9  "ui": {
10    "create_view": {
11      "is_hidden": true
12    },
13    "detail_view": {
14      "is_hidden": true
15    },
16    "display_name": "string",
17    "filter_view": {
18      "is_hidden": true
19    },
20    "group_name": "string",
21    "is_active_in_detail_view": true,
22    "is_bulk_action_enabled": true,
23    "is_groupable": true,
24    "is_hidden": true,
25    "is_hidden_during_create": true,
26    "is_read_only": true,
27    "is_shown_in_summary": true,
28    "is_sortable": true,
29    "list_view": {
30      "is_hidden": true
31    },
32    "placeholder": "string",
33    "summary_view": {
34      "is_hidden": true
35    },
36    "tooltip": "string"
37  },
38  "default_value": true
39}

For example, if an organization input to select a part and a user input to select an array of enums need to be implemented:

1inputs:
2    organization:
3        - name: part_picker
4          description: Input that chooses a part in the organization
5          field_type: id
6          id_type:
7            - product
8            - capability
9            - feature
10            - enhancement
11          is_required: true
12          default_value: don:core:dvrv-us-1:devo/XXXX/product:XXXX
13          ui:
14            display_name: Part Picker
15    user:
16        - name: enum_list_picker
17          description: Input to select multiple enums
18          field_type: array
19          base_type: enum
20          allowed_values:
21            - value-1
22            - value-2
23            - value-3
24          is_required: true
25          default_value: value-1
26          ui:
27            display_name: Enum List Picker
Built with