Get details for a rule
get
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkRuleDetails/{RuleId}
Request
Path Parameters
-
RuleId(required): integer(int64)
The unique identifier of the rule.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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 : publicSectorBusinessRulesFrameworkRuleDetails-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Read Only:
true
The unique identifier of the agency associated with this rule. -
DeletedFlag: string
Read Only:
true
Maximum Length:1
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
Read Only:true
Maximum Length:1
A flag on the rule to indicate whether the rule should be processed or not. The default value is N. -
EventCode: string
Title:
Event Code
Read Only:true
Maximum Length:32
The event code. -
EventDescription: string
Title:
Event Description
Read Only:true
Maximum Length:1000
The description of the event. -
EventId: integer
(int64)
Title:
Event ID
Read Only:true
The unique identifier of the event associated with this rule. -
EventName: string
Title:
Event Name
Read Only:true
Maximum Length:500
The name of the event. -
EventType: string
Read Only:
true
Maximum Length:30
The type of event. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ModuleId: string
Read Only:
true
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. -
OfferingId: string
Title:
Offering
Read Only:true
Maximum Length:80
The offering under which this resource is categorized. -
ResourceCode: string
Read Only:
true
Maximum Length:32
The unique code for the communication resource. -
ResourceId: integer
(int64)
Title:
Resource ID
Read Only:true
The unique identifier of the resource associated with this rule. -
ResourceName: string
Title:
Business Object
Read Only:true
Maximum Length:100
The name of the resource. -
RuleDescription: string
Title:
Rule Description
Read Only:true
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
Read Only:true
Maximum Length:100
The name of this rule as it appears in the user interface. -
SeedDataLock: integer
(int32)
Read Only:
true
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.
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.