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 Action execution type. 1 – Immediate; 2 – Planned. - Note: The Immediate configuration will only be enabled if it is configured in the action plan category. |
TeamID | string Action team ID# |
RespID required | string User ID of the Responsible for execution (Who?) |
DtPlanStart required | string Planned start date (When?) in the YYYY-MM-DD format |
TmPlanStart | string Planned start time (When?) in the HH:MM format. If it is not filled out, the system will consider the current time |
DtPlanEnd required | string Planned end date (When?) in the YYYY-MM-DD format |
TmPlanEnd | string Planned end time (When?) in the HH:MM format. If it is not filled out, the system will consider the current time. |
VlPlanCost | string Planned cost (How much?), in the 10000.00 format, where the '.' is the decimal separator. Thousandth separator is not used. |
DsWhy | string Why? |
DsWhere | string Where? |
DsHow | string How? |
DsResult | string Result - It will be required only for an immediate action to be added, and if the result is set as required in the plan category |
Responses
Request samples
- Payload
{- "ActionplanID": "string",
- "ActionID": "string",
- "ActionTitle": "string",
- "CatID": "string",
- "FgTypeAction": "string",
- "TeamID": "string",
- "RespID": "string",
- "DtPlanStart": "string",
- "TmPlanStart": "string",
- "DtPlanEnd": "string",
- "TmPlanEnd": "string",
- "VlPlanCost": "string",
- "DsWhy": "string",
- "DsWhere": "string",
- "DsHow": "string",
- "DsResult": "string"
}
This method enables the association of action plans and isolated actions with activities from the SE Workflow, SE Incident and SE Problem components
Authorizations:
Request Body schema: application/jsonrequired
Request Body
IDActionPlan | string Action plan ID# |
IDAction | string Isolated action ID# |
IDInstance required | string Instance ID# (workflow, problem and incident). |
IDActivity required | string Activity ID# (workflow, problem and incident). |
Responses
Request samples
- Payload
{- "IDActionPlan": "string",
- "IDAction": "string",
- "IDInstance": "string",
- "IDActivity": "string"
}
This section presents the Dataset REST API present in SoftExpert Suite. To use it, you will need to follow the documented pattern. All endpoints require authentication.
Lets you to query datasets registered on SoftExpert Suite
The dataset API allows consuming the return of queries created within sets recorded in the system. In other words, it will not be possible to query databases external to SoftExpert Suite.
-The structure of return fields varies according to those returned by the query and mapped in the Dataset. The return above is just a simple example with a table of the system's users.
- Fields that return null values will return empty instead.
- For each line returned by the query, it will be serialized in the form of a JSON object in the API return.
- Only the first 10.000 (ten thousand) records will be returned as objects.
Authorizations:
path Parameters
datasetId required | string ID of Dataset |
Responses
Lets you querying data sets registered on SoftExpert Suite, including specific parameters
The dataset API allows consuming the return of queries created within sets recorded in the system. In other words, it will not be possible to query databases external to SoftExpert Suite.
-The structure of return fields varies according to those returned by the query and mapped in the Dataset. The return above is just a simple example with a table of the system's users.
- Fields that return null values will return empty instead.
- For each line returned by the query, it will be serialized in the form of a JSON object in the API return.
- Only the first 10.000 (ten thousand) records will be returned as objects.
Authorizations:
path Parameters
datasetId required | string ID of Dataset |
Request Body schema: application/jsonoptional
datasetParameterID | string (Dataset parameter ID) |
Responses
Request samples
- Payload
{- "datasetParameterID": "string"
}
This section presents the REST API available for SoftExpert Suite Document. To use the methods of the respective component, it will be necessary to follow the standard documented. All endpoints require authentication.
This method makes it possible to create a document
Authorizations:
Request Body schema: application/jsonrequired
Request Body
CategoryID required | string Category ID# |
DocumentID | string Document ID# |
Title required | string Document title - The title will be mandatory if there are no masks for titles in the document category |
Summary | string Document summary |
Date | string Document date. Date format must be Y-M-D (Year-Month-Day) |
LanguageID | string 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 |
RevisionID | string Revision ID# |
object 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 | |
ResponsibleUserID | string ID of the user responsible for the document |
object 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 | string Template ID#. 1 - For the default template of the category. |
object Files array | |
object Keyword array |
Responses
Request samples
- Payload
{- "CategoryID": "string",
- "DocumentID": "string",
- "Title": "string",
- "Summary": "string",
- "Date": "string",
- "LanguageID": "string",
- "RevisionID": "string",
- "Attributes": {
- "item": {
- "ID": "string",
- "Values": {
- "item": {
- "Value": "string"
}
}
}
}, - "ResponsibleUserID": "string",
- "RevisionMembers": {
- "item": {
- "MemberType": "string",
- "MemberID": "string",
- "Step": "string",
- "Sequence": "string",
- "Deadline": "string"
}
}, - "TemplateID": "string",
- "Files": {
- "item": {
- "Name": "string",
- "Content": "string",
- "Container": "string"
}
}, - "Keywords": {
- "item": {
- "KeywordID": "string"
}
}
}
This method enables to edit a document
Authorizations:
Request Body schema: application/jsonrequired
Request Body
idcategory required | string Category ID# |
iddocument required | string Document ID# |
idrevision | string Revision ID# |
title | string Document title |
summary | string Document summary |
iduserresp | string User's reg. code |
Responses
Request samples
- Payload
{- "idcategory": "string",
- "iddocument": "string",
- "idrevision": "string",
- "title": "string",
- "summary": "string",
- "iduserresp": "string"
}
This method enables to cancel a document
Authorizations:
Request Body schema: application/jsonrequired
Request Body
idcategory required | string Document ID# |
iddocument required | string Cancellation description |
dscancel | string Document category ID# |
Responses
Request samples
- Payload
{- "idcategory": "string",
- "iddocument": "string",
- "dscancel": "string"
}
This method enables to delete a document
Authorizations:
Request Body schema: application/jsonrequired
Request Body
idcategory required | string Category ID# |
iddocument required | string Document ID# |
justify required | string Deletion explanation |
Responses
Request samples
- Payload
{- "idcategory": "string",
- "iddocument": "string",
- "justify": "string"
}
This method enables to download an electronic file
Authorizations:
Request Body schema: application/jsonrequired
Request Body
iddocument required | string Document ID# |
idrevision | string Revision ID# |
fgconverttopdf | string Enter 1 to download the file in pdf, if it exists; otherwise, downloads the original file. |
idcategory | string Document category ID# |
fgwatermark | string Enter the value 1 to download the file with watermark. Note: Only for PDF files. |
nmfile | string File name with extension. |
fgfilelink | string Enter 1 to return the link instead of the file. |
Responses
Request samples
- Payload
{- "iddocument": "string",
- "idrevision": "string",
- "fgconverttopdf": "string",
- "idcategory": "string",
- "fgwatermark": "string",
- "nmfile": "string",
- "fgfilelink": "string"
}
This method enables to search for documents
Authorizations:
Request Body schema: application/jsonrequired
Request Body
IDCATEGORY | string String; Category ID# |
IDDOCUMENT | string String; Document ID# |
NMTITLE | string String; Document title |
NMAUTHOR | string String; Document author |
CONTENT | string String; Content |
SYNONYM | string String; Search for synonym |
STATUS | string String; Document status. Ex.: 1,2,3,4; 1: Issue; 2: Released; 3: Revision; 4: Cancelled; |
PERMISSION | string 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; |
IDUSERPERM | string String; ID # of permission user |
DEPARTMENTPERM | string String; Permission of department ID # |
IDUSERREGISTER | string String; Record user ID |
FUNCTIONPERM | string String; Permission of position ID |
KEYWORD | string String; Keyword |
OPKEYWORD | integer Integer; Operator of key word; 1: AND; 2: OR |
DTDOCLASTDAY | string String; Number of days referring to the document date (last days); |
DTDOCBEGIN | string String; Start date for document period |
DTDOCEND | string String; Deadline for document period; |
DTREGLASTDAY | string String; Number of days referring to the document creation date (last days); |
DTREGBEGIN | string String; Start date for document creation date period; |
DTREGEND | string String; Deadline for document creation date period; |
DTVALIDBEGIN | string String; Start date for validity date search field; |
DTVALIDEND | string String; End date for validity date search field; |
DTREVLASTDAY | string String; Number of days referring to the document revision date (last days); |
DTREVBEGIN | string String; Start date for document revision period; |
DTREVEND | string String; Deadline for document revision period; |
IDPROJECT | string String; Project ID #; |
NMPROJECT | string String; Project name; |
object |
Responses
Request samples
- Payload
{- "IDCATEGORY": "string",
- "IDDOCUMENT": "string",
- "NMTITLE": "string",
- "NMAUTHOR": "string",
- "CONTENT": "string",
- "SYNONYM": "string",
- "STATUS": "string",
- "PERMISSION": "string",
- "IDUSERPERM": "string",
- "DEPARTMENTPERM": "string",
- "IDUSERREGISTER": "string",
- "FUNCTIONPERM": "string",
- "KEYWORD": "string",
- "OPKEYWORD": 0,
- "DTDOCLASTDAY": "string",
- "DTDOCBEGIN": "string",
- "DTDOCEND": "string",
- "DTREGLASTDAY": "string",
- "DTREGBEGIN": "string",
- "DTREGEND": "string",
- "DTVALIDBEGIN": "string",
- "DTVALIDEND": "string",
- "DTREVLASTDAY": "string",
- "DTREVBEGIN": "string",
- "DTREVEND": "string",
- "IDPROJECT": "string",
- "NMPROJECT": "string",
- "attributes": {
- "item": {
- "IDATTRIBUTE": "string",
- "VLATTRIBUTE": "string"
}
}
}
This method enables to create a new revision for the document
Authorizations:
Request Body schema: application/jsonrequired
Request Body
iddocument required | string Document ID# |
fgstatus | string Revision status: 0 - In progress; 1- Closed |
dsjustify | string Revision explanation |
idcategory | string Document category ID# |
idrevision | string Revision ID# |
object 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 | |
object 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. | |
object |
Responses
Request samples
- Payload
{- "iddocument": "string",
- "fgstatus": "string",
- "dsjustify": "string",
- "idcategory": "string",
- "idrevision": "string",
- "participants": {
- "item": {
- "CONTROL": "string",
- "ENTCONTROL": "string",
- "STEP": "string",
- "SEQUENCE": "string",
- "QTDEADLINE": "string"
}
}, - "documentdata": {
- "NMTITLE": "string",
- "ATTRIBUTTES": "string"
}, - "file": {
- "item": {
- "NMFILE": "string",
- "BINFILE": "string",
- "CONTAINER": "string"
}
}
}
This method enables to upload an electronic file
Authorizations:
Request Body schema: application/jsonrequired
Request Body
iddocument required | string Document ID# |
idrevision | string Revision ID# |
idcategory | string Document category ID# |
required | object |
Responses
Request samples
- Payload
{- "iddocument": "string",
- "idrevision": "string",
- "idcategory": "string",
- "file": {
- "item": {
- "NMFILE": "string",
- "BINFILE": "string",
- "CONTAINER": "string"
}
}
}
This method enables to recover the data of a document
Authorizations:
Request Body schema: application/jsonrequired
Request Body
iddocument required | string Document ID |
idrevision | string Revision ID |
idcategory | string Document category ID |
Responses
Request samples
- Payload
{- "iddocument": "string",
- "idrevision": "string",
- "idcategory": "string"
}
Files are documents of any kind (images, spreadsheets, text files, etc.) that are uploaded to SoftExpert Suite, and usually associated with some componente.
This section presents the REST API available for SoftExpert Suite Forms. To use the methods of the respective component, it will be necessary to follow the standard documented. All endpoints require authentication.
Lets you allows creating records in a SoftExpert Suite dynamic entity
Authorizations:
Request Body schema: application/jsonrequired
Request Body
UserID | string User ID |
TableID | string Table ID# |
object | |
object | |
object | |
object |
Responses
Request samples
- Payload
{- "UserID": "string",
- "TableID": "string",
- "TableFieldList": {
- "TableField": {
- "TableFieldID": "string",
- "TableFieldValue": "string"
}
}, - "RelationshipList": {
- "Relationship": {
- "RelationshipID": "string",
- "RelationshipField": {
- "RelationshipFieldID": "string",
- "RelationshipFieldValue": "string"
}
}
}, - "TableFieldFileList": {
- "TableFieldFile": {
- "TableFieldID": "string",
- "FileName": "string",
- "FileContent": "string"
}
}, - "RelatedTo": {
- "RelatedRelationshipID": "string",
- "RelatedRelationshipValue": "string"
}
}
Response samples
- 200
{- "Status": "string",
- "Code": 0,
- "Detail": "string",
- "RecordKey": "string"
}
Lets you to edit records of a SoftExpert Suite dynamic entity
Authorizations:
Request Body schema: application/jsonrequired
Request Body
UserID required | string ID of the user that edited the record |
TableID required | string Table ID# |
TableFieldOID required | string Record OID column in the table |
object | |
object | |
object |
Responses
Request samples
- Payload
{- "UserID": "string",
- "TableID": "string",
- "TableFieldOID": "string",
- "TableFieldList": {
- "TableField": {
- "TableFieldID": "string",
- "TableFieldValue": "string"
}
}, - "RelationshipList": {
- "Relationship": {
- "RelationshipID": "string",
- "RelationshipField": {
- "RelationshipFieldID": "string",
- "RelationshipFieldValue": "string"
}
}
}, - "TableFieldFileList": {
- "TableFieldFile": {
- "TableFieldID": "string",
- "FileName": "string",
- "FileContent": "string"
}
}
}
Response samples
- 200
{- "Status": "string",
- "Code": 0,
- "Detail": "string",
- "RecordKey": "string"
}
Lets you allows deleting a record of a SoftExpert Suite dynamic entity
Authorizations:
Request Body schema: application/jsonrequired
Request Body
TableID required | string Table ID# |
TableFieldOID required | string ID# of the record to be deleted |
Responses
Request samples
- Payload
{- "TableID": "string",
- "TableFieldOID": "string"
}
Response samples
- 200
{- "Status": "string",
- "Code": 0,
- "Detail": "string"
}
This section presents the REST API available for SoftExpert Suite Workflow. To use the methods of the respective component, it will be necessary to follow the standard documented. All endpoints require authentication.
This method starts a workflow and changes its data
Need to change server to /apigateway/softexpert/rest
Authorizations:
Request Body schema: application/jsonrequired
Request Body
processId | string 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 |
workflowTitle | string Workflow Title |
userId | string User ID# |
Array of objects | |
Array of objects |
Responses
Request samples
- Payload
{- "processId": "string",
- "workflowTitle": "string",
- "userId": "string",
- "tables": [
- {
- "id": "string",
- "fields": [
- {
- "id": "string",
- "value": "string"
}
]
}
], - "attachments": [
- {
- "filereference": "string",
- "name": "string"
}
]
}
Response samples
- 401
{- "Status": "string",
- "RecordKey": "string",
- "RecordID": "string",
- "Code": 0,
- "TaskKey": "string",
- "Detail": "string"
}
This method edits the data of a process instance created in SoftExpert Suite Workflow
Authorizations:
Request Body schema: application/jsonrequired
Request Body
WorkflowID required | string Instance ID# |
UserID | string User ID |
object |
Responses
Request samples
- Payload
{- "WorkflowID": "string",
- "UserID": "string",
- "Requester": {
- "User": {
- "UserID": "string"
}, - "Customer": {
- "CustomerID": "string",
- "Contact": "string"
}
}
}
Response samples
- 200
{- "Status": "string",
- "Code": 0,
- "Detail": "string"
}
This method attaches a file to a workflow activity
Authorizations:
Request Body schema: application/jsonrequired
Request Body
WorkflowID required | string Workflow ID# |
ActivityID required | string Activity ID# |
FileName required | string File name (including its extension) |
FileContent required | string Binary content of the file |
UserID | string User ID |
AttachmentID | string Attachment ID # |
AttachmentName | string Attachment name |
Summary | string Summary |
Responses
Request samples
- Payload
{- "WorkflowID": "string",
- "ActivityID": "string",
- "FileName": "string",
- "FileContent": "string",
- "UserID": "string",
- "AttachmentID": "string",
- "AttachmentName": "string",
- "Summary": "string"
}
Response samples
- 200
{- "Status": "string",
- "Code": 0,
- "Detail": "string",
- "RecordKey": "string",
- "RecordID": "string"
}
This method cancels a workflow
Authorizations:
Request Body schema: application/jsonrequired
Request Body
WorkflowID required | string Workflow ID# |
Explanation required | string Explanation |
UserID | string User's reg. code #. When given, it will remain in the instance history that it was cancelled by this user. Otherwise, the authentication user will be recorded. |
Responses
Request samples
- Payload
{- "WorkflowID": "string",
- "Explanation": "string",
- "UserID": "string"
}
Response samples
- 200
{- "Status": "string",
- "Code": 0,
- "Detail": "string"
}
This method executes a user activity or workflow decision
Authorizations:
Request Body schema: application/jsonrequired
Request Body
WorkflowID required | string Workflow ID # |
ActivityID required | string Activity ID # |
ActionSequence required | string Number of action sequence |
UserID | string User ID |
ActivityOrder | string Activity order number |
Responses
Request samples
- Payload
{- "WorkflowID": "string",
- "ActivityID": "string",
- "ActionSequence": "string",
- "UserID": "string",
- "ActivityOrder": "string"
}
Response samples
- 200
{- "Status": "string",
- "Code": 0,
- "Detail": "string"
}
This method executes a user activity or workflow decision
Authorizations:
Request Body schema: application/jsonrequired
Request Body
WorkflowID required | string Workflow ID # |
ActivityID required | string Activity ID # |
ActivityOrder | string Activity order number |
Responses
Request samples
- Payload
{- "WorkflowID": "string",
- "ActivityID": "string",
- "ActivityOrder": "string"
}
Response samples
- 200
{- "Status": "string",
- "Code": 0,
- "Detail": "string"
}