すべてのアサイメントの取得
get
/fscmRestApi/resources/11.13.18.05/suppliers/{SupplierId}/child/sites/{SupplierSiteId}/child/assignments
リクエスト
パス・パラメータ
- SupplierId(required): integer(int64)
サプライヤを一意に識別する値。
- SupplierSiteId(required): integer(int64)
サプライヤ・サイトを一意に識別する値。
問合せパラメータ
- 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>
使用可能なファインダ名および対応するファインダ変数を次に示します:- PrimaryKey : 主キーに従ってサプライヤ・サイト割当を検索します。
ファインダ変数:- AssignmentId; integer; サプライヤ・サイト割当を一意に識別する値。
- 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=部門番号>=10および<= 30;事業所=NY
フォーマット : ?q=expression1;expression2
次の問合せ可能な属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- AssignmentId; integer; サプライヤ・サイト割当を一意に識別する値。
- BillPayableDistributionId; integer; サプライヤ・サイトの買掛/未払金である請求の配分を一意に識別する値。
- BillToBU; string; ユーザーが選択したクライアント・ビジネス・ユニットではなく、アプリケーションが請求に使用するビジネス・ユニット。
- BillToBUId; integer; ユーザーが選択したクライアント・ビジネス・ユニットではなく、アプリケーションが請求に使用するビジネス・ユニットを一意に識別する値。
- BillToLocation; string; ユーザーが選択した請求先ビジネス・ユニットの購買文書のデフォルトの請求先事業所。
- BillToLocationCode; string; 請求先事業所を識別する略称。 設定およびメンテナンス作業領域および事業所の管理タスクを使用して、この属性の値をレビューおよび更新します。
- BillToLocationId; integer; ユーザーが選択した請求先ビジネス・ユニットの購買文書のデフォルトの請求先事業所を一意に識別する値。
- ChartOfAccountsId; integer; 勘定体系を一意に識別する値。
- ClientBU; string; サプライヤ・サイトが存在する調達ビジネス・ユニットのクライアントであるビジネス・ユニット。
- ClientBUId; integer; サプライヤ・サイトが存在する調達ビジネス・ユニットのクライアントであるビジネス・ユニットを一意に識別する値。
- DistributionSet; string; サプライヤ・サイトの請求書の配分を決定する配分セット。
- DistributionSetId; integer; サプライヤ・サイトの請求書の配分を決定する配分セットを一意に識別する値。
- InactiveDate; string; サプライヤ・サイト割当がアクティブでなくなる日付。
- LiabilityDistributionId; integer; サプライヤ・サイトの新規請求書の負債配分を一意に識別する値。
- PrepaymentDistributionId; integer; サプライヤ・サイトの前払金の配分を一意に識別する値。
- ShipToLocation; string; クライアント・ビジネス・ユニットの購買文書のデフォルトの出荷先事業所。
- ShipToLocationCode; string; 出荷先事業所を識別する略称。 設定およびメンテナンス作業領域および事業所の管理タスクを使用して、この属性の値をレビューおよび更新します。
- ShipToLocationId; integer; クライアント・ビジネス・ユニットの購買文書のデフォルトの出荷先事業所を一意に識別する値。
- Status; string; サプライヤ・サイト割当のステータス。
- UseWithholdingTaxFlag; boolean; 次の値のいずれかを含みます: trueまたはfalse。 trueの場合、源泉徴収税はサプライヤ割当に適用されます。 falseの場合、源泉徴収税は適用されません。 デフォルト値はfalseです。
- WithholdingTaxGroup; string; アプリケーションがサプライヤ・サイト割当に割り当てた源泉徴収税グループを示します。
- WithholdingTaxGroupId; integer; アプリケーションが源泉徴収税にサイトを割り当てるために使用する税金グループを一意に識別する値。
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : suppliers-sites-assignments
タイプ:
ソースを表示
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"の場合、推定行数は含まれません。
ネストされたスキーマ : suppliers-sites-assignments-item-response
タイプ:
ソースを表示
object
-
AssignmentId: integer
サプライヤ・サイト割当を一意に識別する値。
-
BillPayableDistribution: string
タイトル:
Bill Payable Distribution
サプライヤ・サイトに対して支払可能な請求の配分です。 -
BillPayableDistributionId: integer
タイトル:
Bill Payable Distribution
サプライヤ・サイトに対して買掛/未払金である請求の配分を一意に識別する値。 -
BillToBU: string
タイトル:
Bill-to BU
最大長:240
ユーザーが選択したクライアント・ビジネス・ユニットではなく、請求に使用するビジネス・ユニット。 -
BillToBUId: integer (int64)
ユーザーが選択したクライアント・ビジネス・ユニットではなく、請求に使用するビジネス・ユニットを一意に識別する値。
-
BillToLocation: string
タイトル:
Bill-to Location
読取り専用:true
最大長:60
ユーザーが選択した請求先ビジネス・ユニットの購買文書のデフォルト請求事業所です。 -
BillToLocationCode: string
タイトル:
Bill-to Location
最大長:150
請求先事業所を識別する略称です。 設定およびメンテナンス作業領域および事業所の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
BillToLocationId: integer
ユーザーが選択した請求先ビジネス・ユニットの購買文書のデフォルトの請求事業所を一意に識別する値。
-
ChartOfAccountsId: integer (int64)
読取り専用:
true
勘定体系を一意に識別する値。 -
ClientBU: string
タイトル:
Client BU
最大長:240
サプライヤ・サイトが存在する調達ビジネス・ユニットのクライアントであるビジネス・ユニットです。 -
ClientBUId: integer (int64)
サプライヤ・サイトが存在する調達ビジネス・ユニットのクライアントであるビジネス・ユニットを一意に識別する値です。
-
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
サプライヤ・レコードを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
ユーザーがサプライヤ・レコードを作成した日付。 -
DistributionSet: string
タイトル:
Distribution Set
最大長:50
サプライヤ・サイトの請求書の配分を決定する配分セットです。 -
DistributionSetId: integer
タイトル:
Distribution Set
サプライヤ・サイトの請求書の配分を決定する配分セットを一意に識別する値。 -
InactiveDate: string (date)
タイトル:
Inactive Date
サプライヤ・サイト割当がアクティブでなくなった日付。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
ユーザーが最後にサプライヤ・レコードを更新した日時。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
最後にサプライヤ・レコードを更新したユーザー。 -
LiabilityDistribution: string
タイトル:
Liability Distribution
サプライヤ・サイトの新規請求書の負債配分。 -
LiabilityDistributionId: integer
タイトル:
Liability Distribution
サプライヤ・サイトの新規請求書の負債配分を一意に識別する値です。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
PrepaymentDistribution: string
タイトル:
Prepayment Distribution
サプライヤ・サイトに対する前払金の前払金配分です。 -
PrepaymentDistributionId: integer
タイトル:
Prepayment Distribution
サプライヤ・サイトの前払金の配分を一意に識別する値。 -
ShipToLocation: string
タイトル:
Ship-to Location
読取り専用:true
最大長:60
クライアント・ビジネス・ユニットの購買文書のデフォルト出荷事業所。 -
ShipToLocationCode: string
タイトル:
Ship-to Location
最大長:150
出荷先事業所を識別する略称です。 設定およびメンテナンス作業領域および事業所の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
ShipToLocationId: integer
クライアント・ビジネス・ユニットの購買文書のデフォルト出荷事業所を一意に識別する値です。
-
Status: string
読取り専用:
true
サプライヤ・サイト割当のステータスです。 -
UseWithholdingTaxFlag: boolean
タイトル:
Use Withholding Tax
最大長:1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、源泉徴収税はサプライヤ割当に適用されます。 falseの場合、源泉徴収税は適用されません。 デフォルト値はfalseです。 -
WithholdingTaxGroup: string
タイトル:
Withholding Tax Group
最大長:25
アプリケーションがサプライヤ・サイト割当に割り当てた源泉徴収税グループを示します。 -
WithholdingTaxGroupId: integer (int64)
源泉徴収税にサイトを割り当てる際にアプリケーションが使用する税金グループを一意に識別する値です。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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コマンドを使用して、RESTリソースに対するリクエストを送信します:
curl -u username:password "https://servername/fscmRestApi/resources/version/suppliers/SupplierId/child/sites/SupplierSiteId/child/assignments"
レスポンス本文の例
JSON形式のレスポンス本文の例を次に示します。
{ "items" : [ { "AssignmentId" : 300100153044579, "ClientBUId" : 204, "ClientBU" : "Vision Corporation", "BillToBUId" : 204, "BillToBU" : "Vision Corporation", "ShipToLocationId": 18621, "ShipToLocation": "V10 Virginia", "ShipToLocationCode": "V10_VIRGINIA", "BillToLocationId": 18621, "BillToLocation": "V10 Virginia", "BillToLocationCode": "V10_VIRGINIA", "UseWithholdingTaxFlag" : null, "WithholdingTaxGroupId" : null, "WithholdingTaxGroup" : null, "ChartOfAccountsId" : 101, "LiabilityDistributionId" : 89276, "LiabilityDistribution" : "01-000-2120-0000-000", "PrepaymentDistributionId" : 300100153044580, "PrepaymentDistribution" : "01-000-1140-1300-000", "BillPayableDistributionId" : 300100153044581, "BillPayableDistribution" : "01-000-1130-1200-000", "DistributionSetId" : 10020, "DistributionSet" : "Advertising, Public Relations (Full)", "InactiveDate" : null, "Status" : "ACTIVE", "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/suppliers/300100153044388/child/sites/300100153044573/child/assignments/300100153044579", "name" : "assignments", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/suppliers/300100153044388/child/sites/300100153044573/child/assignments/300100153044579", "name" : "assignments", "kind" : "item" }, { "rel" : "parent", "href" : "https://servername/fscmRestApi/resources/version/suppliers/300100153044388/child/sites/300100153044573", "name" : "sites", "kind" : "item" } ] }, { "AssignmentId" : 300100153044583, "ClientBUId" : 458, "ClientBU" : "Vision Services", "BillToBUId" : 458, "BillToBU" : "Vision Services", "ShipToLocationId" : null, "ShipToLocation" : null, "ShipToLocationCode": null, "BillToLocationId" : null, "BillToLocation" : null, "BillToLocationCode": null, "UseWithholdingTaxFlag" : null, "WithholdingTaxGroupId" : null, "WithholdingTaxGroup" : null, "ChartOfAccountsId" : 50234, "LiabilityDistributionId" : null, "LiabilityDistribution" : null, "PrepaymentDistributionId" : null, "PrepaymentDistribution" : null, "BillPayableDistributionId" : null, "BillPayableDistribution" : null, "DistributionSetId" : null, "DistributionSet" : null, "InactiveDate" : null, "Status" : "ACTIVE", "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/suppliers/300100153044388/child/sites/300100153044573/child/assignments/300100153044583", "name" : "assignments", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/suppliers/300100153044388/child/sites/300100153044573/child/assignments/300100153044583", "name" : "assignments", "kind" : "item" }, { "rel" : "parent", "href" : "https://servername/fscmRestApi/resources/version/suppliers/300100153044388/child/sites/300100153044573", "name" : "sites", "kind" : "item" } ] } ], "count" : 2, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/suppliers/300100153044388/child/sites/300100153044573/child/assignments", "name" : "assignments", "kind" : "collection" } ] }