機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. ユニバーサル作業オブジェクト

すべてのユニバーサル作業オブジェクトの取得

get

/crmRestApi/resources/11.13.18.05/universalWorkObjects

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    使用可能なファインダ名および対応するファインダ変数を次に示します:

    • PrimaryKey : 指定された主キーを持つユニバーサル作業オブジェクトを検索します。
      ファインダ変数:
      • WorkId; integer;ユニバーサル作業オブジェクトの一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
  • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY

    フォーマット : ?q=expression1;expression2

    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • AccountPartyId; integer; 作業オブジェクトに関連付けられたアカウント・パーティの一意の識別子。
    • AccountPartyUniqueName; string; アカウントを識別する一意の名前。
    • AssigneeResourceId; integer; この作業オブジェクトに割り当てられたリソースの識別子。
    • BuOrgId; integer;この作業オブジェクトに関連付けられたビジネス・ユニット組織の一意の識別子。 将来使用するために予約されています。
    • CategoryId; integer; 作業リクエストに対するカテゴリの一意の識別子。
    • CategoryName; string; 作業オブジェクトに関連付けられたカテゴリの名前。
    • ChannelId; integer; 作業オブジェクトに関連付けられたチャネルの一意の識別子。
    • ChannelTypeCd; string; チャネル・タイプを示すコード。 たとえば、電子メール、電話、ソーシャルなどです。 受け入れられる値のリストは、参照ORA_SVC_CHANNEL_TYPE_CDで定義されます。
    • ContactEmailAddr; string; チャネルから送信される担当者の電子メール・アドレス。
    • ContactFirstName; string;チャネルから送信される担当者の名。
    • ContactLastName; string;チャネルから送信される担当者の姓。
    • ContactPartyId; integer; 作業オブジェクトに関連付けられている担当者パーティの一意の識別子。
    • CreatedBy; string;ユニバーサル作業オブジェクトを作成したユーザー。
    • CreationDate; string;ユニバーサル作業オブジェクトが作成された日時。
    • InteractionId; integer; この作業オブジェクトに関連付けられた相互作用の一意の識別子。
    • InventoryItemId; integer; 作業オブジェクトに関連付けられた製品の一意の識別子。
    • InventoryOrgId; integer; 関連付けられた作業オブジェクトである製品の組織の一意の識別子。
    • LanguageCd; string; この作業オブジェクトの顧客優先言語を示す参照コード。
    • LastAssignmentDate; string; このリクエストがエージェントに提供された最後の時間。
    • LastUpdateDate; string;ユニバーサル作業オブジェクトが最後に更新された日時。
    • LastUpdateLogin; string;ユニバーサル作業オブジェクトを最後に更新したユーザーのログイン。
    • LastUpdatedBy; string;ユニバーサル作業オブジェクトを最後に更新したユーザー。
    • ObjectId; number。このリクエストに関連付けられたビジネス・オブジェクトまたはクライアント・チャネル・インスタンスIDの一意の識別子。
    • ObjectTypeCd; string; 設定されている場合は、ビジネス・オブジェクトのタイプ。 たとえば、SVC_SERVICE_REQUESTSです。
    • 優先度、整数。割り当てる必要がある作業の優先度。 たとえば、SRの優先度は重大度に基づいて計算できます。
    • ProdGroupId; integer; 作業オブジェクトに関連付けられた製品グループの一意の識別子。
    • ProductGroupName; string; 作業オブジェクトに関連付けられた製品グループの名前。
    • ProductItemDescription; string;作業オブジェクトに関連付けられた製品の説明。
    • ProductItemNumber; string;作業オブジェクトに関連付けられた製品の代替キー識別子。
    • QueueId; integer; 作業オブジェクトの割当て先のキューの識別子。
    • RealtimeFlag; boolean;チャネルがリアルタイムかどうかを示します。
    • ServiceZoneId; integer; 作業オブジェクトに関連付けられたサービス・リージョンの一意の識別子。
    • ServiceZoneName; string; 作業オブジェクトに関連付けられたサービス・リージョン名。
    • 重大度、文字列。割り当てる必要がある作業の重大度コード。
    • SocialChannelId; string; 作業オブジェクトに関連付けられたソーシャル・チャネル識別子。
    • SocialChannelName; string; 作業オブジェクトに関連付けられたソーシャル・チャネル名。
    • SocialChannelTypeCd; string; 作業オブジェクトに関連付けられたソーシャル・チャネル・タイプ。
    • StatusCd; string;作業オブジェクト割当てのステータス。
    • StripeCd; string; CRM、HCM、PRMなどのストライプ・コードを示す参照コード。
    • WoName; string;作業オブジェクトに関連付けられたオブジェクトのユーザー表示名。
    • WoTitle; string; 作業オブジェクトに関連付けられたオブジェクトのユーザー表示タイトル。
    • WoTypeName; string; 作業オブジェクトに関連付けられた作業のタイプのユーザー表示名。
    • WorkId; integer;ユニバーサル作業オブジェクトの一意の識別子。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

サポートされるメディア・タイプ

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : universalWorkObjects
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : universalWorkObjects-item-response
タイプ: object
ソースを表示
  • タイトル: Account Party ID
    作業オブジェクトに関連付けられたアカウント・パーティの一意の識別子。
  • タイトル: Account
    最大長: 900
    アカウントを識別する一意の名前。
  • タイトル: Assignee Resource ID
    この作業オブジェクトに割り当てられたリソースの識別子。
  • タイトル: Business Unit ID
    この作業オブジェクトに関連付けられたビジネス・ユニット組織の一意の識別子。 将来使用するために予約されています。
  • タイトル: Category ID
    作業リクエストに対するカテゴリの一意の識別子。
  • タイトル: Category Name
    読取り専用: true
    最大長: 255
    作業オブジェクトに関連付けられたカテゴリの名前。
  • タイトル: Channel ID
    作業オブジェクトに関連付けられたチャネルの一意の識別子。
  • タイトル: Channel
    最大長: 30
    チャネル・タイプを示すコード。 たとえば、電子メール、電話、ソーシャルなどです。 受け入れられる値のリストは、参照ORA_SVC_CHANNEL_TYPE_CDで定義されます。
  • タイトル: Contact Email Address
    最大長: 320
    チャネルから送信された担当者Eメール・アドレス。
  • タイトル: Contact First Name
    最大長: 150
    チャネルから送信された担当者の名。
  • タイトル: Contact Last Name
    最大長: 100
    チャネルから送信された担当者の姓。
  • タイトル: Contact Party ID
    作業オブジェクトに関連付けられた担当者パーティの一意の識別子。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    ユニバーサル作業オブジェクトを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    ユニバーサル作業オブジェクトが作成された日時。
  • 読取り専用: true
    デフォルト値: false
    ユニバーサル作業オブジェクトを削除できるかどうかを示します。
  • タイトル: Interaction ID
    この作業オブジェクトに関連付けられた顧客対応の一意の識別子。
  • タイトル: Inventory Item ID
    作業オブジェクトに関連付けられた製品の一意の識別子。
  • タイトル: Inventory Organization ID
    作業オブジェクトに関連付けられた製品の組織の一意の識別子。
  • タイトル: Language Code
    最大長: 30
    この作業オブジェクトの顧客優先言語を示す参照コード。
  • タイトル: Last Assignment Date
    このリクエストがエージェントに最後に提供された時間。
  • タイトル: Last Updated Date
    読取り専用: true
    ユニバーサル作業オブジェクトが最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    ユニバーサル作業オブジェクトを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    ユニバーサル作業オブジェクトを最後に更新したユーザーのログイン。
  • Links
  • タイトル: Object ID
    このリクエストに関連付けられたビジネス・オブジェクトまたはクライアント・チャネル・インスタンスIDの一意の識別子。
  • タイトル: Object Type
    最大長: 30
    ビジネス・オブジェクトのタイプ(設定されている場合)。 たとえば、SVC_SERVICE_REQUESTSです。
  • タイトル: Priority
    割り当てる必要がある作業の優先度。 たとえば、SRの優先度は重大度に基づいて計算できます。
  • タイトル: Product Group ID
    作業オブジェクトに関連付けられた製品グループの一意の識別子。
  • タイトル: Product Group
    最大長: 250
    作業オブジェクトに関連付けられた製品グループの名前。
  • タイトル: Product Description
    読取り専用: true
    最大長: 255
    作業オブジェクトに関連付けられた製品の説明。
  • タイトル: Product Number
    読取り専用: true
    最大長: 255
    作業オブジェクトに関連付けられた製品の代替キー識別子。
  • タイトル: Queue ID
    作業オブジェクトの割当て先であるキューの識別子。
  • タイトル: Real Time
    最大長: 1
    チャネルがリアルタイムかどうかを示します。
  • タイトル: Region ID
    作業オブジェクトに関連付けられたサービス・リージョンの一意の識別子。
  • タイトル: Service Region
    最大長: 360
    作業オブジェクトに関連付けられたサービス・リージョン名。
  • 最大長: 30
    割り当てる必要がある作業の重大度コード。
  • タイトル: Social Channel ID
    最大長: 400
    作業オブジェクトに関連付けられたソーシャル・チャネル識別子。
  • タイトル: Social Channel Name
    最大長: 400
    作業オブジェクトに関連付けられたソーシャル・チャネル名。
  • タイトル: Social Channel Type
    最大長: 30
    作業オブジェクトに関連付けられたソーシャル・チャネル・タイプ。
  • タイトル: Status Code
    最大長: 30
    作業オブジェクト割当のステータス。
  • タイトル: Stripe Code
    最大長: 30
    CRM、HCM、PRMなどのストライプ・コードを示す参照コード。
  • 読取り専用: true
    ユニバーサル作業オブジェクトを更新できるかどうかを示します。
  • タイトル: Reference ID
    最大長: 64
    作業オブジェクトに関連付けられたオブジェクトのユーザー表示名。
  • タイトル: Work ID
    読取り専用: true
    ユニバーサル作業オブジェクトの一意の識別子。
  • タイトル: Title
    最大長: 400
    作業オブジェクトに関連付けられたオブジェクトのユーザー表示タイトル。
  • タイトル: Work Object Type
    最大長: 30
    作業オブジェクトに関連付けられた作業タイプのユーザー表示名。
「トップに戻る」