Jump to

• Request
• Response

Update an incident

patch

/fscmRestApi/resources/11.13.18.05/publicSectorIncidents/{IncidentKey}

Request

Supported Media Types

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

Path Parameters

• IncidentKey: integer
  The unique identifier for an incident. This number is created using autonumbering.

Body ()

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

Root Schema : publicSectorIncidents-item

Type: object

Show Source

• AgencyFlag(optional): boolean
  Indicates whether an agency staff member reported the issue.
• AgencyId(optional): integer(int32)
  The unique agency ID.
• AssignedId(optional): integer(int64)
  The PERSON_ID key of the person assigned to work on the incident. This ID comes from the table PER_USERS.
• ClosedBy(optional): string
  Maximum Length: 64

  The person ID of the person who closed the case.
• ClosedDate(optional): string(date-time)
  The incident close date.
• ClosedReason(optional): string
  Maximum Length: 450

  The reason for closing the incident.
• DisclosureFlag(optional): boolean
  Indicates whether the person who reported the incident chose to keep their information private. This indicator is used when agencies do not accept anonymous incidents, but do provide an option to hide private information. A value of Y means that the information is to be kept private.
• DistrictId(optional): string
  Maximum Length: 30

  The unique identifier for the district of the incident location.
• DistrictType(optional): string
  Maximum Length: 50

  The unique identifier for the district type that is associated with the issue subtype.
• DuplicateFlag(optional): string
  Maximum Length: 1

  Indicates whether the incident is a potential duplicate.
• IncidentComment(optional): array Incident Comments
  Title: Incident Comments

  The incidents resource is used to view, create, delete, or modify code enforcement incidents that are created by public users.
• IncidentId(optional): string
  Maximum Length: 50

  A logical ID for the incident transaction.
• IncidentKey(optional): integer(int64)
  The unique identifier for an incident. This number is created using autonumbering.
• IntakeKey(optional): integer(int64)
  The key from the intake record. The intake record is the parent of the incident record.
• IntakeSource(optional): string
  Maximum Length: 30

  The transaction type for the transaction that is the source of an incident.
• IssueDescription(optional): string
  Maximum Length: 1000

  The complainant's issue description.
• IssueSubtype(optional): string
  Maximum Length: 100

  The description of the issue subtype.
• IssueSubtypeCode(optional): string
  Maximum Length: 40

  The code for the issue subtype.
• IssueSubtypeId(optional): string
  Maximum Length: 50

  The logical issue subtype ID.
• IssueType(optional): string
  Maximum Length: 100

  The description of the issue type.
• IssueTypeId(optional): string
  Maximum Length: 50

  The logical issue type ID.
• Latitude(optional): number
  The latitude of the property that is associated with the issue.
• links(optional): array Items
  Title: Items

  Link Relations
• LocationDescr(optional): string
  Maximum Length: 1000

  Additional issue location information such as an apartment number or descriptive details.
• Longitude(optional): number
  The longitude of the property that is associated with the issue.
• NotifyMeFlag(optional): boolean
  Indicates whether the registered user who reported the incident wishes to receive update notifications.
• ObsoleteFlag(optional): boolean
  Indicates whether the issue is obsolete.
• OriginatorSource(optional): string
  Maximum Length: 30

  The external source system identifier, such as 311, CRM, or CX.
• OriginatorSrId(optional): string
  Maximum Length: 30

  The external source unique service request ID.
• ParentId(optional): string
  Maximum Length: 50

  The ID of the parent incident.
• ParentKey(optional): integer(int64)
  The key of the parent incident.
• ParentType(optional): string
  Maximum Length: 15

  The type of parent record, either an incident or a case.
• PrimaryIssueFlag(optional): boolean
  Indicates whether the issue is the parent of another issue.
• Priority(optional): string
  Maximum Length: 30

  The incident priority code. Valid values are CRITICAL P1,HIGH P2, MEDIUM P3, and LOW P4.
• PropertyAddress1(optional): string
  Maximum Length: 240

  The first line of the address for the complaint.
• PropertyAddress2(optional): string
  Maximum Length: 240

  The second line of the address for the complaint.
• PropertyAddress3(optional): string
  Maximum Length: 240

  The third line of the address for the complaint.
• PropertyAddress4(optional): string
  Maximum Length: 240

  The fourth line of the address for the complaint.
• PropertyAddressId(optional): integer(int64)
  The property address ID.
• PropertyCity(optional): string
  Maximum Length: 60

  The city for the address of the complaint.
• PropertyCoordinateX(optional): number
  The X coordinate of the property that is the subject of the complaint.
• PropertyCoordinateY(optional): number
  The y coordinate of the property that is the subject of the complaint.
• PropertyCountry(optional): string
  Maximum Length: 3

  The country for the address of the complaint.
• PropertyCounty(optional): string
  Maximum Length: 60

  The county of the address of the complaint.
• PropertyParcelId(optional): integer(int64)
  The property parcel ID.
• PropertyPostalCode(optional): string
  Maximum Length: 60

  The postal code for the address of the complaint.
• PropertyPostalPlusFourCode(optional): string
  Maximum Length: 10

  The postal code plus four for the address of the complaint.
• PropertyProvince(optional): string
  Maximum Length: 60

  The province for the address of the complaint.
• PropertyState(optional): string
  Maximum Length: 60

  The state for the address of the complaint.
• ReferralCode(optional): string
  Maximum Length: 100

  The referral code for the issue. Referral codes are used to refer an issue to another agency or another group within the agency.
• ReportedById(optional): string
  Maximum Length: 18

  The ID of the person who reported the issue.
• ReviewDueDate(optional): string(date-time)
  The issue review due date.
• ReviewerId(optional): integer(int64)
  The PERSON_ID key of the incident's reviewer. This ID comes from the table PER_USERS.
• Status(optional): string
  Maximum Length: 15

  The incident status.
• SubmitDate(optional): string(date-time)
  The issue submission date.

{
    "properties":{
        "AgencyFlag":{
            "type":"boolean",
            "description":"Indicates whether an agency staff member reported the issue."
        },
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique agency ID."
        },
        "AssignedId":{
            "format":"int64",
            "type":"integer",
            "description":"The PERSON_ID key of the person assigned to work on the incident. This ID comes from the table PER_USERS."
        },
        "ClosedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The person ID of the person who closed the case."
        },
        "ClosedDate":{
            "format":"date-time",
            "type":"string",
            "description":"The incident close date."
        },
        "ClosedReason":{
            "maxLength":450,
            "type":"string",
            "description":"The reason for closing the incident."
        },
        "DisclosureFlag":{
            "type":"boolean",
            "description":"Indicates whether the person who reported the incident chose to keep their information private. This indicator is used when agencies do not accept anonymous incidents, but do provide an option to hide private information. A value of Y means that the information is to be kept private."
        },
        "DistrictId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the district of the incident location."
        },
        "DistrictType":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the district type that is associated with the issue subtype."
        },
        "DuplicateFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the incident is a potential duplicate."
        },
        "IncidentComment":{
            "items":{
                "$ref":"#/definitions/publicSectorIncidents-IncidentComment-item"
            },
            "type":"array",
            "description":"The incidents resource is used to view, create, delete, or modify code enforcement incidents that are created by public users.",
            "title":"Incident Comments"
        },
        "IncidentId":{
            "maxLength":50,
            "type":"string",
            "description":"A logical ID for the incident transaction."
        },
        "IncidentKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for an incident. This number is created using autonumbering."
        },
        "IntakeKey":{
            "format":"int64",
            "type":"integer",
            "description":"The key from the intake record. The intake record is the parent of the incident record."
        },
        "IntakeSource":{
            "maxLength":30,
            "type":"string",
            "description":"The transaction type for the transaction that is the source of an incident."
        },
        "IssueDescription":{
            "maxLength":1000,
            "type":"string",
            "description":"The complainant's issue description."
        },
        "IssueSubtype":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the issue subtype."
        },
        "IssueSubtypeCode":{
            "maxLength":40,
            "type":"string",
            "description":"The code for the issue subtype."
        },
        "IssueSubtypeId":{
            "maxLength":50,
            "type":"string",
            "description":"The logical issue subtype ID."
        },
        "IssueType":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the issue type."
        },
        "IssueTypeId":{
            "maxLength":50,
            "type":"string",
            "description":"The logical issue type ID."
        },
        "Latitude":{
            "type":"number",
            "description":"The latitude of the property that is associated with the issue."
        },
        "LocationDescr":{
            "maxLength":1000,
            "type":"string",
            "description":"Additional issue location information such as an apartment number or descriptive details."
        },
        "Longitude":{
            "type":"number",
            "description":"The longitude of the property that is associated with the issue."
        },
        "NotifyMeFlag":{
            "type":"boolean",
            "description":"Indicates whether the registered user who reported the incident wishes to receive update notifications."
        },
        "ObsoleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the issue is obsolete."
        },
        "OriginatorSource":{
            "maxLength":30,
            "type":"string",
            "description":"The external source system identifier, such as 311, CRM, or CX."
        },
        "OriginatorSrId":{
            "maxLength":30,
            "type":"string",
            "description":"The external source unique service request ID."
        },
        "ParentId":{
            "maxLength":50,
            "type":"string",
            "description":"The ID of the parent incident."
        },
        "ParentKey":{
            "format":"int64",
            "type":"integer",
            "description":"The key of the parent incident."
        },
        "ParentType":{
            "maxLength":15,
            "type":"string",
            "description":"The type of parent record, either an incident or a case."
        },
        "PrimaryIssueFlag":{
            "type":"boolean",
            "description":"Indicates whether the issue is the parent of another issue."
        },
        "Priority":{
            "maxLength":30,
            "type":"string",
            "description":"The incident priority code. Valid values are CRITICAL P1,HIGH P2, MEDIUM P3, and LOW P4."
        },
        "PropertyAddress1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the address for the complaint."
        },
        "PropertyAddress2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the address for the complaint."
        },
        "PropertyAddress3":{
            "maxLength":240,
            "type":"string",
            "description":"The third line of the address for the complaint."
        },
        "PropertyAddress4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the address for the complaint."
        },
        "PropertyAddressId":{
            "format":"int64",
            "type":"integer",
            "description":"The property address ID."
        },
        "PropertyCity":{
            "maxLength":60,
            "type":"string",
            "description":"The city for the address of the complaint."
        },
        "PropertyCoordinateX":{
            "type":"number",
            "description":"The X coordinate of the property that is the subject of the complaint."
        },
        "PropertyCoordinateY":{
            "type":"number",
            "description":"The y coordinate of the property that is the subject of the complaint."
        },
        "PropertyCountry":{
            "maxLength":3,
            "type":"string",
            "description":"The country for the address of the complaint."
        },
        "PropertyCounty":{
            "maxLength":60,
            "type":"string",
            "description":"The county of the address of the complaint."
        },
        "PropertyParcelId":{
            "format":"int64",
            "type":"integer",
            "description":"The property parcel ID."
        },
        "PropertyPostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code for the address of the complaint."
        },
        "PropertyPostalPlusFourCode":{
            "maxLength":10,
            "type":"string",
            "description":"The postal code plus four for the address of the complaint."
        },
        "PropertyProvince":{
            "maxLength":60,
            "type":"string",
            "description":"The province for the address of the complaint."
        },
        "PropertyState":{
            "maxLength":60,
            "type":"string",
            "description":"The state for the address of the complaint."
        },
        "ReferralCode":{
            "maxLength":100,
            "type":"string",
            "description":"The referral code for the issue. Referral codes are used to refer an issue to another agency or another group within the agency."
        },
        "ReportedById":{
            "maxLength":18,
            "type":"string",
            "description":"The ID of the person who reported the issue."
        },
        "ReviewDueDate":{
            "format":"date-time",
            "type":"string",
            "description":"The issue review due date."
        },
        "ReviewerId":{
            "format":"int64",
            "type":"integer",
            "description":"The PERSON_ID key of the incident's reviewer. This ID comes from the table PER_USERS."
        },
        "Status":{
            "maxLength":15,
            "type":"string",
            "description":"The incident status."
        },
        "SubmitDate":{
            "format":"date-time",
            "type":"string",
            "description":"The issue submission date."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Incident Comments

Type: array

Title: Incident Comments

The incidents resource is used to view, create, delete, or modify code enforcement incidents that are created by public users.

Show Source

• Array of: object publicSectorIncidents-IncidentComment-item

{
    "items":{
        "$ref":"#/definitions/publicSectorIncidents-IncidentComment-item"
    },
    "type":"array",
    "description":"The incidents resource is used to view, create, delete, or modify code enforcement incidents that are created by public users.",
    "title":"Incident Comments"
}

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 : publicSectorIncidents-IncidentComment-item

Type: object

Show Source

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

  The unique identifier for the agency.
• CommentId(optional): integer(int64)
  This comment ID.
• CommentKey(optional): integer(int64)
  The comment key.
• CommentPreview(optional): string
  Title: Comment Preview

  The text of the comment in plain text format. This is used to preview the comment.
• CommentText(optional): string
  Title: Comments

  The text of the comment in HTML format.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the row.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time that the row was created.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time that the row was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• TransactionKey(optional): integer(int64)
  The transaction key for the transaction that the comment is associated with.
• TransactionType(optional): string
  Maximum Length: 10

  The type of transaction that the comment is associated with.
• Visibility(optional): string
  Title: Hide from Public

  Maximum Length: 1

  Indicates whether the comment is visible.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier for the agency.",
            "title":"Agency ID"
        },
        "CommentId":{
            "format":"int64",
            "type":"integer",
            "description":"This comment ID."
        },
        "CommentKey":{
            "format":"int64",
            "type":"integer",
            "description":"The comment key."
        },
        "CommentPreview":{
            "type":"string",
            "description":"The text of the comment in plain text format. This is used to preview the comment.",
            "title":"Comment Preview"
        },
        "CommentText":{
            "type":"string",
            "description":"The text of the comment in HTML format.",
            "title":"Comments"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the row was created.",
            "title":"Creation Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "title":"Last Updated By"
        },
        "TransactionKey":{
            "format":"int64",
            "type":"integer",
            "description":"The transaction key for the transaction that the comment is associated with."
        },
        "TransactionType":{
            "maxLength":10,
            "type":"string",
            "description":"The type of transaction that the comment is associated with."
        },
        "Visibility":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the comment is visible.",
            "title":"Hide from Public"
        },
        "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 : publicSectorIncidents-item

Type: object

Show Source

• AgencyFlag(optional): boolean
  Indicates whether an agency staff member reported the issue.
• AgencyId(optional): integer(int32)
  The unique agency ID.
• AssignedId(optional): integer(int64)
  The PERSON_ID key of the person assigned to work on the incident. This ID comes from the table PER_USERS.
• ClosedBy(optional): string
  Maximum Length: 64

  The person ID of the person who closed the case.
• ClosedDate(optional): string(date-time)
  The incident close date.
• ClosedReason(optional): string
  Maximum Length: 450

  The reason for closing the incident.
• DisclosureFlag(optional): boolean
  Indicates whether the person who reported the incident chose to keep their information private. This indicator is used when agencies do not accept anonymous incidents, but do provide an option to hide private information. A value of Y means that the information is to be kept private.
• DistrictId(optional): string
  Maximum Length: 30

  The unique identifier for the district of the incident location.
• DistrictType(optional): string
  Maximum Length: 50

  The unique identifier for the district type that is associated with the issue subtype.
• DuplicateFlag(optional): string
  Maximum Length: 1

  Indicates whether the incident is a potential duplicate.
• IncidentComment(optional): array Incident Comments
  Title: Incident Comments

  The incidents resource is used to view, create, delete, or modify code enforcement incidents that are created by public users.
• IncidentId(optional): string
  Maximum Length: 50

  A logical ID for the incident transaction.
• IncidentKey(optional): integer(int64)
  The unique identifier for an incident. This number is created using autonumbering.
• IntakeKey(optional): integer(int64)
  The key from the intake record. The intake record is the parent of the incident record.
• IntakeSource(optional): string
  Maximum Length: 30

  The transaction type for the transaction that is the source of an incident.
• IssueDescription(optional): string
  Maximum Length: 1000

  The complainant's issue description.
• IssueSubtype(optional): string
  Maximum Length: 100

  The description of the issue subtype.
• IssueSubtypeCode(optional): string
  Maximum Length: 40

  The code for the issue subtype.
• IssueSubtypeId(optional): string
  Maximum Length: 50

  The logical issue subtype ID.
• IssueType(optional): string
  Maximum Length: 100

  The description of the issue type.
• IssueTypeId(optional): string
  Maximum Length: 50

  The logical issue type ID.
• Latitude(optional): number
  The latitude of the property that is associated with the issue.
• links(optional): array Items
  Title: Items

  Link Relations
• LocationDescr(optional): string
  Maximum Length: 1000

  Additional issue location information such as an apartment number or descriptive details.
• Longitude(optional): number
  The longitude of the property that is associated with the issue.
• NotifyMeFlag(optional): boolean
  Indicates whether the registered user who reported the incident wishes to receive update notifications.
• ObsoleteFlag(optional): boolean
  Indicates whether the issue is obsolete.
• OriginatorSource(optional): string
  Maximum Length: 30

  The external source system identifier, such as 311, CRM, or CX.
• OriginatorSrId(optional): string
  Maximum Length: 30

  The external source unique service request ID.
• ParentId(optional): string
  Maximum Length: 50

  The ID of the parent incident.
• ParentKey(optional): integer(int64)
  The key of the parent incident.
• ParentType(optional): string
  Maximum Length: 15

  The type of parent record, either an incident or a case.
• PrimaryIssueFlag(optional): boolean
  Indicates whether the issue is the parent of another issue.
• Priority(optional): string
  Maximum Length: 30

  The incident priority code. Valid values are CRITICAL P1,HIGH P2, MEDIUM P3, and LOW P4.
• PropertyAddress1(optional): string
  Maximum Length: 240

  The first line of the address for the complaint.
• PropertyAddress2(optional): string
  Maximum Length: 240

  The second line of the address for the complaint.
• PropertyAddress3(optional): string
  Maximum Length: 240

  The third line of the address for the complaint.
• PropertyAddress4(optional): string
  Maximum Length: 240

  The fourth line of the address for the complaint.
• PropertyAddressId(optional): integer(int64)
  The property address ID.
• PropertyCity(optional): string
  Maximum Length: 60

  The city for the address of the complaint.
• PropertyCoordinateX(optional): number
  The X coordinate of the property that is the subject of the complaint.
• PropertyCoordinateY(optional): number
  The y coordinate of the property that is the subject of the complaint.
• PropertyCountry(optional): string
  Maximum Length: 3

  The country for the address of the complaint.
• PropertyCounty(optional): string
  Maximum Length: 60

  The county of the address of the complaint.
• PropertyParcelId(optional): integer(int64)
  The property parcel ID.
• PropertyPostalCode(optional): string
  Maximum Length: 60

  The postal code for the address of the complaint.
• PropertyPostalPlusFourCode(optional): string
  Maximum Length: 10

  The postal code plus four for the address of the complaint.
• PropertyProvince(optional): string
  Maximum Length: 60

  The province for the address of the complaint.
• PropertyState(optional): string
  Maximum Length: 60

  The state for the address of the complaint.
• ReferralCode(optional): string
  Maximum Length: 100

  The referral code for the issue. Referral codes are used to refer an issue to another agency or another group within the agency.
• ReportedById(optional): string
  Maximum Length: 18

  The ID of the person who reported the issue.
• ReviewDueDate(optional): string(date-time)
  The issue review due date.
• ReviewerId(optional): integer(int64)
  The PERSON_ID key of the incident's reviewer. This ID comes from the table PER_USERS.
• Status(optional): string
  Maximum Length: 15

  The incident status.
• SubmitDate(optional): string(date-time)
  The issue submission date.

{
    "properties":{
        "AgencyFlag":{
            "type":"boolean",
            "description":"Indicates whether an agency staff member reported the issue."
        },
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique agency ID."
        },
        "AssignedId":{
            "format":"int64",
            "type":"integer",
            "description":"The PERSON_ID key of the person assigned to work on the incident. This ID comes from the table PER_USERS."
        },
        "ClosedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The person ID of the person who closed the case."
        },
        "ClosedDate":{
            "format":"date-time",
            "type":"string",
            "description":"The incident close date."
        },
        "ClosedReason":{
            "maxLength":450,
            "type":"string",
            "description":"The reason for closing the incident."
        },
        "DisclosureFlag":{
            "type":"boolean",
            "description":"Indicates whether the person who reported the incident chose to keep their information private. This indicator is used when agencies do not accept anonymous incidents, but do provide an option to hide private information. A value of Y means that the information is to be kept private."
        },
        "DistrictId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the district of the incident location."
        },
        "DistrictType":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the district type that is associated with the issue subtype."
        },
        "DuplicateFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the incident is a potential duplicate."
        },
        "IncidentComment":{
            "items":{
                "$ref":"#/definitions/publicSectorIncidents-IncidentComment-item"
            },
            "type":"array",
            "description":"The incidents resource is used to view, create, delete, or modify code enforcement incidents that are created by public users.",
            "title":"Incident Comments"
        },
        "IncidentId":{
            "maxLength":50,
            "type":"string",
            "description":"A logical ID for the incident transaction."
        },
        "IncidentKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for an incident. This number is created using autonumbering."
        },
        "IntakeKey":{
            "format":"int64",
            "type":"integer",
            "description":"The key from the intake record. The intake record is the parent of the incident record."
        },
        "IntakeSource":{
            "maxLength":30,
            "type":"string",
            "description":"The transaction type for the transaction that is the source of an incident."
        },
        "IssueDescription":{
            "maxLength":1000,
            "type":"string",
            "description":"The complainant's issue description."
        },
        "IssueSubtype":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the issue subtype."
        },
        "IssueSubtypeCode":{
            "maxLength":40,
            "type":"string",
            "description":"The code for the issue subtype."
        },
        "IssueSubtypeId":{
            "maxLength":50,
            "type":"string",
            "description":"The logical issue subtype ID."
        },
        "IssueType":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the issue type."
        },
        "IssueTypeId":{
            "maxLength":50,
            "type":"string",
            "description":"The logical issue type ID."
        },
        "Latitude":{
            "type":"number",
            "description":"The latitude of the property that is associated with the issue."
        },
        "LocationDescr":{
            "maxLength":1000,
            "type":"string",
            "description":"Additional issue location information such as an apartment number or descriptive details."
        },
        "Longitude":{
            "type":"number",
            "description":"The longitude of the property that is associated with the issue."
        },
        "NotifyMeFlag":{
            "type":"boolean",
            "description":"Indicates whether the registered user who reported the incident wishes to receive update notifications."
        },
        "ObsoleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the issue is obsolete."
        },
        "OriginatorSource":{
            "maxLength":30,
            "type":"string",
            "description":"The external source system identifier, such as 311, CRM, or CX."
        },
        "OriginatorSrId":{
            "maxLength":30,
            "type":"string",
            "description":"The external source unique service request ID."
        },
        "ParentId":{
            "maxLength":50,
            "type":"string",
            "description":"The ID of the parent incident."
        },
        "ParentKey":{
            "format":"int64",
            "type":"integer",
            "description":"The key of the parent incident."
        },
        "ParentType":{
            "maxLength":15,
            "type":"string",
            "description":"The type of parent record, either an incident or a case."
        },
        "PrimaryIssueFlag":{
            "type":"boolean",
            "description":"Indicates whether the issue is the parent of another issue."
        },
        "Priority":{
            "maxLength":30,
            "type":"string",
            "description":"The incident priority code. Valid values are CRITICAL P1,HIGH P2, MEDIUM P3, and LOW P4."
        },
        "PropertyAddress1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the address for the complaint."
        },
        "PropertyAddress2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the address for the complaint."
        },
        "PropertyAddress3":{
            "maxLength":240,
            "type":"string",
            "description":"The third line of the address for the complaint."
        },
        "PropertyAddress4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the address for the complaint."
        },
        "PropertyAddressId":{
            "format":"int64",
            "type":"integer",
            "description":"The property address ID."
        },
        "PropertyCity":{
            "maxLength":60,
            "type":"string",
            "description":"The city for the address of the complaint."
        },
        "PropertyCoordinateX":{
            "type":"number",
            "description":"The X coordinate of the property that is the subject of the complaint."
        },
        "PropertyCoordinateY":{
            "type":"number",
            "description":"The y coordinate of the property that is the subject of the complaint."
        },
        "PropertyCountry":{
            "maxLength":3,
            "type":"string",
            "description":"The country for the address of the complaint."
        },
        "PropertyCounty":{
            "maxLength":60,
            "type":"string",
            "description":"The county of the address of the complaint."
        },
        "PropertyParcelId":{
            "format":"int64",
            "type":"integer",
            "description":"The property parcel ID."
        },
        "PropertyPostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code for the address of the complaint."
        },
        "PropertyPostalPlusFourCode":{
            "maxLength":10,
            "type":"string",
            "description":"The postal code plus four for the address of the complaint."
        },
        "PropertyProvince":{
            "maxLength":60,
            "type":"string",
            "description":"The province for the address of the complaint."
        },
        "PropertyState":{
            "maxLength":60,
            "type":"string",
            "description":"The state for the address of the complaint."
        },
        "ReferralCode":{
            "maxLength":100,
            "type":"string",
            "description":"The referral code for the issue. Referral codes are used to refer an issue to another agency or another group within the agency."
        },
        "ReportedById":{
            "maxLength":18,
            "type":"string",
            "description":"The ID of the person who reported the issue."
        },
        "ReviewDueDate":{
            "format":"date-time",
            "type":"string",
            "description":"The issue review due date."
        },
        "ReviewerId":{
            "format":"int64",
            "type":"integer",
            "description":"The PERSON_ID key of the incident's reviewer. This ID comes from the table PER_USERS."
        },
        "Status":{
            "maxLength":15,
            "type":"string",
            "description":"The incident status."
        },
        "SubmitDate":{
            "format":"date-time",
            "type":"string",
            "description":"The issue submission date."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Incident Comments

Type: array

Title: Incident Comments

The incidents resource is used to view, create, delete, or modify code enforcement incidents that are created by public users.

Show Source

• Array of: object publicSectorIncidents-IncidentComment-item

{
    "items":{
        "$ref":"#/definitions/publicSectorIncidents-IncidentComment-item"
    },
    "type":"array",
    "description":"The incidents resource is used to view, create, delete, or modify code enforcement incidents that are created by public users.",
    "title":"Incident Comments"
}

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 : publicSectorIncidents-IncidentComment-item

Type: object

Show Source

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

  The unique identifier for the agency.
• CommentId(optional): integer(int64)
  This comment ID.
• CommentKey(optional): integer(int64)
  The comment key.
• CommentPreview(optional): string
  Title: Comment Preview

  The text of the comment in plain text format. This is used to preview the comment.
• CommentText(optional): string
  Title: Comments

  The text of the comment in HTML format.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the row.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time that the row was created.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time that the row was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• TransactionKey(optional): integer(int64)
  The transaction key for the transaction that the comment is associated with.
• TransactionType(optional): string
  Maximum Length: 10

  The type of transaction that the comment is associated with.
• Visibility(optional): string
  Title: Hide from Public

  Maximum Length: 1

  Indicates whether the comment is visible.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier for the agency.",
            "title":"Agency ID"
        },
        "CommentId":{
            "format":"int64",
            "type":"integer",
            "description":"This comment ID."
        },
        "CommentKey":{
            "format":"int64",
            "type":"integer",
            "description":"The comment key."
        },
        "CommentPreview":{
            "type":"string",
            "description":"The text of the comment in plain text format. This is used to preview the comment.",
            "title":"Comment Preview"
        },
        "CommentText":{
            "type":"string",
            "description":"The text of the comment in HTML format.",
            "title":"Comments"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the row was created.",
            "title":"Creation Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "title":"Last Updated By"
        },
        "TransactionKey":{
            "format":"int64",
            "type":"integer",
            "description":"The transaction key for the transaction that the comment is associated with."
        },
        "TransactionType":{
            "maxLength":10,
            "type":"string",
            "description":"The type of transaction that the comment is associated with."
        },
        "Visibility":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the comment is visible.",
            "title":"Hide from Public"
        },
        "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