すべてのルールの取得
get
/fscmRestApi/resources/11.13.18.05/returnRoutingRules
リクエスト
問合せパラメータ
- 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 : 指定した主キー基準に従って返品ルーティング・ルールを検索します。
ファインダ変数:- RuleId; 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;Loc!=NY
フォーマット : ?q=expression1;expression2
次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- CategoryId; integer; アイテム・カテゴリを一意に識別する値。
- CategoryName; string;アイテム・カテゴリを識別する略称。
- CategorySetId; integer; 品目カタログを一意に識別する値。
- CategorySetName; string;アイテム・カタログを識別する略称。
- DestinationOrganizationCode; string;宛先組織を識別する略称。
- DestinationOrganizationId; integer; 宛先組織を一意に識別する値。
- DestinationSubinventory; string;宛先保管場所の名前。
- EnabledFlag; boolean;戻りルーティング・ルールのステータス。
- GeographyId; integer; 顧客の住所のゾーンを一意に識別する値。
- GeographyName; string;顧客の住所のゾーンを識別する略称。
- InventoryItemId; integer;返される在庫品目を一意に識別する値。
- InventoryItemNumber; string; 返される在庫品目を識別する番号。
- ReturnType; string;戻りルーティング・ルールの戻り値の型。 有効な値は、欠陥または超過です。
- RuleId; integer; 戻りルーティング・ルールを一意に識別する値。
- SourceOrganizationCode; string;ソース組織を識別する略称。
- SourceOrganizationId; integer; ソース組織を一意に識別する値。
- SourceSubinventory; string;ソース保管場所の名前。
- SourceType; string;戻りルーティング・ルールのソースのタイプ。 有効な値はゾーンまたは倉庫です。
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : returnRoutingRules
タイプ:
ソースを表示
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"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : returnRoutingRules-item-response
タイプ:
ソースを表示
object
-
CategoryId: integer (int64)
品目カテゴリを一意に識別する値。
-
CategoryName: string
最大長:
250
品目カテゴリを識別する略称です。 -
CategorySetId: integer (int64)
品目カタログを一意に識別する値。
-
CategorySetName: string
最大長:
30
品目カタログを識別する略称です。 -
DestinationOrganizationCode: string
最大長:
18
搬送先組織を識別する略称です。 -
DestinationOrganizationId: integer (int64)
搬送先組織を一意に識別する値。
-
DestinationSubinventory: string
最大長:
10
搬送先保管場所の名前。 -
EnabledFlag: boolean
最大長:
1
返品ルーティング・ルールのステータスです。 -
GeographyId: integer (int64)
顧客の住所のゾーンを一意に識別する値。
-
GeographyName: string
最大長:
360
顧客の住所のゾーンを識別する略称です。 -
InventoryItemId: integer (int64)
返品される在庫品目を一意に識別する値。
-
InventoryItemNumber: string
最大長:
300
返品される在庫品目を識別する番号です。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ReturnType: string
最大長:
10
返品ルーティング・ルールの返品のタイプです。 有効な値は、欠陥または超過です。 -
RuleId: integer (int64)
返品ルーティング・ルールを一意に識別する値。
-
SourceOrganizationCode: string
最大長:
18
ソース組織を識別する略称です。 -
SourceOrganizationId: integer (int64)
ソース組織を一意に識別する値。
-
SourceSubinventory: string
最大長:
10
ソース保管場所の名前。 -
SourceType: string
最大長:
3
返品ルーティング・ルールのソースのタイプです。 有効な値はゾーンまたは倉庫です。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
リンク
- getDestination
-
ソース倉庫またはゾーンの返品ルーティング・ルールを取得します。