Skip to content
AveraAveraAvera Documentation

Create a document

POST
/api/v1/documents
curl --request POST \
  --url https://app.avera.io/api/v1/documents \
  --header 'Content-Type: application/json' \
  --data '{ "projectId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "title": "example", "description": "example", "documentTypeId": "example", "folderId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "fileContentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "nativeFileContentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "attributes": "example" }'

Creates a rich-text or file document item, routed by the item type’s document mode. A rich-text document starts with an empty body; a file document requires fileContentId and may carry a native source file beside the servable one. The document number is generated from the project’s numbering settings.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
projectId
required
string format: uuid
title
required
string
description
string | null
documentTypeId
required
string
folderId
string | null format: uuid
fileContentId
string | null format: uuid
nativeFileContentId
string | null format: uuid
attributes
object | null

Example generated

{
  "projectId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "title": "example",
  "description": "example",
  "documentTypeId": "example",
  "folderId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "fileContentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "nativeFileContentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "attributes": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media type*/*
object
number
required
string
canonicalId
required
string format: uuid
title
string | null
description
string | null
contentType
string | null
documentTypeId
required
string
status
required
string
Allowed values: DRAFT REVIEW RELEASED OBSOLETE
seq
required
integer format: int64
revision
string | null
jsonContent
string | null
fileContent
One of:
object
id
required
string format: uuid
fileName
required
string
fileExtension
required
string
fileSize
required
integer format: int64
mimeType
required
string
scanStatus
required
string
Allowed values: PENDING SCANNING CLEAN INFECTED ERROR SKIPPED
checksum
required
string
checksumAlgorithm
required
string
uploadedAt
required
string format: date-time
uploadedBy
required
string format: uuid
nativeFileContent
One of:
object
id
required
string format: uuid
fileName
required
string
fileExtension
required
string
fileSize
required
integer format: int64
mimeType
required
string
scanStatus
required
string
Allowed values: PENDING SCANNING CLEAN INFECTED ERROR SKIPPED
checksum
required
string
checksumAlgorithm
required
string
uploadedAt
required
string format: date-time
uploadedBy
required
string format: uuid
modifiedAt
required
string format: date-time
modifiedBy
required
string format: uuid
createdAt
required
string format: date-time
createdBy
required
string format: uuid