機械翻訳について

ジャンプ先

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

すべての請求管理を取得

get

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

リクエスト

パス・パラメータ

• contractsUniqID(required): string
  これは、Contractsリソースの複合キーを構成し、Contractsのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、Contractsの特定のインスタンスに移動してハッシュ・キーを取得するために、Contractsコレクション・リソースを問い合せる必要があります。

問合せパラメータ

• dependency: string
  このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
  
  フォーマット: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
• fields: string
  このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
  
  フォーマット : ?fields=Attribute1,Attribute2
  
  子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  コレクションを検索するための事前定義済ファインダとして使用されます。
  
  フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  使用可能なファインダ名および対応するファインダ変数を次に示します:
  
  

  • BillingControlExtAltKey : 指定した請求管理外部代替キーを持つ請求制御明細を検索します。
    ファインダ変数:
    • ExternalReferenceKey; string.
    • ExternalSourceKey; string.
  • PrimaryKey : 指定した請求管理IDおよびメジャー・バージョンを持つ請求管理を検索します。
    ファインダ変数:
    • BillingControlId; integer;請求管理ID。
    • MajorVersion; integer;メジャー・バージョン。
• limit: integer
  このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
• links: string
  このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
  
  例:
  self,canonical
  
• offset: integer
  リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
• onlyData: boolean
  リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
• orderBy: string
  このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
• q: string
  この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY
  
  フォーマット : ?q=expression1;expression2
  
  次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
  

  • ActiveFlag; boolean。請求管理がアクティブかどうかを示します。
  • BillingControlId; integer; 請求管理の一意の識別子。
  • EndDate; string; 請求管理が終了する日付。
  • ExternalReferenceKey; string;外部ソース内の参照キー。
  • ExternalSourceKey; string; 請求管理の外部ソース・キー。
  • HardLimitAmount; number;請求管理のハード制限。
  • MajorVersion; integer; 請求管理の契約バージョン。
  • RbsElementId; integer; 請求管理が定義されているリソース・ブレークダウン・ストラクチャ要素の識別子。
  • SoftLimitAmount; number;請求管理の弱い制限値。
  • StartDate; string; 請求管理が開始する日付。
• totalResults: boolean
  "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。

ヘッダー・パラメータ

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

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

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

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

タイプ: object

ソースを表示

• count(required): integer
  現在の範囲で返されたリソース・インスタンスの数。
• hasMore(required): boolean
  サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。 値がtrueの場合、サーバーから取得するリソースがさらにあります。 デフォルト値はfalseです。
• items: array Items
  タイトル: Items

  コレクション内のアイテム。
• limit(required): integer
  サーバーで使用される実際のページング・サイズ。
• links(required): array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• offset(required): integer
  現在のページで使用されるオフセット値。
• totalResults: integer
  "?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/contracts-BillingControl-item-response"
            }
        }
    }
}

ネストされたスキーマ : アイテム

タイプ: array

タイトル: Items

コレクション内のアイテム。

ソースを表示

• Array of: object contracts-BillingControl-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/contracts-BillingControl-item-response"
    }
}

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

タイプ: array

タイトル: Links

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

ソースを表示

• Array of: object link

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

ネストされたスキーマ : 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."
        }
    }
}

「トップに戻る」