Oracle Fusion Cloud ProcurementのREST API

機械翻訳について

すべての購買オーダーの取得

get

/fscmRestApi/resources/11.13.18.05/purchaseOrdersLOV

リクエスト

問合せパラメータ

effectiveDate: string

この問合せパラメータは、指定した開始日時点で有効なリソースをフェッチするために使用されます。この問合せパラメータの値は、yyyy-MM-dd形式の日付を持つ文字列です
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 : 購買オーダー識別子に従って購買オーダーを検索します。
  ファインダ変数:
  - POHeaderId; integer; 購買オーダーを一意に識別する値。
- findByIntent : 目的に従って購買オーダーを検索します。
  ファインダ変数:
  - Intent; string; インテントを一意に識別する値。有効な値はAPUserです。
  - SysEffectiveDate; object.
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;事業所=NY

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

次の問合せ可能な属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- BillToBU; string; 購買オーダーのサプライヤ請求書を処理するビジネス・ユニット。
- Buyer; string; 購買オーダーの管理を担当する個人。
- OrderNumber; string; 販売先法的エンティティの購買オーダーを一意に識別する番号。
- POHeaderId; integer; 購買オーダーを一意に識別する値。
- SoldToLegalEntity; string; 購買オーダーの購買に財務的に責任があるパーティ。
- Status; string; 購買オーダー・ライフ・サイクルに関連する購買オーダーのステータス。
- StatusCode; string; オーダー・ライフ・サイクルの購買オーダー・ステータスを識別する略称。
- Supplier; string; 品目を履行するサプライヤ。
- SupplierSite; string; サプライヤが品目を購入するために使用する事業所。
totalResults: boolean

"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。デフォルト値はfalseです。

ヘッダー・パラメータ

Effective-Of:

このヘッダーは文字列値を受け入れます。この文字列は、セミコロンで区切られた=のリストです。有効日範囲操作の実行に使用されます。受け入れられるパラメータは、RangeMode、RangeSpan、RangeStartDate、RangeEndDate、RangeStartSequenceおよびRangeEndSequenceです。パラメータ値は常に文字列です。 RangeModeに指定できる値は、SET_LOGICAL_START、SET_LOGICAL_END、END_DATE、SET_EFFECTIVE_START、SET_EFFECTIVE_END、REPLACE_CORRECTION、REPLACE_UPDATE、RECONCILE_CORRECTION、CORRECTION、RECONCILE_UPDATE、UPDATE、ZAPおよびDELETE_CHANGESです。 RangeSpanに指定できる値は、PHYSICAL_ROW_END_DATEおよびLOGICAL_ROW_END_DATEです。 RangeStartDateおよびRangeEndDateの値は、yyyy-MM-dd形式の日付の文字列表現である必要があります。 RangeStartSequenceおよびRangeEndSequenceの値は、解析時に正の整数が生成されるように文字列である必要があります。
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のデフォルト・バージョンを選択します。

ルート・スキーマ : purchaseOrdersLOV

タイプ: 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/purchaseOrdersLOV-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"LOV"
    }
}

ネストされたスキーマ : 品目

タイプ: array

タイトル: Items

コレクション内の品目。

ソースを表示

Array of: object purchaseOrdersLOV-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/purchaseOrdersLOV-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"
    }
}

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

タイプ: object

ソースを表示

BillToBU: string

タイトル: Organization

読取り専用: true

最大長: 240

購買オーダーのサプライヤ請求書を処理するビジネス・ユニットです。
BillToBUId: integer (int64)

読取り専用: true

購買オーダーのサプライヤ請求書を処理するビジネス・ユニットを一意に識別する値。
Buyer: string

タイトル: Name

読取り専用: true

最大長: 240

購買オーダーの管理を担当する個人。
BuyerId: integer (int64)

読取り専用: true

バイヤーを一意に識別する値。
Currency: string

タイトル: Currency Name

読取り専用: true

最大長: 80

購買オーダー通貨です。
CurrencyCode: string

読取り専用: true

最大長: 15

購買オーダー通貨を識別する略語。
Description: string

タイトル: Description

読取り専用: true

最大長: 240

購買オーダーの摘要。
links: array Links

タイトル: Links

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

タイトル: Order

読取り専用: true

最大長: 30

販売先法的エンティティの購買オーダーを一意に識別する番号です。
PaymentTerms: string

タイトル: Payment Terms

読取り専用: true

最大長: 50

購買オーダーに対する各請求書の支払をスケジュールし、支払期日、割引日および割引金額を計算するためにアプリケーションで使用される条件。
PaymentTermsId: integer (int64)

読取り専用: true

支払条件を一意に識別する値。
POHeaderId: integer (int64)

読取り専用: true

購買オーダーを一意に識別する値。
SoldToLegalEntity: string

タイトル: Legal Entity Name

読取り専用: true

最大長: 240

購買オーダーの購買を財務的に担当するパーティ。
SoldToLegalEntityId: integer (int64)

読取り専用: true

購買オーダーの購買を財務的に担当する法的エンティティを一意に識別する値。
Status: string

タイトル: Meaning

読取り専用: true

最大長: 80

購買オーダー・ライフ・サイクルに対する購買オーダーのステータス。
StatusCode: string

タイトル: Status

読取り専用: true

最大長: 25

オーダー・ライフ・サイクルの購買オーダー・ステータスを識別する略称です。
Supplier: string

タイトル: Name

読取り専用: true

最大長: 360

品目を履行するサプライヤ。
SupplierId: integer (int64)

読取り専用: true

サプライヤを一意に識別する値。
SupplierSite: string

タイトル: Site

読取り専用: true

最大長: 240

サプライヤが品目の購入に使用する事業所。
SupplierSiteId: integer (int64)

読取り専用: true

サプライヤ・サイトを一意に識別する値。

{
    "type":"object",
    "properties":{
        "Status":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Status of the purchase order relative to the purchase order life cycle.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillToBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit that processes supplier invoices for the purchase order.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SoldToLegalEntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the legal entity that is financially responsible for purchases on the purchase order.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PaymentTermsId":{
            "type":"integer",
            "description":"Value that uniquely identifies the payment terms.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OrderNumber":{
            "title":"Order",
            "maxLength":30,
            "type":"string",
            "description":"Number that uniquely identifies the purchase order in the sold-to legal entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Buyer":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Person who is responsible for managing the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SoldToLegalEntity":{
            "title":"Legal Entity Name",
            "maxLength":240,
            "type":"string",
            "description":"Party who is financially responsible for purchases on the purchase order.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentTerms":{
            "title":"Payment Terms",
            "maxLength":50,
            "type":"string",
            "description":"Terms that the application uses to schedule payments and calculate due dates, discount dates, and discount amounts for each invoice against the purchase order.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that identifies the purchase order status in the order life cycle.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the purchase order currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BillToBU":{
            "title":"Organization",
            "maxLength":240,
            "type":"string",
            "description":"Business unit that processes supplier invoices for the purchase order.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "POHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BuyerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the buyer.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SupplierSite":{
            "title":"Site",
            "maxLength":240,
            "type":"string",
            "description":"Location that the supplier uses to purchase the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Currency":{
            "title":"Currency Name",
            "maxLength":80,
            "type":"string",
            "description":"Purchase order currency.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Supplier":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"Supplier who fulfills the item.",
            "nullable":false,
            "readOnly":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."
                }
            }
        }
    }
}

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

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

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

トップに戻る

例

この例では、すべての作業領域を取得する方法について説明します。

cURLコマンドの例

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

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

レスポンス本文の例

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

{
	"items": [
	{
		"OrderNumber": "1000018",
		"POHeaderId": 100000016515358,
		"Supplier": "Tall Manufacturing",
		"SupplierId": 147,
		"SupplierSite": "PALMER-CTR_HQ",
		"SupplierSiteId": 2544,
		"BillToBU": "Vision Services",
		"BillToBUId": 458,
		"Buyer": "Jones, Clare",
		"BuyerId": 100010026863783,
		"Currency": "US Dollar",
		"CurrencyCode": "USD",
		"SoldToLegalEntity": "Vision Services",
		"SoldToLegalEntityId": 458,
		"Description": "zBIA_Testcase_6.5_2_Data_Dist",
		"PaymentTerms": "45 Net (terms date + 45)",
		"PaymentTermsId": 10003,
		"Status": "Closed",
		"StatusCode": "CLOSED"
	}, {
		...
	}
}

「トップに戻る」