Jump to

• Request
• Response
• Examples

Update a substitute component

patch

/fscmRestApi/resources/11.13.18.05/productChangeOrders/{ChangeId}/child/AffectedObject/{AffectedObjectUniqID}/child/AffectedItemStructure/{AffectedItemStructureUniqID}/child/StructureComponent/{StructureComponentUniqID}/child/RedlinedSubstituteComponent/{RedlinedSubstituteComponentUniqID}

Request

Path Parameters

• AffectedItemStructureUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Affected Item Structures resource and used to uniquely identify an instance of Affected Item Structures. The client should not generate the hash key value. Instead, the client should query on the Affected Item Structures collection resource in order to navigate to a specific instance of Affected Item Structures to get the hash key.
• AffectedObjectUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Affected Objects resource and used to uniquely identify an instance of Affected Objects. The client should not generate the hash key value. Instead, the client should query on the Affected Objects collection resource in order to navigate to a specific instance of Affected Objects to get the hash key.
• ChangeId(required): integer
  Value that uniquely identifies the change.
• RedlinedSubstituteComponentUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Substitute Components resource and used to uniquely identify an instance of Substitute Components. The client should not generate the hash key value. Instead, the client should query on the Substitute Components collection resource in order to navigate to a specific instance of Substitute Components to get the hash key.
• StructureComponentUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Structure Components resource and used to uniquely identify an instance of Structure Components. The client should not generate the hash key value. Instead, the client should query on the Structure Components collection resource in order to navigate to a specific instance of Structure Components 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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Quantity: number
  Quantity of the substitute component that is used to build the structure.
• SubstituteComponentDFF: array Flexfields for Substitute Components
  Title: Flexfields for Substitute Components

  The Flexfields for Substitute Components resource gets the descriptive flexfields associated with the substitute component.
• SubstituteComponentId: integer
  Value that uniquely identifies the item of the substitute component.

{
    "type":"object",
    "properties":{
        "Quantity":{
            "type":"number",
            "description":"Quantity of the substitute component that is used to build the structure.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "SubstituteComponentDFF":{
            "title":"Flexfields for Substitute Components",
            "type":"array",
            "description":"The Flexfields for Substitute Components resource gets the descriptive flexfields associated with the substitute component.",
            "items":{
                "$ref":"#/components/schemas/productChangeOrders-AffectedObject-AffectedItemStructure-StructureComponent-RedlinedSubstituteComponent-SubstituteComponentDFF-item-patch-request"
            }
        },
        "SubstituteComponentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item of the substitute component.",
            "nullable":false
        }
    }
}

Nested Schema : Flexfields for Substitute Components

Type: array

Title: Flexfields for Substitute Components

The Flexfields for Substitute Components resource gets the descriptive flexfields associated with the substitute component.

Show Source

• Array of: object schema

{
    "title":"Flexfields for Substitute Components",
    "type":"array",
    "description":"The Flexfields for Substitute Components resource gets the descriptive flexfields associated with the substitute component.",
    "items":{
        "$ref":"#/components/schemas/productChangeOrders-AffectedObject-AffectedItemStructure-StructureComponent-RedlinedSubstituteComponent-SubstituteComponentDFF-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context

  Maximum Length: 30

  Descriptive flexfield context that references the substitute component.
• __FLEX_Context_DisplayValue: string
  Title: Context

{
    "type":"object",
    "properties":{
        "__FLEX_Context_DisplayValue":{
            "title":"Context",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context",
            "maxLength":"30",
            "type":"string",
            "description":"Descriptive flexfield context that references the substitute component.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : productChangeOrders-AffectedObject-AffectedItemStructure-StructureComponent-RedlinedSubstituteComponent-item-response

Type: object

Show Source

• ACDType: integer
  Read Only: true

  Value that indicates if the substitute component is being added, modified, or deleted through a change line.
• ACDTypeValue: string
  Read Only: true

  Value that indicates if the substitute component is being added, modified, or deleted through a change line.
• ChangeNotice: string
  Title: Change Notice

  Read Only: true

  Value that uniquely identifies the change order associated with the substitute component.
• CreationDate: string (date-time)
  Read Only: true

  Date when the substitute component was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the substitute component was most recently updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Quantity: number
  Quantity of the substitute component that is used to build the structure.
• SequenceId: integer
  Value that uniquely identifies the substitute component in a structure. This attribute is read-only and is not required for an update operation.
• SubstituteComponentDFF: array Flexfields for Substitute Components
  Title: Flexfields for Substitute Components

  The Flexfields for Substitute Components resource gets the descriptive flexfields associated with the substitute component.
• SubstituteComponentId: integer
  Value that uniquely identifies the item of the substitute component.
• SubstituteComponentItemNumber: string
  Number that identifies the item of the substitute component.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the substitute component was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ACDTypeValue":{
            "type":"string",
            "description":"Value that indicates if the substitute component is being added, modified, or deleted through a change line.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "SubstituteComponentDFF":{
            "title":"Flexfields for Substitute Components",
            "type":"array",
            "description":"The Flexfields for Substitute Components resource gets the descriptive flexfields associated with the substitute component.",
            "items":{
                "$ref":"#/components/schemas/productChangeOrders-AffectedObject-AffectedItemStructure-StructureComponent-RedlinedSubstituteComponent-SubstituteComponentDFF-item-response"
            }
        },
        "ACDType":{
            "type":"integer",
            "description":"Value that indicates if the substitute component is being added, modified, or deleted through a change line.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ChangeNotice":{
            "title":"Change Notice",
            "type":"string",
            "description":"Value that uniquely identifies the change order associated with the substitute component.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of the substitute component that is used to build the structure.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubstituteComponentItemNumber":{
            "type":"string",
            "description":"Number that identifies the item of the substitute component.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the substitute component was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "SequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the substitute component in a structure. This attribute is read-only and is not required for an update operation.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "SubstituteComponentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item of the substitute component.",
            "nullable":false,
            "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 : Flexfields for Substitute Components

Type: array

Title: Flexfields for Substitute Components

The Flexfields for Substitute Components resource gets the descriptive flexfields associated with the substitute component.

Show Source

• Array of: object productChangeOrders-AffectedObject-AffectedItemStructure-StructureComponent-RedlinedSubstituteComponent-SubstituteComponentDFF-item-response

{
    "title":"Flexfields for Substitute Components",
    "type":"array",
    "description":"The Flexfields for Substitute Components resource gets the descriptive flexfields associated with the substitute component.",
    "items":{
        "$ref":"#/components/schemas/productChangeOrders-AffectedObject-AffectedItemStructure-StructureComponent-RedlinedSubstituteComponent-SubstituteComponentDFF-item-response"
    }
}

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."
        }
    }
}

Nested Schema : productChangeOrders-AffectedObject-AffectedItemStructure-StructureComponent-RedlinedSubstituteComponent-SubstituteComponentDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context

  Maximum Length: 30

  Descriptive flexfield context that references the substitute component.
• __FLEX_Context_DisplayValue: string
  Title: Context
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SubCompSequenceId: integer (int64)
  Value that uniquely identifies the substitute component in a structure. This attribute is read-only and is not required for an update operation.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "SubCompSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the substitute component in a structure. This attribute is read-only and is not required for an update operation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context",
            "maxLength":"30",
            "type":"string",
            "description":"Descriptive flexfield context that references the substitute component.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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"
    }
}

Links

SubstituteComponentDFF

Operation: /fscmRestApi/resources/11.13.18.05/productChangeOrders/{ChangeId}/child/AffectedObject/{AffectedObjectUniqID}/child/AffectedItemStructure/{AffectedItemStructureUniqID}/child/StructureComponent/{StructureComponentUniqID}/child/RedlinedSubstituteComponent/{RedlinedSubstituteComponentUniqID}/child/SubstituteComponentDFF

Parameters:

• AffectedItemStructureUniqID: $request.path.AffectedItemStructureUniqID
• AffectedObjectUniqID: $request.path.AffectedObjectUniqID
• ChangeId: $request.path.ChangeId
• RedlinedSubstituteComponentUniqID: $request.path.RedlinedSubstituteComponentUniqID
• StructureComponentUniqID: $request.path.StructureComponentUniqID

The Flexfields for Substitute Components resource gets the descriptive flexfields associated with the substitute component.

Back to Top

Examples

This example describes how to update a substitute component.

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/productChangeOrders/ChangeId/child/AffectedObject/ChangeLineId/child/AffectedItemStructure/AffectedItemStructureUniqID/child/StructureComponent/StructureComponentUniqID/child/RedlinedSubstituteComponent/RedlinedSubstituteComponentUniqID"

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/productChangeOrders/300100184375438/child/AffectedObject/00020000000EACED00057708000110F084E300980000000EACED00057708000110F084E30098/child/AffectedItemStructure/300100184375436/child/StructureComponent/300100184807411/child/RedlinedSubstituteComponent/300100184807415"

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.

{
	"Quantity":2
}

Example Response Body

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

{
	"LastUpdateDate": "2020-09-23T22:17:30.270+05:30",
	"CreationDate": "2020-09-23T21:43:12.001+05:30",
	"ChangeNotice": null,
	"SubstituteComponentItemNumber": "P0076",
	"ACDType": 1,
	"SequenceId": 300100184807415,
	"Quantity": 2,
	"ACDTypeValue": "Added",
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100184375438/child/AffectedObject/00020000000EACED00057708000110F084E300980000000EACED00057708000110F084E30098/child/AffectedItemStructure/300100184375436/child/StructureComponent/300100184807411/child/RedlinedSubstituteComponent/300100184807415",
		"name": "RedlinedSubstituteComponent",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100184375438/child/AffectedObject/00020000000EACED00057708000110F084E300980000000EACED00057708000110F084E30098/child/AffectedItemStructure/300100184375436/child/StructureComponent/300100184807411/child/RedlinedSubstituteComponent/300100184807415",
		"name": "RedlinedSubstituteComponent",
		"kind": "item"
	},
	{
		"rel": "parent",
		"href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100184375438/child/AffectedObject/00020000000EACED00057708000110F084E300980000000EACED00057708000110F084E30098/child/AffectedItemStructure/300100184375436/child/StructureComponent/300100184807411",
		"name": "StructureComponent",
		"kind": "item"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100184375438/child/AffectedObject/00020000000EACED00057708000110F084E300980000000EACED00057708000110F084E30098/child/AffectedItemStructure/300100184375436/child/StructureComponent/300100184807411/child/RedlinedSubstituteComponent/300100184807415/child/SubstituteComponentDFF",
		"name": "SubstituteComponentDFF",
		"kind": "collection"
	}
	]
}

Back to Top