すべてのロケーションの取得
get
/fscmRestApi/resources/11.13.18.05/requisitionOneTimeLocations
リクエスト
問合せパラメータ
- 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 : 主キーに従ってワンタイムのロケーションを検索します。
ファインダ変数:- LocationId; 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 - 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のデフォルト・バージョンを選択します。
ルート・スキーマ : requisitionOneTimeLocations
タイプ:
ソースを表示
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"の場合、推定行数は含まれません。
ネストされたスキーマ : requisitionOneTimeLocations-item-response
タイプ:
ソースを表示
object-
AddrElementAttribute1: string
タイトル:
Additional Address Element 1最大長:150柔軟な住所書式をサポートする最初の追加住所要素。 -
AddrElementAttribute2: string
タイトル:
Additional Address Element 2最大長:150柔軟な住所書式をサポートするための2番目の追加住所要素。 -
AddrElementAttribute3: string
タイトル:
Additional Address Element 3最大長:150柔軟な住所書式をサポートするための3番目の追加住所要素。 -
AddrElementAttribute4: string
タイトル:
Additional Address Element 4最大長:150柔軟な住所書式をサポートするための4番目の追加住所要素。 -
AddrElementAttribute5: string
タイトル:
Additional Address Element 5最大長:150柔軟な住所書式をサポートするための5番目の追加住所要素。 -
Address1: string
タイトル:
Address Line 1最大長:240アドレスの最初の行。 -
Address2: string
タイトル:
Address Line 2最大長:240住所の2行目。 -
Address3: string
タイトル:
Address Line 3最大長:240住所の3行目。 -
Address4: string
タイトル:
Address Line 4最大長:240住所の4行目。 -
AddressLinesPhonetic: string
タイトル:
Address Lines Phonetic最大長:560アドレスの表記。 -
Building: string
タイトル:
Building最大長:240指定された住所の特定の建物名または番号。 -
City: string
タイトル:
City最大長:60住所に指定された市区町村の名前。 -
Country: string
タイトル:
Territory Name最大長:80住所に記載された国。 -
CountryCode: string
タイトル:
Country最大長:2住所に記載された郡コードです。 -
County: string
タイトル:
County最大長:60住所に記載された郡。 -
CreatedBy: string
読取り専用:
true最大長:64住所を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
trueユーザーが住所を作成した日付。 -
FloorNumber: string
タイトル:
Floor最大長:40建物番号が指定されている場合に、特定の住所または特定の建物の特定のフロアを識別する番号。 -
FormattedAddress: string
タイトル:
Address読取り専用:true1行で書式設定された住所。 -
LastUpdateDate: string (date-time)
読取り専用:
trueユーザーが住所を更新した日付。 -
LastUpdatedBy: string
読取り専用:
true最大長:64住所を最後に更新したユーザー。 -
links: array Links
タイトル:
Linksリソース・インスタンスに関連付けられたリンク関係。 -
LocationId: integer (int64)
タイトル:
Location ID読取り専用:true事業所を一意に識別する値です。 -
PostalCode: string
タイトル:
Postal Code最大長:60住所の郵便番号。 -
PostalPlus4Code: string
タイトル:
Postal Code Extension最大長:20米国の郵便番号コードへの4桁の拡張。 -
Province: string
タイトル:
Province最大長:60住所に記載された州。 -
State: string
タイトル:
State最大長:60住所に記載された州。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.