Document
PATCH /ver2/DocumentService.svc/documents/{documentIdOrPath}
envianceSdk.documents.updateDocument
[
"/test-name",
{
"name": "test-name-update",
"description": "test-description-update",
"folder": "/",
"content": "77u/IkxvcmVtIGlwc3VtIGRvbG9yIHNpdCBhbWV0LCBjb25zZWN0ZXR1ciBhZGlwaXNpY2luZyBlbGl0LCBzZWQgZG8gZWl1c21vZCB0ZW1wb3IgaW5jaWRpZHVudCB1dCBsYWJvcmUgZXQgZG9sb3JlIG1hZ25hIGFsaXF1YS4gVXQgZW5pbSBhZCBtaW5pbSB2ZW5pYW0sIHF1aXMgbm9zdHJ1ZCBleGVyY2l0YXRpb24gdWxsYW1jbyBsYWJvcmlzIG5pc2kgdXQgYWxpcXVpcCBleCBlYSBjb21tb2RvIGNvbnNlcXVhdC4gRHVpcyBhdXRlIGlydXJlIGRvbG9yIGluIHJlcHJlaGVuZGVyaXQgaW4gdm9sdXB0YXRlIHZlbGl0IGVzc2UgY2lsbHVtIGRvbG9yZSBldSBmdWdpYXQgbnVsbGEgcGFyaWF0dXIuIEV4Y2VwdGV1ciBzaW50IG9jY2FlY2F0IGN1cGlkYXRhdCBub24gcHJvaWRlbnQsIHN1bnQgaW4gY3VscGEgcXVpIG9mZmljaWEgZGVzZXJ1bnQgbW9sbGl0IGFuaW0gaWQgZXN0IGxhYm9ydW0uIg==",
"fileName": "test-file-name"
},
"onsuccess",
"onerror"
]
envianceSdk.documents.updateDocumentBinary
[
"fileinput1",
"/test-name",
{
"name": "test-name-update",
"description": "test-description-update",
"folder": "/",
"fileName": "test-file-name"
},
"false",
"onsuccess",
"onerror"
]
envianceSdk.documents.updateDocument21
[
"/test-name",
{
"name": "test-name-update",
"description": "test-description-update",
"folder": "/",
"content": "77u/IkxvcmVtIGlwc3VtIGRvbG9yIHNpdCBhbWV0LCBjb25zZWN0ZXR1ciBhZGlwaXNpY2luZyBlbGl0LCBzZWQgZG8gZWl1c21vZCB0ZW1wb3IgaW5jaWRpZHVudCB1dCBsYWJvcmUgZXQgZG9sb3JlIG1hZ25hIGFsaXF1YS4gVXQgZW5pbSBhZCBtaW5pbSB2ZW5pYW0sIHF1aXMgbm9zdHJ1ZCBleGVyY2l0YXRpb24gdWxsYW1jbyBsYWJvcmlzIG5pc2kgdXQgYWxpcXVpcCBleCBlYSBjb21tb2RvIGNvbnNlcXVhdC4gRHVpcyBhdXRlIGlydXJlIGRvbG9yIGluIHJlcHJlaGVuZGVyaXQgaW4gdm9sdXB0YXRlIHZlbGl0IGVzc2UgY2lsbHVtIGRvbG9yZSBldSBmdWdpYXQgbnVsbGEgcGFyaWF0dXIuIEV4Y2VwdGV1ciBzaW50IG9jY2FlY2F0IGN1cGlkYXRhdCBub24gcHJvaWRlbnQsIHN1bnQgaW4gY3VscGEgcXVpIG9mZmljaWEgZGVzZXJ1bnQgbW9sbGl0IGFuaW0gaWQgZXN0IGxhYm9ydW0uIg==",
"fileName": "test-file-name",
"workflows": [
{
"workflowIdOrUniqueId": "workflowInst1",
"customFieldIdOrName": "udf1"
},
{
"workflowIdOrUniqueId": "workflowInst2",
"customFieldIdOrName": "udf2"
}
]
},
"onsuccess",
"onerror"
]
envianceSdk.documents.updateDocumentBinary21
[
"fileinput1",
"/test-name",
{
"name": "test-name-update",
"description": "test-description-update",
"folder": "/",
"fileName": "test-file-name",
"workflows": [
{
"workflowIdOrUniqueId": "workflowInst1",
"customFieldIdOrName": "udf1"
},
{
"workflowIdOrUniqueId": "workflowInst2",
"customFieldIdOrName": "udf2"
}
]
},
"false",
"onsuccess",
"onerror"
]
envianceSdk.documents.updateDocumentBinary21Ext
[
{
"fileInput": "fileinput1",
"documentIdOrPath": "/test-name",
"documentInfo": {
"name": "test-name-update",
"description": "test-description-update",
"folder": "/",
"fileName": "test-file-name",
"workflows": [
{
"workflowIdOrUniqueId": "workflowInst1",
"customFieldIdOrName": "udf1"
},
{
"workflowIdOrUniqueId": "workflowInst2",
"customFieldIdOrName": "udf2"
}
]
},
"updateExistingVersion": "false",
"clientRequestId": "64AA5290-15F2-451B-9EF3-4494F66FE47F"
},
"onsuccess",
"onerror"
]
envianceSdk.documents.updateDocumentFolder
[
"/test-folder",
{
"name": "test-folder-update",
"description": "test-folder-description-update",
"parentFolderIdOrPath": "/"
},
"onsuccess",
"onerror"
]
Request
- Base URLhttps://api.enviance.com (the document declares no server; this is the origin it was published from)
- Authnone declared
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
documentIdOrPathstring required
Query parameters
UpdateExistingVersionstring required
Headers
EnvApi-Systemidstring
Specify specific system to run instead of Home
EnvApi-Packageidstring
(optional) Clients application/package ID
EnvApi-Udf-DateTime-Iso-In-CustomFieldsstring
Udfs of DateTime should use Iso
EnvApi-Udf-DateTime-ReadInUserTzstring
(obsolete) Udfs of DateTime type whould be in ReadInUserTz
EnvApi-Udf-Value-Invariantstring
(optional) Udfs - Force Non-Localized (invariant) values
EnvApi-Localization-Allstring
(optional) Extend objects with User-given Localizations
x-client-request-idstring
(optional) Client ID for double submit prevention
Request body
Response
not available
Changes
No recorded changes to this operation across all 1 revision of this API.