Update a report configuration parameter
patch
/fscmRestApi/resources/11.13.18.05/publicSectorBIPReportParameters/{publicSectorBIPReportParametersUniqID}
Request
Path Parameters
-
publicSectorBIPReportParametersUniqID(required): string
This is the hash key of the attributes which make up the composite key--- ReportControlId and ReportParamId ---for the BIP Report Configurations resource and used to uniquely identify an instance of BIP Report Configurations. The client should not generate the hash key value. Instead, the client should query on the BIP Report Configurations collection resource with a filter on the primary key values in order to navigate to a specific instance of BIP Report Configurations.
For example: publicSectorBIPReportParameters?q=ReportControlId=<value1>;ReportParamId=<value2>
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.
Supported Media Types
- application/json
Root Schema : schema
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. -
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.
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 : publicSectorBIPReportParameters-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
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.