Examples

The sample below show the minum we have to send when updating workflow state. In the sample we go to a workflow step with id=a8fee2a6-ce06-412d-96fe-9798d09353b5


     var update = {
         "AttributeAction": 0,
         "AttributeType": 8,      
         "AttributeData": {
               "Id": "a8fee2a6-ce06-412d-96fe-9798d09353b5"
         }
     }
 
If you for example want to specify the date and time when this action you can adjust the create date. If you do not set the create date as in the first example the create date will be set to Now, i.e. the date and time the request reached the server.

 {
  "TicketId": "593b432b-519c-4355-9d7a-6154b30ea73c",
  "CombinedActivityId": "sesam10:1082757",
  "ActivityUpdates": [
    {
      "AttributeAction": 0,
      "AttributeType": 8,
      "AttributeData": {
        "Id": "a8fee2a6-ce06-412d-96fe-9798d09353b5",
        "Fields": [
          {
            "AttributeName": "CreatedAt",
            "AttributeType": 0,
            "AttributeAction": 0,
            "AttributeData": {
              "FieldName": "CreatedAt",
              "FieldValue": "2022-06-17T06:06:00.000Z"
            }
          }
        ]
      }
    }
  ]
}
 

Properties

NameDescriptionTypeAdditional information
Id

Gets or sets the step you want to execute

string

None.

Name

Gets or sets the "display" friendly name of the step.

string

None.

IsRollbackAllowed

Gets or sets whether this workflow step can be rolled back, i.e. deleted

boolean

None.

Fields

Get or set fields that will be set/or was set during a workflow step. You can expect the following fields to be available

  • CreatedAt, the time when the step was started
  • CreatedBy, the person creating the step
  • CompletedAt, the time when the step was completed
  • CompletedBy, the person completing the step
  • StepComment, any additional info related to the step. Please note that this is a CommentModelcomment
  • FailedSchedule, any schedules that failed due to the step

Collection of AttributeUpdateModel

None.