すべての値セットの取得
get
<servername>/fscmRestApi/resources/11.13.18.05/valueSets
リクエスト
問合せパラメータ
- 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>
使用可能なファインダ名および対応するファインダ変数を次に示します:- PrimaryKey
ファインダ変数:- ValueSetId
- ValueSetCodeFinder
ファインダ変数:- ValueSetCode
- PrimaryKey
- 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のデフォルト・バージョンを選択します。
ネストされたスキーマ : CollectionProperties
タイプ:
Show Source
object
-
count(required): integer
現在の範囲内で返されるリソース・インスタンス数。
-
hasMore(required): boolean
レスポンスで返されたサブセットより多くのリソースをサーバーで使用できるかどうかを示します。 値がtrueの場合、サーバーから取得するリソースがさらにあります。 デフォルト値はfalseです。
-
limit(required): integer
サーバーで使用される実際のページング・サイズ。
-
links(required): array Links
タイトル:
Links
リソース・インスタンスに関連付けられているリンクの関係。 -
offset(required): integer
現在のページで使用されるオフセット値。
-
totalResults: integer
"?totalResults=true"の場合、推定行数は含まれません。
ネストされたスキーマ : valueSets-allOf[1]
タイプ:
Show Source
object
-
items: array Items
タイトル:
Items
コレクション内のアイテム。
ネストされたスキーマ : リンク
タイプ:
Show Source
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.
ネストされたスキーマ : ItemProperties
タイプ:
Show Source
object
-
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられているリンクの関係。
ネストされたスキーマ : valueSets-item
タイプ:
Show Source
object
-
CreatedBy: string
読取り専用:
true
最大長:64
値セットを作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
値セットが作成された日付。 -
DataSecurityObjectName: string
タイトル:
Data Security Resource Name
最大長:60
この値セットの対応するデータ・セキュリティ・オブジェクトの名前。 値セットでセキュリティを有効にすると、データ・セキュリティ・オブジェクト名は既存の値セットまたは作成する値セットになります。 -
摘要: string
タイトル:
Description
最大長:240
値セットの説明。 -
IndependentValueSetCode: string
タイトル:
Value Set Code
最大長:60
非依存の値セットの値セット・コード。 -
IndependentValueSetId: 整数(int64)
タイトル:
Independent Value Set
非依存の値セットの識別子。 独立値セットを使用して、ユーザー定義の有効値のセットを指定できます。 -
LastUpdateDate: string (date-time)
読取り専用:
true
値セットの最終更新日。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
値セットを最後に更新したユーザー。 -
MaximumLength: integer (int32)
タイトル:
Maximum Length
値セット値で使用できる最大文字数。 -
MaximumValue: string
タイトル:
Maximum Value
最大長:150
値セットに使用できる最大文字値。 -
MaximumValueDate: 文字列(日付)
タイトル:
Maximum Value
値セットに許可される最大日付値。 -
MaximumValueNumber: 電話番号
タイトル:
Maximum Value
値セットに使用可能な最大数値。 -
MaximumValueTimestamp: string (date-time)
タイトル:
Maximum Value
値セットに使用できる最大タイムスタンプ値。 -
MinimumValue: string
タイトル:
Minimum Value
最大長:150
値セットに許可される最小文字値。 -
MinimumValueDate: 文字列(日付)
タイトル:
Minimum Value
値セットに許可される最小日付値。 -
MinimumValueNumber: 電話番号
タイトル:
Minimum Value
値セットに許可される最小数値。 -
MinimumValueTimestamp: string (date-time)
タイトル:
Minimum Value
値セットに許可される最小タイムスタンプ値。 -
ModuleId: string
タイトル:
Module
最大長:32
製品ライン、製品ファミリ、アプリケーションまたは論理ビジネス・エリア・レベルのノードであるモジュールの識別子。 -
精度: integer (int32)
タイトル:
Precision
値セット値に許可される有効桁の最大数。 -
ProtectedFlag: string
タイトル:
Protected
最大長:1
値セットが保護アジャニスト更新かどうかを示します。 保護としてマークされた値セットは編集または削除できません。 -
スケール: integer (int32)
タイトル:
Scale
値セット値の小数点に続く最大桁数。 -
SecurityEnabledFlag: string
タイトル:
Security enabled
最大長:1
デフォルト値:N
値セット値に対してデータ・セキュリティが使用可能かどうかを示します。 デフォルト値はfalseです。 -
UppercaseOnlyFlag: string
タイトル:
Uppercase only
最大長:1
デフォルト値:N
値セット値で大文字のみが許可されるかどうかを示します。 デフォルト値はfalseです。 -
ValidationType: string
タイトル:
Validation Type
最大長:30
検証タイプは、値セット値の検証方法を示します。 たとえば、依存、独立および書式検証タイプです。 -
ValueDataType: string
タイトル:
Value Data Type
最大長:30
文字、数値、日付、日時などの値データ型。 -
ValueSetCode: string
タイトル:
Value Set Code
最大長:60
値セットの値セット・コード。 各値セットに対して、コードが値セットのコードであり、コンテキスト依存セグメントがその値セットの値に表示されるコンテキストを定義できます。 -
ValueSetId: 整数(int64)
読取り専用:
true
値セットの識別子。 -
ValueSubtype: string
タイトル:
Value Subtype
最大長:30
テキスト、翻訳済テキスト、数値のみ、時間(20:08)および時間(20:08:08)などの値サブタイプ。 -
ZeroFillFlag: string
タイトル:
Zero fill
最大長:1
デフォルト値:N
値セット値が左側にゼロでパディングされるかどうかを示します。 デフォルト値はfalseです。
- IndependentValueSetCodeLOV
-
メソッド: getパス:
/fndSetupApi/resources/11.13.18.05/valueSets/{valueSets_Id}/lov/IndependentValueSetCodeLOV
ネストされたスキーマ : valueSets-validationTable-item
タイプ:
Show Source
object
-
CreatedBy: string
読取り専用:
true
最大長:64
値セット検証表を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
値セット検証表が作成された日付。 -
DescriptionColumnLength: integer (int32)
タイトル:
Description Column Length
読取り専用:true
説明列の長さ。 -
DescriptionColumnName: string
タイトル:
Description Column Name
最大長:240
値セット値の説明を保持する列名。 -
DescriptionColumnType: string
タイトル:
Description Column Type
読取り専用:true
最大長:30
説明列のデータ型。 -
EnabledFlagColumnName: string
タイトル:
Enabled Flag Column Name
最大長:240
値セット値の有効フラグを保持する列名。 -
EndDateColumnName: string
タイトル:
End Date Column Name
最大長:240
値セット値の終了日を保持する列名。 -
FromClause: string
タイトル:
FROM Clause
最大長:240
値セットのベースとなるデータベース表またはビューを識別するSQL FROM句。 -
IdColumnLength: integer (int32)
タイトル:
ID Column Length
読取り専用:true
識別子列の長さ。 -
IdColumnName: string
タイトル:
ID Column Name
最大長:240
値セット値の識別子を保持する列名。 -
IdColumnType: string
タイトル:
ID Column Type
読取り専用:true
最大長:30
識別子列のデータ型。 -
LastUpdateDate: string (date-time)
読取り専用:
true
値セット検証表が最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
値セット検証表を最後に更新したユーザー。 -
OrderByClause: string
タイトル:
ORDER BY Clause
最大長:4000
値リストの値セット値の順序を無視するSQL ORDER BY句。 -
StartDateColumnName: string
タイトル:
Start Date Column Name
最大長:240
値セット値の開始日を保持する列名。 -
ValueAttributesTableAlias: string
タイトル:
Value Attributes Table Alias
最大長:30
キー・フレックスフィールド値属性値を保持する表またはビューのSQL別名。 -
ValueColumnLength: integer (int32)
タイトル:
Value Column Length
読取り専用:true
値列の長さ。 -
ValueColumnName: string
タイトル:
Value Column Name
最大長:240
値セット値を保持する列名。 -
ValueColumnType: string
タイトル:
Value Column Type
読取り専用:true
最大長:30
値列のデータ型。 -
ValueSetId: 整数(int64)
読取り専用:
true
親値セットの識別子。 -
WhereClause: string
タイトル:
WHERE Clause
最大長:4000
FROM句の表またはビューの行をフィルタ処理するSQL WHERE句。
ネストされたスキーマ : valueSets-values-item
タイプ:
Show Source
object
-
AccountType: string
最大長:
30
勘定科目セグメント値の勘定科目タイプを識別します。 -
ControlAccount: string
最大長:
30
サード・パーティ管理勘定科目を識別します。 -
CreatedBy: string
読取り専用:
true
最大長:64
値を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
値が作成された日付。 -
摘要: string
タイトル:
Description
最大長:240
値の説明。 -
DetailBudgetingAllowed: string
最大長:
30
予算入力が特定のセグメント値に対して許可されるかどうかを指定します。 -
DetailPostingAllowed: string
最大長:
30
指定されたセグメント値に対する転記が許可されるかどうかを指定します。 -
EnabledFlag: string
タイトル:
Enabled
最大長:1
デフォルト値:Y
値が現在使用可能になっているかどうかを示します。 デフォルト値はtrueです。 -
EndDateActive: 文字列(日付)
タイトル:
End Date
値を使用できる終了日。 -
FinancialCategory: string
最大長:
30
値の財務カテゴリ。 -
IndependentValue: string
タイトル:
Independent Value
最大長:150
非依存文字値。 -
IndependentValueDate: 文字列(日付)
タイトル:
Independent Value
非依存の日付値。 -
IndependentValueNumber: 電話番号
タイトル:
Independent Value
非依存の数値。 -
IndependentValueTimestamp: string (date-time)
タイトル:
Independent Value
非依存のタイムスタンプ値。 -
LastUpdateDate: string (date-time)
読取り専用:
true
値が最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
値を最後に更新したユーザー。 -
ReconciliationFlag: string
最大長:
30
突合せが使用可能かどうかを示します。 -
SortOrder: 整数(int64)
タイトル:
Sort Order
値リスト内で値が表示される順序を示す数値。 -
StartDateActive: 文字列(日付)
タイトル:
Start Date
値が使用可能な日付。 -
SummaryFlag: string
最大長:
30
要約を示します。 -
TranslatedValue: string
タイトル:
Translated Value
最大長:150
変換済の値。 -
値: string
タイトル:
Value
最大長:150
文字値です。 -
ValueDate: 文字列(日付)
タイトル:
Value
日付値。 -
ValueId: 整数(int64)
タイトル:
Value ID
読取り専用:true
値セット値の識別子。 -
ValueNumber: 電話番号
タイトル:
Value
数値。 -
ValueTimestamp: string (date-time)
タイトル:
Value
タイムスタンプ値。