Get all objects

get

/fscmRestApi/resources/11.13.18.05/genealogyObjects

Request

Query Parameters
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Find genealogy instances according to the genealogy instance identifier.
      Finder Variables:
      • GenealogyInstanceId; integer; Value that uniquely identifies the genealogy instance.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • CurrentLocationCode; string; Abbreviation that identifies the internal location where the genealogy object instance is located.
    • CurrentLocationContext; string; Description of the location context where the genealogy object instance is located.
    • CurrentLocationId; integer; Value that uniquely identifies the location where the genealogy object instance is located.
    • CurrentLocationName; string; Name of an internal location or value that uniquely identifies the address location where the genealogy object instance is located.
    • CustomerId; integer; 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; Value that uniquely identifies the customer site where the genealogy object instance is located.
    • CustomerSiteName; string; Name of the customer site where the genealogy object instance is located.
    • CustomerSiteNumber; string; Number of the customer site where the genealogy object instance is located.
    • CustomerSitePartyId; integer; Value that uniquely identifies the customer party site where the genealogy object instance is located.
    • CustomerSitePartyName; string; Name of the customer party site party where the genealogy object instance is located.
    • CustomerSitePartyNumber; string; Number of the customer party site where the genealogy object instance is located.
    • ExternalLocation; string; 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; 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; Value that uniquely identifies a genealogy object instance. This is a primary key.
    • InventoryLocatorId; integer; Value that uniquely identifies the locator in a subinventory where the genealogy object instance is located.
    • ItemId; integer; 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.
    • LocationOrganization; string; 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; 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; 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; 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; 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; 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; 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 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; 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; Number that uniquely identifies the serial that the genealogy object instance references. This attribute is used when the item is serial-controlled.
    • 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.
    • Subinventory; string; Value that identifies the subinventory where the genealogy object instance is located.
    • SupplierId; integer; 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; Number that identifies the supplier who ships the genealogy object instance.
    • SupplierSiteId; integer; 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; string; 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.
    • UnitOfMeasure; string; 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.
    • 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; 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; 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; Value that uniquely identifies the work order at the location of the current genealogy object instance.
    • WorkOrderNumber; string; Number that identifies the work order at the location of the current genealogy object instance.
    • WorkOrderOperation; string; Name of the work order operation reference at the location of the current genealogy object instance.
    • WorkOrderOperationId; integer; Value that uniquely identifies the work order operation reference at the location of the current genealogy object instance.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : genealogyObjects
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : genealogyObjects-item-response
Type: object
Show Source
  • Abbreviation that identifies the internal location where the genealogy object instance is located.
  • Maximum Length: 80
    Description of the location context where the genealogy object instance is located.
  • Value that uniquely identifies the location where the genealogy object instance is located.
  • Read Only: true
    Maximum Length: 255
    Name of an internal location or value that uniquely identifies the address location where the genealogy object instance is located.
  • Value that uniquely identifies the customer who receives the genealogy object instance.
  • Name of the customer who receives the genealogy object instance.
  • Number of the customer who receives the genealogy object instance.
  • Value that uniquely identifies the customer site where the genealogy object instance is located.
  • Maximum Length: 255
    Name of the customer site where the genealogy object instance is located.
  • Maximum Length: 255
    Number of the customer site where the genealogy object instance is located.
  • Value that uniquely identifies the customer party site where the genealogy object instance is located.
  • Maximum Length: 255
    Name of the customer party site party where the genealogy object instance is located.
  • Maximum Length: 255
    Number of the customer party site where the genealogy object instance is located.
  • Maximum Length: 240
    Value that identifies the external location where the genealogy object instance is located. This location can be an external address location or a value that is not validated against any location types defined in the application.
  • Maximum Length: 150
    Value of the packing unit or license plate number that the transaction references. The packing unit or license plate reference is from an external source.
  • Value that uniquely identifies a genealogy object instance. This is a primary key.
  • Genealogy Transactions
    Title: Genealogy Transactions
    The Genealogy Transaction resource gets the transactions of a genealogy object that occur in the source applications.
  • Value that uniquely identifies the locator in a subinventory where the genealogy object instance is located.
  • Title: Item
    Value that uniquely identifies the item of the genealogy object instance. Either item identifier or item number can be used during the POST, PATCH, or GET actions.
  • Number that uniquely identifies the item of the genealogy object instance. Either item identifier or item number can be used during the POST, PATCH, or GET actions.
  • Links
  • Read Only: true
    Maximum Length: 240
    Name of the organization where the genealogy object instance is currently located. Either organization identifier or organization code can be provided during the POST, PATCH, or GET actions.
  • Maximum Length: 255
    Abbreviation that identifies the organization where the genealogy object instance is currently located. Either organization identifier or organization code can be provided during the POST, PATCH, or GET actions.
  • Read Only: true
    Maximum Length: 18
    Name of the organization where the genealogy object instance is currently located. Either organization identifier or organization code can be provided during the POST, PATCH, or GET actions.
  • Value that uniquely identifier the organization where the genealogy object instance is currently located. Either organization identifier or organization code can be provided during the POST, PATCH, or GET actions.
  • Title: Lot
    Maximum Length: 80
    Number that uniquely identifies the lot that the genealogy object instance references to control the item in inventory. This attribute is used when the item is lot-controlled.
  • Read Only: true
    Maximum Length: 240
    Name of the organization that creates or operates the genealogy object instance.
  • Abbreviation that identifies the organization that creates or operates the genealogy object instance. Either organization identifier or organization code can be provided during the POST, PATCH, or GET actions.
  • Value that uniquely identifies the organization that creates or operates the genealogy object instance. Either organization identifier or organization code can be provided during the POST, PATCH, or GET actions.
  • Date when the user created the genealogy object instance.
  • Number that identifies the document reference when the user created the genealogy object instance.
  • Value that identifies the document reference type when the user created the genealogy object instance. A list of accepted values is defined in the lookup type ORA_CSE_DOCUMENT_TYPE.
  • Read Only: true
    Quantity of the genealogy object instance when it is created.
  • Quantity for the item that the genealogy object instance references. If the item is serial-controlled, then the quantity cannot exceed one.
  • Title: Serial Number
    Maximum Length: 80
    Number that uniquely identifies the serial that the genealogy object instance references. This attribute is used when the item is serial-controlled.
  • Name of the source application that is the origin of the genealogy object.
  • Value that uniquely identifies the source application that is the origin of the genealogy object. This attribute is read-only.
  • Description of the type of source application. This attribute is read-only.
  • Abbreviation that identifies the type of source application that is the origin of the genealogy object. A list of accepted values is defined in the lookup type ORA_CSE_SOURCE_SYSTEM_TYPE. Valid value is ORA_EXTERNAL.
  • Maximum Length: 30
    Value that identifies the subinventory where the genealogy object instance is located.
  • Value that uniquely identifies the supplier who ships the genealogy object instance.
  • Name of the supplier who ships the genealogy object instance.
  • Read Only: true
    Maximum Length: 30
    Number that identifies the supplier who ships the genealogy object instance.
  • Value that uniquely identifies the supplier site where the genealogy object instance is currently located.
  • Name of the supplier site where the genealogy object instance is currently located.
  • Title: UOM Name
    Read Only: true
    Maximum Length: 25
    Name of the unit of measure for the quantity of the genealogy object instance. This attribute must use the same unit of measure that the item uses as the primary unit of measure.
  • Title: UOM
    Maximum Length: 3
    Abbreviation that identifies the unit of measure for the quantity of the genealogy object instance. This attribute must use the same unit of measure that the item uses as the primary unit of measure.
  • Abbreviation that identifies the work center where the genealogy object instance is located. Either the work center identifier or the work center code can be provided during the POST, PATCH, or GET actions.
  • Title: Work Center
    Value that uniquely identifies the work center where the genealogy object instance is currently located. Either the work center identifier or the work center code can be provided during the POST, PATCH, or GET actions.
  • Title: Name
    Read Only: true
    Maximum Length: 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.
  • Value that uniquely identifies the work order at the location of the current genealogy object instance.
  • Maximum Length: 255
    Number that identifies the work order at the location of the current genealogy object instance.
  • Maximum Length: 255
    Name of the work order operation reference at the location of the current genealogy object instance.
  • Value that uniquely identifies the work order operation reference at the location of the current genealogy object instance.
Nested Schema : Genealogy Transactions
Type: array
Title: Genealogy Transactions
The Genealogy Transaction resource gets the transactions of a genealogy object that occur in the source applications.
Show Source
Nested Schema : genealogyObjects-genealogyTransactions-item-response
Type: object
Show Source
Back to Top