Jump to

• Request
• Response

Get all smart actions

get

/crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/smartActions

Request

Path Parameters

• CaseNumber(required): string
  The alternate key identifier of the case.

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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds the smart action references using the reference ID.
    Finder Variables:
    • UserActionId; integer; The smart action reference ID passed as a parameter to the finder service.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ActionSource; string; Attribute that describes the source of a smart action. Smart actions can be manually created or cloned, or automatically generated.
  • ActiveFlag; boolean; Indicates whether the action is active or inactive. Inactive actions are not returned to client applications under any circumstance. 'True' indicates the smart action is active.
  • ApplicationRoles; string; The application roles associated with the smart action.
  • Condition; string; The boolean script evaluated at runtime to determine if the action can be returned to the client application. Additional evaluations also are carried out to determine if the action will be returned to the client application.
  • ConfirmationMessage; string; A message to seek confirmation for the action being performed.
  • ContentType; string; The content type to use when invoking the REST endpoint.
  • ContextualFlag; boolean; Indicates the contexual flag.
  • DataPrivilege; string; The data security privilege that the authenticated user role must be granted, in order for the action to be returned to the client application. Additional evaluations also are carried out to determine if the action will be returned to the client application.
  • DisplayLabel; string; The consumer friendly action name.
  • Entity; string; The REST resources the Action belongs to.
  • Href; string; The REST endpoint to perform the Action.
  • IncludedIn; string; The View Object corresponding to the primary object the smart action is associated with.
  • IncludedInApplication; string; The list of applications that this action can be used in.
  • InternalFlag; boolean; Indicates whether the action is internal type.
  • MassActionFlag; boolean; Indicates whether the action can be mass processed.
  • Method; string; The HTTP method of the smart action REST operation.
  • ObjectFunctionName; string; The object function associated with the smart action.
  • PageType; string; The Page Type.
  • SmartSuggestFlag; boolean; Indicates the smart suggest flag.
  • SystemActionFlag; boolean; Indicates whether the Action is seeded or custom.
  • UpdateOfAttributes; string; The attributes to be updated when the Actions UI is launched.
  • UserActionId; integer; The unique identifier of the smart action definition.
  • UserActionName; string; The attribute uniquely identifies the action with name. For internal use.
  • UserActionRank; integer; The number to indicate priority of the action.
  • UserPrivilege; string; The User Security Privilege.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

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 : cases-smartActions

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/cases-smartActions-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object cases-smartActions-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/cases-smartActions-item-response"
    }
}

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 : cases-smartActions-item-response

Type: object

Show Source

• ActionContextParameters: string
  Title: Action Context Parameters

  Maximum Length: 1000

  Determines the context when a smart action is applicable.
• ActionIntent: string (byte)
  Title: Action Intent

  JSON object that describes what an action does and what context data can be passed to the action.
• ActionSource: string
  Title: Action Source

  Maximum Length: 512

  Attribute that describes the source of a smart action. Smart actions can be manually created or cloned, or automatically generated.
• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Indicates whether the action is active or inactive. Inactive actions are not returned to client applications under any circumstance. 'True' indicates the smart action is active.
• ApplicationRoles: string
  Title: Application Roles

  Maximum Length: 2000

  The application roles associated with the smart action.
• Condition: string
  Title: Filter Condition

  Maximum Length: 1000

  The boolean script evaluated at runtime to determine if the action can be returned to the client application. Additional evaluations also are carried out to determine if the action will be returned to the client application.
• ConfirmationMessage: string
  Title: Confirmation Message

  Maximum Length: 4000

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

  Maximum Length: 50

  The content type to use when invoking the REST endpoint.
• ContextualFlag: boolean
  Title: Contextual

  Maximum Length: 1

  Indicates the contexual flag.
• DataPrivilege: string
  Title: Data Security Privilege

  Maximum Length: 250

  The data security privilege that the authenticated user role must be granted, in order for the action to be returned to the client application. Additional evaluations also are carried out to determine if the action will be returned to the client application.
• DisplayLabel: string
  Title: Action Name

  Maximum Length: 256

  The consumer friendly action name.
• Entity: string
  Title: Parent Entity

  Maximum Length: 150

  The REST resources the Action belongs to.
• Href: string
  Title: REST Endpoint

  Maximum Length: 150

  The REST endpoint to perform the Action.
• IncludedIn: string
  Title: Included In

  Maximum Length: 150

  The View Object corresponding to the primary object the smart action is associated with.
• IncludedInApplication: string
  Title: Included in Application

  Maximum Length: 512

  The list of applications that this action can be used in.
• InternalFlag: boolean
  Title: Restricted

  Maximum Length: 1

  Indicates whether the action is internal type.
• links: array Links
  Title: Links

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

  Maximum Length: 1

  Indicates whether the action can be mass processed.
• Method: string
  Title: HTTP Method

  Maximum Length: 15

  The HTTP method of the smart action REST operation.
• ObjectFunctionName: string
  Title: Object Function

  Maximum Length: 64

  The object function associated with the smart action.
• PageType: string
  Title: Page Type

  Maximum Length: 256

  The Page Type.
• SmartSuggestFlag: boolean
  Title: Smart Suggest

  Maximum Length: 1

  Indicates the smart suggest flag.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Indicates whether the Action is seeded or custom.
• UpdateOfAttributes: string
  Title: Attributes to Update

  Maximum Length: 512

  The attributes to be updated when the Actions UI is launched.
• UserActionId: integer (int64)
  Title: User Action ID

  The unique identifier of the smart action definition.
• UserActionName: string
  Title: Action Name

  Maximum Length: 256

  The attribute uniquely identifies the action with name. For internal use.
• UserActionNavigation: array User Interface Definitions
  Title: User Interface Definitions

  The user interface definitions resource is used to view user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
• UserActionRank: integer (int64)
  Title: Priority

  The number to indicate priority of the action.
• UserActionRequestPayload: array Payload Definitions
  Title: Payload Definitions

  The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
• UserActionURLBinding: array Path Parameter Definitions
  Title: Path Parameter Definitions

  The path parameters definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
• UserPrivilege: string
  Title: User Security Privilege

  Maximum Length: 4000

  The User Security Privilege.

{
    "type":"object",
    "properties":{
        "Entity":{
            "title":"Parent Entity",
            "maxLength":"150",
            "type":"string",
            "description":"The REST resources the Action belongs to.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludedIn":{
            "title":"Included In",
            "maxLength":"150",
            "type":"string",
            "description":"The View Object corresponding to the primary object the smart action is associated with.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":"50",
            "type":"string",
            "description":"The content type to use when invoking the REST endpoint.",
            "nullable":true,
            "x-queryable":true
        },
        "ContextualFlag":{
            "title":"Contextual",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates  the contexual flag.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":"512",
            "type":"string",
            "description":"The list of applications that this action can be used in.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionContextParameters":{
            "title":"Action Context Parameters",
            "maxLength":"1000",
            "type":"string",
            "description":"Determines the context when a smart action is applicable.",
            "nullable":true,
            "x-queryable":false
        },
        "UserActionNavigation":{
            "title":"User Interface Definitions",
            "type":"array",
            "description":"The user interface definitions resource is used to view user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/cases-smartActions-UserActionNavigation-item-response"
            }
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":"256",
            "type":"string",
            "description":"The consumer friendly action name.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"The number to indicate priority of the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the Action is seeded or custom.",
            "nullable":true,
            "x-queryable":true
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":"4000",
            "type":"string",
            "description":"A message to seek confirmation for the action being performed.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionRequestPayload":{
            "title":"Payload Definitions",
            "type":"array",
            "description":"The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/cases-smartActions-UserActionRequestPayload-item-response"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":"512",
            "type":"string",
            "description":"The attributes to be updated when the Actions UI is launched.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionIntent":{
            "title":"Action Intent",
            "type":"string",
            "description":"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 associated with the smart action.",
            "nullable":true,
            "x-queryable":true
        },
        "PageType":{
            "title":"Page Type",
            "maxLength":"256",
            "type":"string",
            "description":"The Page Type.",
            "nullable":true,
            "x-queryable":true
        },
        "Condition":{
            "title":"Filter Condition",
            "maxLength":"1000",
            "type":"string",
            "description":"The boolean script evaluated at runtime to determine if the action can be returned to the client application. Additional evaluations also are carried out to determine if the action will be returned to the client application.",
            "nullable":true,
            "x-queryable":true
        },
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the smart suggest flag.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionURLBinding":{
            "title":"Path Parameter Definitions",
            "type":"array",
            "description":"The path parameters definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/cases-smartActions-UserActionURLBinding-item-response"
            }
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the action can be mass processed.",
            "nullable":true,
            "x-queryable":true
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":"150",
            "type":"string",
            "description":"The REST endpoint to perform the Action.",
            "nullable":true,
            "x-queryable":true
        },
        "InternalFlag":{
            "title":"Restricted",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the action is internal type.",
            "nullable":true,
            "x-queryable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":"15",
            "type":"string",
            "description":"The HTTP method of the smart action REST operation.",
            "nullable":true,
            "x-queryable":true
        },
        "UserPrivilege":{
            "title":"User Security Privilege",
            "maxLength":"4000",
            "type":"string",
            "description":"The User Security Privilege.",
            "nullable":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the action is active or inactive. Inactive actions are not returned to client applications under any circumstance. 'True' indicates the smart action is active.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":"256",
            "type":"string",
            "description":"The attribute uniquely identifies the action with name. For internal use.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"The unique identifier of the smart action definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DataPrivilege":{
            "title":"Data Security Privilege",
            "maxLength":"250",
            "type":"string",
            "description":"The data security privilege that the authenticated user role must be granted, in order for the action to be returned to the client application. Additional evaluations also are carried out to determine if the action will be returned to the client application.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionSource":{
            "title":"Action Source",
            "maxLength":"512",
            "type":"string",
            "description":"Attribute that describes the source of a smart action. Smart actions can be manually created or cloned, or automatically generated.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplicationRoles":{
            "title":"Application Roles",
            "maxLength":"2000",
            "type":"string",
            "description":"The application roles associated with 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 Interface Definitions

Type: array

Title: User Interface Definitions

The user interface definitions resource is used to view user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Show Source

• Array of: object cases-smartActions-UserActionNavigation-item-response

{
    "title":"User Interface Definitions",
    "type":"array",
    "description":"The user interface definitions resource is used to view user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/cases-smartActions-UserActionNavigation-item-response"
    }
}

Nested Schema : Payload Definitions

Type: array

Title: Payload Definitions

The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Show Source

• Array of: object cases-smartActions-UserActionRequestPayload-item-response

{
    "title":"Payload Definitions",
    "type":"array",
    "description":"The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/cases-smartActions-UserActionRequestPayload-item-response"
    }
}

Nested Schema : Path Parameter Definitions

Type: array

Title: Path Parameter Definitions

The path parameters definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Show Source

• Array of: object cases-smartActions-UserActionURLBinding-item-response

{
    "title":"Path Parameter Definitions",
    "type":"array",
    "description":"The path parameters definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/cases-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 : cases-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

  Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
• UserActionNavAppUsage: string
  Title: Application Usage

  Maximum Length: 50

  The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
• UserActionNavBody: string
  Title: Navigation Metadata

  Maximum Length: 1000

  The metadata definition of the smart action user interface endpoint.
• UserActionNavId: integer (int64)
  Title: Primary Key

  The unique identifier of a smart action user interface definition.
• UserActionNavType: string
  Title: Navigation Type

  Maximum Length: 100

  The text value used by applications to determine which user interface to launch.

{
    "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":"Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"The unique identifier of a smart action user interface definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":"100",
            "type":"string",
            "description":"The text value used by applications to determine which user interface to launch.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":"1000",
            "type":"string",
            "description":"The metadata definition of the smart action user interface endpoint.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":"50",
            "type":"string",
            "description":"The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.",
            "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 : cases-smartActions-UserActionRequestPayload-item-response

Type: object

Show Source

• Binding: string
  Title: Payload Value Binding Type

  Maximum Length: 64

  The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
• links: array Links
  Title: Links

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

  Maximum Length: 1

  Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
• RequestPayloadId: integer (int64)
  The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
• RequestPayloadName: string
  Title: Request Payload Attribute Name

  Maximum Length: 256

  The value assigned to the name property of a name-value pair.
• SmartSuggestPath: string
  Title: Smart Suggest Path

  Maximum Length: 2048

  The smart suggest path.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
• Value: string
  Title: Request Payload Attribute Value

  Maximum Length: 1000

  The value assigned to the value property of a name-value pair.
• ValueStruct: string
  Title: Payload Value Structure

  Maximum Length: 20

  A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":"64",
            "type":"string",
            "description":"The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.",
            "nullable":true,
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":"20",
            "type":"string",
            "description":"A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{\"name\":\"leadId\",\"Value\":\"LeadId\",\"MandatoryFlag\":true,\"Binding\":\"RUNTIME\"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":"1000",
            "type":"string",
            "description":"The value assigned to the value property of a name-value pair.",
            "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.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestPayloadId":{
            "type":"integer",
            "description":"The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":"256",
            "type":"string",
            "description":"The value assigned to the name property of a name-value pair.",
            "nullable":false,
            "x-queryable":true
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.",
            "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 : cases-smartActions-UserActionURLBinding-item-response

Type: object

Show Source

• Binding: string
  Title: URL Binding Type

  Maximum Length: 64

  The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
• links: array Links
  Title: Links

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

  Maximum Length: 1

  Default Value: false

  Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
• URLBindingId: integer (int64)
  The unique identifier of a smart action REST path parameter name-value pair definition.
• URLBindingName: string
  Title: URL Binding Parameter Name

  Maximum Length: 50

  The value assigned to the name property of a name-value pair.
• Value: string
  Title: URL Binding Parameter Value

  Maximum Length: 80

  The value assigned to the value property of a name-value pair.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":"64",
            "type":"string",
            "description":"The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":"80",
            "type":"string",
            "description":"The value assigned to the value property of a name-value pair.",
            "nullable":true,
            "x-queryable":true
        },
        "URLBindingId":{
            "type":"integer",
            "description":"The unique identifier of a smart action REST path parameter name-value pair definition.",
            "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":"Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":"50",
            "type":"string",
            "description":"The value assigned to the name property of a name-value pair.",
            "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

generateSmartActions

Operation: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/smartActions/action/generateSmartActions

Parameters:

• CaseNumber: $request.path.CaseNumber

This method lets you facilitate generation of actions based on a set of input parameters.

getActionEvaluationAttributesForResource

Operation: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/smartActions/action/getActionEvaluationAttributesForResource

Parameters:

• CaseNumber: $request.path.CaseNumber

This method lets you get all attributes from resource for evaluating an action.

getAttributesForResource

Operation: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/smartActions/action/getAttributesForResource

Parameters:

• CaseNumber: $request.path.CaseNumber

Get attributes for a smart action.

getEntities

Operation: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/smartActions/action/getEntities

Parameters:

• CaseNumber: $request.path.CaseNumber

Get all entities for a smart action.

getObjectFunctions

Operation: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/smartActions/action/getObjectFunctions

Parameters:

• CaseNumber: $request.path.CaseNumber

Get all object functions associated with the smart action.

processMassAction

Operation: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/smartActions/action/processMassAction

Parameters:

• CaseNumber: $request.path.CaseNumber

This method lets you process action on multiple object rows.

Back to Top