Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

ParameterTypeRequiredComment
actionString(tick)

find

see also API - General parameters

fieldString(tick)

possible values:

  • description
  • hrid
  • refid
  • customdata
valueString(tick)the value that should be searched for
keyString
required only for search in customdata = the key in customdata to search for
offsetLong
set the offset
onlymultipleentriesBoolean
if set to true, the result will only contain entries with similiar descriptions - can only be used for description
ordercolumnsString
one can set the order - if this string contains invalid columns, the standard sorting is used

Example call

No Format
/api/v1/entity?action=find&field=refid&value="k342i5"

POST /api/v1/entities
action=find
field=refid
value="k342i5"

...