Jump to

• Request
• Response
• Examples

Get an ActionIntent

get

/crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Address/{AddressNumber}/child/smartActions/{contacts_Address_smartActions_Id}/enclosure/ActionIntent

Get an ActionIntent

Request

Path Parameters

• AddressNumber(required): string
  The unique alternate identifier for the address. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified, then it is automatically generated. A list of accepted values is defined in the profile option ZCA_PUID_PREFIX concatenated with an internally generated unique sequence number.
• PartyNumber(required): string
  The alternate key identifier for the contact party. The profile option HZ_GENERATE_PARTY_NUMBER controls whether the attribute value can be system generated or user-provided during create. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task. Inactive records can't be updated.
• contacts_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 a contact 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/contacts/{PartyNumber}/child/Address/{AddressNumber}/child/smartActions/{contacts_Address_smartActions_Id}/enclosure/ActionIntent

Example of Response Body

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

For delete action intent

{
    "Type": "DELETE",
    "Target": "contacts.ContactPoint",
    "Fulfillment": "API"
}

For update action intent

{
    "Type": "UPDATE",
    "Target": "contacts.ContactPoint",
    "SubTarget": "EMAIL",
    "Fulfillment": "UI"
}

Back to Top