Jump to

• Request
• Response

Create a case notice

post

/fscmRestApi/resources/11.13.18.05/publicSectorCaseNotices

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorCaseNotices-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The agency identifier of the case notice.
• AttachmentCount(optional): integer(int32)
  Title: Attachment

  The number of attachments added to 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.
• CaseNoticePuid(optional): string
  Maximum Length: 480

  The public unique identifier of the migrated case notice record.
• CasePuid(optional): string
  Maximum Length: 480

  The public unique identifier of the migrated case record.
• CaseStatus(optional): string
  Title: Case Status

  Maximum Length: 15

  The status of the case when the notice was generated.
• CaseStatusName(optional): string
  Title: Case Status

  Maximum Length: 255

  The case status description when the notice was created.
• 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)
  Title: Generated Date

  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 Mapping

  Maximum Length: 32

  The report definition of the case notice.
• NoticeSource(optional): string
  Title: Type

  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.
• OutputFormat(optional): string
  Maximum Length: 20

  The output format of the notice generated.
• 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.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the case notice.",
            "title":"Agency ID"
        },
        "AttachmentCount":{
            "format":"int32",
            "type":"integer",
            "description":"The number of attachments added to the case notice.",
            "title":"Attachment"
        },
        "AttachmentExistsFlag":{
            "type":"boolean",
            "description":"The switch to indicate if an attachment exists for the case notice.",
            "title":"Attachment"
        },
        "CaseKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case."
        },
        "CaseNoticeId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the case notice.",
            "title":"Notice ID"
        },
        "CaseNoticeKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case notice."
        },
        "CaseNoticePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case notice record."
        },
        "CasePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case record."
        },
        "CaseStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The status of the case when the notice was generated.",
            "title":"Case Status"
        },
        "CaseStatusName":{
            "maxLength":255,
            "type":"string",
            "description":"The case status description when the notice was created.",
            "title":"Case Status"
        },
        "Comments":{
            "maxLength":1000,
            "type":"string",
            "description":"The comments included for the case notice.",
            "title":"Comments"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "GeneratedDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the case notice was generated.",
            "title":"Generated Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "MailingCostAmount":{
            "type":"number",
            "description":"The mailing cost of the case notice.",
            "title":"Mailing Cost"
        },
        "MailingCostCurrencyCode":{
            "maxLength":3,
            "type":"string",
            "description":"The currency code associated with the mailing cost of the case notice.",
            "title":"Currency"
        },
        "NoticeBipTemplateId":{
            "maxLength":32,
            "type":"string",
            "description":"The report definition of the case notice.",
            "title":"Report Mapping"
        },
        "NoticeSource":{
            "maxLength":15,
            "type":"string",
            "description":"The source of the case notice.",
            "title":"Type"
        },
        "NoticeStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The status of the case notice.",
            "title":"Status"
        },
        "NoticeTypeCode":{
            "maxLength":100,
            "type":"string",
            "description":"The notice type code of the case notice."
        },
        "NoticeTypeName":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the notice type.",
            "title":"Notice"
        },
        "OutputFormat":{
            "maxLength":20,
            "type":"string",
            "description":"The output format of the notice generated."
        },
        "ReceivedDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the case notice was received.",
            "title":"Received Date"
        },
        "Sequence":{
            "format":"int32",
            "type":"integer",
            "description":"The sequence of the case notice."
        },
        "ShippedBy":{
            "maxLength":500,
            "type":"string",
            "description":"The name of the shipping carrier that is delivering the case notice.",
            "title":"Carrier Name"
        },
        "ShippedDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the case notice was shipped.",
            "title":"Sent Date"
        },
        "TrackingId":{
            "maxLength":500,
            "type":"string",
            "description":"The tracking identifier of the shipping carrier for the case notice.",
            "title":"Tracking Number"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorCaseNotices-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The agency identifier of the case notice.
• AttachmentCount(optional): integer(int32)
  Title: Attachment

  The number of attachments added to 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.
• CaseNoticePuid(optional): string
  Maximum Length: 480

  The public unique identifier of the migrated case notice record.
• CasePuid(optional): string
  Maximum Length: 480

  The public unique identifier of the migrated case record.
• CaseStatus(optional): string
  Title: Case Status

  Maximum Length: 15

  The status of the case when the notice was generated.
• CaseStatusName(optional): string
  Title: Case Status

  Maximum Length: 255

  The case status description when the notice was created.
• 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)
  Title: Generated Date

  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 Mapping

  Maximum Length: 32

  The report definition of the case notice.
• NoticeSource(optional): string
  Title: Type

  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.
• OutputFormat(optional): string
  Maximum Length: 20

  The output format of the notice generated.
• 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.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the case notice.",
            "title":"Agency ID"
        },
        "AttachmentCount":{
            "format":"int32",
            "type":"integer",
            "description":"The number of attachments added to the case notice.",
            "title":"Attachment"
        },
        "AttachmentExistsFlag":{
            "type":"boolean",
            "description":"The switch to indicate if an attachment exists for the case notice.",
            "title":"Attachment"
        },
        "CaseKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case."
        },
        "CaseNoticeId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the case notice.",
            "title":"Notice ID"
        },
        "CaseNoticeKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case notice."
        },
        "CaseNoticePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case notice record."
        },
        "CasePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case record."
        },
        "CaseStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The status of the case when the notice was generated.",
            "title":"Case Status"
        },
        "CaseStatusName":{
            "maxLength":255,
            "type":"string",
            "description":"The case status description when the notice was created.",
            "title":"Case Status"
        },
        "Comments":{
            "maxLength":1000,
            "type":"string",
            "description":"The comments included for the case notice.",
            "title":"Comments"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "GeneratedDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the case notice was generated.",
            "title":"Generated Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "MailingCostAmount":{
            "type":"number",
            "description":"The mailing cost of the case notice.",
            "title":"Mailing Cost"
        },
        "MailingCostCurrencyCode":{
            "maxLength":3,
            "type":"string",
            "description":"The currency code associated with the mailing cost of the case notice.",
            "title":"Currency"
        },
        "NoticeBipTemplateId":{
            "maxLength":32,
            "type":"string",
            "description":"The report definition of the case notice.",
            "title":"Report Mapping"
        },
        "NoticeSource":{
            "maxLength":15,
            "type":"string",
            "description":"The source of the case notice.",
            "title":"Type"
        },
        "NoticeStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The status of the case notice.",
            "title":"Status"
        },
        "NoticeTypeCode":{
            "maxLength":100,
            "type":"string",
            "description":"The notice type code of the case notice."
        },
        "NoticeTypeName":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the notice type.",
            "title":"Notice"
        },
        "OutputFormat":{
            "maxLength":20,
            "type":"string",
            "description":"The output format of the notice generated."
        },
        "ReceivedDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the case notice was received.",
            "title":"Received Date"
        },
        "Sequence":{
            "format":"int32",
            "type":"integer",
            "description":"The sequence of the case notice."
        },
        "ShippedBy":{
            "maxLength":500,
            "type":"string",
            "description":"The name of the shipping carrier that is delivering the case notice.",
            "title":"Carrier Name"
        },
        "ShippedDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the case notice was shipped.",
            "title":"Sent Date"
        },
        "TrackingId":{
            "maxLength":500,
            "type":"string",
            "description":"The tracking identifier of the shipping carrier for the case notice.",
            "title":"Tracking Number"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top