Enviance Document API
The Document API from Enviance — 5 operation(s) for document.
The Document API from Enviance — 5 operation(s) for document.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/enviance-document-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
version: Platform.v2026.2.0.0.20260708
title: Rest Activity Document API
description: EMS Rest API
contact:
name: Cority
email: support@cority.com
url: https://cority.com
servers:
- url: https://api.enviance.com/
tags:
- name: Document
paths:
/ver2/DocumentService.svc/documents:
post:
tags:
- Document
description: "\n\n\nenvianceSdk.documents.createDocument\n```\n[\n {\n \"name\": \"test-name\",\n \"description\": \"test-description\",\n \"folder\": \"/\",\n \"content\": \"77u/IkxvcmVtIGlwc3VtIGRvbG9yIHNpdCBhbWV0LCBjb25zZWN0ZXR1ciBhZGlwaXNpY2luZyBlbGl0LCBzZWQgZG8gZWl1c21vZCB0ZW1wb3IgaW5jaWRpZHVudCB1dCBsYWJvcmUgZXQgZG9sb3JlIG1hZ25hIGFsaXF1YS4gVXQgZW5pbSBhZCBtaW5pbSB2ZW5pYW0sIHF1aXMgbm9zdHJ1ZCBleGVyY2l0YXRpb24gdWxsYW1jbyBsYWJvcmlzIG5pc2kgdXQgYWxpcXVpcCBleCBlYSBjb21tb2RvIGNvbnNlcXVhdC4gRHVpcyBhdXRlIGlydXJlIGRvbG9yIGluIHJlcHJlaGVuZGVyaXQgaW4gdm9sdXB0YXRlIHZlbGl0IGVzc2UgY2lsbHVtIGRvbG9yZSBldSBmdWdpYXQgbnVsbGEgcGFyaWF0dXIuIEV4Y2VwdGV1ciBzaW50IG9jY2FlY2F0IGN1cGlkYXRhdCBub24gcHJvaWRlbnQsIHN1bnQgaW4gY3VscGEgcXVpIG9mZmljaWEgZGVzZXJ1bnQgbW9sbGl0IGFuaW0gaWQgZXN0IGxhYm9ydW0uIg==\",\n \"fileName\": \"test-file-name\"\n },\n \"onsuccess\",\n \"onerror\"\n]\n```\nenvianceSdk.documents.createDocumentBinary\n```\n[\n \"fileinput1\",\n {\n \"name\": \"test-name\",\n \"description\": \"test-description\",\n \"folder\": \"/\",\n \"fileName\": \"test-file-name\"\n },\n \"onsuccess\",\n \"onerror\"\n]\n```\nenvianceSdk.documents.createDocument21\n```\n[\n {\n \"name\": \"test-name\",\n \"description\": \"test-description\",\n \"folder\": \"/\",\n \"content\": \"77u/IkxvcmVtIGlwc3VtIGRvbG9yIHNpdCBhbWV0LCBjb25zZWN0ZXR1ciBhZGlwaXNpY2luZyBlbGl0LCBzZWQgZG8gZWl1c21vZCB0ZW1wb3IgaW5jaWRpZHVudCB1dCBsYWJvcmUgZXQgZG9sb3JlIG1hZ25hIGFsaXF1YS4gVXQgZW5pbSBhZCBtaW5pbSB2ZW5pYW0sIHF1aXMgbm9zdHJ1ZCBleGVyY2l0YXRpb24gdWxsYW1jbyBsYWJvcmlzIG5pc2kgdXQgYWxpcXVpcCBleCBlYSBjb21tb2RvIGNvbnNlcXVhdC4gRHVpcyBhdXRlIGlydXJlIGRvbG9yIGluIHJlcHJlaGVuZGVyaXQgaW4gdm9sdXB0YXRlIHZlbGl0IGVzc2UgY2lsbHVtIGRvbG9yZSBldSBmdWdpYXQgbnVsbGEgcGFyaWF0dXIuIEV4Y2VwdGV1ciBzaW50IG9jY2FlY2F0IGN1cGlkYXRhdCBub24gcHJvaWRlbnQsIHN1bnQgaW4gY3VscGEgcXVpIG9mZmljaWEgZGVzZXJ1bnQgbW9sbGl0IGFuaW0gaWQgZXN0IGxhYm9ydW0uIg==\",\n \"fileName\": \"test-file-name\",\n \"workflows\": [\n {\n \"workflowIdOrUniqueId\": \"workflowInst1\",\n \"customFieldIdOrName\": \"udf1\"\n },\n {\n \"workflowIdOrUniqueId\": \"workflowInst2\",\n \"customFieldIdOrName\": \"udf2\"\n }\n ]\n },\n \"onsuccess\",\n \"onerror\"\n]\n```\nenvianceSdk.documents.createDocumentBinary21\n```\n[\n \"fileinput1\",\n {\n \"name\": \"test-name\",\n \"description\": \"test-description\",\n \"folder\": \"/\",\n \"fileName\": \"test-file-name\",\n \"workflows\": [\n {\n \"workflowIdOrUniqueId\": \"workflowInst1\",\n \"customFieldIdOrName\": \"udf1\"\n },\n {\n \"workflowIdOrUniqueId\": \"workflowInst2\",\n \"customFieldIdOrName\": \"udf2\"\n }\n ]\n },\n \"onsuccess\",\n \"onerror\"\n]\n```\nenvianceSdk.documents.createDocumentBinary21Ext\n```\n[\n {\n \"fileInput\": \"fileinput1\",\n \"documentInfo\": {\n \"name\": \"test-name\",\n \"description\": \"test-description\",\n \"folder\": \"/\",\n \"fileName\": \"test-file-name\",\n \"workflows\": [\n {\n \"workflowIdOrUniqueId\": \"workflowInst1\",\n \"customFieldIdOrName\": \"udf1\"\n },\n {\n \"workflowIdOrUniqueId\": \"workflowInst2\",\n \"customFieldIdOrName\": \"udf2\"\n }\n ]\n },\n \"clientRequestId\": \"64AA5290-15F2-451B-9EF3-4494F66FE59E\"\n },\n \"onsuccess\",\n \"onerror\"\n]\n```\nenvianceSdk.documents.createDocumentFolder\n```\n[\n {\n \"name\": \"test-folder\",\n \"description\": \"test-folder-description\",\n \"parentFolder\": \"/\"\n },\n \"onsuccess\",\n \"onerror\"\n]\n```\n\n"
operationId: Enviance.RestServices.Ver2.Documents.Impl.DocumentService.CreateDocument
parameters:
- name: EnvApi-Systemid
in: header
description: Specify specific system to run instead of Home
schema:
type: string
- name: EnvApi-Packageid
in: header
description: (optional) Clients application/package ID
schema:
type: string
- name: EnvApi-Udf-DateTime-Iso-In-CustomFields
in: header
description: Udfs of DateTime should use Iso
schema:
type: string
default: 'true'
- name: EnvApi-Udf-DateTime-ReadInUserTz
in: header
description: (obsolete) Udfs of DateTime type whould be in ReadInUserTz
schema:
type: string
- name: EnvApi-Udf-Value-Invariant
in: header
description: (optional) Udfs - Force Non-Localized (invariant) values
schema:
type: string
- name: EnvApi-Localization-All
in: header
description: (optional) Extend objects with User-given Localizations
schema:
type: string
- name: x-client-request-id
in: header
description: (optional) Client ID for double submit prevention
schema:
type: string
responses:
default:
description: not available
content:
application/json:
schema:
type: string
format: guid
application/xml:
schema:
type: string
format: guid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDocument'
application/xml:
schema:
$ref: '#/components/schemas/CreateDocument'
required: true
/ver2/DocumentService.svc/documents/{documentIdOrPath}:
get:
tags:
- Document
description: "\n\n\nenvianceSdk.documents.getDocument\n```\n[\n \"/test-name\",\n \"onsuccess\",\n \"onerror\"\n]\n```\n\n"
operationId: Enviance.RestServices.Ver2.Documents.Impl.DocumentService.GetDocumentInfo
parameters:
- name: EnvApi-Systemid
in: header
description: Specify specific system to run instead of Home
schema:
type: string
- name: EnvApi-Packageid
in: header
description: (optional) Clients application/package ID
schema:
type: string
- name: EnvApi-Udf-DateTime-Iso-In-CustomFields
in: header
description: Udfs of DateTime should use Iso
schema:
type: string
default: 'true'
- name: EnvApi-Udf-DateTime-ReadInUserTz
in: header
description: (obsolete) Udfs of DateTime type whould be in ReadInUserTz
schema:
type: string
- name: EnvApi-Udf-Value-Invariant
in: header
description: (optional) Udfs - Force Non-Localized (invariant) values
schema:
type: string
- name: EnvApi-Localization-All
in: header
description: (optional) Extend objects with User-given Localizations
schema:
type: string
- name: x-client-request-id
in: header
description: (optional) Client ID for double submit prevention
schema:
type: string
- name: documentIdOrPath
in: path
required: true
schema:
type: string
responses:
default:
description: not available
content:
application/json:
schema:
$ref: '#/components/schemas/Enviance.RestServices.Ver2.Documents.DocumentInfo'
application/xml:
schema:
$ref: '#/components/schemas/Enviance.RestServices.Ver2.Documents.DocumentInfo'
patch:
tags:
- Document
description: "\n\n\nenvianceSdk.documents.updateDocument\n```\n[\n \"/test-name\",\n {\n \"name\": \"test-name-update\",\n \"description\": \"test-description-update\",\n \"folder\": \"/\",\n \"content\": \"77u/IkxvcmVtIGlwc3VtIGRvbG9yIHNpdCBhbWV0LCBjb25zZWN0ZXR1ciBhZGlwaXNpY2luZyBlbGl0LCBzZWQgZG8gZWl1c21vZCB0ZW1wb3IgaW5jaWRpZHVudCB1dCBsYWJvcmUgZXQgZG9sb3JlIG1hZ25hIGFsaXF1YS4gVXQgZW5pbSBhZCBtaW5pbSB2ZW5pYW0sIHF1aXMgbm9zdHJ1ZCBleGVyY2l0YXRpb24gdWxsYW1jbyBsYWJvcmlzIG5pc2kgdXQgYWxpcXVpcCBleCBlYSBjb21tb2RvIGNvbnNlcXVhdC4gRHVpcyBhdXRlIGlydXJlIGRvbG9yIGluIHJlcHJlaGVuZGVyaXQgaW4gdm9sdXB0YXRlIHZlbGl0IGVzc2UgY2lsbHVtIGRvbG9yZSBldSBmdWdpYXQgbnVsbGEgcGFyaWF0dXIuIEV4Y2VwdGV1ciBzaW50IG9jY2FlY2F0IGN1cGlkYXRhdCBub24gcHJvaWRlbnQsIHN1bnQgaW4gY3VscGEgcXVpIG9mZmljaWEgZGVzZXJ1bnQgbW9sbGl0IGFuaW0gaWQgZXN0IGxhYm9ydW0uIg==\",\n \"fileName\": \"test-file-name\"\n },\n \"onsuccess\",\n \"onerror\"\n]\n```\nenvianceSdk.documents.updateDocumentBinary\n```\n[\n \"fileinput1\",\n \"/test-name\",\n {\n \"name\": \"test-name-update\",\n \"description\": \"test-description-update\",\n \"folder\": \"/\",\n \"fileName\": \"test-file-name\"\n },\n \"false\",\n \"onsuccess\",\n \"onerror\"\n]\n```\nenvianceSdk.documents.updateDocument21\n```\n[\n \"/test-name\",\n {\n \"name\": \"test-name-update\",\n \"description\": \"test-description-update\",\n \"folder\": \"/\",\n \"content\": \"77u/IkxvcmVtIGlwc3VtIGRvbG9yIHNpdCBhbWV0LCBjb25zZWN0ZXR1ciBhZGlwaXNpY2luZyBlbGl0LCBzZWQgZG8gZWl1c21vZCB0ZW1wb3IgaW5jaWRpZHVudCB1dCBsYWJvcmUgZXQgZG9sb3JlIG1hZ25hIGFsaXF1YS4gVXQgZW5pbSBhZCBtaW5pbSB2ZW5pYW0sIHF1aXMgbm9zdHJ1ZCBleGVyY2l0YXRpb24gdWxsYW1jbyBsYWJvcmlzIG5pc2kgdXQgYWxpcXVpcCBleCBlYSBjb21tb2RvIGNvbnNlcXVhdC4gRHVpcyBhdXRlIGlydXJlIGRvbG9yIGluIHJlcHJlaGVuZGVyaXQgaW4gdm9sdXB0YXRlIHZlbGl0IGVzc2UgY2lsbHVtIGRvbG9yZSBldSBmdWdpYXQgbnVsbGEgcGFyaWF0dXIuIEV4Y2VwdGV1ciBzaW50IG9jY2FlY2F0IGN1cGlkYXRhdCBub24gcHJvaWRlbnQsIHN1bnQgaW4gY3VscGEgcXVpIG9mZmljaWEgZGVzZXJ1bnQgbW9sbGl0IGFuaW0gaWQgZXN0IGxhYm9ydW0uIg==\",\n \"fileName\": \"test-file-name\",\n \"workflows\": [\n {\n \"workflowIdOrUniqueId\": \"workflowInst1\",\n \"customFieldIdOrName\": \"udf1\"\n },\n {\n \"workflowIdOrUniqueId\": \"workflowInst2\",\n \"customFieldIdOrName\": \"udf2\"\n }\n ]\n },\n \"onsuccess\",\n \"onerror\"\n]\n```\nenvianceSdk.documents.updateDocumentBinary21\n```\n[\n \"fileinput1\",\n \"/test-name\",\n {\n \"name\": \"test-name-update\",\n \"description\": \"test-description-update\",\n \"folder\": \"/\",\n \"fileName\": \"test-file-name\",\n \"workflows\": [\n {\n \"workflowIdOrUniqueId\": \"workflowInst1\",\n \"customFieldIdOrName\": \"udf1\"\n },\n {\n \"workflowIdOrUniqueId\": \"workflowInst2\",\n \"customFieldIdOrName\": \"udf2\"\n }\n ]\n },\n \"false\",\n \"onsuccess\",\n \"onerror\"\n]\n```\nenvianceSdk.documents.updateDocumentBinary21Ext\n```\n[\n {\n \"fileInput\": \"fileinput1\",\n \"documentIdOrPath\": \"/test-name\",\n \"documentInfo\": {\n \"name\": \"test-name-update\",\n \"description\": \"test-description-update\",\n \"folder\": \"/\",\n \"fileName\": \"test-file-name\",\n \"workflows\": [\n {\n \"workflowIdOrUniqueId\": \"workflowInst1\",\n \"customFieldIdOrName\": \"udf1\"\n },\n {\n \"workflowIdOrUniqueId\": \"workflowInst2\",\n \"customFieldIdOrName\": \"udf2\"\n }\n ]\n },\n \"updateExistingVersion\": \"false\",\n \"clientRequestId\": \"64AA5290-15F2-451B-9EF3-4494F66FE47F\"\n },\n \"onsuccess\",\n \"onerror\"\n]\n```\nenvianceSdk.documents.updateDocumentFolder\n```\n[\n \"/test-folder\",\n {\n \"name\": \"test-folder-update\",\n \"description\": \"test-folder-description-update\",\n \"parentFolderIdOrPath\": \"/\"\n },\n \"onsuccess\",\n \"onerror\"\n]\n```\n\n"
operationId: Enviance.RestServices.Ver2.Documents.Impl.DocumentService.UpdateDocument
parameters:
- name: EnvApi-Systemid
in: header
description: Specify specific system to run instead of Home
schema:
type: string
- name: EnvApi-Packageid
in: header
description: (optional) Clients application/package ID
schema:
type: string
- name: EnvApi-Udf-DateTime-Iso-In-CustomFields
in: header
description: Udfs of DateTime should use Iso
schema:
type: string
default: 'true'
- name: EnvApi-Udf-DateTime-ReadInUserTz
in: header
description: (obsolete) Udfs of DateTime type whould be in ReadInUserTz
schema:
type: string
- name: EnvApi-Udf-Value-Invariant
in: header
description: (optional) Udfs - Force Non-Localized (invariant) values
schema:
type: string
- name: EnvApi-Localization-All
in: header
description: (optional) Extend objects with User-given Localizations
schema:
type: string
- name: x-client-request-id
in: header
description: (optional) Client ID for double submit prevention
schema:
type: string
- name: documentIdOrPath
in: path
required: true
schema:
type: string
- name: UpdateExistingVersion
in: query
required: true
schema:
type: string
responses:
default:
description: not available
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDocument'
application/xml:
schema:
$ref: '#/components/schemas/UpdateDocument'
required: true
delete:
tags:
- Document
description: "\n\n\nenvianceSdk.documents.deleteDocument\n```\n[\n \"/test-name\",\n \"onsuccess\",\n \"onerror\"\n]\n```\nenvianceSdk.documents.deleteDocumentExt\n```\n[\n {\n \"documentIdOrPath\": \"eccd2310-9b5f-440b-bf0d-91f9803d036b\",\n \"clientRequestId\": \"64AA5290-15F2-451B-9EF3-4494F66FE59E\"\n },\n \"onsuccess\",\n \"onerror\"\n]\n```\nenvianceSdk.documents.deleteDocumentFolder\n```\n[\n \"/test-folder\",\n \"onsuccess\",\n \"onerror\"\n]\n```\n\n"
operationId: Enviance.RestServices.Ver2.Documents.Impl.DocumentService.DeleteDocument
parameters:
- name: EnvApi-Systemid
in: header
description: Specify specific system to run instead of Home
schema:
type: string
- name: EnvApi-Packageid
in: header
description: (optional) Clients application/package ID
schema:
type: string
- name: EnvApi-Udf-DateTime-Iso-In-CustomFields
in: header
description: Udfs of DateTime should use Iso
schema:
type: string
default: 'true'
- name: EnvApi-Udf-DateTime-ReadInUserTz
in: header
description: (obsolete) Udfs of DateTime type whould be in ReadInUserTz
schema:
type: string
- name: EnvApi-Udf-Value-Invariant
in: header
description: (optional) Udfs - Force Non-Localized (invariant) values
schema:
type: string
- name: EnvApi-Localization-All
in: header
description: (optional) Extend objects with User-given Localizations
schema:
type: string
- name: x-client-request-id
in: header
description: (optional) Client ID for double submit prevention
schema:
type: string
- name: documentIdOrPath
in: path
required: true
schema:
type: string
responses:
default:
description: not available
/ver2/DocumentService.svc/documents/zip:
post:
tags:
- Document
operationId: Enviance.RestServices.Ver2.Documents.Impl.DocumentService.GetDocumentsBulk
parameters:
- name: EnvApi-Systemid
in: header
description: Specify specific system to run instead of Home
schema:
type: string
- name: EnvApi-Packageid
in: header
description: (optional) Clients application/package ID
schema:
type: string
- name: EnvApi-Udf-DateTime-Iso-In-CustomFields
in: header
description: Udfs of DateTime should use Iso
schema:
type: string
default: 'true'
- name: EnvApi-Udf-DateTime-ReadInUserTz
in: header
description: (obsolete) Udfs of DateTime type whould be in ReadInUserTz
schema:
type: string
- name: EnvApi-Udf-Value-Invariant
in: header
description: (optional) Udfs - Force Non-Localized (invariant) values
schema:
type: string
- name: EnvApi-Localization-All
in: header
description: (optional) Extend objects with User-given Localizations
schema:
type: string
- name: x-client-request-id
in: header
description: (optional) Client ID for double submit prevention
schema:
type: string
responses:
default:
description: not available
content:
application/json:
schema:
type: array
items:
type: string
format: byte
application/xml:
schema:
type: array
items:
type: string
format: byte
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetDocumentsBulk'
application/xml:
schema:
$ref: '#/components/schemas/GetDocumentsBulk'
required: true
/ver2/DocumentService.svc/folders:
post:
tags:
- Document
description: "\n\n\nenvianceSdk.documents.createDocumentFolder\n```\n[\n {\n \"name\": \"test-folder\",\n \"description\": \"test-folder-description\",\n \"parentFolder\": \"/\"\n },\n \"onsuccess\",\n \"onerror\"\n]\n```\n\n"
operationId: Enviance.RestServices.Ver2.Documents.Impl.DocumentService.CreateDocumentFolder
parameters:
- name: EnvApi-Systemid
in: header
description: Specify specific system to run instead of Home
schema:
type: string
- name: EnvApi-Packageid
in: header
description: (optional) Clients application/package ID
schema:
type: string
- name: EnvApi-Udf-DateTime-Iso-In-CustomFields
in: header
description: Udfs of DateTime should use Iso
schema:
type: string
default: 'true'
- name: EnvApi-Udf-DateTime-ReadInUserTz
in: header
description: (obsolete) Udfs of DateTime type whould be in ReadInUserTz
schema:
type: string
- name: EnvApi-Udf-Value-Invariant
in: header
description: (optional) Udfs - Force Non-Localized (invariant) values
schema:
type: string
- name: EnvApi-Localization-All
in: header
description: (optional) Extend objects with User-given Localizations
schema:
type: string
- name: x-client-request-id
in: header
description: (optional) Client ID for double submit prevention
schema:
type: string
responses:
default:
description: not available
content:
application/json:
schema:
type: string
format: guid
application/xml:
schema:
type: string
format: guid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDocumentFolder'
application/xml:
schema:
$ref: '#/components/schemas/CreateDocumentFolder'
required: true
/ver2/DocumentService.svc/folders/{documentFolderIdOrPath}:
get:
tags:
- Document
description: "\n\n\nenvianceSdk.documents.getDocumentFolder\n```\n[\n \"/test-folder\",\n \"onsuccess\",\n \"onerror\"\n]\n```\n\n"
operationId: Enviance.RestServices.Ver2.Documents.Impl.DocumentService.GetDocumentFolder
parameters:
- name: EnvApi-Systemid
in: header
description: Specify specific system to run instead of Home
schema:
type: string
- name: EnvApi-Packageid
in: header
description: (optional) Clients application/package ID
schema:
type: string
- name: EnvApi-Udf-DateTime-Iso-In-CustomFields
in: header
description: Udfs of DateTime should use Iso
schema:
type: string
default: 'true'
- name: EnvApi-Udf-DateTime-ReadInUserTz
in: header
description: (obsolete) Udfs of DateTime type whould be in ReadInUserTz
schema:
type: string
- name: EnvApi-Udf-Value-Invariant
in: header
description: (optional) Udfs - Force Non-Localized (invariant) values
schema:
type: string
- name: EnvApi-Localization-All
in: header
description: (optional) Extend objects with User-given Localizations
schema:
type: string
- name: x-client-request-id
in: header
description: (optional) Client ID for double submit prevention
schema:
type: string
- name: documentFolderIdOrPath
in: path
required: true
schema:
type: string
responses:
default:
description: not available
content:
application/json:
schema:
$ref: '#/components/schemas/Enviance.RestServices.Ver2.Documents.DocumentFolderInfo'
application/xml:
schema:
$ref: '#/components/schemas/Enviance.RestServices.Ver2.Documents.DocumentFolderInfo'
patch:
tags:
- Document
description: "\n\n\nenvianceSdk.documents.updateDocumentFolder\n```\n[\n \"/test-folder\",\n {\n \"name\": \"test-folder-update\",\n \"description\": \"test-folder-description-update\",\n \"parentFolderIdOrPath\": \"/\"\n },\n \"onsuccess\",\n \"onerror\"\n]\n```\n\n"
operationId: Enviance.RestServices.Ver2.Documents.Impl.DocumentService.UpdateDocumentFolder
parameters:
- name: EnvApi-Systemid
in: header
description: Specify specific system to run instead of Home
schema:
type: string
- name: EnvApi-Packageid
in: header
description: (optional) Clients application/package ID
schema:
type: string
- name: EnvApi-Udf-DateTime-Iso-In-CustomFields
in: header
description: Udfs of DateTime should use Iso
schema:
type: string
default: 'true'
- name: EnvApi-Udf-DateTime-ReadInUserTz
in: header
description: (obsolete) Udfs of DateTime type whould be in ReadInUserTz
schema:
type: string
- name: EnvApi-Udf-Value-Invariant
in: header
description: (optional) Udfs - Force Non-Localized (invariant) values
schema:
type: string
- name: EnvApi-Localization-All
in: header
description: (optional) Extend objects with User-given Localizations
schema:
type: string
- name: x-client-request-id
in: header
description: (optional) Client ID for double submit prevention
schema:
type: string
- name: documentFolderIdOrPath
in: path
required: true
schema:
type: string
responses:
default:
description: not available
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDocumentFolder'
application/xml:
schema:
$ref: '#/components/schemas/UpdateDocumentFolder'
required: true
delete:
tags:
- Document
description: "\n\n\nenvianceSdk.documents.deleteDocumentFolder\n```\n[\n \"/test-folder\",\n \"onsuccess\",\n \"onerror\"\n]\n```\n\n"
operationId: Enviance.RestServices.Ver2.Documents.Impl.DocumentService.DeleteDocumentFolder
parameters:
- name: EnvApi-Systemid
in: header
description: Specify specific system to run instead of Home
schema:
type: string
- name: EnvApi-Packageid
in: header
description: (optional) Clients application/package ID
schema:
type: string
- name: EnvApi-Udf-DateTime-Iso-In-CustomFields
in: header
description: Udfs of DateTime should use Iso
schema:
type: string
default: 'true'
- name: EnvApi-Udf-DateTime-ReadInUserTz
in: header
description: (obsolete) Udfs of DateTime type whould be in ReadInUserTz
schema:
type: string
- name: EnvApi-Udf-Value-Invariant
in: header
description: (optional) Udfs - Force Non-Localized (invariant) values
schema:
type: string
- name: EnvApi-Localization-All
in: header
description: (optional) Extend objects with User-given Localizations
schema:
type: string
- name: x-client-request-id
in: header
description: (optional) Client ID for double submit prevention
schema:
type: string
- name: documentFolderIdOrPath
in: path
required: true
schema:
type: string
responses:
default:
description: not available
components:
schemas:
UpdateDocument:
properties:
documentInfo:
$ref: '#/components/schemas/Enviance.RestServices.Ver2.Documents.DocumentInfo'
type: object
format: UpdateDocument
GetDocumentsBulk:
properties:
documents:
type: array
items:
$ref: '#/components/schemas/Enviance.RestServices.Ver2.Documents.DocumentZipItem'
uniqueItems: false
type: object
format: GetDocumentsBulk
Enviance.RestServices.Ver2.Documents.DocumentInfo:
properties:
id:
type: string
format: guid
uniqueItems: false
name:
type: string
uniqueItems: false
mimeType:
type: string
uniqueItems: false
fileName:
type: string
uniqueItems: false
description:
type: string
uniqueItems: false
folder:
type: string
uniqueItems: false
content:
type: string
uniqueItems: false
contentUrl:
type: string
uniqueItems: false
version:
type: integer
format: int32
uniqueItems: false
objects:
type: array
items:
type: string
uniqueItems: false
tasks:
type: array
items:
type: string
uniqueItems: false
workflows:
type: array
items:
type: string
uniqueItems: false
NameSuffixOnDuplication:
type: string
format: enum
uniqueItems: false
enum:
- None
- Timestamp
- Increment
- Guid
comments:
type: string
uniqueItems: false
type: object
format: Enviance.RestServices.Ver2.Documents.DocumentInfo
CreateDocument:
properties:
documentInfo:
$ref: '#/components/schemas/Enviance.RestServices.Ver2.Documents.DocumentInfo'
copyFrom:
type: string
uniqueItems: false
type: object
format: CreateDocument
Enviance.RestServices.Ver2.Documents.DocumentFolderInfo:
properties:
id:
type: string
format: guid
uniqueItems: false
name:
type: string
uniqueItems: false
description:
type: string
uniqueItems: false
parentFolderIdOrPath:
type: string
uniqueItems: false
type: object
format: Enviance.RestServices.Ver2.Documents.DocumentFolderInfo
Enviance.RestServices.Ver2.Documents.DocumentZipItem:
properties:
documentIdOrPath:
type: string
uniqueItems: false
resultDocumentPathName:
type: string
uniqueItems: false
type: object
format: Enviance.RestServices.Ver2.Documents.DocumentZipItem
UpdateDocumentFolder:
properties:
documentFolderInfo:
$ref: '#/components/schemas/Enviance.RestServices.Ver2.Documents.DocumentFolderInfo'
type: object
format: UpdateDocumentFolder
CreateDocumentFolder:
properties:
documentFolderInfo:
$ref: '#/components/schemas/Enviance.RestServices.Ver2.Documents.DocumentFolderInfo'
copyFrom:
type: string
uniqueItems: false
type: object
format: CreateDocumentFolder
securitySchemes:
Basic:
type: http
scheme: basic
description: Forces authentication with credentials via an api gateway
EnvianceAuth:
type: apiKey
description: "**Enviance \\<SessionId\\>**. \n\t\t\t\t\t Obtain SessionId by POST /ver2/AuthenticationService.svc/sessions first"
name: Authorization
in: header