機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 値リスト
  4. アクティビティ機能

すべてのアクティビティ機能の取得

get

/crmRestApi/resources/11.13.18.05/activityFunctionLookups

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

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

    • PrimaryKey指定した主キー基準に一致するアクティビティ関数を検索します。
      ファインダ変数
      • LookupCode; string; アクティビティ関数の一意のコード。
      • LookupType; string; アクティビティ関数コードの参照タイプ。
      • SetId; integer; アクティビティ関数コードのセットID。
      • ViewApplicationId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • EnabledFlag; boolean;アクティビティ関数がアクティブかどうかを示します。
    • LookupCode; string;アクティビティ関数の一意のコード。
    • LookupType; string; アクティビティ関数参照の参照タイプ。
    • 内容;文字列;アクティビティ関数参照の表示値。
    • SetId; integer;セットの一意の識別子。
    • タグ、文字列、アクティビティ関数の説明と分類。
    • ViewApplicationId; integer; アクティビティ関数参照のビュー・アプリケーションの一意の識別子。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : activityFunctionLookups
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : activityFunctionLookups-item-response
タイプ: object
ソースを表示
  • Activity Type Lookups
    タイトル: Activity Type Lookups
    アクティビティ・タイプ参照リソースは、アクティビティ機能のアクティビティ・タイプを表示するために使用されます。 アクティビティ・タイプは、アクティビティ機能をさらに定義するために使用されます。
  • タイトル: Enabled
    最大長: 1
    デフォルト値: true
    アクティビティ機能がアクティブかどうかを示します。
  • Links
  • タイトル: Lookup Code
    最大長: 30
    アクティビティ機能の一意のコード。
  • タイトル: Lookup Type
    最大長: 30
    アクティビティ機能参照の参照タイプ。
  • タイトル: Meaning
    最大長: 80
    アクティビティ機能参照の表示値。
  • タイトル: Reference Data Set
    読取り専用: true
    デフォルト値: 0
    セットの一意の識別子。
  • タイトル: Tag
    最大長: 150
    アクティビティ機能の説明および分類。
  • 読取り専用: true
    デフォルト値: 0
    アクティビティ機能参照の表示アプリケーションの一意の識別子。
ネストされたスキーマ : アクティビティ・タイプ参照
タイプ: array
タイトル: Activity Type Lookups
アクティビティ・タイプ参照リソースは、アクティビティ機能のアクティビティ・タイプを表示するために使用されます。 アクティビティ・タイプは、アクティビティ機能をさらに定義するために使用されます。
ソースを表示
ネストされたスキーマ : activityFunctionLookups-activityTypeLookup-item-response
タイプ: object
ソースを表示
  • Activity Subtypes
    タイトル: Activity Subtypes
    アクティビティ・サブタイプ参照リソースは、アクティビティ・タイプおよびアクティビティ機能のアクティビティ・サブタイプを表示するために使用されます。 アクティビティ・サブタイプは、アクティビティを追跡するための追加の詳細を提供します。
  • 最大長: 255
    アクティビティのタイプまたはカテゴリを示すコード。
  • タイトル: Display Sequence
    アプリケーション参照のアクティビティ・タイプの表示順序を示す番号。
  • タイトル: Enabled
    最大長: 1
    デフォルト値: true
    アクティビティ・タイプが使用可能かどうかを示します。
  • タイトル: End Date
    アクティビティ・タイプがアクティブである最終日。
  • Links
  • タイトル: Lookup Code
    最大長: 30
    アクティビティ・タイプの一意のコード。
  • 最大長: 255
    アクティビティ・タイプがアクティブかどうかを示します。
  • タイトル: Lookup Type
    最大長: 30
    アクティビティ・タイプ参照の参照タイプ。
  • タイトル: Meaning
    最大長: 80
    アクティビティ・タイプ参照の表示値。
  • タイトル: Reference Data Set
    読取り専用: true
    デフォルト値: 0
    アクティビティ・タイプ参照の一意の識別子。
  • タイトル: Start Date
    アクティビティ・タイプがアクティブである日付。
  • タイトル: Tag
    最大長: 150
    摘要および分類アクティビティ・タイプ。
  • 読取り専用: true
    デフォルト値: 0
    アクティビティ・タイプ参照の表示アプリケーションの一意の識別子。
ネストされたスキーマ : アクティビティ・サブタイプ
タイプ: array
タイトル: Activity Subtypes
アクティビティ・サブタイプ参照リソースは、アクティビティ・タイプおよびアクティビティ機能のアクティビティ・サブタイプを表示するために使用されます。 アクティビティ・サブタイプは、アクティビティを追跡するための追加の詳細を提供します。
ソースを表示
ネストされたスキーマ : activityFunctionLookups-activityTypeLookup-activitySubtypeLookup-item-response
タイプ: object
ソースを表示
「トップに戻る」