Get all attribute-based transfer recommendations

get

/fscmRestApi/resources/11.13.18.05/supplyPlans/{PlanId}/child/AttributeTransferRecommendations

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=
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 Finds an attribute-based transfer recommendation based on the primary search criteria.
      Finder Variables
      • PeggingId; integer; Value that uniquely identifies the supply and demand pegging relationship.
  • 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:
    • Action; string; Value that indicates the action recommended by planning. A list of accepted values is defined in the lookup type ORA_MSC_ACTIONS.
    • ActionId; integer; Code that indicates the type of recommended change made by the planning engine to the supply or demand. Valid values are 1: Cancel, 2: Reschedule in, 3: Reschedule out, 4: Release, 5: Release reservation, 6: None, and 7: Reschedule and release reservation. A list of accepted values is defined in the lookup ORA_MSC_ACTIONS.
    • CreatedBy; string; Indicates the user who created the row.
    • CreationDate; string; Indicates the date and time of the creation of the row.
    • DataSecurityEditAllowed; string; 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.
    • DemandDate; string; Date when the material for the demand is due.
    • DemandId; integer; Value that uniquely identifies the demand.
    • DemandLineNumber; string; Line number associated with the demand.
    • DemandOrderNumber; string; Order number of a demand.
    • DemandOrderType; string; Value that indicates the order type of a demand.
    • DemandOrderTypeCode; integer; Abbreviation that identifies the order type of the demand.
    • DemandQuantity; number; Quantity of the demand in the recommendation.
    • DropShipDestType; integer; Code that identifies where the supply is destined. A list of accepted values is defined in the lookup type ORA_MSC_DESTINATION_TYPE.
    • FirmDate; string; The date when the order is due. This attribute is a fixed value that can't be rescheduled by planning and is populated only when the firm status is set to firm.
    • FirmQuantity; number; The fixed quantity of the order. This attribute value can't be changed by planning and is populated only when the firm status is set to firm.
    • FirmStartQuantity; number; User-specified start quantity of a supply. This attribute value can't be changed by planning and is only populated when the firm status is firm.
    • FirmStatus; string; Indicates whether a supply order is firm. Valid values are firm or not firm.
    • FirmStatusCode; integer; Indicates whether a supply order is firm. Valid values are 1 and 2.
    • FromPlanningAttribute10; string; Value of the planning attribute number 10 associated with the supply for the recommendation.
    • FromPlanningAttribute10Id; integer; Value that uniquely identifies the ID of planning attribute number 10 associated with the supply for the recommendation.
    • FromPlanningAttribute11; string; Value of the planning attribute number 11 associated with the supply for the recommendation.
    • FromPlanningAttribute11Id; integer; Value that uniquely identifies the ID of planning attribute number 11 associated with the supply for the recommendation.
    • FromPlanningAttribute12; string; Value of the planning attribute number 12 associated with the supply for the recommendation.
    • FromPlanningAttribute12Id; integer; Value that uniquely identifies the ID of planning attribute number 12 associated with the supply for the recommendation.
    • FromPlanningAttribute13; string; Value of the planning attribute number 13 associated with the supply for the recommendation.
    • FromPlanningAttribute13Id; integer; Value that uniquely identifies the ID of planning attribute number 13 associated with the supply for the recommendation.
    • FromPlanningAttribute14; string; Value of the planning attribute number 14 associated with the supply for the recommendation.
    • FromPlanningAttribute14Id; integer; Value that uniquely identifies the ID of planning attribute number 14 associated with the supply for the recommendation.
    • FromPlanningAttribute15; string; Value of the planning attribute number 15 associated with the supply for the recommendation.
    • FromPlanningAttribute15Id; integer; Value that uniquely identifies the ID of planning attribute number 15 associated with the supply for the recommendation.
    • FromPlanningAttribute3; string; Value of the planning attribute number 3 associated with the supply for the recommendation.
    • FromPlanningAttribute3Id; integer; Value that uniquely identifies the ID of planning attribute number 3 associated with the supply for the recommendation.
    • FromPlanningAttribute4; string; Value of the planning attribute number 4 associated with the supply for the recommendation.
    • FromPlanningAttribute4Id; integer; Value that uniquely identifies the ID of planning attribute number 4 associated with the supply for the recommendation.
    • FromPlanningAttribute5; string; Value of the planning attribute number 5 associated with the supply for the recommendation.
    • FromPlanningAttribute5Id; integer; Value that uniquely identifies the ID of planning attribute number 5 associated with the supply for the recommendation.
    • FromPlanningAttribute6; string; Value of the planning attribute number 6 associated with the supply for the recommendation.
    • FromPlanningAttribute6Id; integer; Value that uniquely identifies the ID of planning attribute number 6 associated with the supply for the recommendation.
    • FromPlanningAttribute7; string; Value of the planning attribute number 7 associated with the supply for the recommendation.
    • FromPlanningAttribute7Id; integer; Value that uniquely identifies the ID of planning attribute number 7 associated with the supply for the recommendation.
    • FromPlanningAttribute8; string; Value of the planning attribute number 8 associated with the supply for the recommendation.
    • FromPlanningAttribute8Id; integer; Value that uniquely identifies the ID of planning attribute number 8 associated with the supply for the recommendation.
    • FromPlanningAttribute9; string; Value of the planning attribute number 9 associated with the supply for the recommendation.
    • FromPlanningAttribute9Id; integer; Value that uniquely identifies the ID of planning attribute number 9 associated with the supply for the recommendation.
    • FromProjectGroupValue; string; Value of the project group associated with the supply for the recommendation.
    • FromProjectGroupValueId; integer; Value that uniquely identifies the ID of the project group value associated with the supply for the recommendation.
    • FromProjectValue; string; Value of the project associated with the supply for the recommendation.
    • FromProjectValueId; integer; Value that uniquely identifies the ID of the project value associated with the supply for the recommendation.
    • FromTaskValue; string; Value of the task associated with the supply for the recommendation.
    • FromTaskValueId; integer; Value that uniquely identifies the ID of the task value associated with the supply for the recommendation.
    • ImplementedQuantity; number; Cumulative quantity that has been released to date.
    • InventoryItemId; integer; Value that uniquely identifies the item.
    • Item; string; Name of the item.
    • LastUpdateDate; string; Indicates the date and time of the last update of the row.
    • LastUpdatedBy; string; Indicates the user who last updated the row.
    • MeasureDate; string; Date when the order is expected to be completed.
    • OrderStatus; string; SCM Cloud transactional status of a work order, purchase order, or transfer order supplies that are referred to by the planning process.
    • OrderStatusCode; integer; Abbreviation that indicates the SCM Cloud transactional status of a work order, purchase order, or transfer order supplies that are referred to by the planning process. A list of accepted values is defined in the lookup types ORA_MSC_ORDER_STATUS and ORA_MSC_WIP_JOB_STATUS.
    • Organization; string; Name of the organization associated with the order.
    • OrganizationId; integer; Value that uniquely identifies the organization.
    • PeggingId; integer; Value that uniquely identifies the supply and demand pegging relationship.
    • PlannerName; string; Abbreviation that identifies the planner responsible for the item.
    • ReleaseErrors; string; Errors that are generated in the release process.
    • ReleaseStatusText; string; Value that indicates the release status of the order. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_RELEASE_STATUS.
    • RowModified; string; Value that identifies whether the attribute-based transfer recommendation has been modified. Valid values are true or false. If true, then the row is new or modified. If false, then the row isn't new or modified. The default value is false.
    • SupplyDate; string; Date when the material for the supply is available.
    • SupplyLineNumber; string; Line number associated with the supply.
    • SupplyOrderNumber; string; Order number of a supply.
    • SupplyOrderType; string; Value that indicates the order type of a supply.
    • SupplyOrderTypeCode; integer; Abbreviation that identifies the order type of the supply.
    • SupplyQuantity; number; Quantity of the supply in the recommendation.
    • ToPlanningAttribute10; string; Value of the planning attribute number 10 associated with the demand for the recommendation.
    • ToPlanningAttribute10Id; integer; Value that uniquely identifies the ID of planning attribute number 10 associated with the demand for the recommendation.
    • ToPlanningAttribute11; string; Value of the planning attribute number 11 associated with the demand for the recommendation.
    • ToPlanningAttribute11Id; integer; Value that uniquely identifies the ID of planning attribute number 11 associated with the demand for the recommendation.
    • ToPlanningAttribute12; string; Value of the planning attribute number 12 associated with the demand for the recommendation.
    • ToPlanningAttribute12Id; integer; Value that uniquely identifies the ID of planning attribute number 12 associated with the demand for the recommendation.
    • ToPlanningAttribute13; string; Value of the planning attribute number 13 associated with the demand for the recommendation.
    • ToPlanningAttribute13Id; integer; Value that uniquely identifies the ID of planning attribute number 13 associated with the demand for the recommendation.
    • ToPlanningAttribute14; string; Value of the planning attribute number 14 associated with the demand for the recommendation.
    • ToPlanningAttribute14Id; integer; Value that uniquely identifies the ID of planning attribute number 14 associated with the demand for the recommendation.
    • ToPlanningAttribute15; string; Value of the planning attribute number 15 associated with the demand for the recommendation.
    • ToPlanningAttribute15Id; integer; Value that uniquely identifies the ID of planning attribute number 15 associated with the demand for the recommendation.
    • ToPlanningAttribute3; string; Value of the planning attribute number 3 associated with the demand for the recommendation.
    • ToPlanningAttribute3Id; integer; Value that uniquely identifies the ID of planning attribute number 3 associated with the demand for the recommendation.
    • ToPlanningAttribute4; string; Value of the planning attribute number 4 associated with the demand for the recommendation.
    • ToPlanningAttribute4Id; integer; Value that uniquely identifies the ID of planning attribute number 4 associated with the demand for the recommendation.
    • ToPlanningAttribute5; string; Value of the planning attribute number 5 associated with the demand for the recommendation.
    • ToPlanningAttribute5Id; integer; Value that uniquely identifies the ID of planning attribute number 5 associated with the demand for the recommendation.
    • ToPlanningAttribute6; string; Value of the planning attribute number 6 associated with the demand for the recommendation.
    • ToPlanningAttribute6Id; integer; Value that uniquely identifies the ID of planning attribute number 6 associated with the demand for the recommendation.
    • ToPlanningAttribute7; string; Value of the planning attribute number 7 associated with the demand for the recommendation.
    • ToPlanningAttribute7Id; integer; Value that uniquely identifies the ID of planning attribute number 7 associated with the demand for the recommendation.
    • ToPlanningAttribute8; string; Value of the planning attribute number 8 associated with the demand for the recommendation.
    • ToPlanningAttribute8Id; integer; Value that uniquely identifies the ID of planning attribute number 8 associated with the demand for the recommendation.
    • ToPlanningAttribute9; string; Value of the planning attribute number 9 associated with the demand for the recommendation.
    • ToPlanningAttribute9Id; integer; Value that uniquely identifies the ID of planning attribute number 9 associated with the demand for the recommendation.
    • ToProjectGroupValue; string; Value of the project group associated with the demand.
    • ToProjectGroupValueId; integer; Value that uniquely identifies the ID of the project group value associated with the demand for the recommendation.
    • ToProjectValue; string; Value of the project associated with the demand.
    • ToProjectValueId; integer; Value that uniquely identifies the ID of the project value associated with the demand for the recommendation.
    • ToTaskValue; string; Value of the task associated with the demand.
    • ToTaskValueId; integer; Value that uniquely identifies the ID of the task value associated with the demand for the recommendation.
    • TransactionId; integer; Value of the transaction ID of the related supply.
    • TransferQuantity; number; Quantity of the transfer in the recommendation.
  • 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 : supplyPlans-AttributeTransferRecommendations
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : supplyPlans-AttributeTransferRecommendations-item-response
Type: object
Show Source
Back to Top