Get all conditions applied against a record
get
/fscmRestApi/resources/11.13.18.05/publicSectorConditionLists
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 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.
-
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:- AdditionalInfo; string; The additional details about the condition that was applied against a transaction.
- AgencyId; integer; The unique identifier of the public sector agency.
- AppliedBy; string; The name of the user who applied the condition.
- AppliedDate; string; The date when the condition was applied against a transaction.
- ApplyToInProcessTrans; boolean; 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.
- BrPreventAmendmentFlag; string; Indicates the prevent amendment business rule for hold condition.
- BrPreventFinalIns; string; 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; string; The option to enable the Prevent Inspection Result functionality for the transaction against which a condition is applied. The default value is 'N'.
- BrPreventInsSched; string; The option to enable the Prevent Inspection Scheduling functionality for the transaction against which a condition is applied. The default value is 'N'.
- BrPreventIssue; string; 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; string; The option to enable the Prevent New functionality for the transaction against which a condition is applied. The default value is 'N'.
- BrPreventRenewal; string; The option to enable the Prevent Renewal functionality for the transaction against which a condition is applied. The default value is 'N'.
- BrPreventWorkflow; string; The option to enable the Prevent Workflow Advancing functionality for the transaction against which a condition is applied. The default value is 'N'.
- BrRestrictPayment; string; The option to enable the Restrict Payment functionality for the transaction against which a condition is applied. The default value is 'N'.
- ConditionKey; integer; The unique identifier of the applied condition against a transaction.
- ConditionName; string; The name of the condition that is applied.
- ConditionPuid; string; The public unique identifier of the condition from the data migration transaction.
- CreationDate; string; The date when the condition was applied.
- Description; string; The detailed description about the condition applied against a transaction.
- InheritFlag; boolean; The option that indicates that the condition was inherited and not applied directly against the transaction.
- LastUpdateDate; string; The date when the condition was last updated.
- ObjectKeyGenValue1; string; The string key value 1 to identify the unique transaction to which a condition is applied.
- ObjectKeyGenValue2; string; The string key value 2 to identify the unique transaction to which a condition is applied.
- ObjectKeyGenValue3; string; The string key value 3 to identify the unique transaction to which a condition is applied.
- ObjectKeyNumValue1; integer; The integer key value 1 to identify the unique transaction to which a condition is applied.
- ObjectKeyNumValue2; integer; The integer key value 2 to identify the unique transaction to which a condition is applied.
- ObjectKeyNumValue3; integer; The integer key value 3 to identify the unique transaction to which a condition is applied.
- ObjectSubType; string; The unique sub type value to identify the sub type of a record. For example, an address within a parcel.
- ObjectType; string; The unique type of record against which a condition is applied.
- ParentConditionKey; integer; The unique identifier of the condition from the parent transaction.
- ParentPuid; string; The public unique identifier for the parent data migration transaction.
- Priority; integer; The priority of the condition within the transaction. The values are '1' for High, '2' for Medium, and '3' for Low.
- PublicFlag; boolean; The option to enable the description to be visible for the public users. The default value is 'Y'.
- ReferenceApplicationId; string; The attribute used to store the reference application ID.
- ReferenceClassification; string; The attribute used to store the reference classification.
- ReferenceKeyNumValue1; integer; This attribute is the first key value of the Reference table. This is used in the case reference transaction that contains number key values.
- ReferenceKeyNumValue2; integer; This attribute is the second key value of the Reference table. This is used in the case reference transaction that contains number key values.
- ReferencePuid; string; Indicates the reference PUID.
- RemovalDate; string; The date when the condition was resolved.
- RemovedBy; string; The name of the user who resolved the condition.
- ResolutionAction; string; The detailed information about the action that was taken to resolve the condition.
- ResolveInProcessTrans; boolean; 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; integer; The severity of the condition. The values are '1' for Lock, '2' for Hold, and '3' for Notice.
- Status; string; The status of the condition that is applied against a transaction. The values are 'A' for Applied and 'R' for Removed.
-
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 : publicSectorConditionLists
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 : publicSectorConditionLists-item-response
Type:
Show Source
object
-
AdditionalInfo: string
Title:
Additional Information
Maximum Length:500
The additional details about the condition that was applied against a transaction. -
AgencyId: integer
(int32)
Default Value:
1
The unique identifier of the public sector agency. -
AppliedBy: string
Title:
Applied By
Maximum Length:64
The name of the user who applied the condition. -
AppliedDate: string
(date-time)
Title:
Applied Date
The date when the condition was applied against a transaction. -
ApplyToInProcessTrans: boolean
Title:
Include in-process transactions
Maximum Length:1
Default Value:false
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. -
BrPreventAmendmentFlag: string
Title:
Business License Amendment
Maximum Length:1
Indicates the prevent amendment business rule for hold condition. -
BrPreventFinalIns: 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: 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: 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: 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: 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: string
Title:
Business License 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: 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: 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: integer
The unique identifier of the applied condition against a transaction.
-
ConditionName: string
Title:
Condition Name
Maximum Length:50
The name of the condition that is applied. -
ConditionPuid: string
Maximum Length:
480
The public unique identifier of the condition from the data migration transaction. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the condition was applied. -
Description: string
Title:
Description
Maximum Length:500
The detailed description about the condition applied against a transaction. -
InheritFlag: boolean
Title:
Apply Condition to Transactions
Maximum Length:1
The option that indicates that the condition was inherited and not applied directly against the transaction. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the condition was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectKeyGenValue1: string
Maximum Length:
50
The string key value 1 to identify the unique transaction to which a condition is applied. -
ObjectKeyGenValue2: string
Maximum Length:
50
The string key value 2 to identify the unique transaction to which a condition is applied. -
ObjectKeyGenValue3: string
Maximum Length:
50
The string key value 3 to identify the unique transaction to which a condition is applied. -
ObjectKeyNumValue1: integer
(int64)
The integer key value 1 to identify the unique transaction to which a condition is applied.
-
ObjectKeyNumValue2: integer
(int64)
The integer key value 2 to identify the unique transaction to which a condition is applied.
-
ObjectKeyNumValue3: integer
(int64)
The integer key value 3 to identify the unique transaction to which a condition is applied.
-
ObjectSubType: string
Maximum Length:
3
Default Value:NA
The unique sub type value to identify the sub type of a record. For example, an address within a parcel. -
ObjectType: string
Title:
Object Type
Maximum Length:3
The unique type of record against which a condition is applied. -
ParentConditionKey: integer
(int64)
The unique identifier of the condition from the parent transaction.
-
ParentPuid: string
Maximum Length:
480
The public unique identifier for the parent data migration transaction. -
Priority: 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: boolean
Title:
Display Description to Public
Maximum Length:1
Default Value:true
The option to enable the description to be visible for the public users. The default value is 'Y'. -
ReferenceApplicationId: string
Maximum Length:
50
The attribute used to store the reference application ID. -
ReferenceClassification: string
Maximum Length:
30
The attribute used to store the reference classification. -
ReferenceKeyNumValue1: integer
(int64)
This attribute is the first key value of the Reference table. This is used in the case reference transaction that contains number key values.
-
ReferenceKeyNumValue2: integer
(int64)
This attribute is the second key value of the Reference table. This is used in the case reference transaction that contains number key values.
-
ReferencePuid: string
Maximum Length:
480
Indicates the reference PUID. -
RemovalDate: string
(date-time)
Title:
Resolved Date
The date when the condition was resolved. -
RemovedBy: string
Title:
Resolved By
Maximum Length:64
The name of the user who resolved the condition. -
ResolutionAction: string
Title:
Resolution Action
Maximum Length:500
The detailed information about the action that was taken to resolve the condition. -
ResolveInProcessTrans: boolean
Title:
Resolve condition applied to transactions
Maximum Length:1
Default Value:false
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: integer
(int32)
Title:
Severity
The severity of the condition. The values are '1' for Lock, '2' for Hold, and '3' for Notice. -
Status: string
Title:
Status
Maximum Length:1
Default Value:A
The status of the condition that is applied against a transaction. The values are 'A' for Applied and 'R' for Removed.
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.