Get a case notice
get
/fscmRestApi/resources/11.13.18.05/publicSectorCaseNotices/{CaseNoticeKey}
Request
Path Parameters
-
CaseNoticeKey: integer
The unique identifier of the case notice.
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 : publicSectorCaseNotices-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The agency identifier of the case notice.
-
AttachmentExistsFlag(optional):
boolean
Title:
Attachment
The switch to indicate if an attachment exists for the case notice. -
CaseKey(optional):
integer(int64)
The unique identifier of the case.
-
CaseNoticeId(optional):
string
Title:
Notice ID
Maximum Length:50
The unique identifier of the case notice. -
CaseNoticeKey(optional):
integer(int64)
The unique identifier of the case notice.
-
CaseStatus(optional):
string
Title:
Case Status
Maximum Length:15
The status of the case when the notice was generated. -
Comments(optional):
string
Title:
Comments
Maximum Length:1000
The comments included for the case notice. -
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. -
GeneratedDate(optional):
string(date-time)
The date on which the case notice was generated.
-
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 -
MailingCostAmount(optional):
number
Title:
Mailing Cost
The mailing cost of the case notice. -
MailingCostCurrencyCode(optional):
string
Title:
Currency
Maximum Length:3
The currency code associated with the mailing cost of the case notice. -
NoticeBipTemplateId(optional):
string
Title:
Report ID
Maximum Length:32
The report definition of the case notice. -
NoticeSource(optional):
string
Maximum Length:
15
The source of the case notice. -
NoticeStatus(optional):
string
Title:
Status
Maximum Length:15
The status of the case notice. -
NoticeTypeCode(optional):
string
Maximum Length:
100
The notice type code of the case notice. -
NoticeTypeName(optional):
string
Title:
Notice
Maximum Length:200
The name of the notice type. -
ReceivedDate(optional):
string(date-time)
Title:
Received Date
The date on which the case notice was received. -
Sequence(optional):
integer(int32)
The sequence of the case notice.
-
ShippedBy(optional):
string
Title:
Carrier Name
Maximum Length:500
The name of the shipping carrier that is delivering the case notice. -
ShippedDate(optional):
string(date-time)
Title:
Sent Date
The date on which the case notice was shipped. -
TrackingId(optional):
string
Title:
Tracking Number
Maximum Length:500
The tracking identifier of the shipping carrier for the case notice.
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.