Get a report configuration
get
/fscmRestApi/resources/11.13.18.05/publicSectorBIPReports/{ReportControlId}
Request
Path Parameters
-
ReportControlId(required): string
The unique identifier of the report.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : publicSectorBIPReports-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier of the agency that is associated with the report. -
AllowBrfActionFlag: string
Title:
Available for Rules Framework Action
Maximum Length:1
Default Value:N
Indicates whether the report is available in the business rules framework. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the report configuration. -
CreationDate: string
(date-time)
Read Only:
true
The date and time that the report configuration was created. -
DeletedFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N. -
Description: string
Title:
Description
Maximum Length:256
The description of the report. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time that the report configuration was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the report configuration. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ModuleId: string
Maximum Length:
32
The module that owns the row. A module is an entry in the application taxonomy, such as a logical business area. When no module is identified, then the seed data framework does not extract the row as seed data. -
OutputFormat: string
Title:
Output Format
Maximum Length:20
Default Value:ORA_PDF
The report format, such as RTF or PDF. -
ReportCategory: string
Title:
Report Category
Maximum Length:100
Default Value:ORA_NONE
The category that the report belongs to, such as business licenses, cases, code enforcement, permits, and so on. -
ReportControlId: string
Title:
Report ID
Maximum Length:32
The unique identifier of the report. -
ReportMapParameters: array
BIP Report Configurations
Title:
BIP Report Configurations
The BIP report configurations resource is used to view or modify reporting configuration data for a BIP report. It stores the parameters and parameter type on the basis of which reports can be filtered. -
ReportPath: string
Title:
Path
Maximum Length:1000
The file server path of the report. -
SeedDataLock: integer
(int32)
Default Value:
0
Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : BIP Report Configurations
Type:
array
Title:
BIP Report Configurations
The BIP report configurations resource is used to view or modify reporting configuration data for a BIP report. It stores the parameters and parameter type on the basis of which reports can be filtered.
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.
Nested Schema : publicSectorBIPReports-ReportMapParameters-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier of the agency that is associated with the report. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the report configuration parameter. -
CreationDate: string
(date-time)
Read Only:
true
The date and time that the report configuration parameter was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time that the report configuration parameter was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the report configuration parameter. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MappedControlName: string
Title:
Control Name
Maximum Length:150
The name of the control object that is mapped to the report. A control object is a field from which the report parameter receives data. -
MappedControlObjname: string
Title:
Control Object
Maximum Length:150
The control object that is mapped to the report. A control object is a field from which the report parameter receives data. -
ReportControlId: string
Title:
Report ID
Maximum Length:32
The unique identifier of the report. -
ReportParamDatatype: string
Title:
Parameter Data Type
Maximum Length:150
The data type of the parameter added to the report. -
ReportParamId: integer
(int32)
Title:
Parameter ID
The unique identifier of the parameter added to the report. -
ReportParamName: string
Title:
Parameter Name
Maximum Length:150
The name of the parameter added to the report.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ReportMapParameters
-
Parameters:
- ReportControlId:
$request.path.ReportControlId
The BIP report configurations resource is used to view or modify reporting configuration data for a BIP report. It stores the parameters and parameter type on the basis of which reports can be filtered. - ReportControlId: