Service Provider API-Guide

Download As PDF

Object Basics

Generally speaking, API objects represent database tables that contain your organization's information. For example, the central object in the Facility Source (FS) data model represents accounts—companies and organizations involved with your business, such as customers, partners, and competitors. The term “record” describes a particular occurrence of an object. A record is analogous to a row in a database table. Objects can be standard objects,custom objects and external objects.

Applications work with only the objects that you are authorized to access. Programmatic access to objects are determined by the objects defined in your organization, your organization configuration, your user permissions and access settings (which are configured by your organization’s system administrator), your data sharing model, and other factors related specifically to the object.

Primitive Data Types

The API uses the following primitive data types:

Value Details
Base64 Base 64-encoded binary data. Fields of this type are used for storing binary files in Attachment records, Document records, and Scontrol records.
boolean Boolean fields have one of these values: true (or 1), or false (or 0).
Byte A set of bits.
Date Fields of this type contain date values, such as ActivityDate in the Event object.
DateTime Fields of this type handle date/time values (timestamps), such as ActivityDateTime in the Event object or the CreatedDate, LastModifiedDate, or SystemModstamp in many objects.
Double Fields of this type can contain fractional portions (digits to the right of the decimal place), such as ConversionRate in CurrencyType.
Scale: Maximum number of digits to the right of the decimal place.
Precision: Total number of digits, including those to the left and the right of the decimal place.
int Fields of this type contain numbers with no fractional portion.
string Fields that are of data type string contain text and some have length restrictions depending on the data being stored. The MailingStreet is 255 characters.
time Fields of this type handle time values, such as FridayEndTime in the BusinessHours object. Development tools differ in the way that they handle time data.

Fields types:

Comments Version

Value Details
CommentFragment A Collection of data See all collection list

List of CommentFragment

Name Type
Id integer
Subject string
Body string
WorkOrderNumber string
OwnerUserId integer
CreateUser string
CreateDateTime date
AllowInternal boolean
AllowClient boolean
AllowVendor boolean
AllowCorporate boolean
WorkOrderStatusID integer
CommentTypeID integer
IsEmailHighImportance boolean
RequestCodeID integer
User string
Role string
Company string
FirstName string
LastName string

Filtering

Value Detail
PartialFilterClauseModel A Collection of data See all collection list

List of PartialFilterKeywordModel

Name Type
Operation KeywordOperation
NegateOperation boolean
Keyword string

List of KeywordOperation

Possible enumeration values:

Name Value
Equal

0
Contain

1
LessThan

2
LessThanOrEqual

3
GreaterThan

4
GreaterThanOrEqual

5
StartsWith

6

WorkOrders

Value Details
ExternalWorkOrder A Collection of data See all collection list
ExternalAttachment A Collection of data See all collection list

List of ExternalWorkOrder

NameType
Id integer
WorkOrderNumber string
Type string
WorkType string
Status string
StatusCode string
Description string
Priority string
DateReported date
DateModified date
TargetDate date
ScheduledStartDateTime date
ScheduledCompleteDateTime date
ActualStartDateTime date
ActualCompleteDateTime date
LatestInteractiveVoiceResponseIn date
LatestInteractiveVoiceResponseOut date
GLCode string
RequestingContact string
AlternateContact string
RequestTypeId integer
RequestType string
DepartmentId integer
Department string
TradeId integer
RequestCodeId integer
RequestCode string
ServiceLocationName string
DNE decimal number
WorkTypeGLCode string
RequestGLCode string
DispatchMatrixGLCode string
AlternateWorkOrderNumber string
IsETAMissed boolean
MissedETAMessage string
IsEmergency boolean
IsVendorOnSite boolean
HasAttachments boolean
TargetCompleteDate date
IsSnow boolean
ProjectNumber string
ProjectOther string
CurrencyCode string

List of ExternalAttachment

NameType
WorkOrderNumber string
Id integer
InvoiceId integer
QuoteId integer
Name string
Path string
URL string
Username string
CreatedDate date
FormattedCreatedDate string
SizeString string
Latitude string
Longitude string