functionmapping#

Autogenerated API

argus_api.lib.useradmin.v2.functionmapping.list_function_mappings(parent: str = None, child: str = None, sortBy: str = None, limit: int = 25, offset: int = None, includeDeleted: 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#

Returns the mappings for functions matching the query (PUBLIC)

Parameters

  • parent (list) – Search by parent function name or ID

  • child (list) – Search by child function name or ID

  • sortBy (list) – Sort search result

  • limit (int) – Maximum number of returned results

  • offset (int) – Skip a number of results

  • includeDeleted (bool) – Include deleted mappings

  • 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.useradmin.v2.functionmapping.search_function_mappings(sortBy: str = None, parent: str = None, child: str = None, limit: int = 25, offset: int = None, includeDeleted: 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#

Returns the function mappings for functions matching the query (PUBLIC)

Parameters

  • sortBy (list) – Field to sort result by (default parentName)

  • parent (list) – Search for mappings with these functions as parent (function name or id)

  • child (list) – Search for mappings with these functions as child (function name or id)

  • limit (int) – The max amount of items to display (default 25)

  • offset (int) – The amount of items to skip (default 0)

  • includeDeleted (bool) – Include deleted mappings in the response (requires permission) (default false)

  • 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