propertydescriptor#

Autogenerated API

argus_api.lib.customeradmin.v2.propertydescriptor.add_property_descriptor(key: str = None, localizedDescriptions: dict = None, localizedNames: dict = None, section: str = None, defaultValue: dict = None, type: str = None, schema: dict = None, readFunction: str = None, writeFunction: str = None, externallyManaged: 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#

Create a new property descriptor (PUBLIC)

Parameters

  • key (str) – Key of the new property descriptor => [a-zA-Z0-9_:\-.]*

  • localizedDescriptions (dict) – Property descriptor descriptions mapped by language. Supported languages are: english, norwegian. Description in English is required.

  • localizedNames (dict) – Property descriptor names mapped by language. Supported languages are: english, norwegian. If no name is set, this defaults to the property key

  • section (str) – Section of the property.

  • defaultValue (dict) –

  • type (str) – Type of the property.

  • schema (dict) –

  • readFunction (str) – The function required to read this property for a customer (default is viewCustomers).

  • writeFunction (str) – The function required to write this property for a customer (default is updateCustomer).

  • externallyManaged (bool) – If true, mark this property as externally managed.

  • 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.customeradmin.v2.propertydescriptor.add_property_descriptor_enum_entry(idOrKey: str, value: str = None, localizedValues: dict = None, localizedDescriptions: 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#

Create a new property descriptor enum entry (PUBLIC)

Parameters

  • idOrKey (str) – Id or key of the descriptor

  • value (str) – Value of the new enum entry => [a-zA-Z0-9_:\-.]*

  • localizedValues (dict) – Property descriptor enum values mapped by language. Supported languages are: english, norwegian. Value in English is required.

  • localizedDescriptions (dict) – Property descriptor enum value descriptions mapped by language. Supported languages are: english, norwegian. Description in English is required.

  • 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.customeradmin.v2.propertydescriptor.delete_property_descriptor(idOrKey: 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 a property descriptor (PUBLIC)

Parameters

  • idOrKey (str) – Property descriptor UUID or key

  • 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.customeradmin.v2.propertydescriptor.delete_property_descriptor_enum_entry(idOrKey: str, idOrValue: 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 a property descriptor enum entry (PUBLIC)

Parameters

  • idOrKey (str) – Property descriptor UUID or key

  • idOrValue (str) – Property descriptor enum entry UUID or value

  • 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.customeradmin.v2.propertydescriptor.get_property_descriptor(idOrKey: str, includeSchema: 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 property descriptor identified by its UUID or key (PUBLIC)

Parameters

  • idOrKey (str) – Property descriptor UUID or key

  • includeSchema (bool) – Include JSONSchema, defaults to 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.customeradmin.v2.propertydescriptor.get_property_descriptor_json_schema(idOrKey: 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#

Returns JSON Schema for a property descriptor identified by its UUID or key. (PUBLIC)

Parameters

  • idOrKey (str) – Property descriptor UUID or key

  • 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.customeradmin.v2.propertydescriptor.list_property_descriptor_enum_entries(idOrKey: str, 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#

Returns property descriptor enum entries defined by query parameters (PUBLIC)

Parameters

  • idOrKey (str) – Property descriptor UUID or key

  • keywords (list) – Search by keyword

  • sortBy (list) – Sort search result

  • limit (int) – Maximum number of returned results

  • 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.customeradmin.v2.propertydescriptor.list_property_descriptors(keywords: str = None, section: str = None, sortBy: str = None, limit: int = 25, offset: int = None, includeSchema: bool = 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 property descriptors defined by query parameters (PUBLIC)

Parameters

  • keywords (list) – Search by keyword

  • section (list) – Search by section

  • sortBy (list) – Sort search result

  • limit (int) – Maximum number of returned results

  • offset (int) – By how many records to offset results

  • includeSchema (bool) – Set to true to include schema in response.

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

  • 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.customeradmin.v2.propertydescriptor.search_property_descriptor(section: str = None, type: str = None, includeFlags: str = None, excludeFlags: str = None, keywords: str = None, subCriteria: dict = None, limit: int = None, offset: int = None, sortBy: str = None, includeDeleted: bool = None, includeSchema: 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 property descriptors defined by SearchPropertyDescriptorRequest (PUBLIC)

Parameters

  • section (list) – Restrict search to a section.

  • type (list) – Restrict search to a type.

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

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

  • keywords (list) – Search for property descriptor by keywords. Searches through keys and default values.

  • subCriteria (list) – Set additional criteria

  • limit (int) – Max number of results.

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

  • sortBy (list) – Field to sort result by, use - to sort in desc order. (default key)

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

  • includeSchema (bool) – If true, include schema of descriptors in 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.customeradmin.v2.propertydescriptor.search_property_descriptor_enum_entries(idOrKey: str, keywords: str = None, subCriteria: dict = None, keywordMatchStrategy: str = None, keywordFieldStrategy: str = None, limit: int = None, offset: int = None, sortBy: 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#

Returns property descriptors defined by SearchPropertyDescriptorEnumEntryRequest (PUBLIC)

Parameters

  • idOrKey (str) – Property descriptor UUID or key

  • keywords (list) – Search for property descriptor by keywords. Searches through keys and default values.

  • subCriteria (list) – Set additional criteria

  • keywordMatchStrategy (str) – Defines the MatchStrategy for keywords (default match all keywords).

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

  • limit (int) – Max number of results.

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

  • sortBy (list) – Field to sort result by, use - to sort in desc order. (default key)

  • 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.customeradmin.v2.propertydescriptor.update_property_descriptor(idOrKey: str, localizedNames: dict = None, localizedDescriptions: dict = None, section: str = None, defaultValue: dict = None, type: str = None, schema: dict = None, readFunction: str = None, writeFunction: str = None, externallyManaged: bool = 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 a property descriptor object. (PUBLIC)

Parameters

  • idOrKey (str) – Property descriptor UUID or key

  • localizedNames (dict) – If set, update the localized names of the property.

  • localizedDescriptions (dict) – If set, update the localized descriptions of the property.

  • section (str) – If set, change the section of the property.

  • defaultValue (dict) –

  • type (str) – If set, update the type of the property.

  • schema (dict) –

  • readFunction (str) – If set, change the function required to read this property for a customer.

  • writeFunction (str) – If set, change the function required to write this property for a customer.

  • externallyManaged (bool) – If set, change the externally managed flag.

  • deprecated (bool) – If set, change the deprecated flag. (default null)

  • 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.customeradmin.v2.propertydescriptor.update_property_descriptor_enum_entry(idOrKey: str, idOrValue: str, localizedDescriptions: dict = None, localizedValues: 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#

Update a property descriptor enum entry object. (PUBLIC)

Parameters

  • idOrKey (str) – Property descriptor UUID or key

  • idOrValue (str) – Enum entry UUID or value

  • localizedDescriptions (dict) – Descriptions. Mapped by language.

  • localizedValues (dict) – Values. Mapped by language. Note: English value updates only translation and not the value used for fetching the entry.

  • 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