機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. インセンティブ報酬クレジット詳細

すべてのクレジット詳細の取得

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationCreditDetails

リクエスト

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

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

    • CreditErrorsByEventDateRangeRowFinder: クレジット受領者に対して指定された日付範囲で、エラー・ステータスのクレジット詳細を検索します。
      ファインダ変数:
      • bEndDate; string;期間の終了日。
      • bStartDate; string;期間の開始日。
    • CreditsByTransactionTypeDateRangeRowFinder: 指定した日付範囲、トランザクション・タイプおよびクレジット受領者を含むすべてのクレジット詳細を検索します。
      ファインダ変数:
      • bEndDate; string;期間の終了日。
      • bStartDate; string;期間の開始日。
      • bTransactionType; string;トランザクションのタイプ。 この値は、オーダー、請求書、クレジット・メモなど、トランザクションのソースを示します。 設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、参照タイプCN_TP_TRANSACTION_TYPEの使用可能な参照コードをレビューします。
    • DirectCreditsByEventDateRangeRowFinder: クレジット受領者に指定された日付範囲の直接成功クレジット詳細を検索します。
      ファインダ変数:
      • bEndDate; string;期間の終了日。
      • bStartDate; string;期間の開始日。
    • EventDateRangeRowFinder: クレジット受領者に指定された日付範囲のすべてのクレジット詳細を検索します。
      ファインダ変数:
      • bEndDate; string;期間の終了日。
      • bStartDate; string;期間の開始日。
    • IndirectCreditsByEventDateRangeRowFinder: クレジット受領者に対して指定した日付範囲の間接成功クレジット詳細を検索します。
      ファインダ変数:
      • bEndDate; string;期間の終了日。
      • bStartDate; string;期間の開始日。
    • PrimaryKey : 指定したレコード識別子でクレジット詳細を検索します。
      ファインダ変数:
      • CreditId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • CreditAmount; number;機能通貨での貸方金額。
    • CreditDate; string;直接クレジット受領者が識別される日付。
    • CreditId; integer;クレジット詳細の一意の識別子。
    • CreditObjectStatusCode; string; クレジットのステータスを示します。 設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、参照タイプCN_TP_CREDIT_OBJECT_STATUSの使用可能な参照コードをレビューします。
    • CreditParticipantId; integer;クレジットを受け取ったインセンティブ報酬関係者の一意の識別子。
    • CreditReceiver; string;クレジットを受け取ったインセンティブ報酬参加者の名前。
    • CreditStatus; string;「設定およびメンテナンス」、「インセンティブ報酬参照の管理」タスクを使用して、参照タイプCN_TP_CREDIT_OBJECT_STATUSの使用可能な意味をレビューします。
    • CreditType; string;直接、間接、要約など、クレジットの性質を示します。
    • CreditTypeCode; string;クレジット・タイプ・コード。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、参照タイプCN_TP_CREDIT_TYPEの使用可能な意味をレビューします。
    • SourceEventDate; string;ソース・イベント日を示します。
    • TransactionAmount; number;機能通貨でのトランザクション金額。
    • TransactionId; integer;トランザクションの一意の識別子。 クレジットが生成されるベース・トランザクションを指し示します。
    • TransactionNumber; string; インセンティブ・クレジットが発生したトランザクション番号。
    • TransactionType; string;トランザクションのタイプ。 この値は、オーダー、請求書、クレジット・メモなど、トランザクションのソースを示します。 設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、参照タイプCN_TP_TRANSACTION_TYPEの使用可能な参照コードをレビューします。
    • TransactionTypeCode; string;トランザクション・タイプ・コード。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、参照タイプCN_TP_TRANSACTION_TYPEの使用可能な意味をレビューします。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : incentiveCompensationCreditDetails
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : incentiveCompensationCreditDetails-item-response
タイプ: object
ソースを表示
  • 読取り専用: true
    機能通貨での貸方金額。
  • 読取り専用: true
    直接クレジット受領者が識別される日付。
  • 読取り専用: true
    与信詳細の一意の識別子。
  • 読取り専用: true
    最大長: 30
    クレジットのステータスを示します。 設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、参照タイプCN_TP_CREDIT_OBJECT_STATUSの使用可能な参照コードをレビューします。
  • 読取り専用: true
    クレジットを受け取ったインセンティブ報酬関係者の一意の識別子。
  • 読取り専用: true
    最大長: 360
    クレジットを受け取ったインセンティブ報酬参加者の名前。
  • 読取り専用: true
    最大長: 80
    設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、参照タイプCN_TP_CREDIT_OBJECT_STATUSの使用可能な意味をレビューします。
  • 読取り専用: true
    最大長: 80
    直接、間接、要約など、クレジットの性質を示します。
  • 読取り専用: true
    最大長: 30
    クレジット・タイプ・コード。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、参照タイプCN_TP_CREDIT_TYPEの使用可能な意味をレビューします。
  • Links
  • 読取り専用: true
    ソース・イベント日を示します。
  • 読取り専用: true
    機能通貨でのトランザクション金額。
  • 読取り専用: true
    トランザクションの一意の識別子。 クレジットが生成されるベース・トランザクションを指し示します。
  • 読取り専用: true
    最大長: 30
    インセンティブ・クレジットの結果となったトランザクション番号。
  • 読取り専用: true
    最大長: 80
    トランザクションのタイプ。 この値は、オーダー、請求書、クレジット・メモなど、トランザクションのソースを示します。 設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、参照タイプCN_TP_TRANSACTION_TYPEの使用可能な参照コードをレビューします。
  • 読取り専用: true
    最大長: 30
    トランザクション・タイプ・コード。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、参照タイプCN_TP_TRANSACTION_TYPEの使用可能な意味をレビューします。
「トップに戻る」