1. REST API for Oracle CX Sales and B2B ServiceREST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Industry Solutions
  3. Financial Services
  4. Cases

Cases

The Case resource is used to track particular actions for a contact. A case assists customers with necessary financial transactions during life-changing events that require transfer or liquidation of assets.

Resource Plural Label

Cases

Resource Name

__ORAFS__Cases_c

On this page:

Get all Case Records

Request: GET

URI: crmRestApi/resources/11.13.18.05/__ORAFS__Cases_c

Request Path Parameters

There are no required path parameters for this task.

Request Query Parameters

Use the following finder parameters to query the resource:

Finder Name Description

Id

Finds case records by ID.

Finder Variables:
  • PrimaryKey
    • Type: Integer
    • Description: The unique identifier of the Case record.

Request Body

There are no elements in the request body for this task.

Response Body

Returns an array of Case resources.

The following table summarizes the supported response body content types:

Media Type

application/json

Media Type

application/vnd.oracle.adf.resourcecollection+json

Example

Gets all Case records.

Example Command: curl --user sales_cloud_user https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/__ORAFS__Cases_c

Example Response Body

{
"Id" : 300000000891235,
"RowType" : "__ORAFS__Cases_c",
"RecordName" : "CC-0000000006",
"CreatedBy" : "fusion",
"CreationDate" : "2015-05-27T07:31:02+00:00",
"LastUpdatedBy" : "SALES.MGR_US@ap6023fems.us.oraclecloud.com",
"LastUpdateDate" : "2015-07-15T09:08:42+00:00",
"LastUpdateLogin" : null,
"CpdrfVerSor" :null,
"UserLastUpdateDate" : null,
"CpdrfLastUpd" : null,
"CpdrfVerPillar" : null,
"JobDefinitionPackage" : null,
"RequestId" : null,
"JobDefinitionName" : null,
"CurrencyCode" : "USD",
"CurcyConvRateType" : "Corporate",
"CorpCurrencyCode" : "USD",
"SourceType" : "__ORAFS__CASES_C",
"AttachmentEntityName" : "__ORAFS__Cases_c",
"PKProxy" : "300000000891235",
"IsOwner" : "false",
"__ORAFS__PrimaryContact_Id_c" : 300000000839149,
"__ORAFS__PrimaryCon
tact_c" : "Simoneta Aamos",
"__ORAFS__DateOfBirth_c" : "2015-06-02",
"__ORAFS__DateOfDeath_c" : "2015-06-02",
"__ORAFS__Owner_Id_c" : null,
"__ORAFS__Owner_c" : null,
"__ORAFS__Status_c" : "ORA_AFS_IN_PROCESS",
"__ORAFS__Type_c" : "ORA_AFS_LOAN",
"__ORAFS__TotalAssets_c" : 12052,
"__ORAFS__Currency_c" : null,
"__ORAFS__Extn__ORAFS__Cases_cFuseCreateLayoutURL" : "/cust/apps/__extension__/__ORAFS__Cases_c/__ORAFS__Cases_cFuseCreate/__ORAFS__Cases_cFuseCreate_Layout4.jsff",
"__ORAFS__Extn__ORAFS__Cases_cFuseCreateLayoutDrivers" : "__ORAFS__Type_c",
"__ORAFS__Extn__ORAFS__Cases_cFuseDetailLayoutURL" : "/cust/apps/__extension__/__ORAFS__Cases_c/__ORAFS__Cases_cFuseDetail/__ORAFS__Cases_cFuseDetail_Layout3.jsff",
"__ORAFS__Extn__ORAFS__Cases_cFuseDetailLayoutDrivers" : "null",
"__ORAFS__PrimaryHeir_Id_c" : 300000000839108,
"__ORAFS__PrimaryHeir_c" : "Ray Aamos",
"Extn__ORAFS__Cases_cFuseCreate__ORAFS__Layout1Expr" : "true",
"__ORAFS__LoanApplicationName_Id_c" : 300000000932570,
"__ORAFS__LoanApplicationName_c" : "Mgr Opty",
"Extn__ORAFS__Cases_cFuseDetail__ORAFS__Layout1Expr" : "true",
"Extn__ORAFS__Cases_cFuseCreateLayoutURL" : "/cust/apps/__extension__/__ORAFS__Cases_c/__ORAFS__Cases_cFuseCreate/__ORAFS__Cases_cFuseCreate_Layout4.jsff",
"Extn__ORAFS__Cases_cFuseCreateLayoutDrivers" : null,
"Extn__ORAFS__Cases_cFuseDetailLayoutURL" : "/cust/apps/__extension__/__ORAFS__Cases_c/__ORAFS__Cases_cFuseDetail/__ORAFS__Cases_cFuseDetail_Layout3.jsff",
"Extn__ORAFS__Cases_cFuseDetailLayoutDrivers" : null,
"Extn__ORAFS__Cases_cFuseCreateLayout3Expr" : "false",
"Extn__ORAFS__Cases_cFuseDetailLayout4Expr" : "false",
"links" : [ {
...
}]
}

Create a Case

Request: POST

URI: crmRestApi/resources/11.13.18.05/__ORAFS__Cases_c

Request Path Parameters

There are no required path parameters for this task.

Request Body

Accepts a Case resource item.

Media Type

application/vnd.oracle.adf.resourcecollection+json

Response Body

Returns a Case resource item.

The following table summarizes the supported response body content types:

Media Type

application/vnd.oracle.adf.resourcecollection+json

Example

Creates a new Case record.

Example Command: curl --user sales_cloud_user https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/__ORAFS__Cases_c

Get a Case

Request: GET

URI: crmRestApi/resources/11.13.18.05/__ORAFS__Cases_c/<Replace with system generated unique ID>

Request Path Parameters

The following are required path parameters for this task:

Name Type Description

Id

Integer

The unique identifier of the Case record.

Request Body

There are no elements in the request body for this task.

Response Body

Returns a Case resource item.

The following table summarizes the supported response body content types:

Media Type

application/json

Media Type

application/vnd.oracle.adf.resourceitem+json

Example

Gets a Case record.

Example Command: curl --user sales_cloud_user https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/__ORAFS__Cases_c/30000000089311.12.1.02

Update a Case

Request: PATCH

URI: crmRestApi/resources/11.13.18.05/__ORAFS__Cases_c/< Replace with system generated unique ID>

Request Path Parameters

The following are the required path parameters for this task:

Name Type Description

Id

Integer

The unique identifier of the Case record.

Request Body

Accepts a Case resource item.

Media Type

application/vnd.oracle.adf.resourceitem+json

Response Body

Returns a Case resource item.

The following table summarizes the supported response body content types:

Media Type

application/vnd.oracle.adf.resourceitem+json

Example

Updates an existing Case record.

Example Command: curl --user sales_cloud_user https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/__ORAFS__Cases_c/30000000089311.12.1.02

Delete a Case

Request: DELETE

URI: crmRestApi/resources/11.13.18.05/__ORAFS__Cases_c/< Replace with system generated unique ID>

Request Path Parameters

The following are the required path parameters for this task:

Name Type Description

Id

Integer

The unique identifier of the Case record.

Request Body

There are no elements in the request body for this task.

Response Body

There are no elements in the response body for this task.

Example

Deletes an existing Case record.

Example Command: curl --user sales_cloud_user https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/__ORAFS__Cases_c/30000000089311.12.1.02

List of Values

This resource defines the following list of values (LOV):

LOV Name Source Attribute in LOV Target Attribute in Resource

ViewAccessor_CurrencyCode

CurrencyCode

Currency Code

FK_LOVVA_For___ORAFS__PrimaryContact_c

__ORAFS__PrimaryContact_Id_c

Contact

LOVVA_For___ORAFS__PrimaryContact_c

__ORAFS__PrimaryContact_c

Contact

FK_LOVVA_For___ORAFS__Owner_c

__ORAFS__Owner_Id_c

Owner

LOVVA_For___ORAFS__Owner_c

__ORAFS__Owner_c

Owner

LOVVA_For___ORAFS__Status_c

__ORAFS__Status_c

Status

LOVVA_For___ORAFS__Type_c

__ORAFS__Type_c

Type

FK_LOVVA_For___ORAFS__PrimaryHeir_c

__ORAFS__PrimaryHeir_Id_c

Primary Heir

LOVVA_For___ORAFS__PrimaryHeir_c

__ORAFS__PrimaryHeir_c

Primary Heir

Resource Attributes

This resource has the following attributes:

Attribute Name Attribute Type Description

Id

integer

The unique identifier of the Case record.

UI Label

Record ID

RowType

string

The name of the Case object. In this case __ORAFS__Cases_c.

Properties

The maximum length is 80.

RecordName

string

An autogenerated unique identifier for the Case record. This field is unique for each Case.

Properties

The maximum length is 80.

UI Label

Case ID

CreatedBy

string

The user who created the Case record.

Properties

The maximum length is 32.

UI Label

Created By

CreationDate

string

The date and time when the Case record was created.

UI Label

Creation Date

LastUpdatedBy

string

The user who last updated the Case record.

Properties

The maximum length is 32.

UI Label

Last Updated By

LastUpdateDate

string

The date and time when the Case record was last updated.

UI Label

Last Update Date

LastUpdateLogin

string

The login details of the user who last updated the record.

Properties

The maximum length is 32.

CurrencyCode

string

The currency code associated with the Case.

Properties

The maximum length is 15.

UI Label

Currency Code

SourceType

string

The name of the the Case object. In this case __ORAFS__Cases_c.

__ORAFS__PrimaryContact_Id_c

integer

The unique identifier of the contact selected in the Contact field in the Case record.

UI Label

Contact

__ORAFS__PrimaryContact_c

string

The name of the contact selected in the Contact field in the Case record.

Properties

The maximum length is 1500.

UI Label

Contact

__ORAFS__DateOfBirth_c

string

The date when the contact was born to be entered in the Case record.

UI Label

Date of Birth

__ORAFS__DateOfDeath_c

string

The date when the person died to be entered in the Case record.

UI Label

Date of Death

__ORAFS__Description_c

attachment

The description of the Case.

Properties

The maximum length is 32714.

UI Label

Description

__ORAFS__Owner_Id_c

integer

The unique identifier of the Case owner.

UI Label

Owner

__ORAFS__Owner_c

string

The name of the Case owner.

Properties

The maximum length is 1500.

UI Label

Owner

__ORAFS__Status_c

string

The status of the Case. A list of accepted values is defined in the lookup type ORA_AFS_SUCC_CASE_STATUS.

Properties

The maximum length is 1500.

UI Label

Status

__ORAFS__Type_c

string

The type of the Case. A list of accepted values is defined in the lookup type ORA_AFS_SUCC_CASE_TYPE.

Properties

The maximum length is 1500.

UI Label

Type

__ORAFS__TotalAssets_c

integer

The auto-calculated total assets of the contact selected in the Contact field in the Case record.

UI Label

Total Assets

__ORAFS__Currency_c

integer

The Currency field in the Case record.

UI Label

Currency

__ORAFS__PrimaryHeir_Id_c

Integer

The unique identifier of the contact selected in the Primary Heir field in the Case record.

UI Label

Primary Heir

__ORAFS__PrimaryHeir_c

string

The name of the contact selected in the Primary Heir field in the Case record.

Properties

The maximum length is 1500.

UI Label

Primary Heir