Get all replacement headers
get
/fscmRestApi/resources/11.13.18.05/massReplacementHeaders
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Find replacement header according to the primary key.
Finder Variables- ReplacementId; integer; Value that uniquely identifies the replacement header entity.
- PrimaryKey Find replacement header according to the primary key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- LinesCount; integer; Count of replacement detail records for a replacement header.
- MakePermanentFlag; boolean; Attribute that indicates whether a temporary replacement is made permanent during its life cycle.
- ManufacturerPartId; integer; Value that uniquely identifies the primary manufacturer part number.
- ManufacturerPartNumber; string; Number that identifies the primary manufacturer part.
- MarkCompleteFlag; boolean; Attribute used to indicate the completion of replacement header for a permanent replacement.
- ObjectVersionNumber; integer; Number of times the replacement header has been updated.
- PrimaryItemDescription; string; Description of the primary internal item.
- PrimaryItemId; integer; Value that uniquely identifies the primary internal item.
- PrimaryItemNumber; string; Number that identifies the primary internal item.
- ProcurementBUId; integer; Value that uniquely identifies the procurement business unit.
- ProcurementBUName; string; Name of the procurement business unit.
- ReplacementDefType; string; Type of item number used to define a replacement indicating whether it is MPN or internal item.
- ReplacementDefTypeCode; string; Look up value code of item number type used to define a replacement indicating whether it is MPN or internal item.
- ReplacementEndDate; string; Date on which reinstate action gets initiated for a replacement definition.
- ReplacementHeaderStatus; string; Status of the replacement header.
- ReplacementHeaderStatusCode; string; Lookup value code of replacement header status.
- ReplacementId; integer; Value that uniquely identifies the replacement header.
- ReplacementLevelType; string; Level of replacement whether it is specific to inventory organization or globally across organizations.
- ReplacementLevelTypeCode; string; Lookup value code of replacement level indicating whether the replacement is specific to inventory organization or globally across organizations.
- ReplacementNumber; integer; Number that uniquely identifies the replacement header.
- ReplacementStartDate; string; Date on which replacement action gets initiated for a replacement definition.
- ReplacementType; string; Type of replacement indicating whether it is permanent or temporary.
- ReplacementTypeCode; string; Lookup value code of replacement type indicating whether it is permanent or temporary.
- SupplierId; integer; Value that uniquely identifies the primary supplier for which replacement is defined.
- SupplierName; string; Name of the supplier for which replacement is defined.
- SupplierSite; string; Name of the supplier site for which replacement is defined.
- SupplierSiteId; integer; Value that uniquely identifies the primary supplier site for which replacement is defined.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : massReplacementHeaders
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : massReplacementHeaders-item-response
Type:
Show Source
object
-
ExceptionCount: integer
Read Only:
true
Count of errors occurred during mass replacement process. -
LinesCount: integer
Read Only:
true
Count of replacement detail records for a replacement header. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MakePermanentFlag: boolean
Read Only:
true
Maximum Length:255
Attribute that indicates whether a temporary replacement is made permanent during its life cycle. -
ManufacturerPartId: integer
(int64)
Value that uniquely identifies the primary manufacturer part number.
-
ManufacturerPartNumber: string
Title:
Trading Partner Item
Maximum Length:150
Number that identifies the primary manufacturer part. -
MarkCompleteFlag: boolean
Read Only:
true
Maximum Length:255
Attribute used to indicate the completion of replacement header for a permanent replacement. -
massReplacementLines: array
Mass Replacement Lines
Title:
Mass Replacement Lines
The massReplacementLines resource creates the replacement lines representing the organizations in which replacement is initiated for a replacement header. -
ObjectVersionNumber: integer
(int32)
Number of times the replacement header has been updated.
-
PrimaryItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of the primary internal item. -
PrimaryItemId: integer
(int64)
Value that uniquely identifies the primary internal item.
-
PrimaryItemNumber: string
Maximum Length:
300
Number that identifies the primary internal item. -
ProcurementBUId: integer
(int64)
Value that uniquely identifies the procurement business unit.
-
ProcurementBUName: string
Title:
Business Unit
Maximum Length:240
Name of the procurement business unit. -
ReplacementDefType: string
Title:
Meaning
Maximum Length:80
Type of item number used to define a replacement indicating whether it is MPN or internal item. -
ReplacementDefTypeCode: string
Maximum Length:
30
Look up value code of item number type used to define a replacement indicating whether it is MPN or internal item. -
ReplacementEndDate: string
(date)
Date on which reinstate action gets initiated for a replacement definition.
-
ReplacementHeaderStatus: string
Title:
Meaning
Maximum Length:80
Status of the replacement header. -
ReplacementHeaderStatusCode: string
Maximum Length:
30
Lookup value code of replacement header status. -
ReplacementId: integer
(int64)
Value that uniquely identifies the replacement header.
-
ReplacementLevelType: string
Title:
Meaning
Maximum Length:80
Level of replacement whether it is specific to inventory organization or globally across organizations. -
ReplacementLevelTypeCode: string
Maximum Length:
30
Lookup value code of replacement level indicating whether the replacement is specific to inventory organization or globally across organizations. -
ReplacementNumber: integer
(int64)
Read Only:
true
Number that uniquely identifies the replacement header. -
ReplacementStartDate: string
(date)
Date on which replacement action gets initiated for a replacement definition.
-
ReplacementType: string
Title:
Meaning
Maximum Length:80
Type of replacement indicating whether it is permanent or temporary. -
ReplacementTypeCode: string
Maximum Length:
30
Lookup value code of replacement type indicating whether it is permanent or temporary. -
SupplierId: integer
(int64)
Value that uniquely identifies the primary supplier for which replacement is defined.
-
SupplierName: string
Maximum Length:
360
Name of the supplier for which replacement is defined. -
SupplierSite: string
Title:
Site
Maximum Length:15
Name of the supplier site for which replacement is defined. -
SupplierSiteId: integer
(int64)
Value that uniquely identifies the primary supplier site for which replacement is defined.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Mass Replacement Lines
Type:
array
Title:
Mass Replacement Lines
The massReplacementLines resource creates the replacement lines representing the organizations in which replacement is initiated for a replacement header.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : massReplacementHeaders-massReplacementLines-item-response
Type:
Show Source
object
-
AltSupplierId: integer
(int64)
Value that uniquely identifies the alternate supplier used as a replacement option.
-
AltSupplierName: string
Maximum Length:
360
Name of the alternate supplier used as a replacement option. -
AltSupplierSite: string
Title:
Site
Maximum Length:15
Name of the alternate supplier site used as a replacement option. -
AltSupplierSiteId: integer
(int64)
Value that uniquely identifies the alternate supplier site used as a replacement option.
-
DetailStatus: string
Title:
Meaning
Maximum Length:80
Indicates the status of the replacement lifecycle at the organization level in case of organization-specific replacement or at global organization level in case of global replacement. -
DetailStatusCode: string
Maximum Length:
30
Indicates the lookup type code for the status of the replacement lifecycle at the organization level in case of organization-specific replacement or at the global organization level in case of global replacement. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
massReplacementPODetails: array
Mass Replacement Purchase Order Details
Title:
Mass Replacement Purchase Order Details
The Mass Replacement PO Details resource creates the details of a purchase order that has undergone mass replacement. -
ObjectVersionNumber: integer
(int32)
Number of times the replacement line has been updated.
-
Organization: string
Maximum Length:
240
Name of the organization in which replacement is initiated for a replacement header. -
OrganizationCode: string
Read Only:
true
Maximum Length:18
Abbreviation that identifies the organization in which replacement is initiated for a replacement header. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization in which replacement is initiated for a replacement header.
-
ReinstateReplenishNotifyFlag: boolean
Maximum Length:
1
Attribute indicating that the replacement option is notified for reinstating the replenishment attributes. -
ReinstateRequestId: integer
(int64)
Value that uniquely identifies the request for the mass replacement scheduled job submitted during the reinstate phase of the replacement life cycle.
-
ReinstateSrcDocumentLineNumber: number
Number that identifies the primary source document line.
-
ReinstateSrcDocumentNumber: string
Maximum Length:
30
Number that identifies the primary source document. -
ReplacementDetailId: integer
(int64)
Value that uniquely identifies the replacement line.
-
ReplacementEndDate: string
(date)
Date on which the reinstate action gets initiated for a replacement organization or globally across organizations.
-
ReplacementId: integer
(int64)
Value that uniquely identifies the replacement header.
-
ReplacementReplenishNotifyFlag: boolean
Maximum Length:
1
Attribute indicating that the replacement option is notified for updating the replenishment attributes. -
ReplacementRequestId: integer
(int64)
Value that uniquely identifies the request for the mass replacement scheduled job submitted during replacement phase of the replacement lifecycle.
-
ReplacementStartDate: string
(date)
Date on which the replacement action gets initiated for a replacement organization or globally across organizations.
-
RequisitioningBUId: integer
(int64)
Value that uniquely identifies the requisitioning business unit.
-
RequisitioningBUName: string
Title:
Business Unit
Maximum Length:240
Name of the requisitioning business unit. -
SourceDocumentLineNumber: number
Number that identifies the alternate source document line.
-
SourceDocumentNumber: string
Maximum Length:
30
Number that identifies the alternate source document. -
SubstituteItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of the substitute internal item. -
SubstituteItemId: integer
(int64)
Value that uniquely identifies the substitute internal item.
-
SubstituteItemNumber: string
Maximum Length:
300
Number that identifies the substitute internal item. -
SubstituteManufacturerPartNumber: string
Title:
Trading Partner Item
Maximum Length:150
Number that identifies the substitute manufacturer part number. -
SubstituteMPNId: integer
(int64)
Value that uniquely identifies the alternate manufacturer part number.
-
SubstituteType: string
Title:
Meaning
Maximum Length:80
Replacement method selected for a replacement organization or globally across organizations indicating whether it is an alternate supplier or alternate item. -
SubstituteTypeCode: string
Maximum Length:
30
Indicates the lookup type code for the replacement method selected for a replacement organization or globally across organizations.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Mass Replacement Purchase Order Details
Type:
array
Title:
Mass Replacement Purchase Order Details
The Mass Replacement PO Details resource creates the details of a purchase order that has undergone mass replacement.
Show Source
Nested Schema : massReplacementHeaders-massReplacementLines-massReplacementPODetails-item-response
Type:
Show Source
object
-
InlineReplacementFlag: boolean
Maximum Length:
1
Default Value:false
Attribute that indicates whether inline replacement is performed on the purchase order line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PODetailId: integer
(int64)
Value that uniquely identifies the purchase order detail for which replacement is done.
-
PODistributionId: integer
(int64)
Value that uniquely identifies the purchase order distribution for which replacement is done.
-
POHeaderId: integer
(int64)
Value that uniquely identifies the purchase order header for which replacement is done.
-
POLineId: integer
(int64)
Value that uniquely identifies the purchase order line for which replacement is done.
-
POLineLocationId: integer
(int64)
Value that uniquely identifies the purchase order schedule for which replacement is done.
-
POStatus: string
Maximum Length:
30
Attribute that indicates the status of the mass replacement for a purchase order detail record. -
QuantityDue: number
Indicates the order quantity for the replacement line to be created on the purchase order.
-
ReplacementAction: string
Maximum Length:
30
Indicates whether mass update is done against a purchase order detail record for a replacement action or a reinstate action. -
ReplacementDetailId: integer
(int64)
Value that uniquely identifies the replacement line.
-
ReplacementId: integer
(int64)
Value that uniquely identifies the replacement header.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- raiseNotifyPlannerEvent
-
Description of the action to raise a business event to send notifications to the planners and par counters by providing the replacement details.
Examples
This example describes how to get all replacement headers.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/massReplacementHeaders"
Example Response Body
The following shows an example of the response body in JSON format.
"{ "items": [ { "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???, "SupplierId": 6134, "SupplierSite": ???SCH 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" } ] }, { "ReplacementId": 300100553117194, "ReplacementNumber": 1005, "ReplacementLevelTypeCode": "ORA_SCH_PR_ORG", "ReplacementLevelType": "Each organization individually", "ReplacementDefTypeCode": "ORA_SCH_PR_INTERNAL_ITEM", "ReplacementDefType": "Master item", "ReplacementTypeCode": "ORA_SCH_PR_PERMANENT", "ReplacementType": "Permanent", "PrimaryItemNumber": "SCH2020", "PrimaryItemDescription": "Z-Med 12 Pacemaker", "PrimaryItemId": 300100545303414, "ManufacturerPartNumber": null, "ManufacturerPartId": null, "SupplierName": ???Supplier01???, "SupplierId": 6134, "SupplierSite": ???SCH Supplier01???, "SupplierSiteId": 300100203539381, "ProcurementBUName": "Vision Healthcare USA", "ProcurementBUId": 300100200125593, "ReplacementHeaderStatusCode": "ORA_SCH_PR_OPEN", "ReplacementHeaderStatus": "In-Progress", "ReplacementStartDate": "2022-04-14", "ReplacementEndDate": null, "ObjectVersionNumber": 2, "ExceptionCount": 0, "LinesCount": 1, "MakePermanentFlag": "false", "MarkCompleteFlag": "false", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/massReplacementHeaders/300100553117194", "name": "massReplacementHeaders", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/massReplacementHeaders/300100553117194", "name": "massReplacementHeaders", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/massReplacementHeaders/300100553117194/child/massReplacementLines", "name": "massReplacementLines", "kind": "collection" } ] }, { "ReplacementId": 300100553117155, "ReplacementNumber": 1003, "ReplacementLevelTypeCode": "ORA_SCH_PR_ORG", "ReplacementLevelType": "Each organization individually", "ReplacementDefTypeCode": "ORA_SCH_PR_INTERNAL_ITEM", "ReplacementDefType": "Master item", "ReplacementTypeCode": "ORA_SCH_PR_PERMANENT", "ReplacementType": "Permanent", "PrimaryItemNumber": "SCH2060", "PrimaryItemDescription": "Scorpio NRG Knee System Tibial Insert", "PrimaryItemId": 300100545303628, "ManufacturerPartNumber": null, "ManufacturerPartId": null, "SupplierName": ???SCH Supplier01???, "SupplierId": 6134, "SupplierSite": ???SCH 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": "false", "MarkCompleteFlag": "false", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/massReplacementHeaders/300100553117155", "name": "massReplacementHeaders", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/massReplacementHeaders/300100553117155", "name": "massReplacementHeaders", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/massReplacementHeaders/300100553117155/child/massReplacementLines", "name": "massReplacementLines", "kind": "collection" } "