Get a case
get
/fscmRestApi/resources/11.13.18.05/publicSectorListCases/{CaseKey}
Request
Path Parameters
-
CaseKey: integer
The unique identifier of the case.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : publicSectorListCases-item
Type:
Show Source
object
-
AccessCode(optional):
string
Title:
Access Number
Maximum Length:5
The access code to claim the case. -
AdministerCaseStatusAccess(optional):
array Administer Case Status Permissions
Title:
Administer Case Status Permissions
The administer case status access resource is used to determine whether the status of a case can be modified. -
AgencyId(optional):
integer(int32)
The unique identifier of the agency of the case.
-
AppealDueDate(optional):
string(date)
Title:
Appeal By
The appeal due date for the case. -
AssignedId(optional):
integer(int64)
The unique identifier of the code officer assigned to the case.
-
CaseId(optional):
string
Maximum Length:
50
The identifier of the case. -
CaseKey(optional):
integer(int64)
The unique identifier of the case.
-
ClosedBy(optional):
string
Maximum Length:
64
The name of the user who closed the case. -
ClosedDate(optional):
string(date-time)
The date when the case was closed.
-
ClosedReason(optional):
string
Maximum Length:
450
The reason for closing the case. -
ComplianceDueDate(optional):
string(date)
The compliance date of the case.
-
CreatedBy(optional):
string
Maximum Length:
64
The name of the user who created the row. -
CreationDate(optional):
string(date-time)
The date and time when the row was created.
-
CriticalFlag(optional):
boolean
The switch to indicate that the case is critical.
-
DistrictId(optional):
string
Maximum Length:
30
The unique identifier of the district of the location of the case. -
DistrictType(optional):
string
Title:
District Type
Maximum Length:50
The type of the district of the location of the case. -
IntakeKey(optional):
integer(int64)
The unique identifier of the intake.
-
IntakeSource(optional):
string
Maximum Length:
30
The source of the case intake. -
InternalPriority(optional):
string
Maximum Length:
30
The internal priority of the case. -
IssueDescription(optional):
string
Maximum Length:
1000
The description of the issue. -
IssueSubtype(optional):
string
Maximum Length:
100
The name of the issue subtype associated with the case. -
IssueSubtypeId(optional):
string
Maximum Length:
50
The unique identifier of the issue subtype of the case. -
IssueType(optional):
string
Maximum Length:
100
The name of the issue type associated with the case. -
IssueTypeId(optional):
string
Maximum Length:
50
The unique identifier of the issue type of the case. -
LastUpdateDate(optional):
string(date-time)
The date and time when the row was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The 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:
Items
Link Relations -
LocationDescription(optional):
string
Maximum Length:
1000
The description of the location. -
Longitude(optional):
number
The longitude of the location of the case.
-
MigratedDataFlag(optional):
string
Maximum Length:
3
The identifier for the migrated data. -
ObsoleteFlag(optional):
boolean
The switch to indicate that the case is obsolete.
-
Priority(optional):
string
Maximum Length:
30
The priority of the case. -
ProcessInstanceId(optional):
string
Maximum Length:
500
The process instance identifier of the workflow associated with the case. -
ProcessInstStatus(optional):
string
Maximum Length:
15
The process instance status of the workflow that is associated with the case. -
PropertyAddress1(optional):
string
Maximum Length:
240
The first line of the property address of the case. -
PropertyAddress2(optional):
string
Maximum Length:
240
The second line of the property address of the case. -
PropertyAddress3(optional):
string
Maximum Length:
240
The third line of the property address of the case. -
PropertyAddress4(optional):
string
Maximum Length:
240
The 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
Maximum Length:
60
The 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:
3
The country of the property address of the case. -
PropertyCounty(optional):
string
Maximum Length:
60
The 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:
60
The postal code of the property address of the case. -
PropertyPostalPlusFourcode(optional):
string
Maximum Length:
10
The postal plus code of the property address of the case. -
PropertyProvince(optional):
string
Maximum Length:
60
The province of the property address of the case. -
PropertyState(optional):
string
Maximum Length:
60
The state of the property address of the case. -
ReferralCode(optional):
string
Maximum Length:
100
The unique identifier of the referral body of the case. -
ReportedById(optional):
string
Maximum Length:
64
The unique identifier of the person who reported the case. -
ReviewerId(optional):
integer(int64)
The unique identifier of the code technician assigned to the case.
-
SourceTrxId(optional):
string
Maximum Length:
50
The unique identifier of the source transaction that created the case. -
Status(optional):
string
Maximum Length:
15
The status of the case. -
StatusDescription(optional):
string
Maximum Length:
30
The description of the status of the case. -
SubmitDate(optional):
string(date-time)
The date when the case was submitted.
-
TotalFees(optional):
number
Title:
Total Fees
The total fees for the case. -
TotalPaid(optional):
number
Title:
Total Paid
The total paid fees for the case. -
TotalPayableFees(optional):
number
Title:
Total Payable
The total payable fees for the case. -
TotalPaymentInProcess(optional):
number
Title:
Total Payments in Process
The total fees for the case for which payment is in progress. -
UpdateAccess(optional):
array Update Case Permissions
Title:
Update Case Permissions
The update case access resource is used to determine whether a case can be modified. -
UpdateCaseStatusAccess(optional):
array Case Status Change Permissions
Title:
Case Status Change Permissions
The update case status access resource is used to determine whether the status of a case can be modified.
Nested Schema : Administer Case Status Permissions
Type:
array
Title:
Administer Case Status Permissions
The administer case status access resource is used to determine whether the status of a case can be modified.
Show Source
Nested Schema : Update Case Permissions
Type:
array
Title:
Update Case Permissions
The update case access resource is used to determine whether a case can be modified.
Show Source
Nested Schema : Case Status Change Permissions
Type:
array
Title:
Case Status Change Permissions
The update case status access resource is used to determine whether the status of a case can be modified.
Show Source
Nested Schema : publicSectorListCases-AdministerCaseStatusAccess-item
Type:
Show Source
object
-
CaseKey(optional):
integer(int64)
The unique identifier of the case.
-
links(optional):
array Items
Title:
Items
Link Relations
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.
Nested Schema : publicSectorListCases-UpdateAccess-item
Type:
Show Source
object
-
CaseKey(optional):
integer(int64)
The unique identifier of the case.
-
links(optional):
array Items
Title:
Items
Link Relations
Nested Schema : publicSectorListCases-UpdateCaseStatusAccess-item
Type:
Show Source
object
-
CaseKey(optional):
integer(int64)
The unique identifier of the case.
-
links(optional):
array Items
Title:
Items
Link Relations