Versions Compared

Key

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

...

ParameterTypeRequiredComment
actionString(tick)

find

see also API - General parameters

keyfieldString(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

Example call

No Format
/api/v1/entity?action=find&keyfield=refid&hridvalue="k342i5"

POST /api/v1/entities
action=find
keyfield=refid
hridvalue="k342i5"

Answer

Success
No Format
{
  "entities": [
    {
      "expirydate": "",
      "creationdate": "2018-09-12 12:57:45",
      "pinned": "false",
      "downloadurl": "http://localhost:8084/api/api/v1/entities/4a2d501b-8981-4070-8f46-b6279f7a7e85/download",
      "countparents": 1,
      "modificationdate": "2018-09-13 09:45:21",
      "uuid": "4a2d501b-8981-4070-8f46-b6279f7a7e85",
      "entitytype": "FILE",
      "hrid": "",
      "datasource": "https://upload.wikimedia.org/wikipedia/commons/f/f1/Fairy_of_Eagle_Nebula.jpg",
      "mimetype": "",
      "state": "FETCHED",
      "refid": "k342i5",
      "countchildren": 0
    }
  ],
  "type": "Success:EntityApi:Find:refid"
}

...