Jump to

• Request
• Response

Create a case notice

post

/fscmRestApi/resources/11.13.18.05/publicSectorCaseNotices

Request

Header Parameters

• Metadata-Context: string
  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: string
  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: string
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The user defined category of an ad hoc notice.",
            "nullable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency identifier of the case notice.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "NoticeTypeCode":{
            "maxLength":100,
            "type":"string",
            "description":"The notice type code of the case notice.",
            "nullable":false
        },
        "ShippedDate":{
            "title":"Sent Date",
            "type":"string",
            "description":"The date on which the case notice was shipped.",
            "format":"date-time",
            "nullable":true
        },
        "CasePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case record.",
            "nullable":false
        },
        "MailingCostAmount":{
            "title":"Mailing Cost",
            "type":"number",
            "description":"The mailing cost of the case notice.",
            "nullable":true
        },
        "FeeRecordPuid":{
            "type":"string",
            "description":"The public unique identifier of the migrated case fee record associated with the case notice.",
            "nullable":true
        },
        "MailingCostCurrencyCode":{
            "title":"Currency",
            "maxLength":3,
            "type":"string",
            "description":"The currency code associated with the mailing cost of the case notice.",
            "nullable":true
        },
        "FunctionalStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The user defined case status name that maps to a delivered system status.",
            "nullable":true
        },
        "CaseKey":{
            "type":"integer",
            "description":"The unique identifier of the case.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":1000,
            "type":"string",
            "description":"The comments included for the case notice.",
            "nullable":true
        },
        "OutputFormat":{
            "maxLength":20,
            "type":"string",
            "description":"The output format of the notice generated.",
            "nullable":false,
            "default":"ORA_PDF"
        },
        "CaseNoticePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case notice record.",
            "nullable":false
        },
        "CodeReferenceCount":{
            "type":"integer",
            "description":"The number of code references added to the case notice.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":5
            }
        },
        "Sequence":{
            "title":"Count",
            "type":"integer",
            "description":"The sequence of the case notice.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":5
            }
        },
        "TrackingId":{
            "title":"Tracking Number",
            "maxLength":500,
            "type":"string",
            "description":"The tracking identifier of the shipping carrier for the case notice.",
            "nullable":true
        },
        "NoticeSource":{
            "title":"Type",
            "maxLength":15,
            "type":"string",
            "description":"The source of the case notice.",
            "nullable":false,
            "default":"ORA_ADHOC"
        },
        "ReceivedDate":{
            "title":"Received Date",
            "type":"string",
            "description":"The date on which the case notice was received.",
            "format":"date-time",
            "nullable":true
        },
        "NoticeStatus":{
            "title":"Status",
            "maxLength":15,
            "type":"string",
            "description":"The status of the case notice.",
            "nullable":false,
            "default":"ORA_PEND"
        },
        "CaseStatus":{
            "title":"Case Status",
            "maxLength":15,
            "type":"string",
            "description":"The status of the case when the notice was generated.",
            "nullable":false
        },
        "CaseNoticeId":{
            "title":"Notice ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the case notice.",
            "nullable":false
        },
        "GeneratedDate":{
            "title":"Generated Date",
            "type":"string",
            "description":"The date on which the case notice was generated.",
            "format":"date-time",
            "nullable":true
        },
        "FeeRecordKey":{
            "type":"integer",
            "description":"The unique identifier of the fee record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ShippedBy":{
            "title":"Carrier Name",
            "maxLength":500,
            "type":"string",
            "description":"The name of the shipping carrier that is delivering the case notice.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : publicSectorCaseNotices-item-response

Type: object

Show Source

• 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.
• HasReleaseAccess: boolean
  Read Only: true

  Maximum Length: 1

  Indicates that user is able to release the case notice.
• HasUpdateAccess: boolean
  Read Only: true

  Maximum Length: 1

  Indicates that user has update access for the case notice.
• 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.

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The user defined category of an ad hoc notice.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Notice Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency identifier of the case notice.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "NoticeTypeCode":{
            "maxLength":100,
            "type":"string",
            "description":"The notice type code of the case notice.",
            "nullable":false,
            "x-queryable":true
        },
        "ShippedDate":{
            "title":"Sent Date",
            "type":"string",
            "description":"The date on which the case notice was shipped.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "HasUpdateAccess":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that user has update access for the case notice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CasePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case record.",
            "nullable":false,
            "x-queryable":true
        },
        "MailingCostAmount":{
            "title":"Mailing Cost",
            "type":"number",
            "description":"The mailing cost of the case notice.",
            "nullable":true,
            "x-queryable":true
        },
        "FeeRecordPuid":{
            "type":"string",
            "description":"The public unique identifier of the migrated case fee record associated with the case notice.",
            "nullable":true,
            "x-queryable":true
        },
        "MailingCostCurrencyCode":{
            "title":"Currency",
            "maxLength":3,
            "type":"string",
            "description":"The currency code associated with the mailing cost of the case notice.",
            "nullable":true,
            "x-queryable":true
        },
        "NoticeBipTemplateId":{
            "title":"Report Mapping",
            "maxLength":32,
            "type":"string",
            "description":"The report definition of the case notice.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CaseNoticeKey":{
            "type":"integer",
            "description":"The unique identifier of the case notice.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedByName":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CaseStatusName":{
            "title":"Case Status",
            "maxLength":255,
            "type":"string",
            "description":"The case status description when the notice was created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NoticeTypeName":{
            "title":"Notice",
            "maxLength":200,
            "type":"string",
            "description":"The name of the notice type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FunctionalStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The user defined case status name that maps to a delivered system status.",
            "nullable":true,
            "x-queryable":true
        },
        "AttachmentCount":{
            "title":"Attachment",
            "type":"integer",
            "description":"The number of attachments added to the case notice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CaseKey":{
            "type":"integer",
            "description":"The unique identifier of the case.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":1000,
            "type":"string",
            "description":"The comments included for the case notice.",
            "nullable":true,
            "x-queryable":true
        },
        "OutputFormat":{
            "maxLength":20,
            "type":"string",
            "description":"The output format of the notice generated.",
            "nullable":false,
            "default":"ORA_PDF",
            "x-queryable":true
        },
        "CaseNoticePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case notice record.",
            "nullable":false,
            "x-queryable":true
        },
        "CodeReferenceCount":{
            "type":"integer",
            "description":"The number of code references added to the case notice.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "Sequence":{
            "title":"Count",
            "type":"integer",
            "description":"The sequence of the case notice.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "TrackingId":{
            "title":"Tracking Number",
            "maxLength":500,
            "type":"string",
            "description":"The tracking identifier of the shipping carrier for the case notice.",
            "nullable":true,
            "x-queryable":true
        },
        "NoticeSource":{
            "title":"Type",
            "maxLength":15,
            "type":"string",
            "description":"The source of the case notice.",
            "nullable":false,
            "default":"ORA_ADHOC",
            "x-queryable":true
        },
        "ReceivedDate":{
            "title":"Received Date",
            "type":"string",
            "description":"The date on which the case notice was received.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "HasReleaseAccess":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that user is able to release the case notice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NoticeStatus":{
            "title":"Status",
            "maxLength":15,
            "type":"string",
            "description":"The status of the case notice.",
            "nullable":false,
            "default":"ORA_PEND",
            "x-queryable":true
        },
        "CaseStatus":{
            "title":"Case Status",
            "maxLength":15,
            "type":"string",
            "description":"The status of the case when the notice was generated.",
            "nullable":false,
            "x-queryable":true
        },
        "CaseNoticeId":{
            "title":"Notice ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the case notice.",
            "nullable":false,
            "x-queryable":true
        },
        "GeneratedDate":{
            "title":"Generated Date",
            "type":"string",
            "description":"The date on which the case notice was generated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "FeeRecordKey":{
            "type":"integer",
            "description":"The unique identifier of the fee record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShippedBy":{
            "title":"Carrier Name",
            "maxLength":500,
            "type":"string",
            "description":"The name of the shipping carrier that is delivering the case notice.",
            "nullable":true,
            "x-queryable":true
        },
        "AttachmentExistsFlag":{
            "title":"Attachment",
            "maxLength":255,
            "type":"boolean",
            "description":"The switch to indicate if an attachment exists for the case notice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top