Jump to

• Request
• Response
• Examples

Create multiple rows or add multiple affected items to change request.

post

/fscmRestApi/resources/11.13.18.05/productChangeRequests/{productChangeRequestsUniqID}/child/changeRequestAffectedObject

Request

Path Parameters

• productChangeRequestsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Product Change Requests resource and used to uniquely identify an instance of Product Change Requests. The client should not generate the hash key value. Instead, the client should query on the Product Change Requests collection resource in order to navigate to a specific instance of Product Change Requests 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

• changeRequestAffectedObjectDFF: array changeRequestAffectedObjectDFF
• ItemId: integer (int64)
  The item ID for the change request affected object.
• ItemNumber: string
  Maximum Length: 255

  Number that identifies the item corresponding to the component.
• Revision: string
  Maximum Length: 255

  The revision for change request affected object
• RevisionId: integer (int64)
  The revision ID for the change request affected object.
• SequenceNumber: integer
  The sequence number for change request affected object

{
    "type":"object",
    "properties":{
        "SequenceNumber":{
            "type":"integer",
            "description":"The sequence number for change request affected object",
            "nullable":false
        },
        "changeRequestAffectedObjectDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/productChangeRequests-changeRequestAffectedObject-changeRequestAffectedObjectDFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "ItemNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the item corresponding to the component.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Revision":{
            "maxLength":255,
            "type":"string",
            "description":"The revision for change request affected object",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ItemId":{
            "type":"integer",
            "description":"The item ID for the change request affected object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RevisionId":{
            "type":"integer",
            "description":"The revision ID for the change request affected object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : changeRequestAffectedObjectDFF

Type: array

Show Source

• Array of: object productChangeRequests-changeRequestAffectedObject-changeRequestAffectedObjectDFF-item-post-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/productChangeRequests-changeRequestAffectedObject-changeRequestAffectedObjectDFF-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : productChangeRequests-changeRequestAffectedObject-changeRequestAffectedObjectDFF-item-post-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30
• __FLEX_Context_DisplayValue: string
  Title: Context Segment
• SubjectInternalName: string
  Maximum Length: 30

{
    "type":"object",
    "properties":{
        "SubjectInternalName":{
            "maxLength":30,
            "type":"string",
            "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",
            "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_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(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 : productChangeRequests-changeRequestAffectedObject-item-response

Type: object

Show Source

• ChangeLineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the change line associated with the component.
• changeRequestAffectedObjectDFF: array changeRequestAffectedObjectDFF
• ItemId: integer (int64)
  The item ID for the change request affected object.
• ItemNumber: string
  Maximum Length: 255

  Number that identifies the item corresponding to the component.
• links: array Links
  Title: Links

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

  The revision for change request affected object
• RevisionId: integer (int64)
  The revision ID for the change request affected object.
• SequenceNumber: integer
  The sequence number for change request affected object

{
    "type":"object",
    "properties":{
        "ChangeLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the change line associated with the component.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the item corresponding to the component.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Revision":{
            "maxLength":255,
            "type":"string",
            "description":"The revision for change request affected object",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"The sequence number for change request affected object",
            "nullable":false,
            "x-queryable":true
        },
        "changeRequestAffectedObjectDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/productChangeRequests-changeRequestAffectedObject-changeRequestAffectedObjectDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ItemId":{
            "type":"integer",
            "description":"The item ID for the change request affected object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RevisionId":{
            "type":"integer",
            "description":"The revision ID for the change request affected object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : changeRequestAffectedObjectDFF

Type: array

Show Source

• Array of: object productChangeRequests-changeRequestAffectedObject-changeRequestAffectedObjectDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/productChangeRequests-changeRequestAffectedObject-changeRequestAffectedObjectDFF-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 : productChangeRequests-changeRequestAffectedObject-changeRequestAffectedObjectDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30
• __FLEX_Context_DisplayValue: string
  Title: Context Segment
• ChangeLineId: integer (int64)
  Read Only: true
• links: array Links
  Title: Links

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

{
    "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",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "SubjectInternalName":{
            "maxLength":30,
            "type":"string",
            "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",
            "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_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

changeRequestAffectedObjectDFF

Operation: /fscmRestApi/resources/11.13.18.05/productChangeRequests/{productChangeRequestsUniqID}/child/changeRequestAffectedObject/{changeRequestAffectedObjectUniqID}/child/changeRequestAffectedObjectDFF

Parameters:

• changeRequestAffectedObjectUniqID: $request.path.changeRequestAffectedObjectUniqID
• productChangeRequestsUniqID: $request.path.productChangeRequestsUniqID

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/productChangeRequests/productChangeRequestsUniqID/child/changeRequestAffectedObject"

Example Request Body

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

{
"ItemId": 300100547443355,
"RevisionId": 300100547443356
}

Example Response Body

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

{
    "items": [
        {
            "ChangeLineId": 300100548802345,
            "SequenceNumber": 10,
            "ItemId": 300100547443355,
            "RevisionId": 300100547443356,
            "ItemNumber": "VSPDTLA0001",
            "Revision": "A",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/productChangeRequests/300100548802284/child/changeRequestAffectedObject/300100548802345",
                    "name": "changeRequestAffectedObject",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/productChangeRequests/300100548802284/child/changeRequestAffectedObject/300100548802345",
                    "name": "changeRequestAffectedObject",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/productChangeRequests/300100548802284",
                    "name": "productChangeRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/productChangeRequests/300100548802284/child/changeRequestAffectedObject/300100548802345/child/changeRequestAffectedObjectDFF",
                    "name": "changeRequestAffectedObjectDFF",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/productChangeRequests/300100548802284/child/changeRequestAffectedObject",
            "name": "changeRequestAffectedObject",
            "kind": "collection"
        }
    ]
}

Back to Top