Jump to

• Request
• Response
• Examples

Create one approved manufacturer

post

/fscmRestApi/resources/11.13.18.05/productChangeOrders/{ChangeId}/child/AffectedObject/{AffectedObjectUniqID}/child/AffectedItemAML

Request

Path Parameters

• AffectedObjectUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Affected Objects resource and used to uniquely identify an instance of Affected Objects. The client should not generate the hash key value. Instead, the client should query on the Affected Objects collection resource in order to navigate to a specific instance of Affected Objects to get the hash key.
• ChangeId(required): integer
  Value that uniquely identifies the change.

Header Parameters

• Metadata-Context: string
  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: string
  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: string
  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

• InventoryItemId: integer
  Value that uniquely identifies an item.
• ItemNumber: string
  Maximum Length: 255

  Number that identifies the item.
• ItemRelationshipId: integer (int64)
  Value that uniquely identifies the relationship between an item and a manufacturer part.
• MasterOrganizationId: integer
  Value that uniquely identifies the master organization of the relationship.
• OrganizationCode: string
  Maximum Length: 255

  Abbreviation that identifies the organization of the item.
• OrganizationId: integer
  Value that uniquely identifies the organization of the relationship.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  Status of the relationship between the item and the manufacturer part. Valid values include approved, pending and obsolete. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Product Development Lookups task.
• TradingPartnerItemId: integer
  Value that uniquely identifies the manufacturer part number.

{
    "type":"object",
    "properties":{
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies an item.",
            "nullable":false
        },
        "ItemNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ItemRelationshipId":{
            "type":"integer",
            "description":"Value that uniquely identifies the relationship between an item and a manufacturer part.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            }
        },
        "MasterOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the master organization of the relationship.",
            "nullable":true
        },
        "OrganizationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the organization of the item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization of the relationship.",
            "nullable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"Status of the relationship between the item and the manufacturer part. Valid values include approved, pending and obsolete. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Product Development Lookups task.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Status"
                },
                "controlType":"choice"
            }
        },
        "TradingPartnerItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the manufacturer part number.",
            "nullable":true
        }
    }
}

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

Type: object

Show Source

• ACDTypeCode: string
  Read Only: true

  Value that indicates if the manufacturer is being added, modified, or deleted through a change line.
• ChangeLineId: integer (int64)
  Read Only: true

  Default Value: -1

  Value that uniquely identifies the change line corresponding to the item relationship.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the relationship between the item and the manufacturer part.
• CreationDate: string (date-time)
  Read Only: true

  Date when the relationship was created.
• Description: string
  Title: Relationship Description

  Read Only: true

  Maximum Length: 240

  Description of the relationship between item and the manufacturer part.
• EndDateActive: string (date-time)
  Title: End Date

  Read Only: true

  Date when the association between the item and the manufacturer part ends.
• ImplementationDate: string (date-time)
  Read Only: true

  Date of the relationship between an item and a manufacturer part was implemented.
• InventoryItemId: integer
  Value that uniquely identifies an item.
• ItemNumber: string
  Maximum Length: 255

  Number that identifies the item.
• ItemRelationshipId: integer (int64)
  Value that uniquely identifies the relationship between an item and a manufacturer part.
• ItemRelationshipType: string
  Title: Type

  Read Only: true

  Maximum Length: 30

  Default Value: MFG_PART_NUM

  Type of the relationship. Valid values are Manufacturer, Supplier, or Customer.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the relationship between item and a manufacturer part was most recently updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the item relationship.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login of the user who most recently updated the relationship.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MasterOrganizationId: integer
  Value that uniquely identifies the master organization of the relationship.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  Value that identifies the version of the approved manufacturer.
• OrganizationCode: string
  Maximum Length: 255

  Abbreviation that identifies the organization of the item.
• OrganizationId: integer
  Value that uniquely identifies the organization of the relationship.
• RedLineDescription: string
  Read Only: true

  New value of the description if it was updated through a change order.
• RedLineStatusCode: string
  Read Only: true

  New status if it was updated through a change order.
• StartDateActive: string (date-time)
  Title: Start Date

  Read Only: true

  Date when the association between the item and the manufacturer begins.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  Status of the relationship between the item and the manufacturer part. Valid values include approved, pending and obsolete. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Product Development Lookups task.
• TradingPartnerItem: string
  Read Only: true

  Maximum Length: 255

  Name or number of the manufacturer who manufactures the part associated with the item.
• TradingPartnerItemId: integer
  Value that uniquely identifies the manufacturer part number.
• TradingPartnerName: string
  Read Only: true

  Maximum Length: 255

  Name of the manufacturer who manufactures the part associated with the item.

{
    "type":"object",
    "properties":{
        "ACDTypeCode":{
            "type":"string",
            "description":"Value that indicates if the manufacturer is being added, modified, or deleted through a change line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the change line corresponding to the item relationship.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "default":-1,
            "x-hints":{
                "precision":20
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the relationship between the item and the manufacturer part.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the relationship was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Relationship Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the relationship between item and the manufacturer part.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the association between the item and the manufacturer part ends.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ImplementationDate":{
            "type":"string",
            "description":"Date of the relationship between an item and a manufacturer part was implemented.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies an item.",
            "nullable":false,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ItemRelationshipId":{
            "type":"integer",
            "description":"Value that uniquely identifies the relationship between an item and a manufacturer part.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ItemRelationshipType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of the relationship. Valid values are Manufacturer, Supplier, or Customer.",
            "nullable":false,
            "readOnly":true,
            "default":"MFG_PART_NUM",
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the relationship between item and a manufacturer part was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login of the user who most recently updated the relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the item relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MasterOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the master organization of the relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Value that identifies the version of the approved manufacturer.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the organization of the item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization of the relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "RedLineDescription":{
            "type":"string",
            "description":"New value of the description if it was updated through a change order.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PERSISTANT_ATTRIBUTE_NAME":"Description",
                "REDLINE_ATTR":"Y"
            },
            "x-queryable":true
        },
        "RedLineStatusCode":{
            "type":"string",
            "description":"New status if it was updated through a change order.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PERSISTANT_ATTRIBUTE_NAME":"StatusCode",
                "REDLINE_ATTR":"Y"
            },
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when the association between the item and the manufacturer begins.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"Status of the relationship between the item and the manufacturer part. Valid values include approved, pending and obsolete. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Product Development Lookups task.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Status"
                },
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TradingPartnerItem":{
            "maxLength":255,
            "type":"string",
            "description":"Name or number of the manufacturer who manufactures the part associated with the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TradingPartnerItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the manufacturer part number.",
            "nullable":true,
            "x-queryable":true
        },
        "TradingPartnerName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the manufacturer who manufactures the part associated with the item.",
            "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"
            }
        }
    }
}

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

Back to Top

Examples

This example describes how to create oone approved manufacturer.

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/AffectedObject/ChangeLineId/child/AffectedItemAML"

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.

{
"TradingPartnerItemId":300100159305994,
"StatusCode": "ORA_OBSOLETE"
}

Example Response Body

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

{
    "ChangeLineId": 300100159306174,
    "CreatedBy": "PIMQA",
    "CreationDate": "2018-06-27T06:39:22.001+00:00",
    "Description": null,
    "EndDateActive": null,
    "ImplementationDate": null,
    "InventoryItemId": 300100159305997,
    "ItemRelationshipId": 300100159309562,
    "ItemRelationshipType": "MFG_PART_NUM",
    "LastUpdateDate": "2018-06-27T06:39:23.095+00:00",
    "LastUpdateLogin": "6F999107E8637C0AE0537328F70AEE75",
    "LastUpdatedBy": "PIMQA",
    "MasterOrganizationId": 204,
    "ObjectVersionNumber": 1,
    "OrganizationId": null,
    "StartDateActive": "2018-06-27T06:32:32+00:00",
    "StatusCode": "ORA_OBSOLETE",
    "RedLineDescription": null,
    "RedLineStatusCode": null,
    "ACDTypeCode": "ADD",
    "TradingPartnerItemId": 300100159305994,
    "TradingPartnerName": null,
    "TradingPartnerItem": null,
	...
}

Back to Top