Fenergo Document Model API
The Document Model API from Fenergo — 58 operation(s) for document model.
Fenergo Document Model API is one of 281 APIs that Fenergo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Document Model. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 63 operations across 58 paths, and defines 65 schemas. It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against 2 base URLs: /documentmanagementcommand, /documentmanagementquery.
63 operations
58 paths
65 schemas
4 DELETE7 GET25 POST27 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Fenergo Document Model API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (Bearer).
By default, every request must be authenticated.
Bearer— Please insert JWT with Bearer into field
Paths & Operations 63
Across 58 paths, the API surfaces 63 operations — 4 DELETE, 7 GET, 25 POST, 27 PUT. Each is listed below with its method, path, parameters, and response codes.
Document Model 63
POST
/api/documentmanagement
Upload a document
PUT
/api/documentmanagement/{id}
Updates a document
DELETE
/api/documentmanagement/{id}
Delete a document model
GET
/api/documentmanagement/{id}
Get a document by id and tenant
PUT
/api/documentmanagement/{id}/requirement-ids
Update the requirements linked to a document
PUT
/api/documentmanagement/updateFiledeprecated
Update a document
PUT
/api/documentmanagement/{id}/datakey
Update the requirement datakey linked to a document
POST
/api/v2/documentmanagement
Save document metadata and generate the URL to upload the file…
POST
/api/v2/documentmanagement/product/CreateDocumentModel
Save document metadata and generate the URL to upload the file…
POST
/api/v2/documentmanagement/deal/CreateDocumentModel
Save document metadata and generate the URL to upload the file…
POST
/api/v2/documentmanagement/archiveAndReplace
Archive the document and add new document with metadata and generate the URL to…
POST
/api/v2/documentmanagement/product/ArchiveAndReplaceDocumentModel
Archive the document and add new document with metadata and generate the URL to…
POST
/api/v2/documentmanagement/deal/ArchiveAndReplaceDocumentModel
Archive the document and add new document with metadata and generate the URL to…
POST
/api/v2/documentmanagement/virtual
Save document metadata including the URL to the virtual file…
POST
/api/v2/documentmanagement/product/virtual
Save document metadata including the URL to the virtual file…
POST
/api/v2/documentmanagement/deal/virtual
Save document metadata including the URL to the virtual file…
PUT
/api/v2/documentmanagement/updateFiledeprecated
Generate URL to upload the new document file - UpdateFile
PUT
/api/v2/documentmanagement/{id}/access-layers
Update document model access layers - UpdateDocumentAccessLayers
PUT
/api/v2/documentmanagement/product/{id}/access-layers
Update document model access layers - product/UpdateDocumentAccessLayers
PUT
/api/v2/documentmanagement/deal/{id}/access-layers
Update document model access layers - deal/UpdateDocumentAccessLayers
POST
/api/v2/documentmanagement/CreateDocumentModelMultipleRequirements
Save document metadata and generate the URL to upload the file for multiple…
POST
/api/v2/documentmanagement/product/CreateDocumentModelMultipleRequirements
Save document metadata and generate the URL to upload the file for multiple…
POST
/api/v2/documentmanagement/deal/CreateDocumentModelMultipleRequirements
Save document metadata and generate the URL to upload the file for multiple…
POST
/api/v2/documentmanagement/virtual/multiple-requirements
Save document metadata including the URL to the virtual file for multiple…
POST
/api/v2/documentmanagement/product/virtual/multiple-requirements
Save document metadata including the URL to the virtual file for multiple…
POST
/api/v2/documentmanagement/deal/virtual/multiple-requirements
Save document metadata including the URL to the virtual file for multiple…
PUT
/api/v2/documentmanagement/{id}/clone
Clones Document Model which references Original Physical File…
PUT
/api/v2/documentmanagement/product/{id}/clone
Clones Document Model which references Original Physical File…
PUT
/api/v2/documentmanagement/deal/{id}/clone
Clones Document Model which references Original Physical File…
PUT
/api/v2/documentmanagement/error/{id}
Update Document Model Status to 'Error' - UpdateDocumentModelStatusError
PUT
/api/v2/documentmanagement/product/error/{id}
Update Document Model Status to 'Error' - product/UpdateDocumentModelStatusError
PUT
/api/v2/documentmanagement/deal/error/{id}
Update Document Model Status to 'Error' - deal/UpdateDocumentModelStatusError
PUT
/api/v2/documentmanagement/custom-error/{id}
Update Document Model Status to 'Error' with custom error code and message…
PUT
/api/v2/documentmanagement/product/custom-error/{id}
Update Document Model Status to 'Error' with custom error code and message…
PUT
/api/v2/documentmanagement/deal/custom-error/{id}
Update Document Model Status to 'Error' with custom error code and message…
PUT
/api/v2/documentmanagement/{id}
Updates a document - UpdateDocument
DELETE
/api/v2/documentmanagement/{id}
Delete a document model - DeleteDocumentModel
PUT
/api/v2/documentmanagement/product/{id}
Updates a document - product/UpdateDocument
DELETE
/api/v2/documentmanagement/product/{id}
Delete a document model - product/DeleteDocumentModel
PUT
/api/v2/documentmanagement/deal/{id}
Updates a document - deal/UpdateDocument
DELETE
/api/v2/documentmanagement/deal/{id}
Delete a document model - deal/DeleteDocumentModel
PUT
/api/v2/documentmanagement/{id}/requirement-ids
Update the requirements linked to a document - UpdateRequirementIds
PUT
/api/v2/documentmanagement/product/{id}/requirement-ids
Update the requirements linked to a document - product/UpdateRequirementIds
PUT
/api/v2/documentmanagement/deal/{id}/requirement-ids
Update the requirements linked to a document - deal/UpdateRequirementIds
PUT
/api/v2/documentmanagement/{id}/datakey
Update the requirement datakey linked to a document - UpdateDataKey
PUT
/api/v2/documentmanagement/product/{id}/datakey
Update the requirement datakey linked to a document - product/UpdateDataKey
PUT
/api/v2/documentmanagement/deal/{id}/datakey
Update the requirement datakey linked to a document - deal/UpdateDataKey
PUT
/api/v2/documentmanagement/{id}/updateDocumentUploadedByUserName
Update the uploadedByUsername property of a document…
POST
/api/v2/documentmanagement/{id}/archive
Archive a document
POST
/api/v2/documentmanagement/{id}/unarchive
Unarchive a document
GET
/api/documentmanagement/journey/{journeyId}
Get all documents by journey id
GET
/api/documentmanagement/entity/{entityId}deprecated
Get all documents by entity id
POST
/api/documentmanagement/entity/paged
Retrieves paginated document models based on a specific entity ID and tenant ID
POST
/api/documentmanagement/entity/paged/status/lite
Retrieves lightened paginated document models based on a specific entity ID…
POST
/api/documentmanagement/entity/paged/lite/v2
Retrieves paginated documents by entity ID using cursor-based pagination with…
POST
/api/documentmanagement/entity/paged/status
Retrieves paginated document models based on a specific entity ID, tenant ID…
POST
/api/documentmanagement/entity/paged/excludeStatus/lite
Retrieves paginated lightened document models based on a specific entity ID and…
POST
/api/documentmanagement/entity/paged/excludeStatus
Retrieves paginated document models based on a specific entity ID and tenant…
POST
/api/documentmanagement/entity/paged/lite
Retrieves paginated lite document models based on a specific entity ID and…
GET
/api/documentmanagement/entity/{entityId}/journey/{journeyId}
Gets all Document Models for an Entity Id and Journey Id
GET
/api/documentmanagement/signedurl/{id}
Method to get a signed URL from S3
GET
/api/documentmanagement/mimeTypesAllowed
Get all supported mime types when uploading a file in the document requirements
GET
/api/documentmanagement/supportedFileExtensions
Get supported file extensions
Schemas 65
The contract defines 65 schemas that model the data the API accepts and returns. The most detailed are DocumentModelDto (32 properties), DocumentModelLiteDto (29 properties), ArchiveAndReplaceDocumentRequest (18 properties), CreateSignedUrlToUploadFileRequest (16 properties). Each schema is shown below with its type and property counts.
UpdateDocumentDto
object
Properties to update the metadata related to an uploaded document
7 properties
UploadDocumentResponseDto
object
Basic information from the upload document api.
4 properties
ServiceResponseMessage
object
3 properties
ValidationErrorModelListServiceResponse
object
2 properties
UpdateDocumentFileResponseDtoServiceResponse
object
2 properties
StringServiceResponse
object
2 properties
UploadDocumentResponseDtoServiceResponse
object
2 properties
UpdateDocumentFileResponseDto
object
Basic information from the upload document api.
3 properties
ValidationErrorModel
object
4 properties
PropertyDto
object
Contains all the attributes needed in order to add custom fields to the document metadata
4 properties
UpdateDocumentDtoServiceRequest
object
1 property
ObjectServiceResponse
object
2 properties
CreateSignedUrlToUploadFileMultipleRequirementsRequestServiceRequest
object
1 property
CloneDocumentResponseDtoServiceResponse
object
2 properties
CreateVirtualDocResponseDtoServiceResponse
object
2 properties
CreateVirtualDocRequestDtoServiceRequest
object
1 property
UpdateDocumentFileDtoV2
object
Metadata needed to update a file.
2 properties
2 required
ArchiveAndReplaceDocumentRequestServiceRequest
object
1 property
UpdateDocumentStatusErrorDtoServiceRequest
object
1 property
CreateSignedUrlToUploadFileMultipleRequirementsRequest
object
Metadata needed to create Document models to fulfill multiple requirements and generate signed Url to upload file. Contains all properties needed to fill the m…
12 properties
2 required
CloneDocumentResponseDto
object
Contains the Document Model Attributes to return from the document clone command
7 properties
DocumentRequirementBulkDto
object
Contains document requirement attributes set during the bulk upload for multiple requirements
11 properties
UpdateDocumentStatusErrorDto
object
Properties to update the status of an uploaded document with a custom error code and message
2 properties
CreateSignedUrlToUploadFileResponse
object
Basic information from the upload document api.
6 properties
ArchiveAndReplaceDocumentRequest
object
Metadata needed to create Document model and generate signed Url to upload file.. Contains all properties needed to fill the metadata of the document being upl…
18 properties
4 required
CreateVirtualDocResponseDtoListServiceResponse
object
2 properties
ArchiveDocumentDto
object
Metadata needed to archive a document. Contains all properties needed to fill to archive the document.
1 property
1 required
CreateVirtualDocMultipleReqsRequestDtoServiceRequest
object
1 property
UpdateDocumentFileDtoV2ServiceRequest
object
1 property
CreateSignedUrlToUploadFileMultipleRequirementsResponseServiceResponse
object
2 properties
CreateVirtualDocMultipleReqsRequestDto
object
Metadata needed for a virtual document with multiple requirement. Contains all properties needed to fill the metadata of the document.
9 properties
3 required
CreateSignedUrlToUploadFileResponseServiceResponse
object
2 properties
CloneDocumentModelRequestDtoServiceRequest
object
1 property
UpdateDocumentAccessLayersDtoServiceRequest
object
1 property
UpdateDocumentAccessLayersDto
object
1 property
CreateSignedUrlToUploadFileRequestServiceRequest
object
1 property
CreateSignedUrlToUploadFileMultipleRequirementsResponse
object
Basic information from the upload document api for multiple requirements
5 properties
CreateVirtualDocRequestDto
object
Metadata needed for a virtual document. Contains all properties needed to fill the metadata of the document.
10 properties
3 required
CreateSignedUrlToUploadFileRequest
object
Metadata needed to create Document model and generate signed Url to upload file.. Contains all properties needed to fill the metadata of the document being upl…
16 properties
2 required
CreateVirtualDocResponseDto
object
Basic information from the virtual document.
4 properties
AccessLayerDto
object
DTO representing access layers attached
2 properties
CloneDocumentModelRequestDto
object
Contains the Document Model Attributes needed to clone a document to fulfill a requirement
8 properties
DocumentRequirementDto
object
Contains document requirement attributes need to be deserialized as input of Initialize Lambda
10 properties
ArchiveDocumentDtoServiceRequest
object
1 property
DocumentModelDto
object
Document metadata
32 properties
DocumentModelLiteDto
object
Represents a simplified version of document model data transfer object
29 properties
PagedEntityDocumentsResponseDtoServiceResponse
object
2 properties
PagedEntityDocumentsResponseDto
object
4 properties
StringIEnumerableServiceResponse
object
2 properties
DocumentModelDtoServiceResponse
object
2 properties
PagedEntityDocumentsStatusRequestDto
object
Represents options for setting up the results page
5 properties
PagedEntityDocumentsWithFilterRequestDtoServiceRequest
object
1 property
PagedEntityDocumentsRequestDto
object
Represents options for setting up the results page
4 properties
PagedEntityDocumentsWithTokenResponseDtoServiceResponse
object
2 properties
StringListServiceResponse
object
2 properties
PagedEntityDocumentsLiteResponseDtoServiceResponse
object
2 properties
PagedEntityDocumentsRequestDtoServiceRequest
object
1 property
Property
object
4 properties
PagedEntityDocumentsLiteResponseDto
object
Represents a paginated response containing simplified document models for an entity
4 properties
PagedEntityDocumentsWithFilterRequestDto
object
Request DTO for paginated documents by entity ID with optional status filter. Uses DynamoDB cursor-based pagination via PaginationToken.
4 properties
DocumentEntityType
object
2 properties
PagedEntityDocumentsWithTokenResponseDto
object
Response DTO for cursor-based paginated document results
5 properties
DocumentModelDtoIEnumerableServiceResponse
object
2 properties
PagedEntityDocumentsStatusRequestDtoServiceRequest
object
1 property
AccessLayerDto_2
object
DTO representing access layers attached
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Fenergo 12
Other APIs Fenergo publishes across the network.
Fenergo Acceptable Document API
Fenergo Access Layer API
Fenergo Adapter Mock API
Fenergo Advanced Dashboard API
Fenergo Agency API
Fenergo Agent API
Fenergo Agent Slos API
Fenergo Agent Value Story API
Fenergo Aggregation API
Fenergo Allocation API
Fenergo Allocation Configuration API
Fenergo Asset API
#Document Model
Where this information came from
This is an independent, third-party profile of Fenergo Document Model API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.