Create objects
post
/fscmRestApi/resources/11.13.18.05/genealogyObjects
Request
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
Root Schema : schema
Type:
Show Source
object
-
CurrentLocationCode: string
Abbreviation that identifies the internal location where the genealogy object instance is located.
-
CurrentLocationContext(required): string
Maximum Length:
80
Description of the location context where the genealogy object instance is located. -
CurrentLocationId: integer
(int64)
Value that uniquely identifies the location where the genealogy object instance is located.
-
CustomerId: integer
(int64)
Value that uniquely identifies the customer who receives the genealogy object instance.
-
CustomerName: string
Name of the customer who receives the genealogy object instance.
-
CustomerNumber: string
Number of the customer who receives the genealogy object instance.
-
CustomerSiteId: integer
(int64)
Value that uniquely identifies the customer site where the genealogy object instance is located.
-
CustomerSiteName: string
Maximum Length:
255
Name of the customer site where the genealogy object instance is located. -
CustomerSiteNumber: string
Maximum Length:
255
Number of the customer site where the genealogy object instance is located. -
CustomerSitePartyId: integer
(int64)
Value that uniquely identifies the customer party site where the genealogy object instance is located.
-
CustomerSitePartyName: string
Maximum Length:
255
Name of the customer party site party where the genealogy object instance is located. -
CustomerSitePartyNumber: string
Maximum Length:
255
Number of the customer party site where the genealogy object instance is located. -
ExternalLocation: string
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. -
ExternalSystemPackingUnit: string
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. -
GenealogyInstanceId: integer
(int64)
Value that uniquely identifies a genealogy object instance. This is a primary key.
-
genealogyTransactions: array
Genealogy Transactions
Title:
Genealogy Transactions
The Genealogy Transaction resource gets the transactions of a genealogy object that occur in the source applications. -
InventoryLocatorId: integer
(int64)
Value that uniquely identifies the locator in a subinventory where the genealogy object instance is located.
-
ItemId(required): integer
(int64)
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. -
ItemNumber: string
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.
-
LocationOrganizationCode: string
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. -
LocationOrganizationId: integer
(int64)
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.
-
LotNumber: string
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. -
OperatingOrganizationCode: string
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.
-
OperatingOrganizationId(required): integer
(int64)
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.
-
OriginationDate: string
(date-time)
Date when the user created the genealogy object instance.
-
OriginationDocumentNumber: string
Number that identifies the document reference when the user created the genealogy object instance.
-
OriginationDocumentType: string
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(required): number
Quantity for the item that the genealogy object instance references. If the item is serial-controlled, then the quantity cannot exceed one.
-
SerialNumber: string
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. -
SourceSystem: string
Name of the source application that is the origin of the genealogy object.
-
SourceSystemId: integer
Value that uniquely identifies the source application that is the origin of the genealogy object. This attribute is read-only.
-
SourceSystemType: string
Description of the type of source application. This attribute is read-only.
-
SourceSystemTypeCode: string
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.
-
Subinventory: string
Maximum Length:
30
Value that identifies the subinventory where the genealogy object instance is located. -
SupplierId: integer
(int64)
Value that uniquely identifies the supplier who ships the genealogy object instance.
-
SupplierName: string
Name of the supplier who ships the genealogy object instance.
-
SupplierSiteId: integer
(int64)
Value that uniquely identifies the supplier site where the genealogy object instance is currently located.
-
SupplierSiteName: string
Name of the supplier site where the genealogy object instance is currently located.
-
UOMCode(required): string
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. -
WorkCenterCode: string
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.
-
WorkCenterId: integer
(int64)
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. -
WorkOrderId: integer
(int64)
Value that uniquely identifies the work order at the location of the current genealogy object instance.
-
WorkOrderNumber: string
Maximum Length:
255
Number that identifies the work order at the location of the current genealogy object instance. -
WorkOrderOperation: string
Maximum Length:
255
Name of the work order operation reference at the location of the current genealogy object instance. -
WorkOrderOperationId: integer
(int64)
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:
Show Source
object
-
Document: string
Maximum Length:
240
Name that identifies the document that the transaction references. -
DocumentType: string
Maximum Length:
30
Value that identifies the document type that the transaction references. -
GenealogyTransactionId: integer
(int64)
Value that uniquely identifies a genealogy transaction.
-
InventoryLocatorId: integer
(int64)
Value that uniquely identifies the locator of the transaction subinventory.
-
LocationContext: string
Maximum Length:
30
Description of the location of the transaction. -
LocationName: string
Maximum Length:
255
Name of the location of the transaction. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization where the transaction occurs.
-
Quantity: number
Quantity of transaction of the genealogy object instance.
-
SourceSystem: string
Name of the source application that is the origin of the transaction.
-
SourceSystemId: integer
(int64)
Value that uniquely identifies the source application that is the origin of the transaction. This attribute is read-only.
-
SourceSystemTypeCode: string
Maximum Length:
30
Abbreviation that identifies the type of source application that is the origin of the transaction. A list of accepted values is defined in the lookup type ORA_CSE_SOURCE_SYSTEM_TYPE. Valid value is ORA_EXTERNAL. -
SourceTransactionDate: string
(date-time)
Date when the source transaction occurred.
-
SourceTransactionId: number
Value that identifies the source transaction.
-
SourceTransactionType: string
Maximum Length:
240
Name of the type of source transaction. -
SourceTransactionTypeId: string
Maximum Length:
30
Value that uniquely identifies the type of source transaction. -
Subinventory: string
Maximum Length:
10
Name of the transaction subinventory. -
UOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure for the quantity of the transaction. -
WorkCenterId: integer
(int64)
Value that uniquely identifies the work center that is the location of the transaction.
-
WorkOrderId: integer
(int64)
Value that uniquely identifies the work order that is the location of the transaction.
-
WorkOrderNumber: string
Maximum Length:
255
Number that identifies the work order. -
WorkOrderOperation: string
Maximum Length:
255
Name of the work order operation. -
WorkOrderOperationId: integer
(int64)
Value that uniquely identifies the work order operation.
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.
Root Schema : genealogyObjects-item-response
Type:
Show Source
object
-
CurrentLocationCode: string
Abbreviation that identifies the internal location where the genealogy object instance is located.
-
CurrentLocationContext: string
Maximum Length:
80
Description of the location context where the genealogy object instance is located. -
CurrentLocationId: integer
(int64)
Value that uniquely identifies the location where the genealogy object instance is located.
-
CurrentLocationName: string
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. -
CustomerId: integer
(int64)
Value that uniquely identifies the customer who receives the genealogy object instance.
-
CustomerName: string
Name of the customer who receives the genealogy object instance.
-
CustomerNumber: string
Number of the customer who receives the genealogy object instance.
-
CustomerSiteId: integer
(int64)
Value that uniquely identifies the customer site where the genealogy object instance is located.
-
CustomerSiteName: string
Maximum Length:
255
Name of the customer site where the genealogy object instance is located. -
CustomerSiteNumber: string
Maximum Length:
255
Number of the customer site where the genealogy object instance is located. -
CustomerSitePartyId: integer
(int64)
Value that uniquely identifies the customer party site where the genealogy object instance is located.
-
CustomerSitePartyName: string
Maximum Length:
255
Name of the customer party site party where the genealogy object instance is located. -
CustomerSitePartyNumber: string
Maximum Length:
255
Number of the customer party site where the genealogy object instance is located. -
ExternalLocation: string
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. -
ExternalSystemPackingUnit: string
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. -
GenealogyInstanceId: integer
(int64)
Value that uniquely identifies a genealogy object instance. This is a primary key.
-
genealogyTransactions: array
Genealogy Transactions
Title:
Genealogy Transactions
The Genealogy Transaction resource gets the transactions of a genealogy object that occur in the source applications. -
InventoryLocatorId: integer
(int64)
Value that uniquely identifies the locator in a subinventory where the genealogy object instance is located.
-
ItemId: integer
(int64)
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. -
ItemNumber: string
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: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationOrganization: string
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. -
LocationOrganizationCode: string
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. -
LocationOrganizationCodeNU: string
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. -
LocationOrganizationId: integer
(int64)
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.
-
LotNumber: string
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. -
OperatingOrganization: string
Read Only:
true
Maximum Length:240
Name of the organization that creates or operates the genealogy object instance. -
OperatingOrganizationCode: string
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.
-
OperatingOrganizationId: integer
(int64)
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.
-
OriginationDate: string
(date-time)
Date when the user created the genealogy object instance.
-
OriginationDocumentNumber: string
Number that identifies the document reference when the user created the genealogy object instance.
-
OriginationDocumentType: string
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.
-
OriginationQuantity: number
Read Only:
true
Quantity of the genealogy object instance when it is created. -
Quantity: number
Quantity for the item that the genealogy object instance references. If the item is serial-controlled, then the quantity cannot exceed one.
-
SerialNumber: string
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. -
SourceSystem: string
Name of the source application that is the origin of the genealogy object.
-
SourceSystemId: integer
Value that uniquely identifies the source application that is the origin of the genealogy object. This attribute is read-only.
-
SourceSystemType: string
Description of the type of source application. This attribute is read-only.
-
SourceSystemTypeCode: string
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.
-
Subinventory: string
Maximum Length:
30
Value that identifies the subinventory where the genealogy object instance is located. -
SupplierId: integer
(int64)
Value that uniquely identifies the supplier who ships the genealogy object instance.
-
SupplierName: string
Name of the supplier who ships the genealogy object instance.
-
SupplierNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the supplier who ships the genealogy object instance. -
SupplierSiteId: integer
(int64)
Value that uniquely identifies the supplier site where the genealogy object instance is currently located.
-
SupplierSiteName: string
Name of the supplier site where the genealogy object instance is currently located.
-
UnitOfMeasure: string
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. -
UOMCode: string
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. -
WorkCenterCode: string
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.
-
WorkCenterId: integer
(int64)
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. -
WorkCenterName: string
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. -
WorkOrderId: integer
(int64)
Value that uniquely identifies the work order at the location of the current genealogy object instance.
-
WorkOrderNumber: string
Maximum Length:
255
Number that identifies the work order at the location of the current genealogy object instance. -
WorkOrderOperation: string
Maximum Length:
255
Name of the work order operation reference at the location of the current genealogy object instance. -
WorkOrderOperationId: integer
(int64)
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : genealogyObjects-genealogyTransactions-item-response
Type:
Show Source
object
-
CustomerId: integer
(int64)
Read Only:
true
Value that uniquely identifies the customer who bought the genealogy object instance. -
CustomerName: string
Title:
Name
Read Only:true
Maximum Length:360
Name of the customer who bought the genealogy object instance. -
CustomerNumber: string
Title:
Registry ID
Read Only:true
Maximum Length:30
Number that identifies the customer who bought the genealogy object instance. -
CustomerSiteId: integer
(int64)
Read Only:
true
Value that uniquely identifies the customer site that is the location of the transaction. -
CustomerSiteName: string
Title:
Site Name
Read Only:true
Maximum Length:240
Name of the customer site that is the location of the transaction. -
CustomerSiteNumber: string
Title:
Site Number
Read Only:true
Maximum Length:30
Number that uniquely identifies the customer site that is the location of the transaction. -
CustomerSiteParty: string
Title:
Name
Read Only:true
Maximum Length:360
Name of the customer party site that is the location of the transaction. -
CustomerSitePartyId: integer
(int64)
Read Only:
true
Value that uniquely identifies the customer party site that is the location of the transaction. -
CustomerSitePartyNumber: string
Title:
Registry ID
Read Only:true
Maximum Length:30
Number that uniquely identifies the customer party site that is the location of the transaction. -
Document: string
Maximum Length:
240
Name that identifies the document that the transaction references. -
DocumentType: string
Maximum Length:
30
Value that identifies the document type that the transaction references. -
ExternalLocation: string
Read Only:
true
Maximum Length:240
Value that identifies the location of the transaction. This location can be an external address location or a value that is not validated against any location types defined in the application. -
GenealogyTransactionId: integer
(int64)
Value that uniquely identifies a genealogy transaction.
-
InventoryLocatorId: integer
(int64)
Value that uniquely identifies the locator of the transaction subinventory.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationCode: string
Read Only:
true
Maximum Length:80
Abbreviation that identifies the location of the transaction. -
LocationContext: string
Maximum Length:
30
Description of the location of the transaction. -
LocationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the location of the transaction. -
LocationName: string
Maximum Length:
255
Name of the location of the transaction. -
LocationOrganization: string
Read Only:
true
Maximum Length:240
Name of the transaction location organization. -
LocationOrganizationCode: string
Read Only:
true
Maximum Length:18
Abbreviation that identifies the transaction location organization. -
LocationOrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifier the transaction location organization. -
Organization: string
Read Only:
true
Maximum Length:240
Name of the organization where the transaction occurs. -
OrganizationCode: string
Read Only:
true
Maximum Length:18
Abbreviation that identifies the organization where the transaction occurs. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization where the transaction occurs.
-
Quantity: number
Quantity of transaction of the genealogy object instance.
-
SourceSystem: string
Name of the source application that is the origin of the transaction.
-
SourceSystemId: integer
(int64)
Value that uniquely identifies the source application that is the origin of the transaction. This attribute is read-only.
-
SourceSystemType: string
Title:
Meaning
Read Only:true
Maximum Length:80
Description of the type of source application. This attribute is read-only. -
SourceSystemTypeCode: string
Maximum Length:
30
Abbreviation that identifies the type of source application that is the origin of the transaction. A list of accepted values is defined in the lookup type ORA_CSE_SOURCE_SYSTEM_TYPE. Valid value is ORA_EXTERNAL. -
SourceTransactionDate: string
(date-time)
Date when the source transaction occurred.
-
SourceTransactionId: number
Value that identifies the source transaction.
-
SourceTransactionType: string
Maximum Length:
240
Name of the type of source transaction. -
SourceTransactionTypeId: string
Maximum Length:
30
Value that uniquely identifies the type of source transaction. -
Subinventory: string
Maximum Length:
10
Name of the transaction subinventory. -
SupplierId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier who sold the genealogy object instance. -
SupplierName: string
Read Only:
true
Maximum Length:360
Name of the supplier who sold the genealogy object instance. -
SupplierNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the supplier who sold the genealogy object instance. -
SupplierSiteId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier site that is the location of the transaction. -
SupplierSiteName: string
Title:
Site
Read Only:true
Maximum Length:240
Name of the supplier site that is the location of the transaction. -
UnitOfMeasure: string
Title:
UOM Name
Read Only:true
Maximum Length:25
Unit of measure for the quantity of the transaction. -
UOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure for the quantity of the transaction. -
WorkCenterCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the work center that is the location of the transaction. -
WorkCenterId: integer
(int64)
Value that uniquely identifies the work center that is the location of the transaction.
-
WorkCenterName: string
Title:
Name
Read Only:true
Maximum Length:80
Name of the work center. -
WorkOrderId: integer
(int64)
Value that uniquely identifies the work order that is the location of the transaction.
-
WorkOrderNumber: string
Maximum Length:
255
Number that identifies the work order. -
WorkOrderOperation: string
Maximum Length:
255
Name of the work order operation. -
WorkOrderOperationId: integer
(int64)
Value that uniquely identifies the work order operation.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- genealogyTransactions
-
Parameters:
- GenealogyInstanceId:
$request.path.GenealogyInstanceId
The Genealogy Transaction resource gets the transactions of a genealogy object that occur in the source applications. - GenealogyInstanceId: