SoftExpertSuite.WebAPI (v1.0)

User reg. code

User name

Name used by the user to log into the system

User password

User countersign

Enter the user language code, in accordance with the Database Encoding column of the Localization section, in the System Requirements document.

Enabled user (1 - Enabled, 0 - Disabled)

Blocked user (1 - Blocked, 0 - Unblocked).

Maximum number of simultaneous user connections

User phone

User e-mail address

User leader ID#

User image in binary format 64

User unique ID in the domain controller.

AD domain ID added to SE Suite to which the user is linked. (Used in synchronizing user data with Domain controller).

List of access groups IDs separated by commas if you wish to add more than one.

List with IDs and names of user departments and positions. Each position on this list (array) represents a department and a position that will have the following fields

List of team IDs separated by commas if you wish to add more than one team.

Action plan template ID#

Action plan ID# - Required only when there are no identification masks configured in the category

Action plan title - Required only when an action plan template is not used

Category ID# - Required only when an action plan template is not used

ID of the user responsible for planning the action plan

ID of the user responsible for the action plan

ID of the team responsible for planning the action plan

ID# of the team responsible for the action plan

Calendar ID#

Action plan description

Action plan objective

Action plan explanation

ID# of the action plan to which the action belongs.

Action ID#

Action title (What?)

Action category ID# - It will be required only if a list of allowed categories is configured in the action plan category

Action execution type. 1 – Immediate; 2 – Planned. - Note: The Immediate configuration will only be enabled if it is configured in the action plan category.

Action team ID#

User ID of the Responsible for execution (Who?)

Planned start date (When?) in the YYYY-MM-DD format

Planned start time (When?) in the HH:MM format. If it is not filled out, the system will consider the current time

Planned end date (When?) in the YYYY-MM-DD format

Planned end time (When?) in the HH:MM format. If it is not filled out, the system will consider the current time.

Planned cost (How much?), in the 10000.00 format, where the '.' is the decimal separator. Thousandth separator is not used.

Why?

Where?

How?

Action plan ID#

Isolated action ID#

Instance ID# (workflow, problem and incident).

Category ID#

Document ID#

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

Document summary

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

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* - Languages checked with an asterisk are only available on databases with UTF-8 encoding

Revision ID#

Document attributes: ID: Attribute ID#; Value: Attribute value array: Item: 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

ID of the user responsible for the document

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

Template ID#. 1 - For the default template of the category.

Files array

Category ID#

Document ID#

Revision ID#

Document title

Document summary

Document ID#

Cancellation description

Category ID#

Document ID#

Document ID#

Revision ID#

Enter 1 to download the file in pdf, if it exists; otherwise, downloads the original file.

Document category ID#

Enter the value 1 to download the file with watermark. Note: Only for PDF files.

File name with extension.

String; Category ID#

String; Document ID#

String; Document title

String; Document author

String; Content

String; Search for synonym

String; Document status. Ex.: 1,2,3,4; 1: Issue; 2: Released; 3: Revision; 4: Cancelled;

String; Document permissions. Ex.: 1,2,3,4,5; 1: Add; 2: Edit; 3: Delete; 4: Revise; 5: Knowledge; 6: Distribute copy; 7: View; 8: Cancel; 9: Archive; 10: Print; 11: Training; 12: Create training; 13: Save locally; 14: Sign; 15: Notification;

String; ID # of permission user

String; Permission of department ID #

String; Record user ID

String; Permission of position ID

String; Keyword

Integer; Operator of key word; 1: AND; 2: OR

String; Number of days referring to the document date (last days);

String; Start date for document period

String; Deadline for document period;

String; Number of days referring to the document creation date (last days);

String; Start date for document creation date period;

String; Deadline for document creation date period;

String; Start date for validity date search field;

String; End date for validity date search field;

String; Number of days referring to the document revision date (last days);

String; Start date for document revision period;

String; Deadline for document revision period;

String; Project ID #;

String; Project name;

Document ID#

Revision status: 0 - In progress; 1- Closed

Revision explanation

Document category ID#

Revision ID#

Revision participants: CONTROL: Control type --> 1 - arrowrgray User; 2 - arrowrgray Department; 3 - arrowrgray Position; 4 - arrowrgray Department/Position; 5 - arrowrgray 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

Matrix; 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 '.'. Note: For date fields, the value must have the Y-M-D (Year-Month-Day) format.

Document ID#

Revision ID#

Document category ID#

Document ID

Revision ID

User ID

Table ID#

ID of the user that edited the record

Table ID#

Record OID column in the table

Table ID#

Identifier of the process, which can also be changed for the type of process. However, it is necessary to change the name of the field to workflowTypeId

Workflow Title

User ID#

Instance ID#

User ID

Workflow ID#

Activity ID#

File name (including its extension)

Binary content of the file

User ID

Attachment ID #

Attachment name

Workflow ID#

Explanation

Workflow ID #

Activity ID #

Number of action sequence

User ID

Workflow ID #

Activity ID #