Update a replacement header

patch

/fscmRestApi/resources/11.13.18.05/massReplacementHeaders/{ReplacementId}

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Header Parameters
  • 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".
  • 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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Mass Replacement Grouped Organizations
Type: array
Title: Mass Replacement Grouped Organizations
The massReplacementGroupedOrgs resource gets the organizations that are grouped during the item replacement process.
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 : massReplacementHeaders-massReplacementGroupedOrgs-item-patch-request
Type: object
Show Source
Nested Schema : massReplacementHeaders-massReplacementLines-item-patch-request
Type: object
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-patch-request
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : massReplacementHeaders-item-response
Type: object
Show Source
Nested Schema : Mass Replacement Grouped Organizations
Type: array
Title: Mass Replacement Grouped Organizations
The massReplacementGroupedOrgs resource gets the organizations that are grouped during the item replacement process.
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 : massReplacementHeaders-massReplacementGroupedOrgs-item-response
Type: object
Show Source
Nested Schema : massReplacementHeaders-massReplacementLines-item-response
Type: object
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: object
Show Source
Back to Top

Examples

This example describes how to update a replacement header.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/massReplacementHeaders/ReplacementId"
For example:
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/massReplacementHeaders/300100553117194"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

"{
    "parts": [
        {
            "payload": {
                 "ReplacementTypeCode": "ORA_SCH_PR_PERMANENT"
            },
            "id": "part2",
            "operation": "update",
            "path": "/massReplacementHeaders/300100553117194"
        },
         {
            "payload": {
                 "ReplacementTypeCode": "ORA_SCH_PR_PERMANENT"
            },
            "id": "part2",
            "operation": "update",
            "path": "/massReplacementHeaders/300100553117194"
        }
    ]
}"

Example Response Body

The following example includes the contents 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_PERMANENT",
            "ReplacementType": "Permanent",
            "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"
                }
            ]
        },
        {
            "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 Inc",
            "SupplierId": 6134,
            "SupplierSite": "VHS 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"
                }
            ]
        }
    ]
}"
Back to Top