Actions: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
Line 13: Line 13:


===Actions Sample===
===Actions Sample===
:<font color=blue><!—</font>{{APIComment|The Actions element is optional and may contain zero or more Action elements.}}
:{{Template:XFRACAS.Blue|<[[Actions Element|Actions]]>}}
:{{Template:XFRACAS.Blue|<[[Actions Element|Actions]]>}}
::<font color=blue><!—</font>{{APIComment|The ActionType Element is required.}}
::<font color=blue><!—</font>{{APIComment|An action will be updated if its ActionID matches an original ActionID and if any of the following values differ from the original: ActionType, ActionDescription, ActionResult, DueDate, Owner, StartDate, CompleteDate, SentEmailNoticeDate, Creator. If the ActionID does not match an original ActionID, UpdateOnly is disabled and the action will be inserted if it is valid.}}
::{{Template:XFRACAS.Blue|<[[Actions.Action|'''Action''']]>}}
::{{Template:XFRACAS.Blue|<[[Actions.Action|'''Action''']]>}}
:::{{Template:XFRACAS.Blue|<ActionID>}}{{Template:XFRACAS.Black|2}}{{Template:XFRACAS.Blue|</ActionID>}}
:::{{Template:XFRACAS.Blue|<ActionID>}}{{Template:XFRACAS.Black|2}}{{Template:XFRACAS.Blue|</ActionID>}}
:::<font color=blue><!—</font>{{APIComment|The ActionType Element is required and must contain either an ActionTypeID or Description element.}}
:::<font color=blue><!—</font>{{APIComment|The combination of the ActionTypeID and/or Description values must match an existing Action Type.}}
:::{{Template:XFRACAS.Blue|<[[Actions.ActionType|'''ActionType''']]>}}
:::{{Template:XFRACAS.Blue|<[[Actions.ActionType|'''ActionType''']]>}}
::::{{Template:XFRACAS.Blue|<ActionTypeID>}}{{Template:XFRACAS.Black|8}}{{Template:XFRACAS.Blue|</ActionTypeID>}}
::::{{Template:XFRACAS.Blue|<ActionTypeID>}}{{Template:XFRACAS.Black|8}}{{Template:XFRACAS.Blue|</ActionTypeID>}}
Line 24: Line 29:
::::{{Template:XFRACAS.Blue|<Description>}}{{Template:XFRACAS.Black|Incident}}{{Template:XFRACAS.Blue|</Description>}}
::::{{Template:XFRACAS.Blue|<Description>}}{{Template:XFRACAS.Black|Incident}}{{Template:XFRACAS.Blue|</Description>}}
:::{{Template:XFRACAS.Blue|</AssignedType>}}
:::{{Template:XFRACAS.Blue|</AssignedType>}}
:::<font color=blue><!—</font>{{APIComment|The ActionDescription element is required. A maximum of 1000 characters is allowed.}}
:::{{Template:XFRACAS.Blue|<[[Actions.ActionDescription|'''ActionDescription''']]>}}{{Template:XFRACAS.Black|Test Action}}{{Template:XFRACAS.Blue|</ActionDescription>}}
:::{{Template:XFRACAS.Blue|<[[Actions.ActionDescription|'''ActionDescription''']]>}}{{Template:XFRACAS.Black|Test Action}}{{Template:XFRACAS.Blue|</ActionDescription>}}
:::<font color=blue><!—</font>{{APIComment|The ActionResult is optional. A maximum of 1000 characters is allowed.}}
:::{{Template:XFRACAS.Blue|<ActionResult>}}{{Template:XFRACAS.Black|action results here}}{{Template:XFRACAS.Blue|</ActionResult>}}
:::{{Template:XFRACAS.Blue|<ActionResult>}}{{Template:XFRACAS.Black|action results here}}{{Template:XFRACAS.Blue|</ActionResult>}}
:::<font color=blue><!—</font>{{APIComment|DueDate is required and must contain a [[Valid Date]]}}
:::{{Template:XFRACAS.Blue|<[[Actions.DueDate|'''DueDate''']]>}}
:::{{Template:XFRACAS.Blue|<[[Actions.DueDate|'''DueDate''']]>}}
::::{{Template:XFRACAS.Blue|<Year>}}{{Template:XFRACAS.Black|2013}}{{Template:XFRACAS.Blue|</Year>}}
::::{{Template:XFRACAS.Blue|<Year>}}{{Template:XFRACAS.Black|2013}}{{Template:XFRACAS.Blue|</Year>}}
Line 35: Line 43:
::::{{Template:XFRACAS.Blue|<FormattedDate>}}{{Template:XFRACAS.Black|08/09/2013 12:00 AM}}{{Template:XFRACAS.Blue|</FormattedDate>}}
::::{{Template:XFRACAS.Blue|<FormattedDate>}}{{Template:XFRACAS.Black|08/09/2013 12:00 AM}}{{Template:XFRACAS.Blue|</FormattedDate>}}
:::{{Template:XFRACAS.Blue|</[[Actions.DueDate|DueDate]]>}}
:::{{Template:XFRACAS.Blue|</[[Actions.DueDate|DueDate]]>}}
:::<font color=blue><!—</font>{{APIComment|ActionOwner is required and the Login element must contain a [[Valid User]]}}
:::{{Template:XFRACAS.Blue|<ActionOwner>}}
:::{{Template:XFRACAS.Blue|<ActionOwner>}}
::::{{Template:XFRACAS.Blue|<FirstName>}}{{Template:XFRACAS.Black|Joe}}{{Template:XFRACAS.Blue|</FirstName>}}
::::{{Template:XFRACAS.Blue|<FirstName>}}{{Template:XFRACAS.Black|Joe}}{{Template:XFRACAS.Blue|</FirstName>}}
Line 40: Line 49:
::::{{Template:XFRACAS.Blue|<Login>}}{{Template:XFRACAS.Black|JUSER}}{{Template:XFRACAS.Blue|</Login>}}
::::{{Template:XFRACAS.Blue|<Login>}}{{Template:XFRACAS.Black|JUSER}}{{Template:XFRACAS.Blue|</Login>}}
:::{{Template:XFRACAS.Blue|</[Actions.ActionOwner|'''ActionOwner''']]>}}
:::{{Template:XFRACAS.Blue|</[Actions.ActionOwner|'''ActionOwner''']]>}}
:::<font color=blue><!—</font>{{APIComment|StartDate is required and must contain a [[Valid Date]]}}
:::{{Template:XFRACAS.Blue|<[[Actions.StartDate|'''StartDate''']]>}}
:::{{Template:XFRACAS.Blue|<[[Actions.StartDate|'''StartDate''']]>}}
::::{{Template:XFRACAS.Blue|<Year>}}{{Template:XFRACAS.Black|2013}}{{Template:XFRACAS.Blue|</Year>}}
::::{{Template:XFRACAS.Blue|<Year>}}{{Template:XFRACAS.Black|2013}}{{Template:XFRACAS.Blue|</Year>}}
Line 49: Line 59:
::::{{Template:XFRACAS.Blue|<FormattedDate>}}{{Template:XFRACAS.Black|08/01/2013 03:45 PM}}{{Template:XFRACAS.Blue|</FormattedDate>}}
::::{{Template:XFRACAS.Blue|<FormattedDate>}}{{Template:XFRACAS.Black|08/01/2013 03:45 PM}}{{Template:XFRACAS.Blue|</FormattedDate>}}
:::{{Template:XFRACAS.Blue|</[[Actions.StartDate|'''StartDate''']]>}}
:::{{Template:XFRACAS.Blue|</[[Actions.StartDate|'''StartDate''']]>}}
:::<font color=blue><!—</font>{{APIComment|CompleteDate is required and must contain a [[Valid Date]]}}
:::{{Template:XFRACAS.Blue|<CompleteDate>}}
:::{{Template:XFRACAS.Blue|<CompleteDate>}}
::::{{Template:XFRACAS.Blue|<Year>}}{{Template:XFRACAS.Black|2013}}{{Template:XFRACAS.Blue|</Year>}}
::::{{Template:XFRACAS.Blue|<Year>}}{{Template:XFRACAS.Black|2013}}{{Template:XFRACAS.Blue|</Year>}}
Line 58: Line 69:
::::{{Template:XFRACAS.Blue|<FormattedDate>>}}{{Template:XFRACAS.Black|08/01/2013 03:46 PM}}{{Template:XFRACAS.Blue|</FormattedDate>}}
::::{{Template:XFRACAS.Blue|<FormattedDate>>}}{{Template:XFRACAS.Black|08/01/2013 03:46 PM}}{{Template:XFRACAS.Blue|</FormattedDate>}}
:::{{Template:XFRACAS.Blue|</CompleteDate>}}
:::{{Template:XFRACAS.Blue|</CompleteDate>}}
:::<font color=blue><!—</font>{{APIComment|SentEmailNoticeDate is optional and, if present, must contain a [[Valid Date]]}}
:::{{Template:XFRACAS.Blue|<SentEmailNoticeDate />}}
:::{{Template:XFRACAS.Blue|<SentEmailNoticeDate />}}
:::<font color=blue><!—</font>{{APIComment|The Creator element is required and, if present, must contain a [[Valid User]]}}
:::{{Template:XFRACAS.Blue|<[[Actions.Creator|'''Creator''']]>}}
:::{{Template:XFRACAS.Blue|<[[Actions.Creator|'''Creator''']]>}}
::::{{Template:XFRACAS.Blue|<FirstName>}}{{Template:XFRACAS.Black|Sam}}{{Template:XFRACAS.Blue|</FirstName>}}
::::{{Template:XFRACAS.Blue|<FirstName>}}{{Template:XFRACAS.Black|Sam}}{{Template:XFRACAS.Blue|</FirstName>}}

Revision as of 21:35, 9 March 2015

XML Elements


Actions Sample

<!— The Actions element is optional and may contain zero or more Action elements.
<Actions>
<!— The ActionType Element is required.
<!— An action will be updated if its ActionID matches an original ActionID and if any of the following values differ from the original: ActionType, ActionDescription, ActionResult, DueDate, Owner, StartDate, CompleteDate, SentEmailNoticeDate, Creator. If the ActionID does not match an original ActionID, UpdateOnly is disabled and the action will be inserted if it is valid.
<Action>
<ActionID> 2 </ActionID>
<!— The ActionType Element is required and must contain either an ActionTypeID or Description element.
<!— The combination of the ActionTypeID and/or Description values must match an existing Action Type.
<ActionType>
<ActionTypeID> 8 </ActionTypeID>
<Description> Incident Action </Description>
</ActionType>
<AssignedType>
<AssignedID> 1 </AssignedID>
<Description> Incident </Description>
</AssignedType>
<!— The ActionDescription element is required. A maximum of 1000 characters is allowed.
<ActionDescription> Test Action </ActionDescription>
<!— The ActionResult is optional. A maximum of 1000 characters is allowed.
<ActionResult> action results here </ActionResult>
<!— DueDate is required and must contain a Valid Date
<DueDate>
<Year> 2013 </Year>
<Month> 8 </Month>
<Day> 9 </Day>
<Hour> 7 </Hour>
<Minute> 0 </Minute>
<Second> 0 </Second>
<FormattedDate> 08/09/2013 12:00 AM </FormattedDate>
</DueDate>
<!— ActionOwner is required and the Login element must contain a Valid User
<ActionOwner>
<FirstName> Joe </FirstName>
<LastName> User </LastName>
<Login> JUSER </Login>
</[Actions.ActionOwner
<!— StartDate is required and must contain a Valid Date
<StartDate>
<Year> 2013 </Year>
<Month> 8 </Month>
<Day> 1 </Day>
<Hour> 22 </Hour>
<Minute> 45 </Minute>
<Second> 7 </Second>
<FormattedDate> 08/01/2013 03:45 PM </FormattedDate>
</StartDate>
<!— CompleteDate is required and must contain a Valid Date
<CompleteDate>
<Year> 2013 </Year>
<Month> 8 </Month>
<Day> 1 </Day>
<Hour> 22 </Hour>
<Minute> 46 </Minute>
<Second> 8 </Second>
<FormattedDate>> 08/01/2013 03:46 PM </FormattedDate>
</CompleteDate>
<!— SentEmailNoticeDate is optional and, if present, must contain a Valid Date
<SentEmailNoticeDate />
<!— The Creator element is required and, if present, must contain a Valid User
<Creator>
<FirstName> Sam </FirstName>
<LastName> User </LastName>
<Login> SUSER </Login>
</Creator>
<Details />
</Action>
</Actions>
Retrieved from "https://www.reliawiki.com/index.php?title=Actions&oldid=57261"