Get all conditions
get
/fscmRestApi/resources/11.13.18.05/publicSectorConditions
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 that matches the primary key criteria.
Finder Variables:- AgencyId; integer; The unique identifier of the public sector agency.
- ConditionName; string; The unique name for defining the condition.
- RowFinder: Finds a condition that matches the specified keyword.
Finder Variables:- value; string; The keyword used to find a condition by the condition name or the display message.
- PrimaryKey: Finds a condition 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 Information about the condition and resolution actions.
- AgencyId; integer; The unique identifier of the public sector agency.
- BrPreventAmendmentFlag; string; Indicates whether the condition is allowed to prevented by the Prevent Amendement process.
- 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; Indicates whether the condition prevents resulting inspection for a case on hold. If the value is Y, the inspection can't be made. The default value is N.
- BrPreventInsSched; string; Indicates whether the condition prevents an inspection from being scheduled for a case on hold. If the value is Y, the inspection can't be scheduled. The default value is N.
- BrPreventIssue; string; Indicates whether the condition prevents an issue/final business from being added for a case on hold. If the value is Y, an issue/final business can't be added. The default value is N.
- BrPreventNew; string; Indicates whether the condition prevents a new business from being added for a case on hold. If the value is Y, a new business can't be added. The default value is N.
- BrPreventRenewal; string; Indicates whehter the condition prevents an existing business from being renewed for a case on hold. The default value is N.
- BrPreventWorkflow; string; Indicates whether the condition prevents the workflow from advancing for a case on hold. If the value is Y, the workflow can't advance. The default value is N.
- BrRestrictPayment; string; Indicates whether the condition restricts payment from being made for a case on hold. If the value is Y, payment can't be made. The default value is N.
- ConditionName; string; The unique name of the condition.
- CreatedBy; string; The name of the user who created the condition.
- CreationDate; string; The date when the condition was created.
- Description; string; The detailed description of the condition.
- DisplayMessage; string; The information about the condition that is visible across all the transactions.
- EnabledFlag; boolean; Indicates if the condition is available for the users to apply against a record, such as permits, planning, and zoning. The default value is Y, which means that the condition is available.
- InheritFlag; boolean; Indicates if the condition is inheritable. The default value is N.
- LastUpdateDate; string; The date when the condition was last updated.
- LastUpdatedBy; string; The name of the user who last updated the condition.
- ObjectType; string; The type of record against which a condition can be applied.
- ParcelImportUpdateFlag; boolean; Indicates whether a condition is allowed to be updated by the Parcel Import process. The default value is N.
- Priority; integer; The priority of the condition as set by the agency.
- Severity; integer; The severity of the condition. The severity levels are Lock, Hold, and Notice. Lock represents the highest level of severity.
-
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:
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.
Root Schema : publicSectorConditions
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 : publicSectorConditions-item-response
Type:
Show Source
object
-
AdditionalInfo: string
Title:
Additional Information
Maximum Length:500
The additional Information about the condition and resolution actions. -
AgencyId: integer
(int32)
Default Value:
1
The unique identifier of the public sector agency. -
BrPreventAmendmentFlag: string
Title:
Business License Amendment
Maximum Length:1
Indicates whether the condition is allowed to prevented by the Prevent Amendement process. -
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
Indicates whether the condition prevents resulting inspection for a case on hold. If the value is Y, the inspection can't be made. The default value is N. -
BrPreventInsSched: string
Title:
Prevent Inspection Schedule
Maximum Length:1
Indicates whether the condition prevents an inspection from being scheduled for a case on hold. If the value is Y, the inspection can't be scheduled. The default value is N. -
BrPreventIssue: string
Title:
Prevent Issue or Final
Maximum Length:1
Indicates whether the condition prevents an issue/final business from being added for a case on hold. If the value is Y, an issue/final business can't be added. The default value is N. -
BrPreventNew: string
Title:
Prevent Application Progress
Maximum Length:1
Indicates whether the condition prevents a new business from being added for a case on hold. If the value is Y, a new business can't be added. The default value is N. -
BrPreventRenewal: string
Title:
Business License Renewal
Maximum Length:1
Indicates whehter the condition prevents an existing business from being renewed for a case on hold. The default value is N. -
BrPreventWorkflow: string
Title:
Prevent Workflow Advancement
Maximum Length:1
Indicates whether the condition prevents the workflow from advancing for a case on hold. If the value is Y, the workflow can't advance. The default value is N. -
BrRestrictPayment: string
Title:
Prevent Payment
Maximum Length:1
Indicates whether the condition restricts payment from being made for a case on hold. If the value is Y, payment can't be made. The default value is N. -
ConditionName: string
Title:
Condition Name
Maximum Length:50
The unique name of the condition. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The name of the user who created the condition. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the condition was created. -
Description: string
Title:
Description
Maximum Length:500
The detailed description of the condition. -
DisplayMessage: string
Title:
Display Message
Maximum Length:300
The information about the condition that is visible across all the transactions. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates if the condition is available for the users to apply against a record, such as permits, planning, and zoning. The default value is Y, which means that the condition is available. -
InheritFlag: boolean
Title:
Apply Condition to Transactions
Maximum Length:1
Indicates if the condition is inheritable. The default value is N. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the condition was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The name of the user who last updated the condition. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectType: string
Title:
Object Type
Maximum Length:3
The type of record against which a condition can be applied. -
ParcelImportUpdateFlag: boolean
Title:
Allow Updates by Parcel Import
Maximum Length:1
Indicates whether a condition is allowed to be updated by the Parcel Import process. The default value is N. -
Priority: integer
(int32)
Title:
Priority
The priority of the condition as set by the agency. -
Severity: integer
(int32)
Title:
Severity
The severity of the condition. The severity levels are Lock, Hold, and Notice. Lock represents the highest level of severity.
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.