Create a record report
post
/fscmRestApi/resources/11.13.18.05/publicSectorRecordReports
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The agency identifier of the record report. -
CategoryCode: string
Title:
Category
Maximum Length:30
The user defined category of an ad hoc notice. -
GeneratedDate: string
(date-time)
Title:
Generated Date
The date on which the record report was generated. -
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.
-
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. -
ReportTypeCode: string
Maximum Length:
100
The report type code of the record report.
Response
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 : 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.