Get all incidents
get
/fscmRestApi/resources/11.13.18.05/publicSectorIncidents
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:- AssignedIncOfficerFinder: Finds the incidents with the district type which match the district type or include the district ID on the current user's job function.
Finder Variables:- bAssignedId; integer; The Assigned ID for the code enforcement officer who is assigned to the incident. The default value is the current user's person ID.
- value; string; The filter values to be applied when finding assigned incidents. Options include incident ID, status, description, property, address, or city.
- AssignedIncOverdueOfficerFinder: Finds the overdue incidents with the district type which match the district type or include the district ID on the current user's job function.
Finder Variables:- bAssignedId; integer; The Assigned ID for the code enforcement officer who is assigned to the incident. The default value is the current user's person ID.
- bTodayDate; string; The current date, which is used to find overdue incidents. Incidents are overdue when the due date is greater than the current date.
- value; string; The filter values to be applied when finding assigned incidents. Options include incident ID, status, description, property, address, or city.
- AssignedIncidentsCEFinder: Finds incidents assigned to the specified reviewer and, additionally, incidents where the reviewer's job function includes the incident type or subtype.
Finder Variables:- bReviewerId; integer; The Reviewer ID for the code enforcement technician who is assigned to the incident. The default value is the current user's person ID.
- value; string; The filter values to be applied when finding assigned incidents. Options include incident ID, status, description, property, address, or city.
- AssignedOverdueIncCEFinder: Finds overdue incidents assigned to the specified reviewer and, additionally, overdue incidents where the reviewer's job function includes the incident type or subtype.
Finder Variables:- bReviewerId; integer; The Reviewer ID for the code enforcement technician who is assigned to the incident. The default value is the current user's person ID.
- bTodayDate; string; The current date, which is used to find overdue incidents. Incidents are overdue when the due date is greater than the current date.
- value; string; The filter values to be applied when finding overdue assigned incidents. Options include incident ID, status, description, property, address, or city.
- AssignedOverdueIncFinder: Finds overdue incidents where the reviewer matches the specified key criteria.
Finder Variables:- bReviewerId; integer; The Reviewer ID for the code enforcement technician who is assigned to the incident. The default value is the current user's person ID.
- bTodayDate; string; The current date, which is used to find overdue incidents. Incidents are overdue when the due date is greater than the current date.
- value; string; The filter values to be applied when finding overdue assigned incidents. Options include incident ID, status, description, property, address, or city.
- IncidentPUIDAltKey: Finds the incidents that match the specified key criteria.
Finder Variables:- IncidentPuid; string; The public unique identifier for a migrated incident record.
- PrimaryKey: Finds the incidents that match the specified primary key criteria.
Finder Variables:- IncidentKey; integer; The unique identifier for an incident.
- UnassignedIncidentsCEFinder: Finds unassigned incidents that match the specified key criteria and where the current user's job function includes the incident type or subtype. Unassigned incidents are those that do not have a reviewer.
Finder Variables:- bReviewerId; integer; The Reviewer ID for the code enforcement technician who is assigned to the incident. The default value is the current user's person ID.
- value; string; The filter values to be applied when finding unassigned incidents. Options include incident ID, status, description, property, address, or city.
- UnassignedIncidentsFinder: Finds unassigned incidents that match the specified key criteria. Unassigned incidents are those that do not have a reviewer.
Finder Variables:- value; string; The filter values to be applied when finding unassigned incidents. Options include incident ID, status, description, property, address, or city.
- UnassignedOverdueIncCEFinder: Finds unassigned overdue incidents that match the specified key criteria and where the current user's job function includes the incident type or subtype. Unassigned incidents are those that do not have a reviewer.
Finder Variables:- bReviewerId; integer; The Reviewer ID for the code enforcement technician who is assigned to the incident. The default value is the current user's person ID.
- bTodayDate; string; The current date, which is used to find overdue incidents. Incidents are overdue when the due date is greater than the current date.
- value; string; The filter values to be applied when finding unassigned overdue incidents. Options include incident ID, status, description, property, address, or city.
- UnassignedOverdueIncFinder: Finds unassigned overdue incidents that match the specified key criteria. Unassigned incidents are those that do not have a reviewer.
Finder Variables:- bAgencyId; integer.
- bTodayDate; string; The current date, which is used to find overdue incidents. Incidents are overdue when the due date is greater than the current date.
- value; string; The filter values to be applied when finding unassigned overdue incidents. Options include incident ID, status, description, property, address, or city.
- simpleSearchFinder: Finds the incidents that match the specified primary key criteria.
Finder Variables:- value; string; The filter values to be applied when finding delegate information. Options include incident ID, status, description, property, address, or city
- AssignedIncOfficerFinder: Finds the incidents with the district type which match the district type or include the district ID on the current user's job function.
-
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:- AgencyFlag; boolean; Indicates whether an agency staff member reported the issue.
- AgencyId; integer; The unique agency ID.
- AssignedId; integer; The PERSON_ID key of the person assigned to work on the incident. This ID comes from the table PER_USERS.
- AssigneeName; string; The code enforcement officer name.
- ClosedBy; string; The person ID of the person who closed the case.
- ClosedDate; string; The incident close date.
- ClosedReason; string; The reason for closing the incident.
- DisclosureFlag; boolean; Indicates whether the person who reported the incident chose to keep their information private. This indicator is used when agencies do not accept anonymous incidents, but do provide an option to hide private information. A value of Y means that the information is to be kept private.
- DistrictId; string; The unique identifier for the district of the incident location.
- DistrictIdDescr; string; The description of the district where the issue is located.
- DistrictType; string; The unique identifier for the district type that is associated with the issue subtype.
- DistrictTypeDescr; string; The description of the district type that is associated with the issue subtype.
- DuplicateFlag; string; Indicates whether the incident is a potential duplicate.
- IncidentId; string; A logical ID for the incident transaction.
- IncidentKey; integer; The unique identifier for an incident. This number is created using autonumbering.
- IncidentPuid; string; The public unique identifier for a migrated incident record.
- IntakeKey; integer; The key from the intake record. The intake record is the parent of the incident record.
- IntakePuid; string; The public unique identifier for a migrated parent intake record.
- IntakeSource; string; The transaction type for the transaction that is the source of an incident.
- IssueDescription; string; The complainant's issue description.
- IssueSubtype; string; The description of the issue subtype.
- IssueSubtypeCode; string; The code for the issue subtype.
- IssueSubtypeId; string; The logical issue subtype ID.
- IssueType; string; The description of the issue type.
- IssueTypeId; string; The logical issue type ID.
- Latitude; number; The latitude of the property that is associated with the issue.
- LayoutVersion; string; The version of the intake form layout.
- LocationDescr; string; Additional issue location information such as an apartment number or descriptive details.
- Longitude; number; The longitude of the property that is associated with the issue.
- NotifyMeFlag; boolean; Indicates whether the registered user who reported the incident wishes to receive update notifications.
- ObsoleteFlag; boolean; Indicates whether the issue is obsolete.
- OriginatorSource; string; The external source system identifier, such as 311, CRM, or CX.
- OriginatorSrId; string; The external source unique service request ID.
- ParcelIdEntered; string; The property parcel ID.
- ParentId; string; The ID of the parent incident.
- ParentKey; integer; The key of the parent incident.
- ParentType; string; The type of parent record, either an incident or a case.
- PrimaryIssueFlag; boolean; Indicates whether the issue is the parent of another issue.
- Priority; string; The incident priority code. Valid values are CRITICAL P1, HIGH P2, MEDIUM P3, and LOW P4.
- ProcessInconsistent; string; The process inconsistent status of workflow process instance.
- ProcessStatus; string; The process status of workflow process instance.
- PropertyAddress1; string; The first line of the address for the complaint.
- PropertyAddress2; string; The second line of the address for the complaint.
- PropertyAddress3; string; The third line of the address for the complaint.
- PropertyAddress4; string; The fourth line of the address for the complaint.
- PropertyAddressId; integer; The property address ID.
- PropertyCity; string; The city for the address of the complaint.
- PropertyCoordinateX; number; The X coordinate of the property that is the subject of the complaint.
- PropertyCoordinateY; number; The y coordinate of the property that is the subject of the complaint.
- PropertyCountry; string; The country for the address of the complaint.
- PropertyCounty; string; The county of the address of the complaint.
- PropertyParcelId; integer; The property parcel ID.
- PropertyParcelIdEntered; string; The APN number for the parcel that is entered while reporting the incident.
- PropertyPostalCode; string; The postal code for the address of the complaint.
- PropertyPostalPlusFourCode; string; The postal code plus four for the address of the complaint.
- PropertyProvince; string; The province for the address of the complaint.
- PropertyState; string; The state for the address of the complaint.
- ReferralCode; string; The referral code for the issue. Referral codes are used to refer an issue to another agency or another group within the agency.
- ReferralType; string; The referral type for the issue. Referral types are used to identify the department, agency, or other group that an incident has been referred to.
- ReopenedFlag; string; Indicates whether the incident was reopened.
- ReopenedReason; string; The reason for reopening the incident.
- ReportedById; string; The ID of the person who reported the issue.
- ReviewDueDate; string; The issue review due date.
- ReviewerId; integer; The PERSON_ID key of the incident's reviewer. This ID comes from the table PER_USERS.
- ReviewerName; string; The code enforcement technician name.
- Status; string; The incident status.
- StatusName; string; The description of the issue status.
- SubmitDate; string; The issue submission date.
-
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 : publicSectorIncidents
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 : publicSectorIncidents-item-response
Type:
Show Source
object
-
AgencyFlag: boolean
Maximum Length:
1
Indicates whether an agency staff member reported the issue. -
AgencyId: integer
(int32)
Default Value:
1
The unique agency ID. -
AssignedId: integer
(int64)
The PERSON_ID key of the person assigned to work on the incident. This ID comes from the table PER_USERS.
-
AssignedPuid: string
The public unique identifier for the incident assigned ID.
-
AssigneeName: string
Read Only:
true
Maximum Length:255
The code enforcement officer name. -
ClosedBy: string
Read Only:
true
Maximum Length:64
The person ID of the person who closed the case. -
ClosedDate: string
(date-time)
Read Only:
true
The incident close date. -
ClosedReason: string
Maximum Length:
450
The reason for closing the incident. -
DisclosureFlag: boolean
Maximum Length:
1
Indicates whether the person who reported the incident chose to keep their information private. This indicator is used when agencies do not accept anonymous incidents, but do provide an option to hide private information. A value of Y means that the information is to be kept private. -
DistrictId: string
Maximum Length:
30
The unique identifier for the district of the incident location. -
DistrictIdDescr: string
Title:
District Description
Read Only:true
Maximum Length:100
The description of the district where the issue is located. -
DistrictType: string
Maximum Length:
50
The unique identifier for the district type that is associated with the issue subtype. -
DistrictTypeDescr: string
Title:
Description
Read Only:true
Maximum Length:100
The description of the district type that is associated with the issue subtype. -
DuplicateFlag: string
Maximum Length:
1
Indicates whether the incident is a potential duplicate. -
IncidentComment: array
Incident Comments
Title:
Incident Comments
The incident comments resource is used to view, create, delete, or modify comments for code enforcement incidents. -
IncidentId: string
Maximum Length:
50
A logical ID for the incident transaction. -
IncidentKey: integer
(int64)
The unique identifier for an incident. This number is created using autonumbering.
-
IncidentPuid: string
Maximum Length:
480
Default Value:The public unique identifier for a migrated incident record. -
IntakeKey: integer
(int64)
Read Only:
true
The key from the intake record. The intake record is the parent of the incident record. -
IntakePuid: string
Maximum Length:
480
Default Value:The public unique identifier for a migrated parent intake record. -
IntakeSource: string
Maximum Length:
30
The transaction type for the transaction that is the source of an incident. -
IssueDescription: string
Maximum Length:
1000
The complainant's issue description. -
IssueSubtype: string
Read Only:
true
Maximum Length:100
The description of the issue subtype. -
IssueSubtypeCode: string
Read Only:
true
Maximum Length:40
The code for the issue subtype. -
IssueSubtypeId: string
Maximum Length:
50
The logical issue subtype ID. -
IssueType: string
Read Only:
true
Maximum Length:100
The description of the issue type. -
IssueTypeId: string
Maximum Length:
50
The logical issue type ID. -
Latitude: number
The latitude of the property that is associated with the issue.
-
LayoutVersion: string
Read Only:
true
Maximum Length:255
The version of the intake form layout. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationDescr: string
Maximum Length:
1000
Additional issue location information such as an apartment number or descriptive details. -
Longitude: number
The longitude of the property that is associated with the issue.
-
NotifyMeFlag: boolean
Maximum Length:
1
Indicates whether the registered user who reported the incident wishes to receive update notifications. -
ObsoleteFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the issue is obsolete. -
OriginatorSource: string
Maximum Length:
30
The external source system identifier, such as 311, CRM, or CX. -
OriginatorSrId: string
Maximum Length:
30
The external source unique service request ID. -
ParcelIdEntered: string
Title:
Parcel Number
Read Only:true
Maximum Length:30
The property parcel ID. -
ParentId: string
Maximum Length:
50
The ID of the parent incident. -
ParentKey: integer
(int64)
The key of the parent incident.
-
ParentType: string
Maximum Length:
15
The type of parent record, either an incident or a case. -
PrimaryIssueFlag: boolean
Maximum Length:
1
Indicates whether the issue is the parent of another issue. -
Priority: string
Maximum Length:
30
Default Value:N
The incident priority code. Valid values are CRITICAL P1, HIGH P2, MEDIUM P3, and LOW P4. -
ProcessInconsistent: string
Read Only:
true
Maximum Length:255
The process inconsistent status of workflow process instance. -
ProcessInstanceId: string
Read Only:
true
Maximum Length:255
The identifier for the workflow process instance. -
ProcessStatus: string
Read Only:
true
Maximum Length:255
The process status of workflow process instance. -
PropertyAddress1: string
Maximum Length:
240
The first line of the address for the complaint. -
PropertyAddress2: string
Maximum Length:
240
The second line of the address for the complaint. -
PropertyAddress3: string
Maximum Length:
240
The third line of the address for the complaint. -
PropertyAddress4: string
Maximum Length:
240
The fourth line of the address for the complaint. -
PropertyAddressId: integer
(int64)
The property address ID.
-
PropertyCity: string
Maximum Length:
60
The city for the address of the complaint. -
PropertyCoordinateX: number
The X coordinate of the property that is the subject of the complaint.
-
PropertyCoordinateY: number
The y coordinate of the property that is the subject of the complaint.
-
PropertyCountry: string
Maximum Length:
3
The country for the address of the complaint. -
PropertyCounty: string
Maximum Length:
60
The county of the address of the complaint. -
PropertyOwnerId: integer
The unique identifier of the property owner of the incident.
-
PropertyParcelId: integer
(int64)
The property parcel ID.
-
PropertyParcelIdEntered: string
Maximum Length:
30
The APN number for the parcel that is entered while reporting the incident. -
PropertyPostalCode: string
Maximum Length:
60
The postal code for the address of the complaint. -
PropertyPostalPlusFourCode: string
Maximum Length:
10
The postal code plus four for the address of the complaint. -
PropertyProvince: string
Maximum Length:
60
The province for the address of the complaint. -
PropertyState: string
Maximum Length:
60
The state for the address of the complaint. -
ReferralCode: string
Maximum Length:
100
The referral code for the issue. Referral codes are used to refer an issue to another agency or another group within the agency. -
ReferralType: string
Title:
Referral Type
Read Only:true
Maximum Length:100
The referral type for the issue. Referral types are used to identify the department, agency, or other group that an incident has been referred to. -
ReopenedFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the incident was reopened. -
ReopenedReason: string
Maximum Length:
30
The reason for reopening the incident. -
ReportedById: string
Maximum Length:
18
The ID of the person who reported the issue. -
ReviewDueDate: string
(date-time)
The issue review due date.
-
ReviewerId: integer
(int64)
The PERSON_ID key of the incident's reviewer. This ID comes from the table PER_USERS.
-
ReviewerName: string
Read Only:
true
Maximum Length:255
The code enforcement technician name. -
ReviewerPuid: string
The public unique identifier for the incident reviewer ID.
-
Shape: object
Shape
The spatial shape of the property associated with the transaction. This information comes from GIS.
-
Status: string
Maximum Length:
15
The incident status. -
StatusName: string
Title:
Description
Read Only:true
Maximum Length:30
The description of the issue status. -
SubmitDate: string
(date-time)
The issue submission date.
Nested Schema : Incident Comments
Type:
array
Title:
Incident Comments
The incident comments resource is used to view, create, delete, or modify comments for code enforcement incidents.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Shape
Type:
object
The spatial shape of the property associated with the transaction. This information comes from GIS.
Nested Schema : publicSectorIncidents-IncidentComment-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier for the agency. -
CommentId: integer
(int64)
The unique identifier of the comment.
-
CommentKey: integer
(int64)
The comment key.
-
CommentPreview: string
Title:
Comment Preview
Read Only:true
The text of the comment in plain text format. This is used to preview the comment. -
CommentPuid: string
Maximum Length:
480
Default Value:The public unique identifier for a migrated comment record. -
CommentText: string
(byte)
Title:
Comments
The text of the comment in HTML format. -
CreatedByName: string
Title:
Created By
Read Only:true
The name of the user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time that the row was created. -
IncidentPuid: string
Maximum Length:
480
Default Value:The public unique identifier for a migrated parent incident record. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time that the row was last updated. -
LastUpdatedByName: string
Title:
Last Updated By
Read Only:true
The name of the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OriginalCreatedBy: string
The name of the user who created the comment.
-
TransactionKey: integer
(int64)
The transaction key for the transaction that the comment is associated with.
-
TransactionType: string
Read Only:
true
Maximum Length:10
Default Value:INC
The type of transaction that the comment is associated with. -
Visibility: string
Title:
Hide from Public
Maximum Length:1
Default Value:Y
Indicates whether the comment is visible.
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.