Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

POST /analytics/custom_actions/scripts

SUMMARY Creates a new custom action script file. Newly created custom action script files require a deployment before using.

Creates a new custom action script file. Newly created custom action script files require a deployment before using. Users can include an optional HTTP header file_name containing the custom action script file name. If not specified this is defaulted to the script id of the uploaded file.

Table 1: POST /analytics/custom_actions/scripts resource details:

POST /analytics/custom_actions/scripts resource details

MIME Type

application/json

Table 2: POST /analytics/custom_actions/scripts request parameter details:

POST /analytics/custom_actions/scripts request parameter details

Parameter Type Optionality Data Type MIME Type Description

fields

header

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: POST /analytics/custom_actions/scripts request body details:

POST /analytics/custom_actions/scripts request body details

Parameter Data Type MIME Type Description Sample

file

File

application/octet-stream

Required. The custom action script file. Must be supplied with MIME type application/octet-stream.

File

Table 4: POST /analytics/custom_actions/scripts response codes:

POST /analytics/custom_actions/scripts response codes

HTTP Response Code Unique Code Description

201

A custom action script file has been created.

500

1020

An internal server error occurred while posting custom action script file.

Response Description

Custom action script file meta-data with the following fields:
  • id - Number - Unique ID of the custom action script within the JSA deployment.
  • name - String - Name of the custom action script.

Response Sample