Create a dashboard entry

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

Create a new dashboard entry

Path Params

dashboardUUID

string

required

The UUID of the dashboard to perform the operation on.

Body Params

status

string

required

length ≤ 50

The starting status of your dashboard entry

FCCID

string

The customer that this dashboard entry belongs to

FCAID

string

The account that this dashboard entry belongs to (not currently supported)

additionalDashboards

array of strings

length ≤ 10

An array of additional dashboards to add this entry to

additionalDashboards

entryType

string

required

length ≥ 1

The entryType of this dashboard entry

tags

array of strings

required

An array of tags associated with this entry

tags*

allAgentsInvolved

array of objects

required

An array of agents that have been involved somehow in this entry

allAgentsInvolved*

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

currentlyAssignedAgents

array of objects

required

An array of agents that are currently assigned to this entry

currentlyAssignedAgents*

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

entryType

string

required

length ≥ 1

The kind of entry you are creating

payload

history

array of objects

required

length ≥ 1

history*

object

_id

string

required

length ≥ 1

kind

string

required

length ≥ 1

The kind of history item

message

string

required

length ≥ 1

The history message

user

object

This is the information that you will get back where agents of the system are involved (similar to the matrix - but not as cool)

date

string

required

length ≥ 1

The date of the history item

serviceName

string

The service name if this action wasn't a user

date

string

required

length ≥ 1

The date that the dashboard entry was created

UUID

string

required

length ≥ 1

The UUID of this dashboard entry

lastUpdatedDate

string

required

length ≥ 1

The last updated date of this dashboard entry

FCCID

string

length ≥ 1

The FCCID of the customer that this dashboard entry is assigned to

dueDate

string

length ≥ 1

The dueDate of this dashboard entry

flowName

string

length ≥ 1

The flow name of this dashboard entry

flowUUID

string

length ≥ 1

The flow UUID of this dashboard entry

customerMeta

object

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

title

string

The title of the customer

firstName

string

The forename of the customer

lastName

string

The surname of the customer

500

Internal Server Error

Language

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url http://localhost:8080/dashboardUUID \
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