Get all case appeals
get
/fscmRestApi/resources/11.13.18.05/publicSectorListCaseAppeals
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:- OpenAppealsFinder: Finds the open case appeal that matches the specified search criteria. Finder Variables:
- reviewerId; integer; The unique identifier of the code technician assigned to the case.
- searchValue; string; Finds the open case appeal that matches the specified search value.
- UnscheduledAppealsFinder: Finds the unscheduled case appeal that matches the specified search criteria. Finder Variables:
- reviewerId; integer; The unique identifier of the code technician assigned to the case.
- searchValue; string; Finds the unscheduled appeals that match the specified search value.
- ScheduledAppealsFinder: Finds the scheduled case appeal that matches the specified search criteria. Finder Variables:
- endDate; string; The end of the date range to find scheduled appeals.
- reviewerId; integer; The unique identifier of the code technician assigned to the case.
- searchValue; string; Finds the scheduled appeals that match the specified search value.
- startDate; string; The start of the date range to find scheduled appeals.
- PrimaryKey: Finds the case appeal that matches the specified search criteria. Finder Variables:
- CaseAppealKey; integer; The unique identifier of the case appeal.
- OpenAppealsFinder: Finds the open case appeal that matches the specified search criteria. 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 : publicSectorListCaseAppeals
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 : publicSectorListCaseAppeals-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The unique identifier of the agency of the case.
-
AppealReason(optional):
string
Title:
Appeal Reason
Maximum Length:1000
The reason for the case appeal. -
AppealSrc(optional):
string
Maximum Length:
10
The source of the appeal. Valid values are Hearings and Appeal. -
AppealSrcCode(optional):
string
Maximum Length:
255
The source of the appeal. Valid values are Hearings and Appeal. -
AppealStatus(optional):
string
Title:
Status
Maximum Length:15
The status of the case appeal. -
CaseAppealKey(optional):
integer(int64)
The unique identifier of the case appeal.
-
CaseContactKey(optional):
integer(int64)
The unique identifier of the case contact.
-
CaseId(optional):
string
Title:
Case ID
Maximum Length:50
The unique identifier of the case. -
CaseKey(optional):
integer(int64)
The unique identifier of the case.
-
CaseStatus(optional):
string
Title:
Appeal Type
Maximum Length:15
The status of the case. -
ContactAddress1(optional):
string
Maximum Length:
240
The first line for the address of the appellant of the case. -
ContactAddress2(optional):
string
Maximum Length:
240
The second line for the address of the address of the appellant of the case. -
ContactAddress3(optional):
string
Maximum Length:
240
The third line for the address of the appellant of the case. -
ContactAddress4(optional):
string
Maximum Length:
240
The fourth line for the address of the appellant of the case. -
ContactCity(optional):
string
Maximum Length:
60
The city of the address of the appellant of the case. -
ContactCountry(optional):
string
Maximum Length:
3
The country of the address of the appellant of the case. -
ContactCounty(optional):
string
Maximum Length:
60
The county of the address of the appellant of the case. -
ContactPersonFirstName(optional):
string
Title:
First Name
Maximum Length:150
The first name of the appellant. -
ContactPersonLastName(optional):
string
Title:
Last Name
Maximum Length:150
The last name of the appellant. -
ContactPostalCode(optional):
string
Maximum Length:
60
The postal code of the address of the appellant of the case. -
ContactPostalPlusCode(optional):
string
Maximum Length:
10
The postal plus code of the address of the appellant of the case. -
ContactPrimaryFlag(optional):
boolean
Title:
Primary
The switch to indicate that the appellant is the primary contact of the case. -
ContactProvince(optional):
string
Maximum Length:
60
The province of the address of the appellant of the case. -
ContactState(optional):
string
Maximum Length:
60
The state of the address of the appellant of the case. -
ContactType(optional):
string
Title:
Type
Maximum Length:15
The type of contact through which the appellant is associated with the case. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The name of the user who created the row. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the row was created. -
DecisionDate(optional):
string(date-time)
Title:
Decision Date
The hearing decision date for the case appeal. -
Description(optional):
string
The description of the issue subtype.
-
HearingBodyCode(optional):
string
Maximum Length:
60
The unique identifier for the Hearing Body. -
HearingDate(optional):
string(date-time)
Title:
Hearing Date
The hearing date for the case appeal. -
HearingDecision(optional):
string
Title:
Hearing Decision
Maximum Length:15
The hearing decision from the case appeal. -
HrgBodyCode(optional):
string
Maximum Length:
255
The name of the hearing body. -
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. -
IssueTypeId(optional):
string
Maximum Length:
50
The unique identifier of the issue type of the case. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the row was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The name of the user who last updated the row. -
links(optional):
array Items
Title:
Items
Link Relations -
PropertyAddress1(optional):
string
Title:
Address Line 1
Maximum Length:240
The first line for the property address of the case. -
PropertyAddress2(optional):
string
Title:
Address Line 2
Maximum Length:240
The second line for the property address of the case. -
PropertyAddress3(optional):
string
Title:
Address Line 3
Maximum Length:240
The third line for the property address of the case. -
PropertyAddress4(optional):
string
Title:
Address Line 4
Maximum Length:240
The fourth line for the property address of the case. -
PropertyAddressId(optional):
integer(int64)
The unique identifier of the property address of the case.
-
PropertyCity(optional):
string
Title:
City
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
Title:
State Name
Maximum Length:60
The state of the property address of the case. -
RespContactKey(optional):
integer(int64)
The unique identifier of the responsible party for the hearing.
-
ResponsibleParty(optional):
string
Maximum Length:
255
The name of the responsible party of the hearing. -
ReviewerId(optional):
integer(int64)
Title:
Technician Assigned
The unique identifier of the code technician assigned to the case.
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.