REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience

Update a case resource

patch

/crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseResources/{CaseResourceId}

Request

Path Parameters

CaseNumber(required): string

The alternate key identifier of the case.
CaseResourceId(required): integer(int64)

The unique identifier of the case resource.

Header Parameters

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.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

CorpCurrencyCode: string

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.
CurcyConvRateType: string

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.
CurrencyCode: string

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.
PartyId: integer (int64)

Title: Party ID

The unique identifier of the party.
ResourceName: string

Title: Resource Name

Maximum Length: 360

The name of the resource.

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "ResourceName":{
            "title":"Resource Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the resource.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        }
    }
}

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.

Root Schema : cases-caseResources-item-response

Type: object

Show Source

CaseId: integer (int64)

Title: Case ID

The unique identifier of the case.
CaseNumber: string

Title: Case Number

Maximum Length: 30

The alternate key identifier of the case.
CaseResourceId: integer (int64)

Title: Resource ID

Read Only: true

The unique identifier of the case resource.
CorpCurrencyCode: string

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.
CreatedBy: string

Title: Created By

Read Only: true

Maximum Length: 64

The user who created the resource for the case.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

The date and time when the case resource was created.
CurcyConvRateType: string

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.
CurrencyCode: string

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.
DeleteFlag: boolean

Title: Delete

Read Only: true

Indicates whether the record can be deleted.
EmailAddress: string

Title: Email

Read Only: true

Maximum Length: 320

The email address of the contact who created the resource.
FormattedPhoneNumber: string

Title: Phone

Read Only: true

The phone number of the user who created the resource.
LastUpdateDate: string (date-time)

Title: Last Updated Date

Read Only: true

The date and time when the resource for the case was last updated.
LastUpdatedBy: string

Title: Last Updated By

Read Only: true

Maximum Length: 64

The user who last updated the resource for the case.
LastUpdateLogin: string

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: array Links

Title: Links

The link relations associated with the resource instance.
OwnerFlag: boolean

Title: Owner

Read Only: true

Indicates whether the resource is the owner of the case.
PartyId: integer (int64)

Title: Party ID

The unique identifier of the party.
ResourceName: string

Title: Resource Name

Maximum Length: 360

The name of the resource.
ResourcePartyNumber: string

Title: Party Number

Read Only: true

Maximum Length: 30

The alternate key identifier of the party.
UpdateFlag: boolean

Title: Update

Read Only: true

Indicates whether the record can be updated.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the resource for the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the case resource was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the resource for the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Resource Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the resource.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "OwnerFlag":{
            "title":"Owner",
            "type":"boolean",
            "description":"Indicates whether the resource is the owner of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            }
        },
        "CaseId":{
            "title":"Case ID",
            "type":"integer",
            "description":"The unique identifier of the case.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "CaseResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier of the case resource.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete",
            "type":"boolean",
            "description":"Indicates whether the record can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the contact who created the resource.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "UpdateFlag":{
            "title":"Update",
            "type":"boolean",
            "description":"Indicates whether the record can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourcePartyNumber":{
            "title":"Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CaseNumber":{
            "title":"Case Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the case.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The phone number of the user who created the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the resource for the case was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login session of the user who last updated the resource for the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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."
        }
    }
}

Links

ResourcePickerPVO: Operation: /crmRestApi/resources/11.13.18.05/resources

A front office person. For example, sales persons or partner members can be tagged as resources.

Examples

The following example shows how to update a case resource by submitting a patch request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X PATCH https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseResources/{CaseResourceId}

Example of Request Body

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

  {
    "CaseId": 300100215793299,
    "CaseResourceId": 300100215798772,
    "CorpCurrencyCode": "USD",
    "CreatedBy": "AUTOUICASE1",
    "CreationDate": "2021-08-23T06:29:10+00:00",
    "CurcyConvRateType": null,
    "CurrencyCode": "USD",
.....
}

Example of Response Body

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

   "CaseId": 300100215793299,
    "CaseResourceId": 300100215798772,
    "CorpCurrencyCode": "USD",
    "CreatedBy": "AUTOUICASE1",
    "CreationDate": "2021-08-23T06:29:10+00:00",
    "CurcyConvRateType": null,
    "CurrencyCode": "USD",
    "LastUpdateDate": "2021-08-26T13:48:48.028+00:00",
    "LastUpdateLogin": "CA5FADBCB869CFA2E05322EAF40AFAF1",
    "LastUpdatedBy": "SALES_ADMIN",
    "PartyId": 6623,
    "ResourcePartyNumber": "5017",
    "ResourceName": "Ian Maddox",
    "CaseNumber": "CDRM_4003",
    "OwnerFlag": false,
    "UpdateFlag": true,
    "DeleteFlag": true,
    "EmailAddress": "sendmail-test-discard@oracle.com",
    "FormattedPhoneNumber": "+1 ",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseResources/300100215798772",
            "name": "caseResources",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseResources/300100215798772",
            "name": "caseResources",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003",
            "name": "cases",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseResources/300100215798772/lov/ResourcePickerPVO",
            "name": "ResourcePickerPVO",
            "kind": "collection"
        }
    ]
}