service#

Autogenerated API

argus_api.lib.cases.v2.service.bind_category(serviceID: str, category: str = None, caseTypes: 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#

Bind category to service (PUBLIC)

Parameters

  • serviceID (str) – ID or shortname of service to bind category to

  • category (str) – Shortname or ID of category to bind

  • caseTypes (list) – Case types to bind category for

  • 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.service.create_service(domain: str = None, shortName: str = None, name: str = None, localizedNames: dict = None, localizedDescriptions: dict = None, description: str = None, iconURL: str = None, notificationEmail: str = None, notifyOnCreate: bool = None, notifyOnUpdate: bool = None, notifyOnClose: bool = None, notifyFullFormat: bool = None, handledBySoc: bool = None, monitoredBySocOutsideOfficeHours: bool = None, eventEnabled: bool = None, assignDefaultTech: bool = None, assignDefaultUser: bool = None, workflows: dict = None, caseTypes: str = None, listFunction: str = None, readFunction: str = None, writeFunction: str = None, createFunction: str = None, techFunction: str = None, adminFunction: str = None, defineFunction: str = None, fieldPolicy: 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 service (INTERNAL)

Parameters

  • domain (str) – Name or ID of domain to bind service to.

  • shortName (str) – Shortname of service. This must be unique within a domain. => [a-zA-Z0-9_:\-.]*

  • name (str) – Descriptive name of service.

  • localizedNames (dict) – Localized names. If not set, locales will fallback to main name.

  • localizedDescriptions (dict) – Localized descriptions. If not set, locales will fallback to main description.

  • description (str) – Longer description of service.

  • iconURL (str) – An image data-URL on the form data:image/png;base64,BASE64IMAGEDATA => Sanitize by regex data:image/.+

  • notificationEmail (str) – The service notification email address. => format:email

  • notifyOnCreate (bool) – If true, notify the service notification email address on created cases. Default is false.

  • notifyOnUpdate (bool) – If true, notify the service notification email address on updated cases. Default is false.

  • notifyOnClose (bool) – If true, notify the service notification email address on closed cases. Default is false.

  • notifyFullFormat (bool) – If true, use the full format when notifying to the service notification email. Default is false.

  • handledBySoc (bool) – If true, this service is handled by SOC 24/7. Default is false.

  • monitoredBySocOutsideOfficeHours (bool) – If true, this service is monitored by SOC outside office hours. Default is false.

  • eventEnabled (bool) – If true, this service is integrated with events.

  • assignDefaultTech (bool) – If true, cases created for this service will be automatically assign tech to the executing user (if tech).

  • assignDefaultUser (bool) – If true, cases created for this service will be automatically assign user to the executing user (if not tech).

  • workflows (dict) – If set, define workflows to enable for this service.

  • caseTypes (list) – The case types to enable for this service.

  • listFunction (str) – The name or ID of the function to set as LIST function for this service. Default is the same as ‘readFunction’.

  • readFunction (str) – The name or ID of the function to set as READ function for this service.

  • writeFunction (str) – The name or ID of the function to set as WRITE function for this service.

  • createFunction (str) – The name or ID of the function to set as CREATE function for this service.

  • techFunction (str) – The name or ID of the function to set as TECH function for this service.

  • adminFunction (str) – The name or ID of the function to set as ADMIN function for this service.

  • defineFunction (str) – The name or ID of the function to set as DEFINE function for this service.

  • fieldPolicy (str) – The ID of a field policy to set for this service. Default is no policy.

  • 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.service.delete_service(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 service (INTERNAL)

Parameters

  • id (str) – ID or shortname of service to delete

  • 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.service.get_field_policy_by_service(service: str, customer: str = None, domain: 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#

Fetch policy descriptor by service and customer (INTERNAL)

Parameters

  • service (str) – ID or shortname of service to fetch policy for

  • customer (str) – ID or shortname of customer to fetch policy for

  • domain (str) – Domain to lookup service and customer in (when using shortnames). Defaults to the current users domain.

  • 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.service.get_service(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#

Fetch service (INTERNAL)

Parameters

  • id (str) – ID or shortname of service

  • 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

Fetch service logo (INTERNAL)

Parameters

  • id (str) – ID or shortname of service

  • 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

requests.Response object

argus_api.lib.cases.v2.service.list_categories_1(id: str, 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#

DEPRECATED : list_categories_1 is an alias for list_categories_by_service. Exists only for backward compatibility - do not use - use list_categories_by_service instead.

argus_api.lib.cases.v2.service.list_categories_by_service(id: str, 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 categories bound to service (PUBLIC)

Parameters

  • id (str) – ID or shortname of service

  • limit (int) – Maximum number of returned results

  • offset (int) – Skip a number of 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.service.list_services(id: int = None, shortName: str = None, keywords: str = 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#

List services (INTERNAL)

Parameters

  • id (list) – List of IDs to match

  • shortName (list) – List of shortnames to match

  • keywords (list) – Limit by matching keywords

  • sortBy (list) – Sort order (see /cases/v2/service/search documentation for details)

  • limit (int) – Maximum number of returned results

  • offset (int) – Skip a number of 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.service.search_services(limit: int = None, offset: int = None, includeDeleted: bool = None, subCriteria: dict = None, exclude: bool = None, required: bool = None, id: int = None, shortName: str = None, fieldPolicy: str = None, keywords: str = None, sortBy: str = None, includeFlags: str = None, excludeFlags: 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#

Search services (INTERNAL)

Parameters

  • limit (int) – Max number of results.

  • offset (int) – Skip the first (offset) objects. By default, return result from first object.

  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.

  • subCriteria (list) – Set additional criterias which are applied using a logical OR.

  • exclude (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria object will be excluded.

  • required (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria are required (AND-ed together with parent criteria).

  • id (list) – Limit search to services with the specified numeric ID`s.

  • shortName (list) – Limit search to services with the specified shortnames

  • fieldPolicy (list) – Limit search to services bound to specified field policies (by UUID or name)

  • keywords (list) – Limit search to services matching the given keywords (by name or shortname)

  • sortBy (list) – List of properties to sort by (prefix with “-” to sort descending).

  • includeFlags (list) – Only include objects which have includeFlags set.

  • excludeFlags (list) – Exclude objects which have excludeFlags set.

  • 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.service.unbind_category(serviceID: str, categoryID: str, caseType: 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#

Unbind category from service. If caseType is specified, only unbind specific casetype. Default is to unbind all casetypes, disallowing the category for use on this service. (PUBLIC)

Parameters

  • serviceID (str) – ID or shortname of service to unbind category from

  • categoryID (str) – ID or shortname of category to unbind

  • caseType (list) – Casetypes to unbind (default is all)

  • 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.service.update_service(id: str, shortName: str = None, name: str = None, localizedNames: dict = None, localizedDescriptions: dict = None, description: str = None, iconURL: str = None, notificationEmail: str = None, caseTypesToAdd: str = None, caseTypesToRemove: str = None, caseTypesToSet: str = None, listFunction: str = None, readFunction: str = None, writeFunction: str = None, createFunction: str = None, techFunction: str = None, adminFunction: str = None, defineFunction: str = None, fieldPolicy: str = None, notifyOnCreate: bool = None, notifyOnUpdate: bool = None, notifyOnClose: bool = None, notifyFullFormat: bool = None, handledBySoc: bool = None, monitoredBySocOutsideOfficeHours: bool = None, eventEnabled: bool = None, assignDefaultTech: bool = None, assignDefaultUser: bool = None, workflows: dict = None, deprecated: bool = 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 service (INTERNAL)

Parameters

  • id (str) – Service id or shortname

  • shortName (str) – If set, change the shortname of this service. This must be unique within a domain. WARNING: This may affect scripts using shortname as service identifier. => [a-zA-Z0-9_:\-.]*

  • name (str) – If set, change the descriptive name of the service.

  • localizedNames (dict) – Set localized names to override name for specified language. Only specified languages are changed.

  • localizedDescriptions (dict) – Set localized descriptions to override description for specified language. Only specified languages are changed.

  • description (str) – If set, change the longer description of the service.

  • iconURL (str) – If set, replace the icon for the service. An image data-URL on the form data:image/png;base64,BASE64IMAGEDATA => Sanitize by regex data:image/.+

  • notificationEmail (str) – If set, change the service notification email address. => format:email

  • caseTypesToAdd (list) – If set, enable the requested case type for this service.

  • caseTypesToRemove (list) – If set, disable the requested case type for this service. This will be rejected if any non-deleted cases exist which are bound to this service and casetype.

  • caseTypesToSet (list) – If set, override existing case types for this service. If this causes the service to remove a case type which has non-deleted cases bound to it, this will be rejected.

  • listFunction (str) – If set, change the LIST function for this service, identified by function ID or shortname.

  • readFunction (str) – If set, change the READ function for this service, identified by function ID or shortname.

  • writeFunction (str) – If set, change the WRITE function for this service, identified by function ID or shortname.

  • createFunction (str) – If set, change the CREATE function for this service, identified by function ID or shortname.

  • techFunction (str) – If set, change the TECH function for this service, identified by function ID or shortname.

  • adminFunction (str) – If set, change the ADMIN function for this service, identified by function ID or shortname.

  • defineFunction (str) – If set, change the DEFINE function for this service, identified by function ID or shortname.

  • fieldPolicy (str) – If set, change the field policy for this service. Changing the field policy will affect new cases and future updates to existing cases, but will not change fields set on existing cases.

  • notifyOnCreate (bool) – If set, change settings for notifying the service notification email address on created cases.

  • notifyOnUpdate (bool) – If set, change settings for notifying the service notification email address on updated cases.

  • notifyOnClose (bool) – If set, change settings for notifying the service notification email address on closed cases.

  • notifyFullFormat (bool) – If set, change the format settings for notifying to the service notification email.

  • handledBySoc (bool) – If set, set whether this service is handled by SOC 24/7.

  • monitoredBySocOutsideOfficeHours (bool) – If set, set whether this service is monitored by SOC outside office hours.

  • eventEnabled (bool) – If set, set whether service is integrated with events.

  • assignDefaultTech (bool) – If set, change whether cases created for this service will be automatically assign tech to the executing user (if tech).

  • assignDefaultUser (bool) – If set, change whether cases created for this service will be automatically assign user to the executing user (if not tech).

  • workflows (dict) – If set, modify workflows enabled for this service.

  • deprecated (bool) – If set, enable/disable the deprecated flag for this service. 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