Get all incidents
get
/fscmRestApi/resources/11.13.18.05/publicSectorIncidentCommunications
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 an incident with a specified incident identifier. Finder Variables:
- IncidentKey; integer; The unique identifier of the incident.
- PrimaryKey: Finds an incident with a specified incident identifier. 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 : publicSectorIncidentCommunications
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 : publicSectorIncidentCommunications-item
Type:
Show Source
object
-
AgencyFlag(optional):
string
Maximum Length:
1
Indicates whether an agency staff member reported the issue. -
AgencyId(optional):
integer(int32)
The unique identifier for the agency.
-
AssignedCodeOfficerEmail(optional):
string
The email address of the code enforcement officer.
-
AssignedCodeOfficerName(optional):
string
The name of the code enforcement officer.
-
AssignedCodeOfficerPhone(optional):
string
The phone number of the code enforcement officer.
-
AssignedCodeTechnicianEmail(optional):
string
The email address of the code enforcement technician.
-
AssignedCodeTechnicianName(optional):
string
The name of the code enforcement technician.
-
AssignedCodeTechnicianPhone(optional):
string
The phone number of the code enforcement technician.
-
ClosedBy(optional):
string
Maximum Length:
64
The person ID of the person who closed the case. -
ClosedDate(optional):
string(date-time)
The date on which the incident was closed.
-
ClosedReason(optional):
string
Maximum Length:
450
The reason for closing the incident. -
DisclosureFlag(optional):
string
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(optional):
string
Maximum Length:
30
The unique identifier for the district of the incident location. -
DistrictIdDescr(optional):
string
Maximum Length:
100
The description of the district where the issue is located. -
DistrictType(optional):
string
Maximum Length:
50
The unique identifier for the district type that is associated with the issue subtype. -
DistrictTypeDescr(optional):
string
Maximum Length:
100
The description of the district type that is associated with the issue subtype. -
DuplicateFlag(optional):
string
Maximum Length:
1
Indicates whether the incident is a potential duplicate. -
IncidentId(optional):
string
Maximum Length:
50
The unique identifier for the incident transaction. -
IncidentKey(optional):
integer(int64)
The unique identifier for an incident. This number is created using autonumbering.
-
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
Issue details for the reported incident. -
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 unique identifier for the issue subtype. -
IssueType(optional):
string
Maximum Length:
100
The description of the issue type. -
IssueTypeId(optional):
string
Maximum Length:
50
The unique identifier for the issue type. -
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. -
MigratedDataFlag(optional):
string
Maximum Length:
3
Identifies the migrated incident. -
NotifyMeFlag(optional):
string
Maximum Length:
1
Indicates whether the registered user who reported the incident wishes to receive update notifications. -
ObsoleteFlag(optional):
string
Maximum Length:
1
Indicates whether the issue is obsolete. -
OriginatorSource(optional):
string
Maximum Length:
30
The identifier for the external source of the incident. Examples of values are 311, CRM, or CX. -
ParcelIdEntered(optional):
string
Maximum Length:
30
The unique identifier for the parcel. -
ParentId(optional):
string
Maximum Length:
50
The ID of the parent incident. -
ParentType(optional):
string
Maximum Length:
15
The type of parent record, either an incident or a case. -
PrimaryIssueFlag(optional):
string
Maximum Length:
1
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 property address for the reported incident. -
PropertyAddress2(optional):
string
Maximum Length:
240
The second line of the property address for the reported incident. -
PropertyAddress3(optional):
string
Maximum Length:
240
The third line of the property address for the reported incident. -
PropertyAddress4(optional):
string
Maximum Length:
240
The fourth line of the property address for the reported incident. -
PropertyCity(optional):
string
Maximum Length:
60
The city of the property address for the reported incident. -
PropertyCountry(optional):
string
Maximum Length:
3
The country of the property address for the reported incident. -
PropertyCounty(optional):
string
Maximum Length:
60
The county of the property address for the reported incident. -
PropertyPostalCode(optional):
string
Maximum Length:
60
The postal code of the property address for the reported incident. -
PropertyPostalPlusFourCode(optional):
string
Maximum Length:
10
The postal plus code of the property address for the reported incident. -
PropertyProvince(optional):
string
Maximum Length:
60
The province of the property address for the reported incident. -
PropertyState(optional):
string
Maximum Length:
60
The state of the property address for the reported incident. -
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. -
ReferralType(optional):
string
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. -
ReporterEmail(optional):
string
Maximum Length:
320
The email address of the incident reporter. -
ReporterName(optional):
string
Maximum Length:
150
The name of the incident reporter. -
ReporterPhone(optional):
string
Maximum Length:
40
The phone number of the incident reporter. -
ReviewDueDate(optional):
string(date-time)
The review due date for the issue.
-
Status(optional):
string
Maximum Length:
15
The incident status. -
StatusName(optional):
string
Maximum Length:
30
The description of the issue status. -
SubmitDate(optional):
string(date-time)
The submission date of the issue.
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.