Jump to

• Request
• Response

Create a report configuration

post

/fscmRestApi/resources/11.13.18.05/publicSectorBIPReports

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorBIPReports-item

Type: object

Show Source

• 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.
• OutputFormat(optional): string
  Maximum Length: 20

  The report format, such as RTF or PDF.
• ReportCategory(optional): string
  Maximum Length: 100

  The category that the report belongs to, such as business licenses, cases, code enforcement, permits, and so on.
• ReportControlId(optional): string
  Maximum Length: 32

  The unique identifier of the report.
• ReportMapParameters(optional): 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(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.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency that is associated with the report."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the report configuration."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the report configuration was created."
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"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":{
            "maxLength":256,
            "type":"string",
            "description":"The description of the report."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the report configuration was last updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the report configuration."
        },
        "ModuleId":{
            "maxLength":32,
            "type":"string",
            "description":"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":{
            "maxLength":20,
            "type":"string",
            "description":"The report format, such as RTF or PDF."
        },
        "ReportCategory":{
            "maxLength":100,
            "type":"string",
            "description":"The category that the report belongs to, such as business licenses, cases, code enforcement, permits, and so on."
        },
        "ReportControlId":{
            "maxLength":32,
            "type":"string",
            "description":"The unique identifier of the report."
        },
        "ReportMapParameters":{
            "items":{
                "$ref":"#/definitions/publicSectorBIPReports-ReportMapParameters-item"
            },
            "type":"array",
            "description":"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.",
            "title":"BIP Report Configurations"
        },
        "ReportPath":{
            "maxLength":1000,
            "type":"string",
            "description":"The file server path of the report."
        },
        "SeedDataLock":{
            "format":"int32",
            "type":"integer",
            "description":"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."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

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

• Array of: object publicSectorBIPReports-ReportMapParameters-item

{
    "items":{
        "$ref":"#/definitions/publicSectorBIPReports-ReportMapParameters-item"
    },
    "type":"array",
    "description":"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.",
    "title":"BIP Report Configurations"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Nested Schema : publicSectorBIPReports-ReportMapParameters-item

Type: object

Show Source

• 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.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency that is associated with the report."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the report configuration parameter."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the report configuration parameter was created."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the report configuration parameter was last updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the report configuration parameter."
        },
        "MappedControlName":{
            "maxLength":150,
            "type":"string",
            "description":"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":{
            "maxLength":150,
            "type":"string",
            "description":"The control object that is mapped to the report. A control object is a field from which the report parameter receives data."
        },
        "ReportControlId":{
            "maxLength":32,
            "type":"string",
            "description":"The unique identifier of the report."
        },
        "ReportParamDatatype":{
            "maxLength":150,
            "type":"string",
            "description":"The data type of the parameter added to the report."
        },
        "ReportParamId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the parameter added to the report."
        },
        "ReportParamName":{
            "maxLength":150,
            "type":"string",
            "description":"The name of the parameter added to the report."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorBIPReports-item

Type: object

Show Source

• 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.
• OutputFormat(optional): string
  Maximum Length: 20

  The report format, such as RTF or PDF.
• ReportCategory(optional): string
  Maximum Length: 100

  The category that the report belongs to, such as business licenses, cases, code enforcement, permits, and so on.
• ReportControlId(optional): string
  Maximum Length: 32

  The unique identifier of the report.
• ReportMapParameters(optional): 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(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.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency that is associated with the report."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the report configuration."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the report configuration was created."
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"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":{
            "maxLength":256,
            "type":"string",
            "description":"The description of the report."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the report configuration was last updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the report configuration."
        },
        "ModuleId":{
            "maxLength":32,
            "type":"string",
            "description":"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":{
            "maxLength":20,
            "type":"string",
            "description":"The report format, such as RTF or PDF."
        },
        "ReportCategory":{
            "maxLength":100,
            "type":"string",
            "description":"The category that the report belongs to, such as business licenses, cases, code enforcement, permits, and so on."
        },
        "ReportControlId":{
            "maxLength":32,
            "type":"string",
            "description":"The unique identifier of the report."
        },
        "ReportMapParameters":{
            "items":{
                "$ref":"#/definitions/publicSectorBIPReports-ReportMapParameters-item"
            },
            "type":"array",
            "description":"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.",
            "title":"BIP Report Configurations"
        },
        "ReportPath":{
            "maxLength":1000,
            "type":"string",
            "description":"The file server path of the report."
        },
        "SeedDataLock":{
            "format":"int32",
            "type":"integer",
            "description":"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."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

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

• Array of: object publicSectorBIPReports-ReportMapParameters-item

{
    "items":{
        "$ref":"#/definitions/publicSectorBIPReports-ReportMapParameters-item"
    },
    "type":"array",
    "description":"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.",
    "title":"BIP Report Configurations"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Nested Schema : publicSectorBIPReports-ReportMapParameters-item

Type: object

Show Source

• 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.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency that is associated with the report."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the report configuration parameter."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the report configuration parameter was created."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the report configuration parameter was last updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the report configuration parameter."
        },
        "MappedControlName":{
            "maxLength":150,
            "type":"string",
            "description":"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":{
            "maxLength":150,
            "type":"string",
            "description":"The control object that is mapped to the report. A control object is a field from which the report parameter receives data."
        },
        "ReportControlId":{
            "maxLength":32,
            "type":"string",
            "description":"The unique identifier of the report."
        },
        "ReportParamDatatype":{
            "maxLength":150,
            "type":"string",
            "description":"The data type of the parameter added to the report."
        },
        "ReportParamId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the parameter added to the report."
        },
        "ReportParamName":{
            "maxLength":150,
            "type":"string",
            "description":"The name of the parameter added to the report."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Back to Top