Jump to

• Request
• Response

Get one Affected Item structure change order

get

/fscmRestApi/resources/11.13.18.05/productChangeOrdersV2/{productChangeOrdersV2UniqID}/child/changeOrderAffectedObject/{changeOrderAffectedObjectUniqID}/child/changeOrderAffectedItemStructure/{changeOrderAffectedItemStructureUniqID}

Request

Path Parameters

• 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.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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-item-response

Type: object

Show Source

• affectedItemStructureComponent: array Change Order Affected Item Structure Components
  Title: Change Order Affected Item Structure Components

  The Structure Components resource gets the components in a structure of an affected item.
• AlternateBomDesignator: string
  Title: Name

  Maximum Length: 80

  Value that identifies the alternate bill of material designator of the item.
• BillSequenceId: integer
  Value that uniquely identifies the structure associated with the item.
• ChangeId: integer
  Value that uniquely identifies the change.
• CommonBillSequenceId: integer
  The common bill sequence ID of the item structure.
• CommonOrganizationCode: string
  Maximum Length: 255

  The common organization code of the item structure
• CommonOrganizationId: integer
  The common organization ID of the item structure.
• CreationDateTime: string (date-time)
  Read Only: true

  Date when the change object was created.
• EffectivityControl: integer
  Title: Effectivity Control

  The effectivity control of the item structure
• LastUpdateDateTime: string (date-time)
  Read Only: true

  Date when the change object was updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SourceBillSequenceId: integer
  The source bill sequence ID of the item structure.

{
    "type":"object",
    "properties":{
        "ChangeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the change.",
            "nullable":true,
            "x-queryable":true
        },
        "CommonOrganizationId":{
            "type":"integer",
            "description":"The common organization ID of the item structure.",
            "nullable":true,
            "x-queryable":false
        },
        "CommonBillSequenceId":{
            "type":"integer",
            "description":"The common bill sequence ID of the item structure.",
            "nullable":false,
            "x-queryable":true
        },
        "affectedItemStructureComponent":{
            "title":"Change Order Affected Item Structure Components",
            "type":"array",
            "description":"The Structure Components resource gets the components in a structure of an affected item.",
            "items":{
                "$ref":"#/components/schemas/productChangeOrdersV2-changeOrderAffectedObject-changeOrderAffectedItemStructure-affectedItemStructureComponent-item-response"
            }
        },
        "CreationDateTime":{
            "type":"string",
            "description":"Date when the change object was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDateTime":{
            "type":"string",
            "description":"Date when the change object was updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CommonOrganizationCode":{
            "maxLength":255,
            "type":"string",
            "description":"The common organization code of the item structure",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EffectivityControl":{
            "title":"Effectivity Control",
            "type":"integer",
            "description":"The effectivity control of the item structure",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AlternateBomDesignator":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"Value that identifies the alternate bill of material designator of the item.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceBillSequenceId":{
            "type":"integer",
            "description":"The source bill sequence ID of the item structure.",
            "nullable":false,
            "x-queryable":true
        },
        "BillSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the structure associated with the item.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Change Order Affected Item Structure Components

Type: array

Title: Change Order Affected Item Structure Components

The Structure Components resource gets the components in a structure of an affected item.

Show Source

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

{
    "title":"Change Order Affected Item Structure Components",
    "type":"array",
    "description":"The Structure Components resource gets the components in a structure of an affected item.",
    "items":{
        "$ref":"#/components/schemas/productChangeOrdersV2-changeOrderAffectedObject-changeOrderAffectedItemStructure-affectedItemStructureComponent-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-item-response

Type: object

Show Source

• ACDTypeCode: integer
  Title: Change Action

  Read Only: true

  Default Value: 1

  Abbreviation that indicates whether the component is being added, changed, or deleted through a change line.
• affectedItemReferenceDesignator: array Change Order Affected Item Reference Designators
  Title: Change Order Affected Item Reference Designators

  The Reference Designators resource manages the details of a reference designator.
• affectedItemSubstituteComponent: array Change Order Affected Item Substitute Components
  Title: Change Order Affected Item Substitute Components

  The Substitute Components resource manages the details of a substitute component.
• AlternateBOMDesignator: string
  Read Only: true

  Maximum Length: 255

  Value that identifies the alternate bill of material designator of the item.
• BillSequenceId: integer
  Read Only: true

  Value that uniquely identifies the structure associated with the item.
• ChangeId: integer
  Value that uniquely identifies the change affected item structure component
• ChangeLineId: integer
  Default Value: -1

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

  Maximum Length: 255

  Value that uniquely identifies the change object.
• ComponentItemClass: string
  Read Only: true

  Maximum Length: 255

  Class of the component item. This attribute is read-only and isn't required for an update operation.
• ComponentItemId: string
  Maximum Length: 240

  Value that uniquely identifies the item associated with the component.
• ComponentItemNumber: string
  The component item number of the structure component
• ComponentQuantity: number
  Title: Quantity

  Default Value: 1

  Quantity value of the component that's used to build the structure.
• ComponentRemarks: string
  Title: Comments

  Maximum Length: 240

  Comments entered by the user for the affected item structure component.
• ComponentSequenceId: integer
  Read Only: true

  Value that uniquely identifies the component that's currently in the affected item structure component
• ComponentYieldFactor: number
  Title: Yield

  Default Value: 1

  Planned or actual output of a process, relevant to the quantity. The yield includes a loss, an increase, or no change in the planned or actual output quantity of affected item structure component
• CreationDateTime: string (date-time)
  Read Only: true

  Date when the affected item structure component was added to the change object.
• DisableDateTime: string (date-time)
  Date when the component was disabled or redline component
• EffectivityDateTime: string (date-time)
  Date when the affected item structure component became effective to be used in the structure.
• FindNumber: integer
  Title: Find Number

  Default Value: 1

  Finds the Find Number of the component in the item structure.
• ImplementationDateTime: string (date-time)
  Read Only: true

  Date when the affected item structure component was implemented via change order
• ItemSequenceNumber: number
  The component item sequence number of the structure component
• LastUpdateDateTime: string (date-time)
  Read Only: true

  Date when affected item structure component was last updated
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OldComponentSequenceId: integer
  Read Only: true

  Replaced component sequence ID in the affected item structure
• OrganizationCode: string
  Maximum Length: 255

  Abbreviation that identifies the organization of the change object.
• OrganizationId: string
  Maximum Length: 240

  Value that uniquely identifies the organization of the change object.
• PrimaryUomCode: string
  Title: Component UOM

  Maximum Length: 30

  Value that indicates the unit of measure of the affected item structure component as used in a bill of materials.
• PrimaryUOMValue: string
  Maximum Length: 255

  Primary UOM value of a structure component
• QuantityRelatedFlag: boolean
  Title: Quantity Related

  Default Value: true

  Quantity of the redline substitute component
• ReplacedBy: string
  Maximum Length: 255

  Value that identifies the name of the item that replaced another item.
• ReplacedByFindNumber: integer
  Finds the Find Number of the replaced component in the item structure.
• Replaces: string
  Read Only: true

  Maximum Length: 255

  Value that identifies the name of the item that was replaced by another item.
• SuggestedOperationSequence: integer
  Title: Suggested Operation Sequence

  Suggested operation sequence of the component in the item structure.
• UsePlaceholderFlag: boolean
  Title: Use Placeholder

  Value that identifies if an option class holds a large set of options. The values are true or false. The default value is Null.

{
    "type":"object",
    "properties":{
        "ComponentItemId":{
            "maxLength":240,
            "type":"string",
            "description":"Value that uniquely identifies the item associated with the component.",
            "nullable":false,
            "x-queryable":true
        },
        "PrimaryUomCode":{
            "title":"Component UOM",
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates the unit of measure of the affected item structure component as used in a bill of materials.",
            "nullable":false,
            "x-queryable":true
        },
        "ImplementationDateTime":{
            "type":"string",
            "description":"Date when the affected item structure component was implemented via change order",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDateTime":{
            "type":"string",
            "description":"Date when affected item structure component was last updated",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ComponentItemClass":{
            "maxLength":255,
            "type":"string",
            "description":"Class of the component item. This attribute is read-only and isn't required for an update operation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OldComponentSequenceId":{
            "type":"integer",
            "description":"Replaced component sequence ID in the affected item structure",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "maxLength":240,
            "type":"string",
            "description":"Value that uniquely identifies the organization of the change object.",
            "nullable":true,
            "x-queryable":true
        },
        "AlternateBOMDesignator":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the alternate bill of material designator of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ComponentQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity value of the component that's used to build the structure.",
            "nullable":false,
            "default":1,
            "x-queryable":true
        },
        "affectedItemSubstituteComponent":{
            "title":"Change Order Affected Item Substitute Components",
            "type":"array",
            "description":"The Substitute Components resource manages the details of a substitute component.",
            "items":{
                "$ref":"#/components/schemas/productChangeOrdersV2-changeOrderAffectedObject-changeOrderAffectedItemStructure-affectedItemStructureComponent-affectedItemSubstituteComponent-item-response"
            }
        },
        "ReplacedBy":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the name of the item that replaced another item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ReplacedByFindNumber"
                ]
            },
            "x-queryable":true
        },
        "FindNumber":{
            "title":"Find Number",
            "type":"integer",
            "description":"Finds the Find Number of the component in the item structure.",
            "nullable":false,
            "default":1,
            "x-queryable":true
        },
        "QuantityRelatedFlag":{
            "title":"Quantity Related",
            "type":"boolean",
            "description":"Quantity of the redline substitute component",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the organization of the change object.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ComponentItemNumber":{
            "type":"string",
            "description":"The component item number of the structure component",
            "nullable":true,
            "x-queryable":false
        },
        "ComponentYieldFactor":{
            "title":"Yield",
            "type":"number",
            "description":"Planned or actual output of a process, relevant to the quantity. The yield includes a loss, an increase, or no change in the planned or actual output quantity of affected item structure component",
            "nullable":false,
            "default":1,
            "x-queryable":true
        },
        "ReplacedByFindNumber":{
            "type":"integer",
            "description":"Finds the Find Number of the replaced component in the item structure.",
            "nullable":true,
            "x-queryable":false
        },
        "ComponentRemarks":{
            "title":"Comments",
            "maxLength":240,
            "type":"string",
            "description":"Comments entered by the user for the affected item structure component.",
            "nullable":true,
            "x-queryable":true
        },
        "BillSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the structure associated with the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemSequenceNumber":{
            "type":"number",
            "description":"The component item sequence number of the structure component",
            "nullable":true,
            "x-queryable":true
        },
        "ChangeLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the change line associated with the affected item structure component.",
            "nullable":true,
            "default":-1,
            "x-queryable":true
        },
        "EffectivityDateTime":{
            "type":"string",
            "description":"Date when the affected item structure component became effective to be used in the structure.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryUOMValue":{
            "maxLength":255,
            "type":"string",
            "description":"Primary UOM value of a structure component",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DisableDateTime":{
            "type":"string",
            "description":"Date when the component was disabled or redline component",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "UsePlaceholderFlag":{
            "title":"Use Placeholder",
            "type":"boolean",
            "description":"Value that identifies if an option class holds a large set of options. The values are true or false. The default value is Null.",
            "nullable":true,
            "x-queryable":true
        },
        "Replaces":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the name of the item that was replaced by another item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SuggestedOperationSequence":{
            "title":"Suggested Operation Sequence",
            "type":"integer",
            "description":"Suggested operation sequence of the component in the item structure.",
            "nullable":true,
            "x-queryable":true
        },
        "ComponentSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the component that's currently in the affected item structure component",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the change affected item structure component",
            "nullable":true,
            "x-queryable":true
        },
        "ACDTypeCode":{
            "title":"Change Action",
            "type":"integer",
            "description":"Abbreviation that indicates whether the component is being added, changed, or deleted through a change line.",
            "nullable":false,
            "readOnly":true,
            "default":1,
            "x-queryable":true
        },
        "CreationDateTime":{
            "type":"string",
            "description":"Date when the affected item structure component was added to the change object.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "affectedItemReferenceDesignator":{
            "title":"Change Order Affected Item Reference Designators",
            "type":"array",
            "description":"The Reference Designators resource manages the details of a reference designator.",
            "items":{
                "$ref":"#/components/schemas/productChangeOrdersV2-changeOrderAffectedObject-changeOrderAffectedItemStructure-affectedItemStructureComponent-affectedItemReferenceDesignator-item-response"
            }
        },
        "ChangeNotice":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the change object.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Change Order Affected Item Reference Designators

Type: array

Title: Change Order Affected Item Reference Designators

The Reference Designators resource manages the details of a reference designator.

Show Source

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

{
    "title":"Change Order Affected Item Reference Designators",
    "type":"array",
    "description":"The Reference Designators resource manages the details of a reference designator.",
    "items":{
        "$ref":"#/components/schemas/productChangeOrdersV2-changeOrderAffectedObject-changeOrderAffectedItemStructure-affectedItemStructureComponent-affectedItemReferenceDesignator-item-response"
    }
}

Nested Schema : Change Order Affected Item Substitute Components

Type: array

Title: Change Order Affected Item Substitute Components

The Substitute Components resource manages the details of a substitute component.

Show Source

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

{
    "title":"Change Order Affected Item Substitute Components",
    "type":"array",
    "description":"The Substitute Components resource manages the details of a substitute component.",
    "items":{
        "$ref":"#/components/schemas/productChangeOrdersV2-changeOrderAffectedObject-changeOrderAffectedItemStructure-affectedItemStructureComponent-affectedItemSubstituteComponent-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-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."
        }
    }
}

Nested Schema : productChangeOrdersV2-changeOrderAffectedObject-changeOrderAffectedItemStructure-affectedItemStructureComponent-affectedItemSubstituteComponent-item-response

Type: object

Show Source

• ACDType: integer
  Read Only: true

  Value that indicates the type of redline on a substitute component to determine whether the component is being added, modified, or deleted.
• ACDTypeValue: string
  Read Only: true

  Value that indicates if the substitute component is being added, modified, or deleted through a change order object
• affectedItemSubstituteComponentDFF: array affectedItemSubstituteComponentDFF
• CreationDateTime: string (date-time)
  Read Only: true

  Date when redline was made to the redlined substitute component was made
• EnforceIntegerRequirementsValue: string
  Maximum Length: 255

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

  Date when redline was made to the redline substitute component was updated
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PrimaryUOMValue: string
  Read Only: true

  Maximum Length: 255

  Value that indicates the unit of measure of the affected item structure's substitute component.
• Priority: integer
  Value that determines the priority of the substitute component.
• Quantity: number
  Quantity of the redline substitute component
• SubstituteComponentId: integer
  Value that uniquely identifies the item of the redlined substitute component on change order
• SubstituteComponentItemNumber: string
  Number that identifies the item of the redlined substitute component.
• SubstituteComponentSequenceId: integer
  Value that uniquely identifies the redlined substitute component in a structure. 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 substitute component is being added, modified, or deleted through a change order object",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateDateTime":{
            "type":"string",
            "description":"Date when redline was made to the redline substitute component was updated",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Priority":{
            "type":"integer",
            "description":"Value that determines the priority of the substitute component.",
            "nullable":true,
            "x-queryable":true
        },
        "SubstituteComponentSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the redlined substitute component in a structure. This attribute is read-only and isn't required for an update operation.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryUOMValue":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the unit of measure of the affected item structure's substitute component.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of the redline substitute component",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "affectedItemSubstituteComponentDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/productChangeOrdersV2-changeOrderAffectedObject-changeOrderAffectedItemStructure-affectedItemStructureComponent-affectedItemSubstituteComponent-affectedItemSubstituteComponentDFF-item-response"
            }
        },
        "ACDType":{
            "type":"integer",
            "description":"Value that indicates the type of redline on a substitute component to determine whether the component is being added, modified, or deleted.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreationDateTime":{
            "type":"string",
            "description":"Date when redline was made to the redlined substitute component was made",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "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 redlined substitute component.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "SubstituteComponentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item of the redlined substitute component on change order",
            "nullable":false,
            "x-queryable":true
        },
        "EnforceIntegerRequirementsValue":{
            "maxLength":255,
            "type":"string",
            "description":"Generates the demand with quantity specified in integers. It's used in supply chain planning. The values are Round Up, Round Down, or None.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : affectedItemSubstituteComponentDFF

Type: array

Show Source

• Array of: object productChangeOrdersV2-changeOrderAffectedObject-changeOrderAffectedItemStructure-affectedItemStructureComponent-affectedItemSubstituteComponent-affectedItemSubstituteComponentDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/productChangeOrdersV2-changeOrderAffectedObject-changeOrderAffectedItemStructure-affectedItemStructureComponent-affectedItemSubstituteComponent-affectedItemSubstituteComponentDFF-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-affectedItemSubstituteComponent-affectedItemSubstituteComponentDFF-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.
• SubCompSequenceId: 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
        },
        "SubCompSequenceId":{
            "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"
    }
}

Links

CommonOrganizationCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/inventoryOrganizationsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: CommonOrganizationCode; Target Attribute: OrganizationCode
• Display Attribute: OrganizationCode, OrganizationId

affectedItemStructureComponent

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

Parameters:

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

The Structure Components resource gets the components in a structure of an affected item.

Back to Top