Versions Compared

Key

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

...

Parameters:
  • tenant – User tenant.
  • project_id – Project identifier.
  • item_id – Item identifier.
JSON Data:

Data is passed in as a JSON object.

Valid object keys:

  • state – Dictionary with the new item states. Valid states are: read, starred. States that are not specified are not modified.
  • keywords – Dictionary with keywords to update. This can only be used on projects which have their own project index. Keywords that are not specified are not modifiedremoved from the item.

Example request body:

Code Block
js
js
{
    "state": {
        "read": true,
        "starred": false
    },
    "keywords": {
        "Author": ["John Doe"]
    }
}
Headers:See Common Headers.
Status Codes:
  • 204 – Item modified.

See also Common Status Codes.

...