CreateScriptDetails

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/oracle/main/json-schema/oracle-create-script-details-schema.json",
  "title": "CreateScriptDetails",
  "description": "Details of the request body used to create a new script.\nOnly Side, JavaScript and Playwright TypeScript content types are supported and content should be in Side, JavaScript and TypeScript formats only.\n",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-apmsynthetic-api-openapi.yml#/components/schemas/CreateScriptDetails",
  "properties": {
    "content": {
      "description": "The content of the script. It may contain custom-defined tags that can be used for setting dynamic parameters.\nThe format to set dynamic parameters is: `<ORAP><ON>param name</ON><OV>param value</OV><OS>isParamValueSecret(true/false)</OS></ORAP>`.\nParam value and isParamValueSecret are optional, the default value for isParamValueSecret is false.\nExamples:\nWith mandatory param name : `<ORAP><ON>param name</ON></ORAP>`\nWith parameter name and value : `<ORAP><ON>param name</ON><OV>param value</OV></ORAP>`\nNote 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. If the content type is PLAYWRIGHT_TS, then the content should be in TypeScript format.\n",
      "maxLength": 65536,
      "minLength": 1,
      "type": "string"
    },
    "contentFileName": {
      "default": "script.side",
      "description": "File name of uploaded script content.",
      "maxLength": 1024,
      "minLength": 1,
      "type": "string"
    },
    "contentType": {
      "description": "Content type of script.",
      "enum": [
        "SIDE",
        "JS",
        "PLAYWRIGHT_TS"
      ],
      "type": "string",
      "x-obmcs-top-level-enum": "#/definitions/ContentTypes"
    },
    "definedTags": {
      "additionalProperties": {
        "additionalProperties": {
          "description": "The value of the tag. Only string, integer and boolean types are supported.\n",
          "type": "object"
        },
        "description": "Key-value pair representing predefined tags' keys and values scoped to a namespace.\nExample: `{\"bar-key\": \"value\"}`\n",
        "type": "object"
      },
      "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n",
      "type": "object"
    },
    "displayName": {
      "description": "Unique name that can be edited. The name should not contain any confidential information.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "freeformTags": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.\nExample: `{\"bar-key\": \"value\"}`\n",
      "type": "object"
    },
    "parameters": {
      "description": "List of script parameters. Example: `[{\"paramName\": \"userid\", \"paramValue\":\"testuser\", \"isSecret\": false}]`\n",
      "items": {
        "$ref": "#/$defs/ScriptParameter"
      },
      "maxItems": 50,
      "type": "array"
    }
  },
  "required": [
    "displayName",
    "content",
    "contentType"
  ],
  "type": "object",
  "$defs": {
    "ScriptParameter": {
      "description": "Details of the script parameters, paramName must be from the script content and\nthese details can be used to overwrite the default parameter present in the script content.\n",
      "properties": {
        "isSecret": {
          "default": false,
          "description": "If the parameter value is secret and should be kept confidential, then set isSecret to true.",
          "type": "boolean"
        },
        "paramName": {
          "description": "Name of the parameter.",
          "maxLength": 64,
          "minLength": 1,
          "type": "string"
        },
        "paramValue": {
          "description": "Value of the parameter.",
          "maxLength": 2048,
          "type": "string",
          "x-default-description": "null"
        }
      },
      "required": [
        "paramName"
      ],
      "type": "object"
    }
  }
}