Jump to

• Request
• Response
• Examples

Create one affected item

post

/fscmRestApi/resources/11.13.18.05/productChangeOrders/{ChangeId}/child/changeRequestAffectedItems

Request

Path Parameters

• ChangeId(required): integer
  Value that uniquely identifies the change.

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• changeRequestAffectedItemsDFF: array Flexfields for Affected Items in Change Requests
  Title: Flexfields for Affected Items in Change Requests

  The Flexfields for Affected Items in Change Requests resource gets the flexfields for affected items used in change requests.
• ItemId: integer (int64)
  Value that uniquely identifies an item in a change request.
• ItemNumber: string
  Maximum Length: 255

  Number that identifies the item.
• LifecycleStateId: integer (int64)
  Value that uniquely identifies the lifecycle phase of the affected item in the change request.
• ObjectVersionNumber: integer (int32)
  Number that identifies the version of the affected item in the change request.
• Revision: string
  Maximum Length: 255

  Revision of the item.
• RevisionId: integer (int64)
  Value that uniquely identifies a revision of a item in a change request.
• SequenceNumber: integer
  Number that uniquely identifies the sequence of an affected item in a change request.

{
    "type":"object",
    "properties":{
        "changeRequestAffectedItemsDFF":{
            "title":"Flexfields for Affected Items in Change Requests",
            "type":"array",
            "description":"The Flexfields for Affected Items in Change Requests resource gets the flexfields for affected items used in change requests.",
            "items":{
                "$ref":"#/components/schemas/productChangeOrders-changeRequestAffectedItems-changeRequestAffectedItemsDFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "ItemNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Revision":{
            "maxLength":"255",
            "type":"string",
            "description":"Revision of the item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number that identifies the version of the affected item in the change request.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"Number that uniquely identifies the sequence of an affected item in a change request.",
            "nullable":false
        },
        "LifecycleStateId":{
            "type":"integer",
            "description":"Value that uniquely identifies the lifecycle phase of the affected item in the change request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies an item in a change request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "RevisionId":{
            "type":"integer",
            "description":"Value that uniquely identifies a revision of a item in a change request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : Flexfields for Affected Items in Change Requests

Type: array

Title: Flexfields for Affected Items in Change Requests

The Flexfields for Affected Items in Change Requests resource gets the flexfields for affected items used in change requests.

Show Source

• Array of: object productChangeOrders-changeRequestAffectedItems-changeRequestAffectedItemsDFF-item-post-request

{
    "title":"Flexfields for Affected Items in Change Requests",
    "type":"array",
    "description":"The Flexfields for Affected Items in Change Requests resource gets the flexfields for affected items used in change requests.",
    "items":{
        "$ref":"#/components/schemas/productChangeOrders-changeRequestAffectedItems-changeRequestAffectedItemsDFF-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : productChangeOrders-changeRequestAffectedItems-changeRequestAffectedItemsDFF-item-post-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Descriptive flexfield context name for change lines.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment
• SubjectInternalName: string
  Maximum Length: 30

  Internal name of the change line flexfield.

{
    "type":"object",
    "properties":{
        "SubjectInternalName":{
            "maxLength":"30",
            "type":"string",
            "description":"Internal name of the change line flexfield.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "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":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"30",
            "type":"string",
            "description":"Descriptive flexfield context name for change lines.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : productChangeOrders-changeRequestAffectedItems-item-response

Type: object

Show Source

• ChangeLineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the affected item in a change request.
• changeRequestAffectedItemsDFF: array Flexfields for Affected Items in Change Requests
  Title: Flexfields for Affected Items in Change Requests

  The Flexfields for Affected Items in Change Requests resource gets the flexfields for affected items used in change requests.
• ItemId: integer (int64)
  Value that uniquely identifies an item in a change request.
• ItemNumber: string
  Maximum Length: 255

  Number that identifies the item.
• LifecycleStateId: integer (int64)
  Value that uniquely identifies the lifecycle phase of the affected item in the change request.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Number that identifies the version of the affected item in the change request.
• Revision: string
  Maximum Length: 255

  Revision of the item.
• RevisionId: integer (int64)
  Value that uniquely identifies a revision of a item in a change request.
• SequenceNumber: integer
  Number that uniquely identifies the sequence of an affected item in a change request.

{
    "type":"object",
    "properties":{
        "changeRequestAffectedItemsDFF":{
            "title":"Flexfields for Affected Items in Change Requests",
            "type":"array",
            "description":"The Flexfields for Affected Items in Change Requests resource gets the flexfields for affected items used in change requests.",
            "items":{
                "$ref":"#/components/schemas/productChangeOrders-changeRequestAffectedItems-changeRequestAffectedItemsDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "ChangeLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the affected item in a change request.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Revision":{
            "maxLength":"255",
            "type":"string",
            "description":"Revision of the item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number that identifies the version of the affected item in the change request.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"Number that uniquely identifies the sequence of an affected item in a change request.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LifecycleStateId":{
            "type":"integer",
            "description":"Value that uniquely identifies the lifecycle phase of the affected item in the change request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies an item in a change request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RevisionId":{
            "type":"integer",
            "description":"Value that uniquely identifies a revision of a item in a change request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Flexfields for Affected Items in Change Requests

Type: array

Title: Flexfields for Affected Items in Change Requests

The Flexfields for Affected Items in Change Requests resource gets the flexfields for affected items used in change requests.

Show Source

• Array of: object productChangeOrders-changeRequestAffectedItems-changeRequestAffectedItemsDFF-item-response

{
    "title":"Flexfields for Affected Items in Change Requests",
    "type":"array",
    "description":"The Flexfields for Affected Items in Change Requests resource gets the flexfields for affected items used in change requests.",
    "items":{
        "$ref":"#/components/schemas/productChangeOrders-changeRequestAffectedItems-changeRequestAffectedItemsDFF-item-response"
    },
    "x-cardinality":"1"
}

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 : productChangeOrders-changeRequestAffectedItems-changeRequestAffectedItemsDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Descriptive flexfield context name for change lines.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment
• ChangeLineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the change line associated with the flexible fields.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SubjectInternalName: string
  Maximum Length: 30

  Internal name of the change line flexfield.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ChangeLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the change line associated with the flexible fields.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "SubjectInternalName":{
            "maxLength":"30",
            "type":"string",
            "description":"Internal name of the change line flexfield.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "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":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"30",
            "type":"string",
            "description":"Descriptive flexfield context name for change lines.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "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

changeRequestAffectedItemsDFF

Operation: /fscmRestApi/resources/11.13.18.05/productChangeOrders/{ChangeId}/child/changeRequestAffectedItems/{ChangeLineId}/child/changeRequestAffectedItemsDFF

Parameters:

• ChangeId: $request.path.ChangeId
• ChangeLineId2: $request.path.ChangeLineId2

The Flexfields for Affected Items in Change Requests resource gets the flexfields for affected items used in change requests.

Back to Top

Examples

This example describes how to create one affected item.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/productChangeOrders/ChangeId/child/changeRequestAffectedItems"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
    "ItemId": 300100160346280,
    "RevisionId": 300100160346281
}

Example Response Body

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

{
    "ChangeLineId": 300100160366824,
    "ObjectVersionNumber": 1,
    "LifecycleStateId": null,
    "SequenceNumber": 20,
    "ItemId": 300100160346280,
    "RevisionId": 300100160346281,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100160346251/child/changeRequestAffectedItems/300100160366824",
            "name": "changeRequestAffectedItems",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100160346251/child/changeRequestAffectedItems/300100160366824",
            "name": "changeRequestAffectedItems",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100160346251",
            "name": "productChangeOrders",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100160346251/child/changeRequestAffectedItems/300100160366824/child/changeRequestAffectedItemsDFF",
            "name": "changeRequestAffectedItemsDFF",
            "kind": "collection"
        }
    ]
}

Back to Top