/pmse_Project/EventDefinition/:record PUT

Overview

Updates the definition data for an event

Summary

This endpoint will update the Process Definition event identified by the record input parameter with the data provided in the request payload.

Request Arguments

Name	Type	Description	Required
record	String	The value for the evn_uid field in the pmse_bpmn_event record	True

Request Payload

There are 5 event types in SugarBPM^TM.

Start Event

{
    "data":
    {
        "evn_module":"Accounts",
        "evn_params":"updated",
        "evn_criteria":null
    }
}

Timer Event

{
    "data":
    {
        "evn_timer_type":"duration",
        "evn_duration_criteria":"10",
        "evn_duration_params":"minute",
        "evn_criteria":null
    }
}

Receive Message Event

{
    "data":
    {
        "evn_criteria":[
            {
              "expType":"MODULE",
              "expSubtype":"DropDown",
              "expLabel":"Accounts (Industry is equal to Banking)",
              "expValue":"Banking",
              "expOperator":"equals",
              "expModule":"Accounts",
              "expField":"industry"
            }
        ]
    }
}

Send Message Event

{
    "data":
    {
        "evn_module":"Accounts",
        "evn_criteria":"8444baae-c73f-11e8-afa5-6c400895ea84",
        "evn_params":
        {
            "to":[
               {
                  "type":"recipient",
                  "module":"calls",
                  "moduleLabel":"Calls",
                  "value":"email1",
                  "label":"%MODULE% : Email Address",
                  "filter":{
                     "expType":"MODULE",
                     "expSubtype":"DropDown",
                     "expLabel":"Calls (Status is equal to Scheduled)",
                     "expValue":"Planned",
                     "expOperator":"equals",
                     "expModule":"calls",
                     "expField":"status"
                  },
                  "chainedRelationship":{
                     "module":"contact_parent",
                     "moduleLabel":"Contacts",
                     "filter":{
                        "expType":"MODULE",
                        "expSubtype":"DropDown",
                        "expLabel":"Contacts (Lead Source is equal to Cold Call)",
                        "expValue":"Cold Call",
                        "expOperator":"equals",
                        "expModule":"contact_parent",
                        "expField":"lead_source"
                     }
                  }
               }
            ],
            "cc":[],
            "bcc":[]
        }
    }
}

End Event

{
   "data":{
      "activities":{
      },
      "events":{
         "4849630305bb7e68ae078d5012588603":{
            "evn_uid":"4849630305bb7e68ae078d5012588603",
            "evn_behavior":"THROW",
            "evn_marker":"EMPTY",
            "evn_message":"",
            "action":"UPDATE"
         }
      },
      "gateways":{
      },
      "flows":{
      },
      "artifacts":{
      },
      "prj_uid":"389d3d5a-c8ee-11e8-bc27-6c400895ea84"
   },
   "id":"389d3d5a-c8ee-11e8-bc27-6c400895ea84",
   "operation":"update",
   "wrapper":"Project"
}

Response Arguments

Name	Type	Description
N/A

Response

null