Get all sources

get

/fscmRestApi/resources/11.13.18.05/sourcingRules/{SourcingRuleId}/child/Destinations/{ReceiptId}/child/Sources

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
  • 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>
  • 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 sources according to the source identifier.
      Finder Variables
      • SourceId; integer; Value that uniquely identifies the source.
  • 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:
    • AllocationPercent; number; Percentage of replenishment from each source.
    • CarrierId; integer; Value that uniquely identifies the carrier used in the sourcing rule.
    • CarrierName; string; Name of the carrier used in the sourcing rule.
    • CreateMovementRequestFlag; boolean; Value that indicates whether to create movement requests as part of the replenishment based on this sourcing rule. Contains one of the following values: 1 or 2. If 1, then create movement request. If 2, then don't create movement request. This attribute doesn't have a default value.
    • CreatedBy; string; User who created the source.
    • CreationDate; string; Date when the user created the source.
    • FromQuantity; number; Lower limit for quantity-based sourcing. This source is used when the required quantity is between the two limits.
    • LastUpdateDate; string; Date when the user most recently updated the source.
    • LastUpdatedBy; string; User who most recently updated the source.
    • ModeOfTransport; string; Name of the transportation mode used in the sourcing rule. The transportation mode is the type of transportation provided such as truck, air, or boat.
    • OrgSubInventoryCode; string; Code that identifies the subinventory for transfer sourcing rules that are enabled for subinventory planning.
    • OrganizationCode; string; Code that identifies the source organization for make and transfer sourcing rules.
    • Rank; integer; Rank for each source of supply named in a sourcing rule.
    • ReleaseToInstanceCode; string; Code that indicates the source application of the source supplier or organization.
    • ReleaseToInstanceId; integer; Value that uniquely identifies the source application of the source supplier or organization.
    • ServiceLevel; string; Name of the carrier service level used in the sourcing rule. The carrier service level is the type of transportation service provided, such as ground truck or 2 day air.
    • ShipMethod; string; Method of shipping used in the sourcing rule.
    • SourceId; integer; Value that uniquely identifies the source of a make, buy or transfer sourcing rule.
    • SourceOrganizationId; integer; Value that uniquely identifies the source organization for make and transfer sourcing rules.
    • SourcePartnerId; integer; Value that uniquely identifies the supplier for buy sourcing rules.
    • SourcePartnerSiteId; integer; Value that uniquely identifies the supplier site for buy sourcing rules.
    • SourceType; string; Type of the source. Valid values include Make, Buy, or Transfer. These values depend on the attribute Source Type Code.
    • SubInventoryId; integer; Value that uniquely identifies the subinventory for transfer sourcing rules that are enabled for subinventory planning.
    • SupplierName; string; Name of the supplier for buy sourcing rules.
    • SupplierSite; string; Code that identifies the supplier site for buy sourcing rules.
    • ToQuantity; number; Upper limit for quantity-based sourcing. This source is used when the required quantity is between the two limits.
    • TransitLeadTime; number; Number of days that the supply will be in transit between two locations.
    • UOMCode; string; Code that identifies the unit of measure for the quantity.
  • 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 : sourcingRules-Destinations-Sources
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : sourcingRules-Destinations-Sources-item-response
Type: object
Show Source
Nested Schema : Exclusions
Type: array
Title: Exclusions
The Exclusions resource manages any exclusions based on option classes or option items for a specific source.
Show Source
Nested Schema : sourcingRules-Destinations-Sources-Exclusions-item-response
Type: object
Show Source
Back to Top