Create objects

post

/fscmRestApi/resources/11.13.18.05/genealogyObjects

Request

Header Parameters
  • 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".
  • 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.
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Abbreviation that identifies the internal location where the genealogy object instance is located.
  • Maximum Length: 80
    Description of the location context where the genealogy object instance is located.
  • Value that uniquely identifies the location where the genealogy object instance is located.
  • Value that uniquely identifies the customer who receives the genealogy object instance.
  • Name of the customer who receives the genealogy object instance.
  • Number of the customer who receives the genealogy object instance.
  • Value that uniquely identifies the customer site where the genealogy object instance is located.
  • Maximum Length: 255
    Name of the customer site where the genealogy object instance is located.
  • Maximum Length: 255
    Number of the customer site where the genealogy object instance is located.
  • Value that uniquely identifies the customer party site where the genealogy object instance is located.
  • Maximum Length: 255
    Name of the customer party site party where the genealogy object instance is located.
  • Maximum Length: 255
    Number of the customer party site where the genealogy object instance is located.
  • Maximum Length: 240
    Value that identifies the external location where the genealogy object instance is located. This location can be an external address location or a value that is not validated against any location types defined in the application.
  • Maximum Length: 150
    Value of the packing unit or license plate number that the transaction references. The packing unit or license plate reference is from an external source.
  • Value that uniquely identifies a genealogy object instance. This is a primary key.
  • Genealogy Transactions
    Title: Genealogy Transactions
    The Genealogy Transaction resource gets the transactions of a genealogy object that occur in the source applications.
  • Value that uniquely identifies the locator in a subinventory where the genealogy object instance is located.
  • Title: Item
    Value that uniquely identifies the item of the genealogy object instance. Either item identifier or item number can be used during the POST, PATCH, or GET actions.
  • Number that uniquely identifies the item of the genealogy object instance. Either item identifier or item number can be used during the POST, PATCH, or GET actions.
  • Maximum Length: 255
    Abbreviation that identifies the organization where the genealogy object instance is currently located. Either organization identifier or organization code can be provided during the POST, PATCH, or GET actions.
  • Value that uniquely identifier the organization where the genealogy object instance is currently located. Either organization identifier or organization code can be provided during the POST, PATCH, or GET actions.
  • Title: Lot
    Maximum Length: 80
    Number that uniquely identifies the lot that the genealogy object instance references to control the item in inventory. This attribute is used when the item is lot-controlled.
  • Abbreviation that identifies the organization that creates or operates the genealogy object instance. Either organization identifier or organization code can be provided during the POST, PATCH, or GET actions.
  • Value that uniquely identifies the organization that creates or operates the genealogy object instance. Either organization identifier or organization code can be provided during the POST, PATCH, or GET actions.
  • Date when the user created the genealogy object instance.
  • Number that identifies the document reference when the user created the genealogy object instance.
  • Value that identifies the document reference type when the user created the genealogy object instance. A list of accepted values is defined in the lookup type ORA_CSE_DOCUMENT_TYPE.
  • Quantity for the item that the genealogy object instance references. If the item is serial-controlled, then the quantity cannot exceed one.
  • Title: Serial Number
    Maximum Length: 80
    Number that uniquely identifies the serial that the genealogy object instance references. This attribute is used when the item is serial-controlled.
  • Name of the source application that is the origin of the genealogy object.
  • Value that uniquely identifies the source application that is the origin of the genealogy object. This attribute is read-only.
  • Description of the type of source application. This attribute is read-only.
  • Abbreviation that identifies the type of source application that is the origin of the genealogy object. A list of accepted values is defined in the lookup type ORA_CSE_SOURCE_SYSTEM_TYPE. Valid value is ORA_EXTERNAL.
  • Maximum Length: 30
    Value that identifies the subinventory where the genealogy object instance is located.
  • Value that uniquely identifies the supplier who ships the genealogy object instance.
  • Name of the supplier who ships the genealogy object instance.
  • Value that uniquely identifies the supplier site where the genealogy object instance is currently located.
  • Name of the supplier site where the genealogy object instance is currently located.
  • Title: UOM
    Maximum Length: 3
    Abbreviation that identifies the unit of measure for the quantity of the genealogy object instance. This attribute must use the same unit of measure that the item uses as the primary unit of measure.
  • Abbreviation that identifies the work center where the genealogy object instance is located. Either the work center identifier or the work center code can be provided during the POST, PATCH, or GET actions.
  • Title: Work Center
    Value that uniquely identifies the work center where the genealogy object instance is currently located. Either the work center identifier or the work center code can be provided during the POST, PATCH, or GET actions.
  • Value that uniquely identifies the work order at the location of the current genealogy object instance.
  • Maximum Length: 255
    Number that identifies the work order at the location of the current genealogy object instance.
  • Maximum Length: 255
    Name of the work order operation reference at the location of the current genealogy object instance.
  • Value that uniquely identifies the work order operation reference at the location of the current genealogy object instance.
Nested Schema : Genealogy Transactions
Type: array
Title: Genealogy Transactions
The Genealogy Transaction resource gets the transactions of a genealogy object that occur in the source applications.
Show Source
Nested Schema : schema
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : genealogyObjects-item-response
Type: object
Show Source
  • Abbreviation that identifies the internal location where the genealogy object instance is located.
  • Maximum Length: 80
    Description of the location context where the genealogy object instance is located.
  • Value that uniquely identifies the location where the genealogy object instance is located.
  • Read Only: true
    Maximum Length: 255
    Name of an internal location or value that uniquely identifies the address location where the genealogy object instance is located.
  • Value that uniquely identifies the customer who receives the genealogy object instance.
  • Name of the customer who receives the genealogy object instance.
  • Number of the customer who receives the genealogy object instance.
  • Value that uniquely identifies the customer site where the genealogy object instance is located.
  • Maximum Length: 255
    Name of the customer site where the genealogy object instance is located.
  • Maximum Length: 255
    Number of the customer site where the genealogy object instance is located.
  • Value that uniquely identifies the customer party site where the genealogy object instance is located.
  • Maximum Length: 255
    Name of the customer party site party where the genealogy object instance is located.
  • Maximum Length: 255
    Number of the customer party site where the genealogy object instance is located.
  • Maximum Length: 240
    Value that identifies the external location where the genealogy object instance is located. This location can be an external address location or a value that is not validated against any location types defined in the application.
  • Maximum Length: 150
    Value of the packing unit or license plate number that the transaction references. The packing unit or license plate reference is from an external source.
  • Value that uniquely identifies a genealogy object instance. This is a primary key.
  • Genealogy Transactions
    Title: Genealogy Transactions
    The Genealogy Transaction resource gets the transactions of a genealogy object that occur in the source applications.
  • Value that uniquely identifies the locator in a subinventory where the genealogy object instance is located.
  • Title: Item
    Value that uniquely identifies the item of the genealogy object instance. Either item identifier or item number can be used during the POST, PATCH, or GET actions.
  • Number that uniquely identifies the item of the genealogy object instance. Either item identifier or item number can be used during the POST, PATCH, or GET actions.
  • Links
  • Read Only: true
    Maximum Length: 240
    Name of the organization where the genealogy object instance is currently located. Either organization identifier or organization code can be provided during the POST, PATCH, or GET actions.
  • Maximum Length: 255
    Abbreviation that identifies the organization where the genealogy object instance is currently located. Either organization identifier or organization code can be provided during the POST, PATCH, or GET actions.
  • Read Only: true
    Maximum Length: 18
    Name of the organization where the genealogy object instance is currently located. Either organization identifier or organization code can be provided during the POST, PATCH, or GET actions.
  • Value that uniquely identifier the organization where the genealogy object instance is currently located. Either organization identifier or organization code can be provided during the POST, PATCH, or GET actions.
  • Title: Lot
    Maximum Length: 80
    Number that uniquely identifies the lot that the genealogy object instance references to control the item in inventory. This attribute is used when the item is lot-controlled.
  • Read Only: true
    Maximum Length: 240
    Name of the organization that creates or operates the genealogy object instance.
  • Abbreviation that identifies the organization that creates or operates the genealogy object instance. Either organization identifier or organization code can be provided during the POST, PATCH, or GET actions.
  • Value that uniquely identifies the organization that creates or operates the genealogy object instance. Either organization identifier or organization code can be provided during the POST, PATCH, or GET actions.
  • Date when the user created the genealogy object instance.
  • Number that identifies the document reference when the user created the genealogy object instance.
  • Value that identifies the document reference type when the user created the genealogy object instance. A list of accepted values is defined in the lookup type ORA_CSE_DOCUMENT_TYPE.
  • Read Only: true
    Quantity of the genealogy object instance when it is created.
  • Quantity for the item that the genealogy object instance references. If the item is serial-controlled, then the quantity cannot exceed one.
  • Title: Serial Number
    Maximum Length: 80
    Number that uniquely identifies the serial that the genealogy object instance references. This attribute is used when the item is serial-controlled.
  • Name of the source application that is the origin of the genealogy object.
  • Value that uniquely identifies the source application that is the origin of the genealogy object. This attribute is read-only.
  • Description of the type of source application. This attribute is read-only.
  • Abbreviation that identifies the type of source application that is the origin of the genealogy object. A list of accepted values is defined in the lookup type ORA_CSE_SOURCE_SYSTEM_TYPE. Valid value is ORA_EXTERNAL.
  • Maximum Length: 30
    Value that identifies the subinventory where the genealogy object instance is located.
  • Value that uniquely identifies the supplier who ships the genealogy object instance.
  • Name of the supplier who ships the genealogy object instance.
  • Read Only: true
    Maximum Length: 30
    Number that identifies the supplier who ships the genealogy object instance.
  • Value that uniquely identifies the supplier site where the genealogy object instance is currently located.
  • Name of the supplier site where the genealogy object instance is currently located.
  • Title: UOM Name
    Read Only: true
    Maximum Length: 25
    Name of the unit of measure for the quantity of the genealogy object instance. This attribute must use the same unit of measure that the item uses as the primary unit of measure.
  • Title: UOM
    Maximum Length: 3
    Abbreviation that identifies the unit of measure for the quantity of the genealogy object instance. This attribute must use the same unit of measure that the item uses as the primary unit of measure.
  • Abbreviation that identifies the work center where the genealogy object instance is located. Either the work center identifier or the work center code can be provided during the POST, PATCH, or GET actions.
  • Title: Work Center
    Value that uniquely identifies the work center where the genealogy object instance is currently located. Either the work center identifier or the work center code can be provided during the POST, PATCH, or GET actions.
  • Title: Name
    Read Only: true
    Maximum Length: 80
    Name of the work center where the genealogy object instance is located. Either the work center identifier or the work center code can be provided during the POST, PATCH, or GET actions.
  • Value that uniquely identifies the work order at the location of the current genealogy object instance.
  • Maximum Length: 255
    Number that identifies the work order at the location of the current genealogy object instance.
  • Maximum Length: 255
    Name of the work order operation reference at the location of the current genealogy object instance.
  • Value that uniquely identifies the work order operation reference at the location of the current genealogy object instance.
Nested Schema : Genealogy Transactions
Type: array
Title: Genealogy Transactions
The Genealogy Transaction resource gets the transactions of a genealogy object that occur in the source applications.
Show Source
Nested Schema : genealogyObjects-genealogyTransactions-item-response
Type: object
Show Source
Back to Top