Jump to

• Request
• Response
• Examples

Send an email to SR message recipients

post

/crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/action/sendEmailForSrMessage

This method lets you send an email to the recipients of the service request message for the specified message identifier.

Request

Path Parameters

• SrNumber(required): string
  The unique number that is used to identify a service request. You can configure the service request number to a format that is best suitable to your organizational requirements. For example, service request may have the formats service request0000012345, service request_000_12345, 12345_00_service request, and so on depending on your requirements.

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/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• msgId: number
  The unique identifier of the service request message to be sent.

{
    "type":"object",
    "properties":{
        "msgId":{
            "type":"number",
            "description":"The unique identifier of the service request message to be sent.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): string
  Returns the unique email identifier from the application that delivered the email.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"Returns the unique email identifier from the application that delivered the email."
        }
    },
    "additionalProperties":false
}

Back to Top

Examples

The following example shows how to send an email to SR message reciprients by submitting a POST request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000156407/action/sendEmailForSrMessage

Example of Request Body

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

{
"msgId":300100559982654
}

Example of Response Body

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

{
    "result": "8725fe880af7481d6eff3cb0fe8a0b33"
}

Back to Top