artifact#

Autogenerated API

argus_api.lib.configurationadmin.v1.artifact.create(groupID: str = None, artifactID: str = None, version: str = None, data: 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 : create is an alias for create_artifact. Exists only for backward compatibility - do not use - use create_artifact instead.

argus_api.lib.configurationadmin.v1.artifact.create_artifact(groupID: str = None, artifactID: str = None, version: str = None, data: 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#

Add new code artifact as JSON object (INTERNAL)

Parameters

  • groupID (str) – The Maven groupID of this artifact => [a-zA-Z0-9_:\-.]*

  • artifactID (str) – The Maven artifactID of this artifact => [a-zA-Z0-9_:\-.]*

  • version (str) – The Maven version of this artifact => [a-zA-Z0-9_:\-.]*

  • data (str) – The base64-encoded bytes of this artifact

  • 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.configurationadmin.v1.artifact.create_artifact_from_octet_stream(groupID: str, artifactID: str, version: 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#

Upload new code artifact as binary file upload (INTERNAL)

Parameters

  • groupID (str) – Group ID

  • artifactID (str) – Artifact ID

  • version (str) – Version

  • 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.configurationadmin.v1.artifact.create_from_octet_stream(groupID: str, artifactID: str, version: 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#

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

argus_api.lib.configurationadmin.v1.artifact.delete_unused(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 : delete_unused is an alias for delete_unused_artifacts. Exists only for backward compatibility - do not use - use delete_unused_artifacts instead.

argus_api.lib.configurationadmin.v1.artifact.delete_unused_artifacts(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#

Mark unused artifacts as deleted (INTERNAL)

Parameters

  • 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.configurationadmin.v1.artifact.download_by_g_a_v(groupID: str, artifactID: str, version: 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) → requests.models.Response#

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

argus_api.lib.configurationadmin.v1.artifact.download_by_id(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) → requests.models.Response#

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

argus_api.lib.configurationadmin.v1.artifact.download_code_artifact_by_g_a_v(groupID: str, artifactID: str, version: 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) → requests.models.Response#

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

argus_api.lib.configurationadmin.v1.artifact.download_code_artifact_by_gav(groupID: str, artifactID: str, version: 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) → requests.models.Response#

Download raw artifact by groupID, artifactID and version (GAV) (INTERNAL)

Parameters

  • groupID (str) – GroupID of artifact to fetch

  • artifactID (str) – ArtifactID of artifact to fetch

  • version (str) – Version of artifact to fetch

  • 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.configurationadmin.v1.artifact.download_code_artifact_by_id(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) → requests.models.Response#

Download artifact by ID (INTERNAL)

Parameters

  • id (str) – ID of artifact to fetch

  • 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.configurationadmin.v1.artifact.get_by_g_a_v(groupID: str, artifactID: str, version: 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#

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

argus_api.lib.configurationadmin.v1.artifact.get_by_id(id: 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#

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

argus_api.lib.configurationadmin.v1.artifact.get_code_artifact_by_g_a_v(groupID: str, artifactID: str, version: 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#

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

argus_api.lib.configurationadmin.v1.artifact.get_code_artifact_by_gav(groupID: str, artifactID: str, version: 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#

Fetch code artifact metadata by groupID, artifactID and version (GAV) (INTERNAL)

Parameters

  • groupID (str) – GroupID of artifact to fetch

  • artifactID (str) – ArtifactID of artifact to fetch

  • version (str) – Version of artifact to fetch

  • includeData (bool) – If true, include encoded artifact binary data

  • 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.configurationadmin.v1.artifact.get_code_artifcat_by_id(id: 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#

Fetch code artifact metadata by hash ID (INTERNAL)

Parameters

  • id (str) – ID of artifact to fetch

  • includeData (bool) – If true, include encoded artifact binary data

  • 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.configurationadmin.v1.artifact.list(search: str = None, orderDesc: bool = None, limit: int = 25, orderBy: str = 'groupID', 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#

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

argus_api.lib.configurationadmin.v1.artifact.list_code_artifacts(search: str = None, orderDesc: bool = None, limit: int = 25, orderBy: str = 'groupID', 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#

List code artifacts (INTERNAL)

Parameters

  • search (str) – Limit result to artifacts matching this search string

  • orderDesc (bool) – Sort results descending

  • limit (int) – Limit result

  • orderBy (str) – Order result

  • 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.configurationadmin.v1.artifact.list_unused(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 : list_unused is an alias for list_unused_code_artifacts. Exists only for backward compatibility - do not use - use list_unused_code_artifacts instead.

argus_api.lib.configurationadmin.v1.artifact.list_unused_code_artifacts(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#

List unused artifact (INTERNAL)

Parameters

  • 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.configurationadmin.v1.artifact.search(limit: int = None, offset: int = None, includeDeleted: bool = None, includeFlags: int = None, excludeFlags: int = None, subCriteria: dict = None, exclude: bool = None, required: bool = None, searchString: str = None, id: str = None, groupID: str = None, artifactID: str = None, version: str = None, status: str = None, gav: dict = None, includeData: bool = None, startTimestamp: int = None, endTimestamp: int = None, sortBy: str = None, includeCreatedTimestamp: bool = True, includeLastUpdatedTimestamp: 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#

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

argus_api.lib.configurationadmin.v1.artifact.search_code_artifacts(limit: int = None, offset: int = None, includeDeleted: bool = None, includeFlags: int = None, excludeFlags: int = None, subCriteria: dict = None, exclude: bool = None, required: bool = None, searchString: str = None, id: str = None, groupID: str = None, artifactID: str = None, version: str = None, status: str = None, gav: dict = None, includeData: bool = None, startTimestamp: int = None, endTimestamp: int = None, sortBy: str = None, includeCreatedTimestamp: bool = True, includeLastUpdatedTimestamp: 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 code artifacts (INTERNAL)

Parameters

  • limit (int) – Max number of results.

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

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

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

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

  • subCriteria (list) – Set additional criterias which are applied using a logical OR.

  • exclude (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria object will be excluded.

  • required (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria are required (AND-ed together with parent criteria).

  • searchString (str) – Keyword search string

  • id (list) – Only return artifacts with these specific ids

  • groupID (list) – Only return artifacts with these groupIDs

  • artifactID (list) – Only return artifacts with these artifactIDs

  • version (list) – Only return artifacts with these versions

  • status (list) – Only return artifacts with these statuses

  • gav (list) – Only return artifacts which matches any of these GAVs

  • includeData (bool) – DEPRECATED: Also include artifact data in response. This option should not be used.

  • startTimestamp (int) – Search artifacts created or updated after this timestamp

  • endTimestamp (int) – Search artifacts created or updated before this timestamp

  • sortBy (list) – List of properties to sort by (prefix with “-” to sort descending).

  • includeCreatedTimestamp (bool) – Consider creation time in time filtering. Defaults to true. (default true)

  • includeLastUpdatedTimestamp (bool) – Consider creation time in time filtering. Defaults to false. (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