Update Query

User Guide > Resources > Update Query

This request changes query attributes.

Resource

PATCH /queries/<OID>

Where OID is the oid of the query

Parameters

None

Payload

Patch Document

Fields

Name Patch Operations

metaclassName

replace

selectMembers

add, remove, change sub member

selectMembers.defaultName

replace

selectMembers.sequenceNumber

replace

selectMembers.showColumn

replace

selectMembers.ascDesc

replace

selectMembers.sortOrder

replace

selectMembers.memberPath

replace

filterGroups

add, remove, change sub member

filterGroups.groupName

replace

filterGroups.sequenceNumber

replace

filterGroups.isActive

replace

filterGroups.andOr

replace

filterGroups.filterLines

add, remove, change sub member

filterGroups.filterLines.filterName

replace

filterGroups.filterLines.sequenceNumber

replace

filterGroups.filterLines.andOr

replace

filterGroups.filterLines.memberPath

replace

filterGroups.filterLines.comparisonOperator

replace

filterGroups.filterLines.comparisonValue

replace

filterGroups.filterLines.ignoreCase

replace

filterGroups.filterLines.localized

replace

filterGroups.filterLines.isActive

replace

filterGroups.filterLines.hideFilter

replace

Response

None

Context

Authorization

Administrator

Errors

Common Errors

Example

Request
PATCH https://xelion.nl/api/v1/master/queries/1627410
Payload

change query direct member

{
  "operations": [
      {
      "op": "replace",
      "path": "/metaClassName",
      "value": "XCCPhone"
      }
    ]
}

add a new select member to the query, add a new entry with virtual id 1

{
  "operations": [
      {
      "op": "add",
      "path": "/selectMembers/1"
      },
      {
      "op": "replace",
      "path": "/selectMembers/1/defaultName",
      "value": "thisisapatch"
      }
    ]
}

remove select member from a query, <OID> is the oid of the collection object

{
  "operations": [
      {
      "op": "remove",
      "path": "/selectMembers/2121643"
      }
    ]
}

add a new filter group to the query, add a new entry with virtual id 1

{
  "operations": [
      {
      "op": "add",
      "path": "/filterGroups/1"
      },
      {
      "op": "replace",
      "path": "/filterGroups/1/groupName",
      "value": "thisisagroup"
      },
      {
      "op": "add",
      "path": "/filterGroups/1/filterLines/1"
      },
      {
      "op": "replace",
      "path": "/filterGroups/1/filterLines/1/filterName",
      "value": "thisisnewfilter"
      }
    ]
}

remove filter line member from a query filter group, <OID> is the oid of the filter line collection object

{
  "operations": [
      {
      "op": "remove",
      "path": "/filterGroups/2121648/filterLines/2121649"
      }
    ]
}