Jump to

• Request
• Response

Update one Affected Item Structure Component Reference Designator change order

patch

/fscmRestApi/resources/11.13.18.05/productChangeOrdersV2/{productChangeOrdersV2UniqID}/child/changeOrderAffectedObject/{changeOrderAffectedObjectUniqID}/child/changeOrderAffectedItemStructure/{changeOrderAffectedItemStructureUniqID}/child/affectedItemStructureComponent/{ComponentSequenceId}/child/affectedItemReferenceDesignator/{affectedItemReferenceDesignatorUniqID}

Request

Path Parameters

• ComponentSequenceId(required): integer
  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=
• affectedItemReferenceDesignatorUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Change Order Affected Item Reference Designators resource and used to uniquely identify an instance of Change Order Affected Item Reference Designators. The client should not generate the hash key value. Instead, the client should query on the Change Order Affected Item Reference Designators collection resource in order to navigate to a specific instance of Change Order Affected Item Reference Designators to get the hash key.
• changeOrderAffectedItemStructureUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Change Order Affected Item Structures resource and used to uniquely identify an instance of Change Order Affected Item Structures. The client should not generate the hash key value. Instead, the client should query on the Change Order Affected Item Structures collection resource in order to navigate to a specific instance of Change Order Affected Item Structures to get the hash key.
• changeOrderAffectedObjectUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Change Order Affected Objects resource and used to uniquely identify an instance of Change Order Affected Objects. The client should not generate the hash key value. Instead, the client should query on the Change Order Affected Objects collection resource in order to navigate to a specific instance of Change Order Affected Objects to get the hash key.
• productChangeOrdersV2UniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Product Change Orders Version 2 resource and used to uniquely identify an instance of Product Change Orders Version 2. The client should not generate the hash key value. Instead, the client should query on the Product Change Orders Version 2 collection resource in order to navigate to a specific instance of Product Change Orders Version 2 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

• affectedItemReferenceDesignatorDFF: array affectedItemReferenceDesignatorDFF
• Description: string
  Description of the affected object structure component redline reference designator designator
• ReferenceDesignator: string
  The redlined value for the affected object structure component reference designator.

{
    "type":"object",
    "properties":{
        "ReferenceDesignator":{
            "type":"string",
            "description":"The redlined value for the affected object structure component reference designator.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "affectedItemReferenceDesignatorDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/productChangeOrdersV2-changeOrderAffectedObject-changeOrderAffectedItemStructure-affectedItemStructureComponent-affectedItemReferenceDesignator-affectedItemReferenceDesignatorDFF-item-patch-request"
            }
        },
        "Description":{
            "type":"string",
            "description":"Description of the affected object structure component redline reference designator designator",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : affectedItemReferenceDesignatorDFF

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/productChangeOrdersV2-changeOrderAffectedObject-changeOrderAffectedItemStructure-affectedItemStructureComponent-affectedItemReferenceDesignator-affectedItemReferenceDesignatorDFF-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context

  Maximum Length: 30
• __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",
            "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 : productChangeOrdersV2-changeOrderAffectedObject-changeOrderAffectedItemStructure-affectedItemStructureComponent-affectedItemReferenceDesignator-item-response

Type: object

Show Source

• ACDType: integer
  Read Only: true

  Value that indicates if the affected object structure component redline reference designator is being added, modified, or deleted through a change line.
• ACDTypeValue: string
  Read Only: true

  Value that indicates if the affected object structure component is being added, modified, or deleted through a change line.
• affectedItemReferenceDesignatorDFF: array affectedItemReferenceDesignatorDFF
• ChangeLineId: integer (int64)
  Read Only: true

  Default Value: -1

  Value that uniquely identifies the change line associated with the affected object structure component.
• ChangeNotice: string
  Read Only: true

  Value that uniquely identifies the change notice for an affected object structure component reference designator
• CreationDateTime: string (date-time)
  Read Only: true

  Date and time when the affected object structure component reference designator was created.
• Description: string
  Description of the affected object structure component redline reference designator designator
• LastUpdateDateTime: string (date-time)
  Read Only: true

  Date and time when the affected object structure component reference designator was most recently updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ReferenceDesignator: string
  The redlined value for the affected object structure component reference designator.
• ReferenceDesignatorSequenceId: integer
  Read Only: true

  Value that uniquely identifies the redline reference designator. This attribute is read-only and isn't required for an update operation.

{
    "type":"object",
    "properties":{
        "ACDTypeValue":{
            "type":"string",
            "description":"Value that indicates if the affected object structure component is being added, modified, or deleted through a change line.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ChangeLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the change line associated with the affected object structure component.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "default":-1,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ACDType":{
            "type":"integer",
            "description":"Value that indicates if the affected object structure component redline reference designator is being added, modified, or deleted through a change line.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreationDateTime":{
            "type":"string",
            "description":"Date and time when the affected object structure component reference designator was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Description":{
            "type":"string",
            "description":"Description of the affected object structure component redline reference designator designator",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateDateTime":{
            "type":"string",
            "description":"Date and time when the affected object structure component reference designator was most recently updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ChangeNotice":{
            "type":"string",
            "description":"Value that uniquely identifies the change notice for an affected object structure component reference designator",
            "nullable":true,
            "readOnly":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"
            }
        },
        "ReferenceDesignator":{
            "type":"string",
            "description":"The redlined value for the affected object structure component reference designator.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "affectedItemReferenceDesignatorDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/productChangeOrdersV2-changeOrderAffectedObject-changeOrderAffectedItemStructure-affectedItemStructureComponent-affectedItemReferenceDesignator-affectedItemReferenceDesignatorDFF-item-response"
            }
        },
        "ReferenceDesignatorSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the redline reference designator. This attribute is read-only and isn't required for an update operation.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : affectedItemReferenceDesignatorDFF

Type: array

Show Source

• Array of: object productChangeOrdersV2-changeOrderAffectedObject-changeOrderAffectedItemStructure-affectedItemStructureComponent-affectedItemReferenceDesignator-affectedItemReferenceDesignatorDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/productChangeOrdersV2-changeOrderAffectedObject-changeOrderAffectedItemStructure-affectedItemStructureComponent-affectedItemReferenceDesignator-affectedItemReferenceDesignatorDFF-item-response"
    }
}

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 : productChangeOrdersV2-changeOrderAffectedObject-changeOrderAffectedItemStructure-affectedItemStructureComponent-affectedItemReferenceDesignator-affectedItemReferenceDesignatorDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context

  Maximum Length: 30
• __FLEX_Context_DisplayValue: string
  Title: Context
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RefDesigSequenceId: integer (int64)

{
    "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
        },
        "RefDesigSequenceId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context",
            "maxLength":30,
            "type":"string",
            "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"
    }
}

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

Links

affectedItemReferenceDesignatorDFF

Operation: /fscmRestApi/resources/11.13.18.05/productChangeOrdersV2/{productChangeOrdersV2UniqID}/child/changeOrderAffectedObject/{changeOrderAffectedObjectUniqID}/child/changeOrderAffectedItemStructure/{changeOrderAffectedItemStructureUniqID}/child/affectedItemStructureComponent/{ComponentSequenceId}/child/affectedItemReferenceDesignator/{affectedItemReferenceDesignatorUniqID}/child/affectedItemReferenceDesignatorDFF

Parameters:

• ComponentSequenceId: $request.path.ComponentSequenceId
• affectedItemReferenceDesignatorUniqID: $request.path.affectedItemReferenceDesignatorUniqID
• changeOrderAffectedItemStructureUniqID: $request.path.changeOrderAffectedItemStructureUniqID
• changeOrderAffectedObjectUniqID: $request.path.changeOrderAffectedObjectUniqID
• productChangeOrdersV2UniqID: $request.path.productChangeOrdersV2UniqID

Back to Top