Jump to

• Request
• Response
• Examples

Create a demand priority attribute in a demand priority rule

post

/fscmRestApi/resources/11.13.18.05/scpDemandPriorityRules/{RuleId}/child/scpDemandPriorityAttributes

Request

Path Parameters

• RuleId(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=

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

{
    "required":[
        "RuleId"
    ],
    "type":"object",
    "properties":{
        "Message":{
            "title":"Message",
            "maxLength":"255",
            "type":"string",
            "description":"Message that indicates if the attribute was successfully created or not in a demand priority rule.",
            "nullable":true
        },
        "AttributeId":{
            "title":"Attribute Identifier",
            "type":"integer",
            "description":"Unique identifier of a demand priority attribute used in a demand priority rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AttributeRank":{
            "title":"Attribute Rank",
            "type":"integer",
            "description":"Value that helps the user rank demand priority attributes.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SortOrderList":{
            "title":"Sort Order List",
            "maxLength":"4000",
            "type":"string",
            "description":"Comma-separated values appearing in a sequence for the selected attributes in a demand priority rule.",
            "nullable":true
        },
        "RuleId":{
            "title":"Rule Identifier",
            "type":"integer",
            "description":"Unique identifier of a demand priority rule in which the demand priority attribute is used.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AttributePriority":{
            "title":"Attribute Priority",
            "type":"integer",
            "description":"Value that uniquely identifies the priority of the attribute in a demand priority rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SortOrder":{
            "title":"Sort Order",
            "maxLength":"255",
            "type":"string",
            "description":"Indicates the sequence of values for an attribute that's used to prioritize demands in a demand priority rule.",
            "nullable":true
        },
        "scpDemandPriorityAttributeDetails":{
            "title":"Demand Priority Attribute Details",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/scpDemandPriorityRules-scpDemandPriorityAttributes-scpDemandPriorityAttributeDetails-item-post-request"
            }
        },
        "AttributeName":{
            "title":"Attribute Name",
            "maxLength":"64",
            "type":"string",
            "description":"Name of a demand priority attribute used in a demand priority rule.",
            "nullable":true
        }
    }
}

Nested Schema : Demand Priority Attribute Details

Type: array

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.

Show Source

• Array of: object scpDemandPriorityRules-scpDemandPriorityAttributes-scpDemandPriorityAttributeDetails-item-post-request

{
    "title":"Demand Priority Attribute Details",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/scpDemandPriorityRules-scpDemandPriorityAttributes-scpDemandPriorityAttributeDetails-item-post-request"
    }
}

Nested Schema : scpDemandPriorityRules-scpDemandPriorityAttributes-scpDemandPriorityAttributeDetails-item-post-request

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "AttributeValue":{
            "title":"Attribute Value",
            "maxLength":"255",
            "type":"string",
            "description":"Value of the selected attribute used in a demand priority rule.",
            "nullable":true
        },
        "AttributeId":{
            "title":"Attribute Identifier",
            "type":"integer",
            "description":"Unique identifier of a demand priority attribute value used in a rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AttributeSequenceId":{
            "title":"Attribute Sequence Identifier",
            "type":"integer",
            "description":"Value that uniquely identifies the sequence of the selected attribute values in a demand priority rule.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AttributeValueId":{
            "title":"Attribute Value Identifier",
            "maxLength":"100",
            "type":"string",
            "description":"Value that uniquely identifies the selected attribute's value based on the value identifier in a demand priority rule.",
            "nullable":false
        }
    }
}

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 : scpDemandPriorityRules-scpDemandPriorityAttributes-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated an attribute in a demand priority rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the user created the attribute in a demand priority rule.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"Name of the user who initially created the attribute in a demand priority rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Message":{
            "title":"Message",
            "maxLength":"255",
            "type":"string",
            "description":"Message that indicates if the attribute was successfully created or not in a demand priority rule.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeId":{
            "title":"Attribute Identifier",
            "type":"integer",
            "description":"Unique identifier of a demand priority attribute used in a demand priority rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RuleId":{
            "title":"Rule Identifier",
            "type":"integer",
            "description":"Unique identifier of a demand priority rule in which the demand priority attribute is used.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SortOrder":{
            "title":"Sort Order",
            "maxLength":"255",
            "type":"string",
            "description":"Indicates the sequence of values for an attribute that's used to prioritize demands in a demand priority rule.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeRank":{
            "title":"Attribute Rank",
            "type":"integer",
            "description":"Value that helps the user rank demand priority attributes.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SortOrderList":{
            "title":"Sort Order List",
            "maxLength":"4000",
            "type":"string",
            "description":"Comma-separated values appearing in a sequence for the selected attributes in a demand priority rule.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributePriority":{
            "title":"Attribute Priority",
            "type":"integer",
            "description":"Value that uniquely identifies the priority of the attribute in a demand priority rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "scpDemandPriorityAttributeDetails":{
            "title":"Demand Priority Attribute Details",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/scpDemandPriorityRules-scpDemandPriorityAttributes-scpDemandPriorityAttributeDetails-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttributeName":{
            "title":"Attribute Name",
            "maxLength":"64",
            "type":"string",
            "description":"Name of a demand priority attribute used in a demand priority rule.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the user most recently updated an attribute in a demand priority rule.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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 : Demand Priority Attribute Details

Type: array

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.

Show Source

• Array of: object scpDemandPriorityRules-scpDemandPriorityAttributes-scpDemandPriorityAttributeDetails-item-response

{
    "title":"Demand Priority Attribute Details",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/scpDemandPriorityRules-scpDemandPriorityAttributes-scpDemandPriorityAttributeDetails-item-response"
    }
}

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."
        }
    }
}

Nested Schema : scpDemandPriorityRules-scpDemandPriorityAttributes-scpDemandPriorityAttributeDetails-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the attribute details for an attribute in a demand priority rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the user created the attribute details for an attribute in a demand priority rule.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeValue":{
            "title":"Attribute Value",
            "maxLength":"255",
            "type":"string",
            "description":"Value of the selected attribute used in a demand priority rule.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"Name of the user who initially created the attribute details for a demand priority attribute in a rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeId":{
            "title":"Attribute Identifier",
            "type":"integer",
            "description":"Unique identifier of a demand priority attribute value used in a rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AttributeSequenceId":{
            "title":"Attribute Sequence Identifier",
            "type":"integer",
            "description":"Value that uniquely identifies the sequence of the selected attribute values in a demand priority rule.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AttributeValueId":{
            "title":"Attribute Value Identifier",
            "maxLength":"100",
            "type":"string",
            "description":"Value that uniquely identifies the selected attribute's value based on the value identifier in a demand priority rule.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the user most recently updated the attribute details for an attribute in a demand priority rule.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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"
    }
}

Links

scpDemandPriorityAttributeDetails

Operation: /fscmRestApi/resources/11.13.18.05/scpDemandPriorityRules/{RuleId}/child/scpDemandPriorityAttributes/{AttributeId}/child/scpDemandPriorityAttributeDetails

Parameters:

• AttributeId: $request.path.AttributeId
• RuleId: $request.path.RuleId

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.

Back to Top

Examples

This example describes how to create a demand priority attribute in 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/RuleId/child/scpDemandPriorityAttributes"

For example:

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/scpDemandPriorityRules/300100613239506/child/scpDemandPriorityAttributes"

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.

{
"AttributeName": "Requested Item",
"AttributeRank": 5,
"SortOrderList":"RBPS-GREENROLLOS555"
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
"AttributeId": 300100667389219,
"AttributeName": "Requested Item",
"AttributePriority": null,
"AttributeRank": 5,
"CreatedBy": "APS_ALL",
"CreationDate": "2024-06-06T07:32:39+00:00",
"RuleId": 300100666134541,
"SortOrder": "",
"SortOrderList": "RBPS-GREENROLLOS555",
"Message": null,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/scpDemandPriorityRules/300100666134541/child/scpDemandPriorityAttributes/300100667389219",
"name": "scpDemandPriorityAttributes",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/scpDemandPriorityRules/300100666134541/child/scpDemandPriorityAttributes/300100667389219",
"name": "scpDemandPriorityAttributes",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/scpDemandPriorityRules/300100666134541",
"name": "scpDemandPriorityRules",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/scpDemandPriorityRules/300100666134541/child/scpDemandPriorityAttributes/300100667389219/child/scpDemandPriorityAttributeDetails",
"name": "scpDemandPriorityAttributeDetails",
"kind": "collection"
}
]
}

Back to Top