Artifacts
These endpoints are used to manage tenant artifacts. They cover obvious set of CRUD operations with file.
GetAll
Gets all entities relevant to specified query parameters
Request
GET /api/storage/v1/artifacts[?group&alias&type&skip&take&sorting&tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
group | query | Artifact group filter |
||
alias | query | Artifact alias(special name within group) filter |
||
type | query | Artifact type filter |
||
skip | query | Defines page start offset from beginning of sorted result list |
||
take | query | Defines page length (how much consequent items of sorted result list should be taken) |
||
sorting | query | Defines sorting order of result list e.g.: "Title ASC, LastModified DESC" |
||
tenantId | query | Tenant identifier |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
401 | Unauthorized |
||
403 | Forbidden |
Create
Creates new entity
Request
POST /api/storage/v1/artifacts[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier |
||
file | formData | Entity file content |
||
description | formData | Artifact description |
||
group | formData | Artifact group |
||
alias | formData | Artifact alias (special name within group) |
||
type | formData | Artifact type |
||
format | formData | Artifact file format |
||
anonymousAccess | formData | Artifact 'anonymous access' tag indicates whether artifact can be accessed anonymously |
||
*name | formData | Entity name |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
409 |
|
Conflict |
|
401 | Unauthorized |
||
403 | Forbidden |
Get
Gets entity by id
Request
GET /api/storage/v1/artifacts/{id}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity unique identifier |
||
tenantId | query | Tenant identifier |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
Update
Updates specified entity
Request
PUT /api/storage/v1/artifacts/{id}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity unique identifier |
||
tenantId | query | Tenant identifier |
||
file | formData | Entity file content |
||
description | formData | Artifact description |
||
alias | formData | Artifact alias (special name within group) |
||
type | formData | Artifact type |
||
format | formData | Artifact file format |
||
anonymousAccess | formData | Artifact 'anonymous access' tag indicates whether artifact can be accessed anonymously |
||
name | formData | Entity name |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
409 |
|
Conflict |
|
401 | Unauthorized |
||
403 | Forbidden |
Delete
Deletes specified entity
Request
DELETE /api/storage/v1/artifacts/{id}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity unique identifier |
||
tenantId | query | Tenant identifier |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
GetFile
Gets entity file from file storage
Request
GET /api/storage/v1/artifacts/{id}/file[?attachment&tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Entity unique identifier |
||
attachment | query | Indicates that file should be provided as an attachment with proper filename supplied (default value is 'false') |
||
tenantId | query | Tenant identifier |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | string | Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
DeleteGroup
Deletes all entities with specified group
Request
DELETE /api/storage/v1/artifacts/group/{group}[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*group | path | Group name |
||
tenantId | query | Tenant identifier |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
Definitions
PagedOfArtifactDto
Paged list of items
Name | Type | Notes |
---|---|---|
total | integer (int64) | Items count |
items |
|
Items list |
ArtifactDto
Items list
Name | Type | Notes |
---|---|---|
size | integer (int64) | Entity file size |
description | string | Artifact description |
group | string | Artifact group |
alias | string | Artifact alias (special name within group) |
type |
|
Artifact type |
format | string | Artifact file format |
anonymousAccess | boolean | Artifact 'anonymous access' tag indicates whether artifact can be accessed anonymously |
tenantId | integer (int32) | Entity tenant identifier |
id | string | Entity unique identifier |
ownerId | string | Entity owner identifier |
name | string | Entity name |
lastModified | string (date-time) | Last entity modification date and time |
ArtifactType
Artifact type
Enum Values
Temporary Final Service
NameConflictDto
Information about operation subject which has name conflict
Name | Type | Notes |
---|---|---|
type |
|
Coflict type |
id | string | Operation subject identifier |
name | string | Operation subject name |
path | string | Operation subject folder path |
ConflictType
Coflict type
Enum Values
Name FolderOverwrite
ProblemDetails
These endpoints are used to manage tenant artifacts. They cover obvious set of CRUD operations with file.
Name | Type | Notes |
---|---|---|
type | string | |
title | string | |
status | integer (int32) | |
detail | string | |
instance | string |