- Docs
- API reference
- Endpoints and schemas
- GraphQL
- Selection
List
A list is a saved definition of a set of records that Enigma can deliver as a file.
Selection. This type is a selection. An intent returns it, and you choose which of its fields come back.
A list is a saved definition of a set of records that Enigma can deliver as a file. A LIST_GENERATION list finds its records with a search. An ENRICHMENT list matches the rows of an input file that you upload. To produce the file, create a materialization of the list.
Where it appears
Section titled “Where it appears”No connection leads here from a primary entity.
listsreturns it.CreateList.listUpdateList.list
Fields
Section titled “Fields”| Field | Type | Description |
|---|---|---|
id |
ID! |
The ID of the list. |
customerId |
ID! |
The ID of the organization that owns the list. |
workspaceId |
ID |
The ID of the workspace that the list belongs to. The value is null when the list has no workspace. |
listType |
ListType |
The kind of list. LIST_GENERATION finds records with a search. ENRICHMENT matches the rows of an input file. One of LIST_GENERATION, ENRICHMENT. |
name |
String |
The name of the list. |
description |
String |
The description of the list. |
searchInput |
ListSearchInput |
The search settings that define the records of the list. |
createdTimestamp |
DateTime! |
The date and time when the list was created. |
updatedTimestamp |
DateTime! |
The date and time of the last change to the settings of the list. |
fileFormat |
String |
The file format of the output file, such as CSV or PARQUET. |
inputFileUri |
String |
The reference to the uploaded input file of an ENRICHMENT list. |
columnCounts |
[ColumnCount] |
The connection fields of the list query that have a first argument. |
fieldAliases |
[FieldAlias] |
The new names for fields of the list query. |
columnOrdering |
[String] |
The order of the output columns, as dot-separated field paths. |
columnMapping |
[ColumnMapping] |
The input file columns of an ENRICHMENT list, and the search field that each column supplies. |
Connections
Section titled “Connections”Each one is a connection: read it through edges { node { … } }, page it with first, and narrow it with conditions.
| Field | Leads to | Description |
|---|---|---|
materializations |
ListMaterialization |
The materializations of the list, newest first. |
Example
Section titled “Example”query { lists { edges { node { id customerId workspaceId listType } } }}Response, as returned:
{ "data": { "lists": { "edges": [ { "node": { "id": "00000000-0000-4000-8000-000000000001", "customerId": "00000000-0000-4000-8000-000000000002", "workspaceId": "00000000-0000-4000-8000-000000000003", "listType": "LIST_GENERATION" } }, { "node": { "id": "00000000-0000-4000-8000-000000000004", "customerId": "00000000-0000-4000-8000-000000000002", "workspaceId": "00000000-0000-4000-8000-000000000003", "listType": "LIST_GENERATION" } }, { "node": { "id": "00000000-0000-4000-8000-000000000005", "customerId": "00000000-0000-4000-8000-000000000002", "workspaceId": "00000000-0000-4000-8000-000000000003", "listType": "ENRICHMENT" } }, { "node": { "id": "00000000-0000-4000-8000-000000000006", "customerId": "00000000-0000-4000-8000-000000000002", "workspaceId": "00000000-0000-4000-8000-000000000003", "listType": "ENRICHMENT" } }, { "node": { "id": "00000000-0000-4000-8000-000000000007", "customerId": "00000000-0000-4000-8000-000000000002", …}