Jump to

• Request
• Response

Get an intake global fields record

get

/fscmRestApi/resources/11.13.18.05/publicSectorCeIntakeGlobalFields/{IntakeKey}

Request

Path Parameters

• IntakeKey(required): integer(int64)
  The key from the intake record.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : publicSectorCeIntakeGlobalFields-item-response

Type: object

Show Source

• AgencyFlag: boolean
  Maximum Length: 1

  Indicates whether an agency staff member reported the issue.
• AnonymousFlag: boolean
  Title: Hide My Contact Information

  Maximum Length: 1

  Indicates if the issue was reported by an anonymous user.
• AttXrefTransKey: integer (int64)
  The key from the attachment cross reference.
• Case: array Global Customs
  Title: Global Customs

  The case resource is used to view, create, modify, or delete case information.
• CeGlobalCustom: array Global Customs
  Title: Global Customs

  The global custom resource is used to view, create, modify, or delete a child field of record. Note: The standard actions are not available in the records resource. You must use the agency???s dynamic REST API: /fscmRestApi/resources/11.13.18.05/CE_c.
• ComplnAddress1: string
  Maximum Length: 240

  The complainant's first line address.
• ComplnAddress2: string
  Maximum Length: 240

  The complainant's second line address.
• ComplnAddress3: string
  Maximum Length: 240

  The complainant's third line address.
• ComplnAddress4: string
  Maximum Length: 240

  The complainant's fourth line address.
• ComplnCity: string
  Maximum Length: 60

  The complainant's city.
• ComplnCountry: string
  Maximum Length: 3

  The complainant's country.
• ComplnCounty: string
  Maximum Length: 60

  The complainant's county.
• ComplnPostalCode: string
  Maximum Length: 60

  The complainant's postal code.
• ComplnPostalPlusFourCode: string
  Maximum Length: 10

  The complainant's postal code plus four.
• ComplnProvince: string
  Maximum Length: 60

  The complainant's province.
• ComplnState: string
  Maximum Length: 60

  The complainant's state.
• CompnEmail: string
  Title: Email

  Maximum Length: 320

  The complainant's email.
• CompnFirstName: string
  Title: Name

  Maximum Length: 150

  The complainant's first name.
• CompnLastName: string
  Maximum Length: 150

  The complainant's last name.
• CompnMiddleName: string
  Maximum Length: 60

  The complainant's middle name.
• CompnName: string
  Maximum Length: 450

  The complainant's name.
• CompnNameSuffix: string
  Maximum Length: 30

  The complainant's name suffix.
• CompnPhoneAreaCode: string
  Maximum Length: 10

  The complainant's phone area code.
• CompnPhoneCountryCode: string
  Maximum Length: 10

  The complainant's phone country code.
• CompnPhoneExtension: string
  Maximum Length: 20

  The complainant's phone extension.
• CompnPhoneNumber: string
  Title: Phone

  Maximum Length: 40

  The complainant's phone number.
• CompnTitle: string
  Maximum Length: 60

  The complainant's title.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The name of the user who created the row.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the row was created.
• 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.
• Incident: array Global Customs
  Title: Global Customs

  The incident resource is used to view, create, modify, or delete incident information.
• IntakeId: string
  Maximum Length: 50

  A logical ID for the intake transaction.
• IntakeKey: integer (int64)
  The key from the intake record.
• IntakePuid: string
  Maximum Length: 480

  Default Value:

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

  The transaction type for the transaction that is the source of an incident.
• IntakeType: string
  Title: Intake Type

  Maximum Length: 30

  The type of record, either an incident or a case.
• IssueDescription: string
  Title: Issue Description

  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.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the row was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The name of the user who last updated the row.
• Latitude: number
  The latitude of the property that is associated with the issue.
• LayoutVersion: string
  Maximum Length: 30

  Default Value: V1

  The layout version.
• links: array Links
  Title: Links

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

  Indicates location description.
• 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.
• OriginatorSource: string
  Maximum Length: 30

  The external source unique service request ID.
• OriginatorSrId: string
  Maximum Length: 30

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

  The property parcel ID.
• Priority: string
  Title: Does this issue pose a health hazard or public safety risk?

  Maximum Length: 30

  The issue 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.
• 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.
• 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.
• RecordName: string
  Maximum Length: 80

  Indicates customization jedi name.
• RecordNumber: string
  Maximum Length: 64

  Indicates customization jedi number.
• ReportedById: string
  Maximum Length: 18

  Indicates the reporter.
• RowType: string
  Maximum Length: 30

  Default Value: 0

  Structure definition of the user descriptive flexfield.
• Severity: string
  Maximum Length: 4

  The incident severity code.
• Srid: integer (int64)
  The unique service request ID.
• Status: string
  Maximum Length: 15

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

{
    "type":"object",
    "properties":{
        "RecordName":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates customization jedi name.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CompnFirstName":{
            "title":"Name",
            "maxLength":"150",
            "type":"string",
            "description":"The complainant's first name.",
            "nullable":true,
            "x-queryable":true
        },
        "ComplnCity":{
            "maxLength":"60",
            "type":"string",
            "description":"The complainant's city.",
            "nullable":true,
            "x-queryable":true
        },
        "SubmitDate":{
            "type":"string",
            "description":"The issue submission date.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "Latitude":{
            "type":"number",
            "description":"The latitude of the property that is associated with the issue.",
            "nullable":true,
            "x-queryable":true
        },
        "LayoutVersion":{
            "maxLength":"30",
            "type":"string",
            "description":"The layout version.",
            "nullable":true,
            "default":"V1",
            "x-queryable":true
        },
        "CompnPhoneNumber":{
            "title":"Phone",
            "maxLength":"40",
            "type":"string",
            "description":"The complainant's phone number.",
            "nullable":true,
            "x-queryable":true
        },
        "IntakeSource":{
            "maxLength":"30",
            "type":"string",
            "description":"The transaction type for the transaction that is the source of an incident.",
            "nullable":false,
            "x-queryable":true
        },
        "IssueSubtypeId":{
            "maxLength":"50",
            "type":"string",
            "description":"The logical issue subtype ID.",
            "nullable":false,
            "x-queryable":true
        },
        "CompnEmail":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The complainant's email.",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyProvince":{
            "maxLength":"60",
            "type":"string",
            "description":"The province for the address of the complaint.",
            "nullable":true,
            "x-queryable":true
        },
        "CompnLastName":{
            "maxLength":"150",
            "type":"string",
            "description":"The complainant's last name.",
            "nullable":true,
            "x-queryable":true
        },
        "ParcelIdEntered":{
            "maxLength":"30",
            "type":"string",
            "description":"The property parcel ID.",
            "nullable":true,
            "x-queryable":true
        },
        "IntakeId":{
            "maxLength":"50",
            "type":"string",
            "description":"A logical ID for the intake transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AgencyFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an agency staff member reported the issue.",
            "nullable":true,
            "x-queryable":true
        },
        "CompnNameSuffix":{
            "maxLength":"30",
            "type":"string",
            "description":"The complainant's name suffix.",
            "nullable":true,
            "x-queryable":true
        },
        "AttXrefTransKey":{
            "type":"integer",
            "description":"The key from the attachment cross reference.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":"15",
            "type":"string",
            "description":"The incident status.",
            "nullable":false,
            "x-queryable":true
        },
        "CompnPhoneCountryCode":{
            "maxLength":"10",
            "type":"string",
            "description":"The complainant's phone country code.",
            "nullable":true,
            "x-queryable":true
        },
        "AnonymousFlag":{
            "title":"Hide My Contact Information",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the issue was reported by an anonymous user.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IntakePuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier for a migrated intake record.",
            "nullable":false,
            "default":" ",
            "x-queryable":true
        },
        "ComplnCountry":{
            "maxLength":"3",
            "type":"string",
            "description":"The complainant's country.",
            "nullable":true,
            "x-queryable":true
        },
        "Priority":{
            "title":"Does this issue pose a health hazard or public safety risk?",
            "maxLength":"30",
            "type":"string",
            "description":"The issue priority code. Valid values are CRITICAL P1, HIGH P2, MEDIUM P3, and LOW P4.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginatorSource":{
            "maxLength":"30",
            "type":"string",
            "description":"The external source unique service request ID.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationDescr":{
            "maxLength":"1000",
            "type":"string",
            "description":"Indicates location description.",
            "nullable":true,
            "x-queryable":true
        },
        "ComplnPostalPlusFourCode":{
            "maxLength":"10",
            "type":"string",
            "description":"The complainant's postal code plus four.",
            "nullable":true,
            "x-queryable":true
        },
        "Longitude":{
            "type":"number",
            "description":"The longitude of the property that is associated with the issue.",
            "nullable":true,
            "x-queryable":true
        },
        "CompnName":{
            "maxLength":"450",
            "type":"string",
            "description":"The complainant's name.",
            "nullable":true,
            "x-queryable":true
        },
        "ComplnProvince":{
            "maxLength":"60",
            "type":"string",
            "description":"The complainant's province.",
            "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":false,
            "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 system identifier, such as 311, CRM, or CX.",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyCity":{
            "maxLength":"60",
            "type":"string",
            "description":"The city for the address of the complaint.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordNumber":{
            "maxLength":"64",
            "type":"string",
            "description":"Indicates customization jedi number.",
            "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":false,
            "x-queryable":true
        },
        "IntakeKey":{
            "type":"integer",
            "description":"The key from the intake record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RowType":{
            "maxLength":"30",
            "type":"string",
            "description":"Structure definition of the user descriptive flexfield.",
            "nullable":false,
            "default":"0",
            "x-queryable":true
        },
        "IntakeType":{
            "title":"Intake Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of record, either an incident or a case.",
            "nullable":false,
            "x-queryable":true
        },
        "Case":{
            "title":"Global Customs",
            "type":"array",
            "description":"The case resource is used to view, create, modify, or delete case information.",
            "items":{
                "$ref":"#/components/schemas/publicSectorCeIntakeGlobalFields-Case-item-response"
            },
            "x-cardinality":"1"
        },
        "ComplnPostalCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The complainant's postal code.",
            "nullable":true,
            "x-queryable":true
        },
        "CompnMiddleName":{
            "maxLength":"60",
            "type":"string",
            "description":"The complainant's middle name.",
            "nullable":true,
            "x-queryable":true
        },
        "ComplnState":{
            "maxLength":"60",
            "type":"string",
            "description":"The complainant's state.",
            "nullable":true,
            "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
        },
        "CompnPhoneAreaCode":{
            "maxLength":"10",
            "type":"string",
            "description":"The complainant's phone area code.",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyAddress4":{
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line of the address for the complaint.",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyAddress3":{
            "maxLength":"240",
            "type":"string",
            "description":"The third line of the address for the complaint.",
            "nullable":true,
            "x-queryable":true
        },
        "CeGlobalCustom":{
            "title":"Global Customs",
            "type":"array",
            "description":"The global custom resource is used to view, create, modify, or delete a child field of record. Note: The standard actions are not available in the records resource. You must use the agency???s dynamic REST API: /fscmRestApi/resources/11.13.18.05/CE_c.",
            "items":{
                "$ref":"#/components/schemas/publicSectorCeIntakeGlobalFields-CeGlobalCustom-item-response"
            },
            "x-cardinality":"1"
        },
        "IssueDescription":{
            "title":"Issue Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The complainant's issue description.",
            "nullable":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":"Indicates the reporter.",
            "nullable":true,
            "x-queryable":true
        },
        "IssueTypeId":{
            "maxLength":"50",
            "type":"string",
            "description":"The logical issue type ID.",
            "nullable":false,
            "x-queryable":true
        },
        "ComplnAddress1":{
            "maxLength":"240",
            "type":"string",
            "description":"The complainant's first line address.",
            "nullable":true,
            "x-queryable":true
        },
        "ComplnAddress2":{
            "maxLength":"240",
            "type":"string",
            "description":"The complainant's second line address.",
            "nullable":true,
            "x-queryable":true
        },
        "ComplnCounty":{
            "maxLength":"60",
            "type":"string",
            "description":"The complainant's county.",
            "nullable":true,
            "x-queryable":true
        },
        "Severity":{
            "maxLength":"4",
            "type":"string",
            "description":"The incident severity code.",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyCountry":{
            "maxLength":"3",
            "type":"string",
            "description":"The country for the address of the complaint.",
            "nullable":true,
            "x-queryable":true
        },
        "CompnPhoneExtension":{
            "maxLength":"20",
            "type":"string",
            "description":"The complainant's phone extension.",
            "nullable":true,
            "x-queryable":true
        },
        "ComplnAddress3":{
            "maxLength":"240",
            "type":"string",
            "description":"The complainant's third line address.",
            "nullable":true,
            "x-queryable":true
        },
        "ComplnAddress4":{
            "maxLength":"240",
            "type":"string",
            "description":"The complainant's fourth line address.",
            "nullable":true,
            "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
        },
        "Incident":{
            "title":"Global Customs",
            "type":"array",
            "description":"The incident resource is used to view, create, modify, or delete incident information.",
            "items":{
                "$ref":"#/components/schemas/publicSectorCeIntakeGlobalFields-Incident-item-response"
            },
            "x-cardinality":"1"
        },
        "CompnTitle":{
            "maxLength":"60",
            "type":"string",
            "description":"The complainant's title.",
            "nullable":true,
            "x-queryable":true
        },
        "Srid":{
            "type":"integer",
            "description":"The unique service request ID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "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
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Global Customs

Type: array

Title: Global Customs

The case resource is used to view, create, modify, or delete case information.

Show Source

• Array of: object publicSectorCeIntakeGlobalFields-Case-item-response

{
    "title":"Global Customs",
    "type":"array",
    "description":"The case resource is used to view, create, modify, or delete case information.",
    "items":{
        "$ref":"#/components/schemas/publicSectorCeIntakeGlobalFields-Case-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Global Customs

Type: array

Title: Global Customs

The global custom resource is used to view, create, modify, or delete a child field of record. Note: The standard actions are not available in the records resource. You must use the agency???s dynamic REST API: /fscmRestApi/resources/11.13.18.05/CE_c.

Show Source

• Array of: object publicSectorCeIntakeGlobalFields-CeGlobalCustom-item-response

{
    "title":"Global Customs",
    "type":"array",
    "description":"The global custom resource is used to view, create, modify, or delete a child field of record. Note: The standard actions are not available in the records resource. You must use the agency???s dynamic REST API: /fscmRestApi/resources/11.13.18.05/CE_c.",
    "items":{
        "$ref":"#/components/schemas/publicSectorCeIntakeGlobalFields-CeGlobalCustom-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Global Customs

Type: array

Title: Global Customs

The incident resource is used to view, create, modify, or delete incident information.

Show Source

• Array of: object publicSectorCeIntakeGlobalFields-Incident-item-response

{
    "title":"Global Customs",
    "type":"array",
    "description":"The incident resource is used to view, create, modify, or delete incident information.",
    "items":{
        "$ref":"#/components/schemas/publicSectorCeIntakeGlobalFields-Incident-item-response"
    },
    "x-cardinality":"1"
}

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 : publicSectorCeIntakeGlobalFields-Case-item-response

Type: object

Show Source

• AccessCode: string
  Title: Access Number

  Maximum Length: 5
• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1
• AppealDueDate: string (date)
  Title: Appeal By
• AssignedId: integer (int64)
  Title: Inspector Assigned
• AssignedPuid: string
• CaseCodeReference: array Global Customs
  Title: Global Customs

  The case code reference resource is used to view, create, modify, or delete case code references.
• CaseId: string
  Title: Case ID

  Maximum Length: 50
• CaseKey: integer (int64)
• CasePuid: string
  Maximum Length: 480
• ChangeReason: string
• ClosedBy: string
  Title: Closed By

  Maximum Length: 64
• ClosedDate: string (date-time)
  Title: Closed On
• ClosedReason: string
  Title: Reason for Closing

  Maximum Length: 450
• ComplianceDueDate: string (date)
  Title: Compliance Date
• CompliedOn: string (date)
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true
• CriticalFlag: boolean
  Title: Critical

  Maximum Length: 1

  Default Value: false
• DistrictId: string
  Maximum Length: 30
• DistrictType: string
  Title: District Type

  Maximum Length: 50
• FunctionalStatus: string
  Maximum Length: 15
• InspectionActDate: string (date)
• IntakeKey: integer (int64)
  Read Only: true
• IntakePuid: string
  Maximum Length: 480

  Default Value:
• IntakeSource: string
  Maximum Length: 30

  Default Value: ORA_CS
• InternalPriority: string
  Title: Internal Priority

  Maximum Length: 30

  Default Value: ORA_N
• IssueDescription: string
  Title: Issue Description

  Maximum Length: 1000
• IssueSubtype: string
  Title: Issue Subtype

  Read Only: true

  Maximum Length: 100
• IssueSubtypeId: string
  Maximum Length: 50
• IssueType: string
  Title: Issue Type

  Read Only: true

  Maximum Length: 100
• IssueTypeId: string
  Maximum Length: 50
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64
• Latitude: number
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationDescription: string
  Title: Location Description

  Maximum Length: 1000
• Longitude: number
• ObsoleteFlag: boolean
  Maximum Length: 1

  Default Value: false
• ParcelIdEntered: string
  Maximum Length: 30
• Priority: string
  Title: Priority

  Maximum Length: 30

  Default Value: ORA_N
• PropertyAddress1: string
  Title: Address Line 1

  Maximum Length: 240
• PropertyAddress2: string
  Title: Address Line 2

  Maximum Length: 240
• PropertyAddress3: string
  Title: Address Line 3

  Maximum Length: 240
• PropertyAddress4: string
  Title: Address Line 4

  Maximum Length: 240
• PropertyAddressId: integer (int64)
• PropertyCity: string
  Title: City

  Maximum Length: 60
• PropertyCoordinateX: number
• PropertyCoordinateY: number
• PropertyCountry: string
  Title: Country

  Maximum Length: 3
• PropertyCounty: string
  Maximum Length: 60
• PropertyOwnerId: integer
• PropertyParcelId: integer (int64)
• PropertyPostalCode: string
  Maximum Length: 60
• PropertyPostalPlusFourCode: string
  Maximum Length: 10
• PropertyProvince: string
  Maximum Length: 60
• PropertyState: string
  Title: State Name

  Maximum Length: 60
• ReferralCode: string
  Title: Referred To

  Maximum Length: 100
• ReportedById: string
  Title: Reported By

  Maximum Length: 64
• ReviewerId: integer (int64)
  Title: Technician Assigned
• ReviewerPuid: string
• Shape: object Shape
  Read Only: true
• SourceTransactionPuid: string
• SourceTrxId: string
  Maximum Length: 50
• Status: string
  Title: Case Status

  Maximum Length: 15

  Default Value: ORA_VIO
• StatusDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 30
• SubmitDate: string (date-time)
  Title: Submitted On
• UpdateAllComplyBy: string
  Maximum Length: 80

  Default Value: N

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyParcelId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReferralCode":{
            "title":"Referred To",
            "maxLength":"100",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "AssignedPuid":{
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "SubmitDate":{
            "title":"Submitted On",
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "ReviewerPuid":{
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "Latitude":{
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "CompliedOn":{
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SourceTransactionPuid":{
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "IntakeSource":{
            "maxLength":"30",
            "type":"string",
            "nullable":false,
            "default":"ORA_CS",
            "x-queryable":true
        },
        "IssueSubtypeId":{
            "maxLength":"50",
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "ClosedReason":{
            "title":"Reason for Closing",
            "maxLength":"450",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ChangeReason":{
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "PropertyProvince":{
            "maxLength":"60",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "LocationDescription":{
            "title":"Location Description",
            "maxLength":"1000",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "StatusDescription":{
            "title":"Description",
            "maxLength":"30",
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelIdEntered":{
            "maxLength":"30",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InspectionActDate":{
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "UpdateAllComplyBy":{
            "maxLength":"80",
            "type":"string",
            "nullable":true,
            "default":"N",
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Case Status",
            "maxLength":"15",
            "type":"string",
            "nullable":false,
            "default":"ORA_VIO",
            "x-queryable":true
        },
        "FunctionalStatus":{
            "maxLength":"15",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CaseKey":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DistrictType":{
            "title":"District Type",
            "maxLength":"50",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "IntakePuid":{
            "maxLength":"480",
            "type":"string",
            "nullable":false,
            "default":" ",
            "x-queryable":true
        },
        "Priority":{
            "title":"Priority",
            "maxLength":"30",
            "type":"string",
            "nullable":false,
            "default":"ORA_N",
            "x-queryable":true
        },
        "InternalPriority":{
            "title":"Internal Priority",
            "maxLength":"30",
            "type":"string",
            "nullable":false,
            "default":"ORA_N",
            "x-queryable":true
        },
        "AccessCode":{
            "title":"Access Number",
            "maxLength":"5",
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "Longitude":{
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyCounty":{
            "maxLength":"60",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyState":{
            "title":"State Name",
            "maxLength":"60",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyPostalCode":{
            "maxLength":"60",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "SourceTrxId":{
            "maxLength":"50",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ObsoleteFlag":{
            "maxLength":"1",
            "type":"boolean",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "PropertyCity":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "CriticalFlag":{
            "title":"Critical",
            "maxLength":"1",
            "type":"boolean",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "IntakeKey":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Shape":{
            "type":"object",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "ComplianceDueDate":{
            "title":"Compliance Date",
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CasePuid":{
            "maxLength":"480",
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "AssignedId":{
            "title":"Inspector Assigned",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PropertyAddressId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CaseCodeReference":{
            "title":"Global Customs",
            "type":"array",
            "description":"The case code reference resource is used to view, create, modify, or delete case code references.",
            "items":{
                "$ref":"#/components/schemas/publicSectorCeIntakeGlobalFields-Case-CaseCodeReference-item-response"
            }
        },
        "PropertyAddress2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyAddress1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyAddress4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyAddress3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "IssueDescription":{
            "title":"Issue Description",
            "maxLength":"1000",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "AppealDueDate":{
            "title":"Appeal By",
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "DistrictId":{
            "maxLength":"30",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "IssueType":{
            "title":"Issue Type",
            "maxLength":"100",
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueSubtype":{
            "title":"Issue Subtype",
            "maxLength":"100",
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyPostalPlusFourCode":{
            "maxLength":"10",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ReportedById":{
            "title":"Reported By",
            "maxLength":"64",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "IssueTypeId":{
            "maxLength":"50",
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "CaseId":{
            "title":"Case ID",
            "maxLength":"50",
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "PropertyCountry":{
            "title":"Country",
            "maxLength":"3",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyOwnerId":{
            "type":"integer",
            "nullable":true,
            "x-queryable":false
        },
        "ReviewerId":{
            "title":"Technician Assigned",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PropertyCoordinateY":{
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "ClosedDate":{
            "title":"Closed On",
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ClosedBy":{
            "title":"Closed By",
            "maxLength":"64",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyCoordinateX":{
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Global Customs

Type: array

Title: Global Customs

The case code reference resource is used to view, create, modify, or delete case code references.

Show Source

• Array of: object publicSectorCeIntakeGlobalFields-Case-CaseCodeReference-item-response

{
    "title":"Global Customs",
    "type":"array",
    "description":"The case code reference resource is used to view, create, modify, or delete case code references.",
    "items":{
        "$ref":"#/components/schemas/publicSectorCeIntakeGlobalFields-Case-CaseCodeReference-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

Read Only: true

Nested Schema : publicSectorCeIntakeGlobalFields-Case-CaseCodeReference-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1
• CaseId: string
  Read Only: true

  Maximum Length: 50
• CaseKey: integer (int64)
• CasePuid: string
  Maximum Length: 480

  Default Value:
• ChangeReasonCode: string
  Title: Reason for Update

  Default Value: ORA_ADMIN
• ChangeReasonText: string
  Title: Reason Details
• CodeReferenceCode: string
  Title: Code Violation

  Maximum Length: 100
• CodeReferenceDescription: string (byte)
• CodeReferenceKey: integer (int64)
• CodeReferenceName: string
  Maximum Length: 200
• CodeReferencePuid: string
  Maximum Length: 480
• Comments: string
  Title: Comments

  Maximum Length: 1000
• CompliedOn: string (date)
  Title: Complied On
• ComplyBy: string (date)
  Title: Comply By
• CorrectiveActionCode: string
  Maximum Length: 100
• CorrectiveActionDescription: string (byte)
• CorrectiveActionName: string
  Maximum Length: 200
• CreationDate: string (date-time)
  Read Only: true
• FeeFrequencyUnit: string
  Title: Frequency

  Maximum Length: 30

  Default Value: ORA_D
• FeeRate: number
  Title: Rate

  Default Value: 0
• LastUpdateDate: string (date-time)
  Read Only: true
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SourceInspectionKey: integer (int64)
• SourceInspectionPuid: string
  Maximum Length: 480
• SourceTransactionContext: string
  Maximum Length: 80

  Default Value: ORA_MAN
• SourceTransactionContextKey: integer
• Status: string
  Title: Status

  Maximum Length: 8

  Default Value: ORA_OPEN
• StatusText: string
  Read Only: true

  Maximum Length: 255
• TotalFees: number
  Title: Total Fine

  Read Only: true
• TotalPaidFees: number
  Title: Total Fine Paid

  Read Only: true

{
    "type":"object",
    "properties":{
        "SourceInspectionPuid":{
            "maxLength":"480",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "StatusText":{
            "maxLength":"255",
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CorrectiveActionName":{
            "maxLength":"200",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "CodeReferencePuid":{
            "maxLength":"480",
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "CompliedOn":{
            "title":"Complied On",
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CasePuid":{
            "maxLength":"480",
            "type":"string",
            "nullable":false,
            "default":" ",
            "x-queryable":true
        },
        "CorrectiveActionDescription":{
            "type":"string",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CodeReferenceName":{
            "maxLength":"200",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "TotalPaidFees":{
            "title":"Total Fine Paid",
            "type":"number",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":"8",
            "type":"string",
            "nullable":false,
            "default":"ORA_OPEN",
            "x-queryable":true
        },
        "SourceTransactionContextKey":{
            "type":"integer",
            "nullable":true,
            "x-queryable":false
        },
        "CaseKey":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CodeReferenceCode":{
            "title":"Code Violation",
            "maxLength":"100",
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "FeeRate":{
            "title":"Rate",
            "type":"number",
            "nullable":false,
            "default":"0",
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"1000",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "CaseId":{
            "maxLength":"50",
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ComplyBy":{
            "title":"Comply By",
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "FeeFrequencyUnit":{
            "title":"Frequency",
            "maxLength":"30",
            "type":"string",
            "nullable":false,
            "default":"ORA_D",
            "x-queryable":true
        },
        "TotalFees":{
            "title":"Total Fine",
            "type":"number",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CorrectiveActionCode":{
            "maxLength":"100",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "SourceInspectionKey":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ChangeReasonCode":{
            "title":"Reason for Update",
            "type":"string",
            "nullable":true,
            "default":"ORA_ADMIN",
            "x-queryable":false
        },
        "CodeReferenceDescription":{
            "type":"string",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SourceTransactionContext":{
            "maxLength":"80",
            "type":"string",
            "nullable":true,
            "default":"ORA_MAN",
            "x-queryable":false
        },
        "CodeReferenceKey":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeReasonText":{
            "title":"Reason Details",
            "type":"string",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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."
        }
    }
}

Nested Schema : publicSectorCeIntakeGlobalFields-CeGlobalCustom-item-response

Type: object

Show Source

• CreatedBy: string
  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  The date and time that the row was created.
• IntakeId: string
  Maximum Length: 50

  A logical ID for the intake transaction.
• IntakeKey: integer (int64)
  The key from the intake record.
• LastUpdateDate: string (date-time)
  The date and time that the row was updated.
• LastUpdatedBy: string
  Maximum Length: 64

  The user who last updated the row.
• LastUpdateLogin: string
  Maximum Length: 32

  The login who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Indicates the object versionnumber.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time that the row was created.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "IntakeKey":{
            "type":"integer",
            "description":"The key from the intake record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Indicates the object versionnumber.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "IntakeId":{
            "maxLength":"50",
            "type":"string",
            "description":"A logical ID for the intake transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time that the row was updated.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login who last updated the row.",
            "nullable":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 : publicSectorCeIntakeGlobalFields-Incident-item-response

Type: object

Show Source

• AgencyFlag: boolean
  Maximum Length: 1
• AgencyId: integer (int32)
  Default Value: 1
• AssignedId: integer (int64)
• AssignedPuid: string
• AssigneeName: string
  Read Only: true

  Maximum Length: 255
• ClosedBy: string
  Read Only: true

  Maximum Length: 64
• ClosedDate: string (date-time)
  Read Only: true
• ClosedReason: string
  Maximum Length: 450
• DisclosureFlag: boolean
  Maximum Length: 1
• DistrictId: string
  Maximum Length: 30
• DistrictIdDescr: string
  Title: District Description

  Read Only: true

  Maximum Length: 100
• DistrictType: string
  Maximum Length: 50
• DistrictTypeDescr: string
  Title: Description

  Read Only: true

  Maximum Length: 100
• DuplicateFlag: string
  Maximum Length: 1
• IncidentId: string
  Maximum Length: 50
• IncidentKey: integer (int64)
• IncidentPuid: string
  Maximum Length: 480

  Default Value:
• IntakeKey: integer (int64)
  Read Only: true
• IntakePuid: string
  Maximum Length: 480

  Default Value:
• IntakeSource: string
  Maximum Length: 30
• IssueDescription: string
  Maximum Length: 1000
• IssueSubtype: string
  Read Only: true

  Maximum Length: 100
• IssueSubtypeCode: string
  Read Only: true

  Maximum Length: 40
• IssueSubtypeId: string
  Maximum Length: 50
• IssueType: string
  Read Only: true

  Maximum Length: 100
• IssueTypeId: string
  Maximum Length: 50
• Latitude: number
• LayoutVersion: string
  Read Only: true

  Maximum Length: 255
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationDescr: string
  Maximum Length: 1000
• Longitude: number
• NotifyMeFlag: boolean
  Maximum Length: 1
• ObsoleteFlag: boolean
  Maximum Length: 1

  Default Value: false
• OriginatorSource: string
  Maximum Length: 30
• OriginatorSrId: string
  Maximum Length: 30
• ParcelIdEntered: string
  Title: Parcel Number

  Read Only: true

  Maximum Length: 30
• ParentId: string
  Maximum Length: 50
• ParentKey: integer (int64)
• ParentType: string
  Maximum Length: 15
• PrimaryIssueFlag: boolean
  Maximum Length: 1
• Priority: string
  Maximum Length: 30

  Default Value: N
• ProcessInconsistent: string
  Read Only: true

  Maximum Length: 255
• ProcessInstanceId: string
  Read Only: true

  Maximum Length: 255
• ProcessStatus: string
  Read Only: true

  Maximum Length: 255
• PropertyAddress1: string
  Maximum Length: 240
• PropertyAddress2: string
  Maximum Length: 240
• PropertyAddress3: string
  Maximum Length: 240
• PropertyAddress4: string
  Maximum Length: 240
• PropertyAddressId: integer (int64)
• PropertyCity: string
  Maximum Length: 60
• PropertyCoordinateX: number
• PropertyCoordinateY: number
• PropertyCountry: string
  Maximum Length: 3
• PropertyCounty: string
  Maximum Length: 60
• PropertyOwnerId: integer
• PropertyParcelId: integer (int64)
• PropertyParcelIdEntered: string
  Maximum Length: 30
• PropertyPostalCode: string
  Maximum Length: 60
• PropertyPostalPlusFourCode: string
  Maximum Length: 10
• PropertyProvince: string
  Maximum Length: 60
• PropertyState: string
  Maximum Length: 60
• ReferralCode: string
  Maximum Length: 100
• ReferralType: string
  Title: Referral Type

  Read Only: true

  Maximum Length: 100
• ReopenedFlag: string
  Maximum Length: 1

  Default Value: N
• ReopenedReason: string
  Maximum Length: 30
• ReportedById: string
  Maximum Length: 18
• ReviewDueDate: string (date-time)
• ReviewerId: integer (int64)
• ReviewerName: string
  Read Only: true

  Maximum Length: 255
• ReviewerPuid: string
• Shape: object Shape
• Status: string
  Maximum Length: 15
• StatusName: string
  Title: Description

  Read Only: true

  Maximum Length: 30
• SubmitDate: string (date-time)

{
    "type":"object",
    "properties":{
        "PropertyParcelId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReferralCode":{
            "maxLength":"100",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "AssignedPuid":{
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "SubmitDate":{
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ReviewerPuid":{
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "Latitude":{
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "DistrictTypeDescr":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LayoutVersion":{
            "maxLength":"255",
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IntakeSource":{
            "maxLength":"30",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "IssueSubtypeId":{
            "maxLength":"50",
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "ClosedReason":{
            "maxLength":"450",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyProvince":{
            "maxLength":"60",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ParcelIdEntered":{
            "title":"Parcel Number",
            "maxLength":"30",
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentType":{
            "maxLength":"15",
            "type":"string",
            "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",
            "nullable":false,
            "default":" ",
            "x-queryable":true
        },
        "AgencyFlag":{
            "maxLength":"1",
            "type":"boolean",
            "nullable":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":"15",
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "ReopenedFlag":{
            "maxLength":"1",
            "type":"string",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "DistrictType":{
            "maxLength":"50",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "IntakePuid":{
            "maxLength":"480",
            "type":"string",
            "nullable":false,
            "default":" ",
            "x-queryable":true
        },
        "Priority":{
            "maxLength":"30",
            "type":"string",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "IncidentKey":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "OriginatorSource":{
            "maxLength":"30",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "LocationDescr":{
            "maxLength":"1000",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "StatusName":{
            "title":"Description",
            "maxLength":"30",
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Longitude":{
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyCounty":{
            "maxLength":"60",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyState":{
            "maxLength":"60",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "NotifyMeFlag":{
            "maxLength":"1",
            "type":"boolean",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyPostalCode":{
            "maxLength":"60",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "OriginatorSrId":{
            "maxLength":"30",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ObsoleteFlag":{
            "maxLength":"1",
            "type":"boolean",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "PropertyCity":{
            "maxLength":"60",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "DisclosureFlag":{
            "maxLength":"1",
            "type":"boolean",
            "nullable":true,
            "x-queryable":true
        },
        "ReopenedReason":{
            "maxLength":"30",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "IntakeKey":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Shape":{
            "type":"object",
            "nullable":true,
            "x-queryable":false
        },
        "AgencyId":{
            "type":"integer",
            "format":"int32",
            "nullable":true,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "ProcessStatus":{
            "maxLength":"255",
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferralType":{
            "title":"Referral Type",
            "maxLength":"100",
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DistrictIdDescr":{
            "title":"District Description",
            "maxLength":"100",
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyAddressId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PropertyAddress2":{
            "maxLength":"240",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyAddress1":{
            "maxLength":"240",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "IssueSubtypeCode":{
            "maxLength":"40",
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyAddress4":{
            "maxLength":"240",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessInconsistent":{
            "maxLength":"255",
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyAddress3":{
            "maxLength":"240",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "AssigneeName":{
            "maxLength":"255",
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentId":{
            "maxLength":"50",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "IssueDescription":{
            "maxLength":"1000",
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "DistrictId":{
            "maxLength":"30",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "IssueType":{
            "maxLength":"100",
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueSubtype":{
            "maxLength":"100",
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyPostalPlusFourCode":{
            "maxLength":"10",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ReportedById":{
            "maxLength":"18",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "IssueTypeId":{
            "maxLength":"50",
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "ReviewDueDate":{
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyParcelIdEntered":{
            "maxLength":"30",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyCountry":{
            "maxLength":"3",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ParentKey":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "IncidentId":{
            "maxLength":"50",
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "PropertyOwnerId":{
            "type":"integer",
            "nullable":true,
            "x-queryable":false
        },
        "ReviewerId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PropertyCoordinateY":{
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "DuplicateFlag":{
            "maxLength":"1",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryIssueFlag":{
            "maxLength":"1",
            "type":"boolean",
            "nullable":true,
            "x-queryable":true
        },
        "ClosedDate":{
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessInstanceId":{
            "maxLength":"255",
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ClosedBy":{
            "maxLength":"64",
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReviewerName":{
            "maxLength":"255",
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyCoordinateX":{
            "type":"number",
            "nullable":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 : Shape

Type: object

Links

Case

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorCeIntakeGlobalFields/{IntakeKey}/child/Case

Parameters:

• IntakeKey: $request.path.IntakeKey

The case resource is used to view, create, modify, or delete case information.

CeGlobalCustom

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorCeIntakeGlobalFields/{IntakeKey}/child/CeGlobalCustom

Parameters:

• IntakeKey: $request.path.IntakeKey

The case resource is used to view, create, modify, or delete case information.

Incident

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorCeIntakeGlobalFields/{IntakeKey}/child/Incident

Parameters:

• IntakeKey: $request.path.IntakeKey

The case resource is used to view, create, modify, or delete case information.

Back to Top