Get all record reports
get
/fscmRestApi/resources/11.13.18.05/publicSectorRecordReports
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 record report that matches the specified search criteria.
Finder Variables:- ReportKey; integer; The unique identifier of the record report.
- PrimaryKey: Finds the record report that matches the specified search 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:- AgencyId; integer; The agency identifier of the record report.
- AttachmentCount; integer; The number of attachments added to a record report.
- CategoryCode; string; The user defined category of an ad hoc notice.
- CreationDate; string; The date and time when the row was created.
- GeneratedDate; string; The date on which the record report was generated.
- LastUpdateDate; string; The date and time when the row was last updated.
- LastUpdatedByName; string; The name of the user who last updated the row.
- LnpRecordKey; integer; The unique identifier of the record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.
- NoticeBipTemplateId; string; The report definition of the record report.
- OutputFormat; string; The output format of the record report.
- RecordStatus; string; The status of the record when the report was created.
- ReportKey; integer; The unique identifier of the record report.
- ReportSource; string; The source of the record report.
- ReportStatus; string; The status of the record report.
- ReportStatusName; string; The status description of the record report.
- ReportTypeCode; string; The report type code of the record report.
- ReportTypeName; string; The name of the record report type.
-
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 : publicSectorRecordReports
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 : publicSectorRecordReports-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The agency identifier of the record report. -
AttachmentCount: integer
Title:
Attachment
Read Only:true
The number of attachments added to a record report. -
CategoryCode: string
Title:
Category
Maximum Length:30
The user defined category of an ad hoc notice. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
GeneratedDate: string
(date-time)
Title:
Generated Date
The date on which the record report was generated. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the row was last updated. -
LastUpdatedByName: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The name of the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordKey: integer
(int64)
The unique identifier of the record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.
-
NoticeBipTemplateId: string
Read Only:
true
Maximum Length:255
The report definition of the record report. -
OutputFormat: string
Maximum Length:
20
Default Value:ORA_PDF
The output format of the record report. -
RecordStatus: string
Title:
Application Status
Maximum Length:15
The status of the record when the report was created. -
ReportKey: integer
(int64)
The unique identifier of the record report.
-
ReportSource: string
Title:
Report Type
Maximum Length:15
Default Value:ORA_ADHOC
The source of the record report. -
ReportStatus: string
Title:
Status
Maximum Length:15
Default Value:ORA_PEND
The status of the record report. -
ReportStatusName: string
Read Only:
true
Maximum Length:255
The status description of the record report. -
ReportTypeCode: string
Maximum Length:
100
The report type code of the record report. -
ReportTypeName: string
Title:
Report Name
Read Only:true
Maximum Length:255
The name of the record report type.
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.