SoftExpertSuite.WebAPI (v1.0)
REST API SoftExpert Suite Experimental
This section presents the REST API available for SoftExpert Suite Administration. To use the methods of the respective component, it will be necessary to follow the standard documented. All endpoints require authentication.
To edit a user, it is necessary to follow the standard documented below
This method enables to add/edit:
- User general data;
-Departments and position (ID# and name);
- Relationship between epartment/Position/Team/Access group;
- Relationship between user and domain controller.
If the user already exists -existing user ID - the information will be edited and replaced for the information present in the request.
If a value of '1' is entered in the UpdateType attribute, the attributes of the list type will be replaced by the ones in the request, if no value or 0 is entered, the values will be added to those already recorded in the system.
The only difference between the importUserV2 and the importUser method is that before the system performs the operation previously performed by the importUser method, the system will create or update the departments and positions mentioned in the 'DeptPosArray' field.
Authorizations:
Request Body schema: application/jsonrequired
Request Body
UserId required | string User reg. code |
UserName required | string User name |
UserLogin required | string Name used by the user to log into the system |
UserPassword required | string User password |
UserCounterSign | string User countersign |
UserLanguage | string Enter the user language code, in accordance with the Database Encoding column of the Localization section, in the System Requirements document. |
IsActive | integer Enabled user (1 - Enabled, 0 - Disabled) |
IsEnabled | integer Blocked user (1 - Blocked, 0 - Unblocked). |
NumMaxConnections | string Maximum number of simultaneous user connections |
UserPhone | string User phone |
UserEmail | string User e-mail address |
LeaderId | string User leader ID# |
UserPhoto | string User image in binary format 64 |
UserDomainId | string User unique ID in the domain controller. |
DomainId | string AD domain ID added to SE Suite to which the user is linked. (Used in synchronizing user data with Domain controller). |
AccGroupIdArray | string List of access groups IDs separated by commas if you wish to add more than one. |
object 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 | |
TeamIdArray | string List of team IDs separated by commas if you wish to add more than one team. |
UpdateType | string Definition on how the list of values of the AccGroupIdArray, DeptPosArray and TeamIdArray parameters will be considered in the import of the user: When saving the user, if 0 is entered, the values entered in the AccGroupIdArray, DeptPosArray and TeamIdArray parameters will be added to the values already defined in a previous record of the user; When saving the user, if 1 is entered, the values entered in the AccGroupIdArray, DeptPosArray and TeamIdArray parameters will replace the values already defined in a previous record of the user; Note: If no value is entered, the system will consider the value 0 by default. |
Responses
Request samples
- Payload
{- "UserId": "string",
- "UserName": "string",
- "UserLogin": "string",
- "UserPassword": "string",
- "UserCounterSign": "string",
- "UserLanguage": "string",
- "IsActive": 0,
- "IsEnabled": 0,
- "NumMaxConnections": "string",
- "UserPhone": "string",
- "UserEmail": "string",
- "LeaderId": "string",
- "UserPhoto": "string",
- "UserDomainId": "string",
- "DomainId": "string",
- "AccGroupIdArray": "string",
- "DeptPosArray": {
- "DeptPos": {
- "DepartmentID": "string",
- "DepartmentName": "string",
- "PositionID": "string",
- "PositionName": "string"
}
}, - "TeamIdArray": "string",
- "UpdateType": "string"
}
Response samples
- 200
{- "UserId": 0,
- "Status": "string",
- "Detail": "string"
}
This section presents the REST API available for SoftExpert Suite Action Plan. To use the methods of the respective component, it will be necessary to follow the standard documented. All endpoints require authentication.
This method enables the creation of action plans
Authorizations:
Request Body schema: application/jsonrequired
Request Body
IDModelPlanActivity | string Action plan template ID# |
IDActionPlan | string Action plan ID# - Required only when there are no identification masks configured in the category |
Title | string Action plan title - Required only when an action plan template is not used |
IDCategory | string Category ID# - Required only when an action plan template is not used |
IDPlanningResp required | string ID of the user responsible for planning the action plan |
IDActionPlanResp required | string ID of the user responsible for the action plan |
IDTeamPlanningResp | string ID of the team responsible for planning the action plan |
IDTeamMonitoringResp | string ID# of the team responsible for the action plan |
IDCalendar | string Calendar ID# |
Summary | string Action plan description |
Objective | string Action plan objective |
Justify | string Action plan explanation |
Benefit | string Action plan benefit |
Responses
Request samples
- Payload
{- "IDModelPlanActivity": "string",
- "IDActionPlan": "string",
- "Title": "string",
- "IDCategory": "string",
- "IDPlanningResp": "string",
- "IDActionPlanResp": "string",
- "IDTeamPlanningResp": "string",
- "IDTeamMonitoringResp": "string",
- "IDCalendar": "string",
- "Summary": "string",
- "Objective": "string",
- "Justify": "string",
- "Benefit": "string"
}
This method enables recording actions associated with an action plan
Authorizations:
Request Body schema: application/jsonrequired
Request Body
ActionplanID | string ID# of the action plan to which the action belongs. |
ActionID | string Action ID# |
ActionTitle required | string Action title (What?) |
CatID | string Action category ID# - It will be required only if a list of allowed categories is configured in the action plan category |
FgTypeAction required | string |