ServiceAppointment

Field Service、Lightning Scheduler、インテリジェントな予定管理、仮想ケアで顧客の作業を完了するための予定を表します。このオブジェクトは、API バージョン 38.0 以降で使用できます。

サポートされているコール

create()delete()describeLayout()describeSObjects()getDeleted()getUpdated()query()retrieve()search()undelete()update()upsert()

特別なアクセスルール

Field Service が有効になっている必要があります。

項目

項目名 詳細
AccountId
reference
プロパティ
Filter、Group、Nillable、Sort
説明
(参照のみ) 予定に関連付けられた取引先。親レコードが作業指示または作業指示品目の場合、この項目の値は親から継承されます。それ以外の場合は、空白のままです。
これはリレーション項目です。
リレーション名
Account
リレーション種別
Lookup
参照先
Account
ActualDuration
double
プロパティ
Create、Filter、Nillable、Sort、Update
説明
リソースが住所に到着してから予定が完了するまでにかかった時間 (分数)。[実際の開始時間] 項目と [実際の終了時間] 項目に値を最初に追加したときに [実際の所要時間] が自動的に生成され、[実際の開始時間][実際の終了時間] の差異が示されます。それ以降、[実際の開始時間] 項目と [実際の終了時間] 項目を更新しても [実際の所要時間] 項目は再更新されませんが、手動で更新できます。
ActualEndTime
dateTime
プロパティ
Create、Filter、Nillable、Sort、Update
説明
予定が終了した実際の日時。
ActualStartTime
dateTime
プロパティ
Create、Filter、Nillable、Sort、Update
説明
予定が開始された実際の日時。
Address
address
プロパティ
Filter
説明
予定を実行する住所。親レコードが作業指示または作業指示品目の場合、住所は親レコードから継承されます。
AppointmentNumber
string
プロパティ
Autonumber、Defaulted on create、Filter、idLookup、Sort
説明
予定を識別する自動割り当て番号。
ArrivalWindowEndTime
dateTime
プロパティ
Create、Filter、Nillable、Sort、Update
説明
技術者が取引先の部門に到着するようスケジュールされた時間枠の終了。通常、この時間枠はスケジュール済み開始時間から終了時間までの時間枠よりも大きい範囲になっており、遅延やスケジュール変更のための時間が確保されています。到着期間の開始と終了を顧客と共有し、スケジュール済み開始時間と終了時間を内部のみで維持するように選択できます。
ArrivalWindowStartTime
dateTime
プロパティ
Create、Filter、Nillable、Sort、Update
説明
技術者が取引先の部門に到着するようスケジュールされた時間枠の開始。遅延やスケジュールの変更に対応できるように、この期間は通常、[スケジュール済み開始時間] と [スケジュール済み終了時間] の期間よりも長くなります。到着期間の開始と終了を顧客と共有し、スケジュール済み開始時間と終了時間を内部のみで維持するように選択できます。
BundlePolicyId
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
このサービス予定に関連付けられたバンドルポリシーへの参照。
これはリレーション項目です。
リレーション名
BundlePolicy
リレーション種別
Lookup
参照先
ApptBundlePolicy
City
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
予定が完了した市区郡。最大 40 文字です。
ContactId
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
親レコードに関連付けられた取引先責任者。必要に応じて、サービス予定の取引先責任者を手動で更新できます。
これはリレーション項目です。
リレーション名
Contact
リレーション種別
Lookup
参照先
Contact
Country
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
作業指示が完了した国。最大 80 文字です。
Description
textarea
プロパティ
Create、Nillable、Update
説明
予定の説明。
DueDate
dateTime
プロパティ
Create、Filter、Sort、Update
説明
この日付までに予定を完了する必要があります。通常、許容最早開始日と期日は顧客のサービスレベル契約の条件を反映します。
Duration
double
プロパティ
Create、Nillable、Filter、Sort、Update
説明
想定される、予定の長さ。親レコードが作業指示または作業指示品目の場合、予定は親の所要時間を継承しますが手動で更新できます。所要時間は、[所要時間種別] 項目で選択した値に基づいて分または時間単位で示されます。
DurationType
picklist
プロパティ
Create、Defaulted on create、Filter、Group、Nillable、Restricted picklist、Sort、Update
説明
所要時間の単位 (分または時間)。
EarliestStartTime
dateTime
プロパティ
Create、Filter、Sort、Update
説明
この日付以降に予定を完了する必要があります。通常、許容最早開始日と期日は顧客のサービスレベル契約の条件を反映します。
GeocodeAccuracy
picklist
プロパティ
Create、Filter、Group、Nillable、Restricted picklist、Sort、Update
説明
物理的住所と比較した場合の場所の地理座標の精度レベル。通常、住所の緯度および経度座標に基づく地理コードサービスによって提供されます。

この項目は、API でのみ使用できます。

メモ

IsAnonymousBooking
boolean
プロパティ
Create、Defaulted on create、Filter、Group、Sort、Update
説明
サービスリソースが予定に自動的に割り当てられたかどうかを示します。デフォルト値は、false です。
この項目は、API バージョン 49.0 以降で使用できます。
IsBundle
boolean
プロパティ
Create、Defaulted on create、Filter、Group、Sort、Update
説明
このサービス予定がバンドルサービス予定であるかどうかを示します。デフォルト値は false です。
この項目は、API バージョン 54.0 以降で使用できます。
IsBundleMember
boolean
プロパティ
Create、Defaulted on create、Filter、Group、Sort、Update
説明
このサービス予定がバンドルメンバーサービス予定であることかどうか示します。デフォルト値は false です。
この項目は、API バージョン 54.0 以降で使用できます。
IsManuallyBundled
boolean
プロパティ
Create、Defaulted on create、Filter、Group、Sort、Update
説明
このバンドルが手動で作成されたかどうかを示します。デフォルト値は false です。
この項目は、API バージョン 54.0 以降で使用できます。
IsOffsiteAppointment
boolean
プロパティ
Create、Defaulted on create、Filter、Group、Sort、Update
説明
リモートで実行できる作業種別。
この項目は、API バージョン 58.0 以降で使用できます。
LastReferencedDate
dateTime
プロパティ
Filter、Nillable、Sort
説明
サービス予定が最後に更新された日付。ユーザーインターフェースの表示ラベルは、[最終更新日] です。
LastViewedDate
dateTime
プロパティ
Filter、Nillable、Sort
説明
サービス予定が最後に参照された日付。
Latitude
double
プロパティ
Create、Filter、Nillable、Sort、Update
説明
Longitude と一緒に使用して、サービス予定が完了した住所の正確な地理位置情報を指定します。許容値は、–90 ~ 90 (小数点以下 15 桁まで) の数値です。

この項目は、API でのみ使用できます。

メモ

Longitude
double
プロパティ
Create、Filter、Nillable、Sort、Update
説明
Latitude と一緒に使用して、サービス予定が完了した住所の正確な地理位置情報を指定します。許容値は、–180 ~ 180 (小数点以下 15 桁まで) の数値です。

この項目は、API でのみ使用できます。

メモ

OwnerId
reference
プロパティ
Create、Defaulted on create、Filter、Group、Sort、Update
説明
サービス予定の所有者。
これは多態的なリレーション項目です。
リレーション名
Owner
リレーション種別
Lookup
参照先
Group、User
ParentRecordId
reference
プロパティ
Create、Filter、Group、Nillable、Sort
説明
予定に関連付けられた親レコード。親レコードは、サービス予定が作成された後に更新することはできません。
これは多態的なリレーション項目です。
リレーション名
ParentRecord
リレーション種別
Lookup
参照先
Account、Asset、Lead、Opportunity、ServiceAppointmentGroup、WorkOrder、WorkOrderLineItem
ParentRecordStatusCategory
picklist
プロパティ
Defaulted on create、Filter、Group、Nillable、Restricted picklist、Sort
説明
(参照のみ) 親レコードの [状況のカテゴリ]。親レコードが作業指示または作業指示品目の場合、この項目に値が設定されます。それ以外の場合、空白のままです。
ParentRecordType
string
プロパティ
Filter、Group、Nillable、Sort
説明
(参照のみ) 親レコードのタイプ (取引先、納入商品、リード、商談、作業指示、または作業指示品目)。
PostalCode
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
作業指示が完了した郵便番号。最大 20 文字です。
RelatedBundleId
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
このサービス予定がメンバーであるバンドル。
これはリレーション項目です。
リレーション名
RelatedBundle
リレーション種別
Lookup
参照先
ServiceAppointment
SchedEndTime
dateTime
プロパティ
Create、Filter、Nillable、Sort、Update
説明
予定を終了するようにスケジュールされた時刻。Field Service 管理パッケージとスケジュールオプティマイザーを使用している場合、この項目は予定がリソースに割り当てられると入力されます。スケジュール済み終了時間[スケジュール済み開始時間] = [予想所要時間].
SchedStartTime
dateTime
プロパティ
Create、Filter、Nillable、Sort、Update
説明
予定を開始するようにスケジュールされた時刻。Field Service 管理パッケージとスケジュールオプティマイザーを使用している場合、この項目は予定がリソースに割り当てられると入力されます。
ServiceTerritoryId
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
予定に関連付けられたサービステリトリー。親レコードが作業指示または作業指示品目の場合、予定はその親のサービステリトリーを継承します。
これはリレーション項目です。
リレーション名
ServiceTerritory
リレーション種別
Lookup
参照先
ServiceTerritory
State
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
予定が完了した都道府県。最大 80 文字です。
Status
picklist
プロパティ
Create、Defaulted on create、Filter、Group、Nillable、Sort、Update
説明
予定の状況。選択リストには、カスタマイズ可能な次の値が表示されます。
  • なし — デフォルト値。
  • スケジュール済み — 予定はサービスリソースに割り当てられています。
  • 派遣済み — 割り当てられたサービスリソースは、割り当てについて通知されました。
  • 進行中 — 作業が開始されました。
  • 完了 — 作業が完了しました。
  • 完了不可 — 作業を完了できませんでした。
  • キャンセル済み — 作業がキャンセルされました。通常は作業開始前にキャンセルされます。
StatusCategory
picklist
プロパティ
Defaulted on create、Filter、Group、Nillable、Restricted picklist、Sort
説明
それぞれの [状況] の値が分類されるカテゴリ。[状況のカテゴリ] 項目にはデフォルトの [状況] 値と同じ値があります。

カスタムの [状況] 値を作成する場合は、どのカテゴリに属すかを指定する必要があります。たとえば、「Customer Absent」 (お客様不在) という値を作成する場合、それが [完了できません] カテゴリに属するということを指定できます。StatusCategory を参照するプロセスについての詳細は、「状況のカテゴリの使用方法」を参照してください。

Street
textarea
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
サービス予定が完了した番地および町名。
Subject
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
予定について説明する短い語句。
WorkTypeId
reference
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
サービス予定に関連付けられた作業種別。親が作業指示または作業指示品目の場合、作業種別は予定の親レコードから継承されます。

Lightning Scheduler も使用中の場合は、この項目を編集できます。ただし、この項目を更新して親レコードの作業種別と異なる作業種別をリストすると、エラーが表示されます。

メモ

これはリレーション項目です。
リレーション名
WorkType
リレーション種別
Lookup
参照先
WorkType

使用方法

サービス予定には必ず親レコード (作業指示、作業指示品目、商談、取引先、納入商品のいずれか) があります。親レコードのタイプによって、サービス予定の特性がわかります。
  • 作業指示作業指示品目のサービス予定は、実施される作業のより詳細なビューを提供します。作業指示と作業指示品目には作業に関する一般情報を入力できますが、サービス予定にはスケジュールと所有権に関する詳細を追加できます。
  • 納入商品に対するサービス予定は、納入商品に対して実行する作業を表します。
  • 取引先に対するサービス予定は、取引先に対して実行する作業を表します。
  • 商談に対するサービス予定は、商談に関連する作業を表します。
  • リードに対するサービス予定は、リードに関連する作業 (有望なリードを追求するための現地訪問など) を表します。

関連付けられたオブジェクト

このオブジェクトには次の関連するオブジェクトがあります。API バージョンが指定されていない場合、これらはこのオブジェクトと同じ API バージョンで使用できます。指定されている場合、指定された API バージョン以降で使用できます。

ServiceAppointmentChangeEvent (API バージョン 48.0)
このオブジェクトには変更イベントを利用できます。
ServiceAppointmentFeed
このオブジェクトにはフィード追跡を利用できます。
ServiceAppointmentHistory
オブジェクトの追跡項目について履歴を利用できます。
ServiceAppointmentOwnerSharingRule
このオブジェクトには共有ルールを利用できます。
ServiceAppointmentShare
このオブジェクトには共有を利用できます。