Skip to main content
Version: 2.2.2

newRevision

This method allows creating a new revision for the document. It is not possible to create obsolete revisions with this method. To use it, it is necessary to follow the standard documented below:

Java class
Requestweb/wwwroot/ws/java/document/NewRevisionRequestType.java
Returnweb/wwwroot/ws/java/document/NewRevisionResponseType.java

Request:

ID #RequiredDescription
IDDOCUMENTXDocument ID #.
IDUSERStarting with version 2.0, this parameter became obsolete. During the import, leave it blank.
PARTICIPANTSRevision participants:
CONTROL: Control type
â–ª 1 - User;
â–ª 2 - Department;
â–ª 3 - Position;
â–ª 4 - Department/Position;
â–ª 5 - Team.
ENTCONTROL: ID #. E.g.: User ID for user control.
STEP: Step. E.g.:1,2,3,4
â–ª 1 - Draft;
â–ª 2 - Review;
â–ª 3 - Approval;
â–ª 4 - Release.
Sequence: Sequence. E.g.: 2,2,2,2
QTDEADLINE: Deadline (days). E.g.: 5
DOCUMENTDATAMatrix; Document data;
â–ª NMTITLE: String; Document title;
â–ª ATTRIBUTTES: String; Document attributes.
Example:
identifier_of_attribute1=value_of_attribute1; identifier_of_attribute2=value_of_attribute2; identifier_of_attribute3=value_of_attribute3.
Example with a multivalued attribute:
identifier_of_attribute1=value1_of_attribute1, value2_of_attribute1,value3_of_attribute1.
Note: For attributes with a numeric value, the decimal place separator must be "." (dot).
Note: For date fields, the value must have the Y-M-D (Year-Month-Day) format.
FILEFILE: Matrix; Files;
â–ª NMFILE: String; File name.
â–ª BINFILE: Stream; Electronic file binary1.
â–ª Container: Container structure item ID #.
â–ª ERROR: Starting from version 2.0, this parameter became obsolete. During the import, leave it blank.
FGSTATUSRevision status: 0 - In progress; 1- Closed
DSJUSTIFYRevision explanation
IDCATEGORYDocument category ID #.
IDREVISIONRevision ID #
info

¹ - Content of the electronic file converted to Base64. If you are testing the usage through the web service data source, we suggest converting a small text through a website of your choosing.

Request structure:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:document">
<soapenv:Header/>
<soapenv:Body>
<urn:newRevision>
<!--You may enter the following 9 items in any order-->
<urn:iddocument>?</urn:iddocument>
<urn:iduser>?</urn:iduser>
<urn:participants>
<!--0 to 1000 repetitions:-->
<urn:item>
<!--You may enter the following 5 items in any order-->
<urn:CONTROL>?</urn:CONTROL>
<urn:ENTCONTROL>?</urn:ENTCONTROL>
<urn:STEP>?</urn:STEP>
<urn:SEQUENCE>?</urn:SEQUENCE>
<urn:QTDEADLINE>?</urn:QTDEADLINE>
</urn:item>
</urn:participants>
<urn:documentdata>
<!--You may enter the following 2 items in any order-->
<urn:NMTITLE>?</urn:NMTITLE>
<urn:ATTRIBUTTES>?</urn:ATTRIBUTTES>
</urn:documentdata>
<urn:file>
<!--0 to 1000 repetitions:-->
<urn:item>
<!--You may enter the following 4 items in any order-->
<urn:NMFILE>?</urn:NMFILE>
<urn:BINFILE>cid:957077656494</urn:BINFILE>
<urn:CONTAINER>?</urn:CONTAINER>
<urn:ERROR>?</urn:ERROR>
</urn:item>
</urn:file>
<urn:fgstatus>?</urn:fgstatus>
<urn:dsjustify>?</urn:dsjustify>
<urn:idcategory>?</urn:idcategory>
<urn:idrevision>?</urn:idrevision>
</urn:newRevision>
</soapenv:Body>
</soapenv:Envelope>

Return: