REST API for Oracle Fusion Cloud Procurement

Update a category mapping

patch

/fscmRestApi/resources/11.13.18.05/externalPurchasePricesPurchasingCategories/{MappingId}

Request

Path Parameters

MappingId(required): integer(int64)

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

Metadata-Context: string

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: string

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

application/json

Root Schema : schema

Type: object

Show Source

ManufacturerName: string

Maximum Length: 700

Name of the manufacturer.
ManufacturerPartNumber: string

Maximum Length: 700

Number that identifies the manufacturer part.
PurchasingCategoryCode: string

Maximum Length: 820

Abbreviation that identifies the purchasing category that's mapped to a manufacturer part number.
PurchasingCategoryId: integer (int64)

Value that uniquely identifies the purchasing category.
PurchasingCategoryName: string

Maximum Length: 2400

Name of the purchasing category that's mapped to a manufacturer part number.
UNSPSCCode: string

Maximum Length: 700

Value that uniquely identifies the UNSPSC.

{
    "type":"object",
    "properties":{
        "UNSPSCCode":{
            "maxLength":700,
            "type":"string",
            "description":"Value that uniquely identifies the UNSPSC.",
            "nullable":true
        },
        "ManufacturerName":{
            "maxLength":700,
            "type":"string",
            "description":"Name of the manufacturer.",
            "nullable":true
        },
        "PurchasingCategoryCode":{
            "maxLength":820,
            "type":"string",
            "description":"Abbreviation that identifies the purchasing category that's mapped to a manufacturer part number.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PurchasingCategoryName"
                ]
            }
        },
        "PurchasingCategoryName":{
            "maxLength":2400,
            "type":"string",
            "description":"Name of the purchasing category that's mapped to a manufacturer part number.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PurchasingCategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchasing category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ManufacturerPartNumber":{
            "maxLength":700,
            "type":"string",
            "description":"Number that identifies the manufacturer part.",
            "nullable":true
        }
    }
}

Response

Supported Media Types

application/json

Default Response

The following table describes the default response for this task.

Headers

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.

Root Schema : externalPurchasePricesPurchasingCategories-item-response

Type: object

Show Source

LastUpdateDate: string (date-time)

Read Only: true

Date and time when the user most recently updated the purchasing category mapping record.
links: array Links

Title: Links

The link relations associated with the resource instance.
ManufacturerName: string

Maximum Length: 700

Name of the manufacturer.
ManufacturerPartNumber: string

Maximum Length: 700

Number that identifies the manufacturer part.
MappingId: integer (int64)

Value that uniquely identifies the purchasing category mapping.
PurchasingCategoryCode: string

Maximum Length: 820

Abbreviation that identifies the purchasing category that's mapped to a manufacturer part number.
PurchasingCategoryId: integer (int64)

Value that uniquely identifies the purchasing category.
PurchasingCategoryName: string

Maximum Length: 2400

Name of the purchasing category that's mapped to a manufacturer part number.
UNSPSCCode: string

Maximum Length: 700

Value that uniquely identifies the UNSPSC.

{
    "type":"object",
    "properties":{
        "UNSPSCCode":{
            "maxLength":700,
            "type":"string",
            "description":"Value that uniquely identifies the UNSPSC.",
            "nullable":true,
            "x-queryable":true
        },
        "MappingId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchasing category mapping.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ManufacturerName":{
            "maxLength":700,
            "type":"string",
            "description":"Name of the manufacturer.",
            "nullable":true,
            "x-queryable":true
        },
        "PurchasingCategoryCode":{
            "maxLength":820,
            "type":"string",
            "description":"Abbreviation that identifies the purchasing category that's mapped to a manufacturer part number.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PurchasingCategoryName"
                ]
            },
            "x-queryable":true
        },
        "PurchasingCategoryName":{
            "maxLength":2400,
            "type":"string",
            "description":"Name of the purchasing category that's mapped to a manufacturer part number.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PurchasingCategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchasing category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ManufacturerPartNumber":{
            "maxLength":700,
            "type":"string",
            "description":"Number that identifies the manufacturer part.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the purchasing category mapping record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

changeIndicator: string

Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Examples

These examples describe how to update category mappings.

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/externalPurchasePricesPurchasingCategories/MappingId"

Example 1

A purchasing category mapping can be updated using a PATCH operation. To initiate a change on a purchasing category mapping, the user can update the UNSPSCCode, ManufacturerPartNumber, ManufacturerName, PurchasingCategoryCode, or PurchasingCategoryName. If the user updates any one of the values, the other dependent values are also updated.

This example describes how to update the UNSPSCCode and PurchasingCategoryCode.

Example 1 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/externalPurchasePricesPurchasingCategories/300100630548110"

Example 1 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.

{
    "UNSPSCCode": "42151721",
    "PurchasingCategoryCode": "EQUIPMENT.A/V"
}

Example 1 Response Body

The following example includes the contents of the response body in JSON format:

{
    "MappingId": "300100630548110",
    "UNSPSCCode": "42151721",
    "ManufacturerPartNumber": null,
    "PurchasingCategoryId": "3097",
    "PurchasingCategoryCode": "EQUIPMENT.A/V",
    "PurchasingCategoryName": "Audio Video Equipment",
    "LastUpdateDate": "2025-03-03T09:33:50+00:00",
    "ManufacturerName": null,
    "@context": {
        "key": "300100630548110",
        "headers": {
            "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000578"
        },
        "links": [
            {
                "rel": "self",
                "href": "https://servername/fscmRestApi/resources/version/externalPurchasePricesPurchasingCategories/300100630548110",
                "name": "externalPurchasePricesPurchasingCategories",
                "kind": "item"
            },
            {
                "rel": "canonical",
                "href": "https://servername/fscmRestApi/resources/version/externalPurchasePricesPurchasingCategories/300100630548110",
                "name": "externalPurchasePricesPurchasingCategories",
                "kind": "item"
            }
        ]
    }
}

Example 2

This example describes how to update the ManufacturerPartNumber.

Example 2 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/externalPurchasePricesPurchasingCategories/300100630548113"

Example 2 Request Body

{
            "ManufacturerPartNumber": "SCH1003"
}

Example 2 Response Body

The following example includes the contents of the response body in JSON format:

{
    "MappingId": 300100630548113,
    "UNSPSCCode": null,
    "ManufacturerPartNumber": "SCH1003",
    "PurchasingCategoryId": 3097,
    "PurchasingCategoryCode": "EQUIPMENT.A/V",
    "PurchasingCategoryName": "Audio Video Equipment",
    "LastUpdateDate": "2025-02-06T13:30:54+00:00",
    "ManufacturerName": "Aero Tech",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/11.13.18.05/externalPurchasePricesPurchasingCategories/300100630548113",
            "name": "externalPurchasePricesPurchasingCategories",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/11.13.18.05/externalPurchasePricesPurchasingCategories/300100630548113",
            "name": "externalPurchasePricesPurchasingCategories",
            "kind": "item"
        }
    ]
}