Get one transfer order recommendation.

get

/fscmRestApi/resources/11.13.18.05/supplyPlans/{PlanId}/child/TransferOrderRecommendations/{TransferOrderRecommendationsUniqID}

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=
  • This is the hash key of the attributes which make up the composite key--- PlanId, RecommendationType and RecommendationsId ---for the Expedite Transfer Order Recommendations resource and used to uniquely identify an instance of Expedite Transfer Order Recommendations. The client should not generate the hash key value. Instead, the client should query on the Expedite Transfer Order Recommendations collection resource with a filter on the primary key values in order to navigate to a specific instance of Expedite Transfer Order Recommendations.

    For example: TransferOrderRecommendations?q=PlanId=<value1>;RecommendationType=<value2>;RecommendationsId=<value3>
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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : supplyPlans-TransferOrderRecommendations-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 4000
    Category of the item in the transfer order. The category is derived from the default product hierarchy or any product hierarchy of the item associated in the plan's dimension catalog.
  • Number of days the transfer order supply is compressed.
  • Read Only: true
    Maximum Length: 4000
    Currency code associated with the transfer order.
  • Read Only: true
    Contains one of the following: yes or null. If yes, then the user has data security edit privileges. If null, then the user doesn't have data security edit privileges.
  • Read Only: true
    Maximum Length: 240
    Description of the item in the transfer order.
  • Date when supply is needed.
  • Number of days the supply is required sooner than currently planned.
  • Read Only: true
    Indicates whether a supply order is firm. Valid values are 1 and 2. This attribute doesn't have a default value.
  • Read Only: true
    Maximum Length: 4000
    Indicates whether a supply order is firm. Valid values are firm or not firm. This attribute doesn't have a default value.
  • Unique identifier of an inventory item.
  • Read Only: true
    Maximum Length: 300
    Name of the item in the transfer order.
  • Read Only: true
    Date when the transfer order was last updated.
  • Read Only: true
    Maximum Length: 64
    Name of the user who last updated the transfer order.
  • Links
  • Read Only: true
    Notes regarding when the transfer order was created or updated.
  • Maximum Length: 100
    Line number of the supply in the transfer order.
  • Maximum Length: 240
    Order number of the supply in the transfer order.
  • Order quantity for the transfer supply order.
  • Order type of the transfer supply order.
  • Read Only: true
    Maximum Length: 4000
    Name of the supply order types, such as transfer order and planned transfer order.
  • Read Only: true
    Order value of the supply in the transfer order.
  • Read Only: true
    Maximum Length: 49
    Name of the organization in the transfer order recommendation.
  • Value that uniquely identifies the organization of the transfer order.
  • Value that uniquely identifies the plan in which transfer order recommendations are generated.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 10 associated with the transfer order in an attribute-based plan.
  • Read Only: true
    Value that uniquely identifies the ID of the planning attribute number 10 associated with the transfer order in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 11 associated with the transfer order in an attribute-based plan.
  • Read Only: true
    Value that uniquely identifies the ID of the planning attribute number 11 associated with the transfer order in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 12 associated with the transfer order in an attribute-based plan.
  • Read Only: true
    Value that uniquely identifies the ID of the planning attribute number 12 associated with the transfer order in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 13 associated with the transfer order in an attribute-based plan.
  • Read Only: true
    Value that uniquely identifies the ID of the planning attribute number 13 associated with the transfer order in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 14 associated with the transfer order in an attribute-based plan.
  • Read Only: true
    Value that uniquely identifies the ID of the planning attribute number 14 associated with the transfer order in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 15 associated with the transfer order in an attribute-based plan.
  • Read Only: true
    Value that uniquely identifies the ID of the planning attribute number 15 associated with the transfer order in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 3 associated with the transfer order in an attribute-based plan.
  • Read Only: true
    Value that uniquely identifies the ID of the planning attribute number 3 associated with the transfer order in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 4 associated with the transfer order in an attribute-based plan.
  • Read Only: true
    Value that uniquely identifies the ID of the planning attribute number 4 associated with the transfer order in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 5 associated with the transfer order in an attribute-based plan.
  • Read Only: true
    Value that uniquely identifies the ID of the planning attribute number 5 associated with the transfer order in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 6 associated with the transfer order in an attribute-based plan.
  • Read Only: true
    Value that uniquely identifies the ID of the planning attribute number 6 associated with the transfer order in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 7 associated with the transfer order in an attribute-based plan.
  • Read Only: true
    Value that uniquely identifies the ID of the planning attribute number 7 associated with the transfer order in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 8 associated with the transfer order in an attribute-based plan.
  • Read Only: true
    Value that uniquely identifies the ID of the planning attribute number 8 associated with the transfer order in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies planning attribute number 9 associated with the transfer order in an attribute-based plan.
  • Read Only: true
    Value that uniquely identifies the ID of the planning attribute number 9 associated with the transfer order in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies the project group associated with the transfer order in an attribute-based plan.
  • Read Only: true
    Value that uniquely identifies the ID of the project group associated with the transfer order in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies the project associated with the transfer order in an attribute-based plan.
  • Read Only: true
    Value that uniquely identifies the ID of the project associated with the transfer order in an attribute-based plan.
  • Unique identifier of the recommendation type.
  • Type of recommendation made, such as expedite transfer orders.
  • Number of days to reschedule the transfer supply order.
  • Read Only: true
    Maximum Length: 4000
    Source organization for the transfer order.
  • Read Only: true
    Unique identifier for the source organization.
  • Status value of the expedite transfer order recommendation. Valid values are 1 - Accepted, 2 - In review, and 3 - Pending. The default value is 3 - Pending.
  • Read Only: true
    Maximum Length: 4000
    Status of the expedite transfer order recommendation. Valid values are Pending, In review, and Accepted. The default value is Pending.
  • Date when a supply is expected to be completed.
  • Read Only: true
    Maximum Length: 4000
    Value that identifies the task associated with the transfer order in an attribute-based plan.
  • Read Only: true
    Value that uniquely identifies the ID of the task associated with the transfer order in an attribute-based plan.
  • Read Only: true
    Maximum Length: 4000
    Value that uniquely identifies the time zone.
  • Value that uniquely identifies the supply transaction. This value is internally generated by the application.
  • Read Only: true
    Maximum Length: 4000
    Name of the unit of measure associated with the order quantity.
Back to Top