Create a case notice
post
/fscmRestApi/resources/11.13.18.05/publicSectorCaseNotices
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The agency identifier of the case notice. -
CaseKey: integer
(int64)
The unique identifier of the case.
-
CaseNoticeId: string
Title:
Notice ID
Maximum Length:50
The unique identifier of the case notice. -
CaseNoticePuid: string
Maximum Length:
480
The public unique identifier of the migrated case notice record. -
CasePuid: string
Maximum Length:
480
The public unique identifier of the migrated case record. -
CaseStatus: string
Title:
Case Status
Maximum Length:15
The status of the case when the notice was generated. -
CategoryCode: string
Title:
Category
Maximum Length:30
The user defined category of an ad hoc notice. -
CodeReferenceCount: integer
(int32)
Default Value:
0
The number of code references added to the case notice. -
Comments: string
Title:
Comments
Maximum Length:1000
The comments included for the case notice. -
FeeRecordKey: integer
(int64)
The unique identifier of the fee record.
-
FeeRecordPuid: string
The public unique identifier of the migrated case fee record associated with the case notice.
-
FunctionalStatus: string
Maximum Length:
15
The user defined case status name that maps to a delivered system status. -
GeneratedDate: string
(date-time)
Title:
Generated Date
The date on which the case notice was generated. -
MailingCostAmount: number
Title:
Mailing Cost
The mailing cost of the case notice. -
MailingCostCurrencyCode: string
Title:
Currency
Maximum Length:3
The currency code associated with the mailing cost of the case notice. -
NoticeSource: string
Title:
Type
Maximum Length:15
Default Value:ORA_ADHOC
The source of the case notice. -
NoticeStatus: string
Title:
Status
Maximum Length:15
Default Value:ORA_PEND
The status of the case notice. -
NoticeTypeCode: string
Maximum Length:
100
The notice type code of the case notice. -
OutputFormat: string
Maximum Length:
20
Default Value:ORA_PDF
The output format of the notice generated. -
ReceivedDate: string
(date-time)
Title:
Received Date
The date on which the case notice was received. -
Sequence: integer
(int32)
Title:
Count
Default Value:0
The sequence of the case notice. -
ShippedBy: string
Title:
Carrier Name
Maximum Length:500
The name of the shipping carrier that is delivering the case notice. -
ShippedDate: string
(date-time)
Title:
Sent Date
The date on which the case notice was shipped. -
TrackingId: string
Title:
Tracking Number
Maximum Length:500
The tracking identifier of the shipping carrier for the case notice.
Response
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 : publicSectorCaseNotices-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The agency identifier of the case notice. -
AttachmentCount: integer
Title:
Attachment
Read Only:true
The number of attachments added to the case notice. -
AttachmentExistsFlag: boolean
Title:
Attachment
Read Only:true
Maximum Length:255
The switch to indicate if an attachment exists for the case notice. -
CaseKey: integer
(int64)
The unique identifier of the case.
-
CaseNoticeId: string
Title:
Notice ID
Maximum Length:50
The unique identifier of the case notice. -
CaseNoticeKey: integer
(int64)
Read Only:
true
The unique identifier of the case notice. -
CaseNoticePuid: string
Maximum Length:
480
The public unique identifier of the migrated case notice record. -
CasePuid: string
Maximum Length:
480
The public unique identifier of the migrated case record. -
CaseStatus: string
Title:
Case Status
Maximum Length:15
The status of the case when the notice was generated. -
CaseStatusName: string
Title:
Case Status
Read Only:true
Maximum Length:255
The case status description when the notice was created. -
CategoryCode: string
Title:
Category
Maximum Length:30
The user defined category of an ad hoc notice. -
CodeReferenceCount: integer
(int32)
Default Value:
0
The number of code references added to the case notice. -
Comments: string
Title:
Comments
Maximum Length:1000
The comments included for the case notice. -
CreationDate: string
(date-time)
Title:
Notice Creation Date
Read Only:true
The date and time when the row was created. -
FeeRecordKey: integer
(int64)
The unique identifier of the fee record.
-
FeeRecordPuid: string
The public unique identifier of the migrated case fee record associated with the case notice.
-
FunctionalStatus: string
Maximum Length:
15
The user defined case status name that maps to a delivered system status. -
GeneratedDate: string
(date-time)
Title:
Generated Date
The date on which the case notice was generated. -
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. -
MailingCostAmount: number
Title:
Mailing Cost
The mailing cost of the case notice. -
MailingCostCurrencyCode: string
Title:
Currency
Maximum Length:3
The currency code associated with the mailing cost of the case notice. -
NoticeBipTemplateId: string
Title:
Report Mapping
Read Only:true
Maximum Length:32
The report definition of the case notice. -
NoticeSource: string
Title:
Type
Maximum Length:15
Default Value:ORA_ADHOC
The source of the case notice. -
NoticeStatus: string
Title:
Status
Maximum Length:15
Default Value:ORA_PEND
The status of the case notice. -
NoticeTypeCode: string
Maximum Length:
100
The notice type code of the case notice. -
NoticeTypeName: string
Title:
Notice
Read Only:true
Maximum Length:200
The name of the notice type. -
OutputFormat: string
Maximum Length:
20
Default Value:ORA_PDF
The output format of the notice generated. -
ReceivedDate: string
(date-time)
Title:
Received Date
The date on which the case notice was received. -
Sequence: integer
(int32)
Title:
Count
Default Value:0
The sequence of the case notice. -
ShippedBy: string
Title:
Carrier Name
Maximum Length:500
The name of the shipping carrier that is delivering the case notice. -
ShippedDate: string
(date-time)
Title:
Sent Date
The date on which the case notice was shipped. -
TrackingId: string
Title:
Tracking Number
Maximum Length:500
The tracking identifier of the shipping carrier for the case notice.
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.