機械翻訳について

すべての値セットの取得

get

<servername>/fscmRestApi/resources/11.13.18.05/valueSets

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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>

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

    • PrimaryKey
      ファインダ変数:
      • ValueSetId
    • ValueSetCodeFinder
      ファインダ変数:
      • ValueSetCode
  • このパラメータは、リソース・コレクションの内部で返されるリソース数を制限します。 制限がリソース数を超える場合、フレームワークは使用可能なリソースのみ返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • データのみを含めるために(リンク・セクションなしなど)、リソース・アイテム・ペイロードがフィルタ処理されます。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順には「asc」、降順には「desc」を指定します。 デフォルト値は「asc」です。 例:?orderBy=field1:asc,field2:desc
  • この問合せパラメータは、where句を定義します。 指定された式を使用してリソース・コレクションを問い合せます。 この問合せパラメータの値は1つ以上の式です。 例: ?q=Deptno>=10 and <= 30;Loc!=NY

    フォーマット: ?q=expression1;expression2
  • "?totalResults=true"の場合、リソース・コレクション表現には推定行数が含まれます。それ以外の場合、行数は含まれません。 デフォルト値は"false"です。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプは実行時に変わる可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーがAPIのデフォルト・バージョンを選択します。

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

トップに戻る

レスポンス

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

デフォルト・レスポンス

次の表に、このタスクのデフォルト・レスポンスを示します。
Headers
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプは実行時に変わる可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーがAPIのデフォルト・バージョンを選択します。
本文 ()
ルート・スキーマ : valueSets
すべてに一致
Show Source
ネストされたスキーマ : CollectionProperties
タイプ: object
Show Source
ネストされたスキーマ : valueSets-allOf[1]
タイプ: object
Show Source
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
Show Source
ネストされたスキーマ : valueSets-item-response
すべてに一致
Show Source
ネストされたスキーマ : ItemProperties
タイプ: object
Show Source
  • Links
ネストされたスキーマ : valueSets-item
タイプ: object
Show Source
  • 読取り専用: true
    最大長: 64
    値セットを作成したユーザー。
  • 読取り専用: true
    値セットが作成された日付。
  • タイトル: Data Security Resource Name
    最大長: 60
    この値セットの対応するデータ・セキュリティ・オブジェクトの名前。 値セットでセキュリティを有効にすると、データ・セキュリティ・オブジェクト名は既存の値セットまたは作成する値セットになります。
  • タイトル: Description
    最大長: 240
    値セットの説明。
  • タイトル: Value Set Code
    最大長: 60
    非依存の値セットの値セット・コード。
  • タイトル: Independent Value Set
    非依存の値セットの識別子。 独立値セットを使用して、ユーザー定義の有効値のセットを指定できます。
  • 読取り専用: true
    値セットの最終更新日。
  • 読取り専用: true
    最大長: 64
    値セットを最後に更新したユーザー。
  • タイトル: Maximum Length
    値セット値で使用できる最大文字数。
  • タイトル: Maximum Value
    最大長: 150
    値セットに使用できる最大文字値。
  • タイトル: Maximum Value
    値セットに許可される最大日付値。
  • タイトル: Maximum Value
    値セットに使用可能な最大数値。
  • タイトル: Maximum Value
    値セットに使用できる最大タイムスタンプ値。
  • タイトル: Minimum Value
    最大長: 150
    値セットに許可される最小文字値。
  • タイトル: Minimum Value
    値セットに許可される最小日付値。
  • タイトル: Minimum Value
    値セットに許可される最小数値。
  • タイトル: Minimum Value
    値セットに許可される最小タイムスタンプ値。
  • タイトル: Module
    最大長: 32
    製品ライン、製品ファミリ、アプリケーションまたは論理ビジネス・エリア・レベルのノードであるモジュールの識別子。
  • タイトル: Precision
    値セット値に許可される有効桁の最大数。
  • タイトル: Protected
    最大長: 1
    値セットが保護アジャニスト更新かどうかを示します。 保護としてマークされた値セットは編集または削除できません。
  • タイトル: Scale
    値セット値の小数点に続く最大桁数。
  • タイトル: Security enabled
    最大長: 1
    デフォルト値: N
    値セット値に対してデータ・セキュリティが使用可能かどうかを示します。 デフォルト値はfalseです。
  • タイトル: Uppercase only
    最大長: 1
    デフォルト値: N
    値セット値で大文字のみが許可されるかどうかを示します。 デフォルト値はfalseです。
  • タイトル: Validation Type
    最大長: 30
    検証タイプは、値セット値の検証方法を示します。 たとえば、依存、独立および書式検証タイプです。
  • タイトル: Value Data Type
    最大長: 30
    文字、数値、日付、日時などの値データ型。
  • タイトル: Value Set Code
    最大長: 60
    値セットの値セット・コード。 各値セットに対して、コードが値セットのコードであり、コンテキスト依存セグメントがその値セットの値に表示されるコンテキストを定義できます。
  • 読取り専用: true
    値セットの識別子。
  • タイトル: Value Subtype
    最大長: 30
    テキスト、翻訳済テキスト、数値のみ、時間(20:08)および時間(20:08:08)などの値サブタイプ。
  • タイトル: Zero fill
    最大長: 1
    デフォルト値: N
    値セット値が左側にゼロでパディングされるかどうかを示します。 デフォルト値はfalseです。
ネストされたスキーマ : valueSets-item-response-allOf[2]
タイプ: object
Show Source
ネストされたスキーマ : validationTable
タイプ: array
Show Source
ネストされたスキーマ : 値
タイプ: array
Show Source
ネストされたスキーマ : valueSets-validationTable-item-response
すべてに一致
Show Source
ネストされたスキーマ : valueSets-validationTable-item
タイプ: object
Show Source
ネストされたスキーマ : valueSets-values-item-response
すべてに一致
Show Source
ネストされたスキーマ : valueSets-values-item
タイプ: object
Show Source
「トップに戻る」