Jump to

• Request
• Response

Get all attribute-based transfer recommendations

get

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

Request

Path Parameters

• PlanId(required): integer(int64)
  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 :Finds an attribute-based transfer recommendation based on the primary search criteria.
    Finder Variables:
• 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:
  

  • 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.
  • DemandDate; string; Date when the material for the demand is due.
  • 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.
  • 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.
  • 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.
  • FromPlanningAttribute11; string; Value of the 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.
  • FromPlanningAttribute13; string; Value of the 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.
  • FromPlanningAttribute15; string; Value of the 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.
  • FromPlanningAttribute4; string; Value of the 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.
  • FromPlanningAttribute6; string; Value of the 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.
  • FromPlanningAttribute8; string; Value of the 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.
  • FromProjectGroupValue; string; Value of the project group associated with the supply for the recommendation.
  • FromProjectValue; string; Value of the project associated with the supply for the recommendation.
  • FromTaskValue; string; Value of the task 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.
  • 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.
  • PlannerName; string; Abbreviation that identifies the planner responsible for the item.
  • 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.
  • 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.
  • ToPlanningAttribute11; string; Value of the 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.
  • ToPlanningAttribute13; string; Value of the 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.
  • ToPlanningAttribute15; string; Value of the 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.
  • ToPlanningAttribute4; string; Value of the 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.
  • ToPlanningAttribute6; string; Value of the 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.
  • ToPlanningAttribute8; string; Value of the 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.
  • ToProjectGroupValue; string; Value of the project group associated with the demand.
  • ToProjectValue; string; Value of the project associated with the demand.
  • ToTaskValue; string; Value of the task associated with the demand.
  • TransferQuantity; number; Quantity of the transfer in the recommendation.
• 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: string
  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: string
  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

• 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.

Body ()

Root Schema : supplyPlans-AttributeTransferRecommendations

Type: object

Show Source

• 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.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/supplyPlans-AttributeTransferRecommendations-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object supplyPlans-AttributeTransferRecommendations-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/supplyPlans-AttributeTransferRecommendations-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : supplyPlans-AttributeTransferRecommendations-item-response

Type: object

Show Source

• Action: string
  Title: Action

  Read Only: true

  Maximum Length: 255

  Value that indicates the action recommended by planning. A list of accepted values is defined in the lookup type ORA_MSC_ACTIONS.
• ActionId: integer
  Title: Action

  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
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Indicates the user who created the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Indicates the date and time of the creation of the row.
• DemandDate: string (date)
  Title: Demand Date

  Read Only: true

  Date when the material for the demand is due.
• DemandLineNumber: string
  Title: Demand Line Number

  Read Only: true

  Maximum Length: 100

  Line number associated with the demand.
• DemandOrderNumber: string
  Title: Demand Order Number

  Read Only: true

  Maximum Length: 4000

  Order number of a demand.
• DemandOrderType: string
  Title: Demand Order Type

  Maximum Length: 4000

  Value that indicates the order type of a demand.
• DemandOrderTypeCode: integer (int32)
  Title: Demand Order Type

  Abbreviation that identifies the order type of the demand.
• DemandQuantity: number
  Title: Demand Quantity

  Read Only: true

  Quantity of the demand in the recommendation.
• FirmDate: string (date)
  Title: Firm Date

  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
  Title: Firm Quantity

  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.
• FirmStatus: string
  Title: Firm Status

  Read Only: true

  Maximum Length: 255

  Indicates whether a supply order is firm. Valid values are firm or not firm.
• FirmStatusCode: integer (int32)
  Title: Firm Status

  Indicates whether a supply order is firm. Valid values are 1 and 2.
• FromPlanningAttribute10: string
  Maximum Length: 4000

  Value of the planning attribute number 10 associated with the supply for the recommendation.
• FromPlanningAttribute11: string
  Maximum Length: 4000

  Value of the planning attribute number 11 associated with the supply for the recommendation.
• FromPlanningAttribute12: string
  Maximum Length: 4000

  Value of the planning attribute number 12 associated with the supply for the recommendation.
• FromPlanningAttribute13: string
  Maximum Length: 4000

  Value of the planning attribute number 13 associated with the supply for the recommendation.
• FromPlanningAttribute14: string
  Maximum Length: 4000

  Value of the planning attribute number 14 associated with the supply for the recommendation.
• FromPlanningAttribute15: string
  Maximum Length: 4000

  Value of the planning attribute number 15 associated with the supply for the recommendation.
• FromPlanningAttribute3: string
  Maximum Length: 4000

  Value of the planning attribute number 3 associated with the supply for the recommendation.
• FromPlanningAttribute4: string
  Maximum Length: 4000

  Value of the planning attribute number 4 associated with the supply for the recommendation.
• FromPlanningAttribute5: string
  Maximum Length: 4000

  Value of the planning attribute number 5 associated with the supply for the recommendation.
• FromPlanningAttribute6: string
  Maximum Length: 4000

  Value of the planning attribute number 6 associated with the supply for the recommendation.
• FromPlanningAttribute7: string
  Maximum Length: 4000

  Value of the planning attribute number 7 associated with the supply for the recommendation.
• FromPlanningAttribute8: string
  Maximum Length: 4000

  Value of the planning attribute number 8 associated with the supply for the recommendation.
• FromPlanningAttribute9: string
  Maximum Length: 4000

  Value of the planning attribute number 9 associated with the supply for the recommendation.
• FromProjectGroupValue: string
  Title: From - Project Group

  Maximum Length: 4000

  Value of the project group associated with the supply for the recommendation.
• FromProjectValue: string
  Title: From - Project

  Maximum Length: 4000

  Value of the project associated with the supply for the recommendation.
• FromTaskValue: string
  Title: From - Task

  Maximum Length: 4000

  Value of the task associated with the supply for the recommendation.
• ImplementedQuantity: number
  Title: Implemented Quantity

  Read Only: true

  Cumulative quantity that has been released to date.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the item.
• Item: string
  Title: Item

  Read Only: true

  Maximum Length: 4000

  Name of the item.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Indicates the date and time of the last update of the row.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Indicates the user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrderStatus: string
  Title: Order Status

  Read Only: true

  Maximum Length: 255

  SCM Cloud transactional status of a work order, purchase order, or transfer order supplies that are referred to by the planning process.
• OrderStatusCode: integer
  Title: Order Status

  Read Only: true

  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
  Title: Organization

  Read Only: true

  Maximum Length: 4000

  Name of the organization associated with the order.
• OrganizationId: integer (int64)
  Value that uniquely identifies the organization.
• PlannerDescription: string
  Title: Planner Description

  Maximum Length: 100

  Description of the planner responsible for the item.
• PlannerName: string
  Title: Planner

  Maximum Length: 10

  Abbreviation that identifies the planner responsible for the item.
• ReleaseErrors: string
  Title: Release Errors

  Maximum Length: 250

  Errors that are generated in the release process.
• ReleaseStatusCode: integer
  Title: Release Status

  Code that indicates the release status of the order. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_RELEASE_STATUS.
• ReleaseStatusText: string
  Title: Release Status

  Read Only: true

  Maximum Length: 255

  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.
• SupplyDate: string (date)
  Title: Supply Date

  Date when the material for the supply is available.
• SupplyLineNumber: string
  Title: Supply Line Number

  Maximum Length: 100

  Line number associated with the supply.
• SupplyOrderNumber: string
  Title: Supply Order Number

  Maximum Length: 4000

  Order number of a supply.
• SupplyOrderType: string
  Title: Supply Order Type

  Maximum Length: 4000

  Value that indicates the order type of a supply.
• SupplyOrderTypeCode: integer (int32)
  Title: Supply Order Type

  Abbreviation that identifies the order type of the supply.
• SupplyQuantity: number
  Title: Supply Quantity

  Quantity of the supply in the recommendation.
• ToPlanningAttribute10: string
  Maximum Length: 4000

  Value of the planning attribute number 10 associated with the demand for the recommendation.
• ToPlanningAttribute11: string
  Maximum Length: 4000

  Value of the planning attribute number 11 associated with the demand for the recommendation.
• ToPlanningAttribute12: string
  Maximum Length: 4000

  Value of the planning attribute number 12 associated with the demand for the recommendation.
• ToPlanningAttribute13: string
  Maximum Length: 4000

  Value of the planning attribute number 13 associated with the demand for the recommendation.
• ToPlanningAttribute14: string
  Maximum Length: 4000

  Value of the planning attribute number 14 associated with the demand for the recommendation.
• ToPlanningAttribute15: string
  Maximum Length: 4000

  Value of the planning attribute number 15 associated with the demand for the recommendation.
• ToPlanningAttribute3: string
  Maximum Length: 4000

  Value of the planning attribute number 3 associated with the demand for the recommendation.
• ToPlanningAttribute4: string
  Maximum Length: 4000

  Value of the planning attribute number 4 associated with the demand for the recommendation.
• ToPlanningAttribute5: string
  Maximum Length: 4000

  Value of the planning attribute number 5 associated with the demand for the recommendation.
• ToPlanningAttribute6: string
  Maximum Length: 4000

  Value of the planning attribute number 6 associated with the demand for the recommendation.
• ToPlanningAttribute7: string
  Maximum Length: 4000

  Value of the planning attribute number 7 associated with the demand for the recommendation.
• ToPlanningAttribute8: string
  Maximum Length: 4000

  Value of the planning attribute number 8 associated with the demand for the recommendation.
• ToPlanningAttribute9: string
  Maximum Length: 4000

  Value of the planning attribute number 9 associated with the demand for the recommendation.
• ToProjectGroupValue: string
  Title: To - Project Group

  Maximum Length: 4000

  Value of the project group associated with the demand.
• ToProjectValue: string
  Title: To - Project

  Maximum Length: 4000

  Value of the project associated with the demand.
• ToTaskValue: string
  Title: To - Task

  Maximum Length: 4000

  Value of the task associated with the demand.
• TransferQuantity: number
  Title: Transfer Quantity

  Read Only: true

  Quantity of the transfer in the recommendation.

{
    "type":"object",
    "properties":{
        "Action":{
            "title":"Action",
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the action recommended by planning. A list of accepted values is defined in the lookup type ORA_MSC_ACTIONS.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionId":{
            "title":"Action",
            "type":"integer",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ],
                "AllowMultipleValues":"true"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Indicates the date and time of the creation of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "DemandDate":{
            "title":"Demand Date",
            "type":"string",
            "description":"Date when the material for the demand is due.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandLineNumber":{
            "title":"Demand Line Number",
            "maxLength":100,
            "type":"string",
            "description":"Line number associated with the demand.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandOrderNumber":{
            "title":"Demand Order Number",
            "maxLength":4000,
            "type":"string",
            "description":"Order number of a demand.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandOrderType":{
            "title":"Demand Order Type",
            "maxLength":4000,
            "type":"string",
            "description":"Value that indicates the order type of a demand.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "DemandOrderTypeCode":{
            "title":"Demand Order Type",
            "type":"integer",
            "description":"Abbreviation that identifies the order type of the demand.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":9
            },
            "x-queryable":true
        },
        "DemandQuantity":{
            "title":"Demand Quantity",
            "type":"number",
            "description":"Quantity of the demand in the recommendation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirmDate":{
            "title":"Firm Date",
            "type":"string",
            "description":"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.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "FirmQuantity":{
            "title":"Firm Quantity",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "FirmStatus":{
            "title":"Firm Status",
            "maxLength":255,
            "type":"string",
            "description":"Indicates whether a supply order is firm. Valid values are firm or not firm.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirmStatusCode":{
            "title":"Firm Status",
            "type":"integer",
            "description":"Indicates whether a supply order is firm. Valid values are 1 and 2.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ],
                "precision":9
            },
            "x-queryable":true
        },
        "FromPlanningAttribute10":{
            "maxLength":4000,
            "type":"string",
            "description":"Value of the planning attribute number 10 associated with the supply for the recommendation.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "FromPlanningAttribute11":{
            "maxLength":4000,
            "type":"string",
            "description":"Value of the planning attribute number 11 associated with the supply for the recommendation.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "FromPlanningAttribute12":{
            "maxLength":4000,
            "type":"string",
            "description":"Value of the planning attribute number 12 associated with the supply for the recommendation.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "FromPlanningAttribute13":{
            "maxLength":4000,
            "type":"string",
            "description":"Value of the planning attribute number 13 associated with the supply for the recommendation.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "FromPlanningAttribute14":{
            "maxLength":4000,
            "type":"string",
            "description":"Value of the planning attribute number 14 associated with the supply for the recommendation.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "FromPlanningAttribute15":{
            "maxLength":4000,
            "type":"string",
            "description":"Value of the planning attribute number 15 associated with the supply for the recommendation.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "FromPlanningAttribute3":{
            "maxLength":4000,
            "type":"string",
            "description":"Value of the planning attribute number 3 associated with the supply for the recommendation.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "FromPlanningAttribute4":{
            "maxLength":4000,
            "type":"string",
            "description":"Value of the planning attribute number 4 associated with the supply for the recommendation.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "FromPlanningAttribute5":{
            "maxLength":4000,
            "type":"string",
            "description":"Value of the planning attribute number 5 associated with the supply for the recommendation.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "FromPlanningAttribute6":{
            "maxLength":4000,
            "type":"string",
            "description":"Value of the planning attribute number 6 associated with the supply for the recommendation.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "FromPlanningAttribute7":{
            "maxLength":4000,
            "type":"string",
            "description":"Value of the planning attribute number 7 associated with the supply for the recommendation.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "FromPlanningAttribute8":{
            "maxLength":4000,
            "type":"string",
            "description":"Value of the planning attribute number 8 associated with the supply for the recommendation.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "FromPlanningAttribute9":{
            "maxLength":4000,
            "type":"string",
            "description":"Value of the planning attribute number 9 associated with the supply for the recommendation.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "FromProjectGroupValue":{
            "title":"From - Project Group",
            "maxLength":4000,
            "type":"string",
            "description":"Value of the project group associated with the supply for the recommendation.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "FromProjectValue":{
            "title":"From - Project",
            "maxLength":4000,
            "type":"string",
            "description":"Value of the project associated with the supply for the recommendation.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "FromTaskValue":{
            "title":"From - Task",
            "maxLength":4000,
            "type":"string",
            "description":"Value of the task associated with the supply for the recommendation.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "ImplementedQuantity":{
            "title":"Implemented Quantity",
            "type":"number",
            "description":"Cumulative quantity that has been released to date.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "Item":{
            "title":"Item",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Indicates the date and time of the last update of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "OrderStatus":{
            "title":"Order Status",
            "maxLength":255,
            "type":"string",
            "description":"SCM Cloud transactional status of a work order, purchase order, or transfer order supplies that are referred to by the planning process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderStatusCode":{
            "title":"Order Status",
            "type":"integer",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Organization":{
            "title":"Organization",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the organization associated with the order.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "PlannerDescription":{
            "title":"Planner Description",
            "maxLength":100,
            "type":"string",
            "description":"Description of the planner responsible for the item.",
            "nullable":true,
            "x-queryable":false
        },
        "PlannerName":{
            "title":"Planner",
            "maxLength":10,
            "type":"string",
            "description":"Abbreviation that identifies the planner responsible for the item.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "ReleaseErrors":{
            "title":"Release Errors",
            "maxLength":250,
            "type":"string",
            "description":"Errors that are generated in the release process.",
            "nullable":true,
            "x-queryable":false
        },
        "ReleaseStatusCode":{
            "title":"Release Status",
            "type":"integer",
            "description":"Code that indicates the release status of the order. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_RELEASE_STATUS.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "AllowMultipleValues":"true"
            }
        },
        "ReleaseStatusText":{
            "title":"Release Status",
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplyDate":{
            "title":"Supply Date",
            "type":"string",
            "description":"Date when the material for the supply is available.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SupplyLineNumber":{
            "title":"Supply Line Number",
            "maxLength":100,
            "type":"string",
            "description":"Line number associated with the supply.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplyOrderNumber":{
            "title":"Supply Order Number",
            "maxLength":4000,
            "type":"string",
            "description":"Order number of a supply.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplyOrderType":{
            "title":"Supply Order Type",
            "maxLength":4000,
            "type":"string",
            "description":"Value that indicates the order type of a supply.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "SupplyOrderTypeCode":{
            "title":"Supply Order Type",
            "type":"integer",
            "description":"Abbreviation that identifies the order type of the supply.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":9
            },
            "x-queryable":true
        },
        "SupplyQuantity":{
            "title":"Supply Quantity",
            "type":"number",
            "description":"Quantity of the supply in the recommendation.",
            "nullable":true,
            "x-queryable":true
        },
        "ToPlanningAttribute10":{
            "maxLength":4000,
            "type":"string",
            "description":"Value of the planning attribute number 10 associated with the demand for the recommendation.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ToPlanningAttribute11":{
            "maxLength":4000,
            "type":"string",
            "description":"Value of the planning attribute number 11 associated with the demand for the recommendation.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ToPlanningAttribute12":{
            "maxLength":4000,
            "type":"string",
            "description":"Value of the planning attribute number 12 associated with the demand for the recommendation.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ToPlanningAttribute13":{
            "maxLength":4000,
            "type":"string",
            "description":"Value of the planning attribute number 13 associated with the demand for the recommendation.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ToPlanningAttribute14":{
            "maxLength":4000,
            "type":"string",
            "description":"Value of the planning attribute number 14 associated with the demand for the recommendation.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ToPlanningAttribute15":{
            "maxLength":4000,
            "type":"string",
            "description":"Value of the planning attribute number 15 associated with the demand for the recommendation.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ToPlanningAttribute3":{
            "maxLength":4000,
            "type":"string",
            "description":"Value of the planning attribute number 3 associated with the demand for the recommendation.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ToPlanningAttribute4":{
            "maxLength":4000,
            "type":"string",
            "description":"Value of the planning attribute number 4 associated with the demand for the recommendation.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ToPlanningAttribute5":{
            "maxLength":4000,
            "type":"string",
            "description":"Value of the planning attribute number 5 associated with the demand for the recommendation.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ToPlanningAttribute6":{
            "maxLength":4000,
            "type":"string",
            "description":"Value of the planning attribute number 6 associated with the demand for the recommendation.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ToPlanningAttribute7":{
            "maxLength":4000,
            "type":"string",
            "description":"Value of the planning attribute number 7 associated with the demand for the recommendation.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ToPlanningAttribute8":{
            "maxLength":4000,
            "type":"string",
            "description":"Value of the planning attribute number 8 associated with the demand for the recommendation.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ToPlanningAttribute9":{
            "maxLength":4000,
            "type":"string",
            "description":"Value of the planning attribute number 9 associated with the demand for the recommendation.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ToProjectGroupValue":{
            "title":"To - Project Group",
            "maxLength":4000,
            "type":"string",
            "description":"Value of the project group associated with the demand.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "ToProjectValue":{
            "title":"To - Project",
            "maxLength":4000,
            "type":"string",
            "description":"Value of the project associated with the demand.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "ToTaskValue":{
            "title":"To - Task",
            "maxLength":4000,
            "type":"string",
            "description":"Value of the task associated with the demand.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "TransferQuantity":{
            "title":"Transfer Quantity",
            "type":"number",
            "description":"Quantity of the transfer in the recommendation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top