Jump to

• Request
• Response
• Examples

Assign matched opportunity

post

/crmRestApi/resources/11.13.18.05/opportunities/action/assignOpportunity

Assigns a matched opportunity.

Request

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

• optyNumber: string
  The unique identifier of an opportunity.

{
    "type":"object",
    "properties":{
        "optyNumber":{
            "type":"string",
            "description":"The unique identifier of an opportunity.",
            "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
  Success or failure status is returned.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"Success or failure status is returned."
        }
    },
    "additionalProperties":false
}

Back to Top

Examples

The following example shows how to assign matched opportunity by submitting a POST request on the REST resource using cURL.

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

Example of Request Header

The following example shows the request header.

Content-Type - application/vnd.oracle.adf.action+json	

Example of Request Body

The following example shows the request body to run the assignment for the passed in lead identifier and assign either resources or territories to the Lead.

{
    "optyNumber": "AUTOCDRM_7027",
    
}

Example of Response Body

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

{
  "result": "Successful"
}

Back to Top