Requests - Watches API

Requests - Watches API

• Requests - Watches API
  • List all watches of a request
    • Response
  • Add a watch to a request
    • Response
  • Update a watch of a request
    • Response
  • Remove a watch from a request
    • Response
  • Remove all watches from a request
    • Response
  • Fields

List all watches of a request

List all watches of the request with a specific ID:

GET /requests/:id/watches

Response

Status: 200 OK

[
  {
    "added_by": {
      "id": 6,
      "name": "Howard Tanner",
      "account": {
        "id": "pro-product",
        "name": "Widget International"
      }
    },
    "created_at": "2023-02-01T05:14:45-06:00",
    "id": 4580,
    "person": {
      "id": 567,
      "name": "Tom Waters",
      "account": {
        "id": "pro-product",
        "name": "Widget International"
      }
    },
    "updated_at": "2023-02-01T05:14:45-06:00",
    "account": {
      "id": "pro-product",
      "name": "Widget International"
    }
  },
  {
    "added_by": {
      "id": 6,
      "name": "Howard Tanner",
      "account": {
        "id": "pro-product",
        "name": "Widget International"
      }
    },
    "created_at": "2023-02-01T05:14:45-06:00",
    "id": 4581,
    "person": {
      "id": 208,
      "name": "Ellen Brown",
      "account": {
        "id": "pro-product",
        "name": "Widget International"
      }
    },
    "updated_at": "2023-02-01T05:14:45-06:00",
    "account": {
      "id": "pro-product",
      "name": "Widget International"
    }
  }
]

The response contains these fields by default.

Add a watch to a request

Add a watch to a request with a specific ID.

POST /requests/:id/watches

When creating a new watch for a request these fields are available.

Response

Status: 200 OK

{
  "added_by": {
    "id": 6,
    "name": "Howard Tanner",
    "account": {
      "id": "pro-product",
      "name": "Widget International"
    }
  },
  "created_at": "2023-02-01T05:14:45-06:00",
  "id": 4580,
  "person": {
    "id": 567,
    "name": "Tom Waters",
    "account": {
      "id": "pro-product",
      "name": "Widget International"
    }
  },
  "updated_at": "2023-02-01T05:14:45-06:00",
  "account": {
    "id": "pro-product",
    "name": "Widget International"
  }
}

Update a watch of a request

Update a watch of a request with a specific ID.

PATCH /requests/:id/watches/:watch_id

When updating an existing watch for a request these fields are available.

Response

Status: 200 OK

{
  "status": "registered",
  "...": "..."
}

Remove a watch from a request

Remove a watch with a specific ID from a request with a specific ID.

DELETE /requests/:id/watches/:watch_id

Response

Status: 204 No Content

Remove all watches from a request

Remove all watch from a request with a specific ID.

DELETE /requests/:id/watches/

Response

Status: 204 No Content

Fields

added_by

Readonly reference to Person — The person who created the watch.

created_at

Readonly datetime — The date and time at which the watch was created.

id

Readonly integer — The unique ID of the watch.

person

Required reference to Person — The person who is selected as the watcher.

updated_at

Readonly datetime — The date and time of the last update of the watch. If the watch has had no updates it contains the created_at value.