pageBy: (page(n+1)):(take(n))
- page: page number
- take: next limit number of entries
pageInfo: Not needed for the 1st page. The pageInfo is obtained in the response.
select: list of property names to display in the response, display all if left empty.
filter: possible values
- logical operators: AND | OR
- operators: EQ (equal) | NEQ (not equal) | IN (contains)
- property: enclosed with { and }. Exmpl -> {propName}
- value: enclosed with ' '. Exmpl -> 'value'
- group with parenthesis: (term)
- filter term starts and ends always with ( and )
filter example:
({Description} NEQ 'Value' AND ({Name} EQ 'Value2' OR {Name} IN 'Value3') AND {KeyX} NEQ 'Value4')
sortBy: property:[Asc | Desc]
example JSON body
{
"pageBy": "0:10",
"select": [
"Name",
"Description"
],
"filter": "(({Name} IN '4' AND {Description} IN 'common') OR {Name} IN '5')",
"sortBy": "Descriptoin:ASC"
}
Updates an existing instance of the specified list.
Path Parameters
Name
Type
Description
teamId
string
ID of the team where the instances are from.
appId
string
ID of the app where the instances are from.
listId
string
ID of the class or query.
instanceId
string
ID of the instance.
Headers
Name
Type
Description
Authentication
string
Bearer token, grants access to the API.
Request Body
Name
Type
Description
json object
string
Comma-separated fields list, returns all if left empty.
{
"instance": {
"fields": {
"{FieldKey1}": “{FieldValue1}”,
"{FieldKey2}": “{FieldValue2}”,
"{FieldKey3}": “{FieldValue3}”
}
}
}
json object (docs)
string
Optionally documents from the DocumentStore (see Upload call) can be inserted. But this works only for document classes with the 'Upload' action.
{
"instance": {
"fields": {
"{FieldKey1}": “{FieldValue1}”,
"{FieldKey2}": “{FieldValue2}”,
"{FieldKey3}": “{FieldValue3}”,
"File": {
"Id": "8172f7aa...",
"Name": "test-123-9.pdf",
"MimeType": "application/pdf"
}
}
}
}