Navigation:  Integration via SOAP web services > Published web services > Document >

newDocument2

Previous  Top  Next

This method makes it possible to create a document. To use it, it is necessary to follow the standard documented below:

 

Java class

Request

web/wwwroot/ws/java/document/NewDocument2RequestType.java

Return

web/wwwroot/ws/java/document/NewDocument2ResponseType.java

 

Request

ID #

Required

Description

CategoryId

X

Category ID #.

DocumentID

 

Document ID #.

Title

X1

Document title.

Summary

 

Document summary.

Date

 

Document date. Date format must be Y-M-D (Year-Month-Day).

Attributes

 

Document attributes:

ID: Attribute ID #;

Value: Attribute value array:

oItem: Attribute value

 

Note:

For attributes with a numeric value, the decimal place separator must be ".".

For date attributes, the value must have the “Y-M-D” (Year-Month-Day) format

ResponsibleUserID

 

ID of the user responsible for the document.

RevisionMembers

 

Revision participants:

MemberType: Participant type:

1 - User;

2 - Department;

3 - Position;

4 - Department/Position;

5 - Team.

 

MemberID: Participant 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

 

Deadline: Deadline in days. E.g.: 5

TemplateID

 

Template ID #.

1 - For the default template of the category.

Files

 

Files array:

Name: String; File name.

Content: Stream; Electronic file binary2.

Container: Container structure item ID #.

Keywords

 

Keyword array:

KeywordID: String; Keyword ID #.

LanguageID

 

Document language:

1 - English (USA)

2 - Portuguese (Brazil)

3 - Spanish

4 - Portuguese (Portugal)

5 - German

6 - French (France)

7 - Romanian *

8 - Chinese *

9 - Italian

10 - Slovak *

11 - English (United Kingdom)

12 - Turkish *

13 - French (Canada)

14 - Russian *

15 - Polish *

16 - Catalan

17 - Danish

18 - Finnish

19 - Japanese *

RevisionID

 

Revision ID #

 

1 - The title will be mandatory if there are no masks for titles in the document category.

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

 

*Languages checked with an asterisk are only available on databases with UTF-8 encoding.

 

Return

ID #

Description

Status

SUCCESS: SUCCESS

FAILURE: FAILURE

Code

Displayed code:

0 - No error (record created successfully);

1 - Missing required data;

2 - Inexistent category;

3 - Disabled category;

4 - The user does not have permission to add in the category;

5 - Inexistent user;

6 - The category does not allow changing the responsible user;

7 - The required attribute has not been filled out;

8 - Inexistent attribute;

9 - Problems with the attribute values;

10 - Invalid date;

11 - Date later than the current date;

12 - Invalid template;

13 - The category does not allow multiple files;

14 - Invalid extension;

15 - Blocked extension;

16 - Problems with the file;

17 - Inexistent keyword;

18 - ID # already exists;

19 - The category does not allow adding released documents;

20 - Problems when instantiating the workflow;

21 - Inexistent language;

23 - Error when searching for category data;

24 - To save the revision ID #, the revision process needs to be ISO9000 based;

25 - The system does not allow changing the ID # of revisions being issued in this category;

26 - Revision must contain a whole numeric value;

27 - Revision must contain letters only;

28 - The category does not allow entering or editing the ID #;

29 - The category does not allow entering or editing the title;

30 - It is not possible to enter participants as the category is configured as fixed route;

99 - Return unexpected by the system.

Detail

Message detailing the error or success in the execution of the method.

RecordID

SUCCESS: Document ID # created.

FAILURE: Empty.