Create a rule
post
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkRules
Request
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
-
AgencyId: integer
(int32)
Title:
Agency Id
The unique identifier of the agency associated with this rule. -
AlwaysExecute: string
Title:
Always Execute
Maximum Length:1
This field is reserved for future use. -
DeletedFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N. -
Enabled: string
Title:
Enabled
Maximum Length:1
A flag on the rule to indicate whether the rule should be processed or not. The default value is N. -
EventId: integer
(int64)
The unique identifier of the event associated with this rule.
-
ModuleId: string
Maximum Length:
32
The module that owns the row. A module is an entry in the application taxonomy, such as a logical business area. When no module is identified, then the seed data framework does not extract the row as seed data. -
ResourceId: integer
(int64)
The unique identifier of the resource associated with this rule.
-
RuleDescription: string
Title:
Rule Description
Maximum Length:512
The description of this rule as it appears in the user interface. -
RuleName: string
Title:
Rule Name
Maximum Length:100
The name of this rule as it appears in the user interface. -
SeedDataLock: integer
(int32)
Default Value:
0
Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated. -
SourceRuleId: integer
(int64)
Default Value:
0
The unique identifier of the source rule for this cloned rule.
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 : publicSectorBusinessRulesFrameworkRules-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency Id
The unique identifier of the agency associated with this rule. -
AlwaysExecute: string
Title:
Always Execute
Maximum Length:1
This field is reserved for future use. -
DeletedFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N. -
Enabled: string
Title:
Enabled
Maximum Length:1
A flag on the rule to indicate whether the rule should be processed or not. The default value is N. -
EventId: integer
(int64)
The unique identifier of the event associated with this rule.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ModuleId: string
Maximum Length:
32
The module that owns the row. A module is an entry in the application taxonomy, such as a logical business area. When no module is identified, then the seed data framework does not extract the row as seed data. -
ResourceId: integer
(int64)
The unique identifier of the resource associated with this rule.
-
RuleDescription: string
Title:
Rule Description
Maximum Length:512
The description of this rule as it appears in the user interface. -
RuleId: integer
(int64)
Read Only:
true
The unique identifier of the rule. -
RuleName: string
Title:
Rule Name
Maximum Length:100
The name of this rule as it appears in the user interface. -
SeedDataLock: integer
(int32)
Default Value:
0
Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated. -
SourceRuleId: integer
(int64)
Default Value:
0
The unique identifier of the source rule for this cloned 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.