Get all incidents
get
/fscmRestApi/resources/11.13.18.05/publicSectorIncidents
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:- OverDueIncidentsWReviewer: Finds overdue incidents where the reviewer matches the specified key criteria. Finder Variables:
- bReviewerId; string; The Reviewer ID for the person who claimed 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 incidents. Options include incident ID, status, description, property, address, or city.
- OverDueIncidentsWOReviewer: Finds unclaimed overdue incidents that match the specified key criteria. Unclaimed incidents are those that do not have a reviewer. Finder Variables:
- 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 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
- PrimaryKey: Finds the incidents that match the specified primary key criteria. Finder Variables:
- IncidentKey; integer; The unique identifier for an incident.
- OverDueIncidentsWReviewer: Finds overdue incidents where the reviewer matches the specified 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 : publicSectorIncidents
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 : publicSectorIncidents-item
Type:
Show Source
object
-
AgencyFlag(optional):
boolean
Indicates whether an agency staff member reported the issue.
-
AgencyId(optional):
integer(int32)
The unique agency ID.
-
AssignedId(optional):
integer(int64)
The PERSON_ID key of the person assigned to work on the incident. This ID comes from the table PER_USERS.
-
ClosedBy(optional):
string
Maximum Length:
64
The person ID of the person who closed the case. -
ClosedDate(optional):
string(date-time)
The incident close date.
-
ClosedReason(optional):
string
Maximum Length:
450
The reason for closing the incident. -
CreatedBy(optional):
string
Maximum Length:
64
The name of the user who created the row. -
CreationDate(optional):
string(date-time)
The date and time when the row was created.
-
DisclosureFlag(optional):
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(optional):
string
Maximum Length:
30
The unique identifier for the district of the incident location. -
DuplicateFlag(optional):
string
Maximum Length:
1
Indicates whether the incident is a potential duplicate. -
IncidentComment(optional):
array Incident Comments
Title:
Incident Comments
The incidents resource is used to view, create, delete, or modify code enforcement incidents that are created by public users. -
IncidentId(optional):
string
Maximum Length:
50
A logical ID for the incident transaction. -
IncidentKey(optional):
integer(int64)
The unique identifier for an incident. This number is created using autonumbering.
-
IntakeKey(optional):
integer(int64)
The key from the intake record. The intake record is the parent of the incident record.
-
IntakeSource(optional):
string
Maximum Length:
30
The transaction type for the transaction that is the source of an incident. -
IssueDescription(optional):
string
Maximum Length:
1000
The complainant's issue description. -
IssueSubtype(optional):
string
Maximum Length:
100
The description of the issue subtype. -
IssueSubtypeCode(optional):
string
Maximum Length:
40
The code for the issue subtype. -
IssueSubtypeId(optional):
string
Maximum Length:
50
The logical issue subtype ID. -
IssueType(optional):
string
Maximum Length:
100
The description of the issue type. -
IssueTypeId(optional):
string
Maximum Length:
50
The logical issue type ID. -
LastUpdateDate(optional):
string(date-time)
The date and time when the row was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The name of the user who last updated the row. -
LastUpdateLogin(optional):
string
Maximum Length:
32
The session login associated with the user who last updated the row. -
Latitude(optional):
number
The latitude of the property that is associated with the issue.
-
links(optional):
array Items
Title:
Items
Link Relations -
LocationDescr(optional):
string
Maximum Length:
1000
Additional issue location information such as an apartment number or descriptive details. -
Longitude(optional):
number
The longitude of the property that is associated with the issue.
-
NotifyMeFlag(optional):
boolean
Indicates whether the registered user who reported the incident wishes to receive update notifications.
-
ObsoleteFlag(optional):
boolean
Indicates whether the issue is obsolete.
-
OriginatorSource(optional):
string
Maximum Length:
30
The external source system identifier, such as 311, CRM, or CX. -
OriginatorSrId(optional):
string
Maximum Length:
30
The external source unique service request ID. -
ParentId(optional):
string
Maximum Length:
50
The ID of the parent incident. -
ParentKey(optional):
integer(int64)
The key of the parent incident.
-
ParentType(optional):
string
Maximum Length:
15
The type of parent record, either an incident or a case. -
PrimaryIssueFlag(optional):
boolean
Indicates whether the issue is the parent of another issue.
-
Priority(optional):
string
Maximum Length:
30
The incident priority code. Valid values are CRITICAL P1,HIGH P2, MEDIUM P3, and LOW P4. -
PropertyAddress1(optional):
string
Maximum Length:
240
The first line of the address for the complaint. -
PropertyAddress2(optional):
string
Maximum Length:
240
The second line of the address for the complaint. -
PropertyAddress3(optional):
string
Maximum Length:
240
The third line of the address for the complaint. -
PropertyAddress4(optional):
string
Maximum Length:
240
The fourth line of the address for the complaint. -
PropertyAddressId(optional):
integer(int64)
The property address ID.
-
PropertyCity(optional):
string
Maximum Length:
60
The city for the address of the complaint. -
PropertyCoordinateX(optional):
number
The X coordinate of the property that is the subject of the complaint.
-
PropertyCoordinateY(optional):
number
The y coordinate of the property that is the subject of the complaint.
-
PropertyCountry(optional):
string
Maximum Length:
3
The country for the address of the complaint. -
PropertyCounty(optional):
string
Maximum Length:
60
The county of the address of the complaint. -
PropertyParcelId(optional):
integer(int64)
The property parcel ID.
-
PropertyPostalCode(optional):
string
Maximum Length:
60
The postal code for the address of the complaint. -
PropertyPostalPlusFourCode(optional):
string
Maximum Length:
10
The postal code plus four for the address of the complaint. -
PropertyProvince(optional):
string
Maximum Length:
60
The province for the address of the complaint. -
PropertyState(optional):
string
Maximum Length:
60
The state for the address of the complaint. -
ReferralCode(optional):
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. -
ReportedById(optional):
string
Maximum Length:
18
The ID of the person who reported the issue. -
ReviewDueDate(optional):
string(date-time)
The issue review due date.
-
ReviewerId(optional):
integer(int64)
The PERSON_ID key of the incident's reviewer. This ID comes from the table PER_USERS.
-
Status(optional):
string
Maximum Length:
15
The incident status. -
SubmitDate(optional):
string(date-time)
The issue submission date.
Nested Schema : Incident Comments
Type:
array
Title:
Incident Comments
The incidents resource is used to view, create, delete, or modify code enforcement incidents that are created by public users.
Show Source
Nested Schema : publicSectorIncidents-IncidentComment-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier for the agency. -
CommentId(optional):
integer(int64)
This comment ID.
-
CommentKey(optional):
integer(int64)
The comment key.
-
CommentPreview(optional):
string
Title:
Comment Preview
The text of the comment in plain text format. This is used to preview the comment. -
CommentText(optional):
string
Title:
Comments
The text of the comment in HTML format. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the row. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time that the row was created. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time that the row was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the row. -
links(optional):
array Items
Title:
Items
Link Relations -
TransactionKey(optional):
integer(int64)
The transaction key for the transaction that the comment is associated with.
-
TransactionType(optional):
string
Maximum Length:
10
The type of transaction that the comment is associated with. -
Visibility(optional):
string
Title:
Hide from Public
Maximum Length:1
Indicates whether the comment is visible.
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.