Get all cases
get
/fscmRestApi/resources/11.13.18.05/publicSectorUserCases
Request
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- findCaseById: Finds the case that matches the specified case identifier. Finder Variables:
- inputCaseId; string; The identifier of the case.
- simpleSearchFinder: Finds the case that matches the specified search criteria. Finder Variables:
- value; string; Finds the case that matches the specified search value.
- PrimaryKey: Finds the case that matches the specified search criteria. Finder Variables:
- CaseKey; integer; The unique identifier of the case.
- findCaseById: Finds the case that matches the specified case identifier. Finder Variables:
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2 -
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Response
Supported Media Types
- application/vnd.oracle.adf.resourcecollection+json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorUserCases
Type:
Show Source
object
-
count(optional):
integer
Title:
Count
The number of resource instances returned in the current range. -
hasMore(optional):
boolean
Title:
HasMore
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false. -
items(optional):
array Items
Title:
Items
The items in the collection. -
limit(optional):
integer
Title:
Limit
The actual paging size used by the server. -
links(optional):
array Items
Title:
Items
The link relations associated with the resource instance. -
offset(optional):
integer
Title:
Offset
The offset value used in the current page.
Nested Schema : Items
Type:
array
Title:
Items
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorUserCases-item
Type:
Show Source
object
-
AllowCaseAppeals(optional):
array Allow Case Appeals
Title:
Allow Case Appeals
The user case resource is used to view a case that has been claimed by a user. -
AppealCreationDate(optional):
string(date-time)
Title:
Appeal Requested On
The date when an appeal for the case was submitted. -
AppealHearingDate(optional):
string(date-time)
Title:
Hearing Scheduled For
The date when the hearing for the appeal is scheduled. -
CaseId(optional):
string
Title:
Case ID
Maximum Length:50
The identifier of the case. -
CaseKey(optional):
integer(int64)
The unique identifier of the case.
-
CitationCount(optional):
integer(int32)
The number of citations issued for the case.
-
CodeOfficerDisplayName(optional):
string
Title:
Code Officer
Maximum Length:255
The name of the code officer assigned to the case. -
CodeOfficerPhoneNumber(optional):
string
Title:
Code Officer Phone Number
Maximum Length:255
The phone number of the code officer assigned to the case. -
ComplianceDueDate(optional):
string(date)
Title:
Compliance Date
The compliance date of the case. -
CurrencyCode(optional):
string
Maximum Length:
255
The currency code associated with the fees for the case. -
EarliestDueAmount(optional):
number
The fee amount that is due on the earliest due date for the case.
-
EarliestDueDate(optional):
string(date)
Title:
Due On
The earliest date for which fees are due for the case. -
IssueDescription(optional):
string
Title:
Issue Description
Maximum Length:1000
The description of the issue. -
IssueSubtype(optional):
string
Title:
Issue Subtype
Maximum Length:100
The name of the issue subtype associated with the case. -
IssueType(optional):
string
Title:
Issue Type
Maximum Length:100
The name of the issue type associated with the case. -
links(optional):
array Items
Title:
Items
Link Relations -
PropertyAddress1(optional):
string
Title:
Address Line 1
Maximum Length:240
The first line of the property address of the case. -
PropertyAddress2(optional):
string
Title:
Address Line 2
Maximum Length:240
The second line of the property address of the case. -
PropertyAddress3(optional):
string
Title:
Address Line 3
Maximum Length:240
The third line of the property address of the case. -
PropertyAddress4(optional):
string
Title:
Address Line 4
Maximum Length:240
The fourth line of the property address of the case. -
PropertyCity(optional):
string
Title:
City
Maximum Length:60
The city 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. -
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
Title:
State Name
Maximum Length:60
The state of the property address of the case. -
Status(optional):
string
Title:
Case Status
Maximum Length:15
The status of the case. -
StatusName(optional):
string
Title:
Status
Maximum Length:30
The name of the status of the case. -
SubmitDate(optional):
string(date-time)
Title:
Submitted On
The date when the case was submitted. -
TotalCaseFees(optional):
number
Total fees to be paid for the case.
-
UserNotices(optional):
array User Notices
Title:
User Notices
The user case resource is used to view a case that has been claimed by a user.
Nested Schema : Allow Case Appeals
Type:
array
Title:
Allow Case Appeals
The user case resource is used to view a case that has been claimed by a user.
Show Source
Nested Schema : User Notices
Type:
array
Title:
User Notices
The user case resource is used to view a case that has been claimed by a user.
Show Source
Nested Schema : publicSectorUserCases-AllowCaseAppeals-item
Type:
Show Source
object
-
AppealDueDate(optional):
string(date-time)
Title:
Appeal By
The last date by which a user can submit an appeal for the case. -
CaseKey(optional):
integer(int64)
The unique identifier of the case.
-
IsAppealAllowed(optional):
boolean
Indicates whether appeal is allowed.
-
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 : publicSectorUserCases-UserNotices-item
Type:
Show Source
object
-
CaseKey(optional):
integer(int64)
The unique identifier of the case associated with the case notice.
-
CaseNoticeId(optional):
string
Title:
Notice ID
Maximum Length:50
The identifier of the case notice. -
CaseNoticeKey(optional):
integer(int64)
The unique identifier of the case notice.
-
GeneratedDate(optional):
string(date-time)
The date of generation of the case notice.
-
links(optional):
array Items
Title:
Items
Link Relations