category#

Autogenerated API

argus_api.lib.cases.v2.category.create_category(name: str = None, shortName: str = None, description: str = None, localizedNames: dict = None, localizedDescriptions: dict = 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#

Add category (INTERNAL)

Parameters

  • name (str) – Descriptive name of category to add. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • shortName (str) – Shortname for the category. This value must be unique in domain. => [a-zA-Z0-9_:\-.]*

  • description (str) – Longer description of this category. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • localizedNames (dict) – Localized names. If not set, locales will fallback to main name. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • localizedDescriptions (dict) – Localized descriptions. If not set, localized description will fallback to main description. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • domain (str) – Name or ID of domain to create this category in.

  • 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.category.delete_category(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 category (INTERNAL)

Parameters

  • id (str) – ID or shortname of category 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.category.get_category(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 category (INTERNAL)

Parameters

  • id (str) – ID or shortname of category to fetch

  • 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.category.list_categories(id: int = None, shortName: 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 categories (INTERNAL)

Parameters

  • id (list) – List of category IDs to match

  • shortName (list) – List of category shortnames to match

  • sortBy (list) – Sort order (see /cases/v2/category/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.category.search_categories(sortBy: str = None, limit: int = None, offset: int = None, includeDeleted: bool = None, subCriteria: dict = None, exclude: bool = None, required: bool = None, id: int = None, shortName: str = None, service: str = None, caseType: 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 categories (INTERNAL)

Parameters

  • sortBy (list) –

  • 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 categories with the specified numeric ID`s.

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

  • service (list) – Limit search to categories bound to one of these services (by ID or service shortname)

  • caseType (list) – Limit search to categories bound to one of these case types

  • 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.category.update_category(id: str, name: str = None, shortName: str = None, description: str = None, localizedNames: dict = None, localizedDescriptions: 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 category (INTERNAL)

Parameters

  • id (str) – ID or shortname of category to update

  • name (str) – If set, change the descriptive name for this category. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • shortName (str) – If set, change the shortname name for this category. WARNING: This may affect scripts using the category name. => [a-zA-Z0-9_:\-.]*

  • description (str) – If set, change the long description for this category. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • localizedNames (dict) – Set localized names to override name for specified language. Only specified languages are changed. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • localizedDescriptions (dict) – Set localized descriptions to override description for specified language. Only specified languages are changed. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

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