Jump to

• Request
• Response

Update an incident

patch

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

Request

Path Parameters

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

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 ()

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

Root Schema : schema

Type: object

Show Source

• AgencyFlag: boolean
  Maximum Length: 1

  Indicates whether an agency staff member reported the issue.
• AgencyId: integer (int32)
  Default Value: 1

  The unique agency ID.
• AssignedId: integer (int64)
  The PERSON_ID key of the person assigned to work on the incident. This ID comes from the table PER_USERS.
• ClosedReason: string
  Maximum Length: 450

  The reason for closing the incident.
• DisclosureFlag: boolean
  Maximum Length: 1

  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: string
  Maximum Length: 30

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

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

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

  The incident comments resource is used to view, create, delete, or modify comments for code enforcement incidents.
• IncidentId: string
  Maximum Length: 50

  A logical ID for the incident transaction.
• IntakeSource: string
  Maximum Length: 30

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

  The complainant's issue description.
• IssueSubtypeId: string
  Maximum Length: 50

  The logical issue subtype ID.
• IssueTypeId: string
  Maximum Length: 50

  The logical issue type ID.
• Latitude: number
  The latitude of the property that is associated with the issue.
• LocationDescr: string
  Maximum Length: 1000

  Additional issue location information such as an apartment number or descriptive details.
• Longitude: number
  The longitude of the property that is associated with the issue.
• NotifyMeFlag: boolean
  Maximum Length: 1

  Indicates whether the registered user who reported the incident wishes to receive update notifications.
• ObsoleteFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the issue is obsolete.
• OriginatorSource: string
  Maximum Length: 30

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

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

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

  The type of parent record, either an incident or a case.
• PrimaryIssueFlag: boolean
  Maximum Length: 1

  Indicates whether the issue is the parent of another issue.
• Priority: string
  Maximum Length: 30

  Default Value: N

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

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

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

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

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

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

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

  The county of the address of the complaint.
• PropertyOwnerId: integer
  The unique identifier of the property owner of the incident.
• PropertyParcelId: integer (int64)
  The property parcel ID.
• PropertyParcelIdEntered: string
  Maximum Length: 30

  The APN number for the parcel that is entered while reporting the incident.
• PropertyPostalCode: string
  Maximum Length: 60

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

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

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

  The state for the address of the complaint.
• ReferralCode: 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.
• ReopenedFlag: string
  Maximum Length: 1

  Default Value: N

  Indicates whether the incident was reopened.
• ReopenedReason: string
  Maximum Length: 30

  The reason for reopening the incident.
• ReviewDueDate: string (date-time)
  The issue review due date.
• ReviewerId: integer (int64)
  The PERSON_ID key of the incident's reviewer. This ID comes from the table PER_USERS.
• Shape: object Shape
  The spatial shape of the property associated with the transaction. This information comes from GIS.
• Status: string
  Maximum Length: 15

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

{
    "type":"object",
    "properties":{
        "PropertyParcelId":{
            "type":"integer",
            "description":"The property parcel ID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "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.",
            "nullable":true
        },
        "SubmitDate":{
            "type":"string",
            "description":"The issue submission date.",
            "format":"date-time",
            "nullable":true
        },
        "IncidentComment":{
            "title":"Incident Comments",
            "type":"array",
            "description":"The incident comments resource is used to view, create, delete, or modify comments for code enforcement incidents.",
            "items":{
                "$ref":"#/components/schemas/publicSectorIncidents-IncidentComment-item-patch-request"
            }
        },
        "Latitude":{
            "type":"number",
            "description":"The latitude of the property that is associated with the issue.",
            "nullable":true
        },
        "IntakeSource":{
            "maxLength":30,
            "type":"string",
            "description":"The transaction type for the transaction that is the source of an incident.",
            "nullable":true
        },
        "IssueSubtypeId":{
            "maxLength":50,
            "type":"string",
            "description":"The logical issue subtype ID.",
            "nullable":false
        },
        "ClosedReason":{
            "maxLength":450,
            "type":"string",
            "description":"The reason for closing the incident.",
            "nullable":true
        },
        "PropertyProvince":{
            "maxLength":60,
            "type":"string",
            "description":"The province for the address of the complaint.",
            "nullable":true
        },
        "ParentType":{
            "maxLength":15,
            "type":"string",
            "description":"The type of parent record, either an incident or a case.",
            "nullable":true
        },
        "AgencyFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether an agency staff member reported the issue.",
            "nullable":true
        },
        "Status":{
            "maxLength":15,
            "type":"string",
            "description":"The incident status.",
            "nullable":false
        },
        "ReopenedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the incident was reopened.",
            "nullable":false,
            "default":"N"
        },
        "DistrictType":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the district type that is associated with the issue subtype.",
            "nullable":true
        },
        "Priority":{
            "maxLength":30,
            "type":"string",
            "description":"The incident priority code. Valid values are CRITICAL P1, HIGH P2, MEDIUM P3, and LOW P4.",
            "nullable":true,
            "default":"N"
        },
        "OriginatorSource":{
            "maxLength":30,
            "type":"string",
            "description":"The external source system identifier, such as 311, CRM, or CX.",
            "nullable":true
        },
        "LocationDescr":{
            "maxLength":1000,
            "type":"string",
            "description":"Additional issue location information such as an apartment number or descriptive details.",
            "nullable":true
        },
        "Longitude":{
            "type":"number",
            "description":"The longitude of the property that is associated with the issue.",
            "nullable":true
        },
        "PropertyCounty":{
            "maxLength":60,
            "type":"string",
            "description":"The county of the address of the complaint.",
            "nullable":true
        },
        "PropertyState":{
            "maxLength":60,
            "type":"string",
            "description":"The state for the address of the complaint.",
            "nullable":true
        },
        "NotifyMeFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the registered user who reported the incident wishes to receive update notifications.",
            "nullable":true
        },
        "PropertyPostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code for the address of the complaint.",
            "nullable":true
        },
        "OriginatorSrId":{
            "maxLength":30,
            "type":"string",
            "description":"The external source unique service request ID.",
            "nullable":true
        },
        "ObsoleteFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the issue is obsolete.",
            "nullable":true,
            "default":false
        },
        "PropertyCity":{
            "maxLength":60,
            "type":"string",
            "description":"The city for the address of the complaint.",
            "nullable":true
        },
        "DisclosureFlag":{
            "maxLength":1,
            "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.",
            "nullable":true
        },
        "ReopenedReason":{
            "maxLength":30,
            "type":"string",
            "description":"The reason for reopening the incident.",
            "nullable":true
        },
        "Shape":{
            "type":"object",
            "description":"The spatial shape of the property associated with the transaction. This information comes from GIS.",
            "nullable":true,
            "x-queryable":false
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique agency ID.",
            "format":"int32",
            "nullable":true,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "AssignedId":{
            "type":"integer",
            "description":"The PERSON_ID key of the person assigned to work on the incident. This ID comes from the table PER_USERS.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PropertyAddressId":{
            "type":"integer",
            "description":"The property address ID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PropertyAddress2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the address for the complaint.",
            "nullable":true
        },
        "PropertyAddress1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the address for the complaint.",
            "nullable":true
        },
        "PropertyAddress4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the address for the complaint.",
            "nullable":true
        },
        "PropertyAddress3":{
            "maxLength":240,
            "type":"string",
            "description":"The third line of the address for the complaint.",
            "nullable":true
        },
        "ParentId":{
            "maxLength":50,
            "type":"string",
            "description":"The ID of the parent incident.",
            "nullable":true
        },
        "IssueDescription":{
            "maxLength":1000,
            "type":"string",
            "description":"The complainant's issue description.",
            "nullable":false
        },
        "DistrictId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the district of the incident location.",
            "nullable":true
        },
        "PropertyPostalPlusFourCode":{
            "maxLength":10,
            "type":"string",
            "description":"The postal code plus four for the address of the complaint.",
            "nullable":true
        },
        "IssueTypeId":{
            "maxLength":50,
            "type":"string",
            "description":"The logical issue type ID.",
            "nullable":false
        },
        "ReviewDueDate":{
            "type":"string",
            "description":"The issue review due date.",
            "format":"date-time",
            "nullable":true
        },
        "PropertyParcelIdEntered":{
            "maxLength":30,
            "type":"string",
            "description":"The APN number for the parcel that is entered while reporting the incident.",
            "nullable":true
        },
        "PropertyCountry":{
            "maxLength":3,
            "type":"string",
            "description":"The country for the address of the complaint.",
            "nullable":true
        },
        "ParentKey":{
            "type":"integer",
            "description":"The key of the parent incident.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "IncidentId":{
            "maxLength":50,
            "type":"string",
            "description":"A logical ID for the incident transaction.",
            "nullable":false
        },
        "PropertyOwnerId":{
            "type":"integer",
            "description":"The unique identifier of the property owner of the incident.",
            "nullable":true,
            "x-queryable":false
        },
        "ReviewerId":{
            "type":"integer",
            "description":"The PERSON_ID key of the incident's reviewer. This ID comes from the table PER_USERS.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PropertyCoordinateY":{
            "type":"number",
            "description":"The y coordinate of the property that is the subject of the complaint.",
            "nullable":true
        },
        "DuplicateFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the incident is a potential duplicate.",
            "nullable":true
        },
        "PrimaryIssueFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the issue is the parent of another issue.",
            "nullable":true
        },
        "PropertyCoordinateX":{
            "type":"number",
            "description":"The X coordinate of the property that is the subject of the complaint.",
            "nullable":true
        }
    }
}

Nested Schema : Incident Comments

Type: array

Title: Incident Comments

The incident comments resource is used to view, create, delete, or modify comments for code enforcement incidents.

Show Source

• Array of: object schema

{
    "title":"Incident Comments",
    "type":"array",
    "description":"The incident comments resource is used to view, create, delete, or modify comments for code enforcement incidents.",
    "items":{
        "$ref":"#/components/schemas/publicSectorIncidents-IncidentComment-item-patch-request"
    }
}

Nested Schema : Shape

Type: object

The spatial shape of the property associated with the transaction. This information comes from GIS.

Nested Schema : schema

Type: object

Show Source

• CommentText: string (byte)
  Title: Comments

  The text of the comment in HTML format.
• Visibility: string
  Title: Hide from Public

  Maximum Length: 1

  Default Value: Y

  Indicates whether the comment is visible.

{
    "type":"object",
    "properties":{
        "Visibility":{
            "title":"Hide from Public",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the comment is visible.",
            "nullable":false,
            "default":"Y"
        },
        "CommentText":{
            "title":"Comments",
            "type":"string",
            "description":"The text of the comment in HTML format.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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

Type: object

Show Source

• AgencyFlag: boolean
  Maximum Length: 1

  Indicates whether an agency staff member reported the issue.
• AgencyId: integer (int32)
  Default Value: 1

  The unique agency ID.
• AssignedId: integer (int64)
  The PERSON_ID key of the person assigned to work on the incident. This ID comes from the table PER_USERS.
• AssignedPuid: string
  The public unique identifier for the incident assigned ID.
• AssigneeName: string
  Read Only: true

  Maximum Length: 255

  The code enforcement officer name.
• ClosedBy: string
  Read Only: true

  Maximum Length: 64

  The person ID of the person who closed the case.
• ClosedDate: string (date-time)
  Read Only: true

  The incident close date.
• ClosedReason: string
  Maximum Length: 450

  The reason for closing the incident.
• DisclosureFlag: boolean
  Maximum Length: 1

  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: string
  Maximum Length: 30

  The unique identifier for the district of the incident location.
• DistrictIdDescr: string
  Title: District Description

  Read Only: true

  Maximum Length: 100

  The description of the district where the issue is located.
• DistrictType: string
  Maximum Length: 50

  The unique identifier for the district type that is associated with the issue subtype.
• DistrictTypeDescr: string
  Title: Description

  Read Only: true

  Maximum Length: 100

  The description of the district type that is associated with the issue subtype.
• DuplicateFlag: string
  Maximum Length: 1

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

  The incident comments resource is used to view, create, delete, or modify comments for code enforcement incidents.
• IncidentId: string
  Maximum Length: 50

  A logical ID for the incident transaction.
• IncidentKey: integer (int64)
  The unique identifier for an incident. This number is created using autonumbering.
• IncidentPuid: string
  Maximum Length: 480

  Default Value:

  The public unique identifier for a migrated incident record.
• IntakeKey: integer (int64)
  Read Only: true

  The key from the intake record. The intake record is the parent of the incident record.
• IntakePuid: string
  Maximum Length: 480

  Default Value:

  The public unique identifier for a migrated parent intake record.
• IntakeSource: string
  Maximum Length: 30

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

  The complainant's issue description.
• IssueSubtype: string
  Read Only: true

  Maximum Length: 100

  The description of the issue subtype.
• IssueSubtypeCode: string
  Read Only: true

  Maximum Length: 40

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

  The logical issue subtype ID.
• IssueType: string
  Read Only: true

  Maximum Length: 100

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

  The logical issue type ID.
• Latitude: number
  The latitude of the property that is associated with the issue.
• LayoutVersion: string
  Read Only: true

  Maximum Length: 255

  The version of the intake form layout.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationDescr: string
  Maximum Length: 1000

  Additional issue location information such as an apartment number or descriptive details.
• Longitude: number
  The longitude of the property that is associated with the issue.
• NotifyMeFlag: boolean
  Maximum Length: 1

  Indicates whether the registered user who reported the incident wishes to receive update notifications.
• ObsoleteFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the issue is obsolete.
• OriginatorSource: string
  Maximum Length: 30

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

  The external source unique service request ID.
• ParcelIdEntered: string
  Title: Parcel Number

  Read Only: true

  Maximum Length: 30

  The property parcel ID.
• ParentId: string
  Maximum Length: 50

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

  The type of parent record, either an incident or a case.
• PrimaryIssueFlag: boolean
  Maximum Length: 1

  Indicates whether the issue is the parent of another issue.
• Priority: string
  Maximum Length: 30

  Default Value: N

  The incident priority code. Valid values are CRITICAL P1, HIGH P2, MEDIUM P3, and LOW P4.
• ProcessInconsistent: string
  Read Only: true

  Maximum Length: 255

  The process inconsistent status of workflow process instance.
• ProcessInstanceId: string
  Read Only: true

  Maximum Length: 255

  The identifier for the workflow process instance.
• ProcessStatus: string
  Read Only: true

  Maximum Length: 255

  The process status of workflow process instance.
• PropertyAddress1: string
  Maximum Length: 240

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

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

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

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

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

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

  The county of the address of the complaint.
• PropertyOwnerId: integer
  The unique identifier of the property owner of the incident.
• PropertyParcelId: integer (int64)
  The property parcel ID.
• PropertyParcelIdEntered: string
  Maximum Length: 30

  The APN number for the parcel that is entered while reporting the incident.
• PropertyPostalCode: string
  Maximum Length: 60

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

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

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

  The state for the address of the complaint.
• ReferralCode: 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.
• ReferralType: string
  Title: Referral Type

  Read Only: true

  Maximum Length: 100

  The referral type for the issue. Referral types are used to identify the department, agency, or other group that an incident has been referred to.
• ReopenedFlag: string
  Maximum Length: 1

  Default Value: N

  Indicates whether the incident was reopened.
• ReopenedReason: string
  Maximum Length: 30

  The reason for reopening the incident.
• ReportedById: string
  Maximum Length: 18

  The ID of the person who reported the issue.
• ReviewDueDate: string (date-time)
  The issue review due date.
• ReviewerId: integer (int64)
  The PERSON_ID key of the incident's reviewer. This ID comes from the table PER_USERS.
• ReviewerName: string
  Read Only: true

  Maximum Length: 255

  The code enforcement technician name.
• ReviewerPuid: string
  The public unique identifier for the incident reviewer ID.
• Shape: object Shape
  The spatial shape of the property associated with the transaction. This information comes from GIS.
• Status: string
  Maximum Length: 15

  The incident status.
• StatusName: string
  Title: Description

  Read Only: true

  Maximum Length: 30

  The description of the issue status.
• SubmitDate: string (date-time)
  The issue submission date.

{
    "type":"object",
    "properties":{
        "PropertyParcelId":{
            "type":"integer",
            "description":"The property parcel ID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "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.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignedPuid":{
            "type":"string",
            "description":"The public unique identifier for the incident assigned ID.",
            "nullable":true,
            "x-queryable":false
        },
        "SubmitDate":{
            "type":"string",
            "description":"The issue submission date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "IncidentComment":{
            "title":"Incident Comments",
            "type":"array",
            "description":"The incident comments resource is used to view, create, delete, or modify comments for code enforcement incidents.",
            "items":{
                "$ref":"#/components/schemas/publicSectorIncidents-IncidentComment-item-response"
            }
        },
        "ReviewerPuid":{
            "type":"string",
            "description":"The public unique identifier for the incident reviewer ID.",
            "nullable":true,
            "x-queryable":false
        },
        "Latitude":{
            "type":"number",
            "description":"The latitude of the property that is associated with the issue.",
            "nullable":true,
            "x-queryable":true
        },
        "DistrictTypeDescr":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"The description of the district type that is associated with the issue subtype.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LayoutVersion":{
            "maxLength":255,
            "type":"string",
            "description":"The version of the intake form layout.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IntakeSource":{
            "maxLength":30,
            "type":"string",
            "description":"The transaction type for the transaction that is the source of an incident.",
            "nullable":true,
            "x-queryable":true
        },
        "IssueSubtypeId":{
            "maxLength":50,
            "type":"string",
            "description":"The logical issue subtype ID.",
            "nullable":false,
            "x-queryable":true
        },
        "ClosedReason":{
            "maxLength":450,
            "type":"string",
            "description":"The reason for closing the incident.",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyProvince":{
            "maxLength":60,
            "type":"string",
            "description":"The province for the address of the complaint.",
            "nullable":true,
            "x-queryable":true
        },
        "ParcelIdEntered":{
            "title":"Parcel Number",
            "maxLength":30,
            "type":"string",
            "description":"The property parcel ID.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentType":{
            "maxLength":15,
            "type":"string",
            "description":"The type of parent record, either an incident or a case.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "IncidentPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier for a migrated incident record.",
            "nullable":false,
            "default":" ",
            "x-queryable":true
        },
        "AgencyFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether an agency staff member reported the issue.",
            "nullable":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":15,
            "type":"string",
            "description":"The incident status.",
            "nullable":false,
            "x-queryable":true
        },
        "ReopenedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the incident was reopened.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "DistrictType":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the district type that is associated with the issue subtype.",
            "nullable":true,
            "x-queryable":true
        },
        "IntakePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier for a migrated parent intake record.",
            "nullable":false,
            "default":" ",
            "x-queryable":true
        },
        "Priority":{
            "maxLength":30,
            "type":"string",
            "description":"The incident priority code. Valid values are CRITICAL P1, HIGH P2, MEDIUM P3, and LOW P4.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "IncidentKey":{
            "type":"integer",
            "description":"The unique identifier for an incident. This number is created using autonumbering.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "OriginatorSource":{
            "maxLength":30,
            "type":"string",
            "description":"The external source system identifier, such as 311, CRM, or CX.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationDescr":{
            "maxLength":1000,
            "type":"string",
            "description":"Additional issue location information such as an apartment number or descriptive details.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusName":{
            "title":"Description",
            "maxLength":30,
            "type":"string",
            "description":"The description of the issue status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Longitude":{
            "type":"number",
            "description":"The longitude of the property that is associated with the issue.",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyCounty":{
            "maxLength":60,
            "type":"string",
            "description":"The county of the address of the complaint.",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyState":{
            "maxLength":60,
            "type":"string",
            "description":"The state for the address of the complaint.",
            "nullable":true,
            "x-queryable":true
        },
        "NotifyMeFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the registered user who reported the incident wishes to receive update notifications.",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyPostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code for the address of the complaint.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginatorSrId":{
            "maxLength":30,
            "type":"string",
            "description":"The external source unique service request ID.",
            "nullable":true,
            "x-queryable":true
        },
        "ObsoleteFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the issue is obsolete.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "PropertyCity":{
            "maxLength":60,
            "type":"string",
            "description":"The city for the address of the complaint.",
            "nullable":true,
            "x-queryable":true
        },
        "DisclosureFlag":{
            "maxLength":1,
            "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.",
            "nullable":true,
            "x-queryable":true
        },
        "ReopenedReason":{
            "maxLength":30,
            "type":"string",
            "description":"The reason for reopening the incident.",
            "nullable":true,
            "x-queryable":true
        },
        "IntakeKey":{
            "type":"integer",
            "description":"The key from the intake record. The intake record is the parent of the incident record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Shape":{
            "type":"object",
            "description":"The spatial shape of the property associated with the transaction. This information comes from GIS.",
            "nullable":true,
            "x-queryable":false
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique agency ID.",
            "format":"int32",
            "nullable":true,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "ProcessStatus":{
            "maxLength":255,
            "type":"string",
            "description":"The process status of workflow process instance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferralType":{
            "title":"Referral Type",
            "maxLength":100,
            "type":"string",
            "description":"The referral type for the issue. Referral types are used to identify the department, agency, or other group that an incident has been referred to.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedId":{
            "type":"integer",
            "description":"The PERSON_ID key of the person assigned to work on the incident. This ID comes from the table PER_USERS.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DistrictIdDescr":{
            "title":"District Description",
            "maxLength":100,
            "type":"string",
            "description":"The description of the district where the issue is located.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyAddressId":{
            "type":"integer",
            "description":"The property address ID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PropertyAddress2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the address for the complaint.",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyAddress1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the address for the complaint.",
            "nullable":true,
            "x-queryable":true
        },
        "IssueSubtypeCode":{
            "maxLength":40,
            "type":"string",
            "description":"The code for the issue subtype.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyAddress4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the address for the complaint.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessInconsistent":{
            "maxLength":255,
            "type":"string",
            "description":"The process inconsistent status of workflow process instance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyAddress3":{
            "maxLength":240,
            "type":"string",
            "description":"The third line of the address for the complaint.",
            "nullable":true,
            "x-queryable":true
        },
        "AssigneeName":{
            "maxLength":255,
            "type":"string",
            "description":"The code enforcement officer name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentId":{
            "maxLength":50,
            "type":"string",
            "description":"The ID of the parent incident.",
            "nullable":true,
            "x-queryable":true
        },
        "IssueDescription":{
            "maxLength":1000,
            "type":"string",
            "description":"The complainant's issue description.",
            "nullable":false,
            "x-queryable":true
        },
        "DistrictId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the district of the incident location.",
            "nullable":true,
            "x-queryable":true
        },
        "IssueType":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the issue type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueSubtype":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the issue subtype.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyPostalPlusFourCode":{
            "maxLength":10,
            "type":"string",
            "description":"The postal code plus four for the address of the complaint.",
            "nullable":true,
            "x-queryable":true
        },
        "ReportedById":{
            "maxLength":18,
            "type":"string",
            "description":"The ID of the person who reported the issue.",
            "nullable":true,
            "x-queryable":true
        },
        "IssueTypeId":{
            "maxLength":50,
            "type":"string",
            "description":"The logical issue type ID.",
            "nullable":false,
            "x-queryable":true
        },
        "ReviewDueDate":{
            "type":"string",
            "description":"The issue review due date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyParcelIdEntered":{
            "maxLength":30,
            "type":"string",
            "description":"The APN number for the parcel that is entered while reporting the incident.",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyCountry":{
            "maxLength":3,
            "type":"string",
            "description":"The country for the address of the complaint.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentKey":{
            "type":"integer",
            "description":"The key of the parent incident.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IncidentId":{
            "maxLength":50,
            "type":"string",
            "description":"A logical ID for the incident transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "PropertyOwnerId":{
            "type":"integer",
            "description":"The unique identifier of the property owner of the incident.",
            "nullable":true,
            "x-queryable":false
        },
        "ReviewerId":{
            "type":"integer",
            "description":"The PERSON_ID key of the incident's reviewer. This ID comes from the table PER_USERS.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PropertyCoordinateY":{
            "type":"number",
            "description":"The y coordinate of the property that is the subject of the complaint.",
            "nullable":true,
            "x-queryable":true
        },
        "DuplicateFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the incident is a potential duplicate.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryIssueFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the issue is the parent of another issue.",
            "nullable":true,
            "x-queryable":true
        },
        "ClosedDate":{
            "type":"string",
            "description":"The incident close date.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessInstanceId":{
            "maxLength":255,
            "type":"string",
            "description":"The identifier for the workflow process instance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ClosedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The person ID of the person who closed the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReviewerName":{
            "maxLength":255,
            "type":"string",
            "description":"The code enforcement technician name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyCoordinateX":{
            "type":"number",
            "description":"The X coordinate of the property that is the subject of the complaint.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Incident Comments

Type: array

Title: Incident Comments

The incident comments resource is used to view, create, delete, or modify comments for code enforcement incidents.

Show Source

• Array of: object publicSectorIncidents-IncidentComment-item-response

{
    "title":"Incident Comments",
    "type":"array",
    "description":"The incident comments resource is used to view, create, delete, or modify comments for code enforcement incidents.",
    "items":{
        "$ref":"#/components/schemas/publicSectorIncidents-IncidentComment-item-response"
    }
}

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 : Shape

Type: object

The spatial shape of the property associated with the transaction. This information comes from GIS.

Nested Schema : publicSectorIncidents-IncidentComment-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

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

  Read Only: true

  The text of the comment in plain text format. This is used to preview the comment.
• CommentPuid: string
  Maximum Length: 480

  Default Value:

  The public unique identifier for a migrated comment record.
• CommentText: string (byte)
  Title: Comments

  The text of the comment in HTML format.
• CreatedByName: string
  Title: Created By

  Read Only: true

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

  Read Only: true

  The date and time that the row was created.
• IncidentPuid: string
  Maximum Length: 480

  Default Value:

  The public unique identifier for a migrated parent incident record.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

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

  The link relations associated with the resource instance.
• OriginalCreatedBy: string
  The name of the user who created the comment.
• TransactionKey: integer (int64)
  The transaction key for the transaction that the comment is associated with.
• TransactionType: string
  Read Only: true

  Maximum Length: 10

  Default Value: INC

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

  Maximum Length: 1

  Default Value: Y

  Indicates whether the comment is visible.

{
    "type":"object",
    "properties":{
        "CreatedByName":{
            "title":"Created By",
            "type":"string",
            "description":"The name of the user who created the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time that the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionType":{
            "maxLength":10,
            "type":"string",
            "description":"The type of transaction that the comment is associated with.",
            "nullable":false,
            "readOnly":true,
            "default":"INC",
            "x-queryable":true
        },
        "CommentPreview":{
            "title":"Comment Preview",
            "type":"string",
            "description":"The text of the comment in plain text format. This is used to preview the comment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OriginalCreatedBy":{
            "type":"string",
            "description":"The name of the user who created the comment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "TransactionKey":{
            "type":"integer",
            "description":"The transaction key for the transaction that the comment is associated with.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier for the agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "CommentText":{
            "title":"Comments",
            "type":"string",
            "description":"The text of the comment in HTML format.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CommentKey":{
            "type":"integer",
            "description":"The comment key.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CommentId":{
            "type":"integer",
            "description":"The unique identifier of the comment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CommentPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier for a migrated comment record.",
            "nullable":false,
            "default":" ",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Visibility":{
            "title":"Hide from Public",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the comment is visible.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "LastUpdatedByName":{
            "title":"Last Updated By",
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "IncidentPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier for a migrated parent incident record.",
            "nullable":false,
            "default":" ",
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time that the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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."
        }
    }
}

Links

IncidentComment

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorIncidents/{IncidentKey}/child/IncidentComment

Parameters:

• IncidentKey: $request.path.IncidentKey

The incident comments resource is used to view, create, delete, or modify comments for code enforcement incidents.

Back to Top