Work with change requests

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

NOTE: We recommend using the following REST services for this method instead. REST services are more advanced and are the preferred choice over SOAP.

Traffic Change: Create a traffic change request
Object Change Multi Device: Create object change request
Rule Modification: Create Rule Modification Change Request
Rule Removal: Create a rule removal change request
Generic Change: Create generic change request
Request Recertification: Trigger Change Request Recertification

The createTicket method creates a new FireFlow change request.

Request Type: createTicket

Element	Type	Description
FFWSHeader Mandatory	FFWSHeader	Header information. See FFWSHeader Type (see FFWSHeader Type ).
sessionId Mandatory	String	Client’s session identifier.
ticket Mandatory	ticket	A Ticket object. See Ticket Type (see Ticket Type ).

Response Type: createTicketResponse

Element	Type	Description
result Mandatory	Integer	Method result. A value of 1 indicates success.
message Mandatory	String	A message describing the result.
ticketId Optional	Integer	ID number of newly created change request.

Retrieving a Change Request

NOTE: We recommend using the following REST services for this method instead. REST services are more advanced and are the preferred choice over SOAP.

Traffic Change: Get details for a specified change request
Object Change Multi Device: Get object change request
Rule Removal: Get rule removal ticket details by change request ID
Generic Change: Get ticket details by generic Request ID

The getTicket method retrieves a change request by its ID.

Request Type: getTicket

Element	Type	Description
FFWSHeader Mandatory	FFWSHeader	Header information. See FFWSHeader Type (see FFWSHeader Type ).
sessionId Mandatory	String	Client’s session identifier.
ticketId Mandatory	Integer	ID of requested change request.

Response Type: getTicketResponse

Element	Type	Description
result Mandatory	Integer	Method result. A value of 1 indicates success.
ticket Optional	ticket	Requested change request. See Ticket Type (see Ticket Type ).
subTicketIds Optional	List of Integer	IDs of change request's sub requests, if any.
parentTicketId Optional	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
FFWSHeader Mandatory	FFWSHeader	Header information. See FFWSHeader Type (see FFWSHeader Type ).
sessionId Mandatory	String	Client’s session identifier.
ticketId Mandatory	Integer	ID of requested change request.
fields Mandatory	fields	Requested fields. See Fields Type (see Fields Type ).

Response Type: getFieldsResponse

Element

Type

Description

result Mandatory

Integer

Method result. A value of 1 indicates success.

fields Optional

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>