Skip to main content
API docs by Redocly

Archiving API (1.0.0)

Download OpenAPI specification:Download

Archive

Retrieves the collection of Archive resources.

Retrieves the collection of Archive resources.

Authorizations:
JWT
query Parameters
page
integer
Default: 1

The collection page number

pageSize
string

Archive pageSize

tags
string

Filter by tags

createdAtFrom
string

Archive createdAtFrom

createdAtTo
string

Archive createdAtTo

updatedAtFrom
string

Archive updatedAtFrom

updatedAtTo
string

Archive updatedAtTo

fileName
string

Archive fileName

contentType
string

application/pdf

Responses

Response samples

Content type
[
  • {
    }
]

Creates a Archive resource.

Creates a Archive resource.

Authorizations:
JWT
Request Body schema:
required

The new Archive resource

retentionPeriod
required
string <= 50 characters

The time period the resource should be archived. Format: “duration + unit”

tags
Array of strings
object (UploadedFileData)

Responses

Request samples

Content type
{
  • "retentionPeriod": "50d",
  • "tags": [
    ],
  • "file": {
    }
}

Response samples

Content type
{
  • "objectId": "93684e36-6f32-4845-9727-840c2d628673",
  • "status": "in_progress",
  • "retentionPeriod": "50d",
  • "tags": [
    ],
  • "file": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "lastUpdatedAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z"
}

Retrieves a Archive resource.

Retrieves a Archive resource.

Authorizations:
JWT
path Parameters
objectId
required
string

Archive identifier

Responses

Response samples

Content type
{
  • "objectId": "93684e36-6f32-4845-9727-840c2d628673",
  • "status": "in_progress",
  • "retentionPeriod": "50d",
  • "tags": [
    ],
  • "file": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "lastUpdatedAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z"
}

Updates the Archive resource.

Updates the Archive resource.

Authorizations:
JWT
path Parameters
objectId
required
string

Archive identifier

Request Body schema: application/json
required

The updated Archive resource

retentionPeriod
required
string <= 50 characters

The time period the resource should be archived. Format: “duration + unit”

tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "retentionPeriod": "50d",
  • "tags": [
    ]
}

Response samples

Content type
{
  • "objectId": "93684e36-6f32-4845-9727-840c2d628673",
  • "status": "in_progress",
  • "retentionPeriod": "50d",
  • "tags": [
    ],
  • "file": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "lastUpdatedAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z"
}

Archive Direct

Creates Archive resource with direct file upload

Creates a Archive Direct resource.

Authorizations:
JWT
header Parameters
signicat-archive-retention-period
required
string
Example: P1Y

The duration for which the archive object should be retained, specified in ISO 8601 duration format

signicat-archive-tags
string or null
Example: assure, dossier

A comma-separated list of tags associated with the archive object for categorization or search purposes.

content-disposition
required
string
Example: attachment; filename="filename.ext"

The Content-Disposition header specifying how the content should be handled. Mapped to the object field File.Name. Format should be: attachment; filename="filename.ext"

content-digest
required
string
Example: sha-256=:base64-value:

The Content-Digest header contains a SHA-256 hash of the content, used to verify its integrity and ensure that the data has not been tampered with during transmission. The hash value must be encoded in base64 format.

content-type
required
string
Example: application/pdf

The MIME type of the file being uploaded.

Request Body schema:
required

Upload a binary file (e.g., image, document).

object (Archive.Direct)

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

AuditLog

Retrieves the collection of AuditLog resources.

Retrieves the collection of AuditLog resources.

Authorizations:
JWT
path Parameters
objectId
required
string

AuditLog identifier

query Parameters
page
integer
Default: 1

The collection page number

Responses

Response samples

Content type
[
  • {
    }
]

File

Download archived file

Returns any binary file (PDF, image, zip...)

Authorizations:
JWT
path Parameters
objectId
required
string

File identifier

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "code": "string",
  • "title": "string",
  • "type": "http://example.com",
  • "traceId": "string"
}

Creates a File resource.

Creates a File resource.

Authorizations:
JWT
path Parameters
objectId
required
string

File identifier

header Parameters
content-disposition
required
string
Example: attachment; filename="filename.ext"

The Content-Disposition header specifying how the content should be handled. Mapped to the object field File.Name. Format should be: attachment; filename="filename.ext"

content-digest
required
string
Example: sha-256=:base64-value:

The Content-Digest header contains a SHA-256 hash of the content, used to verify its integrity and ensure that the data has not been tampered with during transmission. The hash value must be encoded in base64 format.

content-type
required
string
Example: application/pdf

The MIME type of the file being uploaded.

Request Body schema: */*
required

Upload a binary file (e.g., image, document).

object (File)

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "code": "string",
  • "title": "string",
  • "type": "http://example.com",
  • "traceId": "string"
}

Report

Retrieves a Report resource.

Retrieves a Report resource.

Authorizations:
JWT
path Parameters
objectId
required
string

Report identifier

Responses

Response samples

Content type
{ }