Create a demand priority rule
/fscmRestApi/resources/11.13.18.05/scpDemandPriorityRules
Request
-
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
- application/json
object
-
Message: string
Title:
Message
Maximum Length:255
Message that indicates if a demand priority rule was created successfully or not. -
RuleDescription: string
Title:
Rule Description
Maximum Length:64
Description of a demand priority rule. -
RuleId: integer
(int64)
Title:
Rule Identifier
Unique identifier of a demand priority rule. -
RuleName(required): string
Title:
Rule Name
Maximum Length:64
Name of a demand priority rule. -
scpDemandPriorityAttributes: array
Demand Priority Attributes
Title:
Demand Priority Attributes
Attributes used in a demand priority rule to prioritize demand, for example, Requested Item, Order Revenue, and Requested Date.
array
Demand Priority Attributes
object
-
AttributeId: integer
(int64)
Title:
Attribute Identifier
Unique identifier of a demand priority attribute used in a demand priority rule. -
AttributeName: string
Title:
Attribute Name
Maximum Length:64
Name of a demand priority attribute used in a demand priority rule. -
AttributePriority: integer
(int64)
Title:
Attribute Priority
Value that uniquely identifies the priority of the attribute in a demand priority rule. -
AttributeRank: integer
(int64)
Title:
Attribute Rank
Value that helps the user rank demand priority attributes. -
Message: string
Title:
Message
Maximum Length:255
Message that indicates if the attribute was successfully created or not in a demand priority rule. -
RuleId(required): integer
(int64)
Title:
Rule Identifier
Unique identifier of a demand priority rule in which the demand priority attribute is used. -
scpDemandPriorityAttributeDetails: array
Demand Priority Attribute Details
Title:
Demand Priority Attribute Details
Details of an attribute used in a demand priority rule to prioritize demand. For example, the attribute Requested Item could have values Item 1, Item 2, and Item 3, which could be used in a sequence. -
SortOrder: string
Title:
Sort Order
Maximum Length:255
Indicates the sequence of values for an attribute that's used to prioritize demands in a demand priority rule. -
SortOrderList: string
Title:
Sort Order List
Maximum Length:4000
Comma-separated values appearing in a sequence for the selected attributes in a demand priority rule.
array
Demand Priority Attribute Details
object
-
AttributeId: integer
(int64)
Title:
Attribute Identifier
Unique identifier of a demand priority attribute value used in a rule. -
AttributeSequenceId: integer
(int64)
Title:
Attribute Sequence Identifier
Value that uniquely identifies the sequence of the selected attribute values in a demand priority rule. -
AttributeValue: string
Title:
Attribute Value
Maximum Length:255
Value of the selected attribute used in a demand priority rule. -
AttributeValueId: string
Title:
Attribute Value Identifier
Maximum Length:100
Value that uniquely identifies the selected attribute's value based on the value identifier in a demand priority rule.
Response
- application/json
Default Response
-
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.
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Name of the user who initially created the demand priority rule. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the demand priority rule. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the user most recently updated a demand priority rule. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who most recently updated a demand priority rule. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Message: string
Title:
Message
Maximum Length:255
Message that indicates if a demand priority rule was created successfully or not. -
RuleDescription: string
Title:
Rule Description
Maximum Length:64
Description of a demand priority rule. -
RuleId: integer
(int64)
Title:
Rule Identifier
Unique identifier of a demand priority rule. -
RuleName: string
Title:
Rule Name
Maximum Length:64
Name of a demand priority rule. -
scpDemandPriorityAttributes: array
Demand Priority Attributes
Title:
Demand Priority Attributes
Attributes used in a demand priority rule to prioritize demand, for example, Requested Item, Order Revenue, and Requested Date.
array
Links
array
Demand Priority Attributes
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
object
-
AttributeId: integer
(int64)
Title:
Attribute Identifier
Unique identifier of a demand priority attribute used in a demand priority rule. -
AttributeName: string
Title:
Attribute Name
Maximum Length:64
Name of a demand priority attribute used in a demand priority rule. -
AttributePriority: integer
(int64)
Title:
Attribute Priority
Value that uniquely identifies the priority of the attribute in a demand priority rule. -
AttributeRank: integer
(int64)
Title:
Attribute Rank
Value that helps the user rank demand priority attributes. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Name of the user who initially created the attribute in a demand priority rule. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the attribute in a demand priority rule. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the user most recently updated an attribute in a demand priority rule. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who most recently updated an attribute in a demand priority rule. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Message: string
Title:
Message
Maximum Length:255
Message that indicates if the attribute was successfully created or not in a demand priority rule. -
RuleId: integer
(int64)
Title:
Rule Identifier
Unique identifier of a demand priority rule in which the demand priority attribute is used. -
scpDemandPriorityAttributeDetails: array
Demand Priority Attribute Details
Title:
Demand Priority Attribute Details
Details of an attribute used in a demand priority rule to prioritize demand. For example, the attribute Requested Item could have values Item 1, Item 2, and Item 3, which could be used in a sequence. -
SortOrder: string
Title:
Sort Order
Maximum Length:255
Indicates the sequence of values for an attribute that's used to prioritize demands in a demand priority rule. -
SortOrderList: string
Title:
Sort Order List
Maximum Length:4000
Comma-separated values appearing in a sequence for the selected attributes in a demand priority rule.
array
Links
array
Demand Priority Attribute Details
object
-
AttributeId: integer
(int64)
Title:
Attribute Identifier
Unique identifier of a demand priority attribute value used in a rule. -
AttributeSequenceId: integer
(int64)
Title:
Attribute Sequence Identifier
Value that uniquely identifies the sequence of the selected attribute values in a demand priority rule. -
AttributeValue: string
Title:
Attribute Value
Maximum Length:255
Value of the selected attribute used in a demand priority rule. -
AttributeValueId: string
Title:
Attribute Value Identifier
Maximum Length:100
Value that uniquely identifies the selected attribute's value based on the value identifier in a demand priority rule. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Name of the user who initially created the attribute details for a demand priority attribute in a rule. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the attribute details for an attribute in a demand priority rule. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the user most recently updated the attribute details for an attribute in a demand priority rule. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who most recently updated the attribute details for an attribute in a demand priority rule. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
array
Links
- scpDemandPriorityAttributes
-
Operation: /fscmRestApi/resources/11.13.18.05/scpDemandPriorityRules/{RuleId}/child/scpDemandPriorityAttributesParameters:
- RuleId:
$request.path.RuleId
Attributes used in a demand priority rule to prioritize demand, for example, Requested Item, Order Revenue, and Requested Date. - RuleId:
Examples
This example describes how to create a demand priority rule.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/scpDemandPriorityRules"
Note:
For all four different sort types use these lookup codes:
1. MSC_YES_NO
2. ORA_MSC_BM_RULE_DATE_PRIORITY
3. ORA_MSC_BM_RULE_NMBER_PRIORITY
4. ORA_MSC_MDPR_DIS_ATTR_SRT_ORD
These are the attributes you can select on the Demand Priority Rules UI where the following lookups are used:
1. Simulation Demand - MSC_YES_NO
2. Scheduling Status - ORA_MSC_BM_RULE_SCHEDLE_STATUS
3. Request Type - ORA_MSC_ORDER_DATE_TYPE_CODE
4. Item Type - ORA_MSC_BOM_ITEM_TYPE
5. Set Type - ORA_MSC_BM_SET_TYPE
6. Source Order Document Type - MSC_ORDER_TYPE
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.
{ "IsDefault": null, "ObjectVersionNumber": 1, "RuleDescription": "test rule U", "RuleName": "TestRuleU", "RuleType": null }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "CreatedBy": "APS_ALL", "CreationDate": "2024-05-15T06:44:21+00:00", "IsDefault": null, "LastUpdateDate": "2024-05-15T06:44:21.085+00:00", "LastUpdateLogin": "1878A8E83588013DE06309BE6C64CFEE", "LastUpdatedBy": "APS_ALL", "ObjectVersionNumber": 1, "RuleDescription": "test rule U", "RuleId": 5001, "RuleName": "TestRuleU", "RuleType": null, "Message": null, "links": [ { "rel": "self", "href": "http://servername/fscmRestApi/resources/version /scpDemandPriorityRules/5001", "name": "scpDemandPriorityRules", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "http://servername/fscmRestApi/resources/version /scpDemandPriorityRules/5001", "name": "scpDemandPriorityRules", "kind": "item" }, { "rel": "child", "href": "http://servername/fscmRestApi/resources/version /scpDemandPriorityRules/5001/child/scpDemandPriorityAttributes", "name": "scpDemandPriorityAttributes", "kind": "collection" } ] }