Every API here is available over the APIs.io API and to AI agents over MCP.
{
"openapi": "3.0.1",
"info": {
"title": "Fenergo Nebula Document Management Command",
"description": "Command API to manage the documents uploaded from FenX app. The documents can be linked with Entity Id, Journey Id and Document Requirement ",
"version": "1.0"
},
"servers": [
{
"url": "/documentmanagementcommand"
}
],
"paths": {
"/api/acceptabledocument/set": {
"post": {
"tags": [
"AcceptableDocument"
],
"summary": "Create acceptable document set model",
"description": "<ul>\r\n <li>Creates a new acceptable document set with a first draft version.</li>\r\n <li>The new version initializes with the provided data, has the default status of draft\r\n and the author as the only required signee.</li>\r\n</ul><br /><br /><b>Required permissions:</b><br />Following permissions are required: DocumentConfigurationEdit",
"operationId": "CreateAcceptableDocumentSet",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"202": {
"description": "Acceptable document set model created successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CreateAcceptableDocumentSetResponseDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateAcceptableDocumentSetResponseDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateAcceptableDocumentSetResponseDtoServiceResponse"
}
}
}
},
"400": {
"description": "Invalid request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "An exception occurred while processing the command"
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/acceptabledocument/set/{setId}/version/{versionNumber}": {
"post": {
"tags": [
"AcceptableDocument"
],
"summary": "Create acceptable document set version by version number",
"description": "<ul>\r\n <li>Creates a new version from an existing acceptable document version.</li>\r\n <li>Assigns the next available version number.</li>\r\n <li>The new version initializes with the provided data, has the default status of draft\r\n and the author as the only required signee.</li>\r\n</ul><br /><br /><b>Required permissions:</b><br />Following permissions are required: DocumentConfigurationEdit",
"operationId": "CreateAcceptableDocumentSetVersionByVersionNumber",
"parameters": [
{
"name": "setId",
"in": "path",
"description": "Acceptable document set id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Version number to be cloned",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"202": {
"description": "Acceptable document set model created successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CreateAcceptableDocumentSetResponseDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateAcceptableDocumentSetResponseDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateAcceptableDocumentSetResponseDtoServiceResponse"
}
}
}
},
"400": {
"description": "Invalid request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not found. Acceptable document set with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "An exception occurred while processing the command"
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
},
"put": {
"tags": [
"AcceptableDocument"
],
"summary": "Update acceptable document set version",
"description": "\nUpdates an existing acceptable document set version. Only draft and rejected versions are allowed to be updated.<br /><br /><b>Required permissions:</b><br />Following permissions are required: DocumentConfigurationEdit",
"operationId": "UpdateAcceptableDocumentSetVersion",
"parameters": [
{
"name": "setId",
"in": "path",
"description": "Acceptable document set id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Version number to update",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "Update requirement set version request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateAcceptableDocumentSetVersionDtoServiceRequest"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateAcceptableDocumentSetVersionDtoServiceRequest"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateAcceptableDocumentSetVersionDtoServiceRequest"
}
]
}
}
}
},
"responses": {
"202": {
"description": "Success. Acceptable Document set version updated"
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not found. Acceptable Document set with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"409": {
"description": "Conflict saving changes in expected version",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "There are conflicts that cannot be resolved automatically, get latest and apply your changes",
"type": "Error",
"errorCode": "CONFLICT"
}
]
}
}
}
},
"500": {
"description": "An exception occurred while processing the command"
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
},
"delete": {
"tags": [
"AcceptableDocument"
],
"summary": "Delete acceptable document set version",
"description": "<ul>\r\n <li>Deletes the selected version of an existing acceptable document set.</li>\r\n <li>If the version is the last one, then the version number of it will become the next available one for the model.\r\n Otherwise, the version number will be flagged as deleted and become unavailable.</li>\r\n</ul><br /><br /><b>Required permissions:</b><br />Following permissions are required: DocumentConfigurationDelete",
"operationId": "DeleteAcceptableDocumentSetVersion",
"parameters": [
{
"name": "setId",
"in": "path",
"description": "Acceptable document set id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Version number to delete",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"202": {
"description": "Success. Acceptable document set version deleted"
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not found. Acceptable document set with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "An exception occurred while processing the command"
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/acceptabledocument/set/{setId}": {
"post": {
"tags": [
"AcceptableDocument"
],
"summary": "Create acceptable document set version with given acceptable documents",
"description": "<ul>\r\n <li>Creates a new version from the given acceptable documents.</li>\r\n <li>Assigns the next available version number.</li>\r\n <li>The new version initializes with the provided data, has the default status of draft\r\n and the author as the only required signee.</li>\r\n</ul><br /><br /><b>Required permissions:</b><br />Following permissions are required: DocumentConfigurationEdit",
"operationId": "CreateAcceptableDocumentSetVersion",
"parameters": [
{
"name": "setId",
"in": "path",
"description": "Acceptable document set id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "Request body containing the acceptable document set version data",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CreateAcceptableDocumentSetVersionDtoServiceRequest"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CreateAcceptableDocumentSetVersionDtoServiceRequest"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CreateAcceptableDocumentSetVersionDtoServiceRequest"
}
]
}
}
}
},
"responses": {
"202": {
"description": "Acceptable document set model created successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CreateAcceptableDocumentSetResponseDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateAcceptableDocumentSetResponseDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateAcceptableDocumentSetResponseDtoServiceResponse"
}
}
}
},
"400": {
"description": "Invalid request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not found. Acceptable document set with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "An exception occurred while processing the command"
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
},
"delete": {
"tags": [
"AcceptableDocument"
],
"summary": "Delete acceptable document set and all its versions",
"description": "\nDeletes an existing acceptable document set and all its versions.<br /><br /><b>Required permissions:</b><br />Following permissions are required: DocumentConfigurationDelete",
"operationId": "DeleteAcceptableDocumentSet",
"parameters": [
{
"name": "setId",
"in": "path",
"description": "Acceptable document set id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"202": {
"description": "Success. Acceptable document set deleted"
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not found. Acceptable document set with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "An exception occurred while processing the command"
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/acceptabledocument/set/{setId}/version/{versionNumber}/submit-for-approval": {
"put": {
"tags": [
"AcceptableDocument"
],
"summary": "Submit acceptable document set version for a
# --- truncated at 32 KB (341 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/fenergo/refs/heads/main/openapi/fenergo-documentmanagementcommand-v1-0-openapi.json