Update a case
patch
/fscmRestApi/resources/11.13.18.05/publicSectorCases/{CaseKey}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
CaseKey: integer
The unique identifier of the case.
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorCases-item
Type:
Show Source
object-
AccessCode(optional):
string
Title:
Access NumberMaximum Length:5The access code of the case. -
AgencyId(optional):
integer(int32)
Title:
Agency IDThe unique identifier of the agency of the case. -
AssignedId(optional):
integer(int64)
Title:
Inspector AssignedThe unique identifier of the code officer assigned to the case. -
CaseId(optional):
string
Title:
Case IDMaximum Length:50The identifier of the case. -
CaseKey(optional):
integer(int64)
The unique identifier of the case.
-
ChangeReason(optional):
string
The reason for modifying the case.
-
ClosedBy(optional):
string
Title:
Closed ByMaximum Length:64The name of the user who closed the case. -
ClosedDate(optional):
string(date-time)
Title:
Closed OnThe date when the case was closed. -
ClosedReason(optional):
string
Title:
Reason for ClosingMaximum Length:450The reason for closing the case. -
ComplianceDueDate(optional):
string(date)
Title:
Compliance DateThe compliance date of the case. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The name of the user who created the row. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date and time when the row was created. -
CriticalFlag(optional):
boolean
Title:
CriticalThe switch to indicate that the case is critical. -
DistrictId(optional):
string
Maximum Length:
30The unique identifier of the district of the location of the case. -
DistrictType(optional):
string
Title:
District TypeMaximum Length:50The type of district associated with the case. -
IntakeKey(optional):
integer(int64)
The unique identifier of the intake.
-
IntakeSource(optional):
string
Maximum Length:
30The source of the case intake. -
InternalPriority(optional):
string
Title:
Internal PriorityMaximum Length:30The internal priority of the case. -
IssueDescription(optional):
string
Title:
Issue DescriptionMaximum Length:1000The description of the issue. -
IssueSubtype(optional):
string
Maximum Length:
100The name of the issue subtype associated with the case. -
IssueSubtypeId(optional):
string
Maximum Length:
50The unique identifier of the issue subtype of the case. -
IssueType(optional):
string
Maximum Length:
100The name of the issue type associated with the case. -
IssueTypeId(optional):
string
Maximum Length:
50The unique identifier of the issue type of the case. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe date and time when the row was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The name of the user who last updated the row. -
Latitude(optional):
number
The latitude of the location of the case.
-
links(optional):
array Items
Title:
ItemsLink Relations -
LocationDescription(optional):
string
Title:
Location DescriptionMaximum Length:1000The description of the location. -
Longitude(optional):
number
The longitude of the location of the case.
-
ObsoleteFlag(optional):
boolean
The switch to indicate that the case is obsolete.
-
Priority(optional):
string
Title:
PriorityMaximum Length:30The priority of the case. -
PropertyAddress1(optional):
string
Title:
Address Line 1Maximum Length:240The first line of the property address of the case. -
PropertyAddress2(optional):
string
Title:
Address Line 2Maximum Length:240The second line of the property address of the case. -
PropertyAddress3(optional):
string
Title:
Address Line 3Maximum Length:240The third line of the property address of the case. -
PropertyAddress4(optional):
string
Title:
Address Line 4Maximum Length:240The fourth line of the property address of the case. -
PropertyAddressId(optional):
integer(int64)
The unique identifier of the property address of the case.
-
PropertyCity(optional):
string
Title:
CityMaximum Length:60The city of the property address of the case. -
PropertyCoordinateX(optional):
number
The x-coordinate of the property address of the case.
-
PropertyCoordinateY(optional):
number
The y-coordinate of the property address of the case.
-
PropertyCountry(optional):
string
Maximum Length:
3The country of the property address of the case. -
PropertyCounty(optional):
string
Maximum Length:
60The county of the property address of the case. -
PropertyParcelId(optional):
integer(int64)
The unique identifier of the property parcel of the case.
-
PropertyPostalCode(optional):
string
Maximum Length:
60The postal code of the property address of the case. -
PropertyPostalPlusFourCode(optional):
string
Maximum Length:
10The postal plus code of the property address of the case. -
PropertyProvince(optional):
string
Maximum Length:
60The province of the property address of the case. -
PropertyState(optional):
string
Title:
State NameMaximum Length:60The state of the property address of the case. -
ReferralCode(optional):
string
Title:
Referred ToMaximum Length:100The unique identifier of the referral body of the case. -
ReportedById(optional):
string
Title:
Reported ByMaximum Length:64The unique identifier of the person who reported the case. -
ReviewerId(optional):
integer(int64)
Title:
Technician AssignedThe unique identifier of the code technician assigned to the case. -
SourceTrxId(optional):
string
Maximum Length:
50The unique identifier of the source transaction that created the case. -
Status(optional):
string
Title:
Case StatusMaximum Length:15The status of the case. -
SubmitDate(optional):
string(date-time)
Title:
Submitted OnThe date when the case was submitted.
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorCases-item
Type:
Show Source
object-
AccessCode(optional):
string
Title:
Access NumberMaximum Length:5The access code of the case. -
AgencyId(optional):
integer(int32)
Title:
Agency IDThe unique identifier of the agency of the case. -
AssignedId(optional):
integer(int64)
Title:
Inspector AssignedThe unique identifier of the code officer assigned to the case. -
CaseId(optional):
string
Title:
Case IDMaximum Length:50The identifier of the case. -
CaseKey(optional):
integer(int64)
The unique identifier of the case.
-
ChangeReason(optional):
string
The reason for modifying the case.
-
ClosedBy(optional):
string
Title:
Closed ByMaximum Length:64The name of the user who closed the case. -
ClosedDate(optional):
string(date-time)
Title:
Closed OnThe date when the case was closed. -
ClosedReason(optional):
string
Title:
Reason for ClosingMaximum Length:450The reason for closing the case. -
ComplianceDueDate(optional):
string(date)
Title:
Compliance DateThe compliance date of the case. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The name of the user who created the row. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date and time when the row was created. -
CriticalFlag(optional):
boolean
Title:
CriticalThe switch to indicate that the case is critical. -
DistrictId(optional):
string
Maximum Length:
30The unique identifier of the district of the location of the case. -
DistrictType(optional):
string
Title:
District TypeMaximum Length:50The type of district associated with the case. -
IntakeKey(optional):
integer(int64)
The unique identifier of the intake.
-
IntakeSource(optional):
string
Maximum Length:
30The source of the case intake. -
InternalPriority(optional):
string
Title:
Internal PriorityMaximum Length:30The internal priority of the case. -
IssueDescription(optional):
string
Title:
Issue DescriptionMaximum Length:1000The description of the issue. -
IssueSubtype(optional):
string
Maximum Length:
100The name of the issue subtype associated with the case. -
IssueSubtypeId(optional):
string
Maximum Length:
50The unique identifier of the issue subtype of the case. -
IssueType(optional):
string
Maximum Length:
100The name of the issue type associated with the case. -
IssueTypeId(optional):
string
Maximum Length:
50The unique identifier of the issue type of the case. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe date and time when the row was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The name of the user who last updated the row. -
Latitude(optional):
number
The latitude of the location of the case.
-
links(optional):
array Items
Title:
ItemsLink Relations -
LocationDescription(optional):
string
Title:
Location DescriptionMaximum Length:1000The description of the location. -
Longitude(optional):
number
The longitude of the location of the case.
-
ObsoleteFlag(optional):
boolean
The switch to indicate that the case is obsolete.
-
Priority(optional):
string
Title:
PriorityMaximum Length:30The priority of the case. -
PropertyAddress1(optional):
string
Title:
Address Line 1Maximum Length:240The first line of the property address of the case. -
PropertyAddress2(optional):
string
Title:
Address Line 2Maximum Length:240The second line of the property address of the case. -
PropertyAddress3(optional):
string
Title:
Address Line 3Maximum Length:240The third line of the property address of the case. -
PropertyAddress4(optional):
string
Title:
Address Line 4Maximum Length:240The fourth line of the property address of the case. -
PropertyAddressId(optional):
integer(int64)
The unique identifier of the property address of the case.
-
PropertyCity(optional):
string
Title:
CityMaximum Length:60The city of the property address of the case. -
PropertyCoordinateX(optional):
number
The x-coordinate of the property address of the case.
-
PropertyCoordinateY(optional):
number
The y-coordinate of the property address of the case.
-
PropertyCountry(optional):
string
Maximum Length:
3The country of the property address of the case. -
PropertyCounty(optional):
string
Maximum Length:
60The county of the property address of the case. -
PropertyParcelId(optional):
integer(int64)
The unique identifier of the property parcel of the case.
-
PropertyPostalCode(optional):
string
Maximum Length:
60The postal code of the property address of the case. -
PropertyPostalPlusFourCode(optional):
string
Maximum Length:
10The postal plus code of the property address of the case. -
PropertyProvince(optional):
string
Maximum Length:
60The province of the property address of the case. -
PropertyState(optional):
string
Title:
State NameMaximum Length:60The state of the property address of the case. -
ReferralCode(optional):
string
Title:
Referred ToMaximum Length:100The unique identifier of the referral body of the case. -
ReportedById(optional):
string
Title:
Reported ByMaximum Length:64The unique identifier of the person who reported the case. -
ReviewerId(optional):
integer(int64)
Title:
Technician AssignedThe unique identifier of the code technician assigned to the case. -
SourceTrxId(optional):
string
Maximum Length:
50The unique identifier of the source transaction that created the case. -
Status(optional):
string
Title:
Case StatusMaximum Length:15The status of the case. -
SubmitDate(optional):
string(date-time)
Title:
Submitted OnThe date when the case was submitted.
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.