Get details for a rule
get
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkRuleDetails/{RuleId}
Request
Path Parameters
-
RuleId: integer
The unique identifier of the rule.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorBusinessRulesFrameworkRuleDetails-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The unique identifier of the agency associated with this rule.
-
DeletedFlag(optional):
string
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(optional):
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. -
EventCode(optional):
string
Title:
Event Code
Maximum Length:32
The event code. -
EventDescription(optional):
string
Title:
Event Description
Maximum Length:1000
The description of the event. -
EventId(optional):
integer(int64)
Title:
Event ID
The unique identifier of the event associated with this rule. -
EventName(optional):
string
Title:
Event Name
Maximum Length:500
The name of the event. -
links(optional):
array Items
Title:
Items
Link Relations -
ModuleId(optional):
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. -
OfferingId(optional):
string
Title:
Offering
Maximum Length:80
The offering under which this resource is categorized. -
ResourceCode(optional):
string
Maximum Length:
32
The unique code for the communication resource. -
ResourceId(optional):
integer(int64)
Title:
Resource ID
The unique identifier of the resource associated with this rule. -
ResourceName(optional):
string
Title:
Business Object
Maximum Length:100
The name of the resource. -
RuleDescription(optional):
string
Title:
Rule Description
Maximum Length:512
The description of this rule as it appears in the user interface. -
RuleId(optional):
integer(int64)
The unique identifier of the rule.
-
RuleName(optional):
string
Title:
Rule Name
Maximum Length:100
The name of this rule as it appears in the user interface. -
SeedDataLock(optional):
integer(int32)
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 : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.