SwaggerUI
0.0.1 OAS3
https://hs-open-api-schemas.s3.amazonaws.com/schemas/latest/artifacts-api-oas.yml
dependencies_list
GET/api/v5/artifacts/{artifact_type}/{artifact_uuid}/dependencies_list Returns a list with all the functional dependencies of the specified Artifact
download
GET/api/v5/artifacts/{artifact_type}/{artifact_uuid}/download File download endpoint. Provides the binary content of the specified Artifact
Produces a file-download response with the binary content of the Artifact, specified by the (artifact_type, artifact_uuid) pair. Different Artifact types are persisted in different binary formats, most commonly: .ZIP, .JSON, .BIN, etc.
Parameters
| Name | Description |
|---|---|
| artifact_type * string (path) |
The slug for the Artifact Type - one of the supported values, such as block, layout_release, etc. Together with the Artifact UUID they uniquely identify every Artifact.Available values : block, block_asset, block_asset_chunk, confidence_thresholding_model, field_id_model, flow_version, idp_flow_version, layout, layout_release, nlc_model, table_id_model blockblock_assetblock_asset_chunkconfidence_thresholding_modelfield_id_modelflow_versionidp_flow_versionlayoutlayout_releasenlc_modeltable_id_model |
| artifact_uuid * string($uuid) (path) |
The UUID of the Artifact. Together with the Artifact Type they uniquely identify every Artifact. |
Responses
| Code | Description | Links |
|---|---|---|
| 200 | Media type application/json Controls Accept header.Examples Sample Artifact binary - Example Value - Schema ```json |
|
| " |
| 400 | Media type<br>application/json<br>Examples<br>Generic error JSON<br>- Example Value<br>- Schema<br>```json
{
"error": "Artifacts of type `abcd` are not supported"
}
``` | _No links_ |
| 404 | Media type<br>application/json<br>Examples<br>Not-found error JSON<br>- Example Value<br>- Schema<br>```json
{
"error": "BlockDefinition matching query does not exist."
}
``` | _No links_ |
### export
POST[/api/v5/artifacts/export](https://docs.hyperscience.ai/artifacts_swagger_explorer.html#/export/export_create)
Generates a .ZIP file containing all binaries for a list of Artifacts
### import
POST[/api/v5/artifacts/import](https://docs.hyperscience.ai/artifacts_swagger_explorer.html#/import/import_create)
Submits a list of Artifacts to be imported
### repo_manifest.json
GET[/api/v5/artifacts/repo_manifest.json](https://docs.hyperscience.ai/artifacts_swagger_explorer.html#/repo_manifest.json/repo_manifest.json_retrieve)
File download endpoint. Provides a list with all Artifacts available on the instance
### repositories
GET[/api/v5/artifacts/repositories](https://docs.hyperscience.ai/artifacts_swagger_explorer.html#/repositories/repositories_list)
List `ArtifactsRepository` objects
POST[/api/v5/artifacts/repositories](https://docs.hyperscience.ai/artifacts_swagger_explorer.html#/repositories/repositories_create)
Create an `ArtifactsRepository` object
GET[/api/v5/artifacts/repositories/{id}](https://docs.hyperscience.ai/artifacts_swagger_explorer.html#/repositories/repositories_retrieve)
Retrieve details for an `ArtifactsRepository` object
PUT[/api/v5/artifacts/repositories/{id}](https://docs.hyperscience.ai/artifacts_swagger_explorer.html#/repositories/repositories_update)
Fully update (replace) an `ArtifactsRepository` object
PATCH[/api/v5/artifacts/repositories/{id}](https://docs.hyperscience.ai/artifacts_swagger_explorer.html#/repositories/repositories_partial_update)
Partially update (patch) an `ArtifactsRepository` object
DELETE[/api/v5/artifacts/repositories/{id}](https://docs.hyperscience.ai/artifacts_swagger_explorer.html#/repositories/repositories_destroy)
Delete an `ArtifactsRepository` object
#### Schemas
AdHocRepository
ArtifactKey
ArtifactMetadata
ArtifactsExportResponse
ArtifactsImportResponse
ArtifactsList
ArtifactsRepoManifest
ArtifactsRepository
ExportArtifactsPayload
ExportStorageType
HTTPRepositoryConfig
JsonFailureResponse
LocalZIPsRepositoryConfig
PaginatedArtifactsRepositoryList
PatchedArtifactsRepository
RepoTypeEnum
S3ExportConfig
S3ZIPsRepositoryConfig