ユニバーサル作業オブジェクトの取得
get
/crmRestApi/resources/11.13.18.05/universalWorkObjects/{WorkId}
リクエスト
パス・パラメータ
- WorkId(required): integer(int64)
ユニバーサル作業オブジェクトの一意の識別子。
問合せパラメータ
- dependency: string
このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
フォーマット: <attr1>=<val1>,<attr2>=<value2> - expand: string
このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
- fields: string
このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
フォーマット : ?fields=Attribute1,Attribute2
子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2 - links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- onlyData: boolean
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
この操作にはリクエスト本文がありません。
トップに戻る応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : universalWorkObjects-item-response
タイプ:
ソースを表示
object
-
AccountPartyId: integer (int64)
タイトル:
Account Party ID
作業オブジェクトに関連付けられたアカウント・パーティの一意の識別子。 -
AccountPartyUniqueName: string
タイトル:
Account
最大長:900
アカウントを識別する一意の名前。 -
AssigneeResourceId: integer (int64)
タイトル:
Assignee Resource ID
この作業オブジェクトに割り当てられたリソースの識別子。 -
BuOrgId: integer (int64)
タイトル:
Business Unit ID
この作業オブジェクトに関連付けられたビジネス・ユニット組織の一意の識別子。 将来使用するために予約されています。 -
CategoryId: integer (int64)
タイトル:
Category ID
作業リクエストに対するカテゴリの一意の識別子。 -
CategoryName: string
タイトル:
Category Name
読取り専用:true
最大長:255
作業オブジェクトに関連付けられたカテゴリの名前。 -
ChannelId: integer (int64)
タイトル:
Channel ID
作業オブジェクトに関連付けられたチャネルの一意の識別子。 -
ChannelTypeCd: string
タイトル:
Channel
最大長:30
チャネル・タイプを示すコード。 たとえば、電子メール、電話、ソーシャルなどです。 受け入れられる値のリストは、参照ORA_SVC_CHANNEL_TYPE_CDで定義されます。 -
ContactEmailAddr: string
タイトル:
Contact Email Address
最大長:320
チャネルから送信された担当者Eメール・アドレス。 -
ContactFirstName: string
タイトル:
Contact First Name
最大長:150
チャネルから送信された担当者の名。 -
ContactLastName: string
タイトル:
Contact Last Name
最大長:100
チャネルから送信された担当者の姓。 -
ContactPartyId: integer (int64)
タイトル:
Contact Party ID
作業オブジェクトに関連付けられた担当者パーティの一意の識別子。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
ユニバーサル作業オブジェクトを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
ユニバーサル作業オブジェクトが作成された日時。 -
DeleteFlag: boolean
読取り専用:
true
デフォルト値:false
ユニバーサル作業オブジェクトを削除できるかどうかを示します。 -
InteractionId: integer (int64)
タイトル:
Interaction ID
この作業オブジェクトに関連付けられた顧客対応の一意の識別子。 -
InventoryItemId: integer (int64)
タイトル:
Inventory Item ID
作業オブジェクトに関連付けられた製品の一意の識別子。 -
InventoryOrgId: integer (int64)
タイトル:
Inventory Organization ID
作業オブジェクトに関連付けられた製品の組織の一意の識別子。 -
LanguageCd: string
タイトル:
Language Code
最大長:30
この作業オブジェクトの顧客優先言語を示す参照コード。 -
LastAssignmentDate: string (date-time)
タイトル:
Last Assignment Date
このリクエストがエージェントに最後に提供された時間。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
ユニバーサル作業オブジェクトが最後に更新された日時。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
ユニバーサル作業オブジェクトを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
ユニバーサル作業オブジェクトを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ObjectId: number
タイトル:
Object ID
このリクエストに関連付けられたビジネス・オブジェクトまたはクライアント・チャネル・インスタンスIDの一意の識別子。 -
ObjectTypeCd: string
タイトル:
Object Type
最大長:30
ビジネス・オブジェクトのタイプ(設定されている場合)。 たとえば、SVC_SERVICE_REQUESTSです。 -
Priority: integer
タイトル:
Priority
割り当てる必要がある作業の優先度。 たとえば、SRの優先度は重大度に基づいて計算できます。 -
ProdGroupId: integer (int64)
タイトル:
Product Group ID
作業オブジェクトに関連付けられた製品グループの一意の識別子。 -
ProductGroupName: string
タイトル:
Product Group
最大長:250
作業オブジェクトに関連付けられた製品グループの名前。 -
ProductItemDescription: string
タイトル:
Product Description
読取り専用:true
最大長:255
作業オブジェクトに関連付けられた製品の説明。 -
ProductItemNumber: string
タイトル:
Product Number
読取り専用:true
最大長:255
作業オブジェクトに関連付けられた製品の代替キー識別子。 -
QueueId: integer (int64)
タイトル:
Queue ID
作業オブジェクトの割当て先であるキューの識別子。 -
RealtimeFlag: boolean
タイトル:
Real Time
最大長:1
チャネルがリアルタイムかどうかを示します。 -
ServiceZoneId: integer (int64)
タイトル:
Region ID
作業オブジェクトに関連付けられたサービス・リージョンの一意の識別子。 -
ServiceZoneName: string
タイトル:
Service Region
最大長:360
作業オブジェクトに関連付けられたサービス・リージョン名。 -
Severity: string
最大長:
30
割り当てる必要がある作業の重大度コード。 -
SocialChannelId: string
タイトル:
Social Channel ID
最大長:400
作業オブジェクトに関連付けられたソーシャル・チャネル識別子。 -
SocialChannelName: string
タイトル:
Social Channel Name
最大長:400
作業オブジェクトに関連付けられたソーシャル・チャネル名。 -
SocialChannelTypeCd: string
タイトル:
Social Channel Type
最大長:30
作業オブジェクトに関連付けられたソーシャル・チャネル・タイプ。 -
StatusCd: string
タイトル:
Status Code
最大長:30
作業オブジェクト割当のステータス。 -
StripeCd: string
タイトル:
Stripe Code
最大長:30
CRM、HCM、PRMなどのストライプ・コードを示す参照コード。 -
UpdateFlag: boolean
読取り専用:
true
ユニバーサル作業オブジェクトを更新できるかどうかを示します。 -
WoName: string
タイトル:
Reference ID
最大長:64
作業オブジェクトに関連付けられたオブジェクトのユーザー表示名。 -
WorkId: integer (int64)
タイトル:
Work ID
読取り専用:true
ユニバーサル作業オブジェクトの一意の識別子。 -
WoTitle: string
タイトル:
Title
最大長:400
作業オブジェクトに関連付けられたオブジェクトのユーザー表示タイトル。 -
WoTypeName: string
タイトル:
Work Object Type
最大長:30
作業オブジェクトに関連付けられた作業タイプのユーザー表示名。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
object
-
href: string
タイトル:
hyperlink reference
関連リソースへのURI。 -
kind: string
タイトル:
kind
許可された値:[ "collection", "item", "describe", "other" ]
関連リソースの種類。 -
name: string
タイトル:
name
関連リソースへのリンクの名前。 -
properties: object properties
-
rel: string
タイトル:
relation
許可された値:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
リソース・インスタンスとの関係の名前。 例: self.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。