機械翻訳について

ジャンプ先

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

すべての通貨の取得

get

http://<servername>/fscmRestApi/resources/11.13.18.05/currenciesLOV

リクエスト

問合せパラメータ

• 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>
  
  使用可能なファインダ名および対応するファインダ変数を次に示します:
  
  

  • CurrencyCodeAllRowsFinder :すべての通貨を検索します。
    ファインダ変数:
    • CurrencyCode :指定された通貨の通貨コード。
  • CurrencyCodeFinder :指定した通貨コードに基づいて通貨を検索します。
    ファインダ変数:
    • ActiveDate :通貨の識別子としての有効日。
    • CurrencyCode :指定された通貨の通貨コード。
  • PrimaryKey :指定した主キーの通貨を検索します。
    ファインダ変数:
    • CurrencyCode :指定された通貨の通貨コード。
• 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=Deptno>=10 and <= 30;Loc!=NY
  
  フォーマット: ?q=expression1;expression2
• totalResults: boolean
  "?totalResults=true"の場合、リソース・コレクション表現には推定行数が含まれます。それ以外の場合、行数は含まれません。 デフォルト値は"false"です。

ヘッダー・パラメータ

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

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

トップに戻る

レスポンス

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

• application/json
• application/vnd.oracle.adf.resourcecollection+json

デフォルト・レスポンス

次の表に、このタスクのデフォルト・レスポンスを示します。

Headers

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

本文 ()

ルート・スキーマ : currenciesLOV

すべてに一致

Show Source

• object CollectionProperties
• object currenciesLOV-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CollectionProperties"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "title":"Items",
                    "type":"array",
                    "description":"The items in the collection.",
                    "items":{
                        "$ref":"#/components/schemas/currenciesLOV-item-response"
                    }
                }
            }
        }
    ],
    "x-hints":{
        "usage":"LOV"
    }
}

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

タイプ: object

Show Source

• count(required): integer
  現在の範囲内で返されるリソース・インスタンス数。
• hasMore(required): boolean
  レスポンスで返されたサブセットより多くのリソースをサーバーで使用できるかどうかを示します。 値がtrueの場合、サーバーから取得するリソースがさらにあります。 デフォルト値はfalseです。
• 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."
        },
        "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."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

ネストされたスキーマ : currenciesLOV-allOf[1]

タイプ: object

Show Source

• items: array Items
  タイトル: Items

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

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

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

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられているリンクの関係。

Show Source

• Array of: object link

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

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

タイプ: object

Show Source

• 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":{
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "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."
        },
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : プロパティ

タイプ: object

Show Source

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

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

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

タイプ: array

タイトル: Items

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

Show Source

• Array of: currenciesLOV-item-response

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

ネストされたスキーマ : currenciesLOV-item-response

すべてに一致

Show Source

• object ItemProperties

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ItemProperties"
        },
        {
            "$ref":"#/components/schemas/currenciesLOV-item"
        }
    ]
}

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

タイプ: object

Show Source

• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられているリンクの関係。

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

ネストされたスキーマ : 通貨値リストVO

タイプ: object

タイトル: Currency LOV VO

Show Source

• ActiveDate: string
  読取り専用: true

  デフォルト値: adf.currentDate

  特定の日付にアクティブな通貨。
• CurrencyCode: string
  タイトル: Currency Code

  最大長: 15

  通貨の識別に使用されるコードです。 通貨を使用可能にした後は、その通貨を後で使用不可にした場合でも、通貨コードを変更できません。
• CurrencyFlag: string
  タイトル: Type

  最大長: 1

  デフォルト値: Y

  通貨が統計ユニットか通貨かを示します。
• CurrencyFormat: string
  読取り専用: true

  記号またはコードのない通貨のJava書式マスク。
• CurrencyFormatWithCode: string
  読取り専用: true

  通貨コードを含む通貨のJava書式マスク
• CurrencyFormatWithSymbol: string
  読取り専用: true

  通貨記号を含む通貨のJava書式マスク。
• 摘要: string
  タイトル: Description

  最大長: 240

  通貨の説明。
• EnabledFlag: string
  タイトル: Enabled

  最大長: 1

  デフォルト値: Y

  通貨が有効かどうかを示します。 デフォルト値はtrueです。
• EndDateActive: 文字列(日付)
  タイトル: End Date

  通貨が廃止された日付。
• ExtendedPrecision: integer (int32)
  タイトル: Extended Precision

  デフォルト値: 5

  小数の右側の最大桁数です。
• IssuingTerritoryCode: string
  タイトル: Issuing Territory

  最大長: 2

  通貨を発行したテリトリのコード。
• 名前: string
  タイトル: Currency Name

  最大長: 80

  通貨の名前。
• 精度: integer (int32)
  タイトル: Precision

  デフォルト値: 2

  小数点の右の桁数。
• StartDateActive: 文字列(日付)
  タイトル: Start Date

  通貨が使用された日付。
• 記号: string
  タイトル: Symbol

  最大長: 12

  通貨を示す記号。

{
    "title":"Currency LOV VO",
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The code used to identify the currency. You can't change a currency code after you enable the currency, even if you later disable that currency.",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "Name":{
            "title":"Currency Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of the currency.",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the currency.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-properties":{
                    "DISPLAYWIDTH":"80"
                }
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the currency is enabled or not. The default value is true.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-controlType":"choice"
            }
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The date on which the currency came into use.",
            "format":"date",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-controlType":"date"
            }
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The date on which the currency became obsolete.",
            "format":"date",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-controlType":"date"
            }
        },
        "ActiveDate":{
            "type":"string",
            "description":"The currency active on a particular date.",
            "nullable":true,
            "readOnly":true,
            "default":"adf.currentDate",
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "CurrencyFormat":{
            "type":"string",
            "description":"A Java format mask for the currency with no symbol or code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "CurrencyFormatWithSymbol":{
            "type":"string",
            "description":"A Java format mask for the currency that includes the currency symbol.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "CurrencyFormatWithCode":{
            "type":"string",
            "description":"A Java format mask for the currency that includes the currency code",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "IssuingTerritoryCode":{
            "title":"Issuing Territory",
            "maxLength":2,
            "type":"string",
            "description":"The code of the territory that issued the currency.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-controlType":"choice",
                "adf-properties":{
                    "DISPLAYWIDTH":"30"
                }
            }
        },
        "Symbol":{
            "title":"Symbol",
            "maxLength":12,
            "type":"string",
            "description":"The symbol that denotes the currency.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "Precision":{
            "title":"Precision",
            "type":"integer",
            "description":"The number of digits to the right of the decimal point.",
            "format":"int32",
            "nullable":true,
            "default":2,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-precision":1
            }
        },
        "ExtendedPrecision":{
            "title":"Extended Precision",
            "type":"integer",
            "description":"The maximum number of digits to the right of the decimal point.",
            "format":"int32",
            "nullable":true,
            "default":5,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-precision":2
            }
        },
        "CurrencyFlag":{
            "title":"Type",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the currency is a statistical unit or a currency.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-controlType":"choice"
            }
        }
    },
    "x-hints":{
        "titlePlural":"Currencies LOVs"
    },
    "x-links":[
        {
            "rel":"self",
            "method":"get",
            "title":"self",
            "href":"/fscmRestApi/resources/11.13.18.05/currenciesLOV/{CurrencyCode}"
        },
        {
            "rel":"canonical",
            "method":"get",
            "title":"canonical",
            "href":"/fscmRestApi/resources/11.13.18.05/currenciesLOV/{CurrencyCode}"
        }
    ]
}

関係

canonical

メソッド: get

パス: /fscmRestApi/resources/11.13.18.05/currenciesLOV/{CurrencyCode}

self

メソッド: get

パス: /fscmRestApi/resources/11.13.18.05/currenciesLOV/{CurrencyCode}

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

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられているリンクの関係。

Show Source

• Array of: object link

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

「トップに戻る」