defaultwatcher#

Autogenerated API

argus_api.lib.cases.v2.defaultwatcher.add_default_watcher(subject: str = None, customer: str = None, service: str = None, caseType: str = None, priority: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Define a new default watcher (DEV)

Parameters

  • subject (str) – Which user or group to create a subscription for. If not set, the default is the current user.

  • customer (str) – Which customer to subscribe to updates for.

  • service (str) – Which service to subscribe to updates for.

  • caseType (list) – Which case types this watcher should be enabled for. If not set, it will be enabled for all case types.

  • priority (list) – Which priorities this watcher should be enabled for. If not set, it will be enabled for all priorities.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.defaultwatcher.delete_default_watcher(id: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Delete a default watcher (DEV)

Parameters

  • id (str) –

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.defaultwatcher.get_default_watcher(id: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Get a default watcher (DEV)

Parameters

  • id (str) –

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.defaultwatcher.list_current_user_default_watchers(customer: str = None, service: str = None, sortBy: str = None, limit: int = 25, includeGroups: bool = True, offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

List default watchers for the current user. (DEV)

Parameters

  • customer (list) – Filter by customer

  • service (list) – Filter by service

  • sortBy (list) – Define sort order

  • limit (int) – Limit number of results

  • includeGroups (bool) – If true, also include default watchers defined for parent user groups

  • offset (int) – Skip initial results

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.defaultwatcher.list_default_watchers(customer: str = None, service: str = None, caseType: str = None, priority: str = None, accessMode: str = None, limit: int = 25, offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

List default watchers for a specified service. NOTE: This endpoint fetches converted Customer Contacts, until migration of Default Watchers have finished. See GET /defaultwatcher/new (PUBLIC)

Parameters

  • customer (list) – Filter watchers by customer

  • service (list) – Filter watchers by service

  • caseType (list) – Filter watchers by caseType

  • priority (list) – Filter watchers by priority

  • accessMode (str) – Filter watchers by access mode

  • limit (int) – Maximum number of returned results

  • offset (int) –

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.defaultwatcher.list_default_watchers_new(customer: str = None, service: str = None, caseType: str = None, priority: str = None, limit: int = 25, offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

List default watchers. NOTE: this is a temporary migration endpoint, using new underlying data, and NOT returning legacy Customer contacts. The endpoint will replace GET /defaultwatcher when migration is done. (DEV)

Parameters

  • customer (list) – Filter watchers by customer

  • service (list) – Filter watchers by service

  • caseType (list) – Filter watchers by caseType

  • priority (list) – Filter watchers by priority

  • limit (int) – Maximum number of returned results

  • offset (int) –

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.defaultwatcher.search_default_watchers(customer: str = None, service: str = None, subject: str = None, subjectInheritanceStrategy: str = None, caseType: str = None, priority: str = None, accessMode: str = None, includeDeleted: bool = None, sortBy: str = None, limit: int = 25, offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Search default watchers. NOTE: This endpoint fetches new DefaultWatcher data, and not the converted Customer Contacts. (DEV)

Parameters

  • customer (list) – Limit result to default watchers defined for these customers (by ID or shortname)

  • service (list) – Limit result to default watchers defined for these case services (by ID or shortname)

  • subject (list) – Limit result to default watchers matching these users/groups (by ID or shortname)

  • subjectInheritanceStrategy (str) – Select strategy to use when filtering by subject.

  • caseType (list) – Limit result to default watchers defined for these case types

  • priority (list) – Limit result to default watchers defined for these case priorities

  • accessMode (str) – Limit result to default watchers defined for this access mode

  • includeDeleted (bool) – If true, also include deleted default watchers.

  • sortBy (list) – Define sort order of the results

  • limit (int) – Limit results (default 25)

  • offset (int) – Skip first results (default 0)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.cases.v2.defaultwatcher.update_default_watcher(id: str, caseType: str = None, priority: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Update an existing default watcher (DEV)

Parameters

  • id (str) –

  • caseType (list) – If set, update case types this watcher should be enabled for. Default is no change.

  • priority (list) – If set, update priorities this watcher should be enabled for. Default is no change.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON