Project Schema

Schemas

Faults_View

The list response wrapper for project/ticket queries.

Property	Type	Description
page_no	integer	Current page number (when paginating)
page_size	integer	Page size (when paginating)
record_count	integer	Total record count
tickets	array of Faults_List	The ticket/project records
columns_id	integer	Column profile ID
columns_tilehtml	string	Tile HTML template
columns_dashboard_id	integer	Dashboard column ID
columns_cardhtml	string	Card HTML template
columns_calendar_event_title	string	Calendar event title template
columns	array of ViewColumnsDetails	Column definitions
zapier_ticket	ZapierFaults	Zapier ticket object
_warning	string	Warning message
completion_perc	number (double)	Overall completion percentage
include_children	boolean	Whether children are included
collapse_by_default	boolean	Whether to collapse by default
_dl_warning	string	Data limit warning message
statuses	array of TStatus_List	Available statuses
priorities	array of Policy	Available priorities
agents	array of Uname_List	Available agents

---

Faults

The core project/ticket object used for both requests and responses.

Core Fields:

Property	Type	Description
id	integer	Ticket/project ID
summary	string	Ticket summary/title
details	string	Ticket details (plain text)
details_html	string	Ticket details (HTML)
dateoccurred	datetime	Date the ticket was opened
datecreated	datetime	Date the ticket was created
dateclosed	datetime	Date closed
date_fully_closed	datetime	Date fully closed
last_update	datetime	Last update timestamp
lastactiondate	datetime	Date of last action

Status and Classification:

Property	Type	Description
status_id	integer	Status ID
status_name	string	Status name
tickettype_id	integer	Ticket type ID
tickettype_name	string	Ticket type name
priority_id	integer	Priority ID
impact	integer	Impact level
urgency	integer	Urgency level
impactlevel	integer	Impact level (alternative field)
category_1 / category_2 / category_3 / category_4	string	Category names
categoryid_1 / categoryid_2 / categoryid_3 / categoryid_4	integer	Category IDs
requesttype_name	string	Request type name
itilname	string	ITIL type name
source	integer	Ticket source

People and Assignment:

Property	Type	Description
client_id	integer	Client ID
client_name	string	Client name
site_id	integer	Site ID
site_name	string	Site name
user_id	integer	End user ID
user_name	string	End user name
user_email	string	End user email
firstname	string	End user first name
lastname	string	End user last name
team_id	integer	Team ID
team	string	Team name
agent_id	integer	Assigned agent ID
agent_name	string	Assigned agent name
organisation_id	integer	Organisation ID
department_id	integer	Department ID
reportedby	string	Reported by field
takenby	string	Taken by (created by)

SLA Fields:

Property	Type	Description
sla_id	integer	SLA ID
sla_name	string	SLA name
respondbydate	datetime	SLA respond-by date
responsedate	datetime	Actual response date
first_responsedate	datetime	First response date
fixbydate	datetime	SLA fix-by date
slaresponsestate	string	SLA response state
slatimeelapsed	number	SLA time elapsed
slatimeleft	number	SLA time remaining
slapercused	number	SLA percentage used
slaactiondate	datetime	SLA action date
excludefromsla	boolean	Whether excluded from SLA
slaholdtime	number	SLA hold time
sla_first_response_state	string	SLA first response state
first_respond_by_date	datetime	First respond-by date

Project-Specific Fields:

Property	Type	Description
startdate	datetime	Project start date
targetdate	datetime	Project target/end date
deadlinedate	datetime	Project deadline
projectearlieststart	datetime	Earliest start date
projectlatestend	datetime	Latest end date
projecttimepercentage	number	Time percentage used
projectcompletionpercentage	number	Completion percentage
projecttimebudget	number	Time budget (hours)
projectmoneybudget	number	Money budget
projecttimeactual	number	Actual time spent
projectmoneyactual	number	Actual money spent
projectinternaltask	boolean	Whether this is an internal project task
estimate	number	Estimated hours
estimatedays	number	Estimated days
milestone_id	integer	Milestone ID
milestone_name	string	Milestone name
milestone_billing_type	integer	Milestone billing type
milestone_value	number	Milestone value
milestone_sequence	integer	Milestone sequence number
milestone_status	integer	Milestone status
milestone_startdate	datetime	Milestone start date
milestone_enddate	datetime	Milestone end date
main_project_id	integer	Parent project ID
update_milestone_id	integer	Milestone to update

Time and Billing:

Property	Type	Description
timetaken	number	Total time taken (hours)
chargehours	number	Chargeable hours
nonchargehours	number	Non-chargeable hours
travelhours	number	Travel hours
totalmileage	number	Total mileage
mileage	number	Mileage
nonbillable_time	number	Non-billable time
cost	number	Cost
actualcost	number	Actual cost
itemsprice	number	Items price
items	string	Items description
contract_id	integer	Contract ID
contract_ref	string	Contract reference
salesorder_id	integer	Sales order ID
orderhead_id	integer	Order head ID
budgettype	string	Budget type
budgetcode	integer	Budget code

Child/Parent Relationships:

Property	Type	Description
parent_id	integer	Parent ticket ID
parent_subject	string	Parent ticket subject
child_count	integer	Total child ticket count
child_count_open	integer	Open child ticket count
child_ticket_ids	array of integer	Child ticket ID list
child_ticket_id_string	string	Child ticket IDs as string
merged_into_id	integer	ID of ticket this was merged into
top_level_id	integer	Top-level ticket ID

Workflow and Approvals:

Property	Type	Description
workflow_id	integer	Workflow ID
workflow_name	string	Workflow name
workflow_stage	string	Current workflow stage name
workflow_stage_id	integer	Current workflow stage ID
workflow_stage_number	string	Workflow stage number
workflow_step	integer	Workflow step
workflow_stepstarted	datetime	When workflow step started
changestate	string	Change state
approvedby	integer	Approved by agent ID
approval_process_id	integer	Approval process ID
approval_process_step	integer	Current approval step
approval_process_step_name	string	Current approval step name
approval_cab_name	string	CAB name for approval

Custom Fields and Extensions:

Property	Type	Description
customfields	array of CustomField	Custom field values
timeentries	array of FaultsTimeEntry	Time entries on the ticket
userdef1 through userdef5	string	User-defined fields

Supplier Fields:

Property	Type	Description
supplier_id	integer	Supplier ID
supplier_name	string	Supplier name
supplier_status	integer	Supplier status
supplier_sla_id	integer	Supplier SLA ID
supplier_priority_id	integer	Supplier priority ID
supplier_responsestate	string	Supplier response state
supplier_responsedate	datetime	Supplier response date
supplier_respondbydate	datetime	Supplier respond-by date
supplier_fixbydate	datetime	Supplier fix-by date
supplier_dateclosed	datetime	Supplier close date
supplier_slastate	string	Supplier SLA state
supplier_slatimeelapsed	number	Supplier SLA time elapsed
supplier_contract_id	integer	Supplier contract ID
supplier_contract_ref	string	Supplier contract reference

Other Notable Fields:

Property	Type	Description
flagged	boolean	Whether ticket is flagged
read	boolean	Whether ticket has been read
onhold	boolean	Whether ticket is on hold
hasbeenclosed	boolean	Whether ticket has ever been closed
inactive	boolean	Whether user is inactive
is_vip	boolean	Whether end user is VIP
attachment_count	integer	Number of attachments
satisfactionlevel	integer	Customer satisfaction level
satisfactioncomment	string	Customer satisfaction comment
template_id	integer	Template ID used to create
template_name	string	Template name
invoicenumber	string	Invoice number
invoicedate	datetime	Invoice date
invoicepaiddate	datetime	Invoice paid date
invoicestatus	integer	Invoice status
web_url	string	Web URL for the ticket
api_url	string	API URL for the ticket
colour	string	Colour code
ai_summary	string	AI-generated summary
lessonslearned	string	Lessons learned field
closure_note	string	Closure note (plain text)
closure_note_html	string	Closure note (HTML)
closure_time	number	Time at closure
github_repository	string	Linked GitHub repository
pr_link	string	Linked pull request URL
component_id / component_name	integer / string	Component details
version_id / version_name	integer / string	Version details
service_id	integer	Related service ID
release_id / release_name	integer / string	Release 1 details
release2_id / release2_name	integer / string	Release 2 details
release3_id / release3_name	integer / string	Release 3 details

---

ProjectSetupLines

Represents a line in a project setup/template, defining tasks or sub-tickets to create.

Property	Type	Description
id	integer	Record ID
seq	integer	Sequence number
name	string	Line name
template_id	integer	Template ID for this line
project_parent	integer	Parent project ID
project_parent_is_ticket	boolean	Whether the parent is a ticket
ticket_id	integer	Associated ticket ID
table_type	integer	Table type identifier
entity_id	integer	Entity ID
line_ids	string	Line IDs (comma-separated)
project_line_list	array of KeyPair2	List of project line key-value pairs
template_name	string	Template name
set_template_id	integer	Set template ID
settemplate_name	string	Set template name
template	StdRequest	Template object
new_template	StdRequest	New template object
so_lines	array of OrderLine	Sales order lines
_isnew	boolean	Whether this is a new record
_convertlines	boolean	Whether to convert lines
_warning	string	Warning message

---