Skip to content
Docs
Select language:English

/api/v1/saved-views/{id} (PATCH)

PATCH
/api/v1/saved-views/{id}
curl --request PATCH \
  --url https://example.com/api/v1/saved-views/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "query": { "q": "example", "filters": { "additionalProperty": [ "example" ] }, "not": [ "example" ], "group": "example", "sort": "example", "dir": "asc", "layout": "example" }, "sharedLocationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
string
>= 1 characters <= 80 characters
query
object
q
string
<= 200 characters
filters
object
key
additional properties
Array<string>
<= 50 items
not
Array<string>
<= 40 items
group
string
<= 40 characters
sort
string
<= 40 characters
dir
string
Allowed values: asc desc
layout
string
<= 40 characters
sharedLocationId
Any of:
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required
string
surface
required
string
Allowed values: search activity trash things contents inbox schedules lending paperwork expiring notifications incidents ai-calls services vehicles fuel readings condition-reports moves move-boxes
query
required
object
q
string
filters
object
key
additional properties
Array<string>
not
Array<string>
group
string
sort
string
dir
string
Allowed values: asc desc
layout
string
sharedLocationId
required
Any of:
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
createdBy
required
object
displayName
required
string
mine
required
boolean
rowVersion
required
integer
>= -9007199254740991 <= 9007199254740991
moneyHidden
boolean
Example
{
  "surface": "search",
  "query": {
    "dir": "asc"
  },
  "moneyHidden": true
}