1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Cases

Get all cases

get

/crmRestApi/resources/11.13.18.05/cases

Request

Query Parameters
  • 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).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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
  • 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:

    • CaseByCaseNumber: Finds a case with the specified case number.
      Finder Variables:
      • CaseNumber; string; The alternate key identifier of the case.
    • CaseListMyCaseTeamCasesFinder: Find all the cases assigned to my team.
      Finder Variables:
      • CasesCreatedByMeFinder: Find all the cases created by me.
        Finder Variables:
        • MyCasesByStatusFinder: Finds all the cases assigned to me.
          Finder Variables:
          • StatusCd; string; Finds all the cases assigned to me and are of a particular status. For example, ORA_SVC_NEW or ORA_SVC_REOPENED.
        • MyCasesFinder: Find all the cases assigned to me.
          Finder Variables:
          • PrimaryKey: Finds a case with the specified primary key.
            Finder Variables:
            • CaseId; integer; The unique identifier of the case.
        • 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.
        • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

          Example:
          self,canonical
        • 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.
        • The resource item payload will be filtered in order to contain only data (no links section, for example).
        • This parameter orders a resource collection based on the specified fields. 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
        • 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

          You can use these queryable attributes to filter this collection resource using the q query parameter:
          • AllegationCd; string; The allegation code of a case.
          • AllegationCdMeaning; string; Indicates the display value corresponding to the allegation code for a case.
          • ArbitrationRequiredFlag; boolean; Indicates whether arbitration is required.
          • AssigneePartyName; string; The name of the party associated with the case assignee.
          • AssigneePartyNumber; string; The alternate key identifier of the case assignee.
          • AssigneeResourceId; integer; The unique identifier of the resource assigned to the case. For example, a support engineer.
          • BUOrgId; integer; The unique identifier of the business unit name associated with the case.
          • BusinessUnitName; string; The name of the business unit associated with the case.
          • CaseCategoryId; integer; The unique identifier of the case category.
          • CaseCreatedBy; string; The user who created the case.
          • CaseCreationDate; string; The date and time when the case was created.
          • CaseId; integer; The unique identifier of the case.
          • CaseLastUpdateDate; string; The date and time when the case was last updated.
          • CaseLastUpdateLogin; string; The login details of the user who last updated the case.
          • CaseLastUpdatedBy; string; The user who last updated the case.
          • CaseNumber; string; The alternate key identifier of the case.
          • CaseTypeCd; string; The lookup code that indicates the type of case.
          • CaseTypeCdMeaning; string; The display value corresponding to the case type lookup code for the case.
          • CategoryName; string; The name of the category associated with the case.
          • ClosedDate; string; The date when the case was closed.
          • ComplaintTypeCd; string; The complaint type code of a case.
          • ComplaintTypeCdMeaning; string; Indicates the display value corresponding to the complaint type code for a case.
          • ContributingFactorsCd; string; The contributing factors codes of a case.
          • ContributingFactorsCdMeanings; string; Indicates the display values corresponding to the contributing factors codes for a case.
          • CreatedBy; string; The user who created the case.
          • CreatedByPartyId; integer; The unique identifier of the user who created the case in the system.
          • CreatedByPartyName; string; The party name of the user who created the case in the system.
          • CreatedByPartyNumber; string; The alternate key identifier of the user who created the case in the system.
          • CreationDate; string; The date and time when the case was created.
          • Description; string; A brief description of the case.
          • FiledByTypeCd; string; The filed by type code of a case.
          • FiledByTypeCdMeaning; string; Indicates the display value corresponding to the filed by type code for a case.
          • IncidentOccurrenceDate; string; The date and time when the incident occurred.
          • IncidentTypeCd; string; The incident type code of a case.
          • IncidentTypeCdMeaning; string; Indicates the display value corresponding to the incident type code for a case.
          • IsolatedIncidentFlag; boolean; Indicates whether the incident is isolated.
          • LastClosedDate; string; The date when the case was last closed.
          • LastReopenDate; string; The date when the case was last reopened.
          • LastResolvedDate; string; The date and time when the case was last resolved.
          • LastUpdateDate; string; The date and time when the case was last updated.
          • LastUpdatedBy; string; The user who last updated the case.
          • LastUpdatedByPartyId; integer; The unique identifier of the party of the user who last updated the case.
          • LastUpdatedByPartyName; string; The party name of the user who last updated the case.
          • LastUpdatedByPartyNumber; string; The alternate key identifier of the user who last updated the case.
          • MeasuresTakenCd; string; The measures taken code of a case.
          • MeasuresTakenCdMeanings; string; Indicates the display values corresponding to the measures taken codes for a case.
          • OpenDate; string; The date when the case was opened, in case the case is approved.
          • PolicyViolatedFlag; boolean; Indicates whether the policy is violated.
          • PrimaryContactPartyId; integer; The unique identifier of the primary contact for the case.
          • PrimaryContactPartyName; string; The name of the primary contact party.
          • PrimaryContactPartyNumber; string; The alternate key identifier of the primary contact party.
          • PrimaryHouseholdPartyId; integer; The unique identifier of the primary household for the case.
          • PrimaryHouseholdPartyName; string; The name of the primary household party.
          • PrimaryHouseholdPartyNumber; string; The alternate key identifier of the primary household party.
          • PriorityCd; string; The code indicating the priority of the case. For example, ORA_SVC_HIGH, ORA_SVC_LOW, or ORA_SVC_MEDIUM.
          • PriorityCdMeaning; string; The display value corresponding to the priority lookup code for the case.
          • QueueId; integer; The unique identifier of the queue that the case is assigned to.
          • QueueName; string; The name of the queue associated with the case.
          • QueueNumber; string; The alternate key identifier of the queue associated with the case.
          • ReportedByPartyId; integer; The unique identifier of the person who reported the case.
          • ReportedByPartyName; string; The party name of the person who reported the case.
          • ReportedByPartyNumber; string; The alternate key identifier of the person who reported the case.
          • ResolutionCd; string; The resolution code of a case.
          • ResolutionCdMeaning; string; Indicates the display value corresponding to the resolution lookup code for a case.
          • ResolveDescription; string; The description of how a case has been resolved.
          • ResolveOutcomeCd; string; The resolution outcome code of a case.
          • ResolveOutcomeCdMeaning; string; Indicates the display value corresponding to the resolution outcome lookup code for a case.
          • ResolvedBy; string; The user who resolved a case.
          • ResolvedByPartyId; integer; The unique identification of the user who resolved the case.
          • ReviewedByCd; string; The reviewed by code of a case.
          • ReviewedByCdMeanings; string; Indicates the display value corresponding to the reviewed by code for a case.
          • SensitivityCd; string; The code indicating the sensitivity of the case record from the security point of view. For example, ORA_SVC_CONFIDENTIAL, when security is required to control access to a case record, or ORA_SVC_NORMAL, when no special security is required to control access to case record.
          • SensitivityCdMeaning; string; The display value corresponding to the sensitivity lookup code for the case.
          • SettlementAmount; number; Indicates the amount required in settlement of a case.
          • SettlementRequiredFlag; boolean; Indicates whether the settlement is required.
          • SettlementSummary; string; The description of how a case was settled.
          • SourceCd; string; The code indicating how the case was created or entered into the system. For example, ORA_SVC_API, ORA_SVC_AGENT_UI, or ORA_SVC_MOBILE.
          • SourceCdMeaning; string; The display value corresponding to the source lookup code for the case.
          • SpecialistRequiredFlag; boolean; Indicates whether a specialist is required.
          • StatusCd; string; The code indicating the status of the case. Such as, ORA_SVC_CANCELED, ORA_SVC_CLOSED, ORA_SVC_REOPENED, ORA_SVC_ELIGIBILITY_END, ORA_SVC_INCOMPLETE, ORA_SVC_NEW, ORA_SVC_SUSPENDED, or ORA_SVC_WITHDRAWN.
          • StatusCdMeaning; string; The display value corresponding to the status lookup code for the case.
          • StatusTypeCd; string; The code indicating the status type of the case. Such as, ORA_SVC_ACTIVE, when a case is assigned to a case worker and is being actively worked on, ORA_SVC_CLOSED, when a case is closed, ORA_SVC_INACTIVE, when a case is not being worked on, ORA_SVC_RESOLVED, when a case is resolved, ORA_SVC_SUSPENDED. when a case is suspended or paused due to lack of data.
          • StatusTypeCdMeaning; string; The display value corresponding to the status type lookup code for the case.
          • StripeCd; string; The stripe code for the case.
          • Title; string; The title of the case.
        • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
        Header Parameters
        • 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".
        • 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.

        There's no request body for this operation.

        Back to Top

        Response

        Supported Media Types

        Default Response

        The following table describes the default response for this task.
        Headers
        • 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".
        • 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 : cases
        Type: object
        Show Source
        Nested Schema : Items
        Type: array
        Title: Items
        The items in the collection.
        Show Source
        Nested Schema : cases-item-response
        Type: object
        Show Source
        • Title: Allegation
          Maximum Length: 30
          The allegation code of a case.
        • Title: Allegation Code Value
          Read Only: true
          Maximum Length: 255
          Indicates the display value corresponding to the allegation code for a case.
        • Title: Arbitration Required
          Maximum Length: 1
          Indicates whether arbitration is required.
        • Title: Assignee Party Name
          Maximum Length: 360
          The name of the party associated with the case assignee.
        • Title: Assignee Party Number
          Read Only: true
          Maximum Length: 30
          The alternate key identifier of the case assignee.
        • Title: Assignee Resource ID
          The unique identifier of the resource assigned to the case. For example, a support engineer.
        • Attachments
          Title: Attachments
          The attachments resource is used to view, create, update, and delete an attachment.
        • Title: Business Unit ID
          The unique identifier of the business unit name associated with the case.
        • Title: Business Unit Name
          Maximum Length: 240
          The name of the business unit associated with the case.
        • Title: Case Category ID
          The unique identifier of the case category.
        • Case Contacts
          Title: Case Contacts
          The case contacts resource is used to view, create, update, and delete many-to-many relationships between cases and associated contacts.
        • Title: Case Created By
          Maximum Length: 64
          The user who created the case.
        • Title: Case Creation Date
          The date and time when the case was created.
        • Case Households
          Title: Case Households
          The case households resource is used to view, create, update, and delete many-to-many relationships between cases and associated households.
        • Title: Case ID
          Read Only: true
          The unique identifier of the case.
        • Title: Case Last Update Date
          The date and time when the case was last updated.
        • Title: Case Last Updated By
          Maximum Length: 64
          The user who last updated the case.
        • Title: Case Last Update Login
          Maximum Length: 32
          The login details of the user who last updated the case.
        • Case Messages
          Title: Case Messages
          The case messages resource is used to view, create, update, and delete information about every communication update associated with the case.
        • Title: Case Number
          Maximum Length: 30
          The alternate key identifier of the case.
        • Case Opportunities
          Title: Case Opportunities
          The opportunities resources indicates the one-to-many relationships between the case and associated opportunities.
        • Case Resources
          Title: Case Resources
          Case resources is used to view, create, update, and delete many-to-many relationships between cases and associated resources.
        • Title: Case Type Code
          Maximum Length: 30
          The lookup code that indicates the type of case.
        • Title: Case Type Value
          Maximum Length: 255
          The display value corresponding to the case type lookup code for the case.
        • Title: Category Name
          Maximum Length: 400
          The name of the category associated with the case.
        • Title: Closed Date
          The date when the case was closed.
        • Title: Complaint Type
          Maximum Length: 30
          The complaint type code of a case.
        • Title: Complaint Type Code Value
          Read Only: true
          Maximum Length: 255
          Indicates the display value corresponding to the complaint type code for a case.
        • Title: Contributing Factors
          Maximum Length: 2000
          The contributing factors codes of a case.
        • Title: Contributing Factors Codes Values
          Read Only: true
          Maximum Length: 3000
          Indicates the display values corresponding to the contributing factors codes for a case.
        • Title: Corporate Currency Code
          Maximum Length: 15
          The corporate currency code of the case. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
        • Title: Created By
          Read Only: true
          Maximum Length: 64
          The user who created the case.
        • Title: Created by Party ID
          The unique identifier of the user who created the case in the system.
        • Title: Created by Party Name
          Read Only: true
          Maximum Length: 360
          The party name of the user who created the case in the system.
        • Title: Created by Party Number
          Read Only: true
          Maximum Length: 30
          The alternate key identifier of the user who created the case in the system.
        • Title: Creation Date
          Read Only: true
          The date and time when the case was created.
        • Title: Currency Rate
          Maximum Length: 30
          The currency conversion rate type associated with the case. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
        • Title: Currency Code
          Maximum Length: 15
          The currency code associated with the case. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
        • Title: Delete
          Read Only: true
          Indicates whether the case can be deleted.
        • Title: Description
          Maximum Length: 1000
          A brief description of the case.
        • Title: Filed by Type
          Maximum Length: 30
          The filed by type code of a case.
        • Title: Filed by Type Code Value
          Read Only: true
          Maximum Length: 255
          Indicates the display value corresponding to the filed by type code for a case.
        • Title: Incident Occurrence Date
          The date and time when the incident occurred.
        • Title: Incident Type
          Maximum Length: 30
          The incident type code of a case.
        • Title: Incident Type Code Value
          Read Only: true
          Maximum Length: 255
          Indicates the display value corresponding to the incident type code for a case.
        • Title: Isolated Incident
          Maximum Length: 1
          Indicates whether the incident is isolated.
        • Title: Last Closed Date
          The date when the case was last closed.
        • Title: Last Reopen Date
          The date when the case was last reopened.
        • Title: Last Resolved Date
          The date and time when the case was last resolved.
        • Title: Last Updated Date
          Read Only: true
          The date and time when the case was last updated.
        • Title: Last Updated By
          Read Only: true
          Maximum Length: 64
          The user who last updated the case.
        • Title: Last Updated by Party
          The unique identifier of the party of the user who last updated the case.
        • Title: Last Updated by Party Name
          Read Only: true
          Maximum Length: 360
          The party name of the user who last updated the case.
        • Title: Last Updated by Party Number
          Read Only: true
          Maximum Length: 30
          The alternate key identifier of the user who last updated the case.
        • Title: Last Update Login
          Read Only: true
          Maximum Length: 32
          The login of the user who last updated the case.
        • Links
        • Title: Measures Taken
          Maximum Length: 2000
          The measures taken code of a case.
        • Title: Measures Taken Codes Values
          Read Only: true
          Maximum Length: 3000
          Indicates the display values corresponding to the measures taken codes for a case.
        • Title: Open Date
          The date when the case was opened, in case the case is approved.
        • Title: Policy Violated
          Maximum Length: 1
          Indicates whether the policy is violated.
        • Title: Primary Contact Party ID
          The unique identifier of the primary contact for the case.
        • Title: Primary Contact Party Name
          Maximum Length: 360
          The name of the primary contact party.
        • Title: Primary Contact Party Number
          Read Only: true
          Maximum Length: 30
          The alternate key identifier of the primary contact party.
        • Title: Primary Household Party ID
          The unique identifier of the primary household for the case.
        • Title: Primary Household Party Name
          Maximum Length: 360
          The name of the primary household party.
        • Title: Primary Household Party Number
          Read Only: true
          Maximum Length: 30
          The alternate key identifier of the primary household party.
        • Title: Priority
          Maximum Length: 30
          The code indicating the priority of the case. For example, ORA_SVC_HIGH, ORA_SVC_LOW, or ORA_SVC_MEDIUM.
        • Title: Priority Value
          Maximum Length: 255
          The display value corresponding to the priority lookup code for the case.
        • Title: Queue ID
          The unique identifier of the queue that the case is assigned to.
        • Title: Queue
          Maximum Length: 400
          The name of the queue associated with the case.
        • Title: Queue Number
          Maximum Length: 30
          The alternate key identifier of the queue associated with the case.
        • Title: Reported by Party ID
          The unique identifier of the person who reported the case.
        • Title: Reported by Party Name
          Read Only: true
          Maximum Length: 360
          The party name of the person who reported the case.
        • Title: Reported by Party Number
          Read Only: true
          Maximum Length: 30
          The alternate key identifier of the person who reported the case.
        • Title: Resolution Code
          Maximum Length: 30
          The resolution code of a case.
        • Title: Resolution Code Value
          Read Only: true
          Maximum Length: 255
          Indicates the display value corresponding to the resolution lookup code for a case.
        • Title: Resolved By
          Maximum Length: 64
          The user who resolved a case.
        • Title: Resolved by Party ID
          The unique identification of the user who resolved the case.
        • Title: Resolution Description
          Maximum Length: 3000
          The description of how a case has been resolved.
        • Title: Resolution Outcome
          Maximum Length: 30
          The resolution outcome code of a case.
        • Title: Resolution Outcome Value
          Read Only: true
          Maximum Length: 255
          Indicates the display value corresponding to the resolution outcome lookup code for a case.
        • Title: Reviewed By
          Maximum Length: 2000
          The reviewed by code of a case.
        • Title: Reviewed by Code Value
          Read Only: true
          Maximum Length: 3000
          Indicates the display value corresponding to the reviewed by code for a case.
        • Title: Sensitivity
          Maximum Length: 30
          The code indicating the sensitivity of the case record from the security point of view. For example, ORA_SVC_CONFIDENTIAL, when security is required to control access to a case record, or ORA_SVC_NORMAL, when no special security is required to control access to case record.
        • Title: Sensitivity Value
          Maximum Length: 255
          The display value corresponding to the sensitivity lookup code for the case.
        • Title: Settlement Amount
          Indicates the amount required in settlement of a case.
        • Title: Settlement Required
          Maximum Length: 1
          Indicates whether the settlement is required.
        • Title: Settlement Summary
          Maximum Length: 3000
          The description of how a case was settled.
        • Smart Actions
          Title: Smart Actions
          The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
        • Title: Source
          Maximum Length: 30
          The code indicating how the case was created or entered into the system. For example, ORA_SVC_API, ORA_SVC_AGENT_UI, or ORA_SVC_MOBILE.
        • Title: Source Value
          Maximum Length: 255
          The display value corresponding to the source lookup code for the case.
        • Title: Specialist Required
          Maximum Length: 1
          Indicates whether a specialist is required.
        • Title: Status
          Maximum Length: 30
          The code indicating the status of the case. Such as, ORA_SVC_CANCELED, ORA_SVC_CLOSED, ORA_SVC_REOPENED, ORA_SVC_ELIGIBILITY_END, ORA_SVC_INCOMPLETE, ORA_SVC_NEW, ORA_SVC_SUSPENDED, or ORA_SVC_WITHDRAWN.
        • Title: Status Value
          Maximum Length: 255
          The display value corresponding to the status lookup code for the case.
        • Title: Status Type
          Maximum Length: 30
          Default Value: ORA_SVC_ACTIVE
          The code indicating the status type of the case. Such as, ORA_SVC_ACTIVE, when a case is assigned to a case worker and is being actively worked on, ORA_SVC_CLOSED, when a case is closed, ORA_SVC_INACTIVE, when a case is not being worked on, ORA_SVC_RESOLVED, when a case is resolved, ORA_SVC_SUSPENDED. when a case is suspended or paused due to lack of data.
        • Title: Status Type Value
          Maximum Length: 255
          The display value corresponding to the status type lookup code for the case.
        • Title: Stripe Code
          Maximum Length: 30
          The stripe code for the case.
        • Title: Title
          Maximum Length: 400
          The title of the case.
        • Title: Update
          Read Only: true
          Indicates whether the record can be updated.
        Nested Schema : Attachments
        Type: array
        Title: Attachments
        The attachments resource is used to view, create, update, and delete an attachment.
        Show Source
        Nested Schema : Case Contacts
        Type: array
        Title: Case Contacts
        The case contacts resource is used to view, create, update, and delete many-to-many relationships between cases and associated contacts.
        Show Source
        Nested Schema : Case Households
        Type: array
        Title: Case Households
        The case households resource is used to view, create, update, and delete many-to-many relationships between cases and associated households.
        Show Source
        Nested Schema : Case Messages
        Type: array
        Title: Case Messages
        The case messages resource is used to view, create, update, and delete information about every communication update associated with the case.
        Show Source
        Nested Schema : Case Opportunities
        Type: array
        Title: Case Opportunities
        The opportunities resources indicates the one-to-many relationships between the case and associated opportunities.
        Show Source
        Nested Schema : Case Resources
        Type: array
        Title: Case Resources
        Case resources is used to view, create, update, and delete many-to-many relationships between cases and associated resources.
        Show Source
        Nested Schema : Smart Actions
        Type: array
        Title: Smart Actions
        The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
        Show Source
        Nested Schema : cases-Attachments-item-response
        Type: object
        Show Source
        Nested Schema : Attachment Previews
        Type: array
        Title: Attachment Previews
        The attachments preview resource is used to preview the attachment pages.
        Show Source
        Nested Schema : cases-Attachments-AttachmentsPreview-item-response
        Type: object
        Show Source
        Nested Schema : cases-caseContacts-item-response
        Type: object
        Show Source
        • Title: Contact ID
          Read Only: true
          The unique identifier of the case contact.
        • Title: Case ID
          The unique identifier of the case.
        • Title: Case Number
          Maximum Length: 30
          The alternate key identifier of the case.
        • Title: Contact Party Number
          Read Only: true
          Maximum Length: 30
          The alternate key identifier of the contact party.
        • Title: Corporate Currency Code
          Maximum Length: 15
          The corporate currency code of the case contact. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
        • Title: Created By
          Read Only: true
          Maximum Length: 64
          The user who created the contact for the case.
        • Title: Creation Date
          Read Only: true
          The date and time when the case contact was created.
        • Title: Currency Conversion Rate Type
          Maximum Length: 30
          The currency conversion rate type associated with the case contact. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
        • Title: Currency Code
          Maximum Length: 15
          The currency code associated with the case contact. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
        • Title: Delete
          Read Only: true
          Indicates whether the case contact can be deleted.
        • Title: Email
          Read Only: true
          Maximum Length: 320
          The email address of the contact.
        • Title: Phone
          Read Only: true
          The phone number of the contact.
        • Title: Job Title
          Read Only: true
          Maximum Length: 100
          The job title of the contact.
        • Title: Last Updated Date
          Read Only: true
          The date and time when the contact for the case was last updated.
        • Title: Last Updated By
          Read Only: true
          Maximum Length: 64
          The user who last updated the contact for the case.
        • Title: Last Update Login
          Read Only: true
          Maximum Length: 32
          The login of the user who last updated the contact for the case.
        • Links
        • Title: Party ID
          The unique identifier of the party.
        • Title: Party Name
          Maximum Length: 360
          The name of the party.
        • Title: Person ID
          The unique identifier of a person who is an employee on the case.
        • Title: Primary Contact
          Read Only: true
          Indicates whether the contact is the primary contact for the case.
        • Title: Relationship Code
          Maximum Length: 30
          The code indicating the relation of the contact to the case. For example, ORA_SVC_BENEFICIARY, contact who is the beneficiary of the case, ORA_SVC_CHILD, contact who is a legal child of the applicant, ORA_SVC_DEPENDENT, contact is dependent on the applicant, ORA_SVC_GUARDIAN, contact is a legal guardian of the applicant, ORA_SVC_LAWYER, contact is an attorney by profession dealing with the case, ORA_SVC_PARENT, contact is the legal parent of the applicant, ORA_SVC_PERPETRATOR, contact who carries out a criminal, or harmful act, ORA_SVC_REFERRAL, contact who refers a service provider, ORA_SVC_REPORTER, contact who reports an incident, ORA_SVC_SERVICE_PROVIDER, contact or a business entity who is rendering specific services or benefits to the applicant, ORA_SVC_SIBLING, contact who is the legal sibling of the applicant, ORA_SVC_SPOUSE, contact who is a spouse of the applicant, or ORA_SVC_VICTIM, contact who is affected by an incident or an event,
        • Title: Relationship Value
          Maximum Length: 255
          The display value corresponding to the relationship lookup code for the case contact.
        • Title: Update
          Read Only: true
          Indicates whether the case contact can be updated.
        Nested Schema : cases-caseHouseholds-item-response
        Type: object
        Show Source
        • Title: Household ID
          Read Only: true
          The unique identifier of the case household.
        • Title: Case ID
          The unique identifier of the case.
        • Title: Case Number
          Maximum Length: 30
          The alternate key identifier of the case.
        • Title: Corporate Currency Code
          Maximum Length: 15
          The corporate currency code of the case household. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
        • Title: Created By
          Read Only: true
          Maximum Length: 64
          The user who created the household for the case.
        • Title: Creation Date
          Read Only: true
          The date and time when the case household was created.
        • Title: Currency Conversion Rate Type
          Maximum Length: 30
          The currency conversion rate type associated with the case household. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
        • Title: Currency Code
          Maximum Length: 15
          The currency code associated with the case household. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
        • Title: Delete
          Read Only: true
          Indicates whether the record can be deleted.
        • Title: Household Name
          Maximum Length: 360
          The name of the household.
        • Title: Household Party Number
          Read Only: true
          Maximum Length: 30
          The alternate key identifier of the household party.
        • Title: Last Updated Date
          Read Only: true
          The date and time when the household for the case was last updated.
        • Title: Last Updated By
          Read Only: true
          Maximum Length: 64
          The user who last updated the household for the case.
        • Title: Last Update Login
          Read Only: true
          Maximum Length: 32
          The login of the user who last updated the household for the case.
        • Links
        • Title: Party ID
          The unique identifier of the party.
        • Title: Primary Household
          Read Only: true
          Indicates whether the household is the primary household for the case.
        • Title: Update
          Read Only: true
          Indicates whether the record can be updated.
        Nested Schema : cases-caseMessages-item-response
        Type: object
        Show Source
        • Attachments
          Title: Attachments
          The attachments resource is used to view, create, update, and delete an attachment.
        • Title: Case ID
          The unique identifier of the case.
        • Title: Case Number
          Maximum Length: 30
          The alternate key identifier of the case.
        • Title: Content
          The content of the message that is not an attachment.
        • Title: Corporate Currency Code
          Maximum Length: 15
          The corporate currency code of the case message. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
        • Title: Created By
          Read Only: true
          Maximum Length: 64
          The user who created the message for the case.
        • Title: Creation Date
          Read Only: true
          The date and time when the case message was created.
        • Title: Currency Conversion Rate Type
          Maximum Length: 30
          The currency conversion rate type associated with the case message. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
        • Title: Currency Code
          Maximum Length: 15
          The currency code associated with the case message. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
        • Title: Delete
          Read Only: true
          Indicates whether the record can be deleted.
        • Title: Last Update Date
          The date when the case message was last edited.
        • Title: Last Updated Date
          Read Only: true
          The date and time when the message for the case was last updated.
        • Title: Last Updated By
          Read Only: true
          Maximum Length: 64
          The user who last updated the message for the case.
        • Title: Last Update Login
          Read Only: true
          Maximum Length: 32
          The login of the user who last updated the message for the case.
        • Links
        • Title: Message Created By
          Maximum Length: 64
          The user who created the case message.
        • Title: Message Creation Date
          The date and time when the case message was created.
        • Title: Message ID
          The unique identifier of the message.
        • Title: Message Last Update Date
          The date and time when the case message was last updated.
        • Title: Message Last Updated By
          Maximum Length: 64
          The user who last updated the case message.
        • Title: Message Last Update Login
          Maximum Length: 32
          The application login id of the user who last updated the case message.
        • Title: Message Number
          Maximum Length: 30
          The alternate key identifier of the message.
        • Title: Message Type
          Maximum Length: 30
          Default Value: ORA_SVC_NOTE
          The code indicating the type of the message, such as internal or external.
        • Title: Message Type Value
          Maximum Length: 255
          The display value corresponding to the message type lookup code for the case message.
        • Title: Origination Date
          The date when the message originated, or was posted.
        • Title: Parent Message
          The unique identifier of the parent message.
        • Title: Posting Party ID
          The unique identifier of the user party who posted the message.
        • Title: Posted by Party Name
          Read Only: true
          Maximum Length: 360
          The name of the party who posted the message.
        • Title: Posting Party Number
          Read Only: true
          Maximum Length: 30
          The alternate key identifier of the user party who posted the message.
        • Title: Rich Text Format
          Maximum Length: 1
          Default Value: true
          Indicates whether the message content is in rich text format The values are Y or N.
        • Title: Source
          Maximum Length: 30
          The code indicating how the message was entered into the system. For example, ORA_SVC_API, case message was created through REST API, ORA_SVC_AGENT_UI, case message was created in the UI), or ORA_SVC_MOBILE, case message was created through a mobile device.
        • Title: Source Value
          Maximum Length: 255
          The display value corresponding to the source lookup code for the case message.
        • Title: Status Code
          Maximum Length: 30
          Default Value: ORA_SVC_COMMITTED
          The code indicating the status of the message. For example, ORA_SVC_COMMITTED, indicates that the message is committed, or NULL.
        • Title: Status Value
          Maximum Length: 255
          The display value corresponding to the status lookup code for the case message.
        • Title: Update
          Read Only: true
          Indicates whether the record can be updated.
        • Title: Visibility
          Maximum Length: 30
          Default Value: ORA_SVC_INTERNAL
          The code indicating the visibility level of the case message. For example, ORA_SVC_EXTERNAL, case message is visible to internal and external users, or ORA_SVC_INTERNAL, case message is visible to internal users only.
        • Title: Visibility Value
          Maximum Length: 255
          The display value corresponding to the visibility lookup code for the case message.
        Nested Schema : Attachments
        Type: array
        Title: Attachments
        The attachments resource is used to view, create, update, and delete an attachment.
        Show Source
        Nested Schema : cases-caseMessages-Attachments-item-response
        Type: object
        Show Source
        Nested Schema : Attachment Previews
        Type: array
        Title: Attachment Previews
        The attachments preview resource is used to preview the attachment pages.
        Show Source
        Nested Schema : cases-caseMessages-Attachments-AttachmentsPreview-item-response
        Type: object
        Show Source
        Nested Schema : cases-caseOpportunities-item-response
        Type: object
        Show Source
        Nested Schema : cases-caseResources-item-response
        Type: object
        Show Source
        • Title: Case ID
          The unique identifier of the case.
        • Title: Case Number
          Maximum Length: 30
          The alternate key identifier of the case.
        • Title: Resource ID
          Read Only: true
          The unique identifier of the case resource.
        • Title: Corporate Currency Code
          Maximum Length: 15
          The corporate currency code of the case resource. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
        • Title: Created By
          Read Only: true
          Maximum Length: 64
          The user who created the resource for the case.
        • Title: Creation Date
          Read Only: true
          The date and time when the case resource was created.
        • Title: Currency Conversion Rate Type
          Maximum Length: 30
          The currency conversion rate type associated with the case resource. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
        • Title: Currency Code
          Maximum Length: 15
          The currency code associated with the case resource. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
        • Title: Delete
          Read Only: true
          Indicates whether the record can be deleted.
        • Title: Email
          Read Only: true
          Maximum Length: 320
          The email address of the contact who created the resource.
        • Title: Phone
          Read Only: true
          The phone number of the user who created the resource.
        • Title: Last Updated Date
          Read Only: true
          The date and time when the resource for the case was last updated.
        • Title: Last Updated By
          Read Only: true
          Maximum Length: 64
          The user who last updated the resource for the case.
        • Title: Last Update Login
          Read Only: true
          Maximum Length: 32
          The login session of the user who last updated the resource for the case.
        • Links
        • Title: Owner
          Read Only: true
          Indicates whether the resource is the owner of the case.
        • Title: Party ID
          The unique identifier of the party.
        • Title: Resource Name
          Maximum Length: 360
          The name of the resource.
        • Title: Party Number
          Read Only: true
          Maximum Length: 30
          The alternate key identifier of the party.
        • Title: Update
          Read Only: true
          Indicates whether the record can be updated.
        Nested Schema : cases-smartActions-item-response
        Type: object
        Show Source
        • Title: Action Intent
          JSON object that describes what an action does and what context data can be passed to the action.
        • Title: Confirmation Message
          Maximum Length: 4000
          A message to seek confirmation for the action being performed.
        • Title: Content Type
          Maximum Length: 50
          The content type to use when invoking the REST endpoint.
        • Title: Action Name
          Maximum Length: 256
          The consumer friendly action name.
        • Title: Parent Entity
          Maximum Length: 150
          The REST resources the Action belongs to.
        • Title: REST Endpoint
          Maximum Length: 1024
          The REST endpoint to perform the Action.
        • Title: Included in Application
          Maximum Length: 512
          The list of applications that this action can be used in.
        • Links
        • Title: Mass Action
          Maximum Length: 1
          Indicates whether the action can be mass processed.
        • Title: HTTP Method
          Maximum Length: 15
          The HTTP method of the smart action REST operation.
        • Title: Object Function
          Maximum Length: 64
          The object function associated with the smart action.
        • Title: Page Type
          Maximum Length: 256
          The Page Type.
        • Title: Smart Suggest
          Maximum Length: 1
          Indicates the smart suggest flag.
        • Title: System Action
          Maximum Length: 1
          Indicates whether the Action is seeded or custom.
        • Title: Attributes to Update
          Maximum Length: 512
          The attributes to be updated when the Actions UI is launched.
        • Title: User Action ID
          The unique identifier of the smart action definition.
        • Title: Action Name
          Maximum Length: 256
          The attribute uniquely identifies the action with name. For internal use.
        • User Interface Definitions
          Title: User Interface Definitions
          The user interface definitions resource is used to view user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
        • Title: Priority
          The number to indicate priority of the action.
        • Payload Definitions
          Title: Payload Definitions
          The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
        • Path Parameter Definitions
          Title: Path Parameter Definitions
          The path parameters definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
        Nested Schema : User Interface Definitions
        Type: array
        Title: User Interface Definitions
        The user interface definitions resource is used to view user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
        Show Source
        Nested Schema : Payload Definitions
        Type: array
        Title: Payload Definitions
        The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
        Show Source
        Nested Schema : Path Parameter Definitions
        Type: array
        Title: Path Parameter Definitions
        The path parameters definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
        Show Source
        Nested Schema : cases-smartActions-UserActionNavigation-item-response
        Type: object
        Show Source
        • Links
        • Title: System Action
          Maximum Length: 1
          Default Value: false
          Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
        • Title: Application Usage
          Maximum Length: 50
          The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
        • Title: Navigation Metadata
          Maximum Length: 1000
          The metadata definition of the smart action user interface endpoint.
        • Title: Primary Key
          The unique identifier of a smart action user interface definition.
        • Title: Navigation Type
          Maximum Length: 100
          The text value used by applications to determine which user interface to launch.
        Nested Schema : cases-smartActions-UserActionRequestPayload-item-response
        Type: object
        Show Source
        • Title: Payload Value Binding Type
          Maximum Length: 64
          The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
        • Links
        • Title: Mandatory
          Maximum Length: 1
          Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
        • The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
        • Title: Request Payload Attribute Name
          Maximum Length: 256
          The value assigned to the name property of a name-value pair.
        • Title: Smart Suggest Path
          Maximum Length: 2048
          The smart suggest path.
        • Title: System Action
          Maximum Length: 1
          Default Value: false
          Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
        • Title: Request Payload Attribute Value
          Maximum Length: 1000
          The value assigned to the value property of a name-value pair.
        • Title: Payload Value Structure
          Maximum Length: 20
          A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
        Nested Schema : cases-smartActions-UserActionURLBinding-item-response
        Type: object
        Show Source
        • Title: URL Binding Type
          Maximum Length: 64
          The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
        • Links
        • Title: System Action
          Maximum Length: 1
          Default Value: false
          Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
        • The unique identifier of a smart action REST path parameter name-value pair definition.
        • Title: URL Binding Parameter Name
          Maximum Length: 256
          The value assigned to the name property of a name-value pair.
        • Title: URL Binding Parameter Value
          Maximum Length: 1000
          The value assigned to the value property of a name-value pair.
        Links
        copyCaseAttachments
        This method lets you provide a list of attachments to be copied to a particular case. It will create new copy of each attachment.
        Back to Top

        Examples

        The following example shows how to get all cases by submitting a get request on the REST resource using cURL.

        cURL Command

        curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cases

        Example of Response Body

        The following shows an example of the response body in JSON format.

         {
    "items": [
        {
            "AssigneeResourceId": null,
            "BUOrgId": 204,
            "CaseCategoryId": null,
            "CaseCreatedBy": "AUTOUICASE1",
            "CaseCreationDate": "2021-08-25T23:47:35+00:00",
            "CaseId": 300100216949243,
            "CaseLastUpdateDate": "2021-08-25T23:47:35.001+00:00",
            "CaseLastUpdateLogin": "CA5FA16623618065E05323EAF40A8D90",
            "CaseLastUpdatedBy": "AUTOUICASE1",
            "CaseNumber": "CDRM_5003",
            "ClosedDate": null,
            "CorpCurrencyCode": null,
            "CreatedBy": "AUTOUICASE1",
            "CreatedByPartyId": 300100112109025,
            "CreationDate": "2021-08-25T23:47:35+00:00",
            "CurcyConvRateType": null,
            "CurrencyCode": null,
            "Description": null,
            "LastClosedDate": null,
            "LastReopenDate": null,
            "LastUpdateDate": "2021-08-25T23:47:53.735+00:00",
            "LastUpdateLogin": "CA5F9CD8F6178063E05323EAF40A4F68",
            "LastUpdatedBy": "AUTOUICASE1",
            "LastUpdatedByPartyId": 300100112109025,
            "OpenDate": "2021-08-25T23:47:36.181+00:00",
            "PrimaryContactPartyId": null,
            "PrimaryHouseholdPartyId": null,
            "PriorityCd": null,
            "QueueId": null,
            "ReportedByPartyId": 300100112109025,
            "SensitivityCd": null,
            "SourceCd": null,
            "StatusCd": "ORA_SVC_NEW",
            "StatusTypeCd": "ORA_SVC_ACTIVE",
            "StripeCd": "ORA_SVC_CRM",
            "Title": "JETAutoRestCase_202173_164725548",
            "AssigneePartyName": null,
            "AssigneePartyNumber": null,
            "BusinessUnitName": "Vision Operations",
            "CategoryName": null,
            "PrimaryContactPartyName": null,
            "PrimaryContactPartyNumber": null,
            "PrimaryHouseholdPartyName": null,
            "PrimaryHouseholdPartyNumber": null,
            "QueueName": null,
            "QueueNumber": null,
            "ReportedByPartyName": "AUTOUICASE1 svc",
            "ReportedByPartyNumber": "CDRM_674216",
            "LastUpdatedByPartyName": "AUTOUICASE1 svc",
            "LastUpdatedByPartyNumber": "CDRM_674216",
            "CreatedByPartyName": "AUTOUICASE1 svc",
            "CreatedByPartyNumber": "CDRM_674216",
            "DeleteFlag": true,
            "UpdateFlag": true,
            "StatusTypeCdMeaning": "Active",
            "PriorityCdMeaning": null,
            "SensitivityCdMeaning": null,
            "SourceCdMeaning": null,
            "StatusCdMeaning": "New",
            "CaseTypeCd": null,
            "CaseTypeCdMeaning": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_5003",
                    "name": "cases",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000678"
                    }
...
}
        Back to Top