property

Autogenerated API

argus_api.lib.componentadmin.v1.property.property.get_properties_1(property: str, pattern: dict = None, type: 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

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

argus_api.lib.componentadmin.v1.property.property.get_property(property: str, pattern: dict = None, type: 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 property from runtime components (INTERNAL)

Parameters

• property (str) – Property to fetch

• pattern (dict) –

• type (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

• AuthenticationFailedException – on 401

• AccessDeniedException – on 403

• ObjectNotFoundException – on 404

• RemoteInvocationFailedException – on 409

• ArgusException – on other status codes

Returns

dictionary translated from JSON