Get all destinations
get
/fscmRestApi/resources/11.13.18.05/sourcingRules/{SourcingRuleId}/child/Destinations
Request
Path Parameters
-
SourcingRuleId(required): integer
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
-
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 -
finder: string
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 destinations according to the destination identifier.
Finder Variables- ReceiptId; integer; Value that uniquely identifies the destination.
- PrimaryKey Find destinations according to the destination identifier.
-
limit: integer
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.
-
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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:- CreatedBy; string; User who created the destination.
- CreationDate; string; Date when the user created the destination.
- DisableDate; string; Date until when the set of sources specified for this destination are effective. If blank, then the sources are effective indefinitely.
- EffectiveDate; string; Date when the set of sources specified for this destination are effective.
- LastUpdateDate; string; Date when the user most recently updated the destination.
- LastUpdatedBy; string; User who most recently updated the destination.
- ReceiptId; integer; Value that uniquely identifies the destination organization or location in a sourcing rule.
-
totalResults: boolean
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
-
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 : sourcingRules-Destinations
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : sourcingRules-Destinations-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the destination. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the destination. -
DisableDate: string
(date)
Date until when the set of sources specified for this destination are effective. If blank, then the sources are effective indefinitely.
-
EffectiveDate: string
(date)
Date when the set of sources specified for this destination are effective.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the destination. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the destination. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ReceiptId: integer
Value that uniquely identifies the destination organization or location in a sourcing rule.
-
Sources: array
Sources
Title:
Sources
The Sources resource manages the source organizations or suppliers of the sourcing rule.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Sources
Type:
array
Title:
Sources
The Sources resource manages the source organizations or suppliers of the sourcing rule.
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.
Nested Schema : sourcingRules-Destinations-Sources-item-response
Type:
Show Source
object
-
AllocationPercent: number
Percentage of replenishment from each source.
-
CarrierId: integer
(int64)
Value that uniquely identifies the carrier used in the sourcing rule.
-
CarrierName: string
Name of the carrier used in the sourcing rule.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the source. -
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.
-
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the source. -
Exclusions: array
Exclusions
Title:
Exclusions
The Exclusions resource manages any exclusions based on option classes or option items for a specific source. -
FromQuantity: number
Title:
From Quantity
Lower limit for quantity-based sourcing. This source is used when the required quantity is between the two limits. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the source. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the source. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
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.
-
OrganizationCode: string
Code that identifies the source organization for make and transfer sourcing rules.
-
OrgSubInventoryCode: string
Code that identifies the subinventory for transfer sourcing rules that are enabled for subinventory planning.
-
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
Maximum Length:
30
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
Title:
Organization
Value that uniquely identifies the source organization for make and transfer sourcing rules. -
SourcePartnerId: integer
Title:
Supplier
Value that uniquely identifies the supplier for buy sourcing rules. -
SourcePartnerSiteId: integer
Title:
Supplier Site
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
Title:
To Quantity
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
Title:
Quantity UOM
Maximum Length:3
Code that identifies the unit of measure for the quantity.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : sourcingRules-Destinations-Sources-Exclusions-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the exclusion. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the exclusion. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the exclusion. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the exclusion. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OptionClassItemId: integer
(int64)
Value that uniquely identifies the option or option class item that's excluded for this source.
-
OptionClassItemName: string
Read Only:
true
Maximum Length:300
Name of the option or option class item that's excluded for this source. -
SourceExclusionId: integer
(int64)
Value that uniquely identifies the exclusion rule to exclude this source for a option or option class item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source