REST-TicketTimeTrack
This topic provides details about the REST - TicketTimeTrack API call that GFI HelpDesk uses, including its field types, arguments, and responses.
Retrieve a list of a ticket's time track notes.
API supported in version v4.01.220 and later.
Arguments
| Name | Description |
|---|---|
| $ticketid$ | The unique numeric identifier of the ticket |
Response
<timetrack id="1" ticketid="1" timeworked="600" timebillable="1200"billdate="1306393740" workdate="1306393740" workerstaffid="1"workerstaffname="Varun Shoor" creatorstaffid="1" creatorstaffname="VarunShoor" notecolor="1">Time track comment goes here</timetrack>
<timetrack id="2" ticketid="1" timeworked="600" timebillable="1200"billdate="1306393740" workdate="1306393740" workerstaffid="1"workerstaffname="Varun Shoor" creatorstaffid="1" creatorstaffname="VarunShoor" notecolor="1">Time track comment number two goes here</timetrack>
</timetracks>
Retrieve the time tracking note identified by $id$ that belongs to a ticket identified by $ticketid$.
API supported in version v4.01.220 and later.
Arguments
| Name | Description |
|---|---|
| $ticketid$ | The unique numeric identifier of the ticket |
| $id$ | The unique numeric identifier of the ticket time tracking note |
Response
<timetrack id="1" ticketid="1" timeworked="600" timebillable="1200"billdate="1306393740" workdate="1306393740" workerstaffid="1"workerstaffname="Varun Shoor" creatorstaffid="1" creatorstaffname="VarunShoor" notecolor="1">Time track comment goes here</timetrack>
</timetracks>
Add a new time tracking note to a ticket.
API supported in version > v4.01.220
Arguments (POST variables)
| Name | Description |
|---|---|
| ticketid | The unique numeric identifier of the ticket |
| contents | The ticket time tracking note contents |
| staffid | The ticket time tracking creator staff identifier |
| worktimeline | The UNIX timestamp which specifies when the work was executed |
| billtimeline | The UNIX timestamp which specifies when to bill the use |
| timespent | The time spent (in seconds) |
| timebillable | The time billable (in seconds) |
| workerstaffid | The staff identifier of the worker. If not specified, the staff user creating this entry is considered as the worker |
| notecolor | The Note Color |
Response
<timetrack id="1" ticketid="1" timeworked="600" timebillable="1200"billdate="1306393740" workdate="1306393740" workerstaffid="1"workerstaffname="Varun Shoor" creatorstaffid="1" creatorstaffname="VarunShoor" notecolor="1">Time track comment goes here</timetrack>
</timetracks>
Delete the ticket time tracking note identified by $id$ linked to the $ticketid$.
API supported in version > v4.01.220
Arguments
| Name | Description |
|---|---|
| $ticketid$ | The unique numeric identifier of the ticket |
| $id$ | The unique numeric identifier of the ticket time tracking note |