Ticket Type

The following table describes the elements in a ticket type object.

Element

Type

Description
template Mandatory

String

Ticket template.
attachments Optional

A list of attachment objects

A list of attachments. See Attachment Type (see Attachment Type ).
cc Optional

List of String

A list of email addresses to which the FireFlow system should send copies.
customFields Optional

List of customField objects

A list of user-defined custom fields. See CustomField Type (see CustomField Type ).
description Optional

String

A free text description of the issue.
devices

Mandatory - object change

Optional - traffic change

List of String

A list of device names, on which the change should be made.

Note:

  • In traffic change requests, devices can be empty, a single value or multiple values.
  • In a createTicket (see Creating a Change Request) with multiple devices, sub requests will be created.
  • In a getTicket (see Retrieving a Change Request) for a parent ticket, multiple devices (all sub request devices) will be returned.
  • In object change requests, devices must have exactly one value.
due Optional

String

The date by which this change request should be resolved, in the format: date, GMT.
expire Optional

String

The date on which this change request will expire, in the format: date, GMT.
externalId Optional

String

The ID number of an external system change request to which this change request should be linked.

owner Optional

String

The email address of the change request owner.
priority Optional

Integer

A number indicating this request's priority, where 0 indicates lowest priority.
refersTo Optional

Integer

The ID number of a change request to which this change request refers.
referredByOptional

Integer

The ID numbers of a change request that refer to this change request.
requestor Mandatory

String

The name of the requestor.
requestorEmail Mandatory

String

The email address of the requestor.
subject Mandatory

String

The change request's title.
trafficLines Optional

List of trafficLine objects

A list of traffic lines. See TrafficLine Type (see TrafficLine Type ).

Note: Relevant only for traffic change requests.

In getTicket (see Retrieving a Change Request), if the change request has planned traffic changes as well as requested traffic changes, the planned traffic lines will be returned here.
objectChangeLines Optional

List of objectChangeLine objects

A list of object change lines. See ObjectChangeLine Type (see ObjectChangeLine Type ).

Note: Relevant only for object change tickets.

In getTicket (see Retrieving a Change Request), if the change request has planned object changes as well as requested object changes, the planned object change lines will be returned here.
status Optional

String

Change status.

Only relevant for a change request returned by getTicket (see Retrieving a Change Request). Statuses passed to createTicket (see Creating a Change Request) will be ignored.
id Optional

Integer

Change request ID.

 

â See also: