Get all conditions applied against a record
get
/fscmRestApi/resources/11.13.18.05/publicSectorConditionLists
Request
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 -
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 the condition applied against a record that matches the primary key criteria. Finder Variables:
- ConditionKey; integer; The unique identifier of the applied condition row.
- PrimaryKey: Finds the condition applied against a record that matches the primary key criteria. Finder Variables:
-
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.
-
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 attributes. 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 -
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".
Response
Supported Media Types
- application/vnd.oracle.adf.resourcecollection+json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorConditionLists
Type:
Show Source
object
-
count(optional):
integer
Title:
Count
The number of resource instances returned in the current range. -
hasMore(optional):
boolean
Title:
HasMore
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(optional):
array Items
Title:
Items
The items in the collection. -
limit(optional):
integer
Title:
Limit
The actual paging size used by the server. -
links(optional):
array Items
Title:
Items
The link relations associated with the resource instance. -
offset(optional):
integer
Title:
Offset
The offset value used in the current page.
Nested Schema : Items
Type:
array
Title:
Items
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorConditionLists-item
Type:
Show Source
object
-
AdditionalInfo(optional):
string
Title:
Additional Information
Maximum Length:500
The additional details about the condition that was applied against a transaction. -
AgencyId(optional):
integer(int32)
The unique identifier of the public sector agency.
-
AppliedBy(optional):
string
Title:
Applied By
Maximum Length:64
The name of the user who applied the condition. -
AppliedDate(optional):
string(date-time)
Title:
Applied Date
The date when the condition was applied against a transaction. -
ApplyToInProcessTrans(optional):
boolean
Title:
Include in-process transactions
The option to enable the condition to be inherited to exiting transactions (in-process transactions).The valid values are Y and N. Select Y to apply the condition to all the existing transactions belonging to the same parcel. -
BrPreventFinalIns(optional):
string
Title:
Prevent Final Inspection
Maximum Length:1
Indicates whether the condition prevents scheduling and the resulting inspection for a case on hold. If the value is Y, the scheduling and inspection can't be made. The default value is N. -
BrPreventInsResult(optional):
string
Title:
Prevent Inspection Result
Maximum Length:1
The option to enable the Prevent Inspection Result functionality for the transaction against which a condition is applied. The default value is 'N'. -
BrPreventInsSched(optional):
string
Title:
Prevent Inspection Schedule
Maximum Length:1
The option to enable the Prevent Inspection Scheduling functionality for the transaction against which a condition is applied. The default value is 'N'. -
BrPreventIssue(optional):
string
Title:
Prevent Issue or Final
Maximum Length:1
The option to enable the Prevent Issue or Final workflow functionality for the transaction against which a condition is applied. The default value is 'N'. -
BrPreventNew(optional):
string
Title:
Prevent Application Progress
Maximum Length:1
The option to enable the Prevent New functionality for the transaction against which a condition is applied. The default value is 'N'. -
BrPreventRenewal(optional):
string
Title:
Prevent Renewal
Maximum Length:1
The option to enable the Prevent Renewal functionality for the transaction against which a condition is applied. The default value is 'N'. -
BrPreventWorkflow(optional):
string
Title:
Prevent Workflow Advancement
Maximum Length:1
The option to enable the Prevent Workflow Advancing functionality for the transaction against which a condition is applied. The default value is 'N'. -
BrRestrictPayment(optional):
string
Title:
Prevent Payment
Maximum Length:1
The option to enable the Restrict Payment functionality for the transaction against which a condition is applied. The default value is 'N'. -
ConditionKey(optional):
integer(int64)
The unique identifier of the applied condition against a transaction.
-
ConditionName(optional):
string
Title:
Condition Name
Maximum Length:50
The name of the condition that is applied. -
ConditionPuid(optional):
string
Maximum Length:
480
The public unique identifier of the condition from the data migration transaction. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The name of the user who applied the condition. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date when the condition was applied. -
Description(optional):
string
Title:
Description
Maximum Length:500
The detailed description about the condition applied against a transaction. -
InheritFlag(optional):
boolean
Title:
Apply Condition to Transactions
The option that indicates that the condition was inherited and not applied directly against the transaction. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date when the condition was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The name of the user who last updated the condition. -
links(optional):
array Items
Title:
Items
Link Relations -
ObjectKeyGenValue1(optional):
string
Maximum Length:
50
The string key value 1 to identify the unique transaction to which a condition is applied. -
ObjectKeyGenValue2(optional):
string
Maximum Length:
50
The string key value 2 to identify the unique transaction to which a condition is applied. -
ObjectKeyGenValue3(optional):
string
Maximum Length:
50
The string key value 3 to identify the unique transaction to which a condition is applied. -
ObjectKeyNumValue1(optional):
integer(int64)
The integer key value 1 to identify the unique transaction to which a condition is applied.
-
ObjectKeyNumValue2(optional):
integer(int64)
The integer key value 2 to identify the unique transaction to which a condition is applied.
-
ObjectKeyNumValue3(optional):
integer(int64)
The integer key value 3 to identify the unique transaction to which a condition is applied.
-
ObjectSubType(optional):
string
Maximum Length:
3
The unique sub type value to identify the sub type of a record. For example, an address within a parcel. -
ObjectType(optional):
string
Title:
Object Type
Maximum Length:3
The unique type of record against which a condition is applied. -
ParentConditionKey(optional):
integer(int64)
The unique identifier of the condition from the parent transaction.
-
ParentPuid(optional):
string
Maximum Length:
480
The public unique identifier for the parent data migration transaction. -
Priority(optional):
integer(int32)
Title:
Priority
The priority of the condition within the transaction. The values are '1' for High, '2' for Medium, and '3' for Low. -
PublicFlag(optional):
boolean
Title:
Display Description to Public
The option to enable the description to be visible for the public users. The default value is 'Y'. -
RemovalDate(optional):
string(date-time)
Title:
Resolved Date
The date when the condition was resolved. -
RemovedBy(optional):
string
Title:
Resolved By
Maximum Length:64
The name of the user who resolved the condition. -
ResolutionAction(optional):
string
Title:
Resolution Action
Maximum Length:500
The detailed information about the action that was taken to resolve the condition. -
ResolveInProcessTrans(optional):
boolean
Title:
Resolve condition applied to transactions
The option to include all the in-process transactions for the resolution. The valid values are Y and N. Select Y to include all the in-process transactions. -
Severity(optional):
integer(int32)
Title:
Severity
The severity of the condition. The values are '1' for Lock, '2' for Hold, and '3' for Notice. -
Status(optional):
string
Title:
Status
Maximum Length:1
The status of the condition that is applied against a transaction. The values are 'A' for Applied and 'R' for Removed.
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.