Versions Compared

Old Version 3

changes.mady.by.user Patrice Neff

Saved on

compared with

New Version 4

changes.mady.by.user Patrice Neff

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Pause and resume of objects

...

Parameters:
  • tenant – User tenant.
  • project_id – Project identifier.
  • object_id – Object identifier.
Headers:See Common Headers.
Status Codes:
  • 200 – Object is returned.

See also Common Status Codes.

Returns:

Updated objectObject information.

Code Block
js
js
{
   "id": "8aGYz97eT-yVeunA_9Zzmg",
   "title": "Python",
   "weight": 0.0,
   "subscriptions": [
      "wTXdjK6aRBqpqYRV8w9x0A", "NKrPIPewTy-HYN7lZrimGg"
   ],
   "subscriptions_processed": true,
   "paused": false,
   "seeder": null
}
  • subscriptions_processed is set to true when all subscriptions are processed. A subscription is considered processed, when its first batch of items from is available for searching.
  • paused is set to true if and only if all subscriptions on the object are paused.

Update Object

PUT https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/objects/(id: object_id)

...

DELETE https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/objects/(id: object_id)

Returns an array of all objects in the project.

Parameters:
  • tenant – User tenant.
  • project_id – Project identifier.
  • object_id – Object identifier.
Headers:See Common Headers.
Status Codes:
  • 204 – Object was deleted.

See also Common Status Codes.

Pause Object

POST https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/objects/{id: object_id}/pause

Pauses all subscriptions of an object.

Parameters:
  • tenant – User tenant.
  • project_id – Project identifier.
  • object_id – Object identifier.
Headers:See Common Headers.
Status Codes:
  • 200 – No change, all subscriptions in the object were already paused.
  • 204 – All object subscriptions were paused.

See also Common Status Codes.

Resume Object

POST https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/objects/{id: object_id}/resume

Resumes all existing subscriptions of an object.

Parameters:
  • tenant – User tenant.
  • project_id – Project identifier.
  • object_id – Object identifier.
Headers:See Common Headers.
Status Codes:
  • 200 – No change, all subscriptions in the object were already active.
  • 204 – All object subscriptions were resumed.

See also Common Status Codes.

Pausing an object only affects the existing subscriptions. When adding a new subscription to a paused object, the new subscription will not be paused. As a consequence thereof the object will no longer be in a paused state.