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
Root Schema : schema
Type:
Show Source
object
-
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
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
Nested Schema : publicSectorCeIntakeGlobalFields-Case-CaseCodeReference-item-post-request
Type:
Show Source
object
-
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:
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
-
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
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.
Root Schema : publicSectorCeIntakeGlobalFields-Case-item-response
Type:
Show Source
object
-
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
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
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Shape
Type:
object
Read Only:
true
Nested Schema : publicSectorCeIntakeGlobalFields-Case-CaseCodeReference-item-response
Type:
Show Source
object
-
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_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
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- 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. - IntakeKey: