Jump to

• Request
• Response

Get one object

get

/fscmRestApi/resources/11.13.18.05/genealogyObjects/{GenealogyInstanceId}

Request

Path Parameters

• GenealogyInstanceId(required): integer(int64)
  Value that uniquely identifies a genealogy object instance. This is a primary 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 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 : genealogyObjects-item-response

Type: object

Show Source

• 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: 120

  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.

{
    "type":"object",
    "properties":{
        "CustomerSitePartyName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the customer party site party where the genealogy object instance is located.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalSystemPackingUnit":{
            "maxLength":"150",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemId":{
            "title":"Item",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurrentLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the location where the genealogy object instance is located.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceSystemType":{
            "type":"string",
            "description":"Description of the type of source application. This attribute is read-only.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerNumber":{
            "type":"string",
            "description":"Number of the customer who receives the genealogy object instance.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UOMCode":{
            "title":"UOM",
            "maxLength":"3",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "WorkCenterCode":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationOrganizationId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkOrderOperationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order operation reference at the location of the current genealogy object instance.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OperatingOrganizationCode":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerSitePartyNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number of the customer party site where the genealogy object instance is located.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":"25",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "OperatingOrganizationId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OriginationDocumentType":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer who receives the genealogy object instance.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CustomerSiteNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number of the customer site where the genealogy object instance is located.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrentLocationName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of an internal location or value that uniquely identifies the address location where the genealogy object instance is located.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier who ships the genealogy object instance.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SerialNumber":{
            "title":"Serial Number",
            "maxLength":"80",
            "type":"string",
            "description":"Number that uniquely identifies the serial that the genealogy object instance references. This attribute is used when the item is serial-controlled.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginationDate":{
            "type":"string",
            "description":"Date when the user created the genealogy object instance.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer site where the genealogy object instance is located.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkOrderNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the work order at the location of the current genealogy object instance.",
            "nullable":true,
            "x-queryable":true
        },
        "genealogyTransactions":{
            "title":"Genealogy Transactions",
            "type":"array",
            "description":"The Genealogy Transaction resource gets the transactions of a genealogy object that occur in the source applications.",
            "items":{
                "$ref":"#/components/schemas/genealogyObjects-genealogyTransactions-item-response"
            }
        },
        "SourceSystemTypeCode":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "OriginationQuantity":{
            "type":"number",
            "description":"Quantity of the genealogy object instance when it is created.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentLocationContext":{
            "maxLength":"80",
            "type":"string",
            "description":"Description of the location context where the genealogy object instance is located.",
            "nullable":false,
            "x-queryable":true
        },
        "WorkCenterId":{
            "title":"Work Center",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkOrderOperation":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the work order operation reference at the location of the current genealogy object instance.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryLocatorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the locator in a subinventory where the genealogy object instance is located.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SupplierSiteName":{
            "type":"string",
            "description":"Name of the supplier site where the genealogy object instance is currently located.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source application that is the origin of the genealogy object. This attribute is read-only.",
            "nullable":true,
            "x-queryable":true
        },
        "OperatingOrganization":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the organization that creates or operates the genealogy object instance.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationOrganizationCodeNU":{
            "maxLength":"18",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site where the genealogy object instance is currently located.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ExternalLocation":{
            "maxLength":"240",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerName":{
            "type":"string",
            "description":"Name of the customer who receives the genealogy object instance.",
            "nullable":true,
            "x-queryable":true
        },
        "LotNumber":{
            "title":"Lot",
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrentLocationCode":{
            "type":"string",
            "description":"Abbreviation that identifies the internal location where the genealogy object instance is located.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkCenterName":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerSitePartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer party site where the genealogy object instance is located.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LocationOrganizationCode":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity for the item that the genealogy object instance references. If the item is serial-controlled, then the quantity cannot exceed one.",
            "nullable":false,
            "x-queryable":true
        },
        "SupplierNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the supplier who ships the genealogy object instance.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GenealogyInstanceId":{
            "type":"integer",
            "description":"Value that uniquely identifies a genealogy object instance. This is a primary key.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "WorkOrderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order at the location of the current genealogy object instance.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SupplierName":{
            "type":"string",
            "description":"Name of the supplier who ships the genealogy object instance.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerSiteName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the customer site where the genealogy object instance is located.",
            "nullable":true,
            "x-queryable":true
        },
        "Subinventory":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the subinventory where the genealogy object instance is located.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginationDocumentNumber":{
            "type":"string",
            "description":"Number that identifies the document reference when the user created the genealogy object instance.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationOrganization":{
            "maxLength":"240",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceSystem":{
            "type":"string",
            "description":"Name of the source application that is the origin of the genealogy object.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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

• Array of: object genealogyObjects-genealogyTransactions-item-response

{
    "title":"Genealogy Transactions",
    "type":"array",
    "description":"The Genealogy Transaction resource gets the transactions of a genealogy object that occur in the source applications.",
    "items":{
        "$ref":"#/components/schemas/genealogyObjects-genealogyTransactions-item-response"
    }
}

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 : genealogyObjects-genealogyTransactions-item-response

Type: object

Show Source

• 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: 120

  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.

{
    "type":"object",
    "properties":{
        "Document":{
            "maxLength":"240",
            "type":"string",
            "description":"Name that identifies the document that the transaction references.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystemType":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Description of the type of source application. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerNumber":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the customer who bought the genealogy object instance.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "WorkCenterCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the work center that is the location of the transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the quantity of the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifier the transaction location organization.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkOrderOperationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order operation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CustomerSitePartyNumber":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"Number that uniquely identifies the customer party site that is the location of the transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":"25",
            "type":"string",
            "description":"Unit of measure for the quantity of the transaction.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "LocationCode":{
            "maxLength":"80",
            "type":"string",
            "description":"Abbreviation that identifies the location of the transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer who bought the genealogy object instance.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CustomerSiteNumber":{
            "title":"Site Number",
            "maxLength":"30",
            "type":"string",
            "description":"Number that uniquely identifies the customer site that is the location of the transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceTransactionTypeId":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that uniquely identifies the type of source transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier who sold the genealogy object instance.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CustomerSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer site that is the location of the transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkOrderNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the work order.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystemTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "Organization":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the organization where the transaction occurs.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center that is the location of the transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkOrderOperation":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the work order operation.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryLocatorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the locator of the transaction subinventory.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SupplierSiteName":{
            "title":"Site",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the supplier site that is the location of the transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization where the transaction occurs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "GenealogyTransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies a genealogy transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SourceSystemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source application that is the origin of the transaction. This attribute is read-only.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceTransactionType":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the type of source transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the location of the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site that is the location of the transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ExternalLocation":{
            "maxLength":"240",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceTransactionDate":{
            "type":"string",
            "description":"Date when the source transaction occurred.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that identifies the organization where the transaction occurs.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceTransactionId":{
            "type":"number",
            "description":"Value that identifies the source transaction.",
            "nullable":true,
            "x-hints":{
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CustomerName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the customer who bought the genealogy object instance.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerSiteParty":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the customer party site that is the location of the transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerSitePartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer party site that is the location of the transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkCenterName":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"Name of the work center.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationOrganizationCode":{
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that identifies the transaction location organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the location of the transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of transaction of the genealogy object instance.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentType":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the document type that the transaction references.",
            "nullable":false,
            "x-queryable":true
        },
        "SupplierNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the supplier who sold the genealogy object instance.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerSiteName":{
            "title":"Site Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the customer site that is the location of the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierName":{
            "maxLength":"360",
            "type":"string",
            "description":"Name of the supplier who sold the genealogy object instance.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order that is the location of the transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Subinventory":{
            "maxLength":"10",
            "type":"string",
            "description":"Name of the transaction subinventory.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationOrganization":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the transaction location organization.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationContext":{
            "maxLength":"30",
            "type":"string",
            "description":"Description of the location of the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystem":{
            "type":"string",
            "description":"Name of the source application that is the origin of the transaction.",
            "nullable":true,
            "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

genealogyTransactions

Operation: /fscmRestApi/resources/11.13.18.05/genealogyObjects/{GenealogyInstanceId}/child/genealogyTransactions

Parameters:

• GenealogyInstanceId: $request.path.GenealogyInstanceId

The Genealogy Transaction resource gets the transactions of a genealogy object that occur in the source applications.

Back to Top