機械翻訳について

ジャンプ先

• リクエスト
• レスポンス

請求管理の更新

patch

/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/BillingControl/{BillingControlUniqID}

リクエスト

パス・パラメータ

• BillingControlUniqID(required): string
  これは、請求管理リソースのコンポジット・キー(BillingControlIdおよびMajorVersion)を構成する属性のハッシュ・キーで、請求管理のインスタンスを一意に識別するために使用されます。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、請求管理の特定のインスタンスに移動するために、主キー値に対するフィルタを使用して請求管理コレクション・リソースを問い合せる必要があります。
  
  次に例を示します: BillingControl?q=BillingControlId=<value1>;MajorVersion=<value2>
• contractsUniqID(required): string
  これは、Contractsリソースの複合キーを構成し、Contractsのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、Contractsの特定のインスタンスに移動してハッシュ・キーを取得するために、Contractsコレクション・リソースを問い合せる必要があります。

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

• application/json

リクエスト本文 - application/json ()

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

• ActiveFlag: boolean
  タイトル: Active

  最大長: 1

  デフォルト値: true

  請求管理がアクティブかどうかを示します。
• BillingControlId: integer (int64)
  請求管理の一意の識別子。
• BillingResource: string
  タイトル: Billing Resource

  請求管理が定義されているリソース・ブレークダウン・ストラクチャ要素。
• EndDate: 文字列(日付)
  タイトル: End Date

  請求管理が終了する日付。
• ExternalReferenceKey: string
  最大長: 150

  外部ソースの参照キー。
• ExternalSourceKey: string
  最大長: 150

  請求管理の外部ソース・キー。
• HardLimitAmount: number
  タイトル: Hard Limit

  請求管理のハード制限。
• MajorVersion: integer (int64)
  請求管理の契約バージョン。
• RbsElementId: integer (int64)
  タイトル: Billing Resource ID

  請求管理が定義されているリソース・ブレークダウン・ストラクチャ要素の識別子。
• SoftLimitAmount: number
  タイトル: Soft Limit

  請求管理のソフト制限。
• StartDate: 文字列(日付)
  タイトル: Start Date

  請求管理が開始する日付。

{
    "type":"object",
    "properties":{
        "MajorVersion":{
            "type":"integer",
            "description":"The contract version of the billing control.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the billing control starts.",
            "format":"date",
            "nullable":false
        },
        "ExternalReferenceKey":{
            "maxLength":150,
            "type":"string",
            "description":"The reference key in the external source.",
            "nullable":true
        },
        "ExternalSourceKey":{
            "maxLength":150,
            "type":"string",
            "description":"The external source key of the billing control.",
            "nullable":true
        },
        "BillingResource":{
            "title":"Billing Resource",
            "type":"string",
            "description":"The Resource Breakdown structure Element for which Billing control is defined.",
            "nullable":true,
            "x-queryable":false
        },
        "BillingControlId":{
            "type":"integer",
            "description":"The unique identifier of the billing control.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "HardLimitAmount":{
            "title":"Hard Limit",
            "type":"number",
            "description":"The hard limit for the billing control.",
            "nullable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the billing control ends.",
            "format":"date",
            "nullable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the billing control is active.",
            "nullable":true,
            "default":true
        },
        "RbsElementId":{
            "title":"Billing Resource ID",
            "type":"integer",
            "description":"The identifier of the Resource Breakdown structure Element for which Billing control is defined.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SoftLimitAmount":{
            "title":"Soft Limit",
            "type":"number",
            "description":"The soft limit for the billing control.",
            "nullable":true
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

• Metadata-Context(required):
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : contracts-BillingControl-item-response

タイプ: object

ソースを表示

• ActiveFlag: boolean
  タイトル: Active

  最大長: 1

  デフォルト値: true

  請求管理がアクティブかどうかを示します。
• BillingControlId: integer (int64)
  請求管理の一意の識別子。
• BillingResource: string
  タイトル: Billing Resource

  請求管理が定義されているリソース・ブレークダウン・ストラクチャ要素。
• EndDate: 文字列(日付)
  タイトル: End Date

  請求管理が終了する日付。
• ExternalReferenceKey: string
  最大長: 150

  外部ソースの参照キー。
• ExternalSourceKey: string
  最大長: 150

  請求管理の外部ソース・キー。
• HardLimitAmount: number
  タイトル: Hard Limit

  請求管理のハード制限。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• MajorVersion: integer (int64)
  請求管理の契約バージョン。
• RbsElementId: integer (int64)
  タイトル: Billing Resource ID

  請求管理が定義されているリソース・ブレークダウン・ストラクチャ要素の識別子。
• SoftLimitAmount: number
  タイトル: Soft Limit

  請求管理のソフト制限。
• StartDate: 文字列(日付)
  タイトル: Start Date

  請求管理が開始する日付。

{
    "type":"object",
    "properties":{
        "MajorVersion":{
            "type":"integer",
            "description":"The contract version of the billing control.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the billing control starts.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ExternalReferenceKey":{
            "maxLength":150,
            "type":"string",
            "description":"The reference key in the external source.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalSourceKey":{
            "maxLength":150,
            "type":"string",
            "description":"The external source key of the billing control.",
            "nullable":true,
            "x-queryable":true
        },
        "BillingResource":{
            "title":"Billing Resource",
            "type":"string",
            "description":"The Resource Breakdown structure Element for which Billing control is defined.",
            "nullable":true,
            "x-queryable":false
        },
        "BillingControlId":{
            "type":"integer",
            "description":"The unique identifier of the billing control.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "HardLimitAmount":{
            "title":"Hard Limit",
            "type":"number",
            "description":"The hard limit for the billing control.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the billing control ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the billing control is active.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "RbsElementId":{
            "title":"Billing Resource ID",
            "type":"integer",
            "description":"The identifier of the Resource Breakdown structure Element for which Billing control is defined.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SoftLimitAmount":{
            "title":"Soft Limit",
            "type":"number",
            "description":"The soft limit for the billing control.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

• href: string
  タイトル: hyperlink reference

  関連リソースへのURI。
• kind: string
  タイトル: kind

  許可された値: [ "collection", "item", "describe", "other" ]

  関連リソースの種類。
• name: string
  タイトル: name

  関連リソースへのリンクの名前。
• properties: object properties
• rel: string
  タイトル: relation

  許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  リソース・インスタンスとの関係の名前。 例: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

• changeIndicator: string
  リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

「トップに戻る」