すべてのサマリー属性の取得
get
/fscmRestApi/resources/11.13.18.05/draftPurchaseOrders/{draftPurchaseOrdersUniqID}/child/summaryAttributes
リクエスト
パス・パラメータ
- draftPurchaseOrdersUniqID(required): string
これは、下書き購買オーダー・リソースの複合キーを構成し、下書き購買オーダーのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、ドラフト購買オーダーの特定のインスタンスに移動してハッシュ・キーを取得するために、ドラフト購買オーダー・コレクション・リソースを問い合せる必要があります。
問合せパラメータ
- dependency: string
このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前に、親リソース・インスタンスにフィールドが設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
フォーマット: <attr1>=<val1>,<attr2>=<value2> - 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>
使用可能なファインダ名および対応するファインダ変数を次に示します:- DeliveryAndAmountSummaryFinder: 購買オーダーのアクティブな明細および配分全体の集計された搬送、依頼者、借方勘定、プロジェクトおよび購買オーダー金額情報を検索します。 要約には、すべての明細が同じ事業所に搬送されたかどうか、および対応する事業所詳細に関する情報が含まれます。 すべての配分が同じ借方勘定に賦課されるかどうかを指定し、対応する勘定科目詳細を提供します。 すべての配分に同じリクエスト元があるかどうかを指定し、対応するリクエスト者詳細を提供します。 機能通貨での購買オーダー・オーダー金額(内税付き)、合計tax(exclusive)および合計金額が取得されます。 また、同じプロジェクトおよびタスクをすべての配分に適用するかどうかを指定し、対応するプロジェクトおよびタスクの詳細を提供します。
ファインダ変数: - PrimaryKey : 主キーに従って、購買オーダーの要約属性を検索します。
ファインダ変数:- POHeaderId; integer; 購買オーダーを一意に識別する値。
- DeliveryAndAmountSummaryFinder: 購買オーダーのアクティブな明細および配分全体の集計された搬送、依頼者、借方勘定、プロジェクトおよび購買オーダー金額情報を検索します。 要約には、すべての明細が同じ事業所に搬送されたかどうか、および対応する事業所詳細に関する情報が含まれます。 すべての配分が同じ借方勘定に賦課されるかどうかを指定し、対応する勘定科目詳細を提供します。 すべての配分に同じリクエスト元があるかどうかを指定し、対応するリクエスト者詳細を提供します。 機能通貨での購買オーダー・オーダー金額(内税付き)、合計tax(exclusive)および合計金額が取得されます。 また、同じプロジェクトおよびタスクをすべての配分に適用するかどうかを指定し、対応するプロジェクトおよびタスクの詳細を提供します。
- 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 - totalResults: boolean
"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : draftPurchaseOrders-summaryAttributes
タイプ:
ソースを表示
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"の場合、推定行数は含まれません。
ネストされたスキーマ : draftPurchaseOrders-summaryAttributes-item-response
タイプ:
ソースを表示
object
-
ChargeToSingleAccountFlag: boolean
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、すべての配分で借方勘定が同じであるため、すべての購買オーダー(PO)配分が同じ借方勘定に請求されます。 falseの場合、借方勘定は配分ごとに異なるため、購買オーダー配分は異なる借方勘定に請求されます。 デフォルト値はfalseです。
-
ChartOfAccountId: number
勘定体系を一意に識別する値。
-
DeliverToCustomerLocationAddress: string
最大長:
255
購買会社がサプライヤから受け取った商品を搬送する必要がある一時事業所の物理的な住所。 -
DeliverToCustomerLocationId: integer
以前にサプライヤから受け取った商品を購買会社が搬送する必要がある一時事業所を一意に識別する値です。
-
DeliverToLocationCode: string
以前にサプライヤから受け取った商品を購買会社が搬送する必要がある最終事業所を識別する略称です。
-
DeliverToLocationId: integer
以前にサプライヤから受け取った商品を購買会社が搬送する必要がある最終事業所を一意に識別する値です。
-
DeliverToSingleLocationFlag: boolean
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、すべての購買オーダー配分の搬送ロケーションが同じです。 falseの場合、配送ロケーションは配分で異なります。 デフォルト値はfalseです。
-
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
Ordered: number
すべての明細にわたる購買オーダー金額の合計です。
-
POChargeAccount: string
購買オーダーからの購買の請求先となるアカウント。
-
POChargeAccountId: integer
購買オーダーからの購買の請求先となるアカウントを一意に識別する値です。
-
POHeaderId: integer
購買オーダーを一意に識別する値。
-
ProjectCostingDetailsCode: string
次のいずれかの値が含まれます: NONE、SINGLEまたはMULTIPLE。 配分にプロジェクト原価計算詳細が関連付けられていない場合、属性値はNONEに設定されます。 すべての配分にまったく同じプロジェクトおよびタスクが関連付けられている場合は、SINGLEに設定されます。 配分に関連付けられたプロジェクトとタスクが異なる場合は、複数に設定されます。
-
ProjectId: number
プロジェクトを一意に識別する値。
-
ProjectName: string
最大長:
240
購買オーダー・ヘッダーに表示されるプロジェクトの名前。 -
ProjectNumber: string
最大長:
25
購買オーダー・ヘッダーに表示されるプロジェクトの番号。 -
ProjectsInformationAcrossLines: string
次のいずれかの値が含まれます: NONE、SINGLEまたはMULTIPLE。 配分にプロジェクト原価計算詳細が関連付けられていない場合、属性値はNONEに設定されます。 すべての配分に同じプロジェクトが関連付けられており、原価計算詳細がまったく同じ場合は、SINGLEに設定されます。 配分のプロジェクト原価計算詳細が異なる場合は、MULTIPLEに設定されます。
-
RequestedDeliveryDate: string (date)
購買会社がオーダー品目またはサービスの搬送をリクエストした日付。
-
Requester: string
商品またはサービスのオーダー先の個人の表示名。 依頼者が購買オーダー配分間で異なる場合、この値はNullに設定されます。
-
RequesterId: string
商品またはサービスのオーダー先の個人を一意に識別する値。 依頼者が購買オーダー配分全体で異なる場合、値はNullに設定されます。
-
SameRequestedDeliveryDateFlag: boolean
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、すべての購買オーダー・スケジュールに同じリクエスト搬送日値が保持されます。 falseの場合、リクエスト搬送日はスケジュールで異なります。 デフォルト値はfalseです。
-
SameRequesterIdFlag: boolean
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、同じ個人に対してすべての購買オーダー明細がオーダーされます。 falseの場合、購買オーダーは別の個人に対してオーダーされます。 この属性にはデフォルト値がありません。
-
TaskId: number
タスクを一意に識別する値。
-
TaskName: string
購買オーダーに表示されるプロジェクト・タスクの名前。
-
TaskNumber: string
最大長:
240
購買オーダーに表示されるプロジェクト・タスクの番号。 -
Total: number
オーダー金額と税額合計の合計。
-
TotalTax: number
機能通貨で表された購買オーダーの外税(控除対象外および控除対象外)金額の合計。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
例
この例では、cURLコマンドでファインダを使用して、購買オーダーの明細、スケジュールおよび配分から搬送先事業所、借方勘定、プロジェクトおよび依頼者および金額に関する要約情報を取得する方法について説明します。
cURLコマンドの例
次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します:
curl -u username:password "https://servername/fscmRestApi/resources/version/draftPurchaseOrders/draftPurchaseOrdersUniqID/child/summaryAttributes"
たとえば:
curl -u username:password "https://servername/fscmRestApi/resources/version/draftPurchaseOrders/300100580259972/child/summaryAttributes?finder=DeliveryAndAmountSummaryFinder&onlyData=true"
レスポンス本文の例
次の例には、レスポンス本文の内容がJSON形式で含まれます:
{ "items": [ { "POHeaderId": 300100580259972, "DeliverToLocationCode": null, "DeliverToLocationId": null, "DeliverToSingleLocationFlag": false, "DeliverToCustomerLocationId": 0, "ProjectCostingDetailsCode": "NONE", "ProjectId": 0, "ProjectNumber": null, "ProjectName": null, "RequesterId": "100010026864135", "SameRequesterIdFlag": true, "Requester": "Penelope Antilla", "RequestedDeliveryDate": "2023-07-17", "SameRequestedDeliveryDateFlag": true, "TaskNumber": null, "TaskName": null, "ProjectsInformationAcrossLines": "NONE", "POChargeAccountId": 188976, "ChargeToSingleAccountFlag": true, "POChargeAccount": "00-000-2440-0000-000", "Ordered": 12, "TotalTax": 0, "Total": 12, "TaskId": 0, "DeliverToCustomerLocationAddress": null, "ChartOfAccountId": 101 } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://server/fscmRestApi/resources/version/draftPurchaseOrders/300100580259972/child/summaryAttributes", "name": "summaryAttributes", "kind": "collection" } ] }