Jump to

• Request
• Response
• Examples

Assign accounts

post

/crmRestApi/resources/11.13.18.05/accounts/action/runAssignment

Assign an account to territory assignments using the Request Account Assignment process.

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

• partyNumber: string
  The unique alternate identifier for the account party. You can update the value if the profile option HZ_GENERATE_PARTY_NUMBER is set to True. The default value is a concatenation of the value specified in the profile option ZCA_PUID_PREFIX and a unique system generated sequence number.

{
    "type":"object",
    "properties":{
        "partyNumber":{
            "type":"string",
            "description":"The unique alternate identifier for the account party. You can update the value if the profile option HZ_GENERATE_PARTY_NUMBER is set to True. The default value is a concatenation of the value specified in the profile option ZCA_PUID_PREFIX and a unique system generated sequence number.",
            "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 "Successful" if the action completes successfully.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"Returns \"Successful\" if the action completes successfully."
        }
    },
    "additionalProperties":false
}

Back to Top

Examples

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

cURL Command

curl -u <username:password> \ -X POST https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/action/runAssignment

Example of Request Body

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

{
"partyNumber": 100000013637001
}

Example of Response Body

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

{
  "result": "SUCCESSFUL"
}

Back to Top