機械翻訳について

すべてのサプライヤの取得

get

/fscmRestApi/resources/11.13.18.05/suppliersLOV

リクエスト

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

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

    • FindByBillToBU : 請求に使用可能なビジネス・ユニットに従ってサプライヤを検索します。
      ファインダ変数:
      • BillToBuId; integer; 請求先ビジネス・ユニットを一意に識別する値。
      • bindSysDate; string; システム日付を一意に識別する値です。
    • PrimaryKey : 主キーに従ってサプライヤを検索します。
      ファインダ変数:
      • SupplierId; integer; サプライヤを一意に識別する値。
    • PrimaryKeyFinder : 主キーに従ってサプライヤを検索します。
      ファインダ変数:
      • SupplierId; integer; サプライヤを一意に識別する値。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

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

    フォーマット : ?q=expression1;expression2

    次の問合せ可能な属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • AlternateName; string; サプライヤの代替名。
    • BusinessRelationshipCode; string; 企業とサプライヤ間のビジネス関係を識別する略称。 受け入れられる値のリストは、参照タイプORA_POZ_BUSINESS_RELATIONSHIPで定義されます。 設定およびメンテナンス作業領域および標準参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
    • DUNSNumber; string; サプライヤ・ビジネスを識別するData Universal Numbering System (DUNS)。
    • RegistryId; string; サプライヤ関係でパーティを一意に識別する値。
    • Status; string; サプライヤのステータス。 値はACTIVEまたはINACTIVEです。
    • SupplierId; integer; サプライヤを一意に識別する値。
    • SupplierName; string; サプライヤの名前。
    • SupplierNumber; string; サプライヤを識別する番号。
    • SupplierPartyId; integer; サプライヤ・パーティを一意に識別する値。
    • TaxRegistrationNumber; string; 欧州連合内の国など、一部の国が使用する付加価値税を識別する数値。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

レスポンス

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文 ()
ルート・スキーマ : suppliersLOV
タイプ: object
ソースを表示
ネストされたスキーマ : 品目
タイプ: array
タイトル: Items
コレクション内の品目。
ソースを表示
ネストされたスキーマ : suppliersLOV-item-response
タイプ: object
ソースを表示
  • タイトル: Alternate Name
    読取り専用: true
    最大長: 360
    サプライヤのカナです。
  • タイトル: Business Relationship
    読取り専用: true
    最大長: 30
    企業とサプライヤの間のビジネス関係を識別する略称です。 受け入れられる値のリストは、参照タイプORA_POZ_BUSINESS_RELATIONSHIPで定義されます。 設定およびメンテナンス作業領域および標準参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
  • タイトル: D-U-N-S Number
    読取り専用: true
    最大長: 30
    サプライヤ・ビジネスを識別するデータ・ユニバーサル番号システム(DUNS)。
  • Links
  • タイトル: Registry ID
    読取り専用: true
    最大長: 30
    サプライヤ関係のパーティを一意に識別する値。
  • Supplier Sites List of Values
    タイトル: Supplier Sites List of Values
    サプライヤ・サイト値リスト・リソースは、サプライヤ・サイトを検索します。
  • 読取り専用: true
    サプライヤのステータスです。 値はACTIVEまたはINACTIVEです。
  • 読取り専用: true
    サプライヤを一意に識別する値。
  • タイトル: Supplier
    読取り専用: true
    最大長: 360
    サプライヤの名前。
  • タイトル: Supplier Number
    読取り専用: true
    最大長: 30
    サプライヤを識別する番号。
  • 読取り専用: true
    サプライヤ・パーティを一意に識別する値。
  • タイトル: Registration Number
    読取り専用: true
    最大長: 50
    欧州連合内の国など、一部の国が使用する付加価値税を識別する番号です。
ネストされたスキーマ : サプライヤ・サイト値リスト
タイプ: array
タイトル: Supplier Sites List of Values
サプライヤ・サイト値リスト・リソースは、サプライヤ・サイトを検索します。
ソースを表示
ネストされたスキーマ : suppliersLOV-sitesLOV-item-response
タイプ: object
ソースを表示
  • Links
  • タイトル: Business Unit
    読取り専用: true
    最大長: 240
    サプライヤ・サイトが存在する調達ビジネス・ユニットの名前。
  • タイトル: Procurement BU
    読取り専用: true
    サプライヤ・サイトが存在する調達ビジネス・ユニットを一意に識別する値。
  • タイトル: Pay
    読取り専用: true
    最大長: 1
    デフォルト値: false
    次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サプライヤ・サイトには支払目的が存在します。 falseの場合、支払目的が存在しません。 デフォルト値はfalseです。
  • 読取り専用: true
    最大長: 1
    次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、プライマリ支払目的がサプライヤ・サイトに存在します。 falseの場合、プライマリ支払目的が存在しません。 デフォルト値はfalseです。
  • 読取り専用: true
    最大長: 1
    デフォルト値: false
    次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サプライヤ・サイトに調達カードが存在します。 falseの場合、調達カードは存在しません。 デフォルト値はfalseです。
  • タイトル: Purchasing
    読取り専用: true
    最大長: 1
    デフォルト値: false
    次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サプライヤ・サイトの購買目的が存在します。 falseの場合、目的が存在しません。 デフォルト値はfalseです。
  • 読取り専用: true
    最大長: 1
    デフォルト値: false
    次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サプライヤにはソーシングのみの目的があります。 falseの場合、サプライヤ・サイトにはソーシングのみの目的がありません。 デフォルト値はfalseです。
  • 読取り専用: true
    サプライヤ・サイトのステータス。
  • 読取り専用: true
    サプライヤ住所を一意に識別する値。
  • タイトル: Site Name
    読取り専用: true
    最大長: 240
    サプライヤ住所の名前。
  • タイトル: Site
    読取り専用: true
    最大長: 240
    サプライヤ・サイトの名前。
  • 読取り専用: true
    サプライヤ・サイトを一意に識別する値。
トップに戻る

この例では、すべてのサプライヤを取得する方法について説明します。

cURLコマンドの例

次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します:

curl -u username:password "https://servername/fscmRestApi/resources/version/suppliersLOV"

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
	"items" : [ {
		"SupplierId" : 11,
		"SupplierPartyId" : 12444,
		"SupplierName" : "PennyPack Systems",
		"SupplierNumber" : "1010",
		"AlternateName" : null,
		"Status" : "ACTIVE",
		"BusinessRelationshipCode" : "SPEND_AUTHORIZED",
		"DUNSNumber" : null,
		"TaxRegistrationNumber" : null,
		"RegistryId" : "9926",
		"links" : [ {
			"rel" : "self",
			"href" : "https://servername/fscmRestApi/resources/version/suppliersLOV/11",
			"name" : "suppliersLOV",
			"kind" : "item"
		}, {
			"rel" : "canonical",
			"href" : "https://servername/fscmRestApi/resources/version/suppliersLOV/11",
			"name" : "suppliersLOV",
			"kind" : "item"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/suppliersLOV/11/child/sitesLOV",
			"name" : "sitesLOV",
			"kind" : "collection"
		} ]
	}, {
		"SupplierId" : 100000012081252,
		"SupplierPartyId" : 100000012081250,
		"SupplierName" : "PennyPack Systems (IC)",
		"SupplierNumber" : "50",
		"AlternateName" : null,
		"Status" : "ACTIVE",
		"BusinessRelationshipCode" : "SPEND_AUTHORIZED",
		"DUNSNumber" : null,
		"TaxRegistrationNumber" : null,
		"RegistryId" : "100000012081249",
		"links" : [ {
			"rel" : "self",
			"href" : "https://servername/fscmRestApi/resources/version/suppliersLOV/100000012081252",
			"name" : "suppliersLOV",
			"kind" : "item"
		}, {
			"rel" : "canonical",
			"href" : "https://servername/fscmRestApi/resources/version/suppliersLOV/100000012081252",
			"name" : "suppliersLOV",
			"kind" : "item"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/suppliersLOV/100000012081252/child/sitesLOV",
			"name" : "sitesLOV",
			"kind" : "collection"
		} ],
		"count" : 2,
		"hasMore" : false,
		"limit" : 25,
		"offset" : 0,
		"links" : [ {
			"rel" : "self",
			"href" : "https://servername/fscmRestApi/resources/version/suppliersLOV",
			"name" : "suppliersLOV",
			"kind" : "collection"
		} ]
	}
}
「トップに戻る」