Jump to

• Request
• Response

Update a substitute component

patch

/fscmRestApi/resources/11.13.18.05/itemStructures/{BillSequenceId}/child/Component/{ComponentSequenceId}/child/SubstituteComponent/{SubstituteComponentSequenceId}

Request

Path Parameters

• BillSequenceId(required): integer
  Value that uniquely identifies the structure. This attribute is read-only, which can be modified only if the resource is already modified.
• ComponentSequenceId(required): number
  Value that uniquely identifies the component in a structure. This attribute is read-only and is not required for an update operation.
• SubstituteComponentSequenceId(required): 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.

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

• ACDType: integer
  Title: Change Action

  Default Value: 1

  Value that indicates if the substitute component is being added, modified, or deleted through a change line.
• ACDTypeValue: string
  Maximum Length: 255

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

  Maximum Length: 10

  Change order notice to which the service operation added all the structure component changes. This attribute is used when Needs Approval rule is run.
• EnforceIntegerRequirementsValue: string
  Maximum Length: 255

  Generates the demand with quantity specified in integers. Used in supply chain planning. The values include Round Up, Round Down, or None.
• PrimaryUOMValue: string
  Maximum Length: 255

  Primary unit of measure specified for the substitute component.
• Priority: integer
  Priority specified for the substitute component.
• Quantity: number
  Title: Quantity

  Quantity of the substitute component.
• 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 associated as the substitute component.

{
    "type":"object",
    "properties":{
        "ACDTypeValue":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates if the substitute component is being added, modified, or deleted through a change line.",
            "nullable":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/itemStructures-Component-SubstituteComponent-SubstituteComponentDFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "ACDType":{
            "title":"Change Action",
            "type":"integer",
            "description":"Value that indicates if the substitute component is being added, modified, or deleted through a change line.",
            "nullable":false,
            "default":1
        },
        "ChangeNotice":{
            "title":"Change Notice",
            "maxLength":10,
            "type":"string",
            "description":"Change order notice to which the service operation added all the structure component changes. This attribute is used when Needs Approval rule is run.",
            "nullable":true
        },
        "Priority":{
            "type":"integer",
            "description":"Priority specified for the substitute component.",
            "nullable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity of the substitute component.",
            "nullable":false
        },
        "PrimaryUOMValue":{
            "maxLength":255,
            "type":"string",
            "description":"Primary unit of measure specified for the substitute component.",
            "nullable":true
        },
        "SubstituteComponentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item associated as the substitute component.",
            "nullable":false
        },
        "EnforceIntegerRequirementsValue":{
            "maxLength":255,
            "type":"string",
            "description":"Generates the demand with quantity specified in integers. Used in supply chain planning. The values include Round Up, Round Down, or None.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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/itemStructures-Component-SubstituteComponent-SubstituteComponentDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

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_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(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.

Body ()

Root Schema : itemStructures-Component-SubstituteComponent-item-response

Type: object

Show Source

• ACDType: integer
  Title: Change Action

  Default Value: 1

  Value that indicates if the substitute component is being added, modified, or deleted through a change line.
• ACDTypeValue: string
  Maximum Length: 255

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

  Maximum Length: 10

  Change order notice to which the service operation added all the structure component changes. This attribute is used when Needs Approval rule is run.
• CreationDateTime: string (date-time)
  Read Only: true

  Date and time when the structure was last created.
• EnforceIntegerRequirementsValue: string
  Maximum Length: 255

  Generates the demand with quantity specified in integers. Used in supply chain planning. The values include Round Up, Round Down, or None.
• LastUpdateDateTime: string (date-time)
  Read Only: true

  Date and time when the structure was most recently updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PrimaryUOMValue: string
  Maximum Length: 255

  Primary unit of measure specified for the substitute component.
• Priority: integer
  Priority specified for the substitute component.
• Quantity: number
  Title: Quantity

  Quantity of the substitute component.
• 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 associated as the substitute component.
• SubstituteComponentItemNumber: string
  Maximum Length: 255

  Item number of the substitute component.
• SubstituteComponentSequenceId: 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":{
        "ACDTypeValue":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates if the substitute component is being added, modified, or deleted through a change line.",
            "nullable":true,
            "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/itemStructures-Component-SubstituteComponent-SubstituteComponentDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "LastUpdateDateTime":{
            "type":"string",
            "description":"Date and time when the structure was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Priority":{
            "type":"integer",
            "description":"Priority specified for the substitute component.",
            "nullable":true,
            "x-queryable":true
        },
        "SubstituteComponentSequenceId":{
            "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":{
                "precision":18
            },
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity of the substitute component.",
            "nullable":false,
            "x-queryable":true
        },
        "PrimaryUOMValue":{
            "maxLength":255,
            "type":"string",
            "description":"Primary unit of measure specified for the substitute component.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDateTime":{
            "type":"string",
            "description":"Date and time when the structure was last created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ACDType":{
            "title":"Change Action",
            "type":"integer",
            "description":"Value that indicates if the substitute component is being added, modified, or deleted through a change line.",
            "nullable":false,
            "default":1,
            "x-queryable":true
        },
        "ChangeNotice":{
            "title":"Change Notice",
            "maxLength":10,
            "type":"string",
            "description":"Change order notice to which the service operation added all the structure component changes. This attribute is used when Needs Approval rule is run.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubstituteComponentItemNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Item number of the substitute component.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SubstituteComponentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item associated as the substitute component.",
            "nullable":false,
            "x-queryable":true
        },
        "EnforceIntegerRequirementsValue":{
            "maxLength":255,
            "type":"string",
            "description":"Generates the demand with quantity specified in integers. Used in supply chain planning. The values include Round Up, Round Down, or None.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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 itemStructures-Component-SubstituteComponent-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/itemStructures-Component-SubstituteComponent-SubstituteComponentDFF-item-response"
    },
    "x-cardinality":"1"
}

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 : itemStructures-Component-SubstituteComponent-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_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/itemStructures/{BillSequenceId}/child/Component/{ComponentSequenceId}/child/SubstituteComponent/{SubstituteComponentSequenceId}/child/SubstituteComponentDFF

Parameters:

• BillSequenceId: $request.path.BillSequenceId
• ComponentSequenceId: $request.path.ComponentSequenceId
• SubstituteComponentSequenceId: $request.path.SubstituteComponentSequenceId

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

Back to Top