datasource#

Autogenerated API

argus_api.lib.assets.v2.datasource.create_asset_data_source(shortName: str = None, name: str = None, description: str = None, customer: str = None, writePermission: str = None, sameSourceMergeResolutionStrategy: str = None, otherSourceMergeResolutionStrategy: str = None, priority: float = 5.0, ttl: 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#

Create a new Asset Data Source (DEV)

Parameters
  • shortName (str) – The machine readable shortName for the Data Source. Must be unique per customer. => [a-zA-Z0-9_:\-.]*

  • name (str) – The human readable display name. If not provided will be populated by the short name. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • description (str) – The Data Source’s description. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • customer (str) – The id or shortName of the Customer.

  • writePermission (str) – Id or name of the permission required to write data to this source.

  • sameSourceMergeResolutionStrategy (str) – The chosen merge resolution strategy when handling merge conflicts with the same datasource.

  • otherSourceMergeResolutionStrategy (str) – The chosen merge resolution strategy when handling merge conflicts with the another datasource.

  • priority (float) – Priority of the given datasource (default 5)

  • ttl (int) – Time to live, 0 mean never expires (default 0)

  • 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.assets.v2.datasource.delete_asset_data_source(idOrShortName: str, customer: 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#

Delete Data Source (DEV)

Parameters
  • idOrShortName (str) – Data Source ID or short name

  • customer (str) – Customer ID or short name (default is user’s customer), only used when the data source’s short name was provided to retrieve the data source

  • 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.assets.v2.datasource.get_asset_data_source(idOrShortName: str, customer: 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#

Get Data Source (DEV)

Parameters
  • idOrShortName (str) – Data Source ID or short name

  • customer (str) – Customer ID or short name (default is user’s customer), only used when the data source’s short name was provided to retrieve the asset

  • 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.assets.v2.datasource.list_asset_data_sources(customer: str = None, keywords: 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#

Search Asset Data Sources with specified query params (DEV)

Parameters
  • customer (list) – Customer ids or short names

  • keywords (list) – Filter search by Asset Data Source keyword fields (short name, name, and description)

  • sortBy (list) – Field(s) to sort by (shortName, name, createdTimestamp, lastUpdatedTimestamp, deletedTimestamp)

  • limit (int) – Limit results

  • offset (int) – Offset results

  • includeDeleted (bool) – Include deleted

  • 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.assets.v2.datasource.restore_asset_data_source(idOrShortName: str, customer: 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#

Restore Data Source (DEV)

Parameters
  • idOrShortName (str) – Data Source ID or short name

  • customer (str) – Customer ID or short name (default is user’s customer), only used when the data source’s short name was provided to retrieve the asset

  • 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.assets.v2.datasource.search_asset_data_sources(keywords: str = None, keywordFieldStrategy: str = None, keywordMatchStrategy: str = None, startTimestamp: str = None, endTimestamp: str = None, timeFieldStrategy: str = None, timeMatchStrategy: str = None, userFieldStrategy: str = None, user: str = None, customer: str = None, includeFlags: str = None, excludeFlags: str = None, subCriteria: dict = None, sortBy: str = None, includeDeleted: bool = 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#

Search Asset Data Sources with specified criteria (DEV)

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

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

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

  • startTimestamp (str) – Restrict to a time frame based on the set timeFieldStrategy (start timestamp). (default 0)

  • endTimestamp (str) – Restrict to a time frame based on the set timeFieldStrategy (end timestamp). (default 0)

  • timeFieldStrategy (list) – Defines which timestamps fields will be filtered with start/endTimestamp (default all)

  • timeMatchStrategy (str) – Defines how strict to match against different timestamps (all/any) using start and end timestamp (default any) (default any)

  • userFieldStrategy (list) – Defines which user fields to filter with the submitted user value(s) (default all)

  • user (list) – Search for Asset Data Sources by associated user IDs or short names defined by the UserFieldStrategy

  • customer (list) – Search for Asset Data Sources with these Customer IDs or short names

  • includeFlags (list) – Explicitly search for Assets that contain these flags

  • excludeFlags (list) – Explicitly filter out Assets that contain these flags

  • subCriteria (list) – Set additional criteria that are applied with logical OR by default

  • sortBy (list) – Field(s) by which to sort the results

  • includeDeleted (bool) – Whether to include deleted results (default false)

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

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

  • 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.assets.v2.datasource.update_asset_data_source(idOrShortName: str, customer: str = None, shortName: str = None, name: str = None, description: str = None, writePermission: str = None, priority: float = None, ttl: int = None, sameSourceMergeResolutionStrategy: str = None, otherSourceMergeResolutionStrategy: 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#

Update an existing Asset Data Source (DEV)

Parameters
  • idOrShortName (str) – Data Source ID or short name

  • customer (str) – Customer ID or short name (default is user’s customer), only used when the data source’s short name was provided to retrieve the data source

  • shortName (str) – The Data Source’s new shortname => [a-zA-Z0-9_:\-.]*

  • name (str) – The Data Source’s new name => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • description (str) – The Data Source’s new description => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • writePermission (str) – Id or name of the permission required to write data to this source.

  • priority (float) – Priority of the given datasource

  • ttl (int) – Time to live, 0 mean never expires

  • sameSourceMergeResolutionStrategy (str) – The chosen merge resolution strategy when handling merge conflicts with the same datasource.

  • otherSourceMergeResolutionStrategy (str) – The chosen merge resolution strategy when handling merge conflicts with other datasources.

  • 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