Create an EDMS document from an uploaded file (subject to change)

Upload the file first with POST /projects/{projectId}/uploads, then pass the ID it returns as uploadedFileId. The created document's ID is also its item ID, so its revisions are readable from GET /projects/{projectId}/items/{itemId}/records.

post/projects/{projectId}/items/documents

Request

Base URL
https://app.ketryx.com/api/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/ketryx/apis/ketryx-api/docs/projects/:projectId/items/documents/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

projectIdstring required

Ketryx ID of the project, e.g., KXPRJ12345

Request body

uploadedFileIdstring required

Ketryx ID of a file previously uploaded via POST /projects/{projectId}/uploads

folderPathstring

EDMS folder to create the document in, with / separating folder names. Defaults to the project root.

titlestring

Title of the document. Defaults to the uploaded filename.

typestring

Document type by its user-facing label. Defaults to the standard document type.

createFoldersboolean

Whether to create the folders in folderPath that do not exist yet

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.