Work with change requests

The following methods create and retrieve information for change requests.

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:

Response example: