機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 値リスト
  4. 区分コード

すべての分類コードの取得

get

/crmRestApi/resources/11.13.18.05/classCodes

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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>

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

    • ChildClassCategoryCodeFinder : 指定された親分類コードの子分類コードのリストを検索します。
      ファインダ変数:
      • BindParentPkOne; string;指定した親分類カテゴリを持つクラス・コードを検索します。
      • BindParentPkThree; string;親ビュー・アプリケーションの一意の識別子。
      • BindParentPkTwo; string;指定された親分類コードを持つクラス・コードを検索します。
      • BindParentTreeNodeId; string;親ツリー・ノードの一意の識別子。
      • BindTreeCode; string;指定された親ツリー・コードを持つクラス・コードを検索します。
      • BindTreeVersionId; string;親ツリー・バージョンの一意の識別子。
    • ClassCategoryCodeFinder : 指定された分類コードを持つ分類コードを検索します。
      ファインダ変数:
      • BindClassCategory; string;クラス・カテゴリ・コードを含む分類コードを検索します。
      • BindClassCode; string;クラス・コードを含む分類コードを検索します。
    • ClassCategoryFinder : 指定された分類カテゴリの分類コードを検索します。
      ファインダ変数:
      • BindClassCategory; string;指定された分類カテゴリの分類コードを検索します。
    • PrimaryKey : 指定した主キーを持つ分類コードを検索します。
      ファインダ変数:
      • TreeCode; string;指定した主キーを持つツリー・コードを検索します。
      • TreeNodeId; string;ツリー・ノードの一意の識別子。
      • TreeStructureCode; string;指定した主キーを持つツリー構造コードを検索します。
      • TreeVersionId; string;ツリー・バージョンの一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • ChildCount; integer;親の子の数。
    • ClassCategory; string;クラス・カテゴリ。
    • ClassCategoryDescription; string;クラス・カテゴリの説明。
    • ClassCategoryGroup; string;クラス・カテゴリ・グループ。
    • ClassCode; string;クラス・コード。
    • ClassCodeDescription; string;クラス・コードの説明。
    • ClassCodeMeaning; string; クラス・コードの意味。
    • CreatedBy; string; 行を作成したユーザー。
    • CreationDate; string; 行が作成された日時。
    • DataSourceId; string;データ・ソースの一意の識別子。
    • 奥行き;整数;階層ツリーの深さレベル。
    • LastUpdateDate; string; 行が最後に更新された日時。
    • LastUpdateLogin; string; 行を最後に更新したユーザーのログイン詳細。
    • LastUpdatedBy; string; 行を最後に更新したユーザー。
    • LookupType; string;コードの参照タイプ。
    • 内容;文字列;クラス・カテゴリの意味。
    • ParentDataSourceId; string;親データ・ソースの一意の識別子。
    • ParentPk1Value; string;親クラスのカテゴリ。
    • ParentPk2Value; string;親クラス・コード。
    • ParentPk3Value; string;親ビュー・アプリケーションの結合解除識別子。
    • ParentPk4Value; string; Not Applicable。
    • ParentPk5Value; string; Not Applicable。
    • ParentTreeLabelId; string; Not Applicable。
    • ParentTreeNodeId; string;親ツリー・ノードの一意の識別子。
    • Pk1EndValue; string; Not Applicable。
    • Pk1StartValue; string;クラス・カテゴリ。
    • Pk2EndValue; string; Not Applicable。
    • Pk2StartValue; string;クラス・コード。
    • Pk3EndValue; string; Not Applicable。
    • Pk3StartValue; string; ビュー・アプリケーションの一意の識別子。
    • Pk4EndValue; string; Not Applicable。
    • Pk4StartValue; string; Not Applicable。
    • Pk5EndValue; string; Not Applicable。
    • Pk5StartValue; string; Not Applicable。
    • ReferenceTreeCode; string; Not Applicable。
    • ReferenceTreeVersionId; string; Not Applicable。
    • SortOrder; integer;ソート順序。
    • TreeCode; string;ツリー・コード。
    • TreeLabelId; string; Not Applicable。
    • TreeNodeId; string;ツリー・ノードの一意の識別子。
    • TreeStructureCode; string;ツリー・コードの構造。
    • TreeVersionId; string;ツリー・バージョンの一意の識別子。
    • 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のデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : classCodes
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : classCodes-item-response
タイプ: object
ソースを表示
「トップに戻る」