Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateScriptDetails

Details of the request body used to create a new script. Only Side or JavaScript content types are supported and content should be in Side or JavaScript formats only.

Properties

content

content: string

The content of the script. It may contain custom-defined tags that can be used for setting dynamic parameters. The format to set dynamic parameters is: <ORAP><ON>param name</ON><OV>param value</OV><OS>isParamValueSecret(true/false)</OS></ORAP>. Param value and isParamValueSecret are optional, the default value for isParamValueSecret is false. Examples: With mandatory param name : <ORAP><ON>param name</ON></ORAP> With parameter name and value : <ORAP><ON>param name</ON><OV>param value</OV></ORAP> Note that the content is valid if it matches the given content type. For example, if the content type is SIDE, then the content should be in Side script format. If the content type is JS, then the content should be in JavaScript format.

Optional contentFileName

contentFileName: undefined | string

File name of uploaded script content.

contentType

contentType: ContentTypes

Content type of script.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

displayName

displayName: string

Unique name that can be edited. The name should not contain any confidential information.

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Optional parameters

parameters: Array<ScriptParameter>

List of script parameters. Example: [{\"paramName\": \"userid\", \"paramValue\":\"testuser\", \"isSecret\": false}]

Functions

getDeserializedJsonObj

getJsonObj