Jump to

• Request
• Response

Update a record report

patch

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

Request

Path Parameters

• ReportKey(required): integer(int64)
  The unique identifier of the record report.

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• GeneratedDate: string (date-time)
  Title: Generated Date

  The date on which the record report was generated.
• OutputFormat: string
  Maximum Length: 20

  Default Value: ORA_PDF

  The output format of the record report.
• ReportStatus: string
  Title: Status

  Maximum Length: 15

  Default Value: ORA_PEND

  The status of the record report.

{
    "type":"object",
    "properties":{
        "OutputFormat":{
            "maxLength":20,
            "type":"string",
            "description":"The output format of the record report.",
            "nullable":false,
            "default":"ORA_PDF"
        },
        "GeneratedDate":{
            "title":"Generated Date",
            "type":"string",
            "description":"The date on which the record report was generated.",
            "format":"date-time",
            "nullable":true
        },
        "ReportStatus":{
            "title":"Status",
            "maxLength":15,
            "type":"string",
            "description":"The status of the record report.",
            "nullable":false,
            "default":"ORA_PEND"
        }
    }
}

Back to Top

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.

Body ()

Root Schema : publicSectorRecordReports-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The agency identifier of the record report.
• AttachmentCount: integer
  Title: Attachment

  Read Only: true

  The number of attachments added to a record report.
• CategoryCode: string
  Title: Category

  Maximum Length: 30

  The user defined category of an ad hoc notice.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

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

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

  Read Only: true

  The date and time when the row was last updated.
• LastUpdatedByName: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The name of the user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordKey: 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: string
  Read Only: true

  Maximum Length: 255

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

  Default Value: ORA_PDF

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

  Maximum Length: 15

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

  Maximum Length: 15

  Default Value: ORA_ADHOC

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

  Maximum Length: 15

  Default Value: ORA_PEND

  The status of the record report.
• ReportStatusName: string
  Read Only: true

  Maximum Length: 255

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

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

  Read Only: true

  Maximum Length: 255

  The name of the record report type.

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The user defined category of an ad hoc notice.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReportStatusName":{
            "maxLength":255,
            "type":"string",
            "description":"The status description of the record report.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttachmentCount":{
            "title":"Attachment",
            "type":"integer",
            "description":"The number of attachments added to a record report.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency identifier of the record report.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "ReportTypeName":{
            "title":"Report Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the record report type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OutputFormat":{
            "maxLength":20,
            "type":"string",
            "description":"The output format of the record report.",
            "nullable":false,
            "default":"ORA_PDF",
            "x-queryable":true
        },
        "ReportKey":{
            "type":"integer",
            "description":"The unique identifier of the record report.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ReportTypeCode":{
            "maxLength":100,
            "type":"string",
            "description":"The report type code of the record report.",
            "nullable":false,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier of the record.\nThe record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReportSource":{
            "title":"Report Type",
            "maxLength":15,
            "type":"string",
            "description":"The source of the record report.",
            "nullable":false,
            "default":"ORA_ADHOC",
            "x-queryable":true
        },
        "NoticeBipTemplateId":{
            "maxLength":255,
            "type":"string",
            "description":"The report definition of the record report.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GeneratedDate":{
            "title":"Generated Date",
            "type":"string",
            "description":"The date on which the record report was generated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedByName":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReportStatus":{
            "title":"Status",
            "maxLength":15,
            "type":"string",
            "description":"The status of the record report.",
            "nullable":false,
            "default":"ORA_PEND",
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordStatus":{
            "title":"Application Status",
            "maxLength":15,
            "type":"string",
            "description":"The status of the record when the report was created.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top