Get all case appeals
get
/fscmRestApi/resources/11.13.18.05/publicSectorCaseAppeals
Request
Query Parameters
-
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 fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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:- CaseAppealPuidKey: Finds the case appeal that matches the specified alternate key.
Finder Variables:- CaseAppealPuid; string; The public unique identifier of the migrated case appeal record.
- PrimaryKey: Finds the case appeal that matches the specified search criteria.
Finder Variables:- CaseAppealKey; integer; The unique identifier of the case appeal.
- CaseAppealPuidKey: Finds the case appeal that matches the specified alternate key.
-
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.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
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 fields. 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
You can use these queryable attributes to filter this collection resource using the q query parameter:- AppealReason; string; The reason for the case appeal.
- AppealSrc; string; The source of the transaction such as Appeal or Hearing.
- AppealStatus; string; The status of the case appeal.
- CaseAppealKey; integer; The unique identifier of the case appeal.
- CaseAppealPuid; string; The public unique identifier of the migrated case appeal record.
- CaseCompliedOn; string; The date on which the case met all requirements for compliance.
- CaseContactKey; integer; The unique identifier of the case contact.
- CaseContactPuid; string; The public unique identifier of the migrated case contact record.
- CaseKey; integer; The unique identifier of the case.
- CasePuid; string; The public unique identifier of the migrated case record.
- CaseStatus; string; The status of the case.
- Comments; string; The comments for the case appeal.
- ComplianceDueDate; string; The compliance date of the case.
- CreationDate; string; The date and time when the row was created.
- DecisionDate; string; The hearing decision date for the case appeal.
- EventDecision; string; The system defined status of the hearing decision.
- GenCitFlag; string; Identifies if a citation should be issued.
- GenVioFlag; string; Identifies if a notice of violation should be issued.
- HearingDate; string; The hearing date for the case appeal.
- HearingDecision; string; The hearing decision from the case appeal.
- HrgBodyCode; string; The identifier of the hearing body configured in the system.
- HrgDecisionCode; string; The user defined status of the hearing decision.
- HrgPurposeCode; string; The user defined purpose for the hearing related to the case appeal.
- LastUpdateDate; string; The date and time when the row was last updated.
- LastUpdatedByName; string; The name of the user who last updated the row.
- PersonFirstName; string; The first name of the appellant.
- PersonLastName; string; The last name of the appellant.
- RespContactKey; integer; The identifier of the person responsible for the appeal or hearing that is being processed.
- UpdateCodeReferenceFlag; string; Identifies if a code violation should be updated.
-
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".
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : publicSectorCaseAppeals
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
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: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorCaseAppeals-item-response
Type:
Show Source
object
-
AppealReason: string
Title:
Appeal Reason
Maximum Length:1000
The reason for the case appeal. -
AppealSrc: string
Maximum Length:
10
Default Value:ORA_APL
The source of the transaction such as Appeal or Hearing. -
AppealStatus: string
Title:
Hearing Status
Maximum Length:15
Default Value:ORA_UNSHCD
The status of the case appeal. -
CaseAppealKey: integer
(int64)
The unique identifier of the case appeal.
-
CaseAppealPuid: string
Maximum Length:
480
The public unique identifier of the migrated case appeal record. -
CaseComplianceDueDate: string
Title:
New Compliance Due Date
The case compliance due date. -
CaseCompliedOn: string
(date)
The date on which the case met all requirements for compliance.
-
CaseContactKey: integer
(int64)
The unique identifier of the case contact.
-
CaseContactPuid: string
The public unique identifier of the migrated case contact record.
-
CaseFunctionalStatus: string
Title:
Case Status
The user defined case status name that maps to a delivered system status. -
CaseKey: integer
(int64)
The unique identifier of the case.
-
CasePuid: string
Maximum Length:
480
The public unique identifier of the migrated case record. -
CaseStatus: string
Title:
Appeal Type
Maximum Length:15
The status of the case. -
CitationDueDate: string
(date)
Title:
New Citation Due Date
The citation due date. -
Comments: string
Title:
Comments
Maximum Length:1000
The comments for the case appeal. -
ComplianceDueDate: string
(date)
Read Only:
true
The compliance date of the case. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
DecisionDate: string
(date-time)
Title:
Decision Date
The hearing decision date for the case appeal. -
EventDecision: string
Read Only:
true
Maximum Length:15
The system defined status of the hearing decision. -
GenCitFlag: string
Maximum Length:
1
Default Value:N
Identifies if a citation should be issued. -
GenVioFlag: string
Maximum Length:
1
Default Value:N
Identifies if a notice of violation should be issued. -
HearingDate: string
(date-time)
Title:
Hearing Date
The hearing date for the case appeal. -
HearingDecision: string
Title:
Hearing Decision
Maximum Length:15
The hearing decision from the case appeal. -
HrgBodyCode: string
Maximum Length:
60
The identifier of the hearing body configured in the system. -
HrgDecisionCode: string
Maximum Length:
15
The user defined status of the hearing decision. -
HrgPurposeCode: string
Maximum Length:
15
The user defined purpose for the hearing related to the case appeal. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the row was last updated. -
LastUpdatedByName: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The name of the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonFirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
The first name of the appellant. -
PersonLastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
The last name of the appellant. -
RespContactKey: integer
(int64)
The identifier of the person responsible for the appeal or hearing that is being processed.
-
UpdateCodeReferenceFlag: string
Maximum Length:
1
Default Value:N
Identifies if a code violation should be updated.
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.