Create a rule folder
post
/fscmRestApi/resources/11.13.18.05/configuratorModels/{configuratorModelsUniqID}/child/versions/{versionsUniqID}/child/ruleFolders
Request
Path Parameters
-
configuratorModelsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Configurator Models resource and used to uniquely identify an instance of Configurator Models. The client should not generate the hash key value. Instead, the client should query on the Configurator Models collection resource in order to navigate to a specific instance of Configurator Models to get the hash key.
-
versionsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Versions resource and used to uniquely identify an instance of Versions. The client should not generate the hash key value. Instead, the client should query on the Versions collection resource in order to navigate to a specific instance of Versions to get the hash key.
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
Root Schema : schema
Type:
Show Source
object
-
Description: string
Title:
Description
Maximum Length:1000
Description of the rule folder. -
extensionRules: array
Extension Rules
Title:
Extension Rules
The Extension Rules resource gets extension rule details for a specific model version. -
Name(required): string
Title:
Name
Maximum Length:255
Name of the rule folder. You can use a rule folder to organize your rules into groups. -
ruleFolders: array
Rule Folders
Title:
Rule Folders
The Rule Folders resource manages rule folders for a specific model version.
Nested Schema : Extension Rules
Type:
array
Title:
Extension Rules
The Extension Rules resource gets extension rule details for a specific model version.
Show Source
Nested Schema : Rule Folders
Type:
array
Title:
Rule Folders
The Rule Folders resource manages rule folders for a specific model version.
Show Source
Nested Schema : configuratorModels-versions-ruleFolders-extensionRules-item-post-request
Type:
Show Source
object
-
RuleText: string
Value that indicates the configurator extension rule text (groovy script) that describes the logic to be executed at runtime.
Nested Schema : schema
Type:
Show Source
object
-
Description: string
Title:
Description
Maximum Length:1000
Description of the rule folder. -
Name: string
Title:
Name
Maximum Length:255
Name of the rule folder. You can use a rule folder to organize your rules into groups.
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.
Root Schema : configuratorModels-versions-ruleFolders-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the rule folder. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the rule folder. -
Description: string
Title:
Description
Maximum Length:1000
Description of the rule folder. -
extensionRules: array
Extension Rules
Title:
Extension Rules
The Extension Rules resource gets extension rule details for a specific model version. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the rule folder. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the rule folder. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:255
Name of the rule folder. You can use a rule folder to organize your rules into groups. -
RuleFolderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the version of the configurator model. -
ruleFolders: array
Rule Folders
Title:
Rule Folders
The Rule Folders resource manages rule folders for a specific model version.
Nested Schema : Extension Rules
Type:
array
Title:
Extension Rules
The Extension Rules resource gets extension rule details for a specific model version.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Rule Folders
Type:
array
Title:
Rule Folders
The Rule Folders resource manages rule folders for a specific model version.
Show Source
Nested Schema : configuratorModels-versions-ruleFolders-extensionRules-item-response
Type:
Show Source
object
-
BaseNode: string
Read Only:
true
Value that indicates the base node associated with the extension rule. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the extension rule. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the extension rule. -
Description: string
Title:
Description
Read Only:true
Maximum Length:1000
Description of the extension rule. -
EnabledFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: true or false. If true, then the rule is considered enabled and the rule logic will be employed at runtime. If false, then the rule logic will be disabled at runtime. The default value is true. -
EndDate: string
(date-time)
Read Only:
true
Date when the extension rule becomes invalid because one of the participants in the rule was end-dated. -
InstantiationScope: string
Read Only:
true
Contains one of the following values: Instance or Instance Set. When the rule is invoked, the instantiation scope dictates whether a separate instance of the rule is created for each instance of the base node, or a single instance of the rule is created for the whole set of instances of the base node. -
InstantiationScopeCode: string
Read Only:
true
Maximum Length:30
Value that indicates the instantiation scope. Valid values include ORA_INSTANCE or ORA_INSTANCE_SET. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the extension rule. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the extension rule. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Read Only:true
Maximum Length:255
Name of the extension rule. -
RuleId: integer
(int64)
Read Only:
true
Value that uniquely identifies the extension rule. -
RuleText: string
Value that indicates the configurator extension rule text (groovy script) that describes the logic to be executed at runtime.
-
Status: string
Read Only:
true
Value that indicates the status of the extension rule. Valid values include Valid, Modified, or Error. -
StatusCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the extension rule status. Valid values include UNKNOWN, VALIDATED, VALIDATION_FAILED, LOGIC_GENERATED, or LOGIC_FAILED. -
Type: string
Read Only:
true
Maximum Length:14
Type of configurator rule. Valid value is Extension Rule.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : configuratorModels-versions-ruleFolders-ruleFolders-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the rule folder. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the rule folder. -
Description: string
Title:
Description
Maximum Length:1000
Description of the rule folder. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the rule folder. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the rule folder. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:255
Name of the rule folder. You can use a rule folder to organize your rules into groups. -
RuleFolderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the version of the configurator model.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- extensionRules
-
Parameters:
- RuleFolderId:
$request.path.RuleFolderId
- configuratorModelsUniqID:
$request.path.configuratorModelsUniqID
- versionsUniqID:
$request.path.versionsUniqID
The Extension Rules resource gets extension rule details for a specific model version. - RuleFolderId:
- ruleFolders
-
Parameters:
- RuleFolderId:
$request.path.RuleFolderId
- configuratorModelsUniqID:
$request.path.configuratorModelsUniqID
- versionsUniqID:
$request.path.versionsUniqID
The Rule Folders resource manages rule folders for a specific model version. - RuleFolderId:
Examples
This example describes how to create a rule folder.
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/configuratorModels/configuratorModelsUniqID/child/versions/ObjectVersionId/child/ruleFolders/ruleFolderID/child/ruleFolders"
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 creates.
{ "Name": "SR Rule Folder", "Description": "Statement Rules Rule Folder" }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "RuleFolderId": 1322, "Name": "SR Rule Folder", "Description": "Statement Rules Rule Folder", "CreationDate": "2019-12-07T23:16:48.238+00:00", "CreatedBy": "JRSMITH", "LastUpdateDate": "2019-12-07T23:16:48.238+00:00", "LastUpdatedBy": "JRSMITH" }