Create a report configuration
post
/fscmRestApi/resources/11.13.18.05/publicSectorBIPReports
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorBIPReports-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The unique identifier of the agency that is associated with the report.
-
CreatedBy(optional):
string
Maximum Length:
64
The user who created the report configuration. -
CreationDate(optional):
string(date-time)
The date and time that the report configuration was created.
-
DeletedFlag(optional):
string
Maximum Length:
1
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(optional):
string
Maximum Length:
256
The description of the report. -
LastUpdateDate(optional):
string(date-time)
The date and time that the report configuration was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the report configuration. -
links(optional):
array Items
Title:
Items
Link Relations -
ModuleId(optional):
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. -
ReportControlId(optional):
string
Maximum Length:
32
The unique identifier of the report. -
ReportMapParameters(optional):
array BIP Report Configurations
Title:
BIP Report Configurations
The BIP reports resource is used to view BIP reports. It stores the report identifier, description, and the file location path. A user can modify only the file location path. -
ReportPath(optional):
string
Maximum Length:
1000
The file server path of the report. -
SeedDataLock(optional):
integer(int32)
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 : BIP Report Configurations
Type:
array
Title:
BIP Report Configurations
The BIP reports resource is used to view BIP reports. It stores the report identifier, description, and the file location path. A user can modify only the file location path.
Show Source
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.
Nested Schema : publicSectorBIPReports-ReportMapParameters-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The unique identifier of the agency that is associated with the report.
-
CreatedBy(optional):
string
Maximum Length:
64
The user who created the report configuration parameter. -
CreationDate(optional):
string(date-time)
The date and time that the report configuration parameter was created.
-
LastUpdateDate(optional):
string(date-time)
The date and time that the report configuration parameter was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the report configuration parameter. -
links(optional):
array Items
Title:
Items
Link Relations -
MappedControlName(optional):
string
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(optional):
string
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(optional):
string
Maximum Length:
32
The unique identifier of the report. -
ReportParamDatatype(optional):
string
Maximum Length:
150
The data type of the parameter added to the report. -
ReportParamId(optional):
integer(int32)
The unique identifier of the parameter added to the report.
-
ReportParamName(optional):
string
Maximum Length:
150
The name of the parameter added to the report.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorBIPReports-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The unique identifier of the agency that is associated with the report.
-
CreatedBy(optional):
string
Maximum Length:
64
The user who created the report configuration. -
CreationDate(optional):
string(date-time)
The date and time that the report configuration was created.
-
DeletedFlag(optional):
string
Maximum Length:
1
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(optional):
string
Maximum Length:
256
The description of the report. -
LastUpdateDate(optional):
string(date-time)
The date and time that the report configuration was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the report configuration. -
links(optional):
array Items
Title:
Items
Link Relations -
ModuleId(optional):
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. -
ReportControlId(optional):
string
Maximum Length:
32
The unique identifier of the report. -
ReportMapParameters(optional):
array BIP Report Configurations
Title:
BIP Report Configurations
The BIP reports resource is used to view BIP reports. It stores the report identifier, description, and the file location path. A user can modify only the file location path. -
ReportPath(optional):
string
Maximum Length:
1000
The file server path of the report. -
SeedDataLock(optional):
integer(int32)
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 : BIP Report Configurations
Type:
array
Title:
BIP Report Configurations
The BIP reports resource is used to view BIP reports. It stores the report identifier, description, and the file location path. A user can modify only the file location path.
Show Source
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.
Nested Schema : publicSectorBIPReports-ReportMapParameters-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The unique identifier of the agency that is associated with the report.
-
CreatedBy(optional):
string
Maximum Length:
64
The user who created the report configuration parameter. -
CreationDate(optional):
string(date-time)
The date and time that the report configuration parameter was created.
-
LastUpdateDate(optional):
string(date-time)
The date and time that the report configuration parameter was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the report configuration parameter. -
links(optional):
array Items
Title:
Items
Link Relations -
MappedControlName(optional):
string
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(optional):
string
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(optional):
string
Maximum Length:
32
The unique identifier of the report. -
ReportParamDatatype(optional):
string
Maximum Length:
150
The data type of the parameter added to the report. -
ReportParamId(optional):
integer(int32)
The unique identifier of the parameter added to the report.
-
ReportParamName(optional):
string
Maximum Length:
150
The name of the parameter added to the report.