機械翻訳について

ジョブ・レート上書きの取得

get

/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/JobRateOverride

リクエスト

パス・パラメータ
  • これは、収益プラン・リソースに対する複合キー(BillPlanIdおよびMajorVersion)を構成する属性のハッシュ・キーで、収益プランのインスタンスを一意に識別するために使用されます。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、収益プランの特定のインスタンスにナビゲートするために、主キー値に対するフィルタを使用して収益プラン・コレクション・リソースを問い合せる必要があります。

    次に例を示します: RevenuePlan?q=BillPlanId=<value1>;MajorVersion=<value2>
  • これは、Contractsリソースの複合キーを構成し、Contractsのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、Contractsの特定のインスタンスに移動してハッシュ・キーを取得するために、Contractsコレクション・リソースを問い合せる必要があります。
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • この問合せパラメータは、指定した開始日時点で有効なリソースをフェッチするために使用されます。 この問合せパラメータの値は、yyyy-MM-dd形式の日付を持つ文字列です
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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>

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

    • JobRateOverrideExtAltKey : 指定された外部代替キーによるジョブ・レート上書きを検索します。
      ファインダ変数:
      • ExternalReferenceKey; string.
      • ExternalSourceKey; string.
    • PrimaryKey : 指定したジョブ・レート上書きIDおよびメジャー・バージョンでジョブ・レート上書きを検索します。
      ファインダ変数:
      • BillRateOverrideId; integer; ジョブ・レート・オーバーライドの一意の識別子。
      • MajorVersion; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • BillRateOverrideId; integer;請求レート上書きの一意の識別子。
    • BillRateUnitCode; string;請求レート・ユニット・コード。
    • ContractLineId; integer;請求レート上書きが適用される契約明細の一意の識別子。
    • ContractLineNumber;文字列;請求レート上書きが適用される契約明細番号。
    • DiscountPercentage; number;請求レートに適用される割引率。
    • EndDateActive; string;請求レート上書きが有効になるまでの日付。
    • ExternalReferenceKey; string;ソース・アプリケーションにおけるオーバーライドの一意の識別子。 外部webサービスを介して作成されたオーバーライドを識別するために使用されます。
    • ExternalSourceKey; string;オーバーライドが作成されるソース・アプリケーションの一意の識別子。 外部webサービスを介して作成されたオーバーライドを識別するために使用されます。
    • JobCode; string;請求レートが上書きされるジョブのコード。
    • JobId; integer;請求レートが上書きされるジョブの一意の識別子。
    • JobName; string;請求レートが上書きされるジョブの名前。
    • MajorVersion; integer;レコードの現在のバージョン。
    • レート;番号;品目の顧客に請求される金額。
    • RateCurrency; string;請求レート上書きの通貨。
    • RateCurrencyCode;文字列;請求レート上書きの通貨コード。
    • RateDiscReasonCode; string;割引を適用する理由コード。
    • RateDiscountReason; string;割引を適用する理由。
    • StartDateActive;文字列;請求レート上書きが有効になる日付。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • このヘッダーは文字列値を受け入れます。 この文字列は、セミコロンで区切られた=のリストです。 有効日範囲操作の実行に使用されます。 受け入れられるパラメータは、RangeMode、RangeSpan、RangeStartDate、RangeEndDate、RangeStartSequenceおよびRangeEndSequenceです。 パラメータ値は常に文字列です。 RangeModeに指定できる値は、SET_LOGICAL_START、SET_LOGICAL_END、END_DATE、SET_EFFECTIVE_START、SET_EFFECTIVE_END、REPLACE_CORRECTION、REPLACE_UPDATE、RECONCILE_CORRECTION、CORRECTION、RECONCILE_UPDATE、UPDATE、ZAPおよびDELETE_CHANGESです。 RangeSpanに指定できる値は、PHYSICAL_ROW_END_DATEおよびLOGICAL_ROW_END_DATEです。 RangeStartDateおよびRangeEndDateの値は、yyyy-MM-dd形式の日付の文字列表現である必要があります。 RangeStartSequenceおよびRangeEndSequenceの値は、解析時に正の整数が生成されるように文字列である必要があります。
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : contracts-RevenuePlan-JobRateOverride
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : contracts-RevenuePlan-JobRateOverride-item-response
タイプ: object
ソースを表示
  • タイトル: Job Rate Override ID
    請求レート上書きの一意識別子です。
  • タイトル: Unit of Measure
    読取り専用: true
    最大長: 30
    デフォルト値: HOURS
    請求レート・ユニット・コード。
  • タイトル: Contract Line ID
    請求レート上書きが適用される契約明細の一意識別子です。
  • タイトル: Contract Line Number
    最大長: 150
    請求レート上書きが適用される契約明細番号。
  • タイトル: Discount Percentage
    請求レートに適用された割引率。
  • タイトル: End Date
    請求レート上書きが有効になる日付。
  • タイトル: External Reference Key
    最大長: 150
    ソース・アプリケーションでの上書きの一意の識別子。 外部webサービスを介して作成されたオーバーライドを識別するために使用されます。
  • タイトル: External Source Key
    最大長: 150
    オーバーライドが作成されるソース・アプリケーションの一意の識別子。 外部webサービスを介して作成されたオーバーライドを識別するために使用されます。
  • タイトル: Job Code
    請求レートが上書きされるジョブのコード。
  • タイトル: Job ID
    請求レートが上書きされるジョブの一意識別子です。
  • タイトル: Job
    最大長: 240
    請求レートが上書きされるジョブの名前。
  • Links
  • タイトル: Version
    デフォルト値: 1
    レコードの現在のバージョン。
  • タイトル: Rate
    品目の顧客に請求される金額。
  • タイトル: Currency
    最大長: 80
    請求レート上書きの通貨。
  • タイトル: Currency Code
    最大長: 30
    請求レート上書きの通貨コード。
  • タイトル: Discount Reason
    最大長: 80
    割引を適用する事由です。
  • タイトル: Discount Reason
    最大長: 30
    割引を適用する事由コード。
  • タイトル: Start Date
    請求レート上書きが有効になる日付です。
「トップに戻る」