Skip to content

SetISOReviewDefinition API

Sets the ISO review schedule on a document. Defines when and how the document should be periodically reviewed, who should perform the review (via task or workflow), and what task permissions and completion requirements apply.

Endpoint

/srv.asmx/SetISOReviewDefinition

Methods

  • GET /srv.asmx/SetISOReviewDefinition?authenticationTicket=...&documentPath=...&xmlParameters=...
  • POST /srv.asmx/SetISOReviewDefinition (form data)
  • SOAP Action: http://tempuri.org/SetISOReviewDefinition

Parameters

Parameter Type Required Description
authenticationTicket string Yes Authentication ticket obtained from AuthenticateUser
documentPath string Yes Full path of the document
xmlParameters string Yes XML-serialized ISOReviewDefinitionModel (see below)

xmlParameters — ISOReviewDefinitionModel

<ISOReviewDefinitionModel>
  <StartDate>2024-06-01T00:00:00</StartDate>
  <ScheduleDef>MONTHLY-ON,1,1</ScheduleDef>
  <ReviewByUserId>42</ReviewByUserId>
  <Instructions>Please review this document for accuracy.</Instructions>
  <WorkflowDefId>0</WorkflowDefId>
  <DeadlineHours>48</DeadlineHours>
  <Priority>1</Priority>
  <PermissionChangeDueDate>false</PermissionChangeDueDate>
  <PermissionChangePriority>false</PermissionChangePriority>
  <PermissionChangeFinishDate>false</PermissionChangeFinishDate>
  <RequireSign>false</RequireSign>
  <RequireEdit>false</RequireEdit>
  <RequireLastVersionRead>true</RequireLastVersionRead>
  <RequirePublishedVersionRead>false</RequirePublishedVersionRead>
  <RequireComments>false</RequireComments>
  <RequireApproval>false</RequireApproval>
  <RequireISOReview>false</RequireISOReview>
  <RequireSOXReview>false</RequireSOXReview>
  <RequireArchive>false</RequireArchive>
  <RequireDowngrade>false</RequireDowngrade>
  <RequireDeclassify>false</RequireDeclassify>
</ISOReviewDefinitionModel>

ISOReviewDefinitionModel Fields

Field Type Description
StartDate datetime Date from which the review schedule begins
ScheduleDef string Schedule definition string (see formats below)
ReviewByUserId int Reviewer: real user ID, or -5 = DocumentOwner, -8 = Submitter
Instructions string Task instructions shown to the reviewer (task mode only; ignored in workflow mode)
WorkflowDefId int 0 = task mode; positive integer = submit to this workflow definition ID
DeadlineHours int Task deadline in total hours from the review trigger date
Priority int Task priority: 0 = Low, 1 = Normal, 2 = High
PermissionChangeDueDate bool Allow reviewer to change the due date
PermissionChangePriority bool Allow reviewer to change the priority
PermissionChangeFinishDate bool Allow reviewer to change the finish date
RequireSign bool Reviewer must sign the document
RequireEdit bool Reviewer must edit the document
RequireLastVersionRead bool Reviewer must read the latest version
RequirePublishedVersionRead bool Reviewer must read the published version
RequireComments bool Reviewer must add a comment
RequireApproval bool Reviewer must approve the document
RequireISOReview bool Task requires ISO review completion
RequireSOXReview bool Task requires SOX review completion
RequireArchive bool Task requires archiving
RequireDowngrade bool Task requires downgrading
RequireDeclassify bool Task requires declassification

ScheduleDef Formats

Format Example Description
ONCE ONCE Single review, no recurrence
DAILY,N DAILY,30 Every N days
WEEKLY,freq,dayOfWeek WEEKLY,1,1 Every freq weeks on dayOfWeek (0=Sun … 6=Sat)
MONTHLY-ON,freq,day MONTHLY-ON,1,15 Every freq months on the Nth day of the month
MONTHLY-THE,freq,week,dayOfWeek MONTHLY-THE,1,1,1 Every freq months on the Nth weekday

Response

Success Response

<root success="true" />

Error Response

<root success="false" error="[ErrorCode] Error message" />

Required Permissions

The caller must have Change Document Properties permission on the document.

Example

Set a monthly ISO review assigned to the document owner (POST)

POST /srv.asmx/SetISOReviewDefinition HTTP/1.1
Content-Type: application/x-www-form-urlencoded

authenticationTicket=abc123-def456&documentPath=/Library/Policies/policy.pdf&xmlParameters=<ISOReviewDefinitionModel><StartDate>2024-06-01T00:00:00</StartDate><ScheduleDef>MONTHLY-ON,12,1</ScheduleDef><ReviewByUserId>-5</ReviewByUserId><Instructions>Annual policy review required</Instructions><WorkflowDefId>0</WorkflowDefId><DeadlineHours>168</DeadlineHours><Priority>1</Priority><PermissionChangeDueDate>false</PermissionChangeDueDate><PermissionChangePriority>false</PermissionChangePriority><PermissionChangeFinishDate>false</PermissionChangeFinishDate><RequireSign>false</RequireSign><RequireEdit>false</RequireEdit><RequireLastVersionRead>true</RequireLastVersionRead><RequirePublishedVersionRead>false</RequirePublishedVersionRead><RequireComments>true</RequireComments><RequireApproval>false</RequireApproval><RequireISOReview>false</RequireISOReview><RequireSOXReview>false</RequireSOXReview><RequireArchive>false</RequireArchive><RequireDowngrade>false</RequireDowngrade><RequireDeclassify>false</RequireDeclassify></ISOReviewDefinitionModel>

Notes

  • To remove an existing ISO review schedule, use RemoveISOReviewDefinition
  • When WorkflowDefId > 0, Instructions is ignored; the workflow definition provides the task structure
  • ReviewByUserId = -5 assigns the review task to the document owner at review time; -8 assigns it to the user who submitted the document to the workflow