Jump to

• Request
• Response

Update a record report

patch

/fscmRestApi/resources/11.13.18.05/publicSectorRecordReports/{ReportKey}

Request

Supported Media Types

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

Path Parameters

• ReportKey: integer
  The unique identifier of the record report.

Body ()

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

Root Schema : publicSectorRecordReports-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The agency identifier of the record report.
• AttachmentCount(optional): integer(int32)
  Title: Attachment

  The number of attachments added to a record report.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the row was created.
• GeneratedDate(optional): string(date-time)
  Title: Generated Date

  The date on which the record report was generated.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the row was last updated.
• links(optional): array Items
  Title: Items

  Link Relations
• LnpRecordKey(optional): 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(optional): string
  Maximum Length: 255

  The report definition of the record report.
• OutputFormat(optional): string
  Maximum Length: 20

  The output format of the record report.
• RecordStatus(optional): string
  Title: Application Status

  Maximum Length: 15

  The status of the record when the report was created.
• ReportKey(optional): integer(int64)
  The unique identifier of the record report.
• ReportSource(optional): string
  Title: Report Type

  Maximum Length: 15

  The source of the record report.
• ReportStatus(optional): string
  Title: Status

  Maximum Length: 15

  The status of the record report.
• ReportStatusName(optional): string
  Maximum Length: 255

  The status description of the record report.
• ReportTypeCode(optional): string
  Maximum Length: 100

  The report type code of the record report.
• ReportTypeName(optional): string
  Title: Report Name

  Maximum Length: 255

  The name of the record report type.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the record report.",
            "title":"Agency ID"
        },
        "AttachmentCount":{
            "format":"int32",
            "type":"integer",
            "description":"The number of attachments added to a record report.",
            "title":"Attachment"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "GeneratedDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the record report was generated.",
            "title":"Generated Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LnpRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the record.<br>The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification."
        },
        "NoticeBipTemplateId":{
            "maxLength":255,
            "type":"string",
            "description":"The report definition of the record report."
        },
        "OutputFormat":{
            "maxLength":20,
            "type":"string",
            "description":"The output format of the record report."
        },
        "RecordStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The status of the record when the report was created.",
            "title":"Application Status"
        },
        "ReportKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the record report."
        },
        "ReportSource":{
            "maxLength":15,
            "type":"string",
            "description":"The source of the record report.",
            "title":"Report Type"
        },
        "ReportStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The status of the record report.",
            "title":"Status"
        },
        "ReportStatusName":{
            "maxLength":255,
            "type":"string",
            "description":"The status description of the record report."
        },
        "ReportTypeCode":{
            "maxLength":100,
            "type":"string",
            "description":"The report type code of the record report."
        },
        "ReportTypeName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the record report type.",
            "title":"Report Name"
        },
        "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 : 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"
}

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 : publicSectorRecordReports-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The agency identifier of the record report.
• AttachmentCount(optional): integer(int32)
  Title: Attachment

  The number of attachments added to a record report.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the row was created.
• GeneratedDate(optional): string(date-time)
  Title: Generated Date

  The date on which the record report was generated.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the row was last updated.
• links(optional): array Items
  Title: Items

  Link Relations
• LnpRecordKey(optional): 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(optional): string
  Maximum Length: 255

  The report definition of the record report.
• OutputFormat(optional): string
  Maximum Length: 20

  The output format of the record report.
• RecordStatus(optional): string
  Title: Application Status

  Maximum Length: 15

  The status of the record when the report was created.
• ReportKey(optional): integer(int64)
  The unique identifier of the record report.
• ReportSource(optional): string
  Title: Report Type

  Maximum Length: 15

  The source of the record report.
• ReportStatus(optional): string
  Title: Status

  Maximum Length: 15

  The status of the record report.
• ReportStatusName(optional): string
  Maximum Length: 255

  The status description of the record report.
• ReportTypeCode(optional): string
  Maximum Length: 100

  The report type code of the record report.
• ReportTypeName(optional): string
  Title: Report Name

  Maximum Length: 255

  The name of the record report type.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the record report.",
            "title":"Agency ID"
        },
        "AttachmentCount":{
            "format":"int32",
            "type":"integer",
            "description":"The number of attachments added to a record report.",
            "title":"Attachment"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "GeneratedDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the record report was generated.",
            "title":"Generated Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LnpRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the record.<br>The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification."
        },
        "NoticeBipTemplateId":{
            "maxLength":255,
            "type":"string",
            "description":"The report definition of the record report."
        },
        "OutputFormat":{
            "maxLength":20,
            "type":"string",
            "description":"The output format of the record report."
        },
        "RecordStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The status of the record when the report was created.",
            "title":"Application Status"
        },
        "ReportKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the record report."
        },
        "ReportSource":{
            "maxLength":15,
            "type":"string",
            "description":"The source of the record report.",
            "title":"Report Type"
        },
        "ReportStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The status of the record report.",
            "title":"Status"
        },
        "ReportStatusName":{
            "maxLength":255,
            "type":"string",
            "description":"The status description of the record report."
        },
        "ReportTypeCode":{
            "maxLength":100,
            "type":"string",
            "description":"The report type code of the record report."
        },
        "ReportTypeName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the record report type.",
            "title":"Report Name"
        },
        "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 : 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"
}

Back to Top