The following methods create and retrieve information for change requests.
Note: Change request responses only present changes from the last report and do not represent changes accumulated over a period of time.
Creating a Change Request
The createTicket method creates a new FireFlow change request.
Request Type: createTicket
|
Element |
Type |
Description |
|---|---|---|
| FFWSHeaderMandatory | FFWSHeader |
Header information. See FFWSHeader Type (see FFWSHeader Type ). |
| sessionIdMandatory |
String |
Client’s session identifier. |
| ticketMandatory | ticket |
A Ticket object. See Ticket Type (see Ticket Type ). |
Response Type: createTicketResponse
|
Element |
Type |
Description |
|---|---|---|
| resultMandatory |
Integer |
Method result. A value of 1 indicates success. |
| messageMandatory |
String |
A message describing the result. |
| ticketIdOptional |
Integer |
ID number of newly created change request. |
Retrieving a Change Request
The getTicket method retrieves a change request by its ID.
Request Type: getTicket
|
Element |
Type |
Description |
|---|---|---|
| FFWSHeaderMandatory | FFWSHeader |
Header information. See FFWSHeader Type (see FFWSHeader Type ). |
| sessionIdMandatory |
String |
Client’s session identifier. |
| ticketIdMandatory |
Integer |
ID of requested change request. |
Response Type: getTicketResponse
|
Element |
Type |
Description |
|---|---|---|
| resultMandatory |
Integer |
Method result. A value of 1 indicates success. |
| ticketOptional | ticket |
Requested change request. See Ticket Type (see Ticket Type ). |
| subTicketIdsOptional |
List of Integer |
IDs of change request's sub requests, if any. |
| parentTicketIdOptional |
Integer |
ID of the change request's parent request, if exists. |
Retrieving Information from a Change Request
The getFields method retrieves the content of specific change request fields, by change request ID and field name. For the list of valid fields, see Supported Change Request Field Names (see Supported Change Request Field Names).
Request Type: getFields
|
Element |
Type |
Description |
|---|---|---|
| FFWSHeaderMandatory | FFWSHeader |
Header information. See FFWSHeader Type (see FFWSHeader Type ). |
| sessionIdMandatory |
String |
Client’s session identifier. |
| ticketIdMandatory |
Integer |
ID of requested change request. |
| fieldsMandatory | fields |
Requested fields. See Fields Type (see Fields Type ). |
Response Type: getFieldsResponse
|
Element |
Type |
Description |
|---|---|---|
| resultMandatory |
Integer |
Method result. A value of 1 indicates success. |
| fieldsOptional |
List of customField objects |
Returned field values, along with the field's name. See CustomField Type (see CustomField Type ). |
Request example:
<getFields>
<FFWSHeader>
<version>1</version>
<opaque></opaque>
</FFWSHeader>
<sessionId>cf420f27e1bd47ec80587aee288f49ca</sessionId>
<ticketId>1</ticketId>
<fields>
<key>status</key>
<key>owner</key>
<key>owning group</key>
<key>My Custom Field</key>
</fields>
</getFields>
Response example:
<getFieldsResponse>
<result xsi:type="xsd:int">1</result>
<fields>
<key>status</key>
<values>approve</values>
</fields>
<fields>
<key>owner</key>
<values>admin</values>
</fields>
<fields>
<key>owning group</key>
<values>Security</values>
</fields>
<fields>
<key>My Custom Field</key>
<values>value of My Custom Field</values>
</fields>
</getFieldsResponse>
<getFieldsResponse>
<result xsi:type="xsd:int">1</result>
<fields>
<key>status</key>
<values>approve</values>
</fields>
<fields>
<key>owner</key>
<values>admin</values>
</fields>
<fields>
<key>owning group</key>
<values>Security</values>
</fields>
<fields>
<key>My Custom Field</key>
<values>value of My Custom Field</values>
</fields>
</getFieldsResponse>
Yes 
No 
