Jump to

• Request
• Response

Get all case notices

get

/fscmRestApi/resources/11.13.18.05/publicSectorCaseNotices

Request

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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds the case notice that matches the specified search criteria. Finder Variables:
    • CaseNoticeKey; integer; The unique identifier of the case notice.
  • CaseNoticePuidKey: Finds the case notice that matches the specified alternate key.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Back to Top

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorCaseNotices

Type: object

Show Source

• count(optional): integer
  Title: Count

  The number of resource instances returned in the current range.
• hasMore(optional): boolean
  Title: HasMore

  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items(optional): array Items
  Title: Items

  The items in the collection.
• limit(optional): integer
  Title: Limit

  The actual paging size used by the server.
• links(optional): array Items
  Title: Items

  The link relations associated with the resource instance.
• offset(optional): integer
  Title: Offset

  The offset value used in the current page.

{
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.",
            "title":"HasMore"
        },
        "items":{
            "items":{
                "$ref":"#/definitions/publicSectorCaseNotices-item"
            },
            "type":"array",
            "description":"The items in the collection.",
            "title":"Items"
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server.",
            "title":"Limit"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "title":"Items"
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page.",
            "title":"Offset"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorCaseNotices-item

{
    "items":{
        "$ref":"#/definitions/publicSectorCaseNotices-item"
    },
    "type":"array",
    "description":"The items in the collection.",
    "title":"Items"
}

Nested Schema : Items

Type: array

Title: Items

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested 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