customer#

Autogenerated API

argus_api.lib.customers.v2.customer.get_customer(idOrShortName: str, domain: str = None, includeProperties: str = None, includePropertiesWithPrefix: 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 a Customer identified by its ID or short name. (PUBLIC)

Parameters

  • idOrShortName (str) – Customer ID or short name

  • domain (str) – Customer domain to lookup short name (defaults to current users domain)

  • includeProperties (list) – Return with properties

  • includePropertiesWithPrefix (list) – Return with properties fetched by prefix

  • 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

Returns a Customer logo by customer shortName or id. (PUBLIC)

Parameters

  • idOrShortName (str) – Customer ID or shortName

  • domain (str) – Customer domain to lookup shortName (defaults to current users domain)

  • size (str) – The preferred size of the logo (small, medium, large, xlarge). Will resize the logo within the selected size, retaining aspect ratio.

  • includeDefault (bool) – Include default logo

  • 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

requests.Response object

argus_api.lib.customers.v2.customer.get_customer_properties(idOrShortName: str, domain: str = None, key: str = None, section: 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 a set of properties for the customer id or shortName by property name. (PUBLIC)

Parameters

  • idOrShortName (str) – Customer ID or shortName

  • domain (str) – Customer domain to lookup shortname (defaults to current users domain)

  • key (list) – Filter for specific properties.

  • section (list) – Filter for properties in specific sections.

  • 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.customers.v2.customer.get_customer_user_roles(idOrShortName: str, 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#

Returns a set of User roles for the customer id or shortName. (PUBLIC)

Parameters

  • idOrShortName (str) – Customer ID or shortName

  • domain (str) – Customer domain to lookup user (defaults to current users domain)

  • 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.customers.v2.customer.list_customers(parent: str = None, keywords: str = None, includeProperties: str = None, includePropertiesWithPrefix: 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 customers defined by query parameters (PUBLIC)

Parameters

  • parent (list) – Search by parent id or shortName

  • keywords (list) – Search by keywords

  • includeProperties (list) – Return with properties

  • includePropertiesWithPrefix (list) – Return with properties fetched by prefix

  • 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.customers.v2.customer.search_customers(customer: str = None, ancestor: str = None, parent: str = None, domain: str = None, includeProperties: str = None, includePropertiesWithPrefix: str = None, includeFlags: str = None, excludeFlags: str = None, keywords: str = None, type: str = None, keywordMatchStrategy: str = None, keywordFieldStrategy: str = None, subCriteria: dict = None, includeDeleted: bool = 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 customers defined by SearchBasicCustomerRequest (PUBLIC)

Parameters

  • customer (list) – Restrict search to specified customers.

  • ancestor (list) – Search for customers by ancestor customer id or shortname. Will return customers that descend from any of these parents.

  • parent (list) – Search for customers by parent customer id or shortname. Will return customers that are direct children of any of these parents.

  • domain (list) – Search for customers in one of these domains (by domain id or name).

  • includeProperties (list) – Include properties matching one of the specified keys. Only properties specified here, or by “includePropertiesWithPrefix” will be returned. (default null)

  • includePropertiesWithPrefix (list) – Include properties matching one of the prefixes specified. Only properties specified by prefix, or by “includeProperties” will be returned. (default null)

  • includeFlags (list) – Only include objects which have includeFlags set. For ‘deleted’ use the dedicated field

  • excludeFlags (list) – Exclude objects which have excludeFlags set. For ‘deleted’ use the dedicated field

  • keywords (list) – Search for customers by keywords.

  • type (list) – Search for customers by type.

  • 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).

  • subCriteria (list) – Set additional criteria

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

  • 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 id)

  • 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