POST api/ProcessInstance/{processInstanceId}/Trigger/{trigger}

Initializes the user step.

Request Information

URI Parameters

Name	Description	Type	Additional information
processInstanceId		globally unique identifier	Required
trigger		WorkPoint.Core.Models.ProcessManagement.Trigger	Required

Body Parameters

WorkPoint365.WebAPI.Model.ProcessParameters

Name	Description	Type	Additional information
businessModuleId	Gets or sets the business module identifier.	globally unique identifier	None.
entityId	Gets or sets the entity identifier.	integer	None.
data		Object	None.
dataSubmitted		Dictionary of string [key] and Object [value]	None.
currentStepIndex		integer	None.
processId		globally unique identifier	None.
subProcessId		globally unique identifier	None.
payloads		Collection of Object	None.
list	Gets or sets the entity list web relative URL.	string	None.
folder		string	None.
webUrl		string	None.
items	Gets or sets the list item ids.	Collection of WorkPoint365.WebAPI.Model.ProcessItemParameters	None.
itemId	Gets or sets the list item id.	integer	None.
Item	The before and after properties of the Item	Dictionary of Object [key] and Object [value]	None.
Entity	The before and after properties of the Entity	Dictionary of Object [key] and Object [value]	None.
Trigger		WorkPoint365.WebAPI.Model.ProcessTriggerType	None.
parameters		Dictionary of string [key] and Object [value]	None.
parentField		WorkPoint365.WebAPI.Model.ParentFieldDefinition	None.
teamsActivity		WorkPoint365.WebAPI.Model.TeamsActivity	None.
express		Collection of WorkPoint365.WebAPI.Model.OutlookMessage	None.
messagingId		globally unique identifier	None.
retry		Collection of Dictionary of Object [key] and Object [value]	None.

Request Formats

application/json, text/json

Sample:

{
  "businessModuleId": "6404189b-354e-4b72-9752-261bf04d5e70",
  "entityId": 1,
  "data": {},
  "dataSubmitted": {
    "sample string 1": {},
    "sample string 3": {}
  },
  "currentStepIndex": 1,
  "processId": "a455f261-0683-4d26-b23f-d4c35625e30d",
  "subProcessId": "4fa45d01-535a-4fbb-9154-e09ce77bc8f4",
  "payloads": null,
  "list": "sample string 2",
  "folder": "sample string 3",
  "webUrl": "sample string 4",
  "items": [
    {
      "webUrl": "sample string 1",
      "list": "sample string 2",
      "id": 3
    },
    {
      "webUrl": "sample string 1",
      "list": "sample string 2",
      "id": 3
    }
  ],
  "itemId": 1,
  "Item": null,
  "Entity": null,
  "Trigger": "StageChanged",
  "parameters": {
    "sample string 1": {},
    "sample string 3": {}
  },
  "parentField": {
    "name": "sample string 1",
    "title": {},
    "type": "sample string 3"
  },
  "teamsActivity": {
    "ConversationId": "sample string 1",
    "ConversationType": "sample string 2",
    "TenantId": "sample string 3",
    "MessageId": "sample string 4",
    "ParentMessageId": "sample string 5",
    "TeamId": "sample string 6",
    "ChannelId": "sample string 7"
  },
  "express": [
    {
      "ItemId": "sample string 1",
      "Subject": "sample string 2",
      "ItemType": "sample string 3",
      "ItemMode": "sample string 4",
      "ConversationId": "sample string 5",
      "HasAttachment": true,
      "InternetMessageId": "sample string 7",
      "UserId": "sample string 8"
    },
    {
      "ItemId": "sample string 1",
      "Subject": "sample string 2",
      "ItemType": "sample string 3",
      "ItemMode": "sample string 4",
      "ConversationId": "sample string 5",
      "HasAttachment": true,
      "InternetMessageId": "sample string 7",
      "UserId": "sample string 8"
    }
  ],
  "messagingId": "a6f854db-9067-4d25-92fc-e420603ddc4c",
  "retry": null
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

Response Information

Resource Description

System.Net.Http.HttpResponseMessage

Name	Type	Additional information
Version	System.Version	None.
Content	System.Net.Http.HttpContent	None.
StatusCode	System.Net.HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	System.Net.Http.HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.