Oracle Update Standard Field

Overview

This documentation provides details for using the updateStandardField action to update a standard field in an existing incident in Oracle Service Cloud. The updateStandardField action allows you to update a specified field with a given value or use a custom object structure for more complex updates.

πŸ“˜

Please refer to the following Oracle Documentation to ensure the data in the REST API call is correctly formated:

https://docs.oracle.com/en/cloud/saas/b2c-service/cxsvc/op-services-rest-connect-v1.4-incidents-id-patch.html

Inputs

HostStringOracle host
UsernameStringOracle username
PasswordStringOracle password
IncidentIdStringID of the incident
FieldLabelStringThe label of the field to be updated
FieldValueStringThe new value for the field
IsObjectBooleanWhether the update uses a custom object structure
ObjectDataObjectThe custom object data for the update

Outputs

SuccessBooleanWhether the field was successfully updated

Examples

The following action will update the subject field of the incident with ID 3773011:

{
  "host": "https://your_site.custhelp.com",
  "username": "your_username",
  "password": "your_password",
  "incidentId": "3773011",
  "fieldLabel": "subject",
  "fieldValue": "New Subject from API",
  "isObject": false
}

This query returns the following data:

{
  "success": true
}

The following action will update the statusWithType field of the incident with ID 3773011 using a custom object structure:

{
  "host": "https://your_site.custhelp.com",
  "username": "your_username",
  "password": "your_password",
  "incidentId": "3773011",
  "isObject": true,
  "objectData": {
    "statusWithType": {
      "status": {
        "id": 1,
        "lookupName": "Unresolved"
      }
    }
  }
}

This query returns the following data:

{
  "success": true
}

Note that the output of Success will be false if any of the following occurs:

  • The API call is unsuccessful (i.e., there is an error when making the API call), OR;
  • The API call is successful (response code 200) but the response does not contain the expected data.