Get one transaction
get
/fscmRestApi/resources/11.13.18.05/genealogyObjects/{GenealogyInstanceId}/child/genealogyTransactions/{genealogyTransactionsUniqID}
Request
Path Parameters
-
GenealogyInstanceId(required): integer(int64)
Value that uniquely identifies a genealogy object instance. This is a primary key.
-
genealogyTransactionsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Genealogy Transactions resource and used to uniquely identify an instance of Genealogy Transactions. The client should not generate the hash key value. Instead, the client should query on the Genealogy Transactions collection resource in order to navigate to a specific instance of Genealogy Transactions to get the hash key.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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-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.