Jump to

• Request
• Response

Create a case

post

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

Request

Path Parameters

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

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

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(required): string
  Title: Case ID

  Maximum Length: 50
• CaseKey: integer (int64)
• CasePuid(required): 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)
• 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)
• 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
• IssueSubtypeId(required): string
  Maximum Length: 50
• IssueTypeId(required): string
  Maximum Length: 50
• Latitude: number
• 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
• SourceTransactionPuid: string
• SourceTrxId: string
  Maximum Length: 50
• Status: string
  Title: Case Status

  Maximum Length: 15

  Default Value: ORA_VIO
• SubmitDate(required): string (date-time)
  Title: Submitted On
• UpdateAllComplyBy: string
  Maximum Length: 80

  Default Value: N

{
    "required":[
        "CaseId",
        "CasePuid",
        "IssueSubtypeId",
        "IssueTypeId",
        "SubmitDate"
    ],
    "type":"object",
    "properties":{
        "PropertyParcelId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ReferralCode":{
            "title":"Referred To",
            "maxLength":100,
            "type":"string",
            "nullable":true
        },
        "AssignedPuid":{
            "type":"string",
            "nullable":true
        },
        "SubmitDate":{
            "title":"Submitted On",
            "type":"string",
            "format":"date-time",
            "nullable":false
        },
        "ReviewerPuid":{
            "type":"string",
            "nullable":true
        },
        "Latitude":{
            "type":"number",
            "nullable":true
        },
        "CompliedOn":{
            "type":"string",
            "format":"date",
            "nullable":true
        },
        "SourceTransactionPuid":{
            "type":"string",
            "nullable":true
        },
        "IntakeSource":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "default":"ORA_CS"
        },
        "IssueSubtypeId":{
            "maxLength":50,
            "type":"string",
            "nullable":false
        },
        "ClosedReason":{
            "title":"Reason for Closing",
            "maxLength":450,
            "type":"string",
            "nullable":true
        },
        "ChangeReason":{
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "PropertyProvince":{
            "maxLength":60,
            "type":"string",
            "nullable":true
        },
        "LocationDescription":{
            "title":"Location Description",
            "maxLength":1000,
            "type":"string",
            "nullable":true
        },
        "ParcelIdEntered":{
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "InspectionActDate":{
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "UpdateAllComplyBy":{
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "default":"N",
            "x-queryable":false
        },
        "Status":{
            "title":"Case Status",
            "maxLength":15,
            "type":"string",
            "nullable":false,
            "default":"ORA_VIO"
        },
        "FunctionalStatus":{
            "maxLength":15,
            "type":"string",
            "nullable":true
        },
        "CaseKey":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "DistrictType":{
            "title":"District Type",
            "maxLength":50,
            "type":"string",
            "nullable":true
        },
        "IntakePuid":{
            "maxLength":480,
            "type":"string",
            "nullable":false,
            "default":" "
        },
        "Priority":{
            "title":"Priority",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "default":"ORA_N"
        },
        "InternalPriority":{
            "title":"Internal Priority",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "default":"ORA_N"
        },
        "AccessCode":{
            "title":"Access Number",
            "maxLength":5,
            "type":"string",
            "nullable":false
        },
        "Longitude":{
            "type":"number",
            "nullable":true
        },
        "PropertyCounty":{
            "maxLength":60,
            "type":"string",
            "nullable":true
        },
        "PropertyState":{
            "title":"State Name",
            "maxLength":60,
            "type":"string",
            "nullable":true
        },
        "PropertyPostalCode":{
            "maxLength":60,
            "type":"string",
            "nullable":true
        },
        "SourceTrxId":{
            "maxLength":50,
            "type":"string",
            "nullable":true
        },
        "ObsoleteFlag":{
            "maxLength":1,
            "type":"boolean",
            "nullable":false,
            "default":false
        },
        "PropertyCity":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "nullable":true
        },
        "CriticalFlag":{
            "title":"Critical",
            "maxLength":1,
            "type":"boolean",
            "nullable":false,
            "default":false
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "ComplianceDueDate":{
            "title":"Compliance Date",
            "type":"string",
            "format":"date",
            "nullable":true
        },
        "CasePuid":{
            "maxLength":480,
            "type":"string",
            "nullable":false
        },
        "AssignedId":{
            "title":"Inspector Assigned",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PropertyAddressId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "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-post-request"
            }
        },
        "PropertyAddress2":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "nullable":true
        },
        "PropertyAddress1":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "nullable":true
        },
        "PropertyAddress4":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "nullable":true
        },
        "PropertyAddress3":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "nullable":true
        },
        "IssueDescription":{
            "title":"Issue Description",
            "maxLength":1000,
            "type":"string",
            "nullable":true
        },
        "AppealDueDate":{
            "title":"Appeal By",
            "type":"string",
            "format":"date",
            "nullable":true
        },
        "DistrictId":{
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "PropertyPostalPlusFourCode":{
            "maxLength":10,
            "type":"string",
            "nullable":true
        },
        "ReportedById":{
            "title":"Reported By",
            "maxLength":64,
            "type":"string",
            "nullable":true
        },
        "IssueTypeId":{
            "maxLength":50,
            "type":"string",
            "nullable":false
        },
        "CaseId":{
            "title":"Case ID",
            "maxLength":50,
            "type":"string",
            "nullable":false
        },
        "PropertyCountry":{
            "title":"Country",
            "maxLength":3,
            "type":"string",
            "nullable":true
        },
        "PropertyOwnerId":{
            "type":"integer",
            "nullable":true,
            "x-queryable":false
        },
        "ReviewerId":{
            "title":"Technician Assigned",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PropertyCoordinateY":{
            "type":"number",
            "nullable":true
        },
        "ClosedDate":{
            "title":"Closed On",
            "type":"string",
            "format":"date-time",
            "nullable":true
        },
        "ClosedBy":{
            "title":"Closed By",
            "maxLength":64,
            "type":"string",
            "nullable":true
        },
        "PropertyCoordinateX":{
            "type":"number",
            "nullable":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-post-request

{
    "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-post-request"
    }
}

Nested Schema : publicSectorCeIntakeGlobalFields-Case-CaseCodeReference-item-post-request

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1
• CaseKey: integer (int64)
• CasePuid: string
  Maximum Length: 480

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

  Default Value: ORA_ADMIN
• ChangeReasonText: string
  Title: Description
• 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
• FeeFrequencyUnit: string
  Title: Frequency

  Maximum Length: 30

  Default Value: ORA_F
• FeeRate: number
  Title: Rate

  Default Value: 0
• 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

{
    "type":"object",
    "properties":{
        "SourceInspectionPuid":{
            "maxLength":480,
            "type":"string",
            "nullable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":8,
            "type":"string",
            "nullable":false,
            "default":"ORA_OPEN"
        },
        "SourceTransactionContextKey":{
            "type":"integer",
            "nullable":true,
            "x-queryable":false
        },
        "CaseKey":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AgencyId":{
            "type":"integer",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "CodeReferenceCode":{
            "title":"Code Violation",
            "maxLength":100,
            "type":"string",
            "nullable":false
        },
        "FeeRate":{
            "title":"Rate",
            "type":"number",
            "nullable":false,
            "default":0
        },
        "Comments":{
            "title":"Comments",
            "maxLength":1000,
            "type":"string",
            "nullable":true
        },
        "CorrectiveActionName":{
            "maxLength":200,
            "type":"string",
            "nullable":true
        },
        "CodeReferencePuid":{
            "maxLength":480,
            "type":"string",
            "nullable":false
        },
        "CompliedOn":{
            "title":"Complied On",
            "type":"string",
            "format":"date",
            "nullable":true
        },
        "ComplyBy":{
            "title":"Comply By",
            "type":"string",
            "format":"date",
            "nullable":true
        },
        "CasePuid":{
            "maxLength":480,
            "type":"string",
            "nullable":false,
            "default":" "
        },
        "FeeFrequencyUnit":{
            "title":"Frequency",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "default":"ORA_F"
        },
        "CorrectiveActionDescription":{
            "type":"string",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CorrectiveActionCode":{
            "maxLength":100,
            "type":"string",
            "nullable":true
        },
        "SourceInspectionKey":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "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"
            }
        },
        "CodeReferenceName":{
            "maxLength":200,
            "type":"string",
            "nullable":true
        },
        "ChangeReasonText":{
            "title":"Description",
            "type":"string",
            "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 : 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: Description
• 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_F
• 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_F",
            "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":"Description",
            "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."
        }
    }
}

Links

CaseCodeReference

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

Parameters:

• IntakeKey: $request.path.IntakeKey
• publicSectorCeIntakeGlobalFields_Case_Id: $request.path.publicSectorCeIntakeGlobalFields_Case_Id

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

Back to Top