GET /analytics/custom_actions/actions/{action_id}

SUMMARY Retrieves a custom action based on the supplied action_id.

Retrieves a custom action based on the supplied action_id.

Table 1: GET /analytics/custom_actions/actions/{action_id} resource details:
GET /analytics/custom_actions/actions/{action_id} resource details
MIME Type
application/json

Table 2: GET /analytics/custom_actions/actions/{action_id} request parameter details:
GET /analytics/custom_actions/actions/{action_id} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
action_id	path	Required	Number (Integer)	text/plain	Long id of the custom action to be retrieved.
fields	query	Optional	String	text/plain	Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3: GET /analytics/custom_actions/actions/{action_id} response codes:
GET /analytics/custom_actions/actions/{action_id} response codes
HTTP Response Code	Unique Code	Description
200		The requested custom action has been successfully retrieved.
404	1002	The requested custom action could not be found.
500	1020	An internal server error occurred while retrieving custom action with supplied action_id.

Response Description

A custom action with containing following fields:

id - Number - Unique ID of the custom action within the JSA deployment.
name - String - Unique name of the custom action within the JSA deployment.
description - String - Optional description attached to the custom action.
interpreter - Number - Unique ID of the custom action interpreter used by the custom action.
script - Number - Unique ID of the custom action script used by the custom action.
parameters - Array - Array of custom action parameters contained within the custom action. Each Custom action parameter has the following fields:
- name - String - Name of the custom action parameter. Unique in the context of the parent custom action.
- parameter_type - String - Custom action parameter type. Can be either fixed or dynamic.
- encrypted - Boolean - Designates whether the custom action parameter value field is stored in an encrypted state.True if encrypted, false otherwise.
- value - String - Value of the custom action parameter.