Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


...

Name

Type

Description

id

String

The ID of the retrieved

job

service request

number

String

The number of the retrieved

job

service request 

descriptionStringThe description of the retrieved
job notes
service request 

life_cycle_state

String

The life cycle state of the retrieved service request which can be PENDING, RESPONDED, TEMPORARY_RESOLVED, FINAL_RESOLVED, COMPLETED

caller_emailStringThe email address of the caller as specified on the retrieved service request
caller_phoneString

The

notes

phone number of the

retrieved job

life_cycle_state

String

The life cycle state of the retrieved activity which can be PENDING, IN PROGRESS, COMPLETED

caller as specified on the retrieved service request

Tip

Available from CRM.COM R10.0.0


urgency_levelString

The urgency level of the retrieved service request, which can be one of the following:

URGENCY1, URGENCY2, URGENCY3, CUSTOM1, CUSTOM2 , CUSTOM3, CUSTOM4, CUSTOM5

Tip

For releases prior CRM.COM R14.0.0, the urgency levels CUSTOM3, CUSTOM4 and CUSTOM5 are supported as well


impact_levelString

The impact level of the retrieved service request, which can be one of the following:

IMPACT1, IMPACT2, IMPACT3, CUSTOM1, CUSTOM2

Tip

For releases prior CRM.COM R14.0.0, the impact levels CUSTOM3, CUSTOM4 and CUSTOM5 are supported as well


priority_levelNumber

The priority level of the retrieved service request, which can be one of the following:

1, 2, 3, 4, 5, 6, 7, 8, 9, 10

start_dateDateThe date that the
job
service request is created
expected_completion_dateDateThe date that the
job
service request is expected to be completed
actual_completed_dateDateThe date that the
job
service request is actually completed
cancellation_reasonService Requests Cancellation Object

The reason that the job was cancelled. This is applicable only if the job is on a cancelled life cycle state

Tip

Available from CRM.COM R15


notesStringThe shared notes of the retrieved service request

udf_string_1

String

User Defined Field of type String

udf_string_2

String

User Defined Field of type String

udf_string_3

String

User Defined Field of type String

udf_string_4

String

User Defined Field of type String

udf_string_5

String

User Defined Field of type String

udf_string_6

String

User Defined Field of type String

udf_string_7

String

User Defined Field of type String

udf_string_8

String

User Defined Field of type String

udf_float_1

Float

User Defined Field of type Float

udf_float_2

Float

User Defined Field of type Float

udf_float_3

Float

User Defined Field of type Float

udf_float_4

Float

User Defined Field of type Float

udf_date_1

Date

User Defined Field of type Date

udf_date_2

Date

User Defined Field of type Date

udf_date_3

Date

User Defined Field of type Date

udf_date_4

Date

User Defined Field of type Date

accounts_receivable

Accounts Receivable object

The accounts receivable related with the specified service request

callerContact Information objectThe caller related with the specified service request 
assigned_toAssign ObjectThe assignment information of the retrieved
job
service request
type
Job
Service Request type objectThe type information of the retrieved
jobbilling_termsBilling Terms ObjectThe billing terms of the retrieved jobstatusJob
service request
statusService Request Status objectThe status information of the retrieved
job
service request
category
Job
Service Request Category objectThe category of the retrieved
job
service request
estimate
estimated_completion_timeTime Period ObjectThe time that is estimated to complete the
job
service request, measured in minutes, hours, days, weeks, years
time_to_completionTime Period ObjectThe time that is left up to the expected completion date
time_overdueTime Period ObjectThe time past the expected completion date
accounts
owned_by_
receivable
group
Accounts Receivable
Group object

The

accounts receivable related with the specified joblocationAddress ObjectThe physical location that the job should be performed and delivered to

group that is owning the service request

Tip

Deprecated from CRM.COM R18.0.0 (replaced with owned_by_business_unit)


owned_by_
groupGroup object
business_unitBusiness Unit Object

The

group

business unit that is owning

the job

the service request

Tip

Available from CRM.COM R18.0.0


privacy_levelPrivacy level object

The

job

privacy level of the service request

Tip

Deprecated from CRM.COM R18.0.0


log_information

Log Information Object

The log information related with the retrieved

jobphysical_goods_to_be_provided

service request

referring_toService Request Referring to ObjectThe entities for which the service request was raised for and can be a Subscription or a Job
responseService Request Response ObjectThe response of the retrieved service request 
temporary_resolutionService Request Temporary Resolution ObjectThe temporary resolution of the retrieved service request
final_resolutionService Request Final ResolutionThe final resolution of the retrieved service request
services_setSet of Services Objects

A list of services for which the service request was raised for

physical_goods_setSet of Physical Goods
to Be Provided expenses
Objects
The physical goods that will be provided as part of the job

A list of the physical goods for which the retrieved service request was raised for, which can be traceable or not traceable

related_service_requests_setSet of
Expense
Related Service Requests ObjectsA list
of one time services which are applied on the job as expenses
with the service requests for which the retrieved service request relates to
related_activities_setSet of
Activity
Related Activities Objects

A

set of

list with the activities for which

are planned for the specific jobbills

the retrieved service request relates to

Tip

Available from CRM.COM R14.0.0


related_jobs_setSet of
Bill
Related Jobs Objects

A

set of bills that were generated by the billing engine in relation to the specific job

 

list with the jobs for which the retrieved service request relates to

Tip

Available from CRM.COM R14.0.0


Anchor
service requests referred objects
service requests referred objects
Referred Objects Response Data

Include Page
accounts_receivable_short
accounts_receivable_short

Include Page
contact_information_short
contact_information_short

Include Page
assigned_to_short
assigned_to_short

Include Page
job_typeservice_request_cancellation_reasons_shortjob_type
service_request_cancellation_reasons_short

Include Page
billingservice_termsrequest_jobstype_shortbilling
service_termsrequest_jobstype_short

Include Page
jobservice_request_status_shortjob
service_request_status_short

Include Page
jobservice_request_category_shortjob
service_request_category_short

Include Page
accountstime_receivableperiod_shortaccounts
time_receivableperiod_short

Include Page
addressgroup_shortaddress
group_short

Include Page
groupprivacy_level_shortgroup
privacy_level_short

Include Page
privacylog_levelinformation_shortprivacy
log_levelinformation_short

job_physical_good_to_be_provided
Include Page
job_physical_good_to_be_provided_short
service_requests_referring_to_short
service_requests_referring_to_short

Include Page
service_request_response_short
service_request_response_short

Include Page
service_request_temporary_resolution_short
service_request_temporary_resolution_short

Include Page
service_request_final_resolution_short
service_request_final_resolution_short

Include Page
service_request_services_short
service_request_services_short

Include Page
service_request_physical_goods_short
service_request_physical_goods_short

Include Page
jobrelated_service_expenserequest_shortjob
related_service_expenserequest_short

Include Page
activity_short
activity_short

Include Page
billjob_shortbill
job_short

Include Page
logbusiness_informationunit_shortlog
business_informationunit_short