API docs by Redocly

ListEntity API (1.0.0)

ListEntity API description

list

ListEntity all reports

query Parameters
ids
Array of strings <UUID> [ items <UUID > ]

List of ids to retrieve information for

entityTypeIds
Array of strings <UUID> [ items <UUID > ]

List of entityTypeIds to retrieve information for

offset
integer <int32>
Default: 0

Offset to start retrieving list information for

size
integer <int32>
Default: 100

how many item to return

active
boolean

Indicates whether list should be active or not

private
boolean

Indicates whether list should be private or not

includeDeleted
boolean

Indicates if deleted lists should be included in the results (default false)

updatedAsOf
string <offset-date-time>

Indicates the minimum create/update timestamp to filter lists by

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "totalRecords": 0,
  • "totalPages": 0
}

Create a List

Request Body schema: application/json
required

List object

name
required
string non-empty

List name

description
string

List description

entityTypeId
required
string <UUID>

ID of the entity Type

fqlQuery
string

FQL Query

fields
Array of strings

Fields to be included in list contents

isActive
required
boolean

Indicates a List is Active or not

isPrivate
required
boolean

Indicates a List is Private or not

queryId
string <uuid>

Optional id of query to create list from

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "entityTypeId": "string",
  • "fqlQuery": "string",
  • "fields": [
    ],
  • "isActive": true,
  • "isPrivate": true,
  • "queryId": "10210520-b895-40ca-bce5-474f9643bf53"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "entityTypeId": "string",
  • "fqlQuery": "string",
  • "fields": [
    ],
  • "createdBy": "string",
  • "createdByUsername": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "isActive": true,
  • "isPrivate": true,
  • "isCanned": true,
  • "isDeleted": true,
  • "updatedBy": "string",
  • "updatedByUsername": "string",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "successRefresh": {
    },
  • "inProgressRefresh": {
    },
  • "failedRefresh": {
    },
  • "version": 0
}

Delete List with the provided id

delete the list with the specific id (if exists).

path Parameters
id
required
string <UUID>

id of the list

Responses

getListById

gets the specific list information (if exists).

path Parameters
id
required
string <UUID>

id of the list

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "entityTypeId": "string",
  • "fqlQuery": "string",
  • "fields": [
    ],
  • "createdBy": "string",
  • "createdByUsername": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "isActive": true,
  • "isPrivate": true,
  • "isCanned": true,
  • "isDeleted": true,
  • "updatedBy": "string",
  • "updatedByUsername": "string",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "successRefresh": {
    },
  • "inProgressRefresh": {
    },
  • "failedRefresh": {
    },
  • "version": 0
}

Update a List

path Parameters
id
required
string <UUID>

id of the list

Request Body schema: application/json
required

List object

name
required
string non-empty

List name

description
string

List description

fqlQuery
string

FQL Query

fields
Array of strings

Fields to be included in list contents

isActive
required
boolean

Indicates a List is Active or not

isPrivate
required
boolean

Indicates a List is Private or not

version
required
integer

Number of version

queryId
string <UUID>

Query ID

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "fqlQuery": "string",
  • "fields": [
    ],
  • "isActive": true,
  • "isPrivate": true,
  • "version": 0,
  • "queryId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "entityTypeId": "string",
  • "fqlQuery": "string",
  • "fields": [
    ],
  • "createdBy": "string",
  • "createdByUsername": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "isActive": true,
  • "isPrivate": true,
  • "isCanned": true,
  • "isDeleted": true,
  • "updatedBy": "string",
  • "updatedByUsername": "string",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "successRefresh": {
    },
  • "inProgressRefresh": {
    },
  • "failedRefresh": {
    },
  • "version": 0
}

performRefresh

Perform refresh of the list.

path Parameters
id
required
string <UUID>

id of the list

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "listId": "string",
  • "status": "IN_PROGRESS",
  • "refreshStartDate": "2019-08-24T14:15:22Z",
  • "refreshEndDate": "2019-08-24T14:15:22Z",
  • "refreshedBy": "string",
  • "refreshedByUsername": "string",
  • "recordsCount": 0,
  • "contentVersion": 0,
  • "error": {
    },
  • "listVersion": 0
}

cancelRefresh

Cancel refresh of the list.

path Parameters
id
required
string <UUID>

id of the list

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "type": "string",
  • "code": "string",
  • "parameters": [
    ]
}

getListContents

gets the list contents (if exists).

path Parameters
id
required
string <UUID>

id of the list

query Parameters
fields
Array of strings

List of fields to retrieve content for

offset
integer <int32>
Default: 0

Offset to start retrieving items from

size
integer <int32>
Default: 100

How many items to return

Responses

Response samples

Content type
application/json
{ }

getListVersions

Get all the historic versions of the specified list.

path Parameters
id
required
string <UUID>

id of the list

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getListVersion

Get a specific historic version of the specified list.

path Parameters
id
required
string <UUID>

id of the list

versionNumber
required
integer >= 1

Integer number of the requested version

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "fqlQuery": "string",
  • "fields": [
    ],
  • "isActive": true,
  • "isPrivate": true,
  • "updatedBy": "string",
  • "updatedByUsername": "string",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "listId": "string",
  • "version": 0
}

listExport

exportList

Exports the list.

path Parameters
id
required
string <UUID>

id of the list

Request Body schema: application/json
optional

Export request

Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "exportId": "string",
  • "listId": "string",
  • "status": "IN_PROGRESS",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fields": [
    ]
}

getExportDetails

Get details of an export request

path Parameters
id
required
string <UUID>

id of the list

exportId
required
string <UUID>

exportId of the list

Responses

Response samples

Content type
application/json
{
  • "exportId": "string",
  • "listId": "string",
  • "status": "IN_PROGRESS",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fields": [
    ]
}

cancelExport

Cancel the export.

path Parameters
id
required
string <UUID>

id of the list

exportId
required
string <UUID>

exportId of the list

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "type": "string",
  • "code": "string",
  • "parameters": [
    ]
}

downloadList

Download the exported file.

path Parameters
id
required
string <UUID>

id of the list

exportId
required
string <UUID>

exportId of the list

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "type": "string",
  • "code": "string",
  • "parameters": [
    ]
}

listConfiguration

getListConfiguration

Get list app configuration.

Responses

Response samples

Content type
application/json
{
  • "maxListSize": 0
}