Get a case
get
/fscmRestApi/resources/11.13.18.05/publicSectorCaseTransactionLists/{CaseKey}
Request
Path Parameters
-
CaseKey: integer
The unique identifier for a 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 : publicSectorCaseTransactionLists-item
Type:
Show Source
object
-
Address1(optional):
string
Maximum Length:
240
The first or main address. -
Address2(optional):
string
Maximum Length:
240
The second address, if present. -
Address3(optional):
string
Maximum Length:
240
The third address, if present. -
Address4(optional):
string
Maximum Length:
240
The fourth address, if present. -
CaseId(optional):
string
Maximum Length:
50
The unique ID for a case. This identifier is automatically generated based on the rules configured for the issue subtype. -
CaseKey(optional):
integer(int64)
The unique identifier for a case.
-
CasePuid(optional):
string
Maximum Length:
480
The unique public identifier of the migrated case. -
City(optional):
string
Maximum Length:
60
The city in the parcel address. -
IssueDescription(optional):
string
Maximum Length:
1000
The detailed description of the issue for which the case has been logged. -
IssueSubtype(optional):
string
Maximum Length:
100
The user-friendly name for the issue subtype. -
IssueSubtypeCode(optional):
string
Maximum Length:
40
The code for an issue subtype. -
IssueSubtypeId(optional):
string
Maximum Length:
50
The unique identifier for an issue subtype. -
LastUpdateDate(optional):
string(date-time)
The date on which the case was last updated.
-
links(optional):
array Items
Title:
Items
Link Relations -
ParcelIdEntered(optional):
string
Maximum Length:
30
The parcel ID of the case. -
State(optional):
string
Maximum Length:
60
The state in the parcel address. -
Status(optional):
string
Maximum Length:
15
The system status of the case. -
StatusName(optional):
string
Maximum Length:
30
The user-friendly name of a case status. -
SubmitDate(optional):
string(date-time)
The date on which the case was submitted.
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.