Get all conditions
get
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkConditions
Request
Query Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds a condition with a specified condition identifier.
Finder Variables:- ConditionId; integer; The unique identifier of the condition.
- PrimaryKey: Finds a condition with a specified condition identifier.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AgencyId; integer; The unique identifier for the agency associated with this condition.
- ConditionClob; string; The tenth additional comparison value entered or selected by the user for this condition.
- ConditionCode; integer; A field for future use.
- ConditionField; string; The condition field from the associated resource for this condition.
- ConditionId; integer; The unique identifier of the condition.
- ConditionOperator; string; The comparison operator chosen by the user for this condition.
- ConditionSequence; integer; The sequence number for this condition. Conditions for a given rule are processed in order according to their sequence numbers.
- ConditionValue; string; The comparison value entered or selected by the user for this condition.
- ConditionValue1; string; The first additional comparison value entered or selected by the user for this condition.
- ConditionValue2; string; The second additional comparison value entered or selected by the user for this condition.
- ConditionValue3; string; The third additional comparison value entered or selected by the user for this condition.
- ConditionValue4; string; The fourth additional comparison value entered or selected by the user for this condition.
- ConditionValue5; string; The fifth additional comparison value entered or selected by the user for this condition.
- ConditionValue6; string; The sixth additional comparison value entered or selected by the user for this condition.
- ConditionValue7; string; The seventh additional comparison value entered or selected by the user for this condition.
- ConditionValue8; string; The eighth additional comparison value entered or selected by the user for this condition.
- ConditionValue9; string; The ninth additional comparison value entered or selected by the user for this condition.
- DeletedFlag; boolean; Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.
- GroupingLevel; string; The grouping level for this condition.
- GroupingLevelLeft; string; The left grouping indicator for this condition.
- GroupingLevelRight; string; The right grouping indicator for this condition.
- GroupingVerb; string; The gouping verb set by the user for this condition.
- ModuleId; string; 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.
- RuleId; integer; The unique identifier of the rule associated with this condition.
- SeedDataLock; integer; 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.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 : publicSectorBusinessRulesFrameworkConditions
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorBusinessRulesFrameworkConditions-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency Id
The unique identifier for the agency associated with this condition. -
ConditionClob: string
(byte)
The tenth additional comparison value entered or selected by the user for this condition.
-
ConditionCode: integer
(int64)
A field for future use.
-
ConditionField: string
Title:
Field
Maximum Length:256
The condition field from the associated resource for this condition. -
ConditionId: integer
(int64)
Read Only:
true
The unique identifier of the condition. -
ConditionOperator: string
Title:
Operator
Maximum Length:50
The comparison operator chosen by the user for this condition. -
ConditionSequence: integer
(int32)
Title:
Sequence
The sequence number for this condition. Conditions for a given rule are processed in order according to their sequence numbers. -
ConditionValue: string
Title:
Value
Maximum Length:256
The comparison value entered or selected by the user for this condition. -
ConditionValue1: string
Maximum Length:
256
The first additional comparison value entered or selected by the user for this condition. -
ConditionValue2: string
Maximum Length:
256
The second additional comparison value entered or selected by the user for this condition. -
ConditionValue3: string
Maximum Length:
256
The third additional comparison value entered or selected by the user for this condition. -
ConditionValue4: string
Maximum Length:
256
The fourth additional comparison value entered or selected by the user for this condition. -
ConditionValue5: string
Maximum Length:
256
The fifth additional comparison value entered or selected by the user for this condition. -
ConditionValue6: string
Maximum Length:
256
The sixth additional comparison value entered or selected by the user for this condition. -
ConditionValue7: string
Maximum Length:
256
The seventh additional comparison value entered or selected by the user for this condition. -
ConditionValue8: string
Maximum Length:
256
The eighth additional comparison value entered or selected by the user for this condition. -
ConditionValue9: string
Maximum Length:
256
The ninth additional comparison value entered or selected by the user for this condition. -
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. -
GroupingLevel: string
Title:
Grouping Level
Maximum Length:20
The grouping level for this condition. -
GroupingLevelLeft: string
Title:
Grouping Level Left
Maximum Length:5
The left grouping indicator for this condition. -
GroupingLevelRight: string
Title:
Grouping Level Right
Maximum Length:5
The right grouping indicator for this condition. -
GroupingVerb: string
Title:
Grouping Verb
Maximum Length:20
The gouping verb set by the user for this condition. -
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. -
RuleId: integer
(int64)
The unique identifier of the rule associated with this condition.
-
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.
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.