Create a rule folder
post
/fscmRestApi/resources/11.13.18.05/configuratorModels/{configuratorModelsUniqID}/child/versions/{versionsUniqID}/child/ruleFolders/{RuleFolderId}/child/ruleFolders
Request
Path Parameters
-
RuleFolderId(required): integer(int64)
Value that uniquely identifies the version of the configurator model.
-
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. -
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(required):
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(required):
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-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
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.