置換ヘッダーの取得
get
/fscmRestApi/resources/11.13.18.05/massReplacementHeaders/{ReplacementId}
リクエスト
パス・パラメータ
- ReplacementId(required): integer(int64)
このパラメータの値は、リソース品目を一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース品目にナビゲートする必要があります。 たとえば: products?q=InventoryItemId=
問合せパラメータ
- 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 - links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- onlyData: boolean
データのみを含めるために(リンク・セクションなしなど)、リソース品目ペイロードがフィルタ処理されます。
ヘッダー・パラメータ
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : massReplacementHeaders-item-response
タイプ:
ソースを表示
object
-
DisruptionReason: string
タイトル:
Meaning
読取り専用:true
最大長:80
供給中断の理由を表すユーザー定義参照内容を格納する属性です。 この属性は、置換タスクの作成時に取得されます。 -
DisruptionReasonCode: string
最大長:
30
供給中断の事由を表すユーザー定義参照コードを格納する属性です。 この属性は、置換タスクの作成時に取得されます。 -
EnableReinstateFlag: boolean
読取り専用:
true
置換詳細タスクの在庫ステータスに基づいて置換タスクの回復処理を許可するかどうかを示すブール演算子。 有効な値はTrueおよびFalseです。 -
EstimatedEndDate: string (date)
中断された品目の供給がリストアされる予定日を格納する属性です。 この属性は、置換タスクの作成時に取得されます。
-
ExceptionCount: integer
読取り専用:
true
一括置換プロセス中に発生したエラーの数。 -
LinesCount: integer
読取り専用:
true
置換ヘッダーの置換詳細レコード数。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
MakePermanentFlag: boolean
読取り専用:
true
最大長:255
一時置換がライフ・サイクル中に永続化されるかどうかを示す属性。 -
ManufacturerPartId: integer (int64)
プライマリ製造業者部品番号を一意に識別する値。
-
ManufacturerPartNumber: string
タイトル:
Trading Partner Item
最大長:150
プライマリ製造業者部品を識別する番号。 -
MarkCompleteFlag: boolean
読取り専用:
true
最大長:255
永続置換の置換ヘッダーの完了を示すために使用される属性。 -
massReplacementGroupedOrgs: array Mass Replacement Grouped Organizations
タイトル:
Mass Replacement Grouped Organizations
massReplacementGroupedOrgsリソースは、品目置換プロセス中にグループ化された組織を取得します。 -
massReplacementLines: array Mass Replacement Lines
タイトル:
Mass Replacement Lines
massReplacementLinesリソースは、置換ヘッダーの置換が開始される組織を表す置換行を作成します。 -
ObjectVersionNumber: integer (int32)
置換ヘッダーの更新回数。
-
PackagingString: string
読取り専用:
true
最大長:255
元の品目の梱包文字列を示す値。 -
PrimaryItemDescription: string
タイトル:
Item Description
読取り専用:true
最大長:240
プライマリ内部品目の摘要。 -
PrimaryItemId: integer (int64)
プライマリ内部品目を一意に識別する値。
-
PrimaryItemImageURL: string
タイトル:
Primary Image URL
読取り専用:true
最大長:4000
アイテム・マスターにアップロードされたプライマリ・アイテム・イメージのURL。 -
PrimaryItemNumber: string
最大長:
300
プライマリ内部品目を識別する番号。 -
PrimaryUnitOfMeasure: string
タイトル:
UOM Name
読取り専用:true
最大長:25
元の品目のプライマリ単位の名前を示す属性。 -
ProcurementBUId: integer (int64)
調達ビジネス・ユニットを一意に識別する値。
-
ProcurementBUName: string
タイトル:
Business Unit
最大長:240
調達ビジネス・ユニットの名前。 -
PurchasingUnitOfMeasure: string
読取り専用:
true
最大長:255
当初品目の購買単位の名前を示す属性。 -
ReinstateFlag: boolean
読取り専用:
true
最大長:255
少なくとも1つの組織の置換タスクに対して再稼働が完了したかどうかを示す属性。 -
ReinstateGlobalFlag: boolean
読取り専用:
true
最大長:255
グローバル置換の各組織の在庫ステータスを検証して置換詳細タスクの再稼働を許可するかどうかを示します。 -
ReplacementDefType: string
タイトル:
Meaning
最大長:80
置換がMPNか内部品目かを示す置換の定義に使用される品目番号のタイプです。 -
ReplacementDefTypeCode: string
最大長:
30
置換がMPNか内部品目かを示す置換の定義に使用される品目番号タイプの参照コードです。 -
ReplacementEndDate: string (date)
置換定義に対して再稼働処理が開始される日付。
-
ReplacementFlag: boolean
読取り専用:
true
最大長:255
少なくとも1つの組織の置換タスクに対して置換フェーズが完了したかどうかを示す属性。 -
ReplacementHeaderStatus: string
タイトル:
Meaning
最大長:80
置換ヘッダーのステータス。 -
ReplacementHeaderStatusCode: string
最大長:
30
置換ヘッダー・ステータスの参照値コード。 -
ReplacementId: integer (int64)
置換ヘッダーを一意に識別する値。
-
ReplacementLevelType: string
タイトル:
Meaning
最大長:80
置換のレベルが在庫組織に固有か、組織全体に適用可能かを示します。 -
ReplacementLevelTypeCode: string
最大長:
30
置換レベルの参照値コードで、置換が在庫組織に固有であるか、組織全体でグローバルであるかを示します。 -
ReplacementNumber: integer (int64)
読取り専用:
true
置換ヘッダーを一意に識別する番号。 -
ReplacementStartDate: string (date)
置換定義に対して置換処理が開始される日付。
-
ReplacementType: string
タイトル:
Meaning
最大長:80
永久か一時かを示す置換のタイプです。 -
ReplacementTypeCode: string
最大長:
30
置換タイプが永続か一時かを示す参照コードです。 -
SubItemNotAssignedFlag: boolean
読取り専用:
true
グローバル置換タスクの1つ以上の組織に代替品目が割り当てられていないことを示す属性です。 -
SupplierId: integer (int64)
置換が定義されているプライマリ・サプライヤを一意に識別する値。
-
SupplierName: string
最大長:
360
置換が定義されているサプライヤの名前。 -
SupplierPartNumber: string
読取り専用:
true
最大長:255
当初品目のサプライヤ品目番号を示す属性です。 -
SupplierSite: string
タイトル:
Site
最大長:240
置換が定義されているサプライヤ・サイトの名前。 -
SupplierSiteId: integer (int64)
置換が定義されているプライマリ・サプライヤ・サイトを一意に識別する値。
ネストされたスキーマ : 一括置換グループ組織
タイプ:
array
タイトル:
Mass Replacement Grouped Organizations
massReplacementGroupedOrgsリソースは、品目置換プロセス中にグループ化された組織を取得します。
ソースを表示
ネストされたスキーマ : 一括置換明細
タイプ:
array
タイトル:
Mass Replacement Lines
massReplacementLinesリソースは、置換ヘッダーの置換が開始される組織を表す置換行を作成します。
ソースを表示
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
ネストされたスキーマ : massReplacementHeaders-massReplacementGroupedOrgs-item-response
タイプ:
ソースを表示
object
-
GroupId: integer (int64)
品目置換タスクの影響を受ける組織に対して実行されたグループの一意の識別子を示す属性です。
-
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
OrganizationCode: string
読取り専用:
true
最大長:18
品目置換が実行されるグループ内の組織を識別する略称。 -
OrganizationId: integer (int64)
品目置換が実行されるグループ内の組織の一意の識別子。
-
OrganizationName: string
読取り専用:
true
最大長:240
品目置換が実行されるグループ内の組織の名前。 -
ReplacementId: integer (int64)
品目置換を実行するために組織がグループ化される置換タスクの一意の識別子です。
-
ReplacementOrgId: integer (int64)
品目置換タスク内のグループ化された組織の一意の識別子です。
-
RequisitioningBUId: integer (int64)
品目置換が実行されるグループ内の組織に対応する購買依頼発行ビジネス・ユニットの一意の識別子です。
-
RequisitioningBUName: string
タイトル:
Business Unit
読取り専用:true
最大長:240
品目置換が実行されるグループ内の組織に対応する購買依頼発行ビジネス・ユニットの名前。
ネストされたスキーマ : massReplacementHeaders-massReplacementLines-item-response
タイプ:
ソースを表示
object
-
AlternateItemImageURL: string
タイトル:
Primary Image URL
読取り専用:true
最大長:4000
品目マスターにアップロードされた代替品目イメージのURL。 -
AltSupplierId: integer (int64)
置換オプションとして使用される代替サプライヤを一意に識別する値。
-
AltSupplierName: string
最大長:
360
代替オプションとして使用される代替サプライヤの名前。 -
AltSupplierSite: string
タイトル:
Site
最大長:240
代替オプションとして使用される代替サプライヤ・サイトの名前。 -
AltSupplierSiteId: integer (int64)
置換オプションとして使用される代替サプライヤ・サイトを一意に識別する値。
-
CopyFromDisruptedItemFlag: boolean
最大長:
1
在庫エンティティを元の品目からコピーする必要があるかどうかを示す属性。 -
CopyFromDisruptedTransactionFlag: boolean
最大長:
1
中断された品目から品目トランザクション・デフォルトをコピーする必要があるかどうかを示す属性。 -
DetailInvStatus: string
タイトル:
Meaning
読取り専用:true
最大長:80
在庫組織レベルでの在庫エンティティの置換ライフサイクルのステータス名を示します。 -
DetailInvStatusCode: string
最大長:
30
在庫組織レベルでの在庫エンティティの置換ライフサイクルのステータス・コードを示します。 -
DetailStatus: string
タイトル:
Meaning
最大長:80
組織固有の置換の場合、またはグローバル置換の場合のグローバル組織レベルでの置換ライフサイクルのステータスを示します。 -
DetailStatusCode: string
最大長:
30
組織固有置換の場合の組織レベルでの置換ライフサイクルのステータスの参照タイプ・コード、またはグローバル置換の場合のグローバル組織レベルを示します。 -
GroupId: integer (int64)
品目置換タスクの影響を受ける組織に対して実行されたグループの一意の識別子を示す属性です。
-
InvExceptionFlag: boolean
読取り専用:
true
最大長:255
在庫エンティティの一括置換中に置換詳細の例外があるかどうかを示します。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
massReplacementPODetails: array 一括置換購買オーダー詳細
タイトル:
Mass Replacement Purchase Order Details
一括置換購買オーダー詳細リソースは、一括置換が行われた購買オーダーの詳細を作成します。 -
NewItemLocFlag: boolean
読取り専用:
true
最大長:255
品目置換プロセス中に新規品目保管棚が置換品目に追加されるかどうかを示す属性。 -
NewItemSubFlag: boolean
読取り専用:
true
最大長:255
品目置換プロセス中に新規品目保管場所が置換品目に追加されるかどうかを示す属性です。 -
ObjectVersionNumber: integer (int32)
置換明細が更新された回数。
-
Organization: string
最大長:
240
置換ヘッダーの置換が開始される組織の名前。 -
OrganizationCode: string
読取り専用:
true
最大長:18
置換ヘッダーの置換が開始される組織を識別する略称です。 -
OrganizationId: integer (int64)
置換ヘッダーの置換が開始される組織を一意に識別する値。
-
PackagingString: string
読取り専用:
true
最大長:255
置換品目の梱包文字列を示す値。 -
PrimaryUnitOfMeasure: string
タイトル:
UOM Name
読取り専用:true
最大長:25
置換品目のプライマリ単位の名前を示す属性。 -
PurchasingUnitOfMeasure: string
タイトル:
UOM Name
読取り専用:true
最大長:25
置換品目の購買単位の名前を示す属性。 -
ReinstateReplenishNotifyFlag: boolean
最大長:
1
補充属性の復元について置換オプションが通知されることを示す属性です。 -
ReinstateRequestId: integer (int64)
置換ライフ・サイクルの再稼働フェーズ中に送信された一括置換スケジュール済ジョブのリクエストを一意に識別する値。
-
ReinstateSrcDocumentLineNumber: number
プライマリ・ソース文書明細を識別する番号です。
-
ReinstateSrcDocumentNumber: string
最大長:
30
プライマリ・ソース文書を識別する番号です。 -
ReplacementDetailId: integer (int64)
置換明細を一意に識別する値。
-
ReplacementEndDate: string (date)
置換組織または組織全体でグローバルに再稼働処理が開始される日付。
-
ReplacementId: integer (int64)
置換ヘッダーを一意に識別する値。
-
ReplacementReplenishNotifyFlag: boolean
最大長:
1
補充属性の更新について置換オプションが通知されることを示す属性です。 -
ReplacementRequestId: integer (int64)
置換ライフサイクルの置換フェーズ中に送信された一括置換スケジュール済ジョブのリクエストを一意に識別する値。
-
ReplacementStartDate: string (date)
置換組織または組織全体でグローバルに置換処理が開始される日付。
-
ReplenishByInvSourceFlag: boolean
最大長:
1
補充ソースとして在庫がある品目保管場所を置換する必要があるかどうかを示す属性です。 -
RequestId: integer (int64)
品目置換時に一括置換スケジュール済プロセスのリクエストを一意に識別する値。
-
RequisitioningBUId: integer (int64)
購買依頼発行ビジネス・ユニットを一意に識別する値。
-
RequisitioningBUName: string
タイトル:
Business Unit
最大長:240
購買依頼発行ビジネス・ユニットの名前です。 -
SourceDocumentLineNumber: number
代替ソース文書明細を識別する番号です。
-
SourceDocumentNumber: string
最大長:
30
代替ソース文書を識別する番号です。 -
StuckInProgressFlag: boolean
読取り専用:
true
最大長:255
一括置換スケジュール済プロセスが実行開始前に取り消されたため、在庫エンティティの一括更新の実行中に置換詳細タスクがスタックしたかどうかを示す属性。 -
SubstituteItemDescription: string
タイトル:
Item Description
読取り専用:true
最大長:240
代替内部品目の摘要。 -
SubstituteItemId: integer (int64)
代替内部品目を一意に識別する値。
-
SubstituteItemNumber: string
最大長:
300
代替内部品目を識別する番号。 -
SubstituteManufacturerPartNumber: string
タイトル:
Trading Partner Item
最大長:150
代替製造業者部品番号を識別する番号。 -
SubstituteMPNId: integer (int64)
代替製造業者部品番号を一意に識別する値です。
-
SubstituteType: string
タイトル:
Meaning
最大長:80
代替組織に対して選択された置換メソッド、または代替サプライヤか代替品目かを示す組織全体でグローバルに選択された置換メソッド。 -
SubstituteTypeCode: string
最大長:
30
置換組織または組織全体でグローバルに選択された置換メソッドの参照タイプ・コードを示します。 -
SupplierPartNumber: string
タイトル:
Supplier Item
読取り専用:true
最大長:300
置換品目のサプライヤ品目番号を示す属性です。
ネストされたスキーマ : 一括置換購買オーダー詳細
タイプ:
array
タイトル:
Mass Replacement Purchase Order Details
一括置換購買オーダー詳細リソースは、一括置換が行われた購買オーダーの詳細を作成します。
ソースを表示
ネストされたスキーマ : massReplacementHeaders-massReplacementLines-massReplacementPODetails-item-response
タイプ:
ソースを表示
object
-
InlineReplacementFlag: boolean
最大長:
1
デフォルト値:false
購買オーダー明細でインライン置換が実行されるかどうかを示す属性です。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
PODetailId: integer (int64)
置換が実行される購買オーダー詳細を一意に識別する値。
-
PODistributionId: integer (int64)
置換が実行される購買オーダー配分を一意に識別する値。
-
POHeaderId: integer (int64)
置換が実行される購買オーダー・ヘッダーを一意に識別する値。
-
POLineId: integer (int64)
置換が実行される購買オーダー明細を一意に識別する値。
-
POLineLocationId: integer (int64)
置換が実行される購買オーダー・スケジュールを一意に識別する値。
-
POStatus: string
最大長:
30
購買オーダー詳細レコードの一括置換のステータスを示す属性です。 -
QuantityDue: number
購買オーダーに作成される置換明細のオーダー数量を示します。
-
ReplacementAction: string
最大長:
30
置換処理または再稼働処理の購買オーダー詳細レコードに対して一括更新を実行するかどうかを示します。 -
ReplacementDetailId: integer (int64)
置換明細を一意に識別する値。
-
ReplacementId: integer (int64)
置換ヘッダーを一意に識別する値。
リンク
- massReplacementGroupedOrgs
-
パラメータ:
- ReplacementId:
$request.path.ReplacementId
massReplacementGroupedOrgsリソースは、品目置換プロセス中にグループ化された組織を取得します。 - ReplacementId:
- massReplacementLines
-
操作: /fscmRestApi/resources/11.13.18.05/massReplacementHeaders/{ReplacementId}/child/massReplacementLinesパラメータ:
- ReplacementId:
$request.path.ReplacementId
massReplacementLinesリソースは、置換ヘッダーの置換が開始される組織を表す置換行を作成します。 - ReplacementId:
例
この例では、1つの置換ヘッダーを取得する方法について説明します。
cURLコマンドの例
次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します:
curl -u username:password "https://servername/fscmRestApi/resources/version/massReplacementHeaders/ReplacementId"
レスポンス本文の例
JSON形式のレスポンス本文の例を次に示します。
"{ "ReplacementId": 300100552611876, "ReplacementNumber": 1, "ReplacementLevelTypeCode": "ORA_SCH_PR_ORG", "ReplacementLevelType": "Each organization individually", "ReplacementDefTypeCode": "ORA_SCH_PR_INTERNAL_ITEM", "ReplacementDefType": "Master item", "ReplacementTypeCode": "ORA_SCH_PR_TEMPORARY", "ReplacementType": "Temporary", "PrimaryItemNumber": "SCH1020", "PrimaryItemDescription": "Z-Med 12 Pacemaker", "PrimaryItemId": 300100545228228, "ManufacturerPartNumber": null, "ManufacturerPartId": null, "SupplierName": "Supplier01 Inc", "SupplierId": 6134, "SupplierSite": "VHS Supplier01", "SupplierSiteId": 300100203539381, "ProcurementBUName": "Vision Healthcare USA", "ProcurementBUId": 300100200125593, "ReplacementHeaderStatusCode": "ORA_SCH_PR_OPEN", "ReplacementHeaderStatus": "In-Progress", "ReplacementStartDate": null, "ReplacementEndDate": null, "ObjectVersionNumber": 1, "ExceptionCount": 0, "LinesCount": 0, "MakePermanentFlag": "true", "MarkCompleteFlag": "false", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/massReplacementHeaders/300100552611876", "name": "massReplacementHeaders", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/massReplacementHeaders/300100552611876", "name": "massReplacementHeaders", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/massReplacementHeaders/300100552611876/child/massReplacementLines", "name": "massReplacementLines", "kind": "collection" } ] }"