Jump to

• Request
• Response
• Examples

Get an ActionIntent

get

/crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Address/{AddressNumber}/child/smartActions/{accounts_Address_smartActions_Id}/enclosure/ActionIntent

Get an ActionIntent

Request

Path Parameters

• AddressNumber(required): string
  The alternate key identifier of the address that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update.
• PartyNumber(required): 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. Inactive records can't be updated.
• accounts_Address_smartActions_Id(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/octet-stream

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: string(binary)

Back to Top

Examples

The following example shows how to get an action intent of an account address smart action by submitting a GET request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts-{PartyNumber}-child-Address-{AddressNumber}-child-smartActions-{accounts_Address_smartActions_Id}-enclosure-ActionIntent

Example of Response Body

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

For update action intent

{
    "Type": "UPDATE",
    "Target": "accounts.Address",
    "Fulfillment": "UI"
}

For delete action intent

{
    "Type": "DELETE",
    "Target": "accounts.Address",
    "Fulfillment": "API"
}

Back to Top