REST API for Oracle Fusion Cloud SCM

Update

patch

/fscmRestApi/resources/11.13.18.05/manufacturers/{manufacturersUniqID}/child/manufacturerEFF/{manufacturerEFFUniqID}

Request

Path Parameters

manufacturerEFFUniqID(required): string

This is the hash key of the attributes which make up the composite key for the Manufacturer Extensible Flexfields resource and used to uniquely identify an instance of Manufacturer Extensible Flexfields. The client should not generate the hash key value. Instead, the client should query on the Manufacturer Extensible Flexfields collection resource in order to navigate to a specific instance of Manufacturer Extensible Flexfields to get the hash key.
manufacturersUniqID(required): string

This is the hash key of the attributes which make up the composite key for the Manufacturers resource and used to uniquely identify an instance of Manufacturers. The client should not generate the hash key value. Instead, the client should query on the Manufacturers collection resource in order to navigate to a specific instance of Manufacturers to get the hash key.

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.

Supported Media Types

application/json

Root Schema : Discriminator: CategoryCode

Type: object

Discriminator: CategoryCode

Discriminator Values

ALL_MANUFACTURERS

{
    "discriminator":{
        "propertyName":"CategoryCode",
        "mapping":{
            "ALL_MANUFACTURERS":"#/components/schemas/oracle_apps_flex_scm_productCatalogManagement_manufacturerEff_manufacturer_categories_view_j__manufacturerAllManufacturersPrivateVO-item-patch-request"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_flex_scm_productCatalogManagement_manufacturerEff_manufacturer_categories_view_j__manufacturerAllManufacturersPrivateVO-item-patch-request"
        }
    ]
}

Match One Schema

Show Source

ALL_MANUFACTURERS - object oracle_apps_flex_scm_productCatalogManagement_manufacturerEff_manufacturer_categories_view_j__manufacturerAllManufacturersPrivateVO-item-patch-request

{
    "discriminator":{
        "propertyName":"CategoryCode",
        "mapping":{
            "ALL_MANUFACTURERS":"#/components/schemas/oracle_apps_flex_scm_productCatalogManagement_manufacturerEff_manufacturer_categories_view_j__manufacturerAllManufacturersPrivateVO-item-patch-request"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_flex_scm_productCatalogManagement_manufacturerEff_manufacturer_categories_view_j__manufacturerAllManufacturersPrivateVO-item-patch-request"
        }
    ]
}

Nested Schema : oracle_apps_flex_scm_productCatalogManagement_manufacturerEff_manufacturer_categories_view_j__manufacturerAllManufacturersPrivateVO-item-patch-request

Type: object

Show Source

CategoryCode: string

Maximum Length: 30

Default Value: ALL_MANUFACTURERS
ManufacturerId: string

Maximum Length: 255

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "maxLength":"30",
            "type":"string",
            "nullable":true,
            "default":"ALL_MANUFACTURERS"
        },
        "ManufacturerId":{
            "maxLength":"255",
            "type":"string",
            "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 : Discriminator: CategoryCode

Type: object

Discriminator: CategoryCode

Discriminator Values

ALL_MANUFACTURERS

{
    "discriminator":{
        "propertyName":"CategoryCode",
        "mapping":{
            "ALL_MANUFACTURERS":"#/components/schemas/oracle_apps_flex_scm_productCatalogManagement_manufacturerEff_manufacturer_categories_view_j__manufacturerAllManufacturersPrivateVO-item-response"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_flex_scm_productCatalogManagement_manufacturerEff_manufacturer_categories_view_j__manufacturerAllManufacturersPrivateVO-item-response"
        }
    ]
}

Match One Schema

Show Source

ALL_MANUFACTURERS - object oracle_apps_flex_scm_productCatalogManagement_manufacturerEff_manufacturer_categories_view_j__manufacturerAllManufacturersPrivateVO-item-response

{
    "discriminator":{
        "propertyName":"CategoryCode",
        "mapping":{
            "ALL_MANUFACTURERS":"#/components/schemas/oracle_apps_flex_scm_productCatalogManagement_manufacturerEff_manufacturer_categories_view_j__manufacturerAllManufacturersPrivateVO-item-response"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_flex_scm_productCatalogManagement_manufacturerEff_manufacturer_categories_view_j__manufacturerAllManufacturersPrivateVO-item-response"
        }
    ]
}

Nested Schema : oracle_apps_flex_scm_productCatalogManagement_manufacturerEff_manufacturer_categories_view_j__manufacturerAllManufacturersPrivateVO-item-response

Type: object

Show Source

CategoryCode: string

Maximum Length: 30

Default Value: ALL_MANUFACTURERS
CreatedBy: string

Read Only: true

Maximum Length: 64
CreationDate: string (date-time)

Read Only: true
LastUpdateDate: string (date-time)

Read Only: true
LastUpdatedBy: string

Read Only: true

Maximum Length: 64
links: array Links

Title: Links

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

Maximum Length: 255

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "nullable":false,
            "readOnly":true
        },
        "CategoryCode":{
            "maxLength":"30",
            "type":"string",
            "nullable":true,
            "default":"ALL_MANUFACTURERS"
        },
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "nullable":false,
            "readOnly":true
        },
        "ManufacturerId":{
            "maxLength":"255",
            "type":"string",
            "nullable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":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

This example describes how to update a manufacturer.

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/manufacturers/manufacturersUniqID"

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/manufacturers/300100618812452"

Example Request Body

In this example, the user should be able to update the value of the created Manufacturer extensible flexfield, considering Manufacturer_Flavor as a Manufacturer extensible flexfield, where Flavor is a ContextSensitiveSegment .

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.

{

"ManufacturerId": 300100618812452,
"RegistryId": "CDRM_965283"
"PartyType": "ORGANIZATION"
"ContextCode": "Manufacturer_Flavor",
"Flavor": "Banana",
}

Example Response Body

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

{
"ManufacturerId":300100618812452,
"ContextCode": "Manufacturer_Flavor",
"CreatedBy": "PLM_AUTO",
"CreationDate": "2023-10-31T14:50:47.623+00:00",
"EffLineId": 300100618897251,
"LastUpdateDate": "2023-10-31T14:50:49.292+00:00",
"LastUpdatedBy": "PLM_AUTO",
"ObjectVersionNumber": 1,
"Manufacturer_Flavor": "banana",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/manufacturers/300100618812452/child/manufacturerEFF/300100618812452/child/Manufacturer_Flavor/300100618897251",
"name": "Manufacturer_Flavor",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/manufacturers/300100618812452/child/manufacturerEFF/300100618812452/child/MultiTest/300100618897251",
"name": "Manufacturer_Flavor",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/manufacturers/300100618812452/child/manufacturerEFF/300100618812452",
"name": "manufacturerEFF",
"kind": "item"
}
]
}