Search dashboard entries

post http://localhost:8080/{dashboardUUID}/search

Search Dashboards

This route allows you to search and order your dashboard entries for any given dashboard

You can provide your own sort array: for example:

['status:desc', 'lastActivity:asc'] sort by status then by last activity

Path Params

dashboardUUID

string

required

The UUID of the dashboard who's entries you want to search

Body Params

The information required to search and order dashboard entries for a given dashboard.

reference

number

The reference of the dashboard you want to search for

skip

number

≥ 0

The number of entries that you want to skip

limit

number

≤ 100

The limit of dashboard entries that you want back

status

array of strings

length ≤ 10

An array of tags that the dashboard entries should match

status

assignedAgents

array of strings

length ≤ 10

An array of agents that the dashboard entries should match

assignedAgents

sort

array of strings

any key in the response with asc or desc (status:desc)

sort

dashboardUUIDs

array of strings

length ≤ 10

The Dashboard UUID's to filter results to (FCCID and AGENT search only)

dashboardUUIDs

date

object

Date filter object

Responses

Response body

object

total

number

required

This is the number of entries that your search returned

entries

array of objects

required

length ≥ 1

An array of dashboard entries matching your search criterea

entries*

object

UUID

string

required

The UUID of the dashboard entry

date

string

required

length ≥ 1

The date that the dashboard entry was added to financial cloud

reference

number

The reference number of the dashboard entry

attachments

number

any attachments that are attached to this dashboard entry

hasComments

number

required

The number of comments that this dashboard entry has

owners

array of objects

length ≥ 1

This is the list of assigned agent

owners

object

UUID

string

required

The UUID of the agent

firstName

string

required

length ≥ 1

The first name of the agent

lastName

string

required

length ≥ 1

The last name of the agent

dashboards

array of strings

An array of dashboard UUID's that this entry is a part of

dashboards

tags

involved

array of objects

length ≥ 1

An array of involved agents - an agent is involved as soon as they action something against the entry

involved

object

UUID

string

required

The UUID of the agent

firstName

string

required

length ≥ 1

The first name of the agent

lastName

string

required

length ≥ 1

The last name of the agent

mentions

array of objects

the agents mentioned in the notes, comments etc

mentions

object

UUID

string

required

The UUID of the agent

firstName

string

required

length ≥ 1

The first name of the agent

lastName

string

required

length ≥ 1

The last name of the agent

action

string

required

length ≥ 1

The dashboard item type

lastActivity

string

required

length ≥ 1

The date and time of the last activity on this dashboard

dueDate

string

required

length ≥ 1

The date and time of the due date e.g. a callback

status

string

required

length ≥ 1

The current dashboard status

FCCID

string

The FCCID of the customer (if this item is assigned)

customerMeta

object

The customer meta data - if we had the information available at save time

Headers

object

500

Internal Server Error

Language

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url http://localhost:8080/dashboardUUID/search \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400This is a 400 bad request response