Associate Plans with an Event

Allows a list of plans to be associated with an event from the Workflow module. This feature is only available if the Continuity module was installed.

 

URL

{WSUrl}/api/events/<Eventcode>/plans

 

REQUEST METHOD

POST

 

URL PARAMETER

EventCode: This parameter is provided in the URL and does not need to be sent through POST.

 

FORM CONTENT

An array with the following items:

Name (Required): Name of the plan that will be associated with the event. Limit of 1,000 characters.

PlanId (Required): The ID of the plan in the Continuity module that will be associated with the event. Valid values: whole numbers from 1 and 2147483647.

Version (Required): Version of the plan in the Continuity module that will be associated with the event. The version of the plan must be multiplied by 100 before being sent through the API. For example: Version 1.2 of a plan must be multiplied by 100, and therefore the value sent will be 120. Valid values: whole numbers from 1 and 2147483647.

Responsible (Required): Person assigned as responsible for the plan. Valid format: {"Name": "Person name", "Type": "Person"}.

 

REQUEST EXAMPLE

{WSUrl}/api/events/EVTC201105000052/plans

 

FORM CONTENT EXAMPLE

[{

"PlanId":123,

"Name":"Continuity Plan",

"Version":120,

"Responsible":{"Name":"John Smith","Type":"Person"}

}]

 

SUCCESS RESPONSE

HTTP status code 204: NoContent