Jump to

• Request
• Response

Get a user action

get

/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/parties/{PartyPuid}/child/smartActions/{UserActionId}

Request

Path Parameters

• PartyPuid(required): string
  The alternate identifier of the party.
• SubscriptionNumber(required): string
  The alternate identifier of the subscription.
• UserActionId(required): integer(int64)
  The unique identifier of the subscription user actions.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  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: string
  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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : subscriptions-parties-smartActions-item-response

Type: object

Show Source

• ActionIntent: string (byte)
  Title: Action Intent

  The JSON object that describes what an action does and what context data can be passed to the action.
• ConfirmationMessage: string
  Title: Confirmation Message

  Maximum Length: 4000

  A message seeking confirmation for the action being performed.
• ContentType: string
  Title: Content Type

  Maximum Length: 50

  The content type used when invoking the REST endpoint.
• DisplayLabel: string
  Title: Action Name

  Maximum Length: 256

  The display label of the subscription smart actions.
• Entity: string
  Title: Parent Entity

  Maximum Length: 150

  The entity of the subscription smart actions.
• Href: string
  Title: REST Endpoint

  Maximum Length: 1024

  The HREF of the subscription smart actions
• IncludedInApplication: string
  Title: Included in Application

  Maximum Length: 512

  The included in application flag of the subscription smart actions.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MassActionFlag: boolean
  Title: Mass Action

  Maximum Length: 1

  The mass action flag of the smart action.
• Method: string
  Title: HTTP Method

  Maximum Length: 15

  The method associated with the subscription smart actions.
• ObjectFunctionName: string
  Title: Object Function

  Maximum Length: 64

  The object function name of the smart action.
• PageType: string
  Title: Page Type

  Maximum Length: 256

  The page type of the smart action.
• SmartSuggestFlag: boolean
  Title: Smart Suggest

  Maximum Length: 1

  The smart suggest flag of the smart action.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  The flag indicating if the action is seeded or custom.
• UpdateOfAttributes: string
  Title: Attributes to Update

  Maximum Length: 512

  The update of attributes flag of the subscription smart actions.
• UserActionId: integer (int64)
  Title: User Action ID

  The unique identifier of the subscription user actions.
• UserActionName: string
  Title: Action Name

  Maximum Length: 256

  The name of the subscription user actions.
• UserActionNavigation: array User Action Navigation
  Title: User Action Navigation

  The user action navigation resource stores the UI navigation metadata striped by app usage.
• UserActionRank: integer (int64)
  Title: Priority

  The user rank action of the smart action.
• UserActionRequestPayload: array User Action Request Payload
  Title: User Action Request Payload

  The user action request payload resource stores the payload information for every user action request.
• UserActionURLBinding: array User Action URL Binding
  Title: User Action URL Binding

  The user action URL binding resource stores the binding metadata for a variable in the URL.

{
    "type":"object",
    "properties":{
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":1,
            "type":"boolean",
            "description":"The smart suggest flag of the smart action.",
            "nullable":true,
            "x-queryable":true
        },
        "Entity":{
            "title":"Parent Entity",
            "maxLength":150,
            "type":"string",
            "description":"The entity of the subscription smart actions.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":50,
            "type":"string",
            "description":"The content type used when invoking the REST endpoint.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionURLBinding":{
            "title":"User Action URL Binding",
            "type":"array",
            "description":"The user action URL binding resource stores the binding metadata for a variable in the URL.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-parties-smartActions-UserActionURLBinding-item-response"
            }
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The mass action flag of the smart action.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":512,
            "type":"string",
            "description":"The included in application flag of the subscription smart actions.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavigation":{
            "title":"User Action Navigation",
            "type":"array",
            "description":"The user action navigation resource stores the UI navigation metadata striped by app usage.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-parties-smartActions-UserActionNavigation-item-response"
            }
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":1024,
            "type":"string",
            "description":"The HREF of the subscription smart actions",
            "nullable":true,
            "x-queryable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":15,
            "type":"string",
            "description":"The method associated with the subscription smart actions.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"The display label of the subscription smart actions.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"The name of the subscription user actions.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"The unique identifier of the subscription user actions.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"The user rank action of the smart action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The flag indicating if the action is seeded or custom.",
            "nullable":true,
            "x-queryable":true
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":4000,
            "type":"string",
            "description":"A message seeking confirmation for the action being performed.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionRequestPayload":{
            "title":"User Action Request Payload",
            "type":"array",
            "description":"The user action request payload resource stores the payload information for every user action request.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-parties-smartActions-UserActionRequestPayload-item-response"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":512,
            "type":"string",
            "description":"The update of attributes flag of the subscription smart actions.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionIntent":{
            "title":"Action Intent",
            "type":"string",
            "description":"The JSON object that describes what an action does and what context data can be passed to the action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ObjectFunctionName":{
            "title":"Object Function",
            "maxLength":64,
            "type":"string",
            "description":"The object function name of the smart action.",
            "nullable":true,
            "x-queryable":true
        },
        "PageType":{
            "title":"Page Type",
            "maxLength":256,
            "type":"string",
            "description":"The page type of the smart action.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : User Action Navigation

Type: array

Title: User Action Navigation

The user action navigation resource stores the UI navigation metadata striped by app usage.

Show Source

• Array of: object subscriptions-parties-smartActions-UserActionNavigation-item-response

{
    "title":"User Action Navigation",
    "type":"array",
    "description":"The user action navigation resource stores the UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-parties-smartActions-UserActionNavigation-item-response"
    }
}

Nested Schema : User Action Request Payload

Type: array

Title: User Action Request Payload

The user action request payload resource stores the payload information for every user action request.

Show Source

• Array of: object subscriptions-parties-smartActions-UserActionRequestPayload-item-response

{
    "title":"User Action Request Payload",
    "type":"array",
    "description":"The user action request payload resource stores the payload information for every user action request.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-parties-smartActions-UserActionRequestPayload-item-response"
    }
}

Nested Schema : User Action URL Binding

Type: array

Title: User Action URL Binding

The user action URL binding resource stores the binding metadata for a variable in the URL.

Show Source

• Array of: object subscriptions-parties-smartActions-UserActionURLBinding-item-response

{
    "title":"User Action URL Binding",
    "type":"array",
    "description":"The user action URL binding resource stores the binding metadata for a variable in the URL.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-parties-smartActions-UserActionURLBinding-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : subscriptions-parties-smartActions-UserActionNavigation-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system action flag of the user action navigation.
• UserActionNavAppUsage: string
  Title: Application Usage

  Maximum Length: 50

  The user action navigation application usage.
• UserActionNavBody: string
  Title: Navigation Metadata

  Maximum Length: 1000

  The body of user action navigation.
• UserActionNavId: integer (int64)
  Title: Primary Key

  The unique identifier of the subscription user action navigation.
• UserActionNavType: string
  Title: Navigation Type

  Maximum Length: 100

  The type of user action navigation.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system action flag of the user action navigation.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"The unique identifier of the subscription user action navigation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":100,
            "type":"string",
            "description":"The type of user action navigation.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":1000,
            "type":"string",
            "description":"The body of user action navigation.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":50,
            "type":"string",
            "description":"The user action navigation application usage.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptions-parties-smartActions-UserActionRequestPayload-item-response

Type: object

Show Source

• Binding: string
  Title: Payload Value Binding Type

  Maximum Length: 64

  The binding of the user action payload.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MandatoryFlag: boolean
  Title: Mandatory

  Maximum Length: 1

  The mandatory flag of the user action payload.
• RequestPayloadId: integer (int64)
  The request payload ID of the user action.
• RequestPayloadName: string
  Title: Request Payload Attribute Name

  Maximum Length: 256

  The request payload name of the user action.
• SmartSuggestPath: string
  Title: Smart Suggest Path

  Maximum Length: 2048

  The smart suggest path of the user action payload.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system action flag of the user action request payload.
• Value: string
  Title: Request Payload Attribute Value

  Maximum Length: 1000

  The value of the user action payload.
• ValueStruct: string
  Title: Payload Value Structure

  Maximum Length: 20

  The value structure of the user action payload.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"The binding of the user action payload.",
            "nullable":true,
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system action flag of the user action request payload.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":20,
            "type":"string",
            "description":"The value structure of the user action payload.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value of the user action payload.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":2048,
            "type":"string",
            "description":"The smart suggest path of the user action payload.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestPayloadId":{
            "type":"integer",
            "description":"The request payload ID of the user action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":256,
            "type":"string",
            "description":"The request payload name of the user action.",
            "nullable":false,
            "x-queryable":true
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":1,
            "type":"boolean",
            "description":"The mandatory flag of the user action payload.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptions-parties-smartActions-UserActionURLBinding-item-response

Type: object

Show Source

• Binding: string
  Title: URL Binding Type

  Maximum Length: 64

  The URL binding of user action.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system action flag of the user action URL binding.
• URLBindingId: integer (int64)
  The identifier of URL binding of user action.
• URLBindingName: string
  Title: URL Binding Parameter Name

  Maximum Length: 256

  The name of URL binding of user action.
• Value: string
  Title: URL Binding Parameter Value

  Maximum Length: 1000

  The value of URL binding of user action.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"The URL binding of user action.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value of URL binding of user action.",
            "nullable":true,
            "x-queryable":true
        },
        "URLBindingId":{
            "type":"integer",
            "description":"The identifier of URL binding of user action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system action flag of the user action URL binding.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":256,
            "type":"string",
            "description":"The name of URL binding of user action.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

UserActionNavigation

Operation: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/parties/{PartyPuid}/child/smartActions/{UserActionId}/child/UserActionNavigation

Parameters:

• PartyPuid: $request.path.PartyPuid
• SubscriptionNumber: $request.path.SubscriptionNumber
• UserActionId: $request.path.UserActionId

The user action navigation resource stores the UI navigation metadata striped by app usage.

UserActionRequestPayload

Operation: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/parties/{PartyPuid}/child/smartActions/{UserActionId}/child/UserActionRequestPayload

Parameters:

• PartyPuid: $request.path.PartyPuid
• SubscriptionNumber: $request.path.SubscriptionNumber
• UserActionId: $request.path.UserActionId

The user action request payload resource stores the payload information for every user action request.

UserActionURLBinding

Operation: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/parties/{PartyPuid}/child/smartActions/{UserActionId}/child/UserActionURLBinding

Parameters:

• PartyPuid: $request.path.PartyPuid
• SubscriptionNumber: $request.path.SubscriptionNumber
• UserActionId: $request.path.UserActionId

The user action URL binding resource stores the binding metadata for a variable in the URL.

executeAction

Operation: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/parties/{PartyPuid}/child/smartActions/{UserActionId}/action/executeAction

Parameters:

• PartyPuid: $request.path.PartyPuid
• SubscriptionNumber: $request.path.SubscriptionNumber
• UserActionId: $request.path.UserActionId

This method lets you execute a user smart action.

Back to Top