object#

Autogenerated API

argus_api.lib.jsonobject.v1.object.object.add_json_object_favorite(idOrShortname: str, type: 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#

Creates a new JsonObjectFavorite to current user’s JsonObject (DEV)

Parameters

  • idOrShortname (str) – Id or shortName of the JsonObject to favorite.

  • type (str) – The shortName of the JsonObject type.

  • 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.jsonobject.v1.object.object.create_json_object(type: str, shortName: str = None, name: str = None, localizedNames: dict = None, description: str = None, localizedDescriptions: dict = None, data: dict = 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#

Creates a new JsonObject of a specified type. (DEV)

Parameters

  • type (str) – The shortName of the JsonObject type.

  • shortName (str) – If set, this needs to be unique per type. If not, this will default to the generated UUID of the object. => [a-zA-Z0-9_:\-.]*

  • name (str) – Name of this object

  • localizedNames (dict) – Display name in specified languages. Required for global objects.

  • description (str) – Description of this object

  • localizedDescriptions (dict) – Description in specified languages. Required for global objects.

  • data (dict) –

  • 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.jsonobject.v1.object.object.delete_json_object(type: str, idOrShortname: 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#

Deletes a JsonObject identified by either id or type+shortname (DEV)

Parameters

  • type (str) – The shortName of the JsonObject type.

  • idOrShortname (str) – Id or shortName of the JsonObject 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.jsonobject.v1.object.object.get_json_object(type: str, idOrShortname: str, includeData: 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 a JsonObject identified by either id or type+shortname. (DEV)

Parameters

  • type (str) – The shortName of the JsonObject type.

  • idOrShortname (str) – Id or shortName of the JsonObject to retrieve.

  • includeData (bool) – Whether or not to include the actual JsonObject data in the response.

  • 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.jsonobject.v1.object.object.get_json_objects(type: str, keywords: str = None, favorite: bool = None, limit: int = 25, includeData: bool = None, includeDeleted: bool = None, 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 json objects with specified query parameters (DEV)

Parameters

  • type (str) – The shortName of the JsonObject type.

  • keywords (list) – Filter search by JsonObject keyword fields (name and short name)

  • favorite (bool) – Limit search to favorites

  • limit (int) – Limit result

  • includeData (bool) – Whether or not to include the actual JsonObject data in the response.

  • includeDeleted (bool) – Whether or not to include deleted JsonObjects in the response.

  • offset (int) – Offset result

  • 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.jsonobject.v1.object.object.grant_json_object_access(type: str, idOrShortname: str, level: str = None, subject: str = None, function: str = None, customer: str = None, searchable: 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#

Adds an access entry to the identified JsonObject. (DEV)

Parameters

  • type (str) – The shortName of the JsonObject type.

  • idOrShortname (str) – Id or shortName of the JsonObject to add the access entry to.

  • level (str) – The access level this entry grants.

  • subject (str) – ID or shortname for user or group to grant explicit access to.

  • function (str) – ID or name of function for granting role-based access.

  • customer (str) – ID or shortname of customer for granting role-based access. Null if global permission.

  • searchable (bool) – If true, the object will be searchable. (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

argus_api.lib.jsonobject.v1.object.object.list_json_object_access(type: str, idOrShortname: str, limit: int = 25, includeDeleted: bool = None, 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#

Returns a list of access entries for a JsonObject identified by either id or type+shortname (DEV)

Parameters

  • type (str) – The shortName of the JsonObject type.

  • idOrShortname (str) – Id or shortName of the JsonObject to list access entries for.

  • limit (int) – Maximum number of returned results

  • includeDeleted (bool) – Whether or not to include deleted access entries in the response.

  • offset (int) – By how many records to offset 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.jsonobject.v1.object.object.list_json_object_revisions(type: str, idOrShortname: str, limit: int = 25, includeData: bool = None, 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#

Returns the revisions of a JsonObject identified by either id or type+shortname (DEV)

Parameters

  • type (str) – The shortName of the JsonObject type.

  • idOrShortname (str) – Id or shortName of the JsonObject to retrieve revisions for.

  • limit (int) – Maximum number of returned results

  • includeData (bool) – Whether or not to include the actual JsonObject data in the revision responses.

  • offset (int) – By how many records to offset 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.jsonobject.v1.object.object.remove_json_object_favorite(idOrShortname: str, type: 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#

Deletes JsonObjectFavorite to current user’s JsonObject (DEV)

Parameters

  • idOrShortname (str) – Id or shortName of the JsonObject the favorite should be removed from.

  • type (str) – The shortName of the JsonObject type.

  • 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.jsonobject.v1.object.object.revert_json_object(type: str, idOrShortname: str, revision: int, 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#

Reverts a JsonObject identified by either id or type+shortname to a previous revision (DEV)

Parameters

  • type (str) – The shortName of the JsonObject type.

  • idOrShortname (str) – Id or shortName of the current JsonObject.

  • revision (int) – The revision to revert to.

  • 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.jsonobject.v1.object.object.revoke_json_object_access(idOrShortname: str, type: str, 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#

Revokes access entity to the identified JsonObject (DEV)

Parameters

  • idOrShortname (str) – Id or shortName of the JsonObject the access entity should be removed from.

  • type (str) – The shortName of the JsonObject type.

  • id (str) – ID of the access entity to revoke

  • 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.jsonobject.v1.object.object.search_json_objects(type: str, customer: str = None, keywords: str = None, keywordFieldStrategy: str = None, keywordMatchStrategy: str = None, user: str = None, userFieldStrategy: str = None, sortBy: str = None, favorite: bool = None, limit: int = 25, offset: int = None, includeDeleted: bool = None, includeData: 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#

Search json objects with specified criteria (DEV)

Parameters

  • type (str) – The shortName of the JsonObject type.

  • customer (list) – Limit search to json objects with the given customers, identified by id or shortname

  • keywords (list) – Search for keywords against fields defined by KeywordFieldStrategy

  • keywordFieldStrategy (list) – Defines which fields will be searched by keywords (default all)

  • keywordMatchStrategy (str) – Defines how strict different keywords should be matched (default all)

  • user (list) – Search using users identified by id or shortname. If given a group, we will resolve all members of the group recursively

  • userFieldStrategy (list) – Defines which fields will be searched by user (default all)

  • sortBy (list) – Which fields to sort json objects by (default createdTimestamp)

  • favorite (bool) – Whether to only search for favorites, exclude favorites or neither (default null)

  • limit (int) – Limit maximum amount of results (default 25)

  • offset (int) – Skip specified amount of results (default 0)

  • includeDeleted (bool) – Whether to include deleted json objects in the search. Only allowed for users with ´jsonObjectAdministration` permission (default false)

  • includeData (bool) – Whether to include data in the response. (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

argus_api.lib.jsonobject.v1.object.object.update_json_object(type: str, idOrShortname: str, shortName: str = None, name: str = None, localizedNames: dict = None, description: str = None, localizedDescriptions: dict = None, data: dict = 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#

Updates a JsonObject identified by either id or type+shortname (DEV)

Parameters

  • type (str) – The shortName of the JsonObject type.

  • idOrShortname (str) – Id or shortName of the JsonObject to update.

  • shortName (str) – If set, this needs to be unique per type. => [a-zA-Z0-9_:\-.]*

  • name (str) – Name of this object

  • localizedNames (dict) – Display name in specified languages. Required for global objects.

  • description (str) – Description of this object

  • localizedDescriptions (dict) – Description in specified languages. Required for global objects.

  • data (dict) –

  • 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