api-uk.vfp.viewpoint.com
Open in
urlscan Pro
2606:4700::6812:1704
Public Scan
Submitted URL: https://api-uk.vfp.viewpoint.com/
Effective URL: https://api-uk.vfp.viewpoint.com/swagger/ui/index
Submission: On June 07 via api from US — Scanned from DE
Effective URL: https://api-uk.vfp.viewpoint.com/swagger/ui/index
Submission: On June 07 via api from US — Scanned from DE
Form analysis 153 forms found in the DOM
<form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdiscussionfolderCreate0.4039634155932559">discussionfolderCreate</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="discussionfolderCreate" id="mdiscussionfolderCreate0.4039634155932559"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.569155675311753" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.569155675311753">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Discussion Folder create model</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DiscussionFolder {</span>
<div><span class="propName required">ParentId</span> (<span class="propType">string</span>),</div>
<div><span class="propName required">Name</span> (<span class="propType">string</span>),</div>
<div><span class="propName ">Description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DropBoxEmailEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DropBoxEmailLocalPart</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">InternalRecipients</span> (<span class="propType">Array[InternalRecipient ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Private</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">DaysFrom</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Min. Value:</td>
<td>1</td>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>99999</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName ">DueDateIsEditable</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">EmailRemindersOn</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">DaysBeforeDueDate</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>99999</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName ">OverdueRemindersEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">OverdueReminderRepeatFrequency</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['DAILY', 'WEEKLY',
'MONTHLY']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"DAILY", "WEEKLY", "MONTHLY"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">EmailReminderRepeatFrequencyOccurrences</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>99999</td>
</tr>
</tbody>
</table></span></div><span class="strong">}</span><br><span class="strong">InternalRecipient {</span>
<div><span class="propName required">ProfileId</span> (<span class="propType">string</span>),</div>
<div><span class="propWrap"><span class="propName required">Type</span> (<span class="propType">string</span>) = <span class="propVals">['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP', 'SECURITYGROUP']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">{
"<span class="hljs-attr">ParentId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Name</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">Description</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">DropBoxEmailEnabled</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">DropBoxEmailLocalPart</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">InternalRecipients</span>": [
{
"<span class="hljs-attr">ProfileId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Type</span>": <span class="hljs-string">"UNDEFINED"</span>
}
],
"<span class="hljs-attr">Private</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">DaysFrom</span>": <span class="hljs-number">0</span>,
"<span class="hljs-attr">DueDateIsEditable</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">EmailRemindersOn</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">DaysBeforeDueDate</span>": <span class="hljs-number">0</span>,
"<span class="hljs-attr">OverdueRemindersEnabled</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">OverdueReminderRepeatFrequency</span>": <span class="hljs-string">"DAILY"</span>,
"<span class="hljs-attr">EmailReminderRepeatFrequencyOccurrences</span>": <span class="hljs-number">0</span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Discussion Folder model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The parent entity cannot be found or the user is forbidden access to the parent entity.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>A Discussion Folder matching the supplied Discussion Folder already exists in the parent entity or the drop box email address is already in use.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>The supplied Discussion Folder model contains invalid items.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdiscussionfolderid0.6304927907925979">discussionfolderid</label></td>
<td>
<input class="parameter required" minlength="1" name="discussionfolderid" placeholder="(required)" id="mdiscussionfolderid0.6304927907925979" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Discussion Folder</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mdiscussionfolderUpdate0.5423685917997376">discussionfolderUpdate</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="discussionfolderUpdate" id="mdiscussionfolderUpdate0.5423685917997376"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.09016563948321177" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.09016563948321177">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The update information of the new Discussion Folder</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DiscussionFolder {</span>
<div><span class="propName ">Name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DropBoxEmailEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DropBoxEmailLocalPart</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Private</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">DaysFrom</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Min. Value:</td>
<td>1</td>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>99999</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName ">DueDateIsEditable</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">EmailRemindersOn</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">DaysBeforeDueDate</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>99999</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName ">OverdueRemindersEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">OverdueReminderRepeatFrequency</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['DAILY', 'WEEKLY',
'MONTHLY']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"DAILY", "WEEKLY", "MONTHLY"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">EmailReminderRepeatFrequencyOccurrences</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>99999</td>
</tr>
</tbody>
</table></span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">{
"<span class="hljs-attr">Name</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">Description</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">DropBoxEmailEnabled</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">DropBoxEmailLocalPart</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">Private</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">DaysFrom</span>": <span class="hljs-number">0</span>,
"<span class="hljs-attr">DueDateIsEditable</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">EmailRemindersOn</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">DaysBeforeDueDate</span>": <span class="hljs-number">0</span>,
"<span class="hljs-attr">OverdueRemindersEnabled</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">OverdueReminderRepeatFrequency</span>": <span class="hljs-string">"DAILY"</span>,
"<span class="hljs-attr">EmailReminderRepeatFrequencyOccurrences</span>": <span class="hljs-number">0</span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.15165385376750584">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.15165385376750584" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Discussion Folder ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Discussion Folder cannot be found or the user is forbidden access to this Discussion Folder.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>A Discussion Folder matching the supplied Discussion Folder already exists in the parent entity or the drop box email address is already in use.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and use the value of the returned ETag header as
the value of the If-Match header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>The supplied Discussion Folder update model contains invalid items.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdiscussionFolderId0.01598122962885462">discussionFolderId</label></td>
<td>
<input class="parameter required" minlength="1" name="discussionFolderId" placeholder="(required)" id="mdiscussionFolderId0.01598122962885462" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Discussion Folder</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Discussion folder removed successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied DiscussionFolder ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Discussion Folder cannot be found, or the user is forbidden access to this Discussion Folder.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdiscussionFolderId0.22952144903264737">discussionFolderId</label></td>
<td>
<input class="parameter required" minlength="1" name="discussionFolderId" placeholder="(required)" id="mdiscussionFolderId0.22952144903264737" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Discussion Folder</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Discussion Folder ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Discussion Folder cannot be found or the user is forbidden access to this Discussion Folder.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdiscussionFolderId0.5164285810329017">discussionFolderId</label></td>
<td>
<input class="parameter required" minlength="1" name="discussionFolderId" placeholder="(required)" id="mdiscussionFolderId0.5164285810329017" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the DiscussionFolder</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied DiscussionFolder ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The DiscussionFolder cannot be found or the user is forbidden access to this DiscussionFolder.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdiscussionFolderId0.8486207988837038">discussionFolderId</label></td>
<td>
<input class="parameter required" minlength="1" name="discussionFolderId" placeholder="(required)" id="mdiscussionFolderId0.8486207988837038" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Discussion Folder</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrecipients0.48315486485368475">recipients</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="recipients" id="mrecipients0.48315486485368475"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.49424509890407675" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.49424509890407675">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>A collection of recipient models</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">InternalRecipient {</span>
<div><span class="propName required">ProfileId</span> (<span class="propType">string</span>),</div>
<div><span class="propWrap"><span class="propName required">Type</span> (<span class="propType">string</span>) = <span class="propVals">['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP', 'SECURITYGROUP']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">ProfileId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Type</span>": <span class="hljs-string">"UNDEFINED"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.9040683369527616">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.9040683369527616" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Discussion Folder ID or recipients model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The discussion folder cannot be found or the user lacks permissions.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Supplied Recipients are invalid</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdiscussionFolderId0.3600979379695366">discussionFolderId</label></td>
<td>
<input class="parameter required" minlength="1" name="discussionFolderId" placeholder="(required)" id="mdiscussionFolderId0.3600979379695366" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Discussion Folder</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrecipientIds0.06039203945866234">recipientIds</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="recipientIds" id="mrecipientIds0.06039203945866234"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.09559051757085202" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.09559051757085202">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>A collection of unique identifiers of the Recipients to remove</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">InternalRecipient {</span>
<div><span class="propName required">ProfileId</span> (<span class="propType">string</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">ProfileId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.7049680517330208">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.7049680517330208" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Recipients removed successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Discussion Folder ID or Recipient IDs are invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The discussion folder could not be found or the user lacks permissions.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Supplied Recipients are invalid</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdiscussionFolderId0.21293646161691804">discussionFolderId</label></td>
<td>
<input class="parameter required" minlength="1" name="discussionFolderId" placeholder="(required)" id="mdiscussionFolderId0.21293646161691804" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Discussion Folder</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Discussion Folder ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Discussion Folder cannot be found or the user is forbidden access to this Discussion Folder.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdiscussionCreate0.12472635012494382">discussionCreate</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="discussionCreate" id="mdiscussionCreate0.12472635012494382"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.4545074527942934" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.4545074527942934">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Discussion create model</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">Discussion {</span>
<div><span class="propName ">ParentId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName required">Name</span> (<span class="propType">string</span>),</div>
<div><span class="propWrap"><span class="propName required">Priority</span> (<span class="propType">string</span>) = <span class="propVals">['HIGH', 'MEDIUM', 'LOW']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"HIGH", "MEDIUM", "LOW"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">Text</span> (<span class="propType">string</span>),</div>
<div><span class="propName ">Attachments</span> (<span class="propType">Array[Attachment ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">InternalRecipients</span> (<span class="propType">Array[InternalRecipient ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Keywords</span> (<span class="propType">Array[Keyword ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DueDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Private</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">SendEmail</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Attachment {</span>
<div><span class="propWrap"><span class="propName required">EntityType</span> (<span class="propType">string</span>) = <span class="propVals">['UNDEFINED', 'DOCUMENT']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "DOCUMENT"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">EntityId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">InternalRecipient {</span>
<div><span class="propName required">ProfileId</span> (<span class="propType">string</span>),</div>
<div><span class="propWrap"><span class="propName required">Type</span> (<span class="propType">string</span>) = <span class="propVals">['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP', 'SECURITYGROUP']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span><br><span class="strong">Keyword {</span>
<div><span class="propName required">Id</span> (<span class="propType">string</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">{
"<span class="hljs-attr">ParentId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Name</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">Priority</span>": <span class="hljs-string">"HIGH"</span>,
"<span class="hljs-attr">Text</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">Attachments</span>": [
{
"<span class="hljs-attr">EntityType</span>": <span class="hljs-string">"UNDEFINED"</span>,
"<span class="hljs-attr">EntityId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
],
"<span class="hljs-attr">InternalRecipients</span>": [
{
"<span class="hljs-attr">ProfileId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Type</span>": <span class="hljs-string">"UNDEFINED"</span>
}
],
"<span class="hljs-attr">Keywords</span>": [
{
"<span class="hljs-attr">Id</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
],
"<span class="hljs-attr">Description</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">DueDate</span>": <span class="hljs-string">"2024-06-07T11:33:35.886Z"</span>,
"<span class="hljs-attr">Private</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">SendEmail</span>": <span class="hljs-literal">true</span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Discussion model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The parent entity cannot be found or the user is forbidden access to the parent entity.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>A Discussion matching the supplied Discussion already exists in the parent entity</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>The supplied Discussion model contains invalid items.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdiscussionid0.28495016153682196">discussionid</label></td>
<td>
<input class="parameter required" minlength="1" name="discussionid" placeholder="(required)" id="mdiscussionid0.28495016153682196" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Discussion</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Discussion ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Discussion cannot be found or the user is forbidden access to this Discussion.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdiscussionId0.6853385757984578">discussionId</label></td>
<td>
<input class="parameter required" minlength="1" name="discussionId" placeholder="(required)" id="mdiscussionId0.6853385757984578" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Discussion</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Discussion deleted successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Discussion ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Discussion cannot be found or the user does not have permission to access the Discussion.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdiscussionId0.790214363266428">discussionId</label></td>
<td>
<input class="parameter required" minlength="1" name="discussionId" placeholder="(required)" id="mdiscussionId0.790214363266428" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Discussion</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mdiscussionUpdate0.8526699817224623">discussionUpdate</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="discussionUpdate" id="mdiscussionUpdate0.8526699817224623"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9822046811914611" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9822046811914611">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Update Discussion model</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">Discussion {</span>
<div><span class="propName ">Name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Text</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DueDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Private</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">SendEmail</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">State</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['Reopen', 'Close', 'CloseResolve']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"Reopen", "Close", "CloseResolve"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">{
"<span class="hljs-attr">Name</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">Text</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">Description</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">DueDate</span>": <span class="hljs-string">"2024-06-07T11:33:35.898Z"</span>,
"<span class="hljs-attr">Private</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">SendEmail</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">State</span>": <span class="hljs-string">"Reopen"</span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code"><label for="mreason0.5775676606612707">reason</label></td>
<td>
<input class="parameter" minlength="0" name="reason" placeholder="" id="mreason0.5775676606612707" type="text" value="">
</td>
<td class="markdown">
<p>Optional reason</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.13215882353247843">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.13215882353247843" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Discussion model is incorrect.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Discussion cannot be found or the user is forbidden access to this Discussion.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>A Discussion matching the supplied name exists in this parent entity.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>Error related to the If-Match header</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdiscussionId0.11483958567921415">discussionId</label></td>
<td>
<input class="parameter required" minlength="1" name="discussionId" placeholder="(required)" id="mdiscussionId0.11483958567921415" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Discussion</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mattachments0.8581045638761255">attachments</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="attachments" id="mattachments0.8581045638761255"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.3230643872532313" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.3230643872532313">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>A collection of attachments models</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">Attachment {</span>
<div><span class="propWrap"><span class="propName required">EntityType</span> (<span class="propType">string</span>) = <span class="propVals">['UNDEFINED', 'DOCUMENT']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "DOCUMENT"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">EntityId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">EntityType</span>": <span class="hljs-string">"UNDEFINED"</span>,
"<span class="hljs-attr">EntityId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.6170988180139159">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.6170988180139159" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Discussion ID or attachments model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The discussion cannot be found or the user lacks permissions.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>The supplied Attachments model is incorrect.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdiscussionId0.7568417373262617">discussionId</label></td>
<td>
<input class="parameter required" minlength="1" name="discussionId" placeholder="(required)" id="mdiscussionId0.7568417373262617" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Discussion</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mattachmentIds0.4720496878758953">attachmentIds</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="attachmentIds" id="mattachmentIds0.4720496878758953"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.860663036040239" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.860663036040239">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>A collection of unique identifiers of the Attachments to remove</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">Attachment {</span>
<div><span class="propName ">AttachmentId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">AttachmentId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.40903565857033053">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.40903565857033053" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Attachments removed successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Discussion ID or Attachment IDs are invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The discussion could not be found or the user lacks permissions.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Supplied Attachments are invalid</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdiscussionId0.9517049598585434">discussionId</label></td>
<td>
<input class="parameter required" minlength="1" name="discussionId" placeholder="(required)" id="mdiscussionId0.9517049598585434" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Discussion</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mkeywordIds0.1376257850904219">keywordIds</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="keywordIds" id="mkeywordIds0.1376257850904219"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.1350916708789065" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.1350916708789065">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>A collection of keyword models</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">Keyword {</span>
<div><span class="propName required">Id</span> (<span class="propType">string</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">Id</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.015396238477801694">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.015396238477801694" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Discussion ID or keywords model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The discussion cannot be found or the user lacks permissions.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>The supplied Keywords model is incorrect.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdiscussionId0.8276499602395209">discussionId</label></td>
<td>
<input class="parameter required" minlength="1" name="discussionId" placeholder="(required)" id="mdiscussionId0.8276499602395209" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Discussion</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mkeywordIds0.834141844149551">keywordIds</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="keywordIds" id="mkeywordIds0.834141844149551"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.13221478477578574" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.13221478477578574">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>A collection of unique identifiers of the Keywords to remove</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">Keyword {</span>
<div><span class="propName required">Id</span> (<span class="propType">string</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">Id</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.45695668489840635">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.45695668489840635" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Keywords removed successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Discussion ID or Keyword IDs are invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The discussion could not be found or the user lacks permissions.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Supplied keywords are invalid</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdiscussionId0.3993133573895469">discussionId</label></td>
<td>
<input class="parameter required" minlength="1" name="discussionId" placeholder="(required)" id="mdiscussionId0.3993133573895469" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Discussion</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mdiscussionPostCreate0.2153221790195463">discussionPostCreate</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="discussionPostCreate" id="mdiscussionPostCreate0.2153221790195463"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9397105932413736" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9397105932413736">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Discussion Post create model</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DiscussionPost {</span>
<div><span class="propName required">Text</span> (<span class="propType">string</span>),</div>
<div><span class="propName ">InternalRecipients</span> (<span class="propType">Array[InternalRecipient ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Attachments</span> (<span class="propType">Array[Attachment ]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">InternalRecipient {</span>
<div><span class="propName required">ProfileId</span> (<span class="propType">string</span>),</div>
<div><span class="propWrap"><span class="propName required">Type</span> (<span class="propType">string</span>) = <span class="propVals">['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP', 'SECURITYGROUP']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span><br><span class="strong">Attachment {</span>
<div><span class="propWrap"><span class="propName required">EntityType</span> (<span class="propType">string</span>) = <span class="propVals">['UNDEFINED', 'DOCUMENT']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "DOCUMENT"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">EntityId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">{
"<span class="hljs-attr">Text</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">InternalRecipients</span>": [
{
"<span class="hljs-attr">ProfileId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Type</span>": <span class="hljs-string">"UNDEFINED"</span>
}
],
"<span class="hljs-attr">Attachments</span>": [
{
"<span class="hljs-attr">EntityType</span>": <span class="hljs-string">"UNDEFINED"</span>,
"<span class="hljs-attr">EntityId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
]
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.2438904018499608">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.2438904018499608" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Discussion Post model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The parent entity cannot be found or the user is forbidden access to the parent entity.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown"></td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and use the value of the returned ETag header as
the value of the If-Match header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>The supplied Discussion Post model contains invalid items.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdiscussionId0.6625112206880519">discussionId</label></td>
<td>
<input class="parameter required" minlength="1" name="discussionId" placeholder="(required)" id="mdiscussionId0.6625112206880519" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Discussion</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mpostId0.5042748157350347">postId</label></td>
<td>
<input class="parameter required" minlength="1" name="postId" placeholder="(required)" id="mpostId0.5042748157350347" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the current post</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.166552463508016">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.166552463508016" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Current post deleted successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Discussion ID or post ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Discussion or post cannot be found or the user is forbidden access to this Discussion.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdiscussionId0.053219417961331894">discussionId</label></td>
<td>
<input class="parameter required" minlength="1" name="discussionId" placeholder="(required)" id="mdiscussionId0.053219417961331894" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Discussion</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrecipients0.947999655161623">recipients</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="recipients" id="mrecipients0.947999655161623"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5913160924012575" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5913160924012575">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>A collection of recipient models to be added</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">InternalRecipient {</span>
<div><span class="propName required">ProfileId</span> (<span class="propType">string</span>),</div>
<div><span class="propWrap"><span class="propName required">Type</span> (<span class="propType">string</span>) = <span class="propVals">['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP', 'SECURITYGROUP']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">ProfileId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Type</span>": <span class="hljs-string">"UNDEFINED"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.7015332981390707">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.7015332981390707" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Discussion ID or recipients model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Discussion cannot be found or the user lacks permissions.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>The supplied Recipients model is incorrect.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdiscussionId0.6413418484683919">discussionId</label></td>
<td>
<input class="parameter required" minlength="1" name="discussionId" placeholder="(required)" id="mdiscussionId0.6413418484683919" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Discussion</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrecipients0.35012891353318265">recipients</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="recipients" id="mrecipients0.35012891353318265"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9368209240435399" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9368209240435399">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>A collection of recipient models to be removed</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">InternalRecipient {</span>
<div><span class="propName required">ProfileId</span> (<span class="propType">string</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">ProfileId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.32314072772067237">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.32314072772067237" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Recipients removed successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Discussion ID or Recipient IDs are invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Discussion could not be found or the user lacks permissions.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Supplied Recipients are invalid</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentFolderCreate0.302938138949963">documentFolderCreate</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="documentFolderCreate" id="mdocumentFolderCreate0.302938138949963"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6575978176744468" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6575978176744468">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Document Folder create model</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DocumentFolderCreate {</span>
<div><span class="propName ">Description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName required">Name</span> (<span class="propType">string</span>),</div>
<div><span class="propName required">ParentId</span> (<span class="propType">string</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">{
"<span class="hljs-attr">Description</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">Name</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">ParentId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied DocumentFolder model is incorrect.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The parent entity cannot be found or the user is forbidden access to this parent entity.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>An DocumentFolder matching the supplied DocumentFolder already exists in this parent entity.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentFolderId0.11602547786487238">documentFolderId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentFolderId" placeholder="(required)" id="mdocumentFolderId0.11602547786487238" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the DocumentFolder</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>DocumentFolder deleted successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied DocumentFolder ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The document folder cannot be found or the user is forbidden access to this DocumentFolder.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentFolderId0.37581253525144387">documentFolderId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentFolderId" placeholder="(required)" id="mdocumentFolderId0.37581253525144387" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the DocumentFolder</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied DocumentFolder ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The document folder cannot be found or the user is forbidden access to this DocumentFolder.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentFolderId0.860304887385718">documentFolderId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentFolderId" placeholder="(required)" id="mdocumentFolderId0.860304887385718" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the DocumentFolder</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mdocumentFolderUpdate0.8576195255277581">documentFolderUpdate</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="documentFolderUpdate" id="mdocumentFolderUpdate0.8576195255277581"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.046649435787943894" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.046649435787943894">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Document Folder update model</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DocumentFolderUpdate {</span>
<div><span class="propName ">Description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName required">Name</span> (<span class="propType">string</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">{
"<span class="hljs-attr">Description</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">Name</span>": <span class="hljs-string">"string"</span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.2652195187270556">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.2652195187270556" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied DocumentFolder model is incorrect.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The document folder cannot be found or the user is forbidden access to this DocumentFolder.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>A DocumentFolder matching the supplied DocumentFolder already exists.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentFolderId0.8422375207620179">documentFolderId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentFolderId" placeholder="(required)" id="mdocumentFolderId0.8422375207620179" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the DocumentFolder</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied DocumentFolder ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The document folder cannot be found or the user is forbidden access to this DocumentFolder.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentFolderId0.20446865358948974">documentFolderId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentFolderId" placeholder="(required)" id="mdocumentFolderId0.20446865358948974" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the DocumentFolder</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mpage0.9128148171446495">page</label></td>
<td>
<input class="parameter" minlength="0" name="page" placeholder="" id="mpage0.9128148171446495" type="text" value="">
</td>
<td class="markdown">
<p>The current page of the data being displayed. The page index begins at 0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpageSize0.5968415204931576">pageSize</label></td>
<td>
<input class="parameter" minlength="0" name="pageSize" placeholder="" id="mpageSize0.5968415204931576" type="text" value="32767">
</td>
<td class="markdown">
<p>The number of documents displayed per results page. The maximum number of documents which can be displayed in a single page is 3,2767</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mrecursive0.9536691530679828">recursive</label></td>
<td>
<select class="parameter " name="recursive" id="mrecursive0.9536691530679828">
<option value=""></option>
<option value="true"> true </option>
<option selected="" value="false"> false (default) </option>
</select>
</td>
<td class="markdown">
<p>If true, all Documents in the specified folder and all child document folders will be returned.</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code"><label for="msearchId0.8890065429708485">searchId</label></td>
<td>
<input class="parameter" minlength="0" name="searchId" placeholder="" id="msearchId0.8890065429708485" type="text" value="">
</td>
<td class="markdown">
<p>Unique identifier which, if provided, caches the search results resulting in faster paging through the cached search results.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied DocumentFolder Id is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The document folder cannot be found or the user is forbidden access to this DocumentFolder.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocument0.5204950315165127">document</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="document" id="mdocument0.5204950315165127"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7361039125348952" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7361039125348952">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The document create model</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DocumentCreate {</span>
<div><span class="propName ">Description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName required">Name</span> (<span class="propType">string</span>),</div>
<div><span class="propName ">ParentId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">LinkedLocations</span> (<span class="propType">Array[LinkedLocation ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Workflows</span> (<span class="propType">Array[Workflow ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">OwnerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">IsFilePubliclyAvailable</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PublicLinkExpiry</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RevisionAuthorId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Attachments</span> (<span class="propType">Array[Attachment ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AuthoredDateTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">IsNotifyRecipientsByEmail</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ExternalRecipients</span> (<span class="propType">Array[ExternalRecipient ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">InternalRecipients</span> (<span class="propType">Array[InternalRecipient ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Keywords</span> (<span class="propType">Array[Keyword ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Notes</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">IsFilesPrivateToRecipients</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RevisionStatusId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RevisionReference</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RevisionWorkflows</span> (<span class="propType">Array[Workflow ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">PercentageComplete</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>100</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName ">Classifications</span> (<span class="propType">Array[Classification ]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">LinkedLocation
{</span>
<div><span class="propName ">Id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Workflow {</span>
<div><span class="propName ">Id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Attachment {</span>
<div><span class="propWrap"><span class="propName required">EntityType</span> (<span class="propType">string</span>) = <span class="propVals">['UNDEFINED', 'DOCUMENT']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "DOCUMENT"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">EntityId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">ExternalRecipient {</span>
<div><span class="propWrap"><span class="propName ">Name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Min. Length:</td>
<td>1</td>
</tr>
<tr>
<td class="optionName">Max. Length:</td>
<td>122</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName required">Email</span> (<span class="propType">string</span>)</div><span class="strong">}</span><br><span class="strong">InternalRecipient {</span>
<div><span class="propName required">ProfileId</span> (<span class="propType">string</span>),</div>
<div><span class="propWrap"><span class="propName required">Type</span> (<span class="propType">string</span>) = <span class="propVals">['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP', 'SECURITYGROUP']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span><br><span class="strong">Keyword {</span>
<div><span class="propName required">Id</span> (<span class="propType">string</span>)</div><span class="strong">}</span><br><span class="strong">Classification {</span>
<div><span class="propName ">UniclassId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">{
"<span class="hljs-attr">Description</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">Name</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">ParentId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">LinkedLocations</span>": [
{
"<span class="hljs-attr">Id</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
],
"<span class="hljs-attr">Workflows</span>": [
{
"<span class="hljs-attr">Id</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
],
"<span class="hljs-attr">OwnerId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">IsFilePubliclyAvailable</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">PublicLinkExpiry</span>": <span class="hljs-string">"2024-06-07T11:33:35.936Z"</span>,
"<span class="hljs-attr">RevisionAuthorId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Attachments</span>": [
{
"<span class="hljs-attr">EntityType</span>": <span class="hljs-string">"UNDEFINED"</span>,
"<span class="hljs-attr">EntityId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
],
"<span class="hljs-attr">AuthoredDateTime</span>": <span class="hljs-string">"2024-06-07T11:33:35.936Z"</span>,
"<span class="hljs-attr">IsNotifyRecipientsByEmail</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">ExternalRecipients</span>": [
{
"<span class="hljs-attr">Name</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">Email</span>": <span class="hljs-string">"string"</span>
}
],
"<span class="hljs-attr">InternalRecipients</span>": [
{
"<span class="hljs-attr">ProfileId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Type</span>": <span class="hljs-string">"UNDEFINED"</span>
}
],
"<span class="hljs-attr">Keywords</span>": [
{
"<span class="hljs-attr">Id</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
],
"<span class="hljs-attr">Notes</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">IsFilesPrivateToRecipients</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">RevisionStatusId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">RevisionReference</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">RevisionWorkflows</span>": [
{
"<span class="hljs-attr">Id</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
],
"<span class="hljs-attr">PercentageComplete</span>": <span class="hljs-number">0</span>,
"<span class="hljs-attr">Classifications</span>": [
{
"<span class="hljs-attr">UniclassId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Code</span>": <span class="hljs-string">"string"</span>
}
]
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Document model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The document folder cannot be found or the user does not have permission to access the document folder.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>A Document matching the supplied Document already exists.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>The supplied Document model is incorrect.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.6614507206753604">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.6614507206753604" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Document deleted successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Document ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The document cannot be found or the user does not have permission to access the document.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.7751928490672915">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.7751928490672915" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Document ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The document cannot be found or the user does not have permission to access the document.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.4093035102038689">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.4093035102038689" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mdocumentUpdate0.24925014713388927">documentUpdate</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="documentUpdate" id="mdocumentUpdate0.24925014713388927"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.2747669115858753" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.2747669115858753">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The document update model</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DocumentUpdate {</span>
<div><span class="propName ">Description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">OwnerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CurrentRevisionId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RevisionAuthorId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AuthoredDateTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">IsNotifyRecipientsByEmail</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Notes</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">IsFilesPrivateToRecipients</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RevisionStatusId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RevisionReference</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">IsFilePubliclyAvailable</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PublicLinkExpiry</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">PercentageComplete</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>100</td>
</tr>
</tbody>
</table></span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">{
"<span class="hljs-attr">Description</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">Name</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">OwnerId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">CurrentRevisionId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">RevisionAuthorId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">AuthoredDateTime</span>": <span class="hljs-string">"2024-06-07T11:33:35.947Z"</span>,
"<span class="hljs-attr">IsNotifyRecipientsByEmail</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">Notes</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">IsFilesPrivateToRecipients</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">RevisionStatusId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">RevisionReference</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">IsFilePubliclyAvailable</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">PublicLinkExpiry</span>": <span class="hljs-string">"2024-06-07T11:33:35.947Z"</span>,
"<span class="hljs-attr">PercentageComplete</span>": <span class="hljs-number">0</span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.25253405852694">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.25253405852694" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Document ID or Document model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The document cannot be found or the user does not have permission to access the document.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>A Document matching the supplied Document already exists.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and use the value of the returned ETag header as
the value of the If-Match header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.8469116616928833">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.8469116616928833" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Document ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The document cannot be found or the user does not have permission to access the document.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.047034968088275564">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.047034968088275564" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mattachmentId0.2688056093922877">attachmentId</label></td>
<td>
<input class="parameter required" minlength="1" name="attachmentId" placeholder="(required)" id="mattachmentId0.2688056093922877" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Attachment</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Document ID or Attachment ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The document or attachment cannot be found or the user does not have permission to access either.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.955431009883873">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.955431009883873" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mattachments0.6930442291357222">attachments</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="attachments" id="mattachments0.6930442291357222"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.30551706617140817" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.30551706617140817">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The collection of attachments</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">Attachment {</span>
<div><span class="propWrap"><span class="propName required">EntityType</span> (<span class="propType">string</span>) = <span class="propVals">['UNDEFINED', 'DOCUMENT']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "DOCUMENT"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">EntityId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">EntityType</span>": <span class="hljs-string">"UNDEFINED"</span>,
"<span class="hljs-attr">EntityId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.9480073516859222">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.9480073516859222" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Document ID or Attachment model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The document cannot be found or the user does not have permission to access the document.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Error saving updated revision</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.947220141982422">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.947220141982422" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mattachments0.7854380660999329">attachments</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="attachments" id="mattachments0.7854380660999329"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.3343582956931255" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.3343582956931255">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The collection of attachments</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">Attachment {</span>
<div><span class="propName ">AttachmentId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">AttachmentId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.8971744147848988">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.8971744147848988" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Removed attachment(s) from the specified document's current revision successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Document ID or Attachment model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The document or document revision cannot be found or the user is forbidden access to this document.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Error saving updated revision.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.17312112171533633">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.17312112171533633" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mclassifications0.25124308682343766">classifications</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="classifications" id="mclassifications0.25124308682343766"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6797762247517125" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6797762247517125">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>A collection of Classifications</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">Classification {</span>
<div><span class="propName ">UniclassId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">UniclassId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Code</span>": <span class="hljs-string">"string"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.1788086609789694">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.1788086609789694" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Document ID or classifications model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The document or revision cannot be found or the user does not have permission to access either.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>The supplied Classification(s) is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.9207829672391326">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.9207829672391326" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mclassifications0.9681779999673248">classifications</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="classifications" id="mclassifications0.9681779999673248"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5666945939355736" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5666945939355736">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>A collection of Classifications to be removed</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">Classification {</span>
<div><span class="propName ">UniclassId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">UniclassId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Code</span>": <span class="hljs-string">"string"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.08584012690412557">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.08584012690412557" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Classifications removed successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Document ID or Classification IDs are invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The document or classifications could not be found or the user is forbidden access to this document.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Supplied classifications are invalid</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.04156078734529989">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.04156078734529989" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Document ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The document cannot be found or the user does not have permission to access the document.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.36600775403509767">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.36600775403509767" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mexternalRecipients0.9379256469422681">externalRecipients</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="externalRecipients" id="mexternalRecipients0.9379256469422681"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.47346850548443564" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.47346850548443564">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The external recipients model</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">ExternalRecipient {</span>
<div><span class="propWrap"><span class="propName ">Name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Min. Length:</td>
<td>1</td>
</tr>
<tr>
<td class="optionName">Max. Length:</td>
<td>122</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName required">Email</span> (<span class="propType">string</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">Name</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">Email</span>": <span class="hljs-string">"string"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.05553526016789889">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.05553526016789889" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Document ID or Recipient model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The document cannot be found or the user does not have permission to access the document.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.019652464366191058">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.019652464366191058" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mexternalRecipients0.9474581690886255">externalRecipients</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="externalRecipients" id="mexternalRecipients0.9474581690886255"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.00404145255641386" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.00404145255641386">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The collection of external recipient email addresses</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">ExternalRecipient {</span>
<div><span class="propName required">Email</span> (<span class="propType">string</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">Email</span>": <span class="hljs-string">"string"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.5193865855449014">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.5193865855449014" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>External recipients removed from current revision successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Document ID or Recipient model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The document cannot be found or the user does not have permission to access the document.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>The supplied External recipients are invalid</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.22769003469625781">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.22769003469625781" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mfileUpload0.4055775390524967">fileUpload</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="fileUpload" id="mfileUpload0.4055775390524967"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.16808079756971916" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.16808079756971916">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The file upload model. The FileName property must include the file extension.</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">FileUpload {</span>
<div><span class="propWrap"><span class="propName required">FileName</span> (<span class="propType">string</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Max. Length:</td>
<td>256</td>
</tr>
</tbody>
</table></span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">{
"<span class="hljs-attr">FileName</span>": <span class="hljs-string">"string"</span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.6969830983906016">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.6969830983906016" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Document ID or file model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The document cannot be found or the user does not have permission to access the document.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.8435930797267652">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.8435930797267652" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mfileId0.24551436903391322">fileId</label></td>
<td>
<input class="parameter required" minlength="1" name="fileId" placeholder="(required)" id="mfileId0.24551436903391322" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the File</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.6080268355840865">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.6080268355840865" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>File removed successfully from revision in Document.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Document ID or File ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The document or file cannot be found, or the user does not have permission to access either.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.898038118958143">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.898038118958143" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mfileId0.01502444737018016">fileId</label></td>
<td>
<input class="parameter required" minlength="1" name="fileId" placeholder="(required)" id="mfileId0.01502444737018016" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the File</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mfileUpdate0.3165528610217596">fileUpdate</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="fileUpdate" id="mfileUpdate0.3165528610217596"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.12735569455159212" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.12735569455159212">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The file update model</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">FileUpdate {</span>
<div><span class="propName ">IsPrimary</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">{
"<span class="hljs-attr">IsPrimary</span>": <span class="hljs-literal">true</span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.6511080075229156">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.6511080075229156" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Document ID, Revision ID, File ID or file Update model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The document, revision or file cannot be found or the user does not have permission to access the document, revision or file.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>A file matching the supplied Document already exists.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.9661364125023442">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.9661364125023442" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mkeywordIds0.6859483834157611">keywordIds</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="keywordIds" id="mkeywordIds0.6859483834157611"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6995027496157347" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6995027496157347">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>A collection of keyword models</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">Keyword {</span>
<div><span class="propName required">Id</span> (<span class="propType">string</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">Id</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.45078175511784635">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.45078175511784635" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Document ID or keywords model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The document or revision cannot be found or the user does not have permission to access either.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>The supplied Keywords model is incorrect.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.2070218484346642">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.2070218484346642" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mkeywordIds0.8178882007629631">keywordIds</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="keywordIds" id="mkeywordIds0.8178882007629631"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.35504078078377277" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.35504078078377277">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>A collection of unique identifiers of the Keywords to remove</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">Keyword {</span>
<div><span class="propName required">Id</span> (<span class="propType">string</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">Id</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.9582819337144879">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.9582819337144879" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Keywords removed successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Document ID or Keyword IDs are invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The document or keywords could not be found or the user is forbidden access to this document.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Supplied keywords are invalid</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.6991122351652572">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.6991122351652572" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Document ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The document cannot be found or the user is forbidden access the document.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.9041994566352158">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.9041994566352158" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mlinkedLocationId0.35380746610291336">linkedLocationId</label></td>
<td>
<input class="parameter required" minlength="1" name="linkedLocationId" placeholder="(required)" id="mlinkedLocationId0.35380746610291336" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Location</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Document ID or linked location ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The document or linked location cannot be found or the user is forbidden access to either.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.4636299563935993">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.4636299563935993" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mlinkedLocations0.8413057684132563">linkedLocations</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="linkedLocations" id="mlinkedLocations0.8413057684132563"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.1905807307256846" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.1905807307256846">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>A collection of Document Folders unique identifiers to link the Document to</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">LinkedLocation {</span>
<div><span class="propName ">Id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">Id</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.871699240382293">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.871699240382293" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Document ID or linked location model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The document cannot be found or the user does not have permission to access the document.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>The supplied Linked Location is invalid</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.5958478194474355">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.5958478194474355" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mlinkedLocationIds0.25022592853282144">linkedLocationIds</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="linkedLocationIds" id="mlinkedLocationIds0.25022592853282144"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.05477269708526733" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.05477269708526733">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>A collection of unique identifiers of the Linked locations</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">LinkedLocation {</span>
<div><span class="propName ">LinkedLocationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">LinkedLocationId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.22188227939155603">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.22188227939155603" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Linked Locations removed successfully from Document.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Document ID or linked location ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The document cannot be found or the user does not have permission to access the document.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>The supplied Linked Location is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.8867767314845609">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.8867767314845609" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="minternalRecipients0.7878801481579707">internalRecipients</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="internalRecipients" id="minternalRecipients0.7878801481579707"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9201194934137393" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9201194934137393">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>A collection of internal recipients</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">InternalRecipient {</span>
<div><span class="propName required">ProfileId</span> (<span class="propType">string</span>),</div>
<div><span class="propWrap"><span class="propName required">Type</span> (<span class="propType">string</span>) = <span class="propVals">['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP', 'SECURITYGROUP']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">ProfileId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Type</span>": <span class="hljs-string">"UNDEFINED"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.4248671899449168">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.4248671899449168" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Document ID is invalid or supplied Internal recipient model is incorrect.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The document or revision cannot be found or the user is forbidden access to this document.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>The supplied Internal recipient is invalid</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.3097538877789152">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.3097538877789152" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="minternalRecipients0.1278493290763083">internalRecipients</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="internalRecipients" id="minternalRecipients0.1278493290763083"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9885492724220193" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9885492724220193">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>A collection of internal recipients</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">InternalRecipient {</span>
<div><span class="propName required">ProfileId</span> (<span class="propType">string</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">ProfileId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.5862610692828489">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.5862610692828489" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Internal recipients removed from current revision successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Document ID is invalid or supplied Internal recipient model is incorrect.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The revision cannot be found or the user is forbidden access to this document.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>The supplied Internal recipient is invalid</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.9400416354555703">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.9400416354555703" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Document ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The document cannot be found or the user does not have permission to access the document.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.11587765228439251">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.11587765228439251" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrevisionCreate0.39736136926297316">revisionCreate</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="revisionCreate" id="mrevisionCreate0.39736136926297316"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.17868708947693324" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.17868708947693324">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Revision create model</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">RevisionCreate {</span>
<div><span class="propName ">RevisionAuthorId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Attachments</span> (<span class="propType">Array[Attachment ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AuthoredDateTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">IsNotifyRecipientsByEmail</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ExternalRecipients</span> (<span class="propType">Array[ExternalRecipient ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">InternalRecipients</span> (<span class="propType">Array[InternalRecipient ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Keywords</span> (<span class="propType">Array[Keyword ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Notes</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">IsFilesPrivateToRecipients</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RevisionStatusId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RevisionReference</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RevisionWorkflows</span> (<span class="propType">Array[Workflow ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">PercentageComplete</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>100</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName ">Classifications</span> (<span class="propType">Array[Classification ]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Attachment {</span>
<div><span class="propWrap"><span class="propName required">EntityType</span> (<span class="propType">string</span>) = <span class="propVals">['UNDEFINED', 'DOCUMENT']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "DOCUMENT"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">EntityId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">ExternalRecipient {</span>
<div><span class="propWrap"><span class="propName ">Name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Min. Length:</td>
<td>1</td>
</tr>
<tr>
<td class="optionName">Max. Length:</td>
<td>122</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName required">Email</span> (<span class="propType">string</span>)</div><span class="strong">}</span><br><span class="strong">InternalRecipient {</span>
<div><span class="propName required">ProfileId</span> (<span class="propType">string</span>),</div>
<div><span class="propWrap"><span class="propName required">Type</span> (<span class="propType">string</span>) = <span class="propVals">['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP', 'SECURITYGROUP']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span><br><span class="strong">Keyword {</span>
<div><span class="propName required">Id</span> (<span class="propType">string</span>)</div><span class="strong">}</span><br><span class="strong">Workflow {</span>
<div><span class="propName ">Id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Classification {</span>
<div><span class="propName ">UniclassId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">{
"<span class="hljs-attr">RevisionAuthorId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Attachments</span>": [
{
"<span class="hljs-attr">EntityType</span>": <span class="hljs-string">"UNDEFINED"</span>,
"<span class="hljs-attr">EntityId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
],
"<span class="hljs-attr">AuthoredDateTime</span>": <span class="hljs-string">"2024-06-07T11:33:35.991Z"</span>,
"<span class="hljs-attr">IsNotifyRecipientsByEmail</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">ExternalRecipients</span>": [
{
"<span class="hljs-attr">Name</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">Email</span>": <span class="hljs-string">"string"</span>
}
],
"<span class="hljs-attr">InternalRecipients</span>": [
{
"<span class="hljs-attr">ProfileId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Type</span>": <span class="hljs-string">"UNDEFINED"</span>
}
],
"<span class="hljs-attr">Keywords</span>": [
{
"<span class="hljs-attr">Id</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
],
"<span class="hljs-attr">Notes</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">IsFilesPrivateToRecipients</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">RevisionStatusId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">RevisionReference</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">RevisionWorkflows</span>": [
{
"<span class="hljs-attr">Id</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
],
"<span class="hljs-attr">PercentageComplete</span>": <span class="hljs-number">0</span>,
"<span class="hljs-attr">Classifications</span>": [
{
"<span class="hljs-attr">UniclassId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Code</span>": <span class="hljs-string">"string"</span>
}
]
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.27926815276655104">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.27926815276655104" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Document ID or revision ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The document cannot be found or the user does not have permission to access the document.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>A Revision matching the supplied Revision already exists.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown"></td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.9354957214335713">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.9354957214335713" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrevisionId0.21071821956395898">revisionId</label></td>
<td>
<input class="parameter required" minlength="1" name="revisionId" placeholder="(required)" id="mrevisionId0.21071821956395898" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the current revision</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.9835279793209377">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.9835279793209377" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Current revision deleted successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Document ID or Revision ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The document or revision cannot be found or the user is forbidden access to this document.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.27671723563254647">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.27671723563254647" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrevisionId0.12998837751031278">revisionId</label></td>
<td>
<input class="parameter required" minlength="1" name="revisionId" placeholder="(required)" id="mrevisionId0.12998837751031278" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Revision</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Document ID or revision ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The document or revision cannot be found or the user does not have permission to access either.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.8594657210061749">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.8594657210061749" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrevisionId0.3057509936891101">revisionId</label></td>
<td>
<input class="parameter required" minlength="1" name="revisionId" placeholder="(required)" id="mrevisionId0.3057509936891101" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document Revision</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Document ID or revision ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The document or document revision cannot be found or the user is forbidden access to this document.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.5500433862403538">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.5500433862403538" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrevisionId0.20182491214174525">revisionId</label></td>
<td>
<input class="parameter required" minlength="1" name="revisionId" placeholder="(required)" id="mrevisionId0.20182491214174525" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document Revision</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mfileId0.17647588366053313">fileId</label></td>
<td>
<input class="parameter required" minlength="1" name="fileId" placeholder="(required)" id="mfileId0.17647588366053313" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the File</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Document ID, Revision ID or file ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The document or document revision or file cannot be found or the user is forbidden access to this document.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.9670630803785631">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.9670630803785631" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrevisionId0.9395112178128833">revisionId</label></td>
<td>
<input class="parameter required" minlength="1" name="revisionId" placeholder="(required)" id="mrevisionId0.9395112178128833" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document Revision</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mfileId0.9809264676219598">fileId</label></td>
<td>
<input class="parameter required" minlength="1" name="fileId" placeholder="(required)" id="mfileId0.9809264676219598" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the File</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Document ID, Revision ID or File ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Document or Document Revision or File cannot be found or the user is forbidden access to this Document.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.6985087663385878">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.6985087663385878" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mworkflow0.8182237055008128">workflow</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="workflow" id="mworkflow0.8182237055008128"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.04310122976661224" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.04310122976661224">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>DocumentRevision Workflow Id</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">Workflow {</span>
<div><span class="propName ">Id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">{
"<span class="hljs-attr">Id</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.30443532372124604">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.30443532372124604" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Document cannot be found or the user is forbidden access to this Document.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Supplied workflow(s) are invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.22615798442277102">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.22615798442277102" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mworkflows0.929339350943271">workflows</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="workflows" id="mworkflows0.929339350943271"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.13260979740942203" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.13260979740942203">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>A collection of DocumentRevision workflow Ids</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">Workflow {</span>
<div><span class="propName ">Id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">Id</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.1974300139431462">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.1974300139431462" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Removed workflow(s) from the specified Documents current revision successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Document ID or Workflow model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Document cannot be found or the user is forbidden access to this Document.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Error saving updated Document.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.9189192542876183">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.9189192542876183" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mworkflow0.7551693676309024">workflow</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="workflow" id="mworkflow0.7551693676309024"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.985731465311892" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.985731465311892">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Document Workflow Id</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">Workflow {</span>
<div><span class="propName ">Id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">{
"<span class="hljs-attr">Id</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.5941924625490447">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.5941924625490447" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Document cannot be found or the user is forbidden access to this Document.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Supplied workflow is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.1118962420618066">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.1118962420618066" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mworkflows0.4655470028869897">workflows</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="workflows" id="mworkflows0.4655470028869897"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.14805166857145458" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.14805166857145458">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>A collection of workflow ids</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">Workflow {</span>
<div><span class="propName ">Id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">Id</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.4508724369314432">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.4508724369314432" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Removed workflow(s) from the specified Document successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Document ID or Workflow model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Document cannot be found or the user is forbidden access to this Document.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Error saving updated Document.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.258283920454103">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.258283920454103" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrevisionCreate0.41160460604342175">revisionCreate</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="revisionCreate" id="mrevisionCreate0.41160460604342175"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.03097784012000271" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.03097784012000271">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Revision create model</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">RevisionCreateV2 {</span>
<div><span class="propName ">IsFilePubliclyAvailable</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PublicLinkExpiry</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RevisionAuthorId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Attachments</span> (<span class="propType">Array[Attachment ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AuthoredDateTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">IsNotifyRecipientsByEmail</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ExternalRecipients</span> (<span class="propType">Array[ExternalRecipient ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">InternalRecipients</span> (<span class="propType">Array[InternalRecipient ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Keywords</span> (<span class="propType">Array[Keyword ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Notes</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">IsFilesPrivateToRecipients</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RevisionStatusId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RevisionReference</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RevisionWorkflows</span> (<span class="propType">Array[Workflow ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">PercentageComplete</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>100</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName ">Classifications</span> (<span class="propType">Array[Classification ]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Attachment {</span>
<div><span class="propWrap"><span class="propName required">EntityType</span> (<span class="propType">string</span>) = <span class="propVals">['UNDEFINED', 'DOCUMENT']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "DOCUMENT"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">EntityId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">ExternalRecipient {</span>
<div><span class="propWrap"><span class="propName ">Name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Min. Length:</td>
<td>1</td>
</tr>
<tr>
<td class="optionName">Max. Length:</td>
<td>122</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName required">Email</span> (<span class="propType">string</span>)</div><span class="strong">}</span><br><span class="strong">InternalRecipient {</span>
<div><span class="propName required">ProfileId</span> (<span class="propType">string</span>),</div>
<div><span class="propWrap"><span class="propName required">Type</span> (<span class="propType">string</span>) = <span class="propVals">['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP', 'SECURITYGROUP']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span><br><span class="strong">Keyword {</span>
<div><span class="propName required">Id</span> (<span class="propType">string</span>)</div><span class="strong">}</span><br><span class="strong">Workflow {</span>
<div><span class="propName ">Id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Classification {</span>
<div><span class="propName ">UniclassId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">{
"<span class="hljs-attr">IsFilePubliclyAvailable</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">PublicLinkExpiry</span>": <span class="hljs-string">"2024-06-07T11:33:36.010Z"</span>,
"<span class="hljs-attr">RevisionAuthorId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Attachments</span>": [
{
"<span class="hljs-attr">EntityType</span>": <span class="hljs-string">"UNDEFINED"</span>,
"<span class="hljs-attr">EntityId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
],
"<span class="hljs-attr">AuthoredDateTime</span>": <span class="hljs-string">"2024-06-07T11:33:36.010Z"</span>,
"<span class="hljs-attr">IsNotifyRecipientsByEmail</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">ExternalRecipients</span>": [
{
"<span class="hljs-attr">Name</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">Email</span>": <span class="hljs-string">"string"</span>
}
],
"<span class="hljs-attr">InternalRecipients</span>": [
{
"<span class="hljs-attr">ProfileId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Type</span>": <span class="hljs-string">"UNDEFINED"</span>
}
],
"<span class="hljs-attr">Keywords</span>": [
{
"<span class="hljs-attr">Id</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
],
"<span class="hljs-attr">Notes</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">IsFilesPrivateToRecipients</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">RevisionStatusId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">RevisionReference</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">RevisionWorkflows</span>": [
{
"<span class="hljs-attr">Id</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
],
"<span class="hljs-attr">PercentageComplete</span>": <span class="hljs-number">0</span>,
"<span class="hljs-attr">Classifications</span>": [
{
"<span class="hljs-attr">UniclassId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Code</span>": <span class="hljs-string">"string"</span>
}
]
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.8820398522032689">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.8820398522032689" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Document ID or revision ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The document cannot be found or the user does not have permission to access the document.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>A Revision matching the supplied Revision already exists.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>The supplied Revision model contains invalid items.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdvcCreate0.6349321896984141">dvcCreate</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="dvcCreate" id="mdvcCreate0.6349321896984141"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6760249770085007" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6760249770085007">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>DVC create model</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DVCCreate {</span>
<div><span class="propName ">ParentId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName required">Name</span> (<span class="propType">string</span>),</div>
<div><span class="propName ">OwnerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Attachments</span> (<span class="propType">Array[Attachment ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AllRevisionsPublic</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Classifications</span> (<span class="propType">Array[Classification ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DirectAccess</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AllowMarkups</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">IsPublic</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">EnforceWorkflow</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ExpiryDateTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Comment</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Attachment {</span>
<div><span class="propWrap"><span class="propName required">EntityType</span> (<span class="propType">string</span>) = <span class="propVals">['UNDEFINED', 'DOCUMENT']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "DOCUMENT"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">EntityId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Classification {</span>
<div><span class="propName ">UniclassId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">{
"<span class="hljs-attr">ParentId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Name</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">OwnerId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Attachments</span>": [
{
"<span class="hljs-attr">EntityType</span>": <span class="hljs-string">"UNDEFINED"</span>,
"<span class="hljs-attr">EntityId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
],
"<span class="hljs-attr">AllRevisionsPublic</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">Classifications</span>": [
{
"<span class="hljs-attr">UniclassId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Code</span>": <span class="hljs-string">"string"</span>
}
],
"<span class="hljs-attr">Description</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">DirectAccess</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">AllowMarkups</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">IsPublic</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">EnforceWorkflow</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">ExpiryDateTime</span>": <span class="hljs-string">"2024-06-07T11:33:36.015Z"</span>,
"<span class="hljs-attr">Comment</span>": <span class="hljs-string">"string"</span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Dynamic Virtual Container model is incorrect.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The parent entity cannot be found or the user is forbidden access to this parent entity or the parent type id invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>A Dynamic Virtual Container matching the supplied name exists in this parent entity.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Supplied Attachment(s) are invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdvcId0.7248688259922214">dvcId</label></td>
<td>
<input class="parameter required" minlength="1" name="dvcId" placeholder="(required)" id="mdvcId0.7248688259922214" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the DVC</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>DVC deleted successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied DVC ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The DVC cannot be found or the user does not have permission to access the entity.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdvcId0.3928471082474363">dvcId</label></td>
<td>
<input class="parameter required" minlength="1" name="dvcId" placeholder="(required)" id="mdvcId0.3928471082474363" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the DVC</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied DVC ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The DVC cannot be found or the user is forbidden access to this DVC.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdvcId0.2222335103070352">dvcId</label></td>
<td>
<input class="parameter required" minlength="1" name="dvcId" placeholder="(required)" id="mdvcId0.2222335103070352" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the DVC</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mdvcUpdate0.19204103957684415">dvcUpdate</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="dvcUpdate" id="mdvcUpdate0.19204103957684415"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.07702114220512657" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.07702114220512657">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Update DVC model</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DVCUpdate {</span>
<div><span class="propName ">Name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">OwnerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Attachments</span> (<span class="propType">Array[Attachment ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AllRevisionsPublic</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Classifications</span> (<span class="propType">Array[Classification ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DirectAccess</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AllowMarkups</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">IsPublic</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">EnforceWorkflow</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ExpiryDateTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Comment</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Attachment {</span>
<div><span class="propWrap"><span class="propName required">EntityType</span> (<span class="propType">string</span>) = <span class="propVals">['UNDEFINED', 'DOCUMENT']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "DOCUMENT"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">EntityId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Classification {</span>
<div><span class="propName ">UniclassId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">{
"<span class="hljs-attr">Name</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">OwnerId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Attachments</span>": [
{
"<span class="hljs-attr">EntityType</span>": <span class="hljs-string">"UNDEFINED"</span>,
"<span class="hljs-attr">EntityId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
],
"<span class="hljs-attr">AllRevisionsPublic</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">Classifications</span>": [
{
"<span class="hljs-attr">UniclassId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Code</span>": <span class="hljs-string">"string"</span>
}
],
"<span class="hljs-attr">Description</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">DirectAccess</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">AllowMarkups</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">IsPublic</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">EnforceWorkflow</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">ExpiryDateTime</span>": <span class="hljs-string">"2024-06-07T11:33:36.020Z"</span>,
"<span class="hljs-attr">Comment</span>": <span class="hljs-string">"string"</span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.06357898695675224">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.06357898695675224" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Dynamic Virtual Container model is incorrect.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Dynamic Virtual Container cannot be found or the user is forbidden access to this Dynamic Virtual Container.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>A Dynamic Virtual Container matching the supplied name exists in this parent entity.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and use the value of the returned ETag header as
the value of the If-Match header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdvcid0.5371337654218942">dvcid</label></td>
<td>
<input class="parameter required" minlength="1" name="dvcid" placeholder="(required)" id="mdvcid0.5371337654218942" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the DVC</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mattachments0.7911323969296866">attachments</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="attachments" id="mattachments0.7911323969296866"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.26929095422160776" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.26929095422160776">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Collection of attachments (documents)</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">Attachment {</span>
<div><span class="propWrap"><span class="propName required">EntityType</span> (<span class="propType">string</span>) = <span class="propVals">['UNDEFINED', 'DOCUMENT']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "DOCUMENT"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">EntityId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">EntityType</span>": <span class="hljs-string">"UNDEFINED"</span>,
"<span class="hljs-attr">EntityId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.7662427771717555">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.7662427771717555" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The parent entity cannot be found or the user is forbidden access to this parent entity or the parent type id invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and use the value of the returned ETag header as
the value of the If-Match header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Supplied attachment(s) are invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdvcId0.8160613699471908">dvcId</label></td>
<td>
<input class="parameter required" minlength="1" name="dvcId" placeholder="(required)" id="mdvcId0.8160613699471908" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the DVC</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mattachments0.38351700039468883">attachments</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="attachments" id="mattachments0.38351700039468883"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.0576466439434804" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.0576466439434804">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Collection of attachments</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">Attachment {</span>
<div><span class="propName ">AttachmentId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">AttachmentId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.17766848280073533">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.17766848280073533" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Removed attachment(s) from the specified DVC successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied DVC ID or Attachment model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The DVC cannot be found or the user is forbidden access to this DVC.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and use the value of the returned ETag header as
the value of the If-Match header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Supplied Attachment(s) are invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdvcId0.9727455724088219">dvcId</label></td>
<td>
<input class="parameter required" minlength="1" name="dvcId" placeholder="(required)" id="mdvcId0.9727455724088219" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the DVC</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mclassifications0.36880606798993254">classifications</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="classifications" id="mclassifications0.36880606798993254"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.2197807175337434" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.2197807175337434">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The classifications model</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">Classification {</span>
<div><span class="propName ">UniclassId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">UniclassId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Code</span>": <span class="hljs-string">"string"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.23760597173908704">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.23760597173908704" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied DVC ID or classifications model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The DVC cannot be found or the user does not have permission to access the DVC.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>Etag precondition failed</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>The supplied Classification(s) is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdvcId0.8522813553654391">dvcId</label></td>
<td>
<input class="parameter required" minlength="1" name="dvcId" placeholder="(required)" id="mdvcId0.8522813553654391" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mclassifications0.1000114652661146">classifications</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="classifications" id="mclassifications0.1000114652661146"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6351937665439469" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6351937665439469">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The unique identifiers of the Classifications to remove</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">Classification {</span>
<div><span class="propName ">UniclassId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">UniclassId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Code</span>": <span class="hljs-string">"string"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.9029149246114647">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.9029149246114647" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Classifications removed successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied DVC ID or classifications model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The DVC cannot be found or the user does not have permission to access the DVC.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>Etag precondition failed</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>The supplied Classification(s) is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="menterpriseId0.35393963559903896">enterpriseId</label></td>
<td>
<input class="parameter required" minlength="1" name="enterpriseId" placeholder="(required)" id="menterpriseId0.35393963559903896" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Enterprise</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Enterprise ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The enterprise cannot be found or the user is forbidden access to this enterprise.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="menterpriseId0.5419401846597547">enterpriseId</label></td>
<td>
<input class="parameter required" minlength="1" name="enterpriseId" placeholder="(required)" id="menterpriseId0.5419401846597547" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Enterprise</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mclassificationCode0.8548054810048542">classificationCode</label></td>
<td>
<input class="parameter required" minlength="1" name="classificationCode" placeholder="(required)" id="mclassificationCode0.8548054810048542" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The code associated with the classification</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Enterprise ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Enterprise cannot be found or the user is forbidden access to this Enterprise.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="menterpriseId0.9946505045040568">enterpriseId</label></td>
<td>
<input class="parameter required" minlength="1" name="enterpriseId" placeholder="(required)" id="menterpriseId0.9946505045040568" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Enterprise</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Enterprise ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The enterprise cannot be found or the user is forbidden access to this enterprise.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="menterpriseId0.002244949345482139">enterpriseId</label></td>
<td>
<input class="parameter required" minlength="1" name="enterpriseId" placeholder="(required)" id="menterpriseId0.002244949345482139" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Enterprise</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Enterprise ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The enterprise cannot be found or the user is forbidden access to this enterprise.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="menterpriseId0.38339429228340927">enterpriseId</label></td>
<td>
<input class="parameter required" minlength="1" name="enterpriseId" placeholder="(required)" id="menterpriseId0.38339429228340927" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Enterprise</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Enterprise ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Enterprise cannot be found or the user is forbidden access to this Enterprise.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="menterpriseId0.5295850987269686">enterpriseId</label></td>
<td>
<input class="parameter required" minlength="1" name="enterpriseId" placeholder="(required)" id="menterpriseId0.5295850987269686" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Enterprise</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Enterprise ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The enterprise cannot be found or the user is forbidden access to this enterprise.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="menterpriseId0.3096993867069595">enterpriseId</label></td>
<td>
<input class="parameter required" minlength="1" name="enterpriseId" placeholder="(required)" id="menterpriseId0.3096993867069595" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Enterprise</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Enterprise ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The enterprise cannot be found or the user is forbidden access to this enterprise.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="menterpriseId0.24181808946344296">enterpriseId</label></td>
<td>
<input class="parameter required" minlength="1" name="enterpriseId" placeholder="(required)" id="menterpriseId0.24181808946344296" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Enterprise</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Enterprise ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Enterprise cannot be found or the user is forbidden access to this Enterprise.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="menterpriseId0.9403456581799612">enterpriseId</label></td>
<td>
<input class="parameter required" minlength="1" name="enterpriseId" placeholder="(required)" id="menterpriseId0.9403456581799612" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Enterprise</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Enterprise ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The enterprise cannot be found or the user is forbidden access to this enterprise.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="menterpriseId0.7220580593397381">enterpriseId</label></td>
<td>
<input class="parameter required" minlength="1" name="enterpriseId" placeholder="(required)" id="menterpriseId0.7220580593397381" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Enterprise</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Enterprise ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Enterprise cannot be found or the user is forbidden access to this enterprise.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="menterpriseId0.7688182395870238">enterpriseId</label></td>
<td>
<input class="parameter required" minlength="1" name="enterpriseId" placeholder="(required)" id="menterpriseId0.7688182395870238" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Enterprise</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Enterprise ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The enterprise cannot be found or the user is forbidden access to this enterprise.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mprojectCreate0.27894568319642365">projectCreate</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="projectCreate" id="mprojectCreate0.27894568319642365"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.007361098841293101" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.007361098841293101">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Create project model</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ProjectCreate {</span>
<div><span class="propName required">Name</span> (<span class="propType">string</span>),</div>
<div><span class="propName ">Description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName required">ParentId</span> (<span class="propType">string</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">{
"<span class="hljs-attr">Name</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">Description</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">ParentId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Project model is incorrect.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The parent Site or Project cannot be found or the user is forbidden access to either.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>A Project matching the supplied Project already exists in the parent.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mprojectId0.03823284833545815">projectId</label></td>
<td>
<input class="parameter required" minlength="1" name="projectId" placeholder="(required)" id="mprojectId0.03823284833545815" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Project</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Project deleted successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Project ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Project cannot be found or the user is forbidden access to this project.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mprojectId0.8315430410419007">projectId</label></td>
<td>
<input class="parameter required" minlength="1" name="projectId" placeholder="(required)" id="mprojectId0.8315430410419007" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Project</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Project ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Project cannot be found or the user is forbidden access to this project.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mprojectId0.8048813722417694">projectId</label></td>
<td>
<input class="parameter required" minlength="1" name="projectId" placeholder="(required)" id="mprojectId0.8048813722417694" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Project</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mprojectUpdate0.4838508006797131">projectUpdate</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="projectUpdate" id="mprojectUpdate0.4838508006797131"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.33665277560435847" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.33665277560435847">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Update Project model</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ProjectUpdate {</span>
<div><span class="propName ">Description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">{
"<span class="hljs-attr">Description</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">Name</span>": <span class="hljs-string">"string"</span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.29022543493082553">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.29022543493082553" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Project model is incorrect.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Project cannot be found or the user is forbidden access to this project.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>A Project matching the supplied Project already exists in this parent entity.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and use the value of the returned ETag header as
the value of the If-Match header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mprojectId0.1743148739220599">projectId</label></td>
<td>
<input class="parameter required" minlength="1" name="projectId" placeholder="(required)" id="mprojectId0.1743148739220599" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Project</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Project ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Project cannot be found or the user is forbidden access to this project.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mprojectId0.04542250561354333">projectId</label></td>
<td>
<input class="parameter required" minlength="1" name="projectId" placeholder="(required)" id="mprojectId0.04542250561354333" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Project</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mclassificationCode0.3456668829123368">classificationCode</label></td>
<td>
<input class="parameter required" minlength="1" name="classificationCode" placeholder="(required)" id="mclassificationCode0.3456668829123368" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The code associated with the classification</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Project ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Project cannot be found or the user is forbidden access to this Project.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mprojectId0.4665427390872434">projectId</label></td>
<td>
<input class="parameter required" minlength="1" name="projectId" placeholder="(required)" id="mprojectId0.4665427390872434" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Project</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Project ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Project cannot be found or the user is forbidden access to this project.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mprojectId0.44857313506250795">projectId</label></td>
<td>
<input class="parameter required" minlength="1" name="projectId" placeholder="(required)" id="mprojectId0.44857313506250795" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Project</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Project ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The project cannot be found or the user is forbidden access to this project.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mprojectId0.9548165666059008">projectId</label></td>
<td>
<input class="parameter required" minlength="1" name="projectId" placeholder="(required)" id="mprojectId0.9548165666059008" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Project</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Project ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Project cannot be found or the user is forbidden access to this project.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mprojectId0.008552183361580035">projectId</label></td>
<td>
<input class="parameter required" minlength="1" name="projectId" placeholder="(required)" id="mprojectId0.008552183361580035" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Project</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Project ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Project cannot be found or the user is forbidden access to this Project.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mprojectId0.8432577579777865">projectId</label></td>
<td>
<input class="parameter required" minlength="1" name="projectId" placeholder="(required)" id="mprojectId0.8432577579777865" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Project</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Project ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The project cannot be found or the user is forbidden access to this project.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mprojectId0.5341225647934045">projectId</label></td>
<td>
<input class="parameter required" minlength="1" name="projectId" placeholder="(required)" id="mprojectId0.5341225647934045" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Project</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Project ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Project cannot be found or the user is forbidden access to this Project.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mprojectId0.01689502941408416">projectId</label></td>
<td>
<input class="parameter required" minlength="1" name="projectId" placeholder="(required)" id="mprojectId0.01689502941408416" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Project</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Project ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Project cannot be found or the user is forbidden access to this project.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mprojectId0.7446147477772949">projectId</label></td>
<td>
<input class="parameter required" minlength="1" name="projectId" placeholder="(required)" id="mprojectId0.7446147477772949" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Project</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Project ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The project cannot be found or the user is forbidden access to this project.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mprojectId0.7223889832442347">projectId</label></td>
<td>
<input class="parameter required" minlength="1" name="projectId" placeholder="(required)" id="mprojectId0.7223889832442347" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Project</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Project ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Project cannot be found or the user is forbidden access to this project.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mprojectId0.7429281750806132">projectId</label></td>
<td>
<input class="parameter required" minlength="1" name="projectId" placeholder="(required)" id="mprojectId0.7429281750806132" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Project</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Project ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The project cannot be found or the user is forbidden access to this project.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="msiteCreate0.7023337729784989">siteCreate</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="siteCreate" id="msiteCreate0.7023337729784989"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7855131219405942" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7855131219405942">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Create Site model</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SiteCreate {</span>
<div><span class="propName ">Description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName required">ParentId</span> (<span class="propType">string</span>),</div>
<div><span class="propName required">Name</span> (<span class="propType">string</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">{
"<span class="hljs-attr">Description</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">ParentId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Name</span>": <span class="hljs-string">"string"</span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Site model is incorrect.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The enterprise cannot be found or the user is forbidden access to this enterprise.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>A Site name matching the supplied Site name already exists in this enterprise.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="msiteId0.21110436109382347">siteId</label></td>
<td>
<input class="parameter required" minlength="1" name="siteId" placeholder="(required)" id="msiteId0.21110436109382347" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Site</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Site deleted successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Site ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Site cannot be found or the user is forbidden access to this site.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="msiteId0.8311731058579386">siteId</label></td>
<td>
<input class="parameter required" minlength="1" name="siteId" placeholder="(required)" id="msiteId0.8311731058579386" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Site</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Site ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Site cannot be found or the user is forbidden access to this site.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="msiteId0.17140686366159286">siteId</label></td>
<td>
<input class="parameter required" minlength="1" name="siteId" placeholder="(required)" id="msiteId0.17140686366159286" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Site</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="msiteUpdate0.5020926389444054">siteUpdate</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="siteUpdate" id="msiteUpdate0.5020926389444054"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9415257615271415" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9415257615271415">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Update Site model</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SiteUpdate {</span>
<div><span class="propName ">Description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName required">Name</span> (<span class="propType">string</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">{
"<span class="hljs-attr">Description</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">Name</span>": <span class="hljs-string">"string"</span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.9770346337758749">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.9770346337758749" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Site model is incorrect.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Site cannot be found or the user is forbidden access to this site.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>A Site name matching the supplied Site name already exists in this enterprise.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and use the value of the returned ETag header as
the value of the If-Match header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="msiteId0.13620489916730638">siteId</label></td>
<td>
<input class="parameter required" minlength="1" name="siteId" placeholder="(required)" id="msiteId0.13620489916730638" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Site</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mclassificationCode0.9923117246955755">classificationCode</label></td>
<td>
<input class="parameter required" minlength="1" name="classificationCode" placeholder="(required)" id="mclassificationCode0.9923117246955755" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The code associated with the classification</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Site ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Site cannot be found or the user is forbidden access to this Site.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="msiteId0.7141688069951355">siteId</label></td>
<td>
<input class="parameter required" minlength="1" name="siteId" placeholder="(required)" id="msiteId0.7141688069951355" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Site</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Site ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The site cannot be found or the user is forbidden access to this site.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="msiteId0.9875242137082436">siteId</label></td>
<td>
<input class="parameter required" minlength="1" name="siteId" placeholder="(required)" id="msiteId0.9875242137082436" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Site</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Site ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Site cannot be found or the user is forbidden access to this site.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="msiteId0.5111127798377695">siteId</label></td>
<td>
<input class="parameter required" minlength="1" name="siteId" placeholder="(required)" id="msiteId0.5111127798377695" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Site</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Site ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Site cannot be found or the user is forbidden access to this Site.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="msiteId0.20429157466502978">siteId</label></td>
<td>
<input class="parameter required" minlength="1" name="siteId" placeholder="(required)" id="msiteId0.20429157466502978" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Site</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Site ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Site cannot be found or the user is forbidden access to this site.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="msiteId0.34988316669891417">siteId</label></td>
<td>
<input class="parameter required" minlength="1" name="siteId" placeholder="(required)" id="msiteId0.34988316669891417" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Site</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Site ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The site cannot be found or the user is forbidden access to this site.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="msiteId0.7690222646478952">siteId</label></td>
<td>
<input class="parameter required" minlength="1" name="siteId" placeholder="(required)" id="msiteId0.7690222646478952" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Site</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Site ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Site cannot be found or the user is forbidden access to this Site.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="msiteId0.19596184385552418">siteId</label></td>
<td>
<input class="parameter required" minlength="1" name="siteId" placeholder="(required)" id="msiteId0.19596184385552418" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Site</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Site ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The site cannot be found or the user is forbidden access to this site.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="msiteId0.33740762580363626">siteId</label></td>
<td>
<input class="parameter required" minlength="1" name="siteId" placeholder="(required)" id="msiteId0.33740762580363626" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Site</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Site ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Site cannot be found or the user is forbidden access to this Site.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="msiteId0.09690083462863774">siteId</label></td>
<td>
<input class="parameter required" minlength="1" name="siteId" placeholder="(required)" id="msiteId0.09690083462863774" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Site</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Site ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The site cannot be found or the user is forbidden access to this site.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="msvcCreate0.392655096459384">svcCreate</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="svcCreate" id="msvcCreate0.392655096459384"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.2227323659905489" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.2227323659905489">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Create SVC model</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SVCCreate {</span>
<div><span class="propName ">ParentId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName required">Name</span> (<span class="propType">string</span>),</div>
<div><span class="propName ">OwnerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Workflows</span> (<span class="propType">Array[Workflow ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RevisionReference</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RevisionNotes</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RevisionIsPrivate</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RevisionStatusId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RevisionNotifyByEmail</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Attachments</span> (<span class="propType">Array[Attachment ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RevisionKeywords</span> (<span class="propType">Array[Keyword ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RevisionWorkflows</span> (<span class="propType">Array[Workflow ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RevisionClassifications</span> (<span class="propType">Array[Classification ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DirectAccess</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AllowMarkups</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">IsPublic</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">EnforceWorkflow</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ExpiryDateTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Comment</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Workflow {</span>
<div><span class="propName ">Id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Attachment {</span>
<div><span class="propWrap"><span class="propName required">EntityType</span> (<span class="propType">string</span>) = <span class="propVals">['UNDEFINED', 'DOCUMENT']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "DOCUMENT"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">EntityId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Keyword {</span>
<div><span class="propName required">Id</span> (<span class="propType">string</span>)</div><span class="strong">}</span><br><span class="strong">Classification {</span>
<div><span class="propName ">UniclassId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">{
"<span class="hljs-attr">ParentId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Name</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">OwnerId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Workflows</span>": [
{
"<span class="hljs-attr">Id</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
],
"<span class="hljs-attr">RevisionReference</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">RevisionNotes</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">RevisionIsPrivate</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">RevisionStatusId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">RevisionNotifyByEmail</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">Attachments</span>": [
{
"<span class="hljs-attr">EntityType</span>": <span class="hljs-string">"UNDEFINED"</span>,
"<span class="hljs-attr">EntityId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
],
"<span class="hljs-attr">RevisionKeywords</span>": [
{
"<span class="hljs-attr">Id</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
],
"<span class="hljs-attr">RevisionWorkflows</span>": [
{
"<span class="hljs-attr">Id</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
],
"<span class="hljs-attr">RevisionClassifications</span>": [
{
"<span class="hljs-attr">UniclassId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Code</span>": <span class="hljs-string">"string"</span>
}
],
"<span class="hljs-attr">Description</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">DirectAccess</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">AllowMarkups</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">IsPublic</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">EnforceWorkflow</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">ExpiryDateTime</span>": <span class="hljs-string">"2024-06-07T11:33:36.084Z"</span>,
"<span class="hljs-attr">Comment</span>": <span class="hljs-string">"string"</span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Static Virtual Container model is incorrect.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The parent entity cannot be found or the user is forbidden access to this parent entity or the parent type id invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>A Static Virtual Container matching the supplied name exists in this parent entity.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Invalid items supplied.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="msvcId0.21236973380150737">svcId</label></td>
<td>
<input class="parameter required" minlength="1" name="svcId" placeholder="(required)" id="msvcId0.21236973380150737" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the SVC</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>SVC deleted successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied SVC ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The SVC cannot be found or the user does not have permission to access the entity.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="msvcId0.4772312701996173">svcId</label></td>
<td>
<input class="parameter required" minlength="1" name="svcId" placeholder="(required)" id="msvcId0.4772312701996173" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the SVC</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied SVC ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The SVC cannot be found or the user is forbidden access to this SVC.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="msvcId0.9229827161415511">svcId</label></td>
<td>
<input class="parameter required" minlength="1" name="svcId" placeholder="(required)" id="msvcId0.9229827161415511" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the SVC</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="msvcUpdate0.7698908059482548">svcUpdate</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="svcUpdate" id="msvcUpdate0.7698908059482548"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7382418495565062" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7382418495565062">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Update SVC model</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SVCUpdate {</span>
<div><span class="propName ">OwnerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Workflows</span> (<span class="propType">Array[Workflow ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RevisionReference</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RevisionNotes</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RevisionIsPrivate</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RevisionStatusId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RevisionNotifyByEmail</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Attachments</span> (<span class="propType">Array[Attachment ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RevisionKeywords</span> (<span class="propType">Array[Keyword ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RevisionWorkflows</span> (<span class="propType">Array[Workflow ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RevisionClassifications</span> (<span class="propType">Array[Classification ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DirectAccess</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AllowMarkups</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">IsPublic</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">EnforceWorkflow</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ExpiryDateTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Comment</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Workflow {</span>
<div><span class="propName ">Id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Attachment {</span>
<div><span class="propWrap"><span class="propName required">EntityType</span> (<span class="propType">string</span>) = <span class="propVals">['UNDEFINED', 'DOCUMENT']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "DOCUMENT"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">EntityId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Keyword {</span>
<div><span class="propName required">Id</span> (<span class="propType">string</span>)</div><span class="strong">}</span><br><span class="strong">Classification {</span>
<div><span class="propName ">UniclassId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">{
"<span class="hljs-attr">OwnerId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Name</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">Workflows</span>": [
{
"<span class="hljs-attr">Id</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
],
"<span class="hljs-attr">RevisionReference</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">RevisionNotes</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">RevisionIsPrivate</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">RevisionStatusId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">RevisionNotifyByEmail</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">Attachments</span>": [
{
"<span class="hljs-attr">EntityType</span>": <span class="hljs-string">"UNDEFINED"</span>,
"<span class="hljs-attr">EntityId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
],
"<span class="hljs-attr">RevisionKeywords</span>": [
{
"<span class="hljs-attr">Id</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
],
"<span class="hljs-attr">RevisionWorkflows</span>": [
{
"<span class="hljs-attr">Id</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
],
"<span class="hljs-attr">RevisionClassifications</span>": [
{
"<span class="hljs-attr">UniclassId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Code</span>": <span class="hljs-string">"string"</span>
}
],
"<span class="hljs-attr">Description</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">DirectAccess</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">AllowMarkups</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">IsPublic</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">EnforceWorkflow</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">ExpiryDateTime</span>": <span class="hljs-string">"2024-06-07T11:33:36.089Z"</span>,
"<span class="hljs-attr">Comment</span>": <span class="hljs-string">"string"</span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.5493328521476255">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.5493328521476255" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Static Virtual Container model is incorrect.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Static Virtual Container cannot be found or the user is forbidden access to this Static Virtual Container.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>A Static Virtual Container matching the supplied name exists in this parent entity.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>Error related to the If-Match header</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="msvcid0.7052381280772142">svcid</label></td>
<td>
<input class="parameter required" minlength="1" name="svcid" placeholder="(required)" id="msvcid0.7052381280772142" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the SVC</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mattachments0.8784473223232048">attachments</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="attachments" id="mattachments0.8784473223232048"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.35272321970797393" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.35272321970797393">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Collection of attachments (document) models</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">Attachment {</span>
<div><span class="propWrap"><span class="propName required">EntityType</span> (<span class="propType">string</span>) = <span class="propVals">['UNDEFINED', 'DOCUMENT']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "DOCUMENT"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">EntityId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">EntityType</span>": <span class="hljs-string">"UNDEFINED"</span>,
"<span class="hljs-attr">EntityId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.740230683154341">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.740230683154341" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The parent entity cannot be found or the user is forbidden access to this parent entity or the parent type id invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The supplied If-Match header value does not match the parent entity's UpdatedAtDateTime value in ticks.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Supplied attachment(s) are invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="msvcid0.4817702867539375">svcid</label></td>
<td>
<input class="parameter required" minlength="1" name="svcid" placeholder="(required)" id="msvcid0.4817702867539375" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the SVC</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mattachments0.9927342559144874">attachments</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="attachments" id="mattachments0.9927342559144874"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5729085712771966" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5729085712771966">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Collection of attachment models</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">Attachment {</span>
<div><span class="propName ">AttachmentId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">AttachmentId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.8292506601428951">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.8292506601428951" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Removed attachment(s) from the specified SVC successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied SVC ID or Attachment model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The SVC cannot be found or the user is forbidden access to this SVC.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>Etag precondition failed.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Error saving updated revision.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="msvcId0.8709058385223418">svcId</label></td>
<td>
<input class="parameter required" minlength="1" name="svcId" placeholder="(required)" id="msvcId0.8709058385223418" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the SVC</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mclassifications0.43758176196228815">classifications</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="classifications" id="mclassifications0.43758176196228815"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5835099448602645" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5835099448602645">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>A collection of classification models</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">Classification {</span>
<div><span class="propName ">UniclassId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">UniclassId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Code</span>": <span class="hljs-string">"string"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.14598205568583333">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.14598205568583333" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied SVC ID or classifications model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The SVC cannot be found or the user does not have permission to access the SVC.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>Etag precondition failed</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>The supplied Classification(s) is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="msvcId0.924131696072169">svcId</label></td>
<td>
<input class="parameter required" minlength="1" name="svcId" placeholder="(required)" id="msvcId0.924131696072169" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mclassifications0.022308060643841277">classifications</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="classifications" id="mclassifications0.022308060643841277"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.37273241604897067" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.37273241604897067">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Collection of classification models</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">Classification {</span>
<div><span class="propName ">UniclassId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">UniclassId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Code</span>": <span class="hljs-string">"string"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.06331518800992719">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.06331518800992719" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Classifications removed successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied SVC ID or classifications model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The SVC cannot be found or the user does not have permission to access the SVC.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>Etag precondition failed</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>The supplied Classification(s) is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="msvcid0.747972360009669">svcid</label></td>
<td>
<input class="parameter required" minlength="1" name="svcid" placeholder="(required)" id="msvcid0.747972360009669" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the SVC</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mkeywords0.04815886159229121">keywords</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="keywords" id="mkeywords0.04815886159229121"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.11037473985259161" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.11037473985259161">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Collection of keyword Ids</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">Keyword {</span>
<div><span class="propName required">Id</span> (<span class="propType">string</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">Id</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.7946671077422918">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.7946671077422918" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The parent entity cannot be found or the user is forbidden access to this parent entity or the parent type id invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The supplied If-Match header value does not match the parent entity's UpdatedAtDateTime value in ticks.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Supplied keyword(s) are invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="msvcId0.9513780151970905">svcId</label></td>
<td>
<input class="parameter required" minlength="1" name="svcId" placeholder="(required)" id="msvcId0.9513780151970905" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the SVC</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mkeywordIds0.37957471519441155">keywordIds</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="keywordIds" id="mkeywordIds0.37957471519441155"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.15232785575833052" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.15232785575833052">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Collection of keyword Ids</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">Keyword {</span>
<div><span class="propName required">Id</span> (<span class="propType">string</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">Id</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.14474742247547945">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.14474742247547945" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Keywords removed successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied SVC ID or Keyword IDs are invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The svc or keywords could not be found or the user is forbidden access to this svc.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>Etag precondition failed</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Supplied keywords are invalid</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="msvcid0.8923715453305645">svcid</label></td>
<td>
<input class="parameter required" minlength="1" name="svcid" placeholder="(required)" id="msvcid0.8923715453305645" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the SVC</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.9358642189582982">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.9358642189582982" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied SVC ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The SVC cannot be found or the user is forbidden access to this SVC.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>Etag precondition failed.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Error saving SVC.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="msvcid0.048627094529107184">svcid</label></td>
<td>
<input class="parameter required" minlength="1" name="svcid" placeholder="(required)" id="msvcid0.048627094529107184" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the SVC</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mworkflows0.4981286123929136">workflows</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="workflows" id="mworkflows0.4981286123929136"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.828983240753836" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.828983240753836">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Collection of workflow models</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">Workflow {</span>
<div><span class="propName ">Id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">Id</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.19731457216770854">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.19731457216770854" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The parent entity cannot be found or the user is forbidden access to this parent entity or the parent type id invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The supplied If-Match header value does not match the parent entity's UpdatedAtDateTime value in ticks.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Supplied workflow(s) are invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="msvcId0.22340390547533695">svcId</label></td>
<td>
<input class="parameter required" minlength="1" name="svcId" placeholder="(required)" id="msvcId0.22340390547533695" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the SVC</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrevisionWorkflows0.33974886059173515">revisionWorkflows</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="revisionWorkflows" id="mrevisionWorkflows0.33974886059173515"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.49012676196454463" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.49012676196454463">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>A collection of revision workflow models</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">Workflow {</span>
<div><span class="propName ">Id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">Id</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.22587383646885995">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.22587383646885995" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Removed revision workflow(s) from the specified SVC successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied SVC ID or Workflow model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The SVC cannot be found or the user is forbidden access to this SVC.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>Etag precondition failed.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Error saving updated revision.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="msvcId0.6684420925012968">svcId</label></td>
<td>
<input class="parameter required" minlength="1" name="svcId" placeholder="(required)" id="msvcId0.6684420925012968" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the SVC</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied SVC ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The SVC cannot be found or the user is forbidden access to this SVC.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="msvcid0.12375063634824301">svcid</label></td>
<td>
<input class="parameter required" minlength="1" name="svcid" placeholder="(required)" id="msvcid0.12375063634824301" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the SVC</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mworkflows0.2181298238795213">workflows</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="workflows" id="mworkflows0.2181298238795213"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9880854444072624" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9880854444072624">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Collection of workflow models</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">Workflow {</span>
<div><span class="propName ">Id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">Id</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.7966657880867729">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.7966657880867729" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The parent entity cannot be found or the user is forbidden access to this parent entity or the parent type id invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The supplied If-Match header value does not match the parent entity's UpdatedAtDateTime value in ticks.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Supplied workflow(s) are invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="msvcId0.17157011157820157">svcId</label></td>
<td>
<input class="parameter required" minlength="1" name="svcId" placeholder="(required)" id="msvcId0.17157011157820157" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the SVC</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mworkflows0.39031986490841564">workflows</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="workflows" id="mworkflows0.39031986490841564"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5505286382434664" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5505286382434664">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>A collection of workflows models</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">Workflow {</span>
<div><span class="propName ">Id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">Id</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.5251962437473894">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.5251962437473894" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Removed workflow(s) from the specified SVC successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied SVC ID or Workflow model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The SVC cannot be found or the user is forbidden access to this SVC.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>Etag precondition failed.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Error saving updated revision.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal server error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskfolderCreate0.5446404500973527">taskfolderCreate</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="taskfolderCreate" id="mtaskfolderCreate0.5446404500973527"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5224968350056984" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5224968350056984">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Task Folder create model</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TaskFolder {</span>
<div><span class="propName required">ParentId</span> (<span class="propType">string</span>),</div>
<div><span class="propName required">Name</span> (<span class="propType">string</span>),</div>
<div><span class="propName ">Description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DropBoxEmailEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DropBoxEmailLocalPart</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">InternalRecipients</span> (<span class="propType">Array[InternalRecipient ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">TaskAssignees</span> (<span class="propType">Array[TaskAssignee ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Private</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">DaysFrom</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Min. Value:</td>
<td>1</td>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>99999</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName ">DueDateIsEditable</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">EmailRemindersOn</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">DaysBeforeDueDate</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>99999</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName ">OverdueRemindersEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">OverdueReminderRepeatFrequency</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['DAILY', 'WEEKLY',
'MONTHLY']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"DAILY", "WEEKLY", "MONTHLY"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">EmailReminderRepeatFrequencyOccurrences</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>99999</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName ">LocalAttachmentsDisabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">InternalRecipient {</span>
<div><span class="propName required">ProfileId</span> (<span class="propType">string</span>),</div>
<div><span class="propWrap"><span class="propName required">Type</span> (<span class="propType">string</span>) = <span class="propVals">['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP', 'SECURITYGROUP']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span><br><span class="strong">TaskAssignee {</span>
<div><span class="propName ">ProfileId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">Type</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">{
"<span class="hljs-attr">ParentId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Name</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">Description</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">DropBoxEmailEnabled</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">DropBoxEmailLocalPart</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">InternalRecipients</span>": [
{
"<span class="hljs-attr">ProfileId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Type</span>": <span class="hljs-string">"UNDEFINED"</span>
}
],
"<span class="hljs-attr">TaskAssignees</span>": [
{
"<span class="hljs-attr">ProfileId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Type</span>": <span class="hljs-string">"UNDEFINED"</span>
}
],
"<span class="hljs-attr">Private</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">DaysFrom</span>": <span class="hljs-number">0</span>,
"<span class="hljs-attr">DueDateIsEditable</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">EmailRemindersOn</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">DaysBeforeDueDate</span>": <span class="hljs-number">0</span>,
"<span class="hljs-attr">OverdueRemindersEnabled</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">OverdueReminderRepeatFrequency</span>": <span class="hljs-string">"DAILY"</span>,
"<span class="hljs-attr">EmailReminderRepeatFrequencyOccurrences</span>": <span class="hljs-number">0</span>,
"<span class="hljs-attr">LocalAttachmentsDisabled</span>": <span class="hljs-literal">true</span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Task Folder model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The parent entity cannot be found or the user is forbidden access to the parent entity.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>A Task Folder matching the supplied Task Folder already exists in the parent entity or the drop box email address is already in use.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>The supplied Task Folder model contains invalid items.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskfolderid0.7779542233859955">taskfolderid</label></td>
<td>
<input class="parameter required" minlength="1" name="taskfolderid" placeholder="(required)" id="mtaskfolderid0.7779542233859955" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Task Folder</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskfolderUpdate0.08562601150768456">taskfolderUpdate</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="taskfolderUpdate" id="mtaskfolderUpdate0.08562601150768456"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.8039242035810237" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.8039242035810237">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The update information of the new Task Folder</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TaskFolder {</span>
<div><span class="propName required">Name</span> (<span class="propType">string</span>),</div>
<div><span class="propName ">DropBoxEmailEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">InternalRecipients</span> (<span class="propType">Array[InternalRecipient ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">TaskAssignees</span> (<span class="propType">Array[TaskAssignee ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Private</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">DaysFrom</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Min. Value:</td>
<td>1</td>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>99999</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName ">DueDateIsEditable</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">EmailRemindersOn</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">DaysBeforeDueDate</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>99999</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName ">OverdueRemindersEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">OverdueReminderRepeatFrequency</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['DAILY', 'WEEKLY',
'MONTHLY']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"DAILY", "WEEKLY", "MONTHLY"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">EmailReminderRepeatFrequencyOccurrences</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>99999</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName ">LocalAttachmentsDisabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DropBoxEmailLocalPart</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">InternalRecipient {</span>
<div><span class="propName required">ProfileId</span> (<span class="propType">string</span>),</div>
<div><span class="propWrap"><span class="propName required">Type</span> (<span class="propType">string</span>) = <span class="propVals">['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP', 'SECURITYGROUP']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span><br><span class="strong">TaskAssignee {</span>
<div><span class="propName ">ProfileId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">Type</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">{
"<span class="hljs-attr">Name</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">DropBoxEmailEnabled</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">InternalRecipients</span>": [
{
"<span class="hljs-attr">ProfileId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Type</span>": <span class="hljs-string">"UNDEFINED"</span>
}
],
"<span class="hljs-attr">TaskAssignees</span>": [
{
"<span class="hljs-attr">ProfileId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Type</span>": <span class="hljs-string">"UNDEFINED"</span>
}
],
"<span class="hljs-attr">Private</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">DaysFrom</span>": <span class="hljs-number">0</span>,
"<span class="hljs-attr">DueDateIsEditable</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">EmailRemindersOn</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">DaysBeforeDueDate</span>": <span class="hljs-number">0</span>,
"<span class="hljs-attr">OverdueRemindersEnabled</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">OverdueReminderRepeatFrequency</span>": <span class="hljs-string">"DAILY"</span>,
"<span class="hljs-attr">EmailReminderRepeatFrequencyOccurrences</span>": <span class="hljs-number">0</span>,
"<span class="hljs-attr">LocalAttachmentsDisabled</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">Description</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">DropBoxEmailLocalPart</span>": <span class="hljs-string">"string"</span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.4697706254171652">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.4697706254171652" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Task Folder ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Task Folder cannot be found or the user is forbidden access to this Task Folder.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>A Task Folder matching the supplied Task Folder already exists in the parent entity or the drop box email address is already in use.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and use the value of the returned ETag header as
the value of the If-Match header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskFolderId0.8966613985118137">taskFolderId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskFolderId" placeholder="(required)" id="mtaskFolderId0.8966613985118137" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Task Folder</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Task folder removed successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied TaskFolder ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Task Folder cannot be found, or the user is forbidden access to this Task Folder.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskFolderId0.88506830498988">taskFolderId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskFolderId" placeholder="(required)" id="mtaskFolderId0.88506830498988" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Task Folder</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Task Folder ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Task Folder cannot be found or the user is forbidden access to this Task Folder.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskfolderId0.4610291038038701">taskfolderId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskfolderId" placeholder="(required)" id="mtaskfolderId0.4610291038038701" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the TaskFolder</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied TaskFolder ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The TaskFolder cannot be found or the user is forbidden access to this TaskFolder.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskFolderId0.7288557907539479">taskFolderId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskFolderId" placeholder="(required)" id="mtaskFolderId0.7288557907539479" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Task Folder</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="massignees0.41117359792751174">assignees</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="assignees" id="massignees0.41117359792751174"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.047786543444959806" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.047786543444959806">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>A collection of assignee models</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">TaskAssignee {</span>
<div><span class="propName ">ProfileId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">Type</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">ProfileId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Type</span>": <span class="hljs-string">"UNDEFINED"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.9412917594915837">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.9412917594915837" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Task Folder ID or assignees model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The task folder cannot be found or the user lacks permissions.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>The supplied Assignees model is incorrect.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskFolderId0.4990477128656985">taskFolderId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskFolderId" placeholder="(required)" id="mtaskFolderId0.4990477128656985" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Task Folder</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="massigneesIds0.3647271122410072">assigneesIds</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="assigneesIds" id="massigneesIds0.3647271122410072"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9357039135918486" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9357039135918486">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>A collection of unique identifiers of the Assignees to remove</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">TaskAssignee {</span>
<div><span class="propName required">ProfileId</span> (<span class="propType">string</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">ProfileId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.26857828632155356">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.26857828632155356" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Assignees removed successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Task Folder ID or Assignee IDs are invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The task folder could not be found or the user lacks permissions.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Supplied Assignees are invalid</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskFolderId0.28952532904279304">taskFolderId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskFolderId" placeholder="(required)" id="mtaskFolderId0.28952532904279304" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Task Folder</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrecipients0.32792560058311016">recipients</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="recipients" id="mrecipients0.32792560058311016"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.910794013275936" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.910794013275936">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>A collection of recipient models</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">InternalRecipient {</span>
<div><span class="propName required">ProfileId</span> (<span class="propType">string</span>),</div>
<div><span class="propWrap"><span class="propName required">Type</span> (<span class="propType">string</span>) = <span class="propVals">['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP', 'SECURITYGROUP']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">ProfileId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Type</span>": <span class="hljs-string">"UNDEFINED"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.7843794161861903">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.7843794161861903" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Task Folder ID or recipients model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The task folder cannot be found or the user lacks permissions.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>The supplied Recipients model is incorrect.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskFolderId0.8567847443903873">taskFolderId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskFolderId" placeholder="(required)" id="mtaskFolderId0.8567847443903873" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Task Folder</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrecipientIds0.8523715077049818">recipientIds</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="recipientIds" id="mrecipientIds0.8523715077049818"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7241482813383104" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7241482813383104">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>A collection of unique identifiers of the Recipients to remove</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">InternalRecipient {</span>
<div><span class="propName required">ProfileId</span> (<span class="propType">string</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">ProfileId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.28608145304382804">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.28608145304382804" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Recipients removed successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Task Folder ID or Recipient IDs are invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The task folder could not be found or the user lacks permissions.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Supplied Recipients are invalid</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskfolderId0.7631865358538594">taskfolderId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskfolderId" placeholder="(required)" id="mtaskfolderId0.7631865358538594" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the TaskFolder</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied TaskFolder ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The TaskFolder cannot be found or the user is forbidden access to this TaskFolder.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskfolderid0.37460876250967656">taskfolderid</label></td>
<td>
<input class="parameter required" minlength="1" name="taskfolderid" placeholder="(required)" id="mtaskfolderid0.37460876250967656" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Task Folder</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskfolderUpdate0.4562515672610259">taskfolderUpdate</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="taskfolderUpdate" id="mtaskfolderUpdate0.4562515672610259"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.1931092602181983" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.1931092602181983">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The update information of the new Task Folder</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TaskFolderV2 {</span>
<div><span class="propName ">Name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DropBoxEmailEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Private</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">DaysFrom</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Min. Value:</td>
<td>1</td>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>99999</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName ">DueDateIsEditable</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">EmailRemindersOn</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">DaysBeforeDueDate</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Min. Value:</td>
<td>1</td>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>99999</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName ">OverdueRemindersEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">OverdueReminderRepeatFrequency</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['DAILY', 'WEEKLY',
'MONTHLY']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"DAILY", "WEEKLY", "MONTHLY"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">EmailReminderRepeatFrequencyOccurrences</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Min. Value:</td>
<td>-1</td>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>99999</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName ">LocalAttachmentsDisabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DropBoxEmailLocalPart</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">{
"<span class="hljs-attr">Name</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">DropBoxEmailEnabled</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">Private</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">DaysFrom</span>": <span class="hljs-number">0</span>,
"<span class="hljs-attr">DueDateIsEditable</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">EmailRemindersOn</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">DaysBeforeDueDate</span>": <span class="hljs-number">0</span>,
"<span class="hljs-attr">OverdueRemindersEnabled</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">OverdueReminderRepeatFrequency</span>": <span class="hljs-string">"DAILY"</span>,
"<span class="hljs-attr">EmailReminderRepeatFrequencyOccurrences</span>": <span class="hljs-number">0</span>,
"<span class="hljs-attr">LocalAttachmentsDisabled</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">Description</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">DropBoxEmailLocalPart</span>": <span class="hljs-string">"string"</span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.8467635649251493">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.8467635649251493" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Task Folder ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Task Folder cannot be found or the user is forbidden access to this Task Folder.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>A Task Folder matching the supplied Task Folder already exists in the parent entity or the drop box email address is already in use.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and use the value of the returned ETag header as
the value of the If-Match header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskCreate0.31328743683979776">taskCreate</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="taskCreate" id="mtaskCreate0.31328743683979776"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5656301585320029" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5656301585320029">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Task create model</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">Task {</span>
<div><span class="propName ">ParentId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName required">Name</span> (<span class="propType">string</span>),</div>
<div><span class="propWrap"><span class="propName required">Priority</span> (<span class="propType">string</span>) = <span class="propVals">['HIGH', 'MEDIUM', 'LOW']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"HIGH", "MEDIUM", "LOW"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">TaskAssigneeProfileId</span> (<span class="propType">string</span>),</div>
<div><span class="propName required">Text</span> (<span class="propType">string</span>),</div>
<div><span class="propWrap"><span class="propName required">PercentageComplete</span> (<span class="propType">integer</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>100</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName ">Attachments</span> (<span class="propType">Array[Attachment ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">InternalRecipients</span> (<span class="propType">Array[InternalRecipient ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Keywords</span> (<span class="propType">Array[Keyword ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DueDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Private</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">SendEmail</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ResponseRequired</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ForwardingDisabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Attachment {</span>
<div><span class="propWrap"><span class="propName required">EntityType</span> (<span class="propType">string</span>) = <span class="propVals">['UNDEFINED', 'DOCUMENT']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "DOCUMENT"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">EntityId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">InternalRecipient {</span>
<div><span class="propName required">ProfileId</span> (<span class="propType">string</span>),</div>
<div><span class="propWrap"><span class="propName required">Type</span> (<span class="propType">string</span>) = <span class="propVals">['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP', 'SECURITYGROUP']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span><br><span class="strong">Keyword {</span>
<div><span class="propName required">Id</span> (<span class="propType">string</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">{
"<span class="hljs-attr">ParentId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Name</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">Priority</span>": <span class="hljs-string">"HIGH"</span>,
"<span class="hljs-attr">TaskAssigneeProfileId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Text</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">PercentageComplete</span>": <span class="hljs-number">0</span>,
"<span class="hljs-attr">Attachments</span>": [
{
"<span class="hljs-attr">EntityType</span>": <span class="hljs-string">"UNDEFINED"</span>,
"<span class="hljs-attr">EntityId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
],
"<span class="hljs-attr">InternalRecipients</span>": [
{
"<span class="hljs-attr">ProfileId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Type</span>": <span class="hljs-string">"UNDEFINED"</span>
}
],
"<span class="hljs-attr">Keywords</span>": [
{
"<span class="hljs-attr">Id</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
],
"<span class="hljs-attr">Description</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">DueDate</span>": <span class="hljs-string">"2024-06-07T11:33:36.131Z"</span>,
"<span class="hljs-attr">Private</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">SendEmail</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">ResponseRequired</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">ForwardingDisabled</span>": <span class="hljs-literal">true</span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Task model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The parent entity cannot be found or the user is forbidden access to the parent entity.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>A Task matching the supplied Task already exists in the parent entity</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>The supplied Task model contains invalid items.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskid0.9926585186758203">taskid</label></td>
<td>
<input class="parameter required" minlength="1" name="taskid" placeholder="(required)" id="mtaskid0.9926585186758203" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Task</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Task ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Task cannot be found or the user is forbidden access to this Task.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskId0.49351435789852194">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.49351435789852194" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Task</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Task deleted successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Task ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Task cannot be found or the user does not have permission to access the Task.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskId0.5518100249733517">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.5518100249733517" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Task</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskUpdate0.3243255109903358">taskUpdate</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="taskUpdate" id="mtaskUpdate0.3243255109903358"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.2621462855224945" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.2621462855224945">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Update Task model</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">Task {</span>
<div><span class="propWrap"><span class="propName ">Priority</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['HIGH', 'MEDIUM', 'LOW']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"HIGH", "MEDIUM", "LOW"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">TaskAssigneeProfileId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">State</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['Reopen', 'Close', 'CloseResolve', 'Resolve',
'Redirect']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"Reopen", "Close", "CloseResolve", "Resolve", "Redirect"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">Text</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DueDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Private</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">SendEmail</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ResponseRequired</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ForwardingDisabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">PercentageComplete</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>100</td>
</tr>
</tbody>
</table></span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">{
"<span class="hljs-attr">Priority</span>": <span class="hljs-string">"HIGH"</span>,
"<span class="hljs-attr">TaskAssigneeProfileId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">State</span>": <span class="hljs-string">"Reopen"</span>,
"<span class="hljs-attr">Text</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">Name</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">Description</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">DueDate</span>": <span class="hljs-string">"2024-06-07T11:33:36.136Z"</span>,
"<span class="hljs-attr">Private</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">SendEmail</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">ResponseRequired</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">ForwardingDisabled</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">PercentageComplete</span>": <span class="hljs-number">0</span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code"><label for="mreason0.9581878061021041">reason</label></td>
<td>
<input class="parameter" minlength="0" name="reason" placeholder="" id="mreason0.9581878061021041" type="text" value="">
</td>
<td class="markdown">
<p>Optional reason</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.2693465949459557">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.2693465949459557" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Task model is incorrect.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Task cannot be found or the user is forbidden access to this Task.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>A Task matching the supplied name exists in this parent entity.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>Error related to the If-Match header</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>The supplied Task update model contains invalid items.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskId0.6304397417506566">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.6304397417506566" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Task</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mattachments0.16034452739395566">attachments</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="attachments" id="mattachments0.16034452739395566"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6188255984171918" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6188255984171918">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>A collection of attachments models</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">Attachment {</span>
<div><span class="propWrap"><span class="propName required">EntityType</span> (<span class="propType">string</span>) = <span class="propVals">['UNDEFINED', 'DOCUMENT']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "DOCUMENT"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">EntityId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">EntityType</span>": <span class="hljs-string">"UNDEFINED"</span>,
"<span class="hljs-attr">EntityId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.18651432955846903">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.18651432955846903" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Task ID or attachments model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The task cannot be found or the user lacks permissions.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>The supplied Attachments model is incorrect.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskId0.662348401509411">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.662348401509411" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Task</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mattachmentIds0.46408088004800785">attachmentIds</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="attachmentIds" id="mattachmentIds0.46408088004800785"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.967839812414659" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.967839812414659">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>A collection of unique identifiers of the Attachments to remove</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">Attachment {</span>
<div><span class="propName ">AttachmentId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">AttachmentId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.5722206921620208">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.5722206921620208" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Attachments removed successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Task ID or Attachment IDs are invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The task could not be found or the user lacks permissions.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Supplied Attachments are invalid</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskId0.761760542919103">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.761760542919103" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Task</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mkeywordIds0.5920663597965397">keywordIds</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="keywordIds" id="mkeywordIds0.5920663597965397"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.58808539051087" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.58808539051087">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>A collection of keyword models</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">Keyword {</span>
<div><span class="propName required">Id</span> (<span class="propType">string</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">Id</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.29868546753241243">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.29868546753241243" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Task ID or keywords model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The task cannot be found or the user lacks permissions.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>The supplied Keywords model is incorrect.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskId0.5024088103233828">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.5024088103233828" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Task</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mkeywordIds0.7691777036394993">keywordIds</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="keywordIds" id="mkeywordIds0.7691777036394993"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5598336696646744" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5598336696646744">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>A collection of unique identifiers of the Keywords to remove</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">Keyword {</span>
<div><span class="propName required">Id</span> (<span class="propType">string</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">Id</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.14935105178015262">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.14935105178015262" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Keywords removed successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Task ID or Keyword IDs are invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The task could not be found or the user lacks permissions.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Supplied keywords are invalid</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskId0.4696753298572809">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.4696753298572809" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Task</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskPostCreate0.7754560078759107">taskPostCreate</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="taskPostCreate" id="mtaskPostCreate0.7754560078759107"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.8611137703503693" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.8611137703503693">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Task Post create model</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TaskPost {</span>
<div><span class="propName required">Text</span> (<span class="propType">string</span>),</div>
<div><span class="propName required">TaskAssigneeProfileId</span> (<span class="propType">string</span>),</div>
<div><span class="propWrap"><span class="propName ">PercentageComplete</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>100</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName ">InternalRecipients</span> (<span class="propType">Array[InternalRecipient ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Attachments</span> (<span class="propType">Array[Attachment ]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">InternalRecipient {</span>
<div><span class="propName required">ProfileId</span> (<span class="propType">string</span>),</div>
<div><span class="propWrap"><span class="propName required">Type</span> (<span class="propType">string</span>) = <span class="propVals">['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP', 'SECURITYGROUP']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span><br><span class="strong">Attachment {</span>
<div><span class="propWrap"><span class="propName required">EntityType</span> (<span class="propType">string</span>) = <span class="propVals">['UNDEFINED', 'DOCUMENT']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "DOCUMENT"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">EntityId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">{
"<span class="hljs-attr">Text</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">TaskAssigneeProfileId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">PercentageComplete</span>": <span class="hljs-number">0</span>,
"<span class="hljs-attr">InternalRecipients</span>": [
{
"<span class="hljs-attr">ProfileId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Type</span>": <span class="hljs-string">"UNDEFINED"</span>
}
],
"<span class="hljs-attr">Attachments</span>": [
{
"<span class="hljs-attr">EntityType</span>": <span class="hljs-string">"UNDEFINED"</span>,
"<span class="hljs-attr">EntityId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
]
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.7502099103157298">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.7502099103157298" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Task Post model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The parent entity cannot be found or the user is forbidden access to the parent entity.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown"></td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and use the value of the returned ETag header as
the value of the If-Match header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>The supplied Task Post model contains invalid items.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskId0.03443921030432162">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.03443921030432162" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Task</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mpostId0.9901304096720462">postId</label></td>
<td>
<input class="parameter required" minlength="1" name="postId" placeholder="(required)" id="mpostId0.9901304096720462" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the current post</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.707952579453432">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.707952579453432" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Current post deleted successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Task ID or post ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Task or post cannot be found or the user is forbidden access to this Task.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskId0.8586700057263967">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.8586700057263967" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Task</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrecipients0.8010963127541904">recipients</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="recipients" id="mrecipients0.8010963127541904"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5991326210457628" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5991326210457628">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>A collection of recipient models</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">InternalRecipient {</span>
<div><span class="propName required">ProfileId</span> (<span class="propType">string</span>),</div>
<div><span class="propWrap"><span class="propName required">Type</span> (<span class="propType">string</span>) = <span class="propVals">['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP', 'SECURITYGROUP']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">ProfileId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Type</span>": <span class="hljs-string">"UNDEFINED"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.24949591405078508">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.24949591405078508" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Task ID or recipients model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The task cannot be found or the user lacks permissions.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>The supplied Recipients model is incorrect.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskId0.6668236137319552">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.6668236137319552" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Task</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrecipientIds0.8080674783477024">recipientIds</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="recipientIds" id="mrecipientIds0.8080674783477024"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6714003465300664" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6714003465300664">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>A collection of unique identifiers of the Recipients to remove</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">InternalRecipient {</span>
<div><span class="propName required">ProfileId</span> (<span class="propType">string</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">[
{
"<span class="hljs-attr">ProfileId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.10083013629869897">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.10083013629869897" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">200</td>
<td class="markdown">
<p>Recipients removed successfully.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Task ID or Recipient IDs are invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The task could not be found or the user lacks permissions.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and set the If-Match header to the value of the
returned ETag header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>Supplied Recipients are invalid</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtaskId0.03348971414695168">taskId</label></td>
<td>
<input class="parameter required" minlength="1" name="taskId" placeholder="(required)" id="mtaskId0.03348971414695168" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Task</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mtaskPostCreate0.6161199199021543">taskPostCreate</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="taskPostCreate" id="mtaskPostCreate0.6161199199021543"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.3795222139610217" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.3795222139610217">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Task Post create model</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TaskPost {</span>
<div><span class="propName required">Text</span> (<span class="propType">string</span>),</div>
<div><span class="propName required">TaskAssigneeProfileId</span> (<span class="propType">string</span>),</div>
<div><span class="propWrap"><span class="propName ">PercentageComplete</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>100</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName ">InternalRecipients</span> (<span class="propType">Array[InternalRecipient ]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Attachments</span> (<span class="propType">Array[Attachment ]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">InternalRecipient {</span>
<div><span class="propName required">ProfileId</span> (<span class="propType">string</span>),</div>
<div><span class="propWrap"><span class="propName required">Type</span> (<span class="propType">string</span>) = <span class="propVals">['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP', 'SECURITYGROUP']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span><br><span class="strong">Attachment {</span>
<div><span class="propWrap"><span class="propName required">EntityType</span> (<span class="propType">string</span>) = <span class="propVals">['UNDEFINED', 'DOCUMENT']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"UNDEFINED", "DOCUMENT"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">EntityId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code class="hljs json">{
"<span class="hljs-attr">Text</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">TaskAssigneeProfileId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">PercentageComplete</span>": <span class="hljs-number">0</span>,
"<span class="hljs-attr">InternalRecipients</span>": [
{
"<span class="hljs-attr">ProfileId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>,
"<span class="hljs-attr">Type</span>": <span class="hljs-string">"UNDEFINED"</span>
}
],
"<span class="hljs-attr">Attachments</span>": [
{
"<span class="hljs-attr">EntityType</span>": <span class="hljs-string">"UNDEFINED"</span>,
"<span class="hljs-attr">EntityId</span>": <span class="hljs-string">"00000000-0000-0000-0000-000000000000"</span>
}
]
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required"><label for="mIf-Match0.3748263881547569">If-Match</label></td>
<td>
<input class="parameter required" minlength="1" name="If-Match" placeholder="(required)" id="mIf-Match0.3748263881547569" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Last modified date in ticks</p>
</span></strong>
</td>
<td>header</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Task Post model is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The parent entity cannot be found or the user is forbidden access to the parent entity.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown"></td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td class="markdown">
<p>The value of the If-Match header is not equal to the last modified date of this resource, expressed in ticks. To get the last modified date in ticks, make a GET request for this resource and use the value of the returned ETag header as
the value of the If-Match header.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">422</td>
<td class="markdown">
<p>The supplied Task Post model contains invalid items.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mentityId0.6175442309041899">entityId</label></td>
<td>
<input class="parameter required" minlength="1" name="entityId" placeholder="(required)" id="mentityId0.6175442309041899" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the Entity</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>The supplied Entity ID is invalid.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>The user is not authorised.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>The Entity cannot be found or the user is forbidden access to this Entity.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>Internal Server Error.</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form>Text Content
swagger
For more information on using this API please contact support@4projects.com
Viewpoint for Projects - API
Public API
* DISCUSSIONFOLDERS
* Developer Notes
* Show/Hide
* List Operations
* Expand Operations
* Help
DiscussionFolders may contain Tasks and DiscussionFolders. They can reside
directly under a Project in addition to being the children of other
DiscussionFolders.
* * POST /VFP/API/V1/DISCUSSIONFOLDERS
* Create Discussion Folder
IMPLEMENTATION NOTES
The ParentId is the unique identifier of the Project or Discussion Folder
where the new Discussion Folder is to be created.
OverdueReminderRepeatFrequency can be set to 'Daily', 'Weekly' or
'Monthly'. InternalRecipients types can be 'Profile' or
'DistributionGroup' The DropBoxEmailLocalPart represents the part of the
DropBox email address before the '@' symbol. The domain part of the
DropBox email address (after the '@' symbol) is added automatically by
the system and the complete DropBox email address is returned as the
DropBoxEmailAddress property of the Discussion Folder.
* Authorize
RESPONSE CLASS (STATUS 201)
Discussion Folder created successfully.
* Model
* Example Value
DiscussionFolderV2 {
DiscussionDescriptionMandatory (boolean, optional),
ParentId (string, optional),
Name (string, optional),
Description (string, optional),
DropBoxEmailEnabled (boolean, optional),
DropBoxEmailAddress (string, optional),
Private (boolean, optional),
DaysFrom (integer, optional),
DueDateIsEditable (boolean, optional),
EmailRemindersOn (boolean, optional),
DaysBeforeDueDate (integer, optional),
OverdueRemindersEnabled (boolean, optional),
OverdueReminderRepeatFrequency (string, optional),
EmailReminderRepeatFrequencyOccurrences (integer, optional),
ShortCodeLink (string, optional),
OverdueRemindersNeverEnd (boolean, optional),
InternalRecipients (Array[InternalRecipient ], optional),
CustomFieldGroups (Array[CustomFieldGroup ], optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
InternalRecipient {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
CustomFieldGroup {
GroupId (string, optional),
Name (string, optional),
CustomFields (Array[CustomFieldBase ], optional)
}
CustomFieldBase {
MemberId (string, optional),
Name (string, optional),
Description (string, optional),
Mandatory (boolean, optional),
CustomFieldType (string, optional)
}
{
"DiscussionDescriptionMandatory": true,
"ParentId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"DropBoxEmailEnabled": true,
"DropBoxEmailAddress": "string",
"Private": true,
"DaysFrom": 0,
"DueDateIsEditable": true,
"EmailRemindersOn": true,
"DaysBeforeDueDate": 0,
"OverdueRemindersEnabled": true,
"OverdueReminderRepeatFrequency": "string",
"EmailReminderRepeatFrequencyOccurrences": 0,
"ShortCodeLink": "string",
"OverdueRemindersNeverEnd": true,
"InternalRecipients": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"CustomFieldGroups": [
{
"GroupId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CustomFields": [
{
"MemberId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"Mandatory": true,
"CustomFieldType": "string"
}
]
}
],
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.844Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.844Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type
discussionfolderCreate
Parameter content type: application/json
Discussion Folder create model
body
* Model
* Example Value
DiscussionFolder {
ParentId (string),
Name (string),
Description (string, optional),
DropBoxEmailEnabled (boolean, optional),
DropBoxEmailLocalPart (string, optional),
InternalRecipients (Array[InternalRecipient ], optional),
Private (boolean, optional),
DaysFrom (integer, optional)
integerMin. Value:1Max. Value:99999
,
DueDateIsEditable (boolean, optional),
EmailRemindersOn (boolean, optional),
DaysBeforeDueDate (integer, optional)
integerMax. Value:99999
,
OverdueRemindersEnabled (boolean, optional),
OverdueReminderRepeatFrequency (string, optional) = ['DAILY', 'WEEKLY',
'MONTHLY']
stringEnum:"DAILY", "WEEKLY", "MONTHLY"
,
EmailReminderRepeatFrequencyOccurrences (integer, optional)
integerMax. Value:99999
}
InternalRecipient {
ProfileId (string),
Type (string) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
{
"ParentId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"DropBoxEmailEnabled": true,
"DropBoxEmailLocalPart": "string",
"InternalRecipients": [
{
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Type": "UNDEFINED"
}
],
"Private": true,
"DaysFrom": 0,
"DueDateIsEditable": true,
"EmailRemindersOn": true,
"DaysBeforeDueDate": 0,
"OverdueRemindersEnabled": true,
"OverdueReminderRepeatFrequency": "DAILY",
"EmailReminderRepeatFrequencyOccurrences": 0
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Discussion Folder model is invalid.
401
The user is not authorised.
404
The parent entity cannot be found or the user is forbidden access to the
parent entity.
409
A Discussion Folder matching the supplied Discussion Folder already
exists in the parent entity or the drop box email address is already in
use.
422
The supplied Discussion Folder model contains invalid items.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PATCH /VFP/API/V1/DISCUSSIONFOLDERS/{DISCUSSIONFOLDERID}
* Update a Discussion Folder
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
DiscussionFolderV2 {
DiscussionDescriptionMandatory (boolean, optional),
ParentId (string, optional),
Name (string, optional),
Description (string, optional),
DropBoxEmailEnabled (boolean, optional),
DropBoxEmailAddress (string, optional),
Private (boolean, optional),
DaysFrom (integer, optional),
DueDateIsEditable (boolean, optional),
EmailRemindersOn (boolean, optional),
DaysBeforeDueDate (integer, optional),
OverdueRemindersEnabled (boolean, optional),
OverdueReminderRepeatFrequency (string, optional),
EmailReminderRepeatFrequencyOccurrences (integer, optional),
ShortCodeLink (string, optional),
OverdueRemindersNeverEnd (boolean, optional),
InternalRecipients (Array[InternalRecipient ], optional),
CustomFieldGroups (Array[CustomFieldGroup ], optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
InternalRecipient {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
CustomFieldGroup {
GroupId (string, optional),
Name (string, optional),
CustomFields (Array[CustomFieldBase ], optional)
}
CustomFieldBase {
MemberId (string, optional),
Name (string, optional),
Description (string, optional),
Mandatory (boolean, optional),
CustomFieldType (string, optional)
}
{
"DiscussionDescriptionMandatory": true,
"ParentId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"DropBoxEmailEnabled": true,
"DropBoxEmailAddress": "string",
"Private": true,
"DaysFrom": 0,
"DueDateIsEditable": true,
"EmailRemindersOn": true,
"DaysBeforeDueDate": 0,
"OverdueRemindersEnabled": true,
"OverdueReminderRepeatFrequency": "string",
"EmailReminderRepeatFrequencyOccurrences": 0,
"ShortCodeLink": "string",
"OverdueRemindersNeverEnd": true,
"InternalRecipients": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"CustomFieldGroups": [
{
"GroupId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CustomFields": [
{
"MemberId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"Mandatory": true,
"CustomFieldType": "string"
}
]
}
],
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.855Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.855Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type discussionfolderid
The unique identifier of the Discussion Folder
path string discussionfolderUpdate
Parameter content type: application/json
The update information of the new Discussion Folder
body
* Model
* Example Value
DiscussionFolder {
Name (string, optional),
Description (string, optional),
DropBoxEmailEnabled (boolean, optional),
DropBoxEmailLocalPart (string, optional),
Private (boolean, optional),
DaysFrom (integer, optional)
integerMin. Value:1Max. Value:99999
,
DueDateIsEditable (boolean, optional),
EmailRemindersOn (boolean, optional),
DaysBeforeDueDate (integer, optional)
integerMax. Value:99999
,
OverdueRemindersEnabled (boolean, optional),
OverdueReminderRepeatFrequency (string, optional) = ['DAILY', 'WEEKLY',
'MONTHLY']
stringEnum:"DAILY", "WEEKLY", "MONTHLY"
,
EmailReminderRepeatFrequencyOccurrences (integer, optional)
integerMax. Value:99999
}
{
"Name": "string",
"Description": "string",
"DropBoxEmailEnabled": true,
"DropBoxEmailLocalPart": "string",
"Private": true,
"DaysFrom": 0,
"DueDateIsEditable": true,
"EmailRemindersOn": true,
"DaysBeforeDueDate": 0,
"OverdueRemindersEnabled": true,
"OverdueReminderRepeatFrequency": "DAILY",
"EmailReminderRepeatFrequencyOccurrences": 0
}
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Discussion Folder ID is invalid.
401
The user is not authorised.
404
The Discussion Folder cannot be found or the user is forbidden access to
this Discussion Folder.
409
A Discussion Folder matching the supplied Discussion Folder already
exists in the parent entity or the drop box email address is already in
use.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and use the value of the
returned ETag header as the value of the If-Match header.
422
The supplied Discussion Folder update model contains invalid items.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /VFP/API/V1/DISCUSSIONFOLDERS/{DISCUSSIONFOLDERID}
* Delete a Discussion Folder
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type discussionFolderId
The unique identifier of the Discussion Folder
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
Discussion folder removed successfully.
400
The supplied DiscussionFolder ID is invalid.
401
The user is not authorised.
404
The Discussion Folder cannot be found, or the user is forbidden access to
this Discussion Folder.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/DISCUSSIONFOLDERS/{DISCUSSIONFOLDERID}
* Get a Discussion Folder
WARNING: DEPRECATED
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
DiscussionFolder {
TaskDescriptionMandatory (boolean, optional),
ParentId (string, optional),
Name (string, optional),
Description (string, optional),
DropBoxEmailEnabled (boolean, optional),
DropBoxEmailAddress (string, optional),
Private (boolean, optional),
DaysFrom (integer, optional),
DueDateIsEditable (boolean, optional),
EmailRemindersOn (boolean, optional),
DaysBeforeDueDate (integer, optional),
OverdueRemindersEnabled (boolean, optional),
OverdueReminderRepeatFrequency (string, optional),
EmailReminderRepeatFrequencyOccurrences (integer, optional),
ShortCodeLink (string, optional),
OverdueRemindersNeverEnd (boolean, optional),
InternalRecipients (Array[InternalRecipient ], optional),
CustomFieldGroups (Array[CustomFieldGroup ], optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
InternalRecipient {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
CustomFieldGroup {
GroupId (string, optional),
Name (string, optional),
CustomFields (Array[CustomFieldBase ], optional)
}
CustomFieldBase {
MemberId (string, optional),
Name (string, optional),
Description (string, optional),
Mandatory (boolean, optional),
CustomFieldType (string, optional)
}
{
"TaskDescriptionMandatory": true,
"ParentId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"DropBoxEmailEnabled": true,
"DropBoxEmailAddress": "string",
"Private": true,
"DaysFrom": 0,
"DueDateIsEditable": true,
"EmailRemindersOn": true,
"DaysBeforeDueDate": 0,
"OverdueRemindersEnabled": true,
"OverdueReminderRepeatFrequency": "string",
"EmailReminderRepeatFrequencyOccurrences": 0,
"ShortCodeLink": "string",
"OverdueRemindersNeverEnd": true,
"InternalRecipients": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"CustomFieldGroups": [
{
"GroupId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CustomFields": [
{
"MemberId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"Mandatory": true,
"CustomFieldType": "string"
}
]
}
],
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.863Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.863Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type discussionFolderId
The unique identifier of the Discussion Folder
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Discussion Folder ID is invalid.
401
The user is not authorised.
404
The Discussion Folder cannot be found or the user is forbidden access to
this Discussion Folder.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/DISCUSSIONFOLDERS/{DISCUSSIONFOLDERID}/DISCUSSIONS
* Get available Discussions in a Discussion Folder
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
CreatedBy (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional),
Id (string, optional),
ModifiedBy (string, optional),
Name (string, optional),
ParentId (string, optional),
ParentName (string, optional),
Description (string, optional)
}
[
{
"CreatedBy": "string",
"CreatedAtDateTime": "2024-06-07T11:33:35.867Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.867Z",
"Id": "00000000-0000-0000-0000-000000000000",
"ModifiedBy": "string",
"Name": "string",
"ParentId": "00000000-0000-0000-0000-000000000000",
"ParentName": "string",
"Description": "string"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type discussionFolderId
The unique identifier of the DiscussionFolder
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied DiscussionFolder ID is invalid.
401
The user is not authorised.
404
The DiscussionFolder cannot be found or the user is forbidden access to
this DiscussionFolder.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/DISCUSSIONFOLDERS/{DISCUSSIONFOLDERID}/RECIPIENTS/ADD
* Add Recipients to a Discussion Folder
* Authorize
RESPONSE CLASS (STATUS 200)
Recipients added successfully.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
[
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type discussionFolderId
The unique identifier of the Discussion Folder
path string recipients
Parameter content type: application/json
A collection of recipient models
body
* Model
* Example Value
Array[InternalRecipient {
ProfileId (string),
Type (string) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}]
[
{
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Type": "UNDEFINED"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Discussion Folder ID or recipients model is invalid.
401
The user is not authorised.
404
The discussion folder cannot be found or the user lacks permissions.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
422
Supplied Recipients are invalid
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/DISCUSSIONFOLDERS/{DISCUSSIONFOLDERID}/RECIPIENTS/REMOVE
* Remove Recipients from a Discussion Folder
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type discussionFolderId
The unique identifier of the Discussion Folder
path string recipientIds
Parameter content type: application/json
A collection of unique identifiers of the Recipients to remove
body
* Model
* Example Value
Array[InternalRecipient {
ProfileId (string)
}]
[
{
"ProfileId": "00000000-0000-0000-0000-000000000000"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
Recipients removed successfully.
400
The supplied Discussion Folder ID or Recipient IDs are invalid.
401
The user is not authorised.
404
The discussion folder could not be found or the user lacks permissions.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
422
Supplied Recipients are invalid
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V2/DISCUSSIONFOLDERS/{DISCUSSIONFOLDERID}
* Get a Discussion Folder
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
DiscussionFolderV2 {
DiscussionDescriptionMandatory (boolean, optional),
ParentId (string, optional),
Name (string, optional),
Description (string, optional),
DropBoxEmailEnabled (boolean, optional),
DropBoxEmailAddress (string, optional),
Private (boolean, optional),
DaysFrom (integer, optional),
DueDateIsEditable (boolean, optional),
EmailRemindersOn (boolean, optional),
DaysBeforeDueDate (integer, optional),
OverdueRemindersEnabled (boolean, optional),
OverdueReminderRepeatFrequency (string, optional),
EmailReminderRepeatFrequencyOccurrences (integer, optional),
ShortCodeLink (string, optional),
OverdueRemindersNeverEnd (boolean, optional),
InternalRecipients (Array[InternalRecipient ], optional),
CustomFieldGroups (Array[CustomFieldGroup ], optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
InternalRecipient {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
CustomFieldGroup {
GroupId (string, optional),
Name (string, optional),
CustomFields (Array[CustomFieldBase ], optional)
}
CustomFieldBase {
MemberId (string, optional),
Name (string, optional),
Description (string, optional),
Mandatory (boolean, optional),
CustomFieldType (string, optional)
}
{
"DiscussionDescriptionMandatory": true,
"ParentId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"DropBoxEmailEnabled": true,
"DropBoxEmailAddress": "string",
"Private": true,
"DaysFrom": 0,
"DueDateIsEditable": true,
"EmailRemindersOn": true,
"DaysBeforeDueDate": 0,
"OverdueRemindersEnabled": true,
"OverdueReminderRepeatFrequency": "string",
"EmailReminderRepeatFrequencyOccurrences": 0,
"ShortCodeLink": "string",
"OverdueRemindersNeverEnd": true,
"InternalRecipients": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"CustomFieldGroups": [
{
"GroupId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CustomFields": [
{
"MemberId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"Mandatory": true,
"CustomFieldType": "string"
}
]
}
],
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.876Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.876Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type discussionFolderId
The unique identifier of the Discussion Folder
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Discussion Folder ID is invalid.
401
The user is not authorised.
404
The Discussion Folder cannot be found or the user is forbidden access to
this Discussion Folder.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* DISCUSSIONS
* Developer Notes
* Show/Hide
* List Operations
* Expand Operations
* Help
A Discussion may have one or more Revisions associated with it, with each
Revision representing a post / reply in the discussion. New Discussions must
be assigned a Discussion Name, a priority and include information within the
Text in order to be valid when created. Each post / reply (aka Revision)
added to an existing Discussion must include information within the Text in
order to be valid when created. New Discussions and posts / replies (aka
Revisions) may contain additional recipients and may also include
attachments.
* * POST /VFP/API/V1/DISCUSSIONS
* Create a Discussion
IMPLEMENTATION NOTES
The required fields for creating a Discussion are: ParentId, Name,
Priority, Text. The Attachments, InternalRecipients and Keywords are
optional. The Attachments must be a collection of Attachment models. The
InternalRecipients must be a collection of InternalRecipient models. The
Keywords must be a collection of Keyword models. The ParentId must be a
valid Discussion Folder ID. The Priority must be a valid Priority enum
value.
* Authorize
RESPONSE CLASS (STATUS 201)
Discussion created successfully.
* Model
* Example Value
Discussion {
Name (string, optional),
Description (string, optional),
Private (boolean, optional),
NoDueDate (boolean, optional),
SendEmail (boolean, optional),
ParentId (string, optional),
Keywords (Array[Keyword ], optional),
ShortCode (string, optional),
ShortCodeLink (string, optional),
CurrentPostId (string, optional),
Posts (Array[DiscussionPost ], optional),
State (string, optional),
Attachments (Array[Attachment ], optional),
InternalRecipients (Array[InternalRecipient ], optional),
Text (string, optional),
CustomFieldGroups (Array[CustomFieldGroup ], optional),
DueDate (string, optional),
Priority (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
Keyword {
Name (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
DiscussionPost {
Id (string, optional),
State (string, optional),
ShortCode (string, optional),
InternalRecipients (Array[InternalRecipient ], optional),
Attachments (Array[Attachment ], optional),
PostedDate (string, optional),
PostedBy (User , optional),
Text (string, optional),
Revision (string, optional)
}
Attachment {
Name (string, optional),
Description (string, optional),
EntityType (string, optional),
EntityId (string, optional),
AttachmentId (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
InternalRecipient {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
CustomFieldGroup {
GroupId (string, optional),
Name (string, optional),
CustomFields (Array[CustomFieldBase ], optional)
}
User {
Id (string, optional),
Name (string, optional)
}
CustomFieldBase {
MemberId (string, optional),
Name (string, optional),
Description (string, optional),
Mandatory (boolean, optional),
CustomFieldType (string, optional)
}
{
"Name": "string",
"Description": "string",
"Private": true,
"NoDueDate": true,
"SendEmail": true,
"ParentId": "00000000-0000-0000-0000-000000000000",
"Keywords": [
{
"Name": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.883Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.883Z"
}
],
"ShortCode": "string",
"ShortCodeLink": "string",
"CurrentPostId": "00000000-0000-0000-0000-000000000000",
"Posts": [
{
"Id": "00000000-0000-0000-0000-000000000000",
"State": "string",
"ShortCode": "string",
"InternalRecipients": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"Attachments": [
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.883Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.883Z"
}
],
"PostedDate": "2024-06-07T11:33:35.883Z",
"PostedBy": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"Text": "string",
"Revision": "string"
}
],
"State": "string",
"Attachments": [
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.883Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.883Z"
}
],
"InternalRecipients": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"Text": "string",
"CustomFieldGroups": [
{
"GroupId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CustomFields": [
{
"MemberId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"Mandatory": true,
"CustomFieldType": "string"
}
]
}
],
"DueDate": "2024-06-07T11:33:35.884Z",
"Priority": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.884Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.884Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type discussionCreate
Parameter content type: application/json
Discussion create model
body
* Model
* Example Value
Discussion {
ParentId (string, optional),
Name (string),
Priority (string) = ['HIGH', 'MEDIUM', 'LOW']
stringEnum:"HIGH", "MEDIUM", "LOW"
,
Text (string),
Attachments (Array[Attachment ], optional),
InternalRecipients (Array[InternalRecipient ], optional),
Keywords (Array[Keyword ], optional),
Description (string, optional),
DueDate (string, optional),
Private (boolean, optional),
SendEmail (boolean, optional)
}
Attachment {
EntityType (string) = ['UNDEFINED', 'DOCUMENT']
stringEnum:"UNDEFINED", "DOCUMENT"
,
EntityId (string, optional)
}
InternalRecipient {
ProfileId (string),
Type (string) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
Keyword {
Id (string)
}
{
"ParentId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Priority": "HIGH",
"Text": "string",
"Attachments": [
{
"EntityType": "UNDEFINED",
"EntityId": "00000000-0000-0000-0000-000000000000"
}
],
"InternalRecipients": [
{
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Type": "UNDEFINED"
}
],
"Keywords": [
{
"Id": "00000000-0000-0000-0000-000000000000"
}
],
"Description": "string",
"DueDate": "2024-06-07T11:33:35.886Z",
"Private": true,
"SendEmail": true
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Discussion model is invalid.
401
The user is not authorised.
404
The parent entity cannot be found or the user is forbidden access to the
parent entity.
409
A Discussion matching the supplied Discussion already exists in the
parent entity
422
The supplied Discussion model contains invalid items.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/DISCUSSIONS/{DISCUSSIONID}
* Get a Discussion
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Discussion {
Name (string, optional),
Description (string, optional),
Private (boolean, optional),
NoDueDate (boolean, optional),
SendEmail (boolean, optional),
ParentId (string, optional),
Keywords (Array[Keyword ], optional),
ShortCode (string, optional),
ShortCodeLink (string, optional),
CurrentPostId (string, optional),
Posts (Array[DiscussionPost ], optional),
State (string, optional),
Attachments (Array[Attachment ], optional),
InternalRecipients (Array[InternalRecipient ], optional),
Text (string, optional),
CustomFieldGroups (Array[CustomFieldGroup ], optional),
DueDate (string, optional),
Priority (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
Keyword {
Name (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
DiscussionPost {
Id (string, optional),
State (string, optional),
ShortCode (string, optional),
InternalRecipients (Array[InternalRecipient ], optional),
Attachments (Array[Attachment ], optional),
PostedDate (string, optional),
PostedBy (User , optional),
Text (string, optional),
Revision (string, optional)
}
Attachment {
Name (string, optional),
Description (string, optional),
EntityType (string, optional),
EntityId (string, optional),
AttachmentId (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
InternalRecipient {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
CustomFieldGroup {
GroupId (string, optional),
Name (string, optional),
CustomFields (Array[CustomFieldBase ], optional)
}
User {
Id (string, optional),
Name (string, optional)
}
CustomFieldBase {
MemberId (string, optional),
Name (string, optional),
Description (string, optional),
Mandatory (boolean, optional),
CustomFieldType (string, optional)
}
{
"Name": "string",
"Description": "string",
"Private": true,
"NoDueDate": true,
"SendEmail": true,
"ParentId": "00000000-0000-0000-0000-000000000000",
"Keywords": [
{
"Name": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.889Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.889Z"
}
],
"ShortCode": "string",
"ShortCodeLink": "string",
"CurrentPostId": "00000000-0000-0000-0000-000000000000",
"Posts": [
{
"Id": "00000000-0000-0000-0000-000000000000",
"State": "string",
"ShortCode": "string",
"InternalRecipients": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"Attachments": [
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.889Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.889Z"
}
],
"PostedDate": "2024-06-07T11:33:35.889Z",
"PostedBy": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"Text": "string",
"Revision": "string"
}
],
"State": "string",
"Attachments": [
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.889Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.889Z"
}
],
"InternalRecipients": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"Text": "string",
"CustomFieldGroups": [
{
"GroupId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CustomFields": [
{
"MemberId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"Mandatory": true,
"CustomFieldType": "string"
}
]
}
],
"DueDate": "2024-06-07T11:33:35.889Z",
"Priority": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.889Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.889Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type discussionid
The unique identifier of the Discussion
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Discussion ID is invalid.
401
The user is not authorised.
404
The Discussion cannot be found or the user is forbidden access to this
Discussion.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /VFP/API/V1/DISCUSSIONS/{DISCUSSIONID}
* Delete a Discussion
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type discussionId
The unique identifier of the Discussion
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
Discussion deleted successfully.
400
The supplied Discussion ID is invalid.
401
The user is not authorised.
404
The Discussion cannot be found or the user does not have permission to
access the Discussion.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PATCH /VFP/API/V1/DISCUSSIONS/{DISCUSSIONID}
* Update a Discussion
IMPLEMENTATION NOTES
If moving to a new state and the Text is not provided in the request,
then the Reason is used to populate the Text field.If neither the Text
nor Reason are provided then the a default response such as: "Reopened by
APIV2_Public" will be used to populate the Text field.
If the discussion cannot move to a new state i.e. OPEN to REOPEN and no
Text or Reason is provided then the Text field will be the automated
response to show an edit has occurred.
The columns represent the new state being passed in the request and the
rows represent what state the discussion is currently in.
ReopenCloseClose resolveOpenState unchanged. Update successfulUpdate
successfulUpdate successfulReopenedState unchanged. Update
successfulUpdate successfulUpdate successfulRespondedState unchanged.
Update successfulUpdate successfulUpdate successfulOverdueState changes
to RESONDEDOVERDUE if Text or a reason included in the update.
State stays the same if no Text or a reason included in the update.
State changes to OPEN if a future Duedate is included in the
update.Update successfulUpdate successfulResponded overdueState changes
to RESPONDED if a future Duedate is included in the update.Update
successfulUpdate successfulClosed unresolvedUpdate successfulCannot edit.
Update unsuccessfulCannot edit. Update unsuccessfulClosed resolvedUpdate
successfulCannot edit. Update unsuccessfulCannot edit. Update
unsuccessful
* Authorize
RESPONSE CLASS (STATUS 200)
Discussion updated successfully.
* Model
* Example Value
Discussion {
Name (string, optional),
Description (string, optional),
Private (boolean, optional),
NoDueDate (boolean, optional),
SendEmail (boolean, optional),
ParentId (string, optional),
Keywords (Array[Keyword ], optional),
ShortCode (string, optional),
ShortCodeLink (string, optional),
CurrentPostId (string, optional),
Posts (Array[DiscussionPost ], optional),
State (string, optional),
Attachments (Array[Attachment ], optional),
InternalRecipients (Array[InternalRecipient ], optional),
Text (string, optional),
CustomFieldGroups (Array[CustomFieldGroup ], optional),
DueDate (string, optional),
Priority (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
Keyword {
Name (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
DiscussionPost {
Id (string, optional),
State (string, optional),
ShortCode (string, optional),
InternalRecipients (Array[InternalRecipient ], optional),
Attachments (Array[Attachment ], optional),
PostedDate (string, optional),
PostedBy (User , optional),
Text (string, optional),
Revision (string, optional)
}
Attachment {
Name (string, optional),
Description (string, optional),
EntityType (string, optional),
EntityId (string, optional),
AttachmentId (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
InternalRecipient {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
CustomFieldGroup {
GroupId (string, optional),
Name (string, optional),
CustomFields (Array[CustomFieldBase ], optional)
}
User {
Id (string, optional),
Name (string, optional)
}
CustomFieldBase {
MemberId (string, optional),
Name (string, optional),
Description (string, optional),
Mandatory (boolean, optional),
CustomFieldType (string, optional)
}
{
"Name": "string",
"Description": "string",
"Private": true,
"NoDueDate": true,
"SendEmail": true,
"ParentId": "00000000-0000-0000-0000-000000000000",
"Keywords": [
{
"Name": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.894Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.894Z"
}
],
"ShortCode": "string",
"ShortCodeLink": "string",
"CurrentPostId": "00000000-0000-0000-0000-000000000000",
"Posts": [
{
"Id": "00000000-0000-0000-0000-000000000000",
"State": "string",
"ShortCode": "string",
"InternalRecipients": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"Attachments": [
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.894Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.894Z"
}
],
"PostedDate": "2024-06-07T11:33:35.894Z",
"PostedBy": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"Text": "string",
"Revision": "string"
}
],
"State": "string",
"Attachments": [
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.894Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.894Z"
}
],
"InternalRecipients": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"Text": "string",
"CustomFieldGroups": [
{
"GroupId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CustomFields": [
{
"MemberId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"Mandatory": true,
"CustomFieldType": "string"
}
]
}
],
"DueDate": "2024-06-07T11:33:35.894Z",
"Priority": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.894Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.894Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type discussionId
The unique identifier of the Discussion
path string discussionUpdate
Parameter content type: application/json
Update Discussion model
body
* Model
* Example Value
Discussion {
Name (string, optional),
Text (string, optional),
Description (string, optional),
DueDate (string, optional),
Private (boolean, optional),
SendEmail (boolean, optional),
State (string, optional) = ['Reopen', 'Close', 'CloseResolve']
stringEnum:"Reopen", "Close", "CloseResolve"
}
{
"Name": "string",
"Text": "string",
"Description": "string",
"DueDate": "2024-06-07T11:33:35.898Z",
"Private": true,
"SendEmail": true,
"State": "Reopen"
}
reason
Optional reason
query string If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Discussion model is incorrect.
401
The user is not authorised.
404
The Discussion cannot be found or the user is forbidden access to this
Discussion.
409
A Discussion matching the supplied name exists in this parent entity.
412
Error related to the If-Match header
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/DISCUSSIONS/{DISCUSSIONID}/ATTACHMENTS/ADD
* Add Attachments to a Discussion
* Authorize
RESPONSE CLASS (STATUS 200)
Attachments added successfully.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Name (string, optional),
Description (string, optional),
EntityType (string, optional),
EntityId (string, optional),
AttachmentId (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
[
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.901Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.901Z"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type discussionId
The unique identifier of the Discussion
path string attachments
Parameter content type: application/json
A collection of attachments models
body
* Model
* Example Value
Array[Attachment {
EntityType (string) = ['UNDEFINED', 'DOCUMENT']
stringEnum:"UNDEFINED", "DOCUMENT"
,
EntityId (string, optional)
}]
[
{
"EntityType": "UNDEFINED",
"EntityId": "00000000-0000-0000-0000-000000000000"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Discussion ID or attachments model is invalid.
401
The user is not authorised.
404
The discussion cannot be found or the user lacks permissions.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
422
The supplied Attachments model is incorrect.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/DISCUSSIONS/{DISCUSSIONID}/ATTACHMENTS/REMOVE
* Remove Attachments from a Discussion
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type discussionId
The unique identifier of the Discussion
path string attachmentIds
Parameter content type: application/json
A collection of unique identifiers of the Attachments to remove
body
* Model
* Example Value
Array[Attachment {
AttachmentId (string, optional)
}]
[
{
"AttachmentId": "00000000-0000-0000-0000-000000000000"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
Attachments removed successfully.
400
The supplied Discussion ID or Attachment IDs are invalid.
401
The user is not authorised.
404
The discussion could not be found or the user lacks permissions.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
422
Supplied Attachments are invalid
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/DISCUSSIONS/{DISCUSSIONID}/KEYWORDS/ADD
* Add keywords to a Discussion
* Authorize
RESPONSE CLASS (STATUS 200)
Keywords added successfully.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Name (string, optional),
Id (string, optional)
}
[
{
"Name": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type discussionId
The unique identifier of the Discussion
path string keywordIds
Parameter content type: application/json
A collection of keyword models
body
* Model
* Example Value
Array[Keyword {
Id (string)
}]
[
{
"Id": "00000000-0000-0000-0000-000000000000"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Discussion ID or keywords model is invalid.
401
The user is not authorised.
404
The discussion cannot be found or the user lacks permissions.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
422
The supplied Keywords model is incorrect.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/DISCUSSIONS/{DISCUSSIONID}/KEYWORDS/REMOVE
* Remove keywords from a Discussion
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type discussionId
The unique identifier of the Discussion
path string keywordIds
Parameter content type: application/json
A collection of unique identifiers of the Keywords to remove
body
* Model
* Example Value
Array[Keyword {
Id (string)
}]
[
{
"Id": "00000000-0000-0000-0000-000000000000"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
Keywords removed successfully.
400
The supplied Discussion ID or Keyword IDs are invalid.
401
The user is not authorised.
404
The discussion could not be found or the user lacks permissions.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
422
Supplied keywords are invalid
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/DISCUSSIONS/{DISCUSSIONID}/POST
* Create a Discussion Post
* Authorize
RESPONSE CLASS (STATUS 201)
Discussion Post created successfully.
* Model
* Example Value
Discussion {
Name (string, optional),
Description (string, optional),
Private (boolean, optional),
NoDueDate (boolean, optional),
SendEmail (boolean, optional),
ParentId (string, optional),
Keywords (Array[Keyword ], optional),
ShortCode (string, optional),
ShortCodeLink (string, optional),
CurrentPostId (string, optional),
Posts (Array[DiscussionPost ], optional),
State (string, optional),
Attachments (Array[Attachment ], optional),
InternalRecipients (Array[InternalRecipient ], optional),
Text (string, optional),
CustomFieldGroups (Array[CustomFieldGroup ], optional),
DueDate (string, optional),
Priority (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
Keyword {
Name (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
DiscussionPost {
Id (string, optional),
State (string, optional),
ShortCode (string, optional),
InternalRecipients (Array[InternalRecipient ], optional),
Attachments (Array[Attachment ], optional),
PostedDate (string, optional),
PostedBy (User , optional),
Text (string, optional),
Revision (string, optional)
}
Attachment {
Name (string, optional),
Description (string, optional),
EntityType (string, optional),
EntityId (string, optional),
AttachmentId (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
InternalRecipient {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
CustomFieldGroup {
GroupId (string, optional),
Name (string, optional),
CustomFields (Array[CustomFieldBase ], optional)
}
User {
Id (string, optional),
Name (string, optional)
}
CustomFieldBase {
MemberId (string, optional),
Name (string, optional),
Description (string, optional),
Mandatory (boolean, optional),
CustomFieldType (string, optional)
}
{
"Name": "string",
"Description": "string",
"Private": true,
"NoDueDate": true,
"SendEmail": true,
"ParentId": "00000000-0000-0000-0000-000000000000",
"Keywords": [
{
"Name": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.910Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.910Z"
}
],
"ShortCode": "string",
"ShortCodeLink": "string",
"CurrentPostId": "00000000-0000-0000-0000-000000000000",
"Posts": [
{
"Id": "00000000-0000-0000-0000-000000000000",
"State": "string",
"ShortCode": "string",
"InternalRecipients": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"Attachments": [
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.910Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.910Z"
}
],
"PostedDate": "2024-06-07T11:33:35.910Z",
"PostedBy": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"Text": "string",
"Revision": "string"
}
],
"State": "string",
"Attachments": [
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.910Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.910Z"
}
],
"InternalRecipients": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"Text": "string",
"CustomFieldGroups": [
{
"GroupId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CustomFields": [
{
"MemberId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"Mandatory": true,
"CustomFieldType": "string"
}
]
}
],
"DueDate": "2024-06-07T11:33:35.910Z",
"Priority": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.910Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.910Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type discussionId
The unique identifier of the Discussion
path string discussionPostCreate
Parameter content type: application/json
Discussion Post create model
body
* Model
* Example Value
DiscussionPost {
Text (string),
InternalRecipients (Array[InternalRecipient ], optional),
Attachments (Array[Attachment ], optional)
}
InternalRecipient {
ProfileId (string),
Type (string) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
Attachment {
EntityType (string) = ['UNDEFINED', 'DOCUMENT']
stringEnum:"UNDEFINED", "DOCUMENT"
,
EntityId (string, optional)
}
{
"Text": "string",
"InternalRecipients": [
{
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Type": "UNDEFINED"
}
],
"Attachments": [
{
"EntityType": "UNDEFINED",
"EntityId": "00000000-0000-0000-0000-000000000000"
}
]
}
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Discussion Post model is invalid.
401
The user is not authorised.
404
The parent entity cannot be found or the user is forbidden access to the
parent entity.
409
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and use the value of the
returned ETag header as the value of the If-Match header.
422
The supplied Discussion Post model contains invalid items.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /VFP/API/V1/DISCUSSIONS/{DISCUSSIONID}/POSTS/{POSTID}
* Delete a Discussion's current post
IMPLEMENTATION NOTES
Only the current post can be deleted therefore the postId must be the id
of the current post. If the current post is deleted, the previous post
will become the current post. A discussion must have at least one post.
If the current post is the only post, the request will fail.
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type discussionId
The unique identifier of the Discussion
path string postId
The unique identifier of the current post
path string If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
Current post deleted successfully.
400
The supplied Discussion ID or post ID is invalid.
401
The user is not authorised.
404
The Discussion or post cannot be found or the user is forbidden access to
this Discussion.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/DISCUSSIONS/{DISCUSSIONID}/RECIPIENTS/ADD
* Add Recipients to a Discussion
* Authorize
RESPONSE CLASS (STATUS 200)
Recipients added successfully.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
[
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type discussionId
The unique identifier of the Discussion
path string recipients
Parameter content type: application/json
A collection of recipient models to be added
body
* Model
* Example Value
Array[InternalRecipient {
ProfileId (string),
Type (string) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}]
[
{
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Type": "UNDEFINED"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Discussion ID or recipients model is invalid.
401
The user is not authorised.
404
The Discussion cannot be found or the user lacks permissions.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
422
The supplied Recipients model is incorrect.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/DISCUSSIONS/{DISCUSSIONID}/RECIPIENTS/REMOVE
* Remove Recipients from a Discussion
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type discussionId
The unique identifier of the Discussion
path string recipients
Parameter content type: application/json
A collection of recipient models to be removed
body
* Model
* Example Value
Array[InternalRecipient {
ProfileId (string)
}]
[
{
"ProfileId": "00000000-0000-0000-0000-000000000000"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
Recipients removed successfully.
400
The supplied Discussion ID or Recipient IDs are invalid.
401
The user is not authorised.
404
The Discussion could not be found or the user lacks permissions.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
422
Supplied Recipients are invalid
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* DOCUMENTFOLDERS
* Developer Notes
* Show/Hide
* List Operations
* Expand Operations
* Help
DocumentFolders may contain Documents, DocumentFolders,
StaticVirtualContainers and DynamicVirtualContainers. They can reside
directly under an Enterprise, Site or Project in addition to being the
children of other DocumentFolders.
* * POST /VFP/API/V1/DOCUMENTFOLDERS
* Create a Document Folder
IMPLEMENTATION NOTES
The ParentId is the unique identfier of the Enterprise, Site, Project or
DocumentFolder where the new Document Folder is to be created.
* Authorize
RESPONSE CLASS (STATUS 201)
DocumentFolder created successfully.
* Model
* Example Value
DocumentFolder {
Description (string, optional),
Name (string, optional),
ParentId (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
{
"Description": "string",
"Name": "string",
"ParentId": "00000000-0000-0000-0000-000000000000",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.921Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.921Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type documentFolderCreate
Parameter content type: application/json
Document Folder create model
body
* Model
* Example Value
DocumentFolderCreate {
Description (string, optional),
Name (string),
ParentId (string)
}
{
"Description": "string",
"Name": "string",
"ParentId": "00000000-0000-0000-0000-000000000000"
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied DocumentFolder model is incorrect.
401
The user is not authorised.
404
The parent entity cannot be found or the user is forbidden access to this
parent entity.
409
An DocumentFolder matching the supplied DocumentFolder already exists in
this parent entity.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /VFP/API/V1/DOCUMENTFOLDERS/{DOCUMENTFOLDERID}
* Delete a Document Folder
IMPLEMENTATION NOTES
Caution: Deleting a Document Folder will delete all of its contents.
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type documentFolderId
The unique identifier of the DocumentFolder
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
DocumentFolder deleted successfully.
400
The supplied DocumentFolder ID is invalid.
401
The user is not authorised.
404
The document folder cannot be found or the user is forbidden access to
this DocumentFolder.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/DOCUMENTFOLDERS/{DOCUMENTFOLDERID}
* Get a Document Folder
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
DocumentFolder {
Description (string, optional),
Name (string, optional),
ParentId (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
{
"Description": "string",
"Name": "string",
"ParentId": "00000000-0000-0000-0000-000000000000",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.926Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.926Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type documentFolderId
The unique identifier of the DocumentFolder
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied DocumentFolder ID is invalid.
401
The user is not authorised.
404
The document folder cannot be found or the user is forbidden access to
this DocumentFolder.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PATCH /VFP/API/V1/DOCUMENTFOLDERS/{DOCUMENTFOLDERID}
* Update a Document Folder
* Authorize
RESPONSE CLASS (STATUS 200)
Folder updated successfully.
* Model
* Example Value
DocumentFolder {
Description (string, optional),
Name (string, optional),
ParentId (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
{
"Description": "string",
"Name": "string",
"ParentId": "00000000-0000-0000-0000-000000000000",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.928Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.928Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type documentFolderId
The unique identifier of the DocumentFolder
path string documentFolderUpdate
Parameter content type: application/json
Document Folder update model
body
* Model
* Example Value
DocumentFolderUpdate {
Description (string, optional),
Name (string)
}
{
"Description": "string",
"Name": "string"
}
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied DocumentFolder model is incorrect.
401
The user is not authorised.
404
The document folder cannot be found or the user is forbidden access to
this DocumentFolder.
409
A DocumentFolder matching the supplied DocumentFolder already exists.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/DOCUMENTFOLDERS/{DOCUMENTFOLDERID}/CHILDFOLDERS
* Get all Document Folders in a Document Folder
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
CreatedBy (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional),
Description (string, optional),
FullPath (string, optional),
Id (string, optional),
ModifiedBy (string, optional),
Name (string, optional),
ParentId (string, optional),
ParentName (string, optional),
PrimaryKey (string, optional),
SequenceNumber (string, optional),
State (string, optional)
}
[
{
"CreatedBy": "string",
"CreatedAtDateTime": "2024-06-07T11:33:35.930Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.930Z",
"Description": "string",
"FullPath": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"ModifiedBy": "string",
"Name": "string",
"ParentId": "00000000-0000-0000-0000-000000000000",
"ParentName": "string",
"PrimaryKey": "00000000-0000-0000-0000-000000000000",
"SequenceNumber": "string",
"State": "string"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type documentFolderId
The unique identifier of the DocumentFolder
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied DocumentFolder ID is invalid.
401
The user is not authorised.
404
The document folder cannot be found or the user is forbidden access to
this DocumentFolder.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/DOCUMENTFOLDERS/{DOCUMENTFOLDERID}/DOCUMENTS
* Get all Documents in a Document Folder
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] {
SearchId (string, optional),
CurrentPage (integer, optional),
PageSize (integer, optional),
TotalPages (integer, optional),
TotalRecords (integer, optional),
Documents (Array[DocumentSearchResponse ], optional)
}
DocumentSearchResponse {
Id (string, optional),
Name (string, optional),
Description (string, optional)
}
{
"SearchId": "00000000-0000-0000-0000-000000000000",
"CurrentPage": 0,
"PageSize": 0,
"TotalPages": 0,
"TotalRecords": 0,
"Documents": [
{
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type documentFolderId
The unique identifier of the DocumentFolder
path string page
The current page of the data being displayed. The page index begins at 0
query integer pageSize
The number of documents displayed per results page. The maximum number of
documents which can be displayed in a single page is 3,2767
query integer recursive true false (default)
If true, all Documents in the specified folder and all child document
folders will be returned.
query boolean searchId
Unique identifier which, if provided, caches the search results resulting
in faster paging through the cached search results.
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied DocumentFolder Id is invalid.
401
The user is not authorised.
404
The document folder cannot be found or the user is forbidden access to
this DocumentFolder.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* DOCUMENTS
* Developer Notes
* Show/Hide
* List Operations
* Expand Operations
* Help
A Document may have one or more Revisions associated with it but must always
have a Revision that is marked as Current. Each Revision on the Document may
contain any number of Files, but must always have a file that is marked as
the Primary File for each Revision. Revisions that are not marked as the
current revision for a Document, aka previous revisions, can be accessed via
the Revisions collection. Only the current Revision may be operated on –
previous Revisions on a Document are Read Only.
* * POST /VFP/API/V1/DOCUMENTS
* Create a Document
IMPLEMENTATION NOTES
A Document can only exist under a DocumentFolder, therefore the ParentId
of the new Document must be the Id of a DocumentFolder. A Document must
have at least one Revision, therefore when creating a new Document it's
initial Revision must also be supplied in the same request. The
AuthoredDateTime is assumed to be UTC, please offset it if required.
* Authorize
RESPONSE CLASS (STATUS 201)
Document created successfully.
* Model
* Example Value
Document {
Description (string, optional),
Name (string, optional),
CreatedBy (User , optional),
ModifiedBy (User , optional),
Owner (User , optional),
Revisions (Array[RevisionSummary ], optional),
LinkedLocations (Array[LinkedLocation ], optional),
ParentId (string, optional),
CurrentRevisionId (string, optional),
Workflows (Array[Workflow ], optional),
CurrentWorkflowId (string, optional),
CurrentWorkflowName (string, optional),
RevisionCreatedAtDateTime (string, optional),
AuthoredDateTime (string, optional),
RevisionUpdatedAtDateTime (string, optional),
DefaultStatus (Status , optional),
RevisionAuthor (User , optional),
RevisionReference (string, optional),
Attachments (Array[Attachment ], optional),
CustomFieldGroups (Array[CustomFieldGroup ], optional),
IsNotifyRecipientsByEmail (boolean, optional),
ExternalRecipients (Array[ExternalRecipient ], optional),
Files (Array[File ], optional),
InternalRecipients (Array[InternalRecipient ], optional),
Keywords (Array[Keyword ], optional),
Notes (string, optional),
PrimaryFileId (string, optional),
IsFilesPrivateToRecipients (boolean, optional),
State (string, optional),
RevisionStatus (Status , optional),
RevisionWorkflows (Array[Workflow ], optional),
CurrentRevisionWorkflowId (string, optional),
CurrentRevisionWorkflowName (string, optional),
PercentageComplete (integer, optional),
Classifications (Array[ClassificationGet ], optional),
IsFilePubliclyAvailable (boolean, optional),
PublicLinkExpiry (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
User {
Id (string, optional),
Name (string, optional)
}
RevisionSummary {
Id (string, optional),
CreatedAtDateTime (string, optional),
CreatedById (string, optional),
Reference (string, optional),
ModifiedById (string, optional),
UpdatedAtDateTime (string, optional),
IsCurrentRevision (boolean, optional)
}
LinkedLocation {
Id (string, optional),
Name (string, optional),
AddedDateTime (string, optional)
}
Workflow {
Description (string, optional),
Name (string, optional),
IsCurrentWorkflow (boolean, optional),
StartDateTime (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
Status {
Name (string, optional),
IsDefault (boolean, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
Attachment {
Name (string, optional),
Description (string, optional),
EntityType (string, optional),
EntityId (string, optional),
AttachmentId (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
CustomFieldGroup {
GroupId (string, optional),
Name (string, optional),
CustomFields (Array[CustomFieldBase ], optional)
}
ExternalRecipient {
Name (string, optional)
stringMin. Length:1Max. Length:122
,
Email (string)
}
File {
Name (string),
IsPrimary (boolean, optional),
Status (string, optional),
Size (integer, optional),
Extension (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
InternalRecipient {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
Keyword {
Name (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
ClassificationGet {
UniclassId (string, optional),
Code (string, optional),
Title (string, optional)
}
CustomFieldBase {
MemberId (string, optional),
Name (string, optional),
Description (string, optional),
Mandatory (boolean, optional),
CustomFieldType (string, optional)
}
{
"Description": "string",
"Name": "string",
"CreatedBy": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"ModifiedBy": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"Owner": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"Revisions": [
{
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.934Z",
"CreatedById": "00000000-0000-0000-0000-000000000000",
"Reference": "string",
"ModifiedById": "00000000-0000-0000-0000-000000000000",
"UpdatedAtDateTime": "2024-06-07T11:33:35.934Z",
"IsCurrentRevision": true
}
],
"LinkedLocations": [
{
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"AddedDateTime": "2024-06-07T11:33:35.934Z"
}
],
"ParentId": "00000000-0000-0000-0000-000000000000",
"CurrentRevisionId": "00000000-0000-0000-0000-000000000000",
"Workflows": [
{
"Description": "string",
"Name": "string",
"IsCurrentWorkflow": true,
"StartDateTime": "2024-06-07T11:33:35.934Z",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.934Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.934Z"
}
],
"CurrentWorkflowId": "00000000-0000-0000-0000-000000000000",
"CurrentWorkflowName": "string",
"RevisionCreatedAtDateTime": "2024-06-07T11:33:35.934Z",
"AuthoredDateTime": "2024-06-07T11:33:35.934Z",
"RevisionUpdatedAtDateTime": "2024-06-07T11:33:35.934Z",
"DefaultStatus": {
"Name": "string",
"IsDefault": true,
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.934Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.934Z"
},
"RevisionAuthor": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"RevisionReference": "string",
"Attachments": [
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.934Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.934Z"
}
],
"CustomFieldGroups": [
{
"GroupId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CustomFields": [
{
"MemberId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"Mandatory": true,
"CustomFieldType": "string"
}
]
}
],
"IsNotifyRecipientsByEmail": true,
"ExternalRecipients": [
{
"Name": "string",
"Email": "string"
}
],
"Files": [
{
"Name": "string",
"IsPrimary": true,
"Status": "string",
"Size": 0,
"Extension": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.934Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.934Z"
}
],
"InternalRecipients": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"Keywords": [
{
"Name": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.934Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.934Z"
}
],
"Notes": "string",
"PrimaryFileId": "00000000-0000-0000-0000-000000000000",
"IsFilesPrivateToRecipients": true,
"State": "string",
"RevisionStatus": {
"Name": "string",
"IsDefault": true,
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.934Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.934Z"
},
"RevisionWorkflows": [
{
"Description": "string",
"Name": "string",
"IsCurrentWorkflow": true,
"StartDateTime": "2024-06-07T11:33:35.934Z",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.934Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.934Z"
}
],
"CurrentRevisionWorkflowId": "00000000-0000-0000-0000-000000000000",
"CurrentRevisionWorkflowName": "string",
"PercentageComplete": 0,
"Classifications": [
{
"UniclassId": "00000000-0000-0000-0000-000000000000",
"Code": "string",
"Title": "string"
}
],
"IsFilePubliclyAvailable": true,
"PublicLinkExpiry": "2024-06-07T11:33:35.934Z",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.934Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.934Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type document
Parameter content type: application/json
The document create model
body
* Model
* Example Value
DocumentCreate {
Description (string, optional),
Name (string),
ParentId (string, optional),
LinkedLocations (Array[LinkedLocation ], optional),
Workflows (Array[Workflow ], optional),
OwnerId (string, optional),
IsFilePubliclyAvailable (boolean, optional),
PublicLinkExpiry (string, optional),
RevisionAuthorId (string, optional),
Attachments (Array[Attachment ], optional),
AuthoredDateTime (string, optional),
IsNotifyRecipientsByEmail (boolean, optional),
ExternalRecipients (Array[ExternalRecipient ], optional),
InternalRecipients (Array[InternalRecipient ], optional),
Keywords (Array[Keyword ], optional),
Notes (string, optional),
IsFilesPrivateToRecipients (boolean, optional),
RevisionStatusId (string, optional),
RevisionReference (string, optional),
RevisionWorkflows (Array[Workflow ], optional),
PercentageComplete (integer, optional)
integerMax. Value:100
,
Classifications (Array[Classification ], optional)
}
LinkedLocation {
Id (string, optional)
}
Workflow {
Id (string, optional)
}
Attachment {
EntityType (string) = ['UNDEFINED', 'DOCUMENT']
stringEnum:"UNDEFINED", "DOCUMENT"
,
EntityId (string, optional)
}
ExternalRecipient {
Name (string, optional)
stringMin. Length:1Max. Length:122
,
Email (string)
}
InternalRecipient {
ProfileId (string),
Type (string) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
Keyword {
Id (string)
}
Classification {
UniclassId (string, optional),
Code (string, optional)
}
{
"Description": "string",
"Name": "string",
"ParentId": "00000000-0000-0000-0000-000000000000",
"LinkedLocations": [
{
"Id": "00000000-0000-0000-0000-000000000000"
}
],
"Workflows": [
{
"Id": "00000000-0000-0000-0000-000000000000"
}
],
"OwnerId": "00000000-0000-0000-0000-000000000000",
"IsFilePubliclyAvailable": true,
"PublicLinkExpiry": "2024-06-07T11:33:35.936Z",
"RevisionAuthorId": "00000000-0000-0000-0000-000000000000",
"Attachments": [
{
"EntityType": "UNDEFINED",
"EntityId": "00000000-0000-0000-0000-000000000000"
}
],
"AuthoredDateTime": "2024-06-07T11:33:35.936Z",
"IsNotifyRecipientsByEmail": true,
"ExternalRecipients": [
{
"Name": "string",
"Email": "string"
}
],
"InternalRecipients": [
{
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Type": "UNDEFINED"
}
],
"Keywords": [
{
"Id": "00000000-0000-0000-0000-000000000000"
}
],
"Notes": "string",
"IsFilesPrivateToRecipients": true,
"RevisionStatusId": "00000000-0000-0000-0000-000000000000",
"RevisionReference": "string",
"RevisionWorkflows": [
{
"Id": "00000000-0000-0000-0000-000000000000"
}
],
"PercentageComplete": 0,
"Classifications": [
{
"UniclassId": "00000000-0000-0000-0000-000000000000",
"Code": "string"
}
]
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Document model is invalid.
401
The user is not authorised.
404
The document folder cannot be found or the user does not have permission
to access the document folder.
409
A Document matching the supplied Document already exists.
422
The supplied Document model is incorrect.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /VFP/API/V1/DOCUMENTS/{DOCUMENTID}
* Delete a Document
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The unique identifier of the Document
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
Document deleted successfully.
400
The supplied Document ID is invalid.
401
The user is not authorised.
404
The document cannot be found or the user does not have permission to
access the document.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/DOCUMENTS/{DOCUMENTID}
* Get a Document
IMPLEMENTATION NOTES
CustomFields list can return different custom field objects please refer
to the custom field endpoint for more information.
* Authorize
RESPONSE CLASS (STATUS 200)
Document retrieved successfully.
* Model
* Example Value
Document {
Description (string, optional),
Name (string, optional),
CreatedBy (User , optional),
ModifiedBy (User , optional),
Owner (User , optional),
Revisions (Array[RevisionSummary ], optional),
LinkedLocations (Array[LinkedLocation ], optional),
ParentId (string, optional),
CurrentRevisionId (string, optional),
Workflows (Array[Workflow ], optional),
CurrentWorkflowId (string, optional),
CurrentWorkflowName (string, optional),
RevisionCreatedAtDateTime (string, optional),
AuthoredDateTime (string, optional),
RevisionUpdatedAtDateTime (string, optional),
DefaultStatus (Status , optional),
RevisionAuthor (User , optional),
RevisionReference (string, optional),
Attachments (Array[Attachment ], optional),
CustomFieldGroups (Array[CustomFieldGroup ], optional),
IsNotifyRecipientsByEmail (boolean, optional),
ExternalRecipients (Array[ExternalRecipient ], optional),
Files (Array[File ], optional),
InternalRecipients (Array[InternalRecipient ], optional),
Keywords (Array[Keyword ], optional),
Notes (string, optional),
PrimaryFileId (string, optional),
IsFilesPrivateToRecipients (boolean, optional),
State (string, optional),
RevisionStatus (Status , optional),
RevisionWorkflows (Array[Workflow ], optional),
CurrentRevisionWorkflowId (string, optional),
CurrentRevisionWorkflowName (string, optional),
PercentageComplete (integer, optional),
Classifications (Array[ClassificationGet ], optional),
IsFilePubliclyAvailable (boolean, optional),
PublicLinkExpiry (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
User {
Id (string, optional),
Name (string, optional)
}
RevisionSummary {
Id (string, optional),
CreatedAtDateTime (string, optional),
CreatedById (string, optional),
Reference (string, optional),
ModifiedById (string, optional),
UpdatedAtDateTime (string, optional),
IsCurrentRevision (boolean, optional)
}
LinkedLocation {
Id (string, optional),
Name (string, optional),
AddedDateTime (string, optional)
}
Workflow {
Description (string, optional),
Name (string, optional),
IsCurrentWorkflow (boolean, optional),
StartDateTime (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
Status {
Name (string, optional),
IsDefault (boolean, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
Attachment {
Name (string, optional),
Description (string, optional),
EntityType (string, optional),
EntityId (string, optional),
AttachmentId (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
CustomFieldGroup {
GroupId (string, optional),
Name (string, optional),
CustomFields (Array[CustomFieldBase ], optional)
}
ExternalRecipient {
Name (string, optional)
stringMin. Length:1Max. Length:122
,
Email (string)
}
File {
Name (string),
IsPrimary (boolean, optional),
Status (string, optional),
Size (integer, optional),
Extension (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
InternalRecipient {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
Keyword {
Name (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
ClassificationGet {
UniclassId (string, optional),
Code (string, optional),
Title (string, optional)
}
CustomFieldBase {
MemberId (string, optional),
Name (string, optional),
Description (string, optional),
Mandatory (boolean, optional),
CustomFieldType (string, optional)
}
{
"Description": "string",
"Name": "string",
"CreatedBy": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"ModifiedBy": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"Owner": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"Revisions": [
{
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.939Z",
"CreatedById": "00000000-0000-0000-0000-000000000000",
"Reference": "string",
"ModifiedById": "00000000-0000-0000-0000-000000000000",
"UpdatedAtDateTime": "2024-06-07T11:33:35.939Z",
"IsCurrentRevision": true
}
],
"LinkedLocations": [
{
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"AddedDateTime": "2024-06-07T11:33:35.939Z"
}
],
"ParentId": "00000000-0000-0000-0000-000000000000",
"CurrentRevisionId": "00000000-0000-0000-0000-000000000000",
"Workflows": [
{
"Description": "string",
"Name": "string",
"IsCurrentWorkflow": true,
"StartDateTime": "2024-06-07T11:33:35.939Z",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.939Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.939Z"
}
],
"CurrentWorkflowId": "00000000-0000-0000-0000-000000000000",
"CurrentWorkflowName": "string",
"RevisionCreatedAtDateTime": "2024-06-07T11:33:35.939Z",
"AuthoredDateTime": "2024-06-07T11:33:35.939Z",
"RevisionUpdatedAtDateTime": "2024-06-07T11:33:35.939Z",
"DefaultStatus": {
"Name": "string",
"IsDefault": true,
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.939Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.939Z"
},
"RevisionAuthor": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"RevisionReference": "string",
"Attachments": [
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.939Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.939Z"
}
],
"CustomFieldGroups": [
{
"GroupId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CustomFields": [
{
"MemberId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"Mandatory": true,
"CustomFieldType": "string"
}
]
}
],
"IsNotifyRecipientsByEmail": true,
"ExternalRecipients": [
{
"Name": "string",
"Email": "string"
}
],
"Files": [
{
"Name": "string",
"IsPrimary": true,
"Status": "string",
"Size": 0,
"Extension": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.939Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.939Z"
}
],
"InternalRecipients": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"Keywords": [
{
"Name": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.939Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.939Z"
}
],
"Notes": "string",
"PrimaryFileId": "00000000-0000-0000-0000-000000000000",
"IsFilesPrivateToRecipients": true,
"State": "string",
"RevisionStatus": {
"Name": "string",
"IsDefault": true,
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.939Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.939Z"
},
"RevisionWorkflows": [
{
"Description": "string",
"Name": "string",
"IsCurrentWorkflow": true,
"StartDateTime": "2024-06-07T11:33:35.939Z",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.939Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.939Z"
}
],
"CurrentRevisionWorkflowId": "00000000-0000-0000-0000-000000000000",
"CurrentRevisionWorkflowName": "string",
"PercentageComplete": 0,
"Classifications": [
{
"UniclassId": "00000000-0000-0000-0000-000000000000",
"Code": "string",
"Title": "string"
}
],
"IsFilePubliclyAvailable": true,
"PublicLinkExpiry": "2024-06-07T11:33:35.939Z",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.939Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.939Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The unique identifier of the Document
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Document ID is invalid.
401
The user is not authorised.
404
The document cannot be found or the user does not have permission to
access the document.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PATCH /VFP/API/V1/DOCUMENTS/{DOCUMENTID}
* Update a Document
* Authorize
RESPONSE CLASS (STATUS 200)
Document updated successfully.
* Model
* Example Value
Document {
Description (string, optional),
Name (string, optional),
CreatedBy (User , optional),
ModifiedBy (User , optional),
Owner (User , optional),
Revisions (Array[RevisionSummary ], optional),
LinkedLocations (Array[LinkedLocation ], optional),
ParentId (string, optional),
CurrentRevisionId (string, optional),
Workflows (Array[Workflow ], optional),
CurrentWorkflowId (string, optional),
CurrentWorkflowName (string, optional),
RevisionCreatedAtDateTime (string, optional),
AuthoredDateTime (string, optional),
RevisionUpdatedAtDateTime (string, optional),
DefaultStatus (Status , optional),
RevisionAuthor (User , optional),
RevisionReference (string, optional),
Attachments (Array[Attachment ], optional),
CustomFieldGroups (Array[CustomFieldGroup ], optional),
IsNotifyRecipientsByEmail (boolean, optional),
ExternalRecipients (Array[ExternalRecipient ], optional),
Files (Array[File ], optional),
InternalRecipients (Array[InternalRecipient ], optional),
Keywords (Array[Keyword ], optional),
Notes (string, optional),
PrimaryFileId (string, optional),
IsFilesPrivateToRecipients (boolean, optional),
State (string, optional),
RevisionStatus (Status , optional),
RevisionWorkflows (Array[Workflow ], optional),
CurrentRevisionWorkflowId (string, optional),
CurrentRevisionWorkflowName (string, optional),
PercentageComplete (integer, optional),
Classifications (Array[ClassificationGet ], optional),
IsFilePubliclyAvailable (boolean, optional),
PublicLinkExpiry (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
User {
Id (string, optional),
Name (string, optional)
}
RevisionSummary {
Id (string, optional),
CreatedAtDateTime (string, optional),
CreatedById (string, optional),
Reference (string, optional),
ModifiedById (string, optional),
UpdatedAtDateTime (string, optional),
IsCurrentRevision (boolean, optional)
}
LinkedLocation {
Id (string, optional),
Name (string, optional),
AddedDateTime (string, optional)
}
Workflow {
Description (string, optional),
Name (string, optional),
IsCurrentWorkflow (boolean, optional),
StartDateTime (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
Status {
Name (string, optional),
IsDefault (boolean, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
Attachment {
Name (string, optional),
Description (string, optional),
EntityType (string, optional),
EntityId (string, optional),
AttachmentId (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
CustomFieldGroup {
GroupId (string, optional),
Name (string, optional),
CustomFields (Array[CustomFieldBase ], optional)
}
ExternalRecipient {
Name (string, optional)
stringMin. Length:1Max. Length:122
,
Email (string)
}
File {
Name (string),
IsPrimary (boolean, optional),
Status (string, optional),
Size (integer, optional),
Extension (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
InternalRecipient {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
Keyword {
Name (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
ClassificationGet {
UniclassId (string, optional),
Code (string, optional),
Title (string, optional)
}
CustomFieldBase {
MemberId (string, optional),
Name (string, optional),
Description (string, optional),
Mandatory (boolean, optional),
CustomFieldType (string, optional)
}
{
"Description": "string",
"Name": "string",
"CreatedBy": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"ModifiedBy": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"Owner": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"Revisions": [
{
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.942Z",
"CreatedById": "00000000-0000-0000-0000-000000000000",
"Reference": "string",
"ModifiedById": "00000000-0000-0000-0000-000000000000",
"UpdatedAtDateTime": "2024-06-07T11:33:35.942Z",
"IsCurrentRevision": true
}
],
"LinkedLocations": [
{
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"AddedDateTime": "2024-06-07T11:33:35.942Z"
}
],
"ParentId": "00000000-0000-0000-0000-000000000000",
"CurrentRevisionId": "00000000-0000-0000-0000-000000000000",
"Workflows": [
{
"Description": "string",
"Name": "string",
"IsCurrentWorkflow": true,
"StartDateTime": "2024-06-07T11:33:35.942Z",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.942Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.942Z"
}
],
"CurrentWorkflowId": "00000000-0000-0000-0000-000000000000",
"CurrentWorkflowName": "string",
"RevisionCreatedAtDateTime": "2024-06-07T11:33:35.942Z",
"AuthoredDateTime": "2024-06-07T11:33:35.942Z",
"RevisionUpdatedAtDateTime": "2024-06-07T11:33:35.942Z",
"DefaultStatus": {
"Name": "string",
"IsDefault": true,
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.942Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.942Z"
},
"RevisionAuthor": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"RevisionReference": "string",
"Attachments": [
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.942Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.942Z"
}
],
"CustomFieldGroups": [
{
"GroupId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CustomFields": [
{
"MemberId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"Mandatory": true,
"CustomFieldType": "string"
}
]
}
],
"IsNotifyRecipientsByEmail": true,
"ExternalRecipients": [
{
"Name": "string",
"Email": "string"
}
],
"Files": [
{
"Name": "string",
"IsPrimary": true,
"Status": "string",
"Size": 0,
"Extension": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.942Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.942Z"
}
],
"InternalRecipients": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"Keywords": [
{
"Name": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.942Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.942Z"
}
],
"Notes": "string",
"PrimaryFileId": "00000000-0000-0000-0000-000000000000",
"IsFilesPrivateToRecipients": true,
"State": "string",
"RevisionStatus": {
"Name": "string",
"IsDefault": true,
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.942Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.942Z"
},
"RevisionWorkflows": [
{
"Description": "string",
"Name": "string",
"IsCurrentWorkflow": true,
"StartDateTime": "2024-06-07T11:33:35.942Z",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.942Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.942Z"
}
],
"CurrentRevisionWorkflowId": "00000000-0000-0000-0000-000000000000",
"CurrentRevisionWorkflowName": "string",
"PercentageComplete": 0,
"Classifications": [
{
"UniclassId": "00000000-0000-0000-0000-000000000000",
"Code": "string",
"Title": "string"
}
],
"IsFilePubliclyAvailable": true,
"PublicLinkExpiry": "2024-06-07T11:33:35.942Z",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.942Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.942Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The unique identifier of the Document
path string documentUpdate
Parameter content type: application/json
The document update model
body
* Model
* Example Value
DocumentUpdate {
Description (string, optional),
Name (string, optional),
OwnerId (string, optional),
CurrentRevisionId (string, optional),
RevisionAuthorId (string, optional),
AuthoredDateTime (string, optional),
IsNotifyRecipientsByEmail (boolean, optional),
Notes (string, optional),
IsFilesPrivateToRecipients (boolean, optional),
RevisionStatusId (string, optional),
RevisionReference (string, optional),
IsFilePubliclyAvailable (boolean, optional),
PublicLinkExpiry (string, optional),
PercentageComplete (integer, optional)
integerMax. Value:100
}
{
"Description": "string",
"Name": "string",
"OwnerId": "00000000-0000-0000-0000-000000000000",
"CurrentRevisionId": "00000000-0000-0000-0000-000000000000",
"RevisionAuthorId": "00000000-0000-0000-0000-000000000000",
"AuthoredDateTime": "2024-06-07T11:33:35.947Z",
"IsNotifyRecipientsByEmail": true,
"Notes": "string",
"IsFilesPrivateToRecipients": true,
"RevisionStatusId": "00000000-0000-0000-0000-000000000000",
"RevisionReference": "string",
"IsFilePubliclyAvailable": true,
"PublicLinkExpiry": "2024-06-07T11:33:35.947Z",
"PercentageComplete": 0
}
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Document ID or Document model is invalid.
401
The user is not authorised.
404
The document cannot be found or the user does not have permission to
access the document.
409
A Document matching the supplied Document already exists.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and use the value of the
returned ETag header as the value of the If-Match header.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/DOCUMENTS/{DOCUMENTID}/ATTACHMENTS
* Get attachments from a Document's current revision
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Name (string, optional),
Description (string, optional),
EntityType (string, optional),
EntityId (string, optional),
AttachmentId (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
[
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.949Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.949Z"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The unique identifier of the Document
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Document ID is invalid.
401
The user is not authorised.
404
The document cannot be found or the user does not have permission to
access the document.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/DOCUMENTS/{DOCUMENTID}/ATTACHMENTS/{ATTACHMENTID}
* Get attachment from Documents current revision
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Attachment {
Name (string, optional),
Description (string, optional),
EntityType (string, optional),
EntityId (string, optional),
AttachmentId (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.950Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.950Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The unique identifier of the Document
path string attachmentId
The unique identifier of the Attachment
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Document ID or Attachment ID is invalid.
401
The user is not authorised.
404
The document or attachment cannot be found or the user does not have
permission to access either.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/DOCUMENTS/{DOCUMENTID}/ATTACHMENTS/ADD
* Add attachments to a Document's current revision
* Authorize
RESPONSE CLASS (STATUS 200)
Added attachment(s) to the specified document's current revision
successfully.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Name (string, optional),
Description (string, optional),
EntityType (string, optional),
EntityId (string, optional),
AttachmentId (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
[
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.952Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.952Z"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The unique identifier of the Document
path string attachments
Parameter content type: application/json
The collection of attachments
body
* Model
* Example Value
Array[Attachment {
EntityType (string) = ['UNDEFINED', 'DOCUMENT']
stringEnum:"UNDEFINED", "DOCUMENT"
,
EntityId (string, optional)
}]
[
{
"EntityType": "UNDEFINED",
"EntityId": "00000000-0000-0000-0000-000000000000"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Document ID or Attachment model is invalid.
401
The user is not authorised.
404
The document cannot be found or the user does not have permission to
access the document.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
422
Error saving updated revision
500
Internal server error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/DOCUMENTS/{DOCUMENTID}/ATTACHMENTS/REMOVE
* Remove attachments from a Document's current revision
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The unique identifier of the Document
path string attachments
Parameter content type: application/json
The collection of attachments
body
* Model
* Example Value
Array[Attachment {
AttachmentId (string, optional)
}]
[
{
"AttachmentId": "00000000-0000-0000-0000-000000000000"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
Removed attachment(s) from the specified document's current revision
successfully.
400
The supplied Document ID or Attachment model is invalid.
401
The user is not authorised.
404
The document or document revision cannot be found or the user is
forbidden access to this document.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
422
Error saving updated revision.
500
Internal server error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/DOCUMENTS/{DOCUMENTID}/CLASSIFICATIONS/ADD
* Add classifications to a Document's current revision
* Authorize
RESPONSE CLASS (STATUS 200)
Classifications added successfully.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
UniclassId (string, optional),
Code (string, optional),
Title (string, optional)
}
[
{
"UniclassId": "00000000-0000-0000-0000-000000000000",
"Code": "string",
"Title": "string"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The unique identifier of the Document
path string classifications
Parameter content type: application/json
A collection of Classifications
body
* Model
* Example Value
Array[Classification {
UniclassId (string, optional),
Code (string, optional)
}]
[
{
"UniclassId": "00000000-0000-0000-0000-000000000000",
"Code": "string"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Document ID or classifications model is invalid.
401
The user is not authorised.
404
The document or revision cannot be found or the user does not have
permission to access either.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
422
The supplied Classification(s) is invalid.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/DOCUMENTS/{DOCUMENTID}/CLASSIFICATIONS/REMOVE
* Remove classifications from a Document's current revision
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The unique identifier of the Document
path string classifications
Parameter content type: application/json
A collection of Classifications to be removed
body
* Model
* Example Value
Array[Classification {
UniclassId (string, optional),
Code (string, optional)
}]
[
{
"UniclassId": "00000000-0000-0000-0000-000000000000",
"Code": "string"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
Classifications removed successfully.
400
The supplied Document ID or Classification IDs are invalid.
401
The user is not authorised.
404
The document or classifications could not be found or the user is
forbidden access to this document.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
422
Supplied classifications are invalid
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/DOCUMENTS/{DOCUMENTID}/CUSTOMFIELDS
* Get custom fields from a Document's current revision
IMPLEMENTATION NOTES
When AcceptableValues collection is empty, any value can be used
providing it complies with the MinCharacters, MaxCharacters and
CustomFieldDataType requirements. These Custom Field types will return
these additional properties
Date and Bool Custom Fields Include-
String: Value
Text Custom Field Includes-
List of string: Options
int: MaximumLength
int: MinimumLength
string: InputMethod
string: Value
Numeric Custom Field Includes-
int: MaximumLength
int: MinimumLength
string: Value
* Authorize
RESPONSE CLASS (STATUS 200)
Successfully returned custom fields.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
GroupId (string, optional),
Name (string, optional),
CustomFields (Array[CustomFieldBase ], optional)
}
CustomFieldBase {
MemberId (string, optional),
Name (string, optional),
Description (string, optional),
Mandatory (boolean, optional),
CustomFieldType (string, optional)
}
[
{
"GroupId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CustomFields": [
{
"MemberId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"Mandatory": true,
"CustomFieldType": "string"
}
]
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The unique identifier of the Document
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Document ID is invalid.
401
The user is not authorised.
404
The document cannot be found or the user does not have permission to
access the document.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/DOCUMENTS/{DOCUMENTID}/EXTERNALRECIPIENTS/ADD
* Add external recipients to a Document's current revision
* Authorize
RESPONSE CLASS (STATUS 200)
External recipients added to current revision successfully.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Name (string, optional)
stringMin. Length:1Max. Length:122
,
Email (string)
}
[
{
"Name": "string",
"Email": "string"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The unique identifier of the Document
path string externalRecipients
Parameter content type: application/json
The external recipients model
body
* Model
* Example Value
Array[ExternalRecipient {
Name (string, optional)
stringMin. Length:1Max. Length:122
,
Email (string)
}]
[
{
"Name": "string",
"Email": "string"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Document ID or Recipient model is invalid.
401
The user is not authorised.
404
The document cannot be found or the user does not have permission to
access the document.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/DOCUMENTS/{DOCUMENTID}/EXTERNALRECIPIENTS/REMOVE
* Remove external recipients from Documents current revision
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The unique identifier of the Document
path string externalRecipients
Parameter content type: application/json
The collection of external recipient email addresses
body
* Model
* Example Value
Array[ExternalRecipient {
Email (string)
}]
[
{
"Email": "string"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
External recipients removed from current revision successfully.
400
The supplied Document ID or Recipient model is invalid.
401
The user is not authorised.
404
The document cannot be found or the user does not have permission to
access the document.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
422
The supplied External recipients are invalid
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/DOCUMENTS/{DOCUMENTID}/FILES
* Add a file to a Document's current revision (create a temporary upload
URL for a file)
IMPLEMENTATION NOTES
Creates and returns a temporary upload URL for a file to be uploaded to.
The upload of the file to the URL, using a PUT request, must start before
the expiry time of the URL. Once uploaded, the file will be processed and
will be added to the specified Document's current revision files
collection. The processing of the file may take several minutes. During
processing the file will be visible in the files collection of the
Document's current revision with a zero byte filesize, will be marked as
'Pending' and will not be available to download. Once processing is
successfully completed, the file will be available for download and will
display its actual filesize.
* Authorize
RESPONSE CLASS (STATUS 200)
Temporary upload URL created successfully.
* Model
* Example Value
FileUpload {
Url (string, optional),
UrlExpiryInMinutes (integer, optional)
}
{
"Url": "string",
"UrlExpiryInMinutes": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The unique identifier of the Document
path string fileUpload
Parameter content type: application/json
The file upload model. The FileName property must include the file
extension.
body
* Model
* Example Value
FileUpload {
FileName (string)
stringMax. Length:256
}
{
"FileName": "string"
}
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Document ID or file model is invalid.
401
The user is not authorised.
404
The document cannot be found or the user does not have permission to
access the document.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /VFP/API/V1/DOCUMENTS/{DOCUMENTID}/FILES/{FILEID}
* Delete a File from a Document's current revision
IMPLEMENTATION NOTES
Deletes a file from a Document's current revision, provided that the file
is not the only file in the current revision as that file will be the
primary file. If the file is successfully deleted, the next file in the
current revision will be made the primary file.
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The unique identifier of the Document
path string fileId
The unique identifier of the File
path string If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
File removed successfully from revision in Document.
400
The supplied Document ID or File ID is invalid.
401
The user is not authorised.
404
The document or file cannot be found, or the user does not have
permission to access either.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PATCH /VFP/API/V1/DOCUMENTS/{DOCUMENTID}/FILES/{FILEID}
* Make a file the primary file
IMPLEMENTATION NOTES
Make a file the primary file for the current revision of a document. The
file must already exist in the current revision.
* Authorize
RESPONSE CLASS (STATUS 200)
File updated successfully.
* Model
* Example Value
File {
Name (string),
IsPrimary (boolean, optional),
Status (string, optional),
Size (integer, optional),
Extension (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
{
"Name": "string",
"IsPrimary": true,
"Status": "string",
"Size": 0,
"Extension": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.969Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.969Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The unique identifier of the Document
path string fileId
The unique identifier of the File
path string fileUpdate
Parameter content type: application/json
The file update model
body
* Model
* Example Value
FileUpdate {
IsPrimary (boolean, optional)
}
{
"IsPrimary": true
}
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Document ID, Revision ID, File ID or file Update model is
invalid.
401
The user is not authorised.
404
The document, revision or file cannot be found or the user does not have
permission to access the document, revision or file.
409
A file matching the supplied Document already exists.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/DOCUMENTS/{DOCUMENTID}/KEYWORDS/ADD
* Add keywords to a Document's current revision
* Authorize
RESPONSE CLASS (STATUS 200)
Keywords added successfully.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Name (string, optional),
Id (string, optional)
}
[
{
"Name": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The unique identifier of the Document
path string keywordIds
Parameter content type: application/json
A collection of keyword models
body
* Model
* Example Value
Array[Keyword {
Id (string)
}]
[
{
"Id": "00000000-0000-0000-0000-000000000000"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Document ID or keywords model is invalid.
401
The user is not authorised.
404
The document or revision cannot be found or the user does not have
permission to access either.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
422
The supplied Keywords model is incorrect.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/DOCUMENTS/{DOCUMENTID}/KEYWORDS/REMOVE
* Remove keywords from a Document's current revision
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The unique identifier of the Document
path string keywordIds
Parameter content type: application/json
A collection of unique identifiers of the Keywords to remove
body
* Model
* Example Value
Array[Keyword {
Id (string)
}]
[
{
"Id": "00000000-0000-0000-0000-000000000000"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
Keywords removed successfully.
400
The supplied Document ID or Keyword IDs are invalid.
401
The user is not authorised.
404
The document or keywords could not be found or the user is forbidden
access to this document.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
422
Supplied keywords are invalid
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/DOCUMENTS/{DOCUMENTID}/LINKEDLOCATIONS
* Get a Document's linked locations
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Id (string, optional),
Name (string, optional),
AddedDateTime (string, optional)
}
[
{
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"AddedDateTime": "2024-06-07T11:33:35.975Z"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The unique identifier of the Document
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Document ID is invalid.
401
The user is not authorised.
404
The document cannot be found or the user is forbidden access the
document.
500
Internal Server Error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/DOCUMENTS/{DOCUMENTID}/LINKEDLOCATIONS/{LINKEDLOCATIONID}
* Get a linked location from a Document
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
LinkedLocation {
Id (string, optional),
Name (string, optional),
AddedDateTime (string, optional)
}
{
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"AddedDateTime": "2024-06-07T11:33:35.977Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The unique identifier of the Document
path string linkedLocationId
The unique identifier of the Location
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Document ID or linked location ID is invalid.
401
The user is not authorised.
404
The document or linked location cannot be found or the user is forbidden
access to either.
500
Internal Server Error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/DOCUMENTS/{DOCUMENTID}/LINKEDLOCATIONS/ADD
* Link a Document to Document Folder(s)
IMPLEMENTATION NOTES
Links a Document to one or several Document Folders.
* Authorize
RESPONSE CLASS (STATUS 200)
Linked locations added successfully.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Id (string, optional),
Name (string, optional),
AddedDateTime (string, optional)
}
[
{
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"AddedDateTime": "2024-06-07T11:33:35.978Z"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The unique identifier of the Document
path string linkedLocations
Parameter content type: application/json
A collection of Document Folders unique identifiers to link the Document
to
body
* Model
* Example Value
Array[LinkedLocation {
Id (string, optional)
}]
[
{
"Id": "00000000-0000-0000-0000-000000000000"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Document ID or linked location model is invalid.
401
The user is not authorised.
404
The document cannot be found or the user does not have permission to
access the document.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
422
The supplied Linked Location is invalid
500
Internal Server Error
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/DOCUMENTS/{DOCUMENTID}/LINKEDLOCATIONS/REMOVE
* Unlink a Document from Document Folder(s)
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The unique identifier of the Document
path string linkedLocationIds
Parameter content type: application/json
A collection of unique identifiers of the Linked locations
body
* Model
* Example Value
Array[LinkedLocation {
LinkedLocationId (string, optional)
}]
[
{
"LinkedLocationId": "00000000-0000-0000-0000-000000000000"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
Linked Locations removed successfully from Document.
400
The supplied Document ID or linked location ID is invalid.
401
The user is not authorised.
404
The document cannot be found or the user does not have permission to
access the document.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
422
The supplied Linked Location is invalid.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/DOCUMENTS/{DOCUMENTID}/RECIPIENTS/ADD
* Add internal recipients to a Document's current revision
IMPLEMENTATION NOTES
The acceptable enumerated types for the internal recipient are 0 =
PROFILE or 19 = DISTRIBUTIONGROUP. Either the numeric or string value of
the type is an acceptable value for the internal recipient Type property.
* Authorize
RESPONSE CLASS (STATUS 200)
Internal recipients added to current revision successfully.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
[
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The unique identifier of the Document
path string internalRecipients
Parameter content type: application/json
A collection of internal recipients
body
* Model
* Example Value
Array[InternalRecipient {
ProfileId (string),
Type (string) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}]
[
{
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Type": "UNDEFINED"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Document ID is invalid or supplied Internal recipient model
is incorrect.
401
The user is not authorised.
404
The document or revision cannot be found or the user is forbidden access
to this document.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
422
The supplied Internal recipient is invalid
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/DOCUMENTS/{DOCUMENTID}/RECIPIENTS/REMOVE
* Remove internal recipients from a Document's current revision
IMPLEMENTATION NOTES
id of the document is required to access the current revision
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The unique identifier of the Document
path string internalRecipients
Parameter content type: application/json
A collection of internal recipients
body
* Model
* Example Value
Array[InternalRecipient {
ProfileId (string)
}]
[
{
"ProfileId": "00000000-0000-0000-0000-000000000000"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
Internal recipients removed from current revision successfully.
400
The supplied Document ID is invalid or supplied Internal recipient model
is incorrect.
401
The user is not authorised.
404
The revision cannot be found or the user is forbidden access to this
document.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
422
The supplied Internal recipient is invalid
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/DOCUMENTS/{DOCUMENTID}/REVISIONS
* Get a Document's revisions
IMPLEMENTATION NOTES
CustomFields list can return different custom field objects please refer
to the custom field endpoint for more information
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
AuthoredDateTime (string, optional),
DefaultStatus (Status , optional),
RevisionAuthor (User , optional),
RevisionReference (string, optional),
Attachments (Array[Attachment ], optional),
CustomFieldGroups (Array[CustomFieldGroup ], optional),
IsNotifyRecipientsByEmail (boolean, optional),
ExternalRecipients (Array[ExternalRecipient ], optional),
Files (Array[File ], optional),
InternalRecipients (Array[InternalRecipient ], optional),
Keywords (Array[Keyword ], optional),
Markups (Array[Markup ], optional),
Notes (string, optional),
ParentId (string, optional),
PrimaryFileId (string, optional),
IsFilesPrivateToRecipients (boolean, optional),
State (string, optional),
RevisionStatus (Status , optional),
Workflows (Array[Workflow ], optional),
CurrentWorkflowId (string, optional),
CurrentWorkflowName (string, optional),
PercentageComplete (integer, optional),
Classifications (Array[ClassificationGet ], optional),
IsFilePubliclyAvailable (boolean, optional),
PublicLinkExpiry (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
Status {
Name (string, optional),
IsDefault (boolean, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
User {
Id (string, optional),
Name (string, optional)
}
Attachment {
Name (string, optional),
Description (string, optional),
EntityType (string, optional),
EntityId (string, optional),
AttachmentId (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
CustomFieldGroup {
GroupId (string, optional),
Name (string, optional),
CustomFields (Array[CustomFieldBase ], optional)
}
ExternalRecipient {
Name (string, optional)
stringMin. Length:1Max. Length:122
,
Email (string)
}
File {
Name (string),
IsPrimary (boolean, optional),
Status (string, optional),
Size (integer, optional),
Extension (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
InternalRecipient {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
Keyword {
Name (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
Markup {
Description (string, optional),
Name (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
Workflow {
Description (string, optional),
Name (string, optional),
IsCurrentWorkflow (boolean, optional),
StartDateTime (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
ClassificationGet {
UniclassId (string, optional),
Code (string, optional),
Title (string, optional)
}
CustomFieldBase {
MemberId (string, optional),
Name (string, optional),
Description (string, optional),
Mandatory (boolean, optional),
CustomFieldType (string, optional)
}
[
{
"AuthoredDateTime": "2024-06-07T11:33:35.985Z",
"DefaultStatus": {
"Name": "string",
"IsDefault": true,
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.985Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.985Z"
},
"RevisionAuthor": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"RevisionReference": "string",
"Attachments": [
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.985Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.985Z"
}
],
"CustomFieldGroups": [
{
"GroupId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CustomFields": [
{
"MemberId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"Mandatory": true,
"CustomFieldType": "string"
}
]
}
],
"IsNotifyRecipientsByEmail": true,
"ExternalRecipients": [
{
"Name": "string",
"Email": "string"
}
],
"Files": [
{
"Name": "string",
"IsPrimary": true,
"Status": "string",
"Size": 0,
"Extension": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.985Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.985Z"
}
],
"InternalRecipients": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"Keywords": [
{
"Name": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.985Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.985Z"
}
],
"Markups": [
{
"Description": "string",
"Name": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.985Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.985Z"
}
],
"Notes": "string",
"ParentId": "00000000-0000-0000-0000-000000000000",
"PrimaryFileId": "00000000-0000-0000-0000-000000000000",
"IsFilesPrivateToRecipients": true,
"State": "string",
"RevisionStatus": {
"Name": "string",
"IsDefault": true,
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.985Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.985Z"
},
"Workflows": [
{
"Description": "string",
"Name": "string",
"IsCurrentWorkflow": true,
"StartDateTime": "2024-06-07T11:33:35.985Z",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.985Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.985Z"
}
],
"CurrentWorkflowId": "00000000-0000-0000-0000-000000000000",
"CurrentWorkflowName": "string",
"PercentageComplete": 0,
"Classifications": [
{
"UniclassId": "00000000-0000-0000-0000-000000000000",
"Code": "string",
"Title": "string"
}
],
"IsFilePubliclyAvailable": true,
"PublicLinkExpiry": "2024-06-07T11:33:35.985Z",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.985Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.985Z"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The unique identifier of the Document
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Document ID is invalid.
401
The user is not authorised.
404
The document cannot be found or the user does not have permission to
access the document.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/DOCUMENTS/{DOCUMENTID}/REVISIONS
* Create a Document revision
WARNING: DEPRECATED
IMPLEMENTATION NOTES
When a revision is created it is automatically set as the current
revision of the document. The AuthoredDateTime is assumed to be UTC,
please offset it if required.
* Authorize
RESPONSE CLASS (STATUS 201)
Revision created successfully.
* Model
* Example Value
Revision {
AuthoredDateTime (string, optional),
DefaultStatus (Status , optional),
RevisionAuthor (User , optional),
RevisionReference (string, optional),
Attachments (Array[Attachment ], optional),
CustomFieldGroups (Array[CustomFieldGroup ], optional),
IsNotifyRecipientsByEmail (boolean, optional),
ExternalRecipients (Array[ExternalRecipient ], optional),
Files (Array[File ], optional),
InternalRecipients (Array[InternalRecipient ], optional),
Keywords (Array[Keyword ], optional),
Markups (Array[Markup ], optional),
Notes (string, optional),
ParentId (string, optional),
PrimaryFileId (string, optional),
IsFilesPrivateToRecipients (boolean, optional),
State (string, optional),
RevisionStatus (Status , optional),
Workflows (Array[Workflow ], optional),
CurrentWorkflowId (string, optional),
CurrentWorkflowName (string, optional),
PercentageComplete (integer, optional),
Classifications (Array[ClassificationGet ], optional),
IsFilePubliclyAvailable (boolean, optional),
PublicLinkExpiry (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
Status {
Name (string, optional),
IsDefault (boolean, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
User {
Id (string, optional),
Name (string, optional)
}
Attachment {
Name (string, optional),
Description (string, optional),
EntityType (string, optional),
EntityId (string, optional),
AttachmentId (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
CustomFieldGroup {
GroupId (string, optional),
Name (string, optional),
CustomFields (Array[CustomFieldBase ], optional)
}
ExternalRecipient {
Name (string, optional)
stringMin. Length:1Max. Length:122
,
Email (string)
}
File {
Name (string),
IsPrimary (boolean, optional),
Status (string, optional),
Size (integer, optional),
Extension (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
InternalRecipient {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
Keyword {
Name (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
Markup {
Description (string, optional),
Name (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
Workflow {
Description (string, optional),
Name (string, optional),
IsCurrentWorkflow (boolean, optional),
StartDateTime (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
ClassificationGet {
UniclassId (string, optional),
Code (string, optional),
Title (string, optional)
}
CustomFieldBase {
MemberId (string, optional),
Name (string, optional),
Description (string, optional),
Mandatory (boolean, optional),
CustomFieldType (string, optional)
}
{
"AuthoredDateTime": "2024-06-07T11:33:35.989Z",
"DefaultStatus": {
"Name": "string",
"IsDefault": true,
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.989Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.989Z"
},
"RevisionAuthor": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"RevisionReference": "string",
"Attachments": [
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.989Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.989Z"
}
],
"CustomFieldGroups": [
{
"GroupId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CustomFields": [
{
"MemberId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"Mandatory": true,
"CustomFieldType": "string"
}
]
}
],
"IsNotifyRecipientsByEmail": true,
"ExternalRecipients": [
{
"Name": "string",
"Email": "string"
}
],
"Files": [
{
"Name": "string",
"IsPrimary": true,
"Status": "string",
"Size": 0,
"Extension": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.989Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.989Z"
}
],
"InternalRecipients": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"Keywords": [
{
"Name": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.989Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.989Z"
}
],
"Markups": [
{
"Description": "string",
"Name": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.989Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.989Z"
}
],
"Notes": "string",
"ParentId": "00000000-0000-0000-0000-000000000000",
"PrimaryFileId": "00000000-0000-0000-0000-000000000000",
"IsFilesPrivateToRecipients": true,
"State": "string",
"RevisionStatus": {
"Name": "string",
"IsDefault": true,
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.989Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.989Z"
},
"Workflows": [
{
"Description": "string",
"Name": "string",
"IsCurrentWorkflow": true,
"StartDateTime": "2024-06-07T11:33:35.989Z",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.989Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.989Z"
}
],
"CurrentWorkflowId": "00000000-0000-0000-0000-000000000000",
"CurrentWorkflowName": "string",
"PercentageComplete": 0,
"Classifications": [
{
"UniclassId": "00000000-0000-0000-0000-000000000000",
"Code": "string",
"Title": "string"
}
],
"IsFilePubliclyAvailable": true,
"PublicLinkExpiry": "2024-06-07T11:33:35.989Z",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.989Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.989Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The unique identifier of the Document
path string revisionCreate
Parameter content type: application/json
Revision create model
body
* Model
* Example Value
RevisionCreate {
RevisionAuthorId (string, optional),
Attachments (Array[Attachment ], optional),
AuthoredDateTime (string, optional),
IsNotifyRecipientsByEmail (boolean, optional),
ExternalRecipients (Array[ExternalRecipient ], optional),
InternalRecipients (Array[InternalRecipient ], optional),
Keywords (Array[Keyword ], optional),
Notes (string, optional),
IsFilesPrivateToRecipients (boolean, optional),
RevisionStatusId (string, optional),
RevisionReference (string, optional),
RevisionWorkflows (Array[Workflow ], optional),
PercentageComplete (integer, optional)
integerMax. Value:100
,
Classifications (Array[Classification ], optional)
}
Attachment {
EntityType (string) = ['UNDEFINED', 'DOCUMENT']
stringEnum:"UNDEFINED", "DOCUMENT"
,
EntityId (string, optional)
}
ExternalRecipient {
Name (string, optional)
stringMin. Length:1Max. Length:122
,
Email (string)
}
InternalRecipient {
ProfileId (string),
Type (string) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
Keyword {
Id (string)
}
Workflow {
Id (string, optional)
}
Classification {
UniclassId (string, optional),
Code (string, optional)
}
{
"RevisionAuthorId": "00000000-0000-0000-0000-000000000000",
"Attachments": [
{
"EntityType": "UNDEFINED",
"EntityId": "00000000-0000-0000-0000-000000000000"
}
],
"AuthoredDateTime": "2024-06-07T11:33:35.991Z",
"IsNotifyRecipientsByEmail": true,
"ExternalRecipients": [
{
"Name": "string",
"Email": "string"
}
],
"InternalRecipients": [
{
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Type": "UNDEFINED"
}
],
"Keywords": [
{
"Id": "00000000-0000-0000-0000-000000000000"
}
],
"Notes": "string",
"IsFilesPrivateToRecipients": true,
"RevisionStatusId": "00000000-0000-0000-0000-000000000000",
"RevisionReference": "string",
"RevisionWorkflows": [
{
"Id": "00000000-0000-0000-0000-000000000000"
}
],
"PercentageComplete": 0,
"Classifications": [
{
"UniclassId": "00000000-0000-0000-0000-000000000000",
"Code": "string"
}
]
}
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Document ID or revision ID is invalid.
401
The user is not authorised.
404
The document cannot be found or the user does not have permission to
access the document.
409
A Revision matching the supplied Revision already exists.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
422
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /VFP/API/V1/DOCUMENTS/{DOCUMENTID}/REVISIONS/{REVISIONID}
* Delete a Document's current revision
IMPLEMENTATION NOTES
Only the current revision can be deleted therefore the revisionId must be
the id of the current revision. If the current revision is deleted, the
previous revision will become the current revision. A document must have
at least one revision. If the current revision is the only revision, the
request will fail.
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The unique identifier of the Document
path string revisionId
The unique identifier of the current revision
path string If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
Current revision deleted successfully.
400
The supplied Document ID or Revision ID is invalid.
401
The user is not authorised.
404
The document or revision cannot be found or the user is forbidden access
to this document.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/DOCUMENTS/{DOCUMENTID}/REVISIONS/{REVISIONID}
* Get a Document's revision
IMPLEMENTATION NOTES
CustomFields list can return different custom field objects please refer
to the custom field endpoint for more information
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Revision {
AuthoredDateTime (string, optional),
DefaultStatus (Status , optional),
RevisionAuthor (User , optional),
RevisionReference (string, optional),
Attachments (Array[Attachment ], optional),
CustomFieldGroups (Array[CustomFieldGroup ], optional),
IsNotifyRecipientsByEmail (boolean, optional),
ExternalRecipients (Array[ExternalRecipient ], optional),
Files (Array[File ], optional),
InternalRecipients (Array[InternalRecipient ], optional),
Keywords (Array[Keyword ], optional),
Markups (Array[Markup ], optional),
Notes (string, optional),
ParentId (string, optional),
PrimaryFileId (string, optional),
IsFilesPrivateToRecipients (boolean, optional),
State (string, optional),
RevisionStatus (Status , optional),
Workflows (Array[Workflow ], optional),
CurrentWorkflowId (string, optional),
CurrentWorkflowName (string, optional),
PercentageComplete (integer, optional),
Classifications (Array[ClassificationGet ], optional),
IsFilePubliclyAvailable (boolean, optional),
PublicLinkExpiry (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
Status {
Name (string, optional),
IsDefault (boolean, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
User {
Id (string, optional),
Name (string, optional)
}
Attachment {
Name (string, optional),
Description (string, optional),
EntityType (string, optional),
EntityId (string, optional),
AttachmentId (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
CustomFieldGroup {
GroupId (string, optional),
Name (string, optional),
CustomFields (Array[CustomFieldBase ], optional)
}
ExternalRecipient {
Name (string, optional)
stringMin. Length:1Max. Length:122
,
Email (string)
}
File {
Name (string),
IsPrimary (boolean, optional),
Status (string, optional),
Size (integer, optional),
Extension (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
InternalRecipient {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
Keyword {
Name (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
Markup {
Description (string, optional),
Name (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
Workflow {
Description (string, optional),
Name (string, optional),
IsCurrentWorkflow (boolean, optional),
StartDateTime (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
ClassificationGet {
UniclassId (string, optional),
Code (string, optional),
Title (string, optional)
}
CustomFieldBase {
MemberId (string, optional),
Name (string, optional),
Description (string, optional),
Mandatory (boolean, optional),
CustomFieldType (string, optional)
}
{
"AuthoredDateTime": "2024-06-07T11:33:35.994Z",
"DefaultStatus": {
"Name": "string",
"IsDefault": true,
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.994Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.994Z"
},
"RevisionAuthor": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"RevisionReference": "string",
"Attachments": [
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.994Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.994Z"
}
],
"CustomFieldGroups": [
{
"GroupId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CustomFields": [
{
"MemberId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"Mandatory": true,
"CustomFieldType": "string"
}
]
}
],
"IsNotifyRecipientsByEmail": true,
"ExternalRecipients": [
{
"Name": "string",
"Email": "string"
}
],
"Files": [
{
"Name": "string",
"IsPrimary": true,
"Status": "string",
"Size": 0,
"Extension": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.994Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.994Z"
}
],
"InternalRecipients": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"Keywords": [
{
"Name": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.994Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.994Z"
}
],
"Markups": [
{
"Description": "string",
"Name": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.994Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.994Z"
}
],
"Notes": "string",
"ParentId": "00000000-0000-0000-0000-000000000000",
"PrimaryFileId": "00000000-0000-0000-0000-000000000000",
"IsFilesPrivateToRecipients": true,
"State": "string",
"RevisionStatus": {
"Name": "string",
"IsDefault": true,
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.994Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.994Z"
},
"Workflows": [
{
"Description": "string",
"Name": "string",
"IsCurrentWorkflow": true,
"StartDateTime": "2024-06-07T11:33:35.994Z",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.994Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.994Z"
}
],
"CurrentWorkflowId": "00000000-0000-0000-0000-000000000000",
"CurrentWorkflowName": "string",
"PercentageComplete": 0,
"Classifications": [
{
"UniclassId": "00000000-0000-0000-0000-000000000000",
"Code": "string",
"Title": "string"
}
],
"IsFilePubliclyAvailable": true,
"PublicLinkExpiry": "2024-06-07T11:33:35.994Z",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.994Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.994Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The unique identifier of the Document
path string revisionId
The unique identifier of the Revision
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Document ID or revision ID is invalid.
401
The user is not authorised.
404
The document or revision cannot be found or the user does not have
permission to access either.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/DOCUMENTS/{DOCUMENTID}/REVISIONS/{REVISIONID}/FILES
* Get the Files collection of a Document revision
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Name (string),
IsPrimary (boolean, optional),
Status (string, optional),
Size (integer, optional),
Extension (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
[
{
"Name": "string",
"IsPrimary": true,
"Status": "string",
"Size": 0,
"Extension": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.997Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.997Z"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The unique identifier of the Document
path string revisionId
The unique identifier of the Document Revision
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Document ID or revision ID is invalid.
401
The user is not authorised.
404
The document or document revision cannot be found or the user is
forbidden access to this document.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/VFP/API/V1/DOCUMENTS/{DOCUMENTID}/REVISIONS/{REVISIONID}/FILES/{FILEID}
* Get a File from a Document revision
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
File {
Name (string),
IsPrimary (boolean, optional),
Status (string, optional),
Size (integer, optional),
Extension (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
{
"Name": "string",
"IsPrimary": true,
"Status": "string",
"Size": 0,
"Extension": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:35.998Z",
"UpdatedAtDateTime": "2024-06-07T11:33:35.998Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The unique identifier of the Document
path string revisionId
The unique identifier of the Document Revision
path string fileId
The unique identifier of the File
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Document ID, Revision ID or file ID is invalid.
401
The user is not authorised.
404
The document or document revision or file cannot be found or the user is
forbidden access to this document.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/VFP/API/V1/DOCUMENTS/{DOCUMENTID}/REVISIONS/{REVISIONID}/FILES/{FILEID}/BLOBURL
* Get a download URL for a File
IMPLEMENTATION NOTES
The download of the file must begin before the URL has expired.
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
FileDownloadURL {
Url (string, optional),
UrlExpiryInSeconds (integer, optional)
}
{
"Url": "string",
"UrlExpiryInSeconds": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The unique identifier of the Document
path string revisionId
The unique identifier of the Document Revision
path string fileId
The unique identifier of the File
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Document ID, Revision ID or File ID is invalid.
401
The user is not authorised.
404
The Document or Document Revision or File cannot be found or the user is
forbidden access to this Document.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/DOCUMENTS/{DOCUMENTID}/REVISIONWORKFLOWS/ADD
* Add a workflow to a Document's current revision
IMPLEMENTATION NOTES
Only a "DocumentRevision" workflow type can be added as a Document
revision workflow.
* Authorize
RESPONSE CLASS (STATUS 200)
Workflows successfully added to Documents current revision.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Description (string, optional),
Name (string, optional),
IsCurrentWorkflow (boolean, optional),
StartDateTime (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
[
{
"Description": "string",
"Name": "string",
"IsCurrentWorkflow": true,
"StartDateTime": "2024-06-07T11:33:36.001Z",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.001Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.001Z"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The unique identifier of the Document
path string workflow
Parameter content type: application/json
DocumentRevision Workflow Id
body
* Model
* Example Value
Workflow {
Id (string, optional)
}
{
"Id": "00000000-0000-0000-0000-000000000000"
}
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 401
The user is not authorised.
404
The Document cannot be found or the user is forbidden access to this
Document.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
422
Supplied workflow(s) are invalid.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/DOCUMENTS/{DOCUMENTID}/REVISIONWORKFLOWS/REMOVE
* Remove workflows from a Document's current revision
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The unique identifier of the Document
path string workflows
Parameter content type: application/json
A collection of DocumentRevision workflow Ids
body
* Model
* Example Value
Array[Workflow {
Id (string, optional)
}]
[
{
"Id": "00000000-0000-0000-0000-000000000000"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
Removed workflow(s) from the specified Documents current revision
successfully.
400
The supplied Document ID or Workflow model is invalid.
401
The user is not authorised.
404
The Document cannot be found or the user is forbidden access to this
Document.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
422
Error saving updated Document.
500
Internal server error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/DOCUMENTS/{DOCUMENTID}/WORKFLOWS/ADD
* Add a workflow to a Document
IMPLEMENTATION NOTES
Only "Document" workflow types can be added as a Document workflow.
* Authorize
RESPONSE CLASS (STATUS 200)
Workflow successfully added to Document.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Description (string, optional),
Name (string, optional),
IsCurrentWorkflow (boolean, optional),
StartDateTime (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
[
{
"Description": "string",
"Name": "string",
"IsCurrentWorkflow": true,
"StartDateTime": "2024-06-07T11:33:36.004Z",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.004Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.004Z"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The unique identifier of the Document
path string workflow
Parameter content type: application/json
Document Workflow Id
body
* Model
* Example Value
Workflow {
Id (string, optional)
}
{
"Id": "00000000-0000-0000-0000-000000000000"
}
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 401
The user is not authorised.
404
The Document cannot be found or the user is forbidden access to this
Document.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
422
Supplied workflow is invalid.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/DOCUMENTS/{DOCUMENTID}/WORKFLOWS/REMOVE
* Remove workflows from a Document
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The unique identifier of the Document
path string workflows
Parameter content type: application/json
A collection of workflow ids
body
* Model
* Example Value
Array[Workflow {
Id (string, optional)
}]
[
{
"Id": "00000000-0000-0000-0000-000000000000"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
Removed workflow(s) from the specified Document successfully.
400
The supplied Document ID or Workflow model is invalid.
401
The user is not authorised.
404
The Document cannot be found or the user is forbidden access to this
Document.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
422
Error saving updated Document.
500
Internal server error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V2/DOCUMENTS/{DOCUMENTID}/REVISIONS
* Create a Document revision
IMPLEMENTATION NOTES
When a revision is created it is automatically set as the current
revision of the document. The AuthoredDateTime is assumed to be UTC,
please offset it if required.
* Authorize
RESPONSE CLASS (STATUS 201)
Revision created successfully.
* Model
* Example Value
Revision {
AuthoredDateTime (string, optional),
DefaultStatus (Status , optional),
RevisionAuthor (User , optional),
RevisionReference (string, optional),
Attachments (Array[Attachment ], optional),
CustomFieldGroups (Array[CustomFieldGroup ], optional),
IsNotifyRecipientsByEmail (boolean, optional),
ExternalRecipients (Array[ExternalRecipient ], optional),
Files (Array[File ], optional),
InternalRecipients (Array[InternalRecipient ], optional),
Keywords (Array[Keyword ], optional),
Markups (Array[Markup ], optional),
Notes (string, optional),
ParentId (string, optional),
PrimaryFileId (string, optional),
IsFilesPrivateToRecipients (boolean, optional),
State (string, optional),
RevisionStatus (Status , optional),
Workflows (Array[Workflow ], optional),
CurrentWorkflowId (string, optional),
CurrentWorkflowName (string, optional),
PercentageComplete (integer, optional),
Classifications (Array[ClassificationGet ], optional),
IsFilePubliclyAvailable (boolean, optional),
PublicLinkExpiry (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
Status {
Name (string, optional),
IsDefault (boolean, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
User {
Id (string, optional),
Name (string, optional)
}
Attachment {
Name (string, optional),
Description (string, optional),
EntityType (string, optional),
EntityId (string, optional),
AttachmentId (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
CustomFieldGroup {
GroupId (string, optional),
Name (string, optional),
CustomFields (Array[CustomFieldBase ], optional)
}
ExternalRecipient {
Name (string, optional)
stringMin. Length:1Max. Length:122
,
Email (string)
}
File {
Name (string),
IsPrimary (boolean, optional),
Status (string, optional),
Size (integer, optional),
Extension (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
InternalRecipient {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
Keyword {
Name (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
Markup {
Description (string, optional),
Name (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
Workflow {
Description (string, optional),
Name (string, optional),
IsCurrentWorkflow (boolean, optional),
StartDateTime (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
ClassificationGet {
UniclassId (string, optional),
Code (string, optional),
Title (string, optional)
}
CustomFieldBase {
MemberId (string, optional),
Name (string, optional),
Description (string, optional),
Mandatory (boolean, optional),
CustomFieldType (string, optional)
}
{
"AuthoredDateTime": "2024-06-07T11:33:36.008Z",
"DefaultStatus": {
"Name": "string",
"IsDefault": true,
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.008Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.008Z"
},
"RevisionAuthor": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"RevisionReference": "string",
"Attachments": [
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.008Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.008Z"
}
],
"CustomFieldGroups": [
{
"GroupId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CustomFields": [
{
"MemberId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"Mandatory": true,
"CustomFieldType": "string"
}
]
}
],
"IsNotifyRecipientsByEmail": true,
"ExternalRecipients": [
{
"Name": "string",
"Email": "string"
}
],
"Files": [
{
"Name": "string",
"IsPrimary": true,
"Status": "string",
"Size": 0,
"Extension": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.008Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.008Z"
}
],
"InternalRecipients": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"Keywords": [
{
"Name": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.008Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.008Z"
}
],
"Markups": [
{
"Description": "string",
"Name": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.008Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.008Z"
}
],
"Notes": "string",
"ParentId": "00000000-0000-0000-0000-000000000000",
"PrimaryFileId": "00000000-0000-0000-0000-000000000000",
"IsFilesPrivateToRecipients": true,
"State": "string",
"RevisionStatus": {
"Name": "string",
"IsDefault": true,
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.008Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.008Z"
},
"Workflows": [
{
"Description": "string",
"Name": "string",
"IsCurrentWorkflow": true,
"StartDateTime": "2024-06-07T11:33:36.008Z",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.008Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.008Z"
}
],
"CurrentWorkflowId": "00000000-0000-0000-0000-000000000000",
"CurrentWorkflowName": "string",
"PercentageComplete": 0,
"Classifications": [
{
"UniclassId": "00000000-0000-0000-0000-000000000000",
"Code": "string",
"Title": "string"
}
],
"IsFilePubliclyAvailable": true,
"PublicLinkExpiry": "2024-06-07T11:33:36.008Z",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.008Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.008Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The unique identifier of the Document
path string revisionCreate
Parameter content type: application/json
Revision create model
body
* Model
* Example Value
RevisionCreateV2 {
IsFilePubliclyAvailable (boolean, optional),
PublicLinkExpiry (string, optional),
RevisionAuthorId (string, optional),
Attachments (Array[Attachment ], optional),
AuthoredDateTime (string, optional),
IsNotifyRecipientsByEmail (boolean, optional),
ExternalRecipients (Array[ExternalRecipient ], optional),
InternalRecipients (Array[InternalRecipient ], optional),
Keywords (Array[Keyword ], optional),
Notes (string, optional),
IsFilesPrivateToRecipients (boolean, optional),
RevisionStatusId (string, optional),
RevisionReference (string, optional),
RevisionWorkflows (Array[Workflow ], optional),
PercentageComplete (integer, optional)
integerMax. Value:100
,
Classifications (Array[Classification ], optional)
}
Attachment {
EntityType (string) = ['UNDEFINED', 'DOCUMENT']
stringEnum:"UNDEFINED", "DOCUMENT"
,
EntityId (string, optional)
}
ExternalRecipient {
Name (string, optional)
stringMin. Length:1Max. Length:122
,
Email (string)
}
InternalRecipient {
ProfileId (string),
Type (string) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
Keyword {
Id (string)
}
Workflow {
Id (string, optional)
}
Classification {
UniclassId (string, optional),
Code (string, optional)
}
{
"IsFilePubliclyAvailable": true,
"PublicLinkExpiry": "2024-06-07T11:33:36.010Z",
"RevisionAuthorId": "00000000-0000-0000-0000-000000000000",
"Attachments": [
{
"EntityType": "UNDEFINED",
"EntityId": "00000000-0000-0000-0000-000000000000"
}
],
"AuthoredDateTime": "2024-06-07T11:33:36.010Z",
"IsNotifyRecipientsByEmail": true,
"ExternalRecipients": [
{
"Name": "string",
"Email": "string"
}
],
"InternalRecipients": [
{
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Type": "UNDEFINED"
}
],
"Keywords": [
{
"Id": "00000000-0000-0000-0000-000000000000"
}
],
"Notes": "string",
"IsFilesPrivateToRecipients": true,
"RevisionStatusId": "00000000-0000-0000-0000-000000000000",
"RevisionReference": "string",
"RevisionWorkflows": [
{
"Id": "00000000-0000-0000-0000-000000000000"
}
],
"PercentageComplete": 0,
"Classifications": [
{
"UniclassId": "00000000-0000-0000-0000-000000000000",
"Code": "string"
}
]
}
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Document ID or revision ID is invalid.
401
The user is not authorised.
404
The document cannot be found or the user does not have permission to
access the document.
409
A Revision matching the supplied Revision already exists.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
422
The supplied Revision model contains invalid items.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* DYNAMICVIRTUALCONTAINERS
* Developer Notes
* Show/Hide
* List Operations
* Expand Operations
* Help
A dynamic virtual container contains dynamic references to documents from
elsewhere within an enterprise. It may also contain DynamicVirtualContainers
as children. Only the latest revision of a document that is attached to a
dynamic virtual container will display within it, updating dynamically as the
Document is revised. A dynamic virtual container cannot be revised and must
be assigned an OwnerID to be valid when created. It is not possible to upload
Documents into a dynamic virtual container.
* * POST /VFP/API/V1/DVCS
* Create a DVC
IMPLEMENTATION NOTES
The ParentId can be the unique identifier of an Project, DocumentFolder
or Dynamic virtual container. The Attachments collection can be used to
add only documents to the DVC. Each attachment EntityType property should
therefore be set to DOCUMENT or 5. The Classification collection can be
used to add classifications to the DVC. The ExpiryDateTime is assumed to
be UTC, please offset it if required. The ExpiryDateTime is assumed to be
UTC, please offset it if required.
* Authorize
RESPONSE CLASS (STATUS 201)
Dynamic Virtual Container created successfully.
* Model
* Example Value
DVCGet {
ParentId (string, optional),
Name (string, optional),
Owner (User , optional),
Expiry (boolean, optional),
CreatedAtDateTime (string, optional),
Id (string, optional),
UpdatedAtDateTime (string, optional),
Attachments (Array[Attachment ], optional),
Classifications (Array[ClassificationGet ], optional),
AllRevisionsPublic (boolean, optional),
Description (string, optional),
DirectAccess (boolean, optional),
AllowMarkups (boolean, optional),
IsPublic (boolean, optional),
EnforceWorkflow (boolean, optional),
ExpiryDateTime (string, optional),
Comment (string, optional)
}
User {
Id (string, optional),
Name (string, optional)
}
Attachment {
Name (string, optional),
Description (string, optional),
EntityType (string, optional),
EntityId (string, optional),
AttachmentId (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
ClassificationGet {
UniclassId (string, optional),
Code (string, optional),
Title (string, optional)
}
{
"ParentId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Owner": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"Expiry": true,
"CreatedAtDateTime": "2024-06-07T11:33:36.014Z",
"Id": "00000000-0000-0000-0000-000000000000",
"UpdatedAtDateTime": "2024-06-07T11:33:36.014Z",
"Attachments": [
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.014Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.014Z"
}
],
"Classifications": [
{
"UniclassId": "00000000-0000-0000-0000-000000000000",
"Code": "string",
"Title": "string"
}
],
"AllRevisionsPublic": true,
"Description": "string",
"DirectAccess": true,
"AllowMarkups": true,
"IsPublic": true,
"EnforceWorkflow": true,
"ExpiryDateTime": "2024-06-07T11:33:36.014Z",
"Comment": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type dvcCreate
Parameter content type: application/json
DVC create model
body
* Model
* Example Value
DVCCreate {
ParentId (string, optional),
Name (string),
OwnerId (string, optional),
Attachments (Array[Attachment ], optional),
AllRevisionsPublic (boolean, optional),
Classifications (Array[Classification ], optional),
Description (string, optional),
DirectAccess (boolean, optional),
AllowMarkups (boolean, optional),
IsPublic (boolean, optional),
EnforceWorkflow (boolean, optional),
ExpiryDateTime (string, optional),
Comment (string, optional)
}
Attachment {
EntityType (string) = ['UNDEFINED', 'DOCUMENT']
stringEnum:"UNDEFINED", "DOCUMENT"
,
EntityId (string, optional)
}
Classification {
UniclassId (string, optional),
Code (string, optional)
}
{
"ParentId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"OwnerId": "00000000-0000-0000-0000-000000000000",
"Attachments": [
{
"EntityType": "UNDEFINED",
"EntityId": "00000000-0000-0000-0000-000000000000"
}
],
"AllRevisionsPublic": true,
"Classifications": [
{
"UniclassId": "00000000-0000-0000-0000-000000000000",
"Code": "string"
}
],
"Description": "string",
"DirectAccess": true,
"AllowMarkups": true,
"IsPublic": true,
"EnforceWorkflow": true,
"ExpiryDateTime": "2024-06-07T11:33:36.015Z",
"Comment": "string"
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Dynamic Virtual Container model is incorrect.
401
The user is not authorised.
404
The parent entity cannot be found or the user is forbidden access to this
parent entity or the parent type id invalid.
409
A Dynamic Virtual Container matching the supplied name exists in this
parent entity.
422
Supplied Attachment(s) are invalid.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /VFP/API/V1/DVCS/{DVCID}
* Delete a DVC
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type dvcId
The unique identifier of the DVC
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
DVC deleted successfully.
400
The supplied DVC ID is invalid.
401
The user is not authorised.
404
The DVC cannot be found or the user does not have permission to access
the entity.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/DVCS/{DVCID}
* Get a DVC
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
DVCGet {
ParentId (string, optional),
Name (string, optional),
Owner (User , optional),
Expiry (boolean, optional),
CreatedAtDateTime (string, optional),
Id (string, optional),
UpdatedAtDateTime (string, optional),
Attachments (Array[Attachment ], optional),
Classifications (Array[ClassificationGet ], optional),
AllRevisionsPublic (boolean, optional),
Description (string, optional),
DirectAccess (boolean, optional),
AllowMarkups (boolean, optional),
IsPublic (boolean, optional),
EnforceWorkflow (boolean, optional),
ExpiryDateTime (string, optional),
Comment (string, optional)
}
User {
Id (string, optional),
Name (string, optional)
}
Attachment {
Name (string, optional),
Description (string, optional),
EntityType (string, optional),
EntityId (string, optional),
AttachmentId (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
ClassificationGet {
UniclassId (string, optional),
Code (string, optional),
Title (string, optional)
}
{
"ParentId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Owner": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"Expiry": true,
"CreatedAtDateTime": "2024-06-07T11:33:36.017Z",
"Id": "00000000-0000-0000-0000-000000000000",
"UpdatedAtDateTime": "2024-06-07T11:33:36.017Z",
"Attachments": [
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.017Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.017Z"
}
],
"Classifications": [
{
"UniclassId": "00000000-0000-0000-0000-000000000000",
"Code": "string",
"Title": "string"
}
],
"AllRevisionsPublic": true,
"Description": "string",
"DirectAccess": true,
"AllowMarkups": true,
"IsPublic": true,
"EnforceWorkflow": true,
"ExpiryDateTime": "2024-06-07T11:33:36.017Z",
"Comment": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type dvcId
The unique identifier of the DVC
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied DVC ID is invalid.
401
The user is not authorised.
404
The DVC cannot be found or the user is forbidden access to this DVC.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PATCH /VFP/API/V1/DVCS/{DVCID}
* Update a DVC
* Authorize
RESPONSE CLASS (STATUS 200)
Dynamic Virtual Container updated successfully.
* Model
* Example Value
DVCGet {
ParentId (string, optional),
Name (string, optional),
Owner (User , optional),
Expiry (boolean, optional),
CreatedAtDateTime (string, optional),
Id (string, optional),
UpdatedAtDateTime (string, optional),
Attachments (Array[Attachment ], optional),
Classifications (Array[ClassificationGet ], optional),
AllRevisionsPublic (boolean, optional),
Description (string, optional),
DirectAccess (boolean, optional),
AllowMarkups (boolean, optional),
IsPublic (boolean, optional),
EnforceWorkflow (boolean, optional),
ExpiryDateTime (string, optional),
Comment (string, optional)
}
User {
Id (string, optional),
Name (string, optional)
}
Attachment {
Name (string, optional),
Description (string, optional),
EntityType (string, optional),
EntityId (string, optional),
AttachmentId (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
ClassificationGet {
UniclassId (string, optional),
Code (string, optional),
Title (string, optional)
}
{
"ParentId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Owner": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"Expiry": true,
"CreatedAtDateTime": "2024-06-07T11:33:36.019Z",
"Id": "00000000-0000-0000-0000-000000000000",
"UpdatedAtDateTime": "2024-06-07T11:33:36.019Z",
"Attachments": [
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.019Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.019Z"
}
],
"Classifications": [
{
"UniclassId": "00000000-0000-0000-0000-000000000000",
"Code": "string",
"Title": "string"
}
],
"AllRevisionsPublic": true,
"Description": "string",
"DirectAccess": true,
"AllowMarkups": true,
"IsPublic": true,
"EnforceWorkflow": true,
"ExpiryDateTime": "2024-06-07T11:33:36.019Z",
"Comment": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type dvcId
The unique identifier of the DVC
path string dvcUpdate
Parameter content type: application/json
Update DVC model
body
* Model
* Example Value
DVCUpdate {
Name (string, optional),
OwnerId (string, optional),
Attachments (Array[Attachment ], optional),
AllRevisionsPublic (boolean, optional),
Classifications (Array[Classification ], optional),
Description (string, optional),
DirectAccess (boolean, optional),
AllowMarkups (boolean, optional),
IsPublic (boolean, optional),
EnforceWorkflow (boolean, optional),
ExpiryDateTime (string, optional),
Comment (string, optional)
}
Attachment {
EntityType (string) = ['UNDEFINED', 'DOCUMENT']
stringEnum:"UNDEFINED", "DOCUMENT"
,
EntityId (string, optional)
}
Classification {
UniclassId (string, optional),
Code (string, optional)
}
{
"Name": "string",
"OwnerId": "00000000-0000-0000-0000-000000000000",
"Attachments": [
{
"EntityType": "UNDEFINED",
"EntityId": "00000000-0000-0000-0000-000000000000"
}
],
"AllRevisionsPublic": true,
"Classifications": [
{
"UniclassId": "00000000-0000-0000-0000-000000000000",
"Code": "string"
}
],
"Description": "string",
"DirectAccess": true,
"AllowMarkups": true,
"IsPublic": true,
"EnforceWorkflow": true,
"ExpiryDateTime": "2024-06-07T11:33:36.020Z",
"Comment": "string"
}
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Dynamic Virtual Container model is incorrect.
401
The user is not authorised.
404
The Dynamic Virtual Container cannot be found or the user is forbidden
access to this Dynamic Virtual Container.
409
A Dynamic Virtual Container matching the supplied name exists in this
parent entity.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and use the value of the
returned ETag header as the value of the If-Match header.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/DVCS/{DVCID}/ATTACHMENTS/ADD
* Add attachments to a DVC
IMPLEMENTATION NOTES
Only documents can be added as DVC attachments. The supplied EntityType
values can be either DOCUMENT or 5
* Authorize
RESPONSE CLASS (STATUS 200)
Attachments successfully added to DVC.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Name (string, optional),
Description (string, optional),
EntityType (string, optional),
EntityId (string, optional),
AttachmentId (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
[
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.021Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.021Z"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type dvcid
The unique identifier of the DVC
path string attachments
Parameter content type: application/json
Collection of attachments (documents)
body
* Model
* Example Value
Array[Attachment {
EntityType (string) = ['UNDEFINED', 'DOCUMENT']
stringEnum:"UNDEFINED", "DOCUMENT"
,
EntityId (string, optional)
}]
[
{
"EntityType": "UNDEFINED",
"EntityId": "00000000-0000-0000-0000-000000000000"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 401
The user is not authorised.
404
The parent entity cannot be found or the user is forbidden access to this
parent entity or the parent type id invalid.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and use the value of the
returned ETag header as the value of the If-Match header.
422
Supplied attachment(s) are invalid.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/DVCS/{DVCID}/ATTACHMENTS/REMOVE
* Remove attachments from a DVC
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type dvcId
The unique identifier of the DVC
path string attachments
Parameter content type: application/json
Collection of attachments
body
* Model
* Example Value
Array[Attachment {
AttachmentId (string, optional)
}]
[
{
"AttachmentId": "00000000-0000-0000-0000-000000000000"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
Removed attachment(s) from the specified DVC successfully.
400
The supplied DVC ID or Attachment model is invalid.
401
The user is not authorised.
404
The DVC cannot be found or the user is forbidden access to this DVC.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and use the value of the
returned ETag header as the value of the If-Match header.
422
Supplied Attachment(s) are invalid.
500
Internal server error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/DVCS/{DVCID}/CLASSIFICATIONS/ADD
* Add classifications to a DVC
* Authorize
RESPONSE CLASS (STATUS 200)
Classifications added successfully.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
UniclassId (string, optional),
Code (string, optional),
Title (string, optional)
}
[
{
"UniclassId": "00000000-0000-0000-0000-000000000000",
"Code": "string",
"Title": "string"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type dvcId
The unique identifier of the DVC
path string classifications
Parameter content type: application/json
The classifications model
body
* Model
* Example Value
Array[Classification {
UniclassId (string, optional),
Code (string, optional)
}]
[
{
"UniclassId": "00000000-0000-0000-0000-000000000000",
"Code": "string"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied DVC ID or classifications model is invalid.
401
The user is not authorised.
404
The DVC cannot be found or the user does not have permission to access
the DVC.
412
Etag precondition failed
422
The supplied Classification(s) is invalid.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/DVCS/{DVCID}/CLASSIFICATIONS/REMOVE
* Remove classifications from a DVC
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type dvcId
The unique identifier of the Document
path string classifications
Parameter content type: application/json
The unique identifiers of the Classifications to remove
body
* Model
* Example Value
Array[Classification {
UniclassId (string, optional),
Code (string, optional)
}]
[
{
"UniclassId": "00000000-0000-0000-0000-000000000000",
"Code": "string"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
Classifications removed successfully.
400
The supplied DVC ID or classifications model is invalid.
401
The user is not authorised.
404
The DVC cannot be found or the user does not have permission to access
the DVC.
412
Etag precondition failed
422
The supplied Classification(s) is invalid.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* ENTERPRISES
* Developer Notes
* Show/Hide
* List Operations
* Expand Operations
* Help
Enterprises may contain Sites and DocumentFolders. Enterprise level is the
highest accessible level in the VFP Navigation Tree.
* * GET /VFP/API/V1/ENTERPRISES
* Get available Enterprises
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
CreatedAtDateTime (string, optional),
Description (string, optional),
Id (string, optional),
Name (string, optional)
}
[
{
"CreatedAtDateTime": "2024-06-07T11:33:36.031Z",
"Description": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
}
]
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 401
The user is not authorised.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/ENTERPRISES/{ENTERPRISEID}
* Get an Enterprise
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Enterprise {
Name (string, optional),
Description (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
{
"Name": "string",
"Description": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.032Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.032Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type enterpriseId
The unique identifier of the Enterprise
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Enterprise ID is invalid.
401
The user is not authorised.
404
The enterprise cannot be found or the user is forbidden access to this
enterprise.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/ENTERPRISES/{ENTERPRISEID}/CLASSIFICATIONS
* Get available classifications in an Enterprise
* Authorize
RESPONSE CLASS (STATUS 200)
Classifications retrieved successfully.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
UniclassId (string, optional),
UniclassName (string, optional),
Code (string, optional),
Title (string, optional),
Status (string, optional)
}
[
{
"UniclassId": "00000000-0000-0000-0000-000000000000",
"UniclassName": "string",
"Code": "string",
"Title": "string",
"Status": "string"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type enterpriseId
The unique identifier of the Enterprise
path string classificationCode
The code associated with the classification
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Enterprise ID is invalid.
401
The user is not authorised.
404
The Enterprise cannot be found or the user is forbidden access to this
Enterprise.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/ENTERPRISES/{ENTERPRISEID}/DISTRIBUTIONGROUPS
* Get available Distribution Groups in an Enterprise
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
[
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type enterpriseId
The unique identifier of the Enterprise
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Enterprise ID is invalid.
401
The user is not authorised.
404
The enterprise cannot be found or the user is forbidden access to this
enterprise.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/ENTERPRISES/{ENTERPRISEID}/DOCUMENTFOLDERS
* Get available Document Folders in an Enterprise
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
CreatedBy (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional),
Description (string, optional),
FullPath (string, optional),
Id (string, optional),
ModifiedBy (string, optional),
Name (string, optional),
ParentId (string, optional),
ParentName (string, optional),
PrimaryKey (string, optional),
SequenceNumber (string, optional),
State (string, optional)
}
[
{
"CreatedBy": "string",
"CreatedAtDateTime": "2024-06-07T11:33:36.035Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.035Z",
"Description": "string",
"FullPath": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"ModifiedBy": "string",
"Name": "string",
"ParentId": "00000000-0000-0000-0000-000000000000",
"ParentName": "string",
"PrimaryKey": "00000000-0000-0000-0000-000000000000",
"SequenceNumber": "string",
"State": "string"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type enterpriseId
The unique identifier of the Enterprise
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Enterprise ID is invalid.
401
The user is not authorised.
404
The enterprise cannot be found or the user is forbidden access to this
enterprise.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/ENTERPRISES/{ENTERPRISEID}/KEYWORDS
* Get available keywords in an Enterprise
* Authorize
RESPONSE CLASS (STATUS 200)
Keywords retrieved successfully.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Name (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
[
{
"Name": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.036Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.036Z"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type enterpriseId
The unique identifier of the Enterprise
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Enterprise ID is invalid.
401
The user is not authorised.
404
The Enterprise cannot be found or the user is forbidden access to this
Enterprise.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/ENTERPRISES/{ENTERPRISEID}/SECURITYGROUPS
* Get available Security Groups in an Enterprise
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
[
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type enterpriseId
The unique identifier of the Enterprise
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Enterprise ID is invalid.
401
The user is not authorised.
404
The enterprise cannot be found or the user is forbidden access to this
enterprise.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/ENTERPRISES/{ENTERPRISEID}/SITES
* Get available Sites in an Enterprise
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
CreatedBy (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional),
Id (string, optional),
ModifiedBy (string, optional),
Name (string, optional),
ParentId (string, optional),
ParentName (string, optional),
Description (string, optional)
}
[
{
"CreatedBy": "string",
"CreatedAtDateTime": "2024-06-07T11:33:36.038Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.038Z",
"Id": "00000000-0000-0000-0000-000000000000",
"ModifiedBy": "string",
"Name": "string",
"ParentId": "00000000-0000-0000-0000-000000000000",
"ParentName": "string",
"Description": "string"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type enterpriseId
The unique identifier of the Enterprise
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Enterprise ID is invalid.
401
The user is not authorised.
404
The enterprise cannot be found or the user is forbidden access to this
enterprise.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/ENTERPRISES/{ENTERPRISEID}/STATUSES
* Get available statuses in an Enterprise
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Name (string, optional),
IsDefault (boolean, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
[
{
"Name": "string",
"IsDefault": true,
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.040Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.040Z"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type enterpriseId
The unique identifier of the Enterprise
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Enterprise ID is invalid.
401
The user is not authorised.
404
The Enterprise cannot be found or the user is forbidden access to this
Enterprise.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/ENTERPRISES/{ENTERPRISEID}/USERS
* Get available Users in an Enterprise
WARNING: DEPRECATED
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
[
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type enterpriseId
The unique identifier of the Enterprise
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Enterprise ID is invalid.
401
The user is not authorised.
404
The enterprise cannot be found or the user is forbidden access to this
enterprise.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/ENTERPRISES/{ENTERPRISEID}/WORKFLOWS
* Get available workflows in an Enterprise
* Authorize
RESPONSE CLASS (STATUS 200)
Workflows retrieved successfully.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Name (string, optional),
Description (string, optional),
WorkflowType (string, optional),
State (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
[
{
"Name": "string",
"Description": "string",
"WorkflowType": "string",
"State": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.042Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.042Z"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type enterpriseId
The unique identifier of the Enterprise
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Enterprise ID is invalid.
401
The user is not authorised.
404
The Enterprise cannot be found or the user is forbidden access to this
enterprise.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V2/ENTERPRISES/{ENTERPRISEID}/USERS
* Get available User profiles in an Enterprise
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
[
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type enterpriseId
The unique identifier of the Enterprise
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Enterprise ID is invalid.
401
The user is not authorised.
404
The enterprise cannot be found or the user is forbidden access to this
enterprise.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* PROJECTS
* Developer Notes
* Show/Hide
* List Operations
* Expand Operations
* Help
Projects may contain DocumentFolders, StaticVirtualContainers,
DynamicVirtualContainers as well as other Projects. They may be created under
Site level but not under Enterprise level.
* * POST /VFP/API/V1/PROJECTS
* Create a Project
* Authorize
RESPONSE CLASS (STATUS 201)
Project created successfully.
* Model
* Example Value
Project {
Description (string, optional),
Name (string, optional),
ParentId (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
{
"Description": "string",
"Name": "string",
"ParentId": "00000000-0000-0000-0000-000000000000",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.044Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.044Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type projectCreate
Parameter content type: application/json
Create project model
body
* Model
* Example Value
ProjectCreate {
Name (string),
Description (string, optional),
ParentId (string)
}
{
"Name": "string",
"Description": "string",
"ParentId": "00000000-0000-0000-0000-000000000000"
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Project model is incorrect.
401
The user is not authorised.
404
The parent Site or Project cannot be found or the user is forbidden
access to either.
409
A Project matching the supplied Project already exists in the parent.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /VFP/API/V1/PROJECTS/{PROJECTID}
* Delete a Project
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type projectId
The unique identifier of the Project
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
Project deleted successfully.
400
The supplied Project ID is invalid.
401
The user is not authorised.
404
The Project cannot be found or the user is forbidden access to this
project.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/PROJECTS/{PROJECTID}
* Get a Project
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Project {
Description (string, optional),
Name (string, optional),
ParentId (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
{
"Description": "string",
"Name": "string",
"ParentId": "00000000-0000-0000-0000-000000000000",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.047Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.047Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type projectId
The unique identifier of the Project
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Project ID is invalid.
401
The user is not authorised.
404
The Project cannot be found or the user is forbidden access to this
project.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PATCH /VFP/API/V1/PROJECTS/{PROJECTID}
* Update a Project
* Authorize
RESPONSE CLASS (STATUS 200)
Project updated successfully.
* Model
* Example Value
Project {
Description (string, optional),
Name (string, optional),
ParentId (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
{
"Description": "string",
"Name": "string",
"ParentId": "00000000-0000-0000-0000-000000000000",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.048Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.048Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type projectId
The unique identifier of the Project
path string projectUpdate
Parameter content type: application/json
Update Project model
body
* Model
* Example Value
ProjectUpdate {
Description (string, optional),
Name (string, optional)
}
{
"Description": "string",
"Name": "string"
}
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Project model is incorrect.
401
The user is not authorised.
404
The Project cannot be found or the user is forbidden access to this
project.
409
A Project matching the supplied Project already exists in this parent
entity.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and use the value of the
returned ETag header as the value of the If-Match header.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/PROJECTS/{PROJECTID}/CHILDPROJECTS
* Get available Projects in a Project
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
CreatedBy (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional),
Id (string, optional),
ModifiedBy (string, optional),
Name (string, optional),
ParentId (string, optional),
ParentName (string, optional),
Description (string, optional)
}
[
{
"CreatedBy": "string",
"CreatedAtDateTime": "2024-06-07T11:33:36.050Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.050Z",
"Id": "00000000-0000-0000-0000-000000000000",
"ModifiedBy": "string",
"Name": "string",
"ParentId": "00000000-0000-0000-0000-000000000000",
"ParentName": "string",
"Description": "string"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type projectId
The unique identifier of the Project
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Project ID is invalid.
401
The user is not authorised.
404
The Project cannot be found or the user is forbidden access to this
project.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/PROJECTS/{PROJECTID}/CLASSIFICATIONS
* Get available classifications in a Project
* Authorize
RESPONSE CLASS (STATUS 200)
Classifications retrieved successfully.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
UniclassId (string, optional),
UniclassName (string, optional),
Code (string, optional),
Title (string, optional),
Status (string, optional)
}
[
{
"UniclassId": "00000000-0000-0000-0000-000000000000",
"UniclassName": "string",
"Code": "string",
"Title": "string",
"Status": "string"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type projectId
The unique identifier of the Project
path string classificationCode
The code associated with the classification
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Project ID is invalid.
401
The user is not authorised.
404
The Project cannot be found or the user is forbidden access to this
Project.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/PROJECTS/{PROJECTID}/DISCUSSIONFOLDERS
* Get available Discussion Folders in a Project
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
CreatedBy (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional),
Id (string, optional),
ModifiedBy (string, optional),
Name (string, optional),
ParentId (string, optional),
ParentName (string, optional),
Description (string, optional)
}
[
{
"CreatedBy": "string",
"CreatedAtDateTime": "2024-06-07T11:33:36.052Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.052Z",
"Id": "00000000-0000-0000-0000-000000000000",
"ModifiedBy": "string",
"Name": "string",
"ParentId": "00000000-0000-0000-0000-000000000000",
"ParentName": "string",
"Description": "string"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type projectId
The unique identifier of the Project
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Project ID is invalid.
401
The user is not authorised.
404
The Project cannot be found or the user is forbidden access to this
project.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/PROJECTS/{PROJECTID}/DISTRIBUTIONGROUPS
* Get available Distribution Groups in a Project
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
[
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type projectId
The unique identifier of the Project
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Project ID is invalid.
401
The user is not authorised.
404
The project cannot be found or the user is forbidden access to this
project.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/PROJECTS/{PROJECTID}/DOCUMENTFOLDERS
* Get available Document Folders in a Project
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
CreatedBy (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional),
Description (string, optional),
FullPath (string, optional),
Id (string, optional),
ModifiedBy (string, optional),
Name (string, optional),
ParentId (string, optional),
ParentName (string, optional),
PrimaryKey (string, optional),
SequenceNumber (string, optional),
State (string, optional)
}
[
{
"CreatedBy": "string",
"CreatedAtDateTime": "2024-06-07T11:33:36.054Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.054Z",
"Description": "string",
"FullPath": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"ModifiedBy": "string",
"Name": "string",
"ParentId": "00000000-0000-0000-0000-000000000000",
"ParentName": "string",
"PrimaryKey": "00000000-0000-0000-0000-000000000000",
"SequenceNumber": "string",
"State": "string"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type projectId
The unique identifier of the Project
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Project ID is invalid.
401
The user is not authorised.
404
The Project cannot be found or the user is forbidden access to this
project.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/PROJECTS/{PROJECTID}/KEYWORDS
* Get available keywords in a Project
* Authorize
RESPONSE CLASS (STATUS 200)
Keywords retrieved successfully.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Name (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
[
{
"Name": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.056Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.056Z"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type projectId
The unique identifier of the Project
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Project ID is invalid.
401
The user is not authorised.
404
The Project cannot be found or the user is forbidden access to this
Project.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/PROJECTS/{PROJECTID}/SECURITYGROUPS
* Get available Security Groups in a Project
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
[
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type projectId
The unique identifier of the Project
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Project ID is invalid.
401
The user is not authorised.
404
The project cannot be found or the user is forbidden access to this
project.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/PROJECTS/{PROJECTID}/STATUSES
* Get available statuses in a Project
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Name (string, optional),
IsDefault (boolean, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
[
{
"Name": "string",
"IsDefault": true,
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.058Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.058Z"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type projectId
The unique identifier of the Project
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Project ID is invalid.
401
The user is not authorised.
404
The Project cannot be found or the user is forbidden access to this
Project.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/PROJECTS/{PROJECTID}/TASKFOLDERS
* Get available Task Folders in a Project
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
CreatedBy (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional),
Id (string, optional),
ModifiedBy (string, optional),
Name (string, optional),
ParentId (string, optional),
ParentName (string, optional),
Description (string, optional)
}
[
{
"CreatedBy": "string",
"CreatedAtDateTime": "2024-06-07T11:33:36.059Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.059Z",
"Id": "00000000-0000-0000-0000-000000000000",
"ModifiedBy": "string",
"Name": "string",
"ParentId": "00000000-0000-0000-0000-000000000000",
"ParentName": "string",
"Description": "string"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type projectId
The unique identifier of the Project
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Project ID is invalid.
401
The user is not authorised.
404
The Project cannot be found or the user is forbidden access to this
project.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/PROJECTS/{PROJECTID}/USERS
* Get available Users in a Project
WARNING: DEPRECATED
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
[
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type projectId
The unique identifier of the Project
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Project ID is invalid.
401
The user is not authorised.
404
The project cannot be found or the user is forbidden access to this
project.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/PROJECTS/{PROJECTID}/WORKFLOWS
* Get available workflows in a Project
* Authorize
RESPONSE CLASS (STATUS 200)
Workflows retrieved successfully.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Name (string, optional),
Description (string, optional),
WorkflowType (string, optional),
State (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
[
{
"Name": "string",
"Description": "string",
"WorkflowType": "string",
"State": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.061Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.061Z"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type projectId
The unique identifier of the Project
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Project ID is invalid.
401
The user is not authorised.
404
The Project cannot be found or the user is forbidden access to this
project.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V2/PROJECTS/{PROJECTID}/USERS
* Get available User profiles in a Project
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
[
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type projectId
The unique identifier of the Project
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Project ID is invalid.
401
The user is not authorised.
404
The project cannot be found or the user is forbidden access to this
project.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* SITES
* Developer Notes
* Show/Hide
* List Operations
* Expand Operations
* Help
Sites may contain Projects and DocumentFolders. They can only be created
directly under Enterprise level.
* * POST /VFP/API/V1/SITES
* Create a Site
IMPLEMENTATION NOTES
A Site can only exist under an Enterprise, therefore the ParentId of the
new Site must be the Id of an Enterprise.
* Authorize
RESPONSE CLASS (STATUS 201)
Site created successfully.
* Model
* Example Value
Site {
Description (string, optional),
Name (string, optional),
ParentId (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
{
"Description": "string",
"Name": "string",
"ParentId": "00000000-0000-0000-0000-000000000000",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.064Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.064Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type siteCreate
Parameter content type: application/json
Create Site model
body
* Model
* Example Value
SiteCreate {
Description (string, optional),
ParentId (string),
Name (string)
}
{
"Description": "string",
"ParentId": "00000000-0000-0000-0000-000000000000",
"Name": "string"
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Site model is incorrect.
401
The user is not authorised.
404
The enterprise cannot be found or the user is forbidden access to this
enterprise.
409
A Site name matching the supplied Site name already exists in this
enterprise.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /VFP/API/V1/SITES/{SITEID}
* Delete a Site
IMPLEMENTATION NOTES
Deleting a Site will also delete everything inside it.
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type siteId
The unique identifier of the Site
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
Site deleted successfully.
400
The supplied Site ID is invalid.
401
The user is not authorised.
404
The Site cannot be found or the user is forbidden access to this site.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/SITES/{SITEID}
* Get a Site
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Site {
Description (string, optional),
Name (string, optional),
ParentId (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
{
"Description": "string",
"Name": "string",
"ParentId": "00000000-0000-0000-0000-000000000000",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.069Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.069Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type siteId
The unique identifier of the Site
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Site ID is invalid.
401
The user is not authorised.
404
The Site cannot be found or the user is forbidden access to this site.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PATCH /VFP/API/V1/SITES/{SITEID}
* Update a Site
IMPLEMENTATION NOTES
A Site can only exist under an Enterprise, therefore the ParentId of the
Site must be the Id of an Enterprise.
* Authorize
RESPONSE CLASS (STATUS 200)
Site updated successfully.
* Model
* Example Value
Site {
Description (string, optional),
Name (string, optional),
ParentId (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
{
"Description": "string",
"Name": "string",
"ParentId": "00000000-0000-0000-0000-000000000000",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.070Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.070Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type siteId
The unique identifier of the Site
path string siteUpdate
Parameter content type: application/json
Update Site model
body
* Model
* Example Value
SiteUpdate {
Description (string, optional),
Name (string)
}
{
"Description": "string",
"Name": "string"
}
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Site model is incorrect.
401
The user is not authorised.
404
The Site cannot be found or the user is forbidden access to this site.
409
A Site name matching the supplied Site name already exists in this
enterprise.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and use the value of the
returned ETag header as the value of the If-Match header.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/SITES/{SITEID}/CLASSIFICATIONS
* Get available classifications in a Site
* Authorize
RESPONSE CLASS (STATUS 200)
Classifications retrieved successfully.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
UniclassId (string, optional),
UniclassName (string, optional),
Code (string, optional),
Title (string, optional),
Status (string, optional)
}
[
{
"UniclassId": "00000000-0000-0000-0000-000000000000",
"UniclassName": "string",
"Code": "string",
"Title": "string",
"Status": "string"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type siteId
The unique identifier of the Site
path string classificationCode
The code associated with the classification
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Site ID is invalid.
401
The user is not authorised.
404
The Site cannot be found or the user is forbidden access to this Site.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/SITES/{SITEID}/DISTRIBUTIONGROUPS
* Get available Distribution Groups in an Site
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
[
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type siteId
The unique identifier of the Site
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Site ID is invalid.
401
The user is not authorised.
404
The site cannot be found or the user is forbidden access to this site.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/SITES/{SITEID}/DOCUMENTFOLDERS
* Get available Document Folders in a Site
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
CreatedBy (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional),
Description (string, optional),
FullPath (string, optional),
Id (string, optional),
ModifiedBy (string, optional),
Name (string, optional),
ParentId (string, optional),
ParentName (string, optional),
PrimaryKey (string, optional),
SequenceNumber (string, optional),
State (string, optional)
}
[
{
"CreatedBy": "string",
"CreatedAtDateTime": "2024-06-07T11:33:36.074Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.074Z",
"Description": "string",
"FullPath": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"ModifiedBy": "string",
"Name": "string",
"ParentId": "00000000-0000-0000-0000-000000000000",
"ParentName": "string",
"PrimaryKey": "00000000-0000-0000-0000-000000000000",
"SequenceNumber": "string",
"State": "string"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type siteId
The unique identifier of the Site
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Site ID is invalid.
401
The user is not authorised.
404
The Site cannot be found or the user is forbidden access to this site.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/SITES/{SITEID}/KEYWORDS
* Get available keywords in a Site
* Authorize
RESPONSE CLASS (STATUS 200)
Keywords retrieved successfully.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Name (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
[
{
"Name": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.075Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.075Z"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type siteId
The unique identifier of the Site
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Site ID is invalid.
401
The user is not authorised.
404
The Site cannot be found or the user is forbidden access to this Site.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/SITES/{SITEID}/PROJECTS
* Get available Projects in a Site
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
CreatedBy (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional),
Id (string, optional),
ModifiedBy (string, optional),
Name (string, optional),
ParentId (string, optional),
ParentName (string, optional),
Description (string, optional)
}
[
{
"CreatedBy": "string",
"CreatedAtDateTime": "2024-06-07T11:33:36.076Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.076Z",
"Id": "00000000-0000-0000-0000-000000000000",
"ModifiedBy": "string",
"Name": "string",
"ParentId": "00000000-0000-0000-0000-000000000000",
"ParentName": "string",
"Description": "string"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type siteId
The unique identifier of the Site
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Site ID is invalid.
401
The user is not authorised.
404
The Site cannot be found or the user is forbidden access to this site.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/SITES/{SITEID}/SECURITYGROUPS
* Get available Security Groups in an Site
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
[
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type siteId
The unique identifier of the Site
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Site ID is invalid.
401
The user is not authorised.
404
The site cannot be found or the user is forbidden access to this site.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/SITES/{SITEID}/STATUSES
* Get available statuses in a Site
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Name (string, optional),
IsDefault (boolean, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
[
{
"Name": "string",
"IsDefault": true,
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.078Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.078Z"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type siteId
The unique identifier of the Site
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Site ID is invalid.
401
The user is not authorised.
404
The Site cannot be found or the user is forbidden access to this Site.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/SITES/{SITEID}/USERS
* Get available Users in a Site
WARNING: DEPRECATED
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
[
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type siteId
The unique identifier of the Site
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Site ID is invalid.
401
The user is not authorised.
404
The site cannot be found or the user is forbidden access to this site.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/SITES/{SITEID}/WORKFLOWS
* Get available workflows in a Site
* Authorize
RESPONSE CLASS (STATUS 200)
Workflows retrieved successfully.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Name (string, optional),
Description (string, optional),
WorkflowType (string, optional),
State (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
[
{
"Name": "string",
"Description": "string",
"WorkflowType": "string",
"State": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.080Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.080Z"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type siteId
The unique identifier of the Site
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Site ID is invalid.
401
The user is not authorised.
404
The Site cannot be found or the user is forbidden access to this Site.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V2/SITES/{SITEID}/USERS
* Get available User profiles in a Site
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
[
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type siteId
The unique identifier of the Site
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Site ID is invalid.
401
The user is not authorised.
404
The site cannot be found or the user is forbidden access to this site.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* STATICVIRTUALCONTAINERS
* Developer Notes
* Show/Hide
* List Operations
* Expand Operations
* Help
A static virtual container contains static references to documents from
elsewhere within an enterprise. It may also contain StaticVirtualContainers
as children. A static virtual container displays only the specific revisions
of a document that have been attached to it. Multiple revisions of a Document
may be attached and they will not dynamically update when the Document is
revised. A static virtual container can be revised and must be assigned an
OwnerID to be valid when created. It is not possible to upload Documents into
a static virtual container.
* * POST /VFP/API/V1/SVCS
* Create a SVC
IMPLEMENTATION NOTES
The ParentId can be the unique identifier of a Project, DocumentFolder or
Static virtual container.
* Authorize
RESPONSE CLASS (STATUS 201)
Static Virtual Container created successfully.
* Model
* Example Value
SVCGet {
ParentId (string, optional),
Name (string, optional),
Workflows (Array[Workflow ], optional),
Owner (User , optional),
RevisionReference (string, optional),
RevisionStatus (string, optional),
RevisionIsPrivate (boolean, optional),
RevisionNotes (string, optional),
RevisionNotifyByEmail (boolean, optional),
RevisionWorkflows (Array[Workflow ], optional),
RevisionKeywords (Array[ContainerKeyword ], optional),
RevisionClassifications (Array[ClassificationGet ], optional),
Attachments (Array[Attachment ], optional),
CreatedAtDateTime (string, optional),
Id (string, optional),
UpdatedAtDateTime (string, optional),
Description (string, optional),
DirectAccess (boolean, optional),
AllowMarkups (boolean, optional),
IsPublic (boolean, optional),
EnforceWorkflow (boolean, optional),
ExpiryDateTime (string, optional),
Comment (string, optional)
}
Workflow {
Description (string, optional),
Name (string, optional),
IsCurrentWorkflow (boolean, optional),
StartDateTime (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
User {
Id (string, optional),
Name (string, optional)
}
ContainerKeyword {
Name (string, optional),
Id (string, optional)
}
ClassificationGet {
UniclassId (string, optional),
Code (string, optional),
Title (string, optional)
}
Attachment {
Name (string, optional),
Description (string, optional),
EntityType (string, optional),
EntityId (string, optional),
AttachmentId (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
{
"ParentId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Workflows": [
{
"Description": "string",
"Name": "string",
"IsCurrentWorkflow": true,
"StartDateTime": "2024-06-07T11:33:36.083Z",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.083Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.083Z"
}
],
"Owner": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"RevisionReference": "string",
"RevisionStatus": "string",
"RevisionIsPrivate": true,
"RevisionNotes": "string",
"RevisionNotifyByEmail": true,
"RevisionWorkflows": [
{
"Description": "string",
"Name": "string",
"IsCurrentWorkflow": true,
"StartDateTime": "2024-06-07T11:33:36.083Z",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.083Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.083Z"
}
],
"RevisionKeywords": [
{
"Name": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
],
"RevisionClassifications": [
{
"UniclassId": "00000000-0000-0000-0000-000000000000",
"Code": "string",
"Title": "string"
}
],
"Attachments": [
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.083Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.083Z"
}
],
"CreatedAtDateTime": "2024-06-07T11:33:36.083Z",
"Id": "00000000-0000-0000-0000-000000000000",
"UpdatedAtDateTime": "2024-06-07T11:33:36.083Z",
"Description": "string",
"DirectAccess": true,
"AllowMarkups": true,
"IsPublic": true,
"EnforceWorkflow": true,
"ExpiryDateTime": "2024-06-07T11:33:36.083Z",
"Comment": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type svcCreate
Parameter content type: application/json
Create SVC model
body
* Model
* Example Value
SVCCreate {
ParentId (string, optional),
Name (string),
OwnerId (string, optional),
Workflows (Array[Workflow ], optional),
RevisionReference (string, optional),
RevisionNotes (string, optional),
RevisionIsPrivate (boolean, optional),
RevisionStatusId (string, optional),
RevisionNotifyByEmail (boolean, optional),
Attachments (Array[Attachment ], optional),
RevisionKeywords (Array[Keyword ], optional),
RevisionWorkflows (Array[Workflow ], optional),
RevisionClassifications (Array[Classification ], optional),
Description (string, optional),
DirectAccess (boolean, optional),
AllowMarkups (boolean, optional),
IsPublic (boolean, optional),
EnforceWorkflow (boolean, optional),
ExpiryDateTime (string, optional),
Comment (string, optional)
}
Workflow {
Id (string, optional)
}
Attachment {
EntityType (string) = ['UNDEFINED', 'DOCUMENT']
stringEnum:"UNDEFINED", "DOCUMENT"
,
EntityId (string, optional)
}
Keyword {
Id (string)
}
Classification {
UniclassId (string, optional),
Code (string, optional)
}
{
"ParentId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"OwnerId": "00000000-0000-0000-0000-000000000000",
"Workflows": [
{
"Id": "00000000-0000-0000-0000-000000000000"
}
],
"RevisionReference": "string",
"RevisionNotes": "string",
"RevisionIsPrivate": true,
"RevisionStatusId": "00000000-0000-0000-0000-000000000000",
"RevisionNotifyByEmail": true,
"Attachments": [
{
"EntityType": "UNDEFINED",
"EntityId": "00000000-0000-0000-0000-000000000000"
}
],
"RevisionKeywords": [
{
"Id": "00000000-0000-0000-0000-000000000000"
}
],
"RevisionWorkflows": [
{
"Id": "00000000-0000-0000-0000-000000000000"
}
],
"RevisionClassifications": [
{
"UniclassId": "00000000-0000-0000-0000-000000000000",
"Code": "string"
}
],
"Description": "string",
"DirectAccess": true,
"AllowMarkups": true,
"IsPublic": true,
"EnforceWorkflow": true,
"ExpiryDateTime": "2024-06-07T11:33:36.084Z",
"Comment": "string"
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Static Virtual Container model is incorrect.
401
The user is not authorised.
404
The parent entity cannot be found or the user is forbidden access to this
parent entity or the parent type id invalid.
409
A Static Virtual Container matching the supplied name exists in this
parent entity.
422
Invalid items supplied.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /VFP/API/V1/SVCS/{SVCID}
* Delete a SVC
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type svcId
The unique identifier of the SVC
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
SVC deleted successfully.
400
The supplied SVC ID is invalid.
401
The user is not authorised.
404
The SVC cannot be found or the user does not have permission to access
the entity.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/SVCS/{SVCID}
* Get a SVC
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
SVCGet {
ParentId (string, optional),
Name (string, optional),
Workflows (Array[Workflow ], optional),
Owner (User , optional),
RevisionReference (string, optional),
RevisionStatus (string, optional),
RevisionIsPrivate (boolean, optional),
RevisionNotes (string, optional),
RevisionNotifyByEmail (boolean, optional),
RevisionWorkflows (Array[Workflow ], optional),
RevisionKeywords (Array[ContainerKeyword ], optional),
RevisionClassifications (Array[ClassificationGet ], optional),
Attachments (Array[Attachment ], optional),
CreatedAtDateTime (string, optional),
Id (string, optional),
UpdatedAtDateTime (string, optional),
Description (string, optional),
DirectAccess (boolean, optional),
AllowMarkups (boolean, optional),
IsPublic (boolean, optional),
EnforceWorkflow (boolean, optional),
ExpiryDateTime (string, optional),
Comment (string, optional)
}
Workflow {
Description (string, optional),
Name (string, optional),
IsCurrentWorkflow (boolean, optional),
StartDateTime (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
User {
Id (string, optional),
Name (string, optional)
}
ContainerKeyword {
Name (string, optional),
Id (string, optional)
}
ClassificationGet {
UniclassId (string, optional),
Code (string, optional),
Title (string, optional)
}
Attachment {
Name (string, optional),
Description (string, optional),
EntityType (string, optional),
EntityId (string, optional),
AttachmentId (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
{
"ParentId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Workflows": [
{
"Description": "string",
"Name": "string",
"IsCurrentWorkflow": true,
"StartDateTime": "2024-06-07T11:33:36.086Z",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.086Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.086Z"
}
],
"Owner": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"RevisionReference": "string",
"RevisionStatus": "string",
"RevisionIsPrivate": true,
"RevisionNotes": "string",
"RevisionNotifyByEmail": true,
"RevisionWorkflows": [
{
"Description": "string",
"Name": "string",
"IsCurrentWorkflow": true,
"StartDateTime": "2024-06-07T11:33:36.086Z",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.086Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.086Z"
}
],
"RevisionKeywords": [
{
"Name": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
],
"RevisionClassifications": [
{
"UniclassId": "00000000-0000-0000-0000-000000000000",
"Code": "string",
"Title": "string"
}
],
"Attachments": [
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.086Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.086Z"
}
],
"CreatedAtDateTime": "2024-06-07T11:33:36.086Z",
"Id": "00000000-0000-0000-0000-000000000000",
"UpdatedAtDateTime": "2024-06-07T11:33:36.086Z",
"Description": "string",
"DirectAccess": true,
"AllowMarkups": true,
"IsPublic": true,
"EnforceWorkflow": true,
"ExpiryDateTime": "2024-06-07T11:33:36.086Z",
"Comment": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type svcId
The unique identifier of the SVC
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied SVC ID is invalid.
401
The user is not authorised.
404
The SVC cannot be found or the user is forbidden access to this SVC.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PATCH /VFP/API/V1/SVCS/{SVCID}
* Update a SVC
* Authorize
RESPONSE CLASS (STATUS 200)
Static Virtual Container updated successfully.
* Model
* Example Value
SVCGet {
ParentId (string, optional),
Name (string, optional),
Workflows (Array[Workflow ], optional),
Owner (User , optional),
RevisionReference (string, optional),
RevisionStatus (string, optional),
RevisionIsPrivate (boolean, optional),
RevisionNotes (string, optional),
RevisionNotifyByEmail (boolean, optional),
RevisionWorkflows (Array[Workflow ], optional),
RevisionKeywords (Array[ContainerKeyword ], optional),
RevisionClassifications (Array[ClassificationGet ], optional),
Attachments (Array[Attachment ], optional),
CreatedAtDateTime (string, optional),
Id (string, optional),
UpdatedAtDateTime (string, optional),
Description (string, optional),
DirectAccess (boolean, optional),
AllowMarkups (boolean, optional),
IsPublic (boolean, optional),
EnforceWorkflow (boolean, optional),
ExpiryDateTime (string, optional),
Comment (string, optional)
}
Workflow {
Description (string, optional),
Name (string, optional),
IsCurrentWorkflow (boolean, optional),
StartDateTime (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
User {
Id (string, optional),
Name (string, optional)
}
ContainerKeyword {
Name (string, optional),
Id (string, optional)
}
ClassificationGet {
UniclassId (string, optional),
Code (string, optional),
Title (string, optional)
}
Attachment {
Name (string, optional),
Description (string, optional),
EntityType (string, optional),
EntityId (string, optional),
AttachmentId (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
{
"ParentId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Workflows": [
{
"Description": "string",
"Name": "string",
"IsCurrentWorkflow": true,
"StartDateTime": "2024-06-07T11:33:36.088Z",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.088Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.088Z"
}
],
"Owner": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"RevisionReference": "string",
"RevisionStatus": "string",
"RevisionIsPrivate": true,
"RevisionNotes": "string",
"RevisionNotifyByEmail": true,
"RevisionWorkflows": [
{
"Description": "string",
"Name": "string",
"IsCurrentWorkflow": true,
"StartDateTime": "2024-06-07T11:33:36.088Z",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.088Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.088Z"
}
],
"RevisionKeywords": [
{
"Name": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
],
"RevisionClassifications": [
{
"UniclassId": "00000000-0000-0000-0000-000000000000",
"Code": "string",
"Title": "string"
}
],
"Attachments": [
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.088Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.088Z"
}
],
"CreatedAtDateTime": "2024-06-07T11:33:36.088Z",
"Id": "00000000-0000-0000-0000-000000000000",
"UpdatedAtDateTime": "2024-06-07T11:33:36.088Z",
"Description": "string",
"DirectAccess": true,
"AllowMarkups": true,
"IsPublic": true,
"EnforceWorkflow": true,
"ExpiryDateTime": "2024-06-07T11:33:36.088Z",
"Comment": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type svcId
The unique identifier of the SVC
path string svcUpdate
Parameter content type: application/json
Update SVC model
body
* Model
* Example Value
SVCUpdate {
OwnerId (string, optional),
Name (string, optional),
Workflows (Array[Workflow ], optional),
RevisionReference (string, optional),
RevisionNotes (string, optional),
RevisionIsPrivate (boolean, optional),
RevisionStatusId (string, optional),
RevisionNotifyByEmail (boolean, optional),
Attachments (Array[Attachment ], optional),
RevisionKeywords (Array[Keyword ], optional),
RevisionWorkflows (Array[Workflow ], optional),
RevisionClassifications (Array[Classification ], optional),
Description (string, optional),
DirectAccess (boolean, optional),
AllowMarkups (boolean, optional),
IsPublic (boolean, optional),
EnforceWorkflow (boolean, optional),
ExpiryDateTime (string, optional),
Comment (string, optional)
}
Workflow {
Id (string, optional)
}
Attachment {
EntityType (string) = ['UNDEFINED', 'DOCUMENT']
stringEnum:"UNDEFINED", "DOCUMENT"
,
EntityId (string, optional)
}
Keyword {
Id (string)
}
Classification {
UniclassId (string, optional),
Code (string, optional)
}
{
"OwnerId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Workflows": [
{
"Id": "00000000-0000-0000-0000-000000000000"
}
],
"RevisionReference": "string",
"RevisionNotes": "string",
"RevisionIsPrivate": true,
"RevisionStatusId": "00000000-0000-0000-0000-000000000000",
"RevisionNotifyByEmail": true,
"Attachments": [
{
"EntityType": "UNDEFINED",
"EntityId": "00000000-0000-0000-0000-000000000000"
}
],
"RevisionKeywords": [
{
"Id": "00000000-0000-0000-0000-000000000000"
}
],
"RevisionWorkflows": [
{
"Id": "00000000-0000-0000-0000-000000000000"
}
],
"RevisionClassifications": [
{
"UniclassId": "00000000-0000-0000-0000-000000000000",
"Code": "string"
}
],
"Description": "string",
"DirectAccess": true,
"AllowMarkups": true,
"IsPublic": true,
"EnforceWorkflow": true,
"ExpiryDateTime": "2024-06-07T11:33:36.089Z",
"Comment": "string"
}
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Static Virtual Container model is incorrect.
401
The user is not authorised.
404
The Static Virtual Container cannot be found or the user is forbidden
access to this Static Virtual Container.
409
A Static Virtual Container matching the supplied name exists in this
parent entity.
412
Error related to the If-Match header
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/SVCS/{SVCID}/ATTACHMENTS/ADD
* Add attachments to a SVC
IMPLEMENTATION NOTES
Only documents can be added as SVC attachments. The supplied EntityType
values can be either DOCUMENT or 5
* Authorize
RESPONSE CLASS (STATUS 200)
Attachments successfully added to SVC.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Name (string, optional),
Description (string, optional),
EntityType (string, optional),
EntityId (string, optional),
AttachmentId (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
[
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.090Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.090Z"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type svcid
The unique identifier of the SVC
path string attachments
Parameter content type: application/json
Collection of attachments (document) models
body
* Model
* Example Value
Array[Attachment {
EntityType (string) = ['UNDEFINED', 'DOCUMENT']
stringEnum:"UNDEFINED", "DOCUMENT"
,
EntityId (string, optional)
}]
[
{
"EntityType": "UNDEFINED",
"EntityId": "00000000-0000-0000-0000-000000000000"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 401
The user is not authorised.
404
The parent entity cannot be found or the user is forbidden access to this
parent entity or the parent type id invalid.
412
The supplied If-Match header value does not match the parent entity's
UpdatedAtDateTime value in ticks.
422
Supplied attachment(s) are invalid.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/SVCS/{SVCID}/ATTACHMENTS/REMOVE
* Remove attachments from a SVC
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type svcid
The unique identifier of the SVC
path string attachments
Parameter content type: application/json
Collection of attachment models
body
* Model
* Example Value
Array[Attachment {
AttachmentId (string, optional)
}]
[
{
"AttachmentId": "00000000-0000-0000-0000-000000000000"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
Removed attachment(s) from the specified SVC successfully.
400
The supplied SVC ID or Attachment model is invalid.
401
The user is not authorised.
404
The SVC cannot be found or the user is forbidden access to this SVC.
412
Etag precondition failed.
422
Error saving updated revision.
500
Internal server error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/SVCS/{SVCID}/CLASSIFICATIONS/ADD
* Add classifications to a SVC's current revision
* Authorize
RESPONSE CLASS (STATUS 200)
Classifications added successfully.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
UniclassId (string, optional),
Code (string, optional),
Title (string, optional)
}
[
{
"UniclassId": "00000000-0000-0000-0000-000000000000",
"Code": "string",
"Title": "string"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type svcId
The unique identifier of the SVC
path string classifications
Parameter content type: application/json
A collection of classification models
body
* Model
* Example Value
Array[Classification {
UniclassId (string, optional),
Code (string, optional)
}]
[
{
"UniclassId": "00000000-0000-0000-0000-000000000000",
"Code": "string"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied SVC ID or classifications model is invalid.
401
The user is not authorised.
404
The SVC cannot be found or the user does not have permission to access
the SVC.
412
Etag precondition failed
422
The supplied Classification(s) is invalid.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/SVCS/{SVCID}/CLASSIFICATIONS/REMOVE
* Remove classifications from a SVC's current revision
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type svcId
The unique identifier of the Document
path string classifications
Parameter content type: application/json
Collection of classification models
body
* Model
* Example Value
Array[Classification {
UniclassId (string, optional),
Code (string, optional)
}]
[
{
"UniclassId": "00000000-0000-0000-0000-000000000000",
"Code": "string"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
Classifications removed successfully.
400
The supplied SVC ID or classifications model is invalid.
401
The user is not authorised.
404
The SVC cannot be found or the user does not have permission to access
the SVC.
412
Etag precondition failed
422
The supplied Classification(s) is invalid.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/SVCS/{SVCID}/KEYWORDS/ADD
* Add keywords to a SVC
* Authorize
RESPONSE CLASS (STATUS 200)
Keywords successfully added to SVC.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Name (string, optional),
Id (string, optional)
}
[
{
"Name": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type svcid
The unique identifier of the SVC
path string keywords
Parameter content type: application/json
Collection of keyword Ids
body
* Model
* Example Value
Array[Keyword {
Id (string)
}]
[
{
"Id": "00000000-0000-0000-0000-000000000000"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 401
The user is not authorised.
404
The parent entity cannot be found or the user is forbidden access to this
parent entity or the parent type id invalid.
412
The supplied If-Match header value does not match the parent entity's
UpdatedAtDateTime value in ticks.
422
Supplied keyword(s) are invalid.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/SVCS/{SVCID}/KEYWORDS/REMOVE
* Remove keywords from a SVC's Revision
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type svcId
The unique identifier of the SVC
path string keywordIds
Parameter content type: application/json
Collection of keyword Ids
body
* Model
* Example Value
Array[Keyword {
Id (string)
}]
[
{
"Id": "00000000-0000-0000-0000-000000000000"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
Keywords removed successfully.
400
The supplied SVC ID or Keyword IDs are invalid.
401
The user is not authorised.
404
The svc or keywords could not be found or the user is forbidden access to
this svc.
412
Etag precondition failed
422
Supplied keywords are invalid
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/SVCS/{SVCID}/REVISIONS
* Create a SVC revision
* Authorize
RESPONSE CLASS (STATUS 201)
Successfully added revision to SVC.
* Model
* Example Value
SVCRevisionGet {
RevisionReference (string, optional),
RevisionStatus (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
{
"RevisionReference": "string",
"RevisionStatus": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.099Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.099Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type svcid
The unique identifier of the SVC
path string If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied SVC ID is invalid.
401
The user is not authorised.
404
The SVC cannot be found or the user is forbidden access to this SVC.
412
Etag precondition failed.
422
Error saving SVC.
500
Internal server error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/SVCS/{SVCID}/REVISIONWORKFLOWS/ADD
* Add workflows to a SVC's current revision
IMPLEMENTATION NOTES
Only "Static Virtual Container Revision" workflow types can be added as a
SVC Revision's workflow.
* Authorize
RESPONSE CLASS (STATUS 200)
Workflows successfully added to SVC's Revision.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Description (string, optional),
Name (string, optional),
IsCurrentWorkflow (boolean, optional),
StartDateTime (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
[
{
"Description": "string",
"Name": "string",
"IsCurrentWorkflow": true,
"StartDateTime": "2024-06-07T11:33:36.101Z",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.101Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.101Z"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type svcid
The unique identifier of the SVC
path string workflows
Parameter content type: application/json
Collection of workflow models
body
* Model
* Example Value
Array[Workflow {
Id (string, optional)
}]
[
{
"Id": "00000000-0000-0000-0000-000000000000"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 401
The user is not authorised.
404
The parent entity cannot be found or the user is forbidden access to this
parent entity or the parent type id invalid.
412
The supplied If-Match header value does not match the parent entity's
UpdatedAtDateTime value in ticks.
422
Supplied workflow(s) are invalid.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/SVCS/{SVCID}/REVISIONWORKFLOWS/REMOVE
* Remove workflows a SVC's current revision
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type svcId
The unique identifier of the SVC
path string revisionWorkflows
Parameter content type: application/json
A collection of revision workflow models
body
* Model
* Example Value
Array[Workflow {
Id (string, optional)
}]
[
{
"Id": "00000000-0000-0000-0000-000000000000"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
Removed revision workflow(s) from the specified SVC successfully.
400
The supplied SVC ID or Workflow model is invalid.
401
The user is not authorised.
404
The SVC cannot be found or the user is forbidden access to this SVC.
412
Etag precondition failed.
422
Error saving updated revision.
500
Internal server error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/SVCS/{SVCID}/UPDATEDATTACHMENTS
* Get SVC updated attachments
IMPLEMENTATION NOTES
Gets a collection of attachments that have been revised since being added
as attachments to the SVC.
* Authorize
RESPONSE CLASS (STATUS 200)
Updated attachments retrieved successfully.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Name (string, optional),
Description (string, optional),
EntityType (string, optional),
EntityId (string, optional),
AttachmentId (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
[
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.106Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.106Z"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type svcId
The unique identifier of the SVC
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied SVC ID is invalid.
401
The user is not authorised.
404
The SVC cannot be found or the user is forbidden access to this SVC.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/SVCS/{SVCID}/WORKFLOWS/ADD
* Add workflows to a SVC
IMPLEMENTATION NOTES
Only "Static Container" workflow types can be added as a SVC workflow.
* Authorize
RESPONSE CLASS (STATUS 200)
Workflows successfully added to SVC.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Description (string, optional),
Name (string, optional),
IsCurrentWorkflow (boolean, optional),
StartDateTime (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
[
{
"Description": "string",
"Name": "string",
"IsCurrentWorkflow": true,
"StartDateTime": "2024-06-07T11:33:36.107Z",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.107Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.107Z"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type svcid
The unique identifier of the SVC
path string workflows
Parameter content type: application/json
Collection of workflow models
body
* Model
* Example Value
Array[Workflow {
Id (string, optional)
}]
[
{
"Id": "00000000-0000-0000-0000-000000000000"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 401
The user is not authorised.
404
The parent entity cannot be found or the user is forbidden access to this
parent entity or the parent type id invalid.
412
The supplied If-Match header value does not match the parent entity's
UpdatedAtDateTime value in ticks.
422
Supplied workflow(s) are invalid.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/SVCS/{SVCID}/WORKFLOWS/REMOVE
* Remove workflows from a SVC
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type svcId
The unique identifier of the SVC
path string workflows
Parameter content type: application/json
A collection of workflows models
body
* Model
* Example Value
Array[Workflow {
Id (string, optional)
}]
[
{
"Id": "00000000-0000-0000-0000-000000000000"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
Removed workflow(s) from the specified SVC successfully.
400
The supplied SVC ID or Workflow model is invalid.
401
The user is not authorised.
404
The SVC cannot be found or the user is forbidden access to this SVC.
412
Etag precondition failed.
422
Error saving updated revision.
500
Internal server error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* TASKFOLDERS
* Developer Notes
* Show/Hide
* List Operations
* Expand Operations
* Help
TaskFolders may contain Tasks and TaskFolders. They can reside directly under
a Project in addition to being the children of other TaskFolders.
* * POST /VFP/API/V1/TASKFOLDERS
* Create Task Folder
IMPLEMENTATION NOTES
The ParentId is the unique identifier of the Project or Task Folder where
the new Task Folder is to be created. OverdueReminderRepeatFrequency can
be set to 'Daily', 'Weekly' or 'Monthly'. InternalRecipients and Task
assignees types can be 'Profile' or 'DistributionGroup' The
DropBoxEmailLocalPart represents the part of the DropBox email address
before the '@' symbol. The domain part of the DropBox email address
(after the '@' symbol) is added automatically by the system and the
complete DropBox email address is returned as the DropBoxEmailAddress
property of the Task Folder.
* Authorize
RESPONSE CLASS (STATUS 201)
Task Folder created successfully.
* Model
* Example Value
TaskFolder {
ParentId (string, optional),
Name (string, optional),
Description (string, optional),
ShortCodeLink (string, optional),
DropBoxEmailEnabled (boolean, optional),
DropBoxEmailAddress (string, optional),
InternalRecipients (Array[InternalRecipient ], optional),
CustomFieldGroups (Array[CustomFieldGroup ], optional),
TaskAssignees (Array[TaskAssignee ], optional),
Private (boolean, optional),
DaysFrom (integer, optional),
DueDateIsEditable (boolean, optional),
EmailRemindersOn (boolean, optional),
DaysBeforeDueDate (integer, optional),
OverdueRemindersEnabled (boolean, optional),
OverdueReminderRepeatFrequency (string, optional),
EmailReminderRepeatFrequencyOccurrences (integer, optional),
OverdueRemindersNeverEnd (boolean, optional),
DisableLocalAttachments (boolean, optional),
TaskDescriptionMandatory (boolean, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
InternalRecipient {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
CustomFieldGroup {
GroupId (string, optional),
Name (string, optional),
CustomFields (Array[CustomFieldBase ], optional)
}
TaskAssignee {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
CustomFieldBase {
MemberId (string, optional),
Name (string, optional),
Description (string, optional),
Mandatory (boolean, optional),
CustomFieldType (string, optional)
}
{
"ParentId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"ShortCodeLink": "string",
"DropBoxEmailEnabled": true,
"DropBoxEmailAddress": "string",
"InternalRecipients": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"CustomFieldGroups": [
{
"GroupId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CustomFields": [
{
"MemberId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"Mandatory": true,
"CustomFieldType": "string"
}
]
}
],
"TaskAssignees": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"Private": true,
"DaysFrom": 0,
"DueDateIsEditable": true,
"EmailRemindersOn": true,
"DaysBeforeDueDate": 0,
"OverdueRemindersEnabled": true,
"OverdueReminderRepeatFrequency": "string",
"EmailReminderRepeatFrequencyOccurrences": 0,
"OverdueRemindersNeverEnd": true,
"DisableLocalAttachments": true,
"TaskDescriptionMandatory": true,
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.111Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.111Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type taskfolderCreate
Parameter content type: application/json
Task Folder create model
body
* Model
* Example Value
TaskFolder {
ParentId (string),
Name (string),
Description (string, optional),
DropBoxEmailEnabled (boolean, optional),
DropBoxEmailLocalPart (string, optional),
InternalRecipients (Array[InternalRecipient ], optional),
TaskAssignees (Array[TaskAssignee ], optional),
Private (boolean, optional),
DaysFrom (integer, optional)
integerMin. Value:1Max. Value:99999
,
DueDateIsEditable (boolean, optional),
EmailRemindersOn (boolean, optional),
DaysBeforeDueDate (integer, optional)
integerMax. Value:99999
,
OverdueRemindersEnabled (boolean, optional),
OverdueReminderRepeatFrequency (string, optional) = ['DAILY', 'WEEKLY',
'MONTHLY']
stringEnum:"DAILY", "WEEKLY", "MONTHLY"
,
EmailReminderRepeatFrequencyOccurrences (integer, optional)
integerMax. Value:99999
,
LocalAttachmentsDisabled (boolean, optional)
}
InternalRecipient {
ProfileId (string),
Type (string) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
TaskAssignee {
ProfileId (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
{
"ParentId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"DropBoxEmailEnabled": true,
"DropBoxEmailLocalPart": "string",
"InternalRecipients": [
{
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Type": "UNDEFINED"
}
],
"TaskAssignees": [
{
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Type": "UNDEFINED"
}
],
"Private": true,
"DaysFrom": 0,
"DueDateIsEditable": true,
"EmailRemindersOn": true,
"DaysBeforeDueDate": 0,
"OverdueRemindersEnabled": true,
"OverdueReminderRepeatFrequency": "DAILY",
"EmailReminderRepeatFrequencyOccurrences": 0,
"LocalAttachmentsDisabled": true
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Task Folder model is invalid.
401
The user is not authorised.
404
The parent entity cannot be found or the user is forbidden access to the
parent entity.
409
A Task Folder matching the supplied Task Folder already exists in the
parent entity or the drop box email address is already in use.
422
The supplied Task Folder model contains invalid items.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PATCH /VFP/API/V1/TASKFOLDERS/{TASKFOLDERID}
* Update a Task Folder
WARNING: DEPRECATED
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
TaskFolder {
ParentId (string, optional),
Name (string, optional),
Description (string, optional),
ShortCodeLink (string, optional),
DropBoxEmailEnabled (boolean, optional),
DropBoxEmailAddress (string, optional),
InternalRecipients (Array[InternalRecipient ], optional),
CustomFieldGroups (Array[CustomFieldGroup ], optional),
TaskAssignees (Array[TaskAssignee ], optional),
Private (boolean, optional),
DaysFrom (integer, optional),
DueDateIsEditable (boolean, optional),
EmailRemindersOn (boolean, optional),
DaysBeforeDueDate (integer, optional),
OverdueRemindersEnabled (boolean, optional),
OverdueReminderRepeatFrequency (string, optional),
EmailReminderRepeatFrequencyOccurrences (integer, optional),
OverdueRemindersNeverEnd (boolean, optional),
DisableLocalAttachments (boolean, optional),
TaskDescriptionMandatory (boolean, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
InternalRecipient {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
CustomFieldGroup {
GroupId (string, optional),
Name (string, optional),
CustomFields (Array[CustomFieldBase ], optional)
}
TaskAssignee {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
CustomFieldBase {
MemberId (string, optional),
Name (string, optional),
Description (string, optional),
Mandatory (boolean, optional),
CustomFieldType (string, optional)
}
{
"ParentId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"ShortCodeLink": "string",
"DropBoxEmailEnabled": true,
"DropBoxEmailAddress": "string",
"InternalRecipients": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"CustomFieldGroups": [
{
"GroupId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CustomFields": [
{
"MemberId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"Mandatory": true,
"CustomFieldType": "string"
}
]
}
],
"TaskAssignees": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"Private": true,
"DaysFrom": 0,
"DueDateIsEditable": true,
"EmailRemindersOn": true,
"DaysBeforeDueDate": 0,
"OverdueRemindersEnabled": true,
"OverdueReminderRepeatFrequency": "string",
"EmailReminderRepeatFrequencyOccurrences": 0,
"OverdueRemindersNeverEnd": true,
"DisableLocalAttachments": true,
"TaskDescriptionMandatory": true,
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.113Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.113Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type taskfolderid
The unique identifier of the Task Folder
path string taskfolderUpdate
Parameter content type: application/json
The update information of the new Task Folder
body
* Model
* Example Value
TaskFolder {
Name (string),
DropBoxEmailEnabled (boolean, optional),
InternalRecipients (Array[InternalRecipient ], optional),
TaskAssignees (Array[TaskAssignee ], optional),
Private (boolean, optional),
DaysFrom (integer, optional)
integerMin. Value:1Max. Value:99999
,
DueDateIsEditable (boolean, optional),
EmailRemindersOn (boolean, optional),
DaysBeforeDueDate (integer, optional)
integerMax. Value:99999
,
OverdueRemindersEnabled (boolean, optional),
OverdueReminderRepeatFrequency (string, optional) = ['DAILY', 'WEEKLY',
'MONTHLY']
stringEnum:"DAILY", "WEEKLY", "MONTHLY"
,
EmailReminderRepeatFrequencyOccurrences (integer, optional)
integerMax. Value:99999
,
LocalAttachmentsDisabled (boolean, optional),
Description (string, optional),
DropBoxEmailLocalPart (string, optional)
}
InternalRecipient {
ProfileId (string),
Type (string) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
TaskAssignee {
ProfileId (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
{
"Name": "string",
"DropBoxEmailEnabled": true,
"InternalRecipients": [
{
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Type": "UNDEFINED"
}
],
"TaskAssignees": [
{
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Type": "UNDEFINED"
}
],
"Private": true,
"DaysFrom": 0,
"DueDateIsEditable": true,
"EmailRemindersOn": true,
"DaysBeforeDueDate": 0,
"OverdueRemindersEnabled": true,
"OverdueReminderRepeatFrequency": "DAILY",
"EmailReminderRepeatFrequencyOccurrences": 0,
"LocalAttachmentsDisabled": true,
"Description": "string",
"DropBoxEmailLocalPart": "string"
}
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Task Folder ID is invalid.
401
The user is not authorised.
404
The Task Folder cannot be found or the user is forbidden access to this
Task Folder.
409
A Task Folder matching the supplied Task Folder already exists in the
parent entity or the drop box email address is already in use.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and use the value of the
returned ETag header as the value of the If-Match header.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /VFP/API/V1/TASKFOLDERS/{TASKFOLDERID}
* Delete a Task Folder
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type taskFolderId
The unique identifier of the Task Folder
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
Task folder removed successfully.
400
The supplied TaskFolder ID is invalid.
401
The user is not authorised.
404
The Task Folder cannot be found, or the user is forbidden access to this
Task Folder.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/TASKFOLDERS/{TASKFOLDERID}
* Get a Task Folder
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
TaskFolder {
ParentId (string, optional),
Name (string, optional),
Description (string, optional),
ShortCodeLink (string, optional),
DropBoxEmailEnabled (boolean, optional),
DropBoxEmailAddress (string, optional),
InternalRecipients (Array[InternalRecipient ], optional),
CustomFieldGroups (Array[CustomFieldGroup ], optional),
TaskAssignees (Array[TaskAssignee ], optional),
Private (boolean, optional),
DaysFrom (integer, optional),
DueDateIsEditable (boolean, optional),
EmailRemindersOn (boolean, optional),
DaysBeforeDueDate (integer, optional),
OverdueRemindersEnabled (boolean, optional),
OverdueReminderRepeatFrequency (string, optional),
EmailReminderRepeatFrequencyOccurrences (integer, optional),
OverdueRemindersNeverEnd (boolean, optional),
DisableLocalAttachments (boolean, optional),
TaskDescriptionMandatory (boolean, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
InternalRecipient {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
CustomFieldGroup {
GroupId (string, optional),
Name (string, optional),
CustomFields (Array[CustomFieldBase ], optional)
}
TaskAssignee {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
CustomFieldBase {
MemberId (string, optional),
Name (string, optional),
Description (string, optional),
Mandatory (boolean, optional),
CustomFieldType (string, optional)
}
{
"ParentId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"ShortCodeLink": "string",
"DropBoxEmailEnabled": true,
"DropBoxEmailAddress": "string",
"InternalRecipients": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"CustomFieldGroups": [
{
"GroupId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CustomFields": [
{
"MemberId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"Mandatory": true,
"CustomFieldType": "string"
}
]
}
],
"TaskAssignees": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"Private": true,
"DaysFrom": 0,
"DueDateIsEditable": true,
"EmailRemindersOn": true,
"DaysBeforeDueDate": 0,
"OverdueRemindersEnabled": true,
"OverdueReminderRepeatFrequency": "string",
"EmailReminderRepeatFrequencyOccurrences": 0,
"OverdueRemindersNeverEnd": true,
"DisableLocalAttachments": true,
"TaskDescriptionMandatory": true,
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.117Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.117Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type taskFolderId
The unique identifier of the Task Folder
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Task Folder ID is invalid.
401
The user is not authorised.
404
The Task Folder cannot be found or the user is forbidden access to this
Task Folder.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/TASKFOLDERS/{TASKFOLDERID}/ASSIGNEES
* Get available Assignees for a Task in a TaskFolder
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
[
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type taskfolderId
The unique identifier of the TaskFolder
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied TaskFolder ID is invalid.
401
The user is not authorised.
404
The TaskFolder cannot be found or the user is forbidden access to this
TaskFolder.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/TASKFOLDERS/{TASKFOLDERID}/ASSIGNEES/ADD
* Add Assignees to a Task Folder
* Authorize
RESPONSE CLASS (STATUS 200)
Assignees added successfully.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
[
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type taskFolderId
The unique identifier of the Task Folder
path string assignees
Parameter content type: application/json
A collection of assignee models
body
* Model
* Example Value
Array[TaskAssignee {
ProfileId (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}]
[
{
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Type": "UNDEFINED"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Task Folder ID or assignees model is invalid.
401
The user is not authorised.
404
The task folder cannot be found or the user lacks permissions.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
422
The supplied Assignees model is incorrect.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/TASKFOLDERS/{TASKFOLDERID}/ASSIGNEES/REMOVE
* Remove Assignees from a Task Folder
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type taskFolderId
The unique identifier of the Task Folder
path string assigneesIds
Parameter content type: application/json
A collection of unique identifiers of the Assignees to remove
body
* Model
* Example Value
Array[TaskAssignee {
ProfileId (string)
}]
[
{
"ProfileId": "00000000-0000-0000-0000-000000000000"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
Assignees removed successfully.
400
The supplied Task Folder ID or Assignee IDs are invalid.
401
The user is not authorised.
404
The task folder could not be found or the user lacks permissions.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
422
Supplied Assignees are invalid
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/TASKFOLDERS/{TASKFOLDERID}/RECIPIENTS/ADD
* Add Recipients to a Task Folder
* Authorize
RESPONSE CLASS (STATUS 200)
Recipients added successfully.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
[
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type taskFolderId
The unique identifier of the Task Folder
path string recipients
Parameter content type: application/json
A collection of recipient models
body
* Model
* Example Value
Array[InternalRecipient {
ProfileId (string),
Type (string) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}]
[
{
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Type": "UNDEFINED"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Task Folder ID or recipients model is invalid.
401
The user is not authorised.
404
The task folder cannot be found or the user lacks permissions.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
422
The supplied Recipients model is incorrect.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/TASKFOLDERS/{TASKFOLDERID}/RECIPIENTS/REMOVE
* Remove Recipients from a Task Folder
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type taskFolderId
The unique identifier of the Task Folder
path string recipientIds
Parameter content type: application/json
A collection of unique identifiers of the Recipients to remove
body
* Model
* Example Value
Array[InternalRecipient {
ProfileId (string)
}]
[
{
"ProfileId": "00000000-0000-0000-0000-000000000000"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
Recipients removed successfully.
400
The supplied Task Folder ID or Recipient IDs are invalid.
401
The user is not authorised.
404
The task folder could not be found or the user lacks permissions.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
422
Supplied Recipients are invalid
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/TASKFOLDERS/{TASKFOLDERID}/TASKS
* Get available Tasks in a TaskFolder
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
CreatedBy (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional),
Id (string, optional),
ModifiedBy (string, optional),
Name (string, optional),
ParentId (string, optional),
ParentName (string, optional),
Description (string, optional)
}
[
{
"CreatedBy": "string",
"CreatedAtDateTime": "2024-06-07T11:33:36.126Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.126Z",
"Id": "00000000-0000-0000-0000-000000000000",
"ModifiedBy": "string",
"Name": "string",
"ParentId": "00000000-0000-0000-0000-000000000000",
"ParentName": "string",
"Description": "string"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type taskfolderId
The unique identifier of the TaskFolder
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied TaskFolder ID is invalid.
401
The user is not authorised.
404
The TaskFolder cannot be found or the user is forbidden access to this
TaskFolder.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PATCH /VFP/API/V2/TASKFOLDERS/{TASKFOLDERID}
* Update a Task Folder
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
TaskFolder {
ParentId (string, optional),
Name (string, optional),
Description (string, optional),
ShortCodeLink (string, optional),
DropBoxEmailEnabled (boolean, optional),
DropBoxEmailAddress (string, optional),
InternalRecipients (Array[InternalRecipient ], optional),
CustomFieldGroups (Array[CustomFieldGroup ], optional),
TaskAssignees (Array[TaskAssignee ], optional),
Private (boolean, optional),
DaysFrom (integer, optional),
DueDateIsEditable (boolean, optional),
EmailRemindersOn (boolean, optional),
DaysBeforeDueDate (integer, optional),
OverdueRemindersEnabled (boolean, optional),
OverdueReminderRepeatFrequency (string, optional),
EmailReminderRepeatFrequencyOccurrences (integer, optional),
OverdueRemindersNeverEnd (boolean, optional),
DisableLocalAttachments (boolean, optional),
TaskDescriptionMandatory (boolean, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
InternalRecipient {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
CustomFieldGroup {
GroupId (string, optional),
Name (string, optional),
CustomFields (Array[CustomFieldBase ], optional)
}
TaskAssignee {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
CustomFieldBase {
MemberId (string, optional),
Name (string, optional),
Description (string, optional),
Mandatory (boolean, optional),
CustomFieldType (string, optional)
}
{
"ParentId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"ShortCodeLink": "string",
"DropBoxEmailEnabled": true,
"DropBoxEmailAddress": "string",
"InternalRecipients": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"CustomFieldGroups": [
{
"GroupId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CustomFields": [
{
"MemberId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"Mandatory": true,
"CustomFieldType": "string"
}
]
}
],
"TaskAssignees": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"Private": true,
"DaysFrom": 0,
"DueDateIsEditable": true,
"EmailRemindersOn": true,
"DaysBeforeDueDate": 0,
"OverdueRemindersEnabled": true,
"OverdueReminderRepeatFrequency": "string",
"EmailReminderRepeatFrequencyOccurrences": 0,
"OverdueRemindersNeverEnd": true,
"DisableLocalAttachments": true,
"TaskDescriptionMandatory": true,
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.127Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.127Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type taskfolderid
The unique identifier of the Task Folder
path string taskfolderUpdate
Parameter content type: application/json
The update information of the new Task Folder
body
* Model
* Example Value
TaskFolderV2 {
Name (string, optional),
DropBoxEmailEnabled (boolean, optional),
Private (boolean, optional),
DaysFrom (integer, optional)
integerMin. Value:1Max. Value:99999
,
DueDateIsEditable (boolean, optional),
EmailRemindersOn (boolean, optional),
DaysBeforeDueDate (integer, optional)
integerMin. Value:1Max. Value:99999
,
OverdueRemindersEnabled (boolean, optional),
OverdueReminderRepeatFrequency (string, optional) = ['DAILY', 'WEEKLY',
'MONTHLY']
stringEnum:"DAILY", "WEEKLY", "MONTHLY"
,
EmailReminderRepeatFrequencyOccurrences (integer, optional)
integerMin. Value:-1Max. Value:99999
,
LocalAttachmentsDisabled (boolean, optional),
Description (string, optional),
DropBoxEmailLocalPart (string, optional)
}
{
"Name": "string",
"DropBoxEmailEnabled": true,
"Private": true,
"DaysFrom": 0,
"DueDateIsEditable": true,
"EmailRemindersOn": true,
"DaysBeforeDueDate": 0,
"OverdueRemindersEnabled": true,
"OverdueReminderRepeatFrequency": "DAILY",
"EmailReminderRepeatFrequencyOccurrences": 0,
"LocalAttachmentsDisabled": true,
"Description": "string",
"DropBoxEmailLocalPart": "string"
}
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Task Folder ID is invalid.
401
The user is not authorised.
404
The Task Folder cannot be found or the user is forbidden access to this
Task Folder.
409
A Task Folder matching the supplied Task Folder already exists in the
parent entity or the drop box email address is already in use.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and use the value of the
returned ETag header as the value of the If-Match header.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* TASKS
* Developer Notes
* Show/Hide
* List Operations
* Expand Operations
* Help
A Task may have one or more Revisions associated with it, with each Revision
representing a post / reply in the Task. New Tasks must be assigned a Task
Name, a Priority and an Assignee and include information within the Body Text
in order to be valid when created. Each post / reply(aka Revision) added to
an existing Task must be assigned an Assignee and include information within
the Body Text in order to be valid when created. New Tasks and posts /
replies(aka Revisions) may contain additional recipients and may also include
attachments. Only the entire Task or the latest Revision on a task may be
edited and / or deleted.
* * POST /VFP/API/V1/TASKS
* Create a Task
IMPLEMENTATION NOTES
The required fields for creating a Task are: ParentId, Name, Priority,
TaskAssigneeProfileId, Text, PercentageComplete. The
TaskAssigneeProfileId must be a valid user profile ID. The
PercentageComplete must be in the range of 0 to 100. The Attachments,
InternalRecipients and Keywords are optional. The Attachments must be a
collection of Attachment models. The InternalRecipients must be a
collection of InternalRecipient models. The Keywords must be a collection
of Keyword models. The ParentId must be a valid Task Folder ID. The
Priority must be a valid Priority enum value.
* Authorize
RESPONSE CLASS (STATUS 201)
Task created successfully.
* Model
* Example Value
Task {
ParentId (string, optional),
Priority (string, optional),
AssignedTo (User , optional),
Keywords (Array[Keyword ], optional),
CustomFieldGroups (Array[CustomFieldGroup ], optional),
ShortCode (string, optional),
ShortCodeLink (string, optional),
CurrentPostId (string, optional),
Posts (Array[TaskPost ], optional),
CreatedAtDateTime (string, optional),
Id (string, optional),
UpdatedAtDateTime (string, optional),
State (string, optional),
Attachments (Array[Attachment ], optional),
InternalRecipients (Array[InternalRecipient ], optional),
Text (string, optional),
Name (string, optional),
Description (string, optional),
DueDate (string, optional),
Private (boolean, optional),
SendEmail (boolean, optional),
ResponseRequired (boolean, optional),
ForwardingDisabled (boolean, optional),
PercentageComplete (integer, optional)
integerMax. Value:100
}
User {
Id (string, optional),
Name (string, optional)
}
Keyword {
Name (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
CustomFieldGroup {
GroupId (string, optional),
Name (string, optional),
CustomFields (Array[CustomFieldBase ], optional)
}
TaskPost {
Id (string, optional),
State (string, optional),
ShortCode (string, optional),
AssignedTo (User , optional),
InternalRecipients (Array[InternalRecipient ], optional),
Attachments (Array[Attachment ], optional),
PostedDate (string, optional),
PostedBy (User , optional),
Text (string, optional),
Revision (string, optional)
}
Attachment {
Name (string, optional),
Description (string, optional),
EntityType (string, optional),
EntityId (string, optional),
AttachmentId (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
InternalRecipient {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
CustomFieldBase {
MemberId (string, optional),
Name (string, optional),
Description (string, optional),
Mandatory (boolean, optional),
CustomFieldType (string, optional)
}
{
"ParentId": "00000000-0000-0000-0000-000000000000",
"Priority": "string",
"AssignedTo": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"Keywords": [
{
"Name": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.129Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.129Z"
}
],
"CustomFieldGroups": [
{
"GroupId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CustomFields": [
{
"MemberId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"Mandatory": true,
"CustomFieldType": "string"
}
]
}
],
"ShortCode": "string",
"ShortCodeLink": "string",
"CurrentPostId": "00000000-0000-0000-0000-000000000000",
"Posts": [
{
"Id": "00000000-0000-0000-0000-000000000000",
"State": "string",
"ShortCode": "string",
"AssignedTo": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"InternalRecipients": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"Attachments": [
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.130Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.130Z"
}
],
"PostedDate": "2024-06-07T11:33:36.130Z",
"PostedBy": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"Text": "string",
"Revision": "string"
}
],
"CreatedAtDateTime": "2024-06-07T11:33:36.130Z",
"Id": "00000000-0000-0000-0000-000000000000",
"UpdatedAtDateTime": "2024-06-07T11:33:36.130Z",
"State": "string",
"Attachments": [
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.130Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.130Z"
}
],
"InternalRecipients": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"Text": "string",
"Name": "string",
"Description": "string",
"DueDate": "2024-06-07T11:33:36.130Z",
"Private": true,
"SendEmail": true,
"ResponseRequired": true,
"ForwardingDisabled": true,
"PercentageComplete": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type taskCreate
Parameter content type: application/json
Task create model
body
* Model
* Example Value
Task {
ParentId (string, optional),
Name (string),
Priority (string) = ['HIGH', 'MEDIUM', 'LOW']
stringEnum:"HIGH", "MEDIUM", "LOW"
,
TaskAssigneeProfileId (string),
Text (string),
PercentageComplete (integer)
integerMax. Value:100
,
Attachments (Array[Attachment ], optional),
InternalRecipients (Array[InternalRecipient ], optional),
Keywords (Array[Keyword ], optional),
Description (string, optional),
DueDate (string, optional),
Private (boolean, optional),
SendEmail (boolean, optional),
ResponseRequired (boolean, optional),
ForwardingDisabled (boolean, optional)
}
Attachment {
EntityType (string) = ['UNDEFINED', 'DOCUMENT']
stringEnum:"UNDEFINED", "DOCUMENT"
,
EntityId (string, optional)
}
InternalRecipient {
ProfileId (string),
Type (string) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
Keyword {
Id (string)
}
{
"ParentId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Priority": "HIGH",
"TaskAssigneeProfileId": "00000000-0000-0000-0000-000000000000",
"Text": "string",
"PercentageComplete": 0,
"Attachments": [
{
"EntityType": "UNDEFINED",
"EntityId": "00000000-0000-0000-0000-000000000000"
}
],
"InternalRecipients": [
{
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Type": "UNDEFINED"
}
],
"Keywords": [
{
"Id": "00000000-0000-0000-0000-000000000000"
}
],
"Description": "string",
"DueDate": "2024-06-07T11:33:36.131Z",
"Private": true,
"SendEmail": true,
"ResponseRequired": true,
"ForwardingDisabled": true
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Task model is invalid.
401
The user is not authorised.
404
The parent entity cannot be found or the user is forbidden access to the
parent entity.
409
A Task matching the supplied Task already exists in the parent entity
422
The supplied Task model contains invalid items.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /VFP/API/V1/TASKS/{TASKID}
* Get a Task
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Task {
ParentId (string, optional),
Priority (string, optional),
AssignedTo (User , optional),
Keywords (Array[Keyword ], optional),
CustomFieldGroups (Array[CustomFieldGroup ], optional),
ShortCode (string, optional),
ShortCodeLink (string, optional),
CurrentPostId (string, optional),
Posts (Array[TaskPost ], optional),
CreatedAtDateTime (string, optional),
Id (string, optional),
UpdatedAtDateTime (string, optional),
State (string, optional),
Attachments (Array[Attachment ], optional),
InternalRecipients (Array[InternalRecipient ], optional),
Text (string, optional),
Name (string, optional),
Description (string, optional),
DueDate (string, optional),
Private (boolean, optional),
SendEmail (boolean, optional),
ResponseRequired (boolean, optional),
ForwardingDisabled (boolean, optional),
PercentageComplete (integer, optional)
integerMax. Value:100
}
User {
Id (string, optional),
Name (string, optional)
}
Keyword {
Name (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
CustomFieldGroup {
GroupId (string, optional),
Name (string, optional),
CustomFields (Array[CustomFieldBase ], optional)
}
TaskPost {
Id (string, optional),
State (string, optional),
ShortCode (string, optional),
AssignedTo (User , optional),
InternalRecipients (Array[InternalRecipient ], optional),
Attachments (Array[Attachment ], optional),
PostedDate (string, optional),
PostedBy (User , optional),
Text (string, optional),
Revision (string, optional)
}
Attachment {
Name (string, optional),
Description (string, optional),
EntityType (string, optional),
EntityId (string, optional),
AttachmentId (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
InternalRecipient {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
CustomFieldBase {
MemberId (string, optional),
Name (string, optional),
Description (string, optional),
Mandatory (boolean, optional),
CustomFieldType (string, optional)
}
{
"ParentId": "00000000-0000-0000-0000-000000000000",
"Priority": "string",
"AssignedTo": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"Keywords": [
{
"Name": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.132Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.132Z"
}
],
"CustomFieldGroups": [
{
"GroupId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CustomFields": [
{
"MemberId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"Mandatory": true,
"CustomFieldType": "string"
}
]
}
],
"ShortCode": "string",
"ShortCodeLink": "string",
"CurrentPostId": "00000000-0000-0000-0000-000000000000",
"Posts": [
{
"Id": "00000000-0000-0000-0000-000000000000",
"State": "string",
"ShortCode": "string",
"AssignedTo": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"InternalRecipients": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"Attachments": [
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.132Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.132Z"
}
],
"PostedDate": "2024-06-07T11:33:36.132Z",
"PostedBy": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"Text": "string",
"Revision": "string"
}
],
"CreatedAtDateTime": "2024-06-07T11:33:36.132Z",
"Id": "00000000-0000-0000-0000-000000000000",
"UpdatedAtDateTime": "2024-06-07T11:33:36.132Z",
"State": "string",
"Attachments": [
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.132Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.132Z"
}
],
"InternalRecipients": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"Text": "string",
"Name": "string",
"Description": "string",
"DueDate": "2024-06-07T11:33:36.132Z",
"Private": true,
"SendEmail": true,
"ResponseRequired": true,
"ForwardingDisabled": true,
"PercentageComplete": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type taskid
The unique identifier of the Task
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Task ID is invalid.
401
The user is not authorised.
404
The Task cannot be found or the user is forbidden access to this Task.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /VFP/API/V1/TASKS/{TASKID}
* Delete a Task
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type taskId
The unique identifier of the Task
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
Task deleted successfully.
400
The supplied Task ID is invalid.
401
The user is not authorised.
404
The Task cannot be found or the user does not have permission to access
the Task.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PATCH /VFP/API/V1/TASKS/{TASKID}
* Update a Task
IMPLEMENTATION NOTES
If moving to a new state and the Text is not provided in the request,
then the Reason is used to populate the Text field.If neither the Text
nor Reason are provided then the a default response such as: "Reopened by
APIV2_Public" will be used to populate the Text field.
If the task cannot move to a new state i.e. OPEN to REOPEN and no Text or
Reason is provided then the Text field will be the automated response to
show an edit has occurred. If ForwardingDisabled is true then the task
cannot be Redirected.
If you send a TaskAssigneeProfileId in the request the task state will go
to REDIRECTED. If you send Text in the request it will go to RESPONDED.
If you send both then it will be REDIRECTED.
The columns represent the new state being passed in the request and the
rows represent what state the discussion is currently in.
ReopenCloseClose resolveResolveRedirectOpenState unchanged.Update
successfulUpdate successfulUpdate successfulUpdate successfulUpdate
successfulReopenedState unchanged.Update successfulUpdate
successfulUpdate successfulUpdate successfulUpdate
successfulRespondedState unchanged.Update successfulUpdate
successfulUpdate successfulUpdate successfulUpdate
successfulRedirectedState unchanged.Update successfulUpdate
successfulUpdate successfulUpdate successfulState unchanged.Update
successfulOverdueState changes to RESONDEDOVERDUE if Text or a reason
included in the update.
State stays the same if no Text or a reason included in the update.
State changes to RESPONDED if a future Duedate is included in the
update.Update successfulUpdate successfulUpdate successfulUpdate
successfulResponded overdueState changes to RESPONDED if a future Duedate
is included in the update.Update successfulUpdate successfulUpdate
successfulUpdate successfulClosed unresolvedUpdate successfulCannot
edit.Update unsuccessfulCannot edit.Update unsuccessfulCannot edit.Update
unsuccessfulCannot edit.Update unsuccessfulClosed resolvedUpdate
successfulCannot edit.Update unsuccessfulCannot edit.Update
unsuccessfulCannot edit.Update unsuccessfulCannot edit.Update
unsuccessfulResolvedState unchanged.Update successfulUpdate
successfulUpdate successfulState unchanged.Update successfulUpdate
successful
* Authorize
RESPONSE CLASS (STATUS 200)
Task updated successfully.
* Model
* Example Value
Task {
ParentId (string, optional),
Priority (string, optional),
AssignedTo (User , optional),
Keywords (Array[Keyword ], optional),
CustomFieldGroups (Array[CustomFieldGroup ], optional),
ShortCode (string, optional),
ShortCodeLink (string, optional),
CurrentPostId (string, optional),
Posts (Array[TaskPost ], optional),
CreatedAtDateTime (string, optional),
Id (string, optional),
UpdatedAtDateTime (string, optional),
State (string, optional),
Attachments (Array[Attachment ], optional),
InternalRecipients (Array[InternalRecipient ], optional),
Text (string, optional),
Name (string, optional),
Description (string, optional),
DueDate (string, optional),
Private (boolean, optional),
SendEmail (boolean, optional),
ResponseRequired (boolean, optional),
ForwardingDisabled (boolean, optional),
PercentageComplete (integer, optional)
integerMax. Value:100
}
User {
Id (string, optional),
Name (string, optional)
}
Keyword {
Name (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
CustomFieldGroup {
GroupId (string, optional),
Name (string, optional),
CustomFields (Array[CustomFieldBase ], optional)
}
TaskPost {
Id (string, optional),
State (string, optional),
ShortCode (string, optional),
AssignedTo (User , optional),
InternalRecipients (Array[InternalRecipient ], optional),
Attachments (Array[Attachment ], optional),
PostedDate (string, optional),
PostedBy (User , optional),
Text (string, optional),
Revision (string, optional)
}
Attachment {
Name (string, optional),
Description (string, optional),
EntityType (string, optional),
EntityId (string, optional),
AttachmentId (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
InternalRecipient {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
CustomFieldBase {
MemberId (string, optional),
Name (string, optional),
Description (string, optional),
Mandatory (boolean, optional),
CustomFieldType (string, optional)
}
{
"ParentId": "00000000-0000-0000-0000-000000000000",
"Priority": "string",
"AssignedTo": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"Keywords": [
{
"Name": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.135Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.135Z"
}
],
"CustomFieldGroups": [
{
"GroupId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CustomFields": [
{
"MemberId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"Mandatory": true,
"CustomFieldType": "string"
}
]
}
],
"ShortCode": "string",
"ShortCodeLink": "string",
"CurrentPostId": "00000000-0000-0000-0000-000000000000",
"Posts": [
{
"Id": "00000000-0000-0000-0000-000000000000",
"State": "string",
"ShortCode": "string",
"AssignedTo": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"InternalRecipients": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"Attachments": [
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.135Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.135Z"
}
],
"PostedDate": "2024-06-07T11:33:36.135Z",
"PostedBy": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"Text": "string",
"Revision": "string"
}
],
"CreatedAtDateTime": "2024-06-07T11:33:36.135Z",
"Id": "00000000-0000-0000-0000-000000000000",
"UpdatedAtDateTime": "2024-06-07T11:33:36.135Z",
"State": "string",
"Attachments": [
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.135Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.135Z"
}
],
"InternalRecipients": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"Text": "string",
"Name": "string",
"Description": "string",
"DueDate": "2024-06-07T11:33:36.135Z",
"Private": true,
"SendEmail": true,
"ResponseRequired": true,
"ForwardingDisabled": true,
"PercentageComplete": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type taskId
The unique identifier of the Task
path string taskUpdate
Parameter content type: application/json
Update Task model
body
* Model
* Example Value
Task {
Priority (string, optional) = ['HIGH', 'MEDIUM', 'LOW']
stringEnum:"HIGH", "MEDIUM", "LOW"
,
TaskAssigneeProfileId (string, optional),
State (string, optional) = ['Reopen', 'Close', 'CloseResolve', 'Resolve',
'Redirect']
stringEnum:"Reopen", "Close", "CloseResolve", "Resolve", "Redirect"
,
Text (string, optional),
Name (string, optional),
Description (string, optional),
DueDate (string, optional),
Private (boolean, optional),
SendEmail (boolean, optional),
ResponseRequired (boolean, optional),
ForwardingDisabled (boolean, optional),
PercentageComplete (integer, optional)
integerMax. Value:100
}
{
"Priority": "HIGH",
"TaskAssigneeProfileId": "00000000-0000-0000-0000-000000000000",
"State": "Reopen",
"Text": "string",
"Name": "string",
"Description": "string",
"DueDate": "2024-06-07T11:33:36.136Z",
"Private": true,
"SendEmail": true,
"ResponseRequired": true,
"ForwardingDisabled": true,
"PercentageComplete": 0
}
reason
Optional reason
query string If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Task model is incorrect.
401
The user is not authorised.
404
The Task cannot be found or the user is forbidden access to this Task.
409
A Task matching the supplied name exists in this parent entity.
412
Error related to the If-Match header
422
The supplied Task update model contains invalid items.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/TASKS/{TASKID}/ATTACHMENTS/ADD
* Add Attachments to a Task
* Authorize
RESPONSE CLASS (STATUS 200)
Attachments added successfully.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Name (string, optional),
Description (string, optional),
EntityType (string, optional),
EntityId (string, optional),
AttachmentId (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
[
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.141Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.141Z"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type taskId
The unique identifier of the Task
path string attachments
Parameter content type: application/json
A collection of attachments models
body
* Model
* Example Value
Array[Attachment {
EntityType (string) = ['UNDEFINED', 'DOCUMENT']
stringEnum:"UNDEFINED", "DOCUMENT"
,
EntityId (string, optional)
}]
[
{
"EntityType": "UNDEFINED",
"EntityId": "00000000-0000-0000-0000-000000000000"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Task ID or attachments model is invalid.
401
The user is not authorised.
404
The task cannot be found or the user lacks permissions.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
422
The supplied Attachments model is incorrect.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/TASKS/{TASKID}/ATTACHMENTS/REMOVE
* Remove Attachments from a Task
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type taskId
The unique identifier of the Task
path string attachmentIds
Parameter content type: application/json
A collection of unique identifiers of the Attachments to remove
body
* Model
* Example Value
Array[Attachment {
AttachmentId (string, optional)
}]
[
{
"AttachmentId": "00000000-0000-0000-0000-000000000000"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
Attachments removed successfully.
400
The supplied Task ID or Attachment IDs are invalid.
401
The user is not authorised.
404
The task could not be found or the user lacks permissions.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
422
Supplied Attachments are invalid
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/TASKS/{TASKID}/KEYWORDS/ADD
* Add keywords to a Task
* Authorize
RESPONSE CLASS (STATUS 200)
Keywords added successfully.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Name (string, optional),
Id (string, optional)
}
[
{
"Name": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type taskId
The unique identifier of the Task
path string keywordIds
Parameter content type: application/json
A collection of keyword models
body
* Model
* Example Value
Array[Keyword {
Id (string)
}]
[
{
"Id": "00000000-0000-0000-0000-000000000000"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Task ID or keywords model is invalid.
401
The user is not authorised.
404
The task cannot be found or the user lacks permissions.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
422
The supplied Keywords model is incorrect.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/TASKS/{TASKID}/KEYWORDS/REMOVE
* Remove keywords from a Task
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type taskId
The unique identifier of the Task
path string keywordIds
Parameter content type: application/json
A collection of unique identifiers of the Keywords to remove
body
* Model
* Example Value
Array[Keyword {
Id (string)
}]
[
{
"Id": "00000000-0000-0000-0000-000000000000"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
Keywords removed successfully.
400
The supplied Task ID or Keyword IDs are invalid.
401
The user is not authorised.
404
The task could not be found or the user lacks permissions.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
422
Supplied keywords are invalid
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/TASKS/{TASKID}/POST
* Create a Task Post
WARNING: DEPRECATED
* Authorize
RESPONSE CLASS (STATUS 201)
Task Post created successfully.
* Model
* Example Value
Task {
ParentId (string, optional),
Priority (string, optional),
AssignedTo (User , optional),
Keywords (Array[Keyword ], optional),
CustomFieldGroups (Array[CustomFieldGroup ], optional),
ShortCode (string, optional),
ShortCodeLink (string, optional),
CurrentPostId (string, optional),
Posts (Array[TaskPost ], optional),
CreatedAtDateTime (string, optional),
Id (string, optional),
UpdatedAtDateTime (string, optional),
State (string, optional),
Attachments (Array[Attachment ], optional),
InternalRecipients (Array[InternalRecipient ], optional),
Text (string, optional),
Name (string, optional),
Description (string, optional),
DueDate (string, optional),
Private (boolean, optional),
SendEmail (boolean, optional),
ResponseRequired (boolean, optional),
ForwardingDisabled (boolean, optional),
PercentageComplete (integer, optional)
integerMax. Value:100
}
User {
Id (string, optional),
Name (string, optional)
}
Keyword {
Name (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
CustomFieldGroup {
GroupId (string, optional),
Name (string, optional),
CustomFields (Array[CustomFieldBase ], optional)
}
TaskPost {
Id (string, optional),
State (string, optional),
ShortCode (string, optional),
AssignedTo (User , optional),
InternalRecipients (Array[InternalRecipient ], optional),
Attachments (Array[Attachment ], optional),
PostedDate (string, optional),
PostedBy (User , optional),
Text (string, optional),
Revision (string, optional)
}
Attachment {
Name (string, optional),
Description (string, optional),
EntityType (string, optional),
EntityId (string, optional),
AttachmentId (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
InternalRecipient {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
CustomFieldBase {
MemberId (string, optional),
Name (string, optional),
Description (string, optional),
Mandatory (boolean, optional),
CustomFieldType (string, optional)
}
{
"ParentId": "00000000-0000-0000-0000-000000000000",
"Priority": "string",
"AssignedTo": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"Keywords": [
{
"Name": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.147Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.147Z"
}
],
"CustomFieldGroups": [
{
"GroupId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CustomFields": [
{
"MemberId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"Mandatory": true,
"CustomFieldType": "string"
}
]
}
],
"ShortCode": "string",
"ShortCodeLink": "string",
"CurrentPostId": "00000000-0000-0000-0000-000000000000",
"Posts": [
{
"Id": "00000000-0000-0000-0000-000000000000",
"State": "string",
"ShortCode": "string",
"AssignedTo": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"InternalRecipients": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"Attachments": [
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.147Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.147Z"
}
],
"PostedDate": "2024-06-07T11:33:36.147Z",
"PostedBy": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"Text": "string",
"Revision": "string"
}
],
"CreatedAtDateTime": "2024-06-07T11:33:36.147Z",
"Id": "00000000-0000-0000-0000-000000000000",
"UpdatedAtDateTime": "2024-06-07T11:33:36.147Z",
"State": "string",
"Attachments": [
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.147Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.147Z"
}
],
"InternalRecipients": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"Text": "string",
"Name": "string",
"Description": "string",
"DueDate": "2024-06-07T11:33:36.147Z",
"Private": true,
"SendEmail": true,
"ResponseRequired": true,
"ForwardingDisabled": true,
"PercentageComplete": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type taskId
The unique identifier of the Task
path string taskPostCreate
Parameter content type: application/json
Task Post create model
body
* Model
* Example Value
TaskPost {
Text (string),
TaskAssigneeProfileId (string),
PercentageComplete (integer, optional)
integerMax. Value:100
,
InternalRecipients (Array[InternalRecipient ], optional),
Attachments (Array[Attachment ], optional)
}
InternalRecipient {
ProfileId (string),
Type (string) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
Attachment {
EntityType (string) = ['UNDEFINED', 'DOCUMENT']
stringEnum:"UNDEFINED", "DOCUMENT"
,
EntityId (string, optional)
}
{
"Text": "string",
"TaskAssigneeProfileId": "00000000-0000-0000-0000-000000000000",
"PercentageComplete": 0,
"InternalRecipients": [
{
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Type": "UNDEFINED"
}
],
"Attachments": [
{
"EntityType": "UNDEFINED",
"EntityId": "00000000-0000-0000-0000-000000000000"
}
]
}
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Task Post model is invalid.
401
The user is not authorised.
404
The parent entity cannot be found or the user is forbidden access to the
parent entity.
409
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and use the value of the
returned ETag header as the value of the If-Match header.
422
The supplied Task Post model contains invalid items.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /VFP/API/V1/TASKS/{TASKID}/POSTS/{POSTID}
* Delete a Task's current post
IMPLEMENTATION NOTES
Only the current post can be deleted therefore the postId must be the id
of the current post. If the current post is deleted, the previous post
will become the current post. A task must have at least one post. If the
current post is the only post, the request will fail.
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type taskId
The unique identifier of the Task
path string postId
The unique identifier of the current post
path string If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
Current post deleted successfully.
400
The supplied Task ID or post ID is invalid.
401
The user is not authorised.
404
The Task or post cannot be found or the user is forbidden access to this
Task.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/TASKS/{TASKID}/RECIPIENTS/ADD
* Add Recipients to a Task
* Authorize
RESPONSE CLASS (STATUS 200)
Recipients added successfully.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
[
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type taskId
The unique identifier of the Task
path string recipients
Parameter content type: application/json
A collection of recipient models
body
* Model
* Example Value
Array[InternalRecipient {
ProfileId (string),
Type (string) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}]
[
{
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Type": "UNDEFINED"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Task ID or recipients model is invalid.
401
The user is not authorised.
404
The task cannot be found or the user lacks permissions.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
422
The supplied Recipients model is incorrect.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V1/TASKS/{TASKID}/RECIPIENTS/REMOVE
* Remove Recipients from a Task
* Authorize
PARAMETERS
Parameter Value Description Parameter Type Data Type taskId
The unique identifier of the Task
path string recipientIds
Parameter content type: application/json
A collection of unique identifiers of the Recipients to remove
body
* Model
* Example Value
Array[InternalRecipient {
ProfileId (string)
}]
[
{
"ProfileId": "00000000-0000-0000-0000-000000000000"
}
]
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
Recipients removed successfully.
400
The supplied Task ID or Recipient IDs are invalid.
401
The user is not authorised.
404
The task could not be found or the user lacks permissions.
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and set the If-Match header
to the value of the returned ETag header.
422
Supplied Recipients are invalid
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /VFP/API/V2/TASKS/{TASKID}/POSTS
* Create a Task Post
* Authorize
RESPONSE CLASS (STATUS 201)
Task Post created successfully.
* Model
* Example Value
Task {
ParentId (string, optional),
Priority (string, optional),
AssignedTo (User , optional),
Keywords (Array[Keyword ], optional),
CustomFieldGroups (Array[CustomFieldGroup ], optional),
ShortCode (string, optional),
ShortCodeLink (string, optional),
CurrentPostId (string, optional),
Posts (Array[TaskPost ], optional),
CreatedAtDateTime (string, optional),
Id (string, optional),
UpdatedAtDateTime (string, optional),
State (string, optional),
Attachments (Array[Attachment ], optional),
InternalRecipients (Array[InternalRecipient ], optional),
Text (string, optional),
Name (string, optional),
Description (string, optional),
DueDate (string, optional),
Private (boolean, optional),
SendEmail (boolean, optional),
ResponseRequired (boolean, optional),
ForwardingDisabled (boolean, optional),
PercentageComplete (integer, optional)
integerMax. Value:100
}
User {
Id (string, optional),
Name (string, optional)
}
Keyword {
Name (string, optional),
Id (string),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
CustomFieldGroup {
GroupId (string, optional),
Name (string, optional),
CustomFields (Array[CustomFieldBase ], optional)
}
TaskPost {
Id (string, optional),
State (string, optional),
ShortCode (string, optional),
AssignedTo (User , optional),
InternalRecipients (Array[InternalRecipient ], optional),
Attachments (Array[Attachment ], optional),
PostedDate (string, optional),
PostedBy (User , optional),
Text (string, optional),
Revision (string, optional)
}
Attachment {
Name (string, optional),
Description (string, optional),
EntityType (string, optional),
EntityId (string, optional),
AttachmentId (string, optional),
CreatedAtDateTime (string, optional),
UpdatedAtDateTime (string, optional)
}
InternalRecipient {
Email (string, optional),
ProfileId (string, optional),
Name (string, optional),
Type (string, optional) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
CustomFieldBase {
MemberId (string, optional),
Name (string, optional),
Description (string, optional),
Mandatory (boolean, optional),
CustomFieldType (string, optional)
}
{
"ParentId": "00000000-0000-0000-0000-000000000000",
"Priority": "string",
"AssignedTo": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"Keywords": [
{
"Name": "string",
"Id": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.154Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.154Z"
}
],
"CustomFieldGroups": [
{
"GroupId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CustomFields": [
{
"MemberId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"Mandatory": true,
"CustomFieldType": "string"
}
]
}
],
"ShortCode": "string",
"ShortCodeLink": "string",
"CurrentPostId": "00000000-0000-0000-0000-000000000000",
"Posts": [
{
"Id": "00000000-0000-0000-0000-000000000000",
"State": "string",
"ShortCode": "string",
"AssignedTo": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"InternalRecipients": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"Attachments": [
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.154Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.154Z"
}
],
"PostedDate": "2024-06-07T11:33:36.154Z",
"PostedBy": {
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
},
"Text": "string",
"Revision": "string"
}
],
"CreatedAtDateTime": "2024-06-07T11:33:36.154Z",
"Id": "00000000-0000-0000-0000-000000000000",
"UpdatedAtDateTime": "2024-06-07T11:33:36.154Z",
"State": "string",
"Attachments": [
{
"Name": "string",
"Description": "string",
"EntityType": "string",
"EntityId": "00000000-0000-0000-0000-000000000000",
"AttachmentId": "00000000-0000-0000-0000-000000000000",
"CreatedAtDateTime": "2024-06-07T11:33:36.154Z",
"UpdatedAtDateTime": "2024-06-07T11:33:36.154Z"
}
],
"InternalRecipients": [
{
"Email": "string",
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": "UNDEFINED"
}
],
"Text": "string",
"Name": "string",
"Description": "string",
"DueDate": "2024-06-07T11:33:36.154Z",
"Private": true,
"SendEmail": true,
"ResponseRequired": true,
"ForwardingDisabled": true,
"PercentageComplete": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type taskId
The unique identifier of the Task
path string taskPostCreate
Parameter content type: application/json
Task Post create model
body
* Model
* Example Value
TaskPost {
Text (string),
TaskAssigneeProfileId (string),
PercentageComplete (integer, optional)
integerMax. Value:100
,
InternalRecipients (Array[InternalRecipient ], optional),
Attachments (Array[Attachment ], optional)
}
InternalRecipient {
ProfileId (string),
Type (string) = ['UNDEFINED', 'PROFILE', 'DISTRIBUTIONGROUP',
'SECURITYGROUP']
stringEnum:"UNDEFINED", "PROFILE", "DISTRIBUTIONGROUP", "SECURITYGROUP"
}
Attachment {
EntityType (string) = ['UNDEFINED', 'DOCUMENT']
stringEnum:"UNDEFINED", "DOCUMENT"
,
EntityId (string, optional)
}
{
"Text": "string",
"TaskAssigneeProfileId": "00000000-0000-0000-0000-000000000000",
"PercentageComplete": 0,
"InternalRecipients": [
{
"ProfileId": "00000000-0000-0000-0000-000000000000",
"Type": "UNDEFINED"
}
],
"Attachments": [
{
"EntityType": "UNDEFINED",
"EntityId": "00000000-0000-0000-0000-000000000000"
}
]
}
If-Match
Last modified date in ticks
header string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Task Post model is invalid.
401
The user is not authorised.
404
The parent entity cannot be found or the user is forbidden access to the
parent entity.
409
412
The value of the If-Match header is not equal to the last modified date
of this resource, expressed in ticks. To get the last modified date in
ticks, make a GET request for this resource and use the value of the
returned ETag header as the value of the If-Match header.
422
The supplied Task Post model contains invalid items.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* TREEVIEW
* Developer Notes
* Show/Hide
* List Operations
* Expand Operations
* Help
The treeview is a collection of first-level child containers under a parent
container (entity).
* * GET /VFP/API/V1/TREEVIEW/{ENTITYID}
* Get a Treeview for an entity
IMPLEMENTATION NOTES
Returns a collection of entities that are children of the provided
entity.
* Authorize
RESPONSE CLASS (STATUS 200)
Operation successful.
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Id (string, optional),
Name (string, optional),
Level (integer, optional),
HasChildNodes (boolean, optional),
Type (string, optional),
IsPublic (boolean, optional)
}
[
{
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Level": 0,
"HasChildNodes": true,
"Type": "string",
"IsPublic": true
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type entityId
The unique identifier of the Entity
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
The supplied Entity ID is invalid.
401
The user is not authorised.
404
The Entity cannot be found or the user is forbidden access to this
Entity.
500
Internal Server Error.
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
For more information on using this API, please contact support@4projects.com