Jump to

• Request
• Response

Create A New WLDF Script Action

post

/management/weblogic/{version}/edit/WLDFSystemResources/{name}/WLDFResource/watchNotification/scriptActions

Add a new WLDF script action to this collection.

Request

Supported Media Types

• application/json

Path Parameters

• name: string
  The name property of the instance in the collection.
• version: string
  The version of the WebLogic REST interface.

Header Parameters

• X-Requested-By: string
  The 'X-Requested-By' header is used to protect against Cross-Site Request Forgery (CSRF) attacks. The value is an arbitrary name such as 'MyClient'.

Body ()

Must contain a populated WLDF script action model.

Root Schema : WLDF Script Action

Type: object

Show Source

• enabled(optional): boolean
  Default Value: true

  Specifies whether this action is enabled.

• environment(optional): object Properties
  Title: Properties

  Additional Properties Allowed: additionalProperties

  A map of environment variables to set for the child process.

• id(optional): integer(int64)
  Read Only: true

  Return the unique id of this bean instance.

• name(optional): string
  Read Only: true

  The name of the WebLogic Diagnostic Framework (WLDF) bean.

• parameters(optional): array Items
  Title: Items

  An array of ordered command-line arguments to the target script.

• pathToScript(optional): string

  The full path to the script to execute.

  Constraints

  • legal null
• timeout(optional): integer(int32)
  Minimum Value: 0

  Default Value: 0

  The length of time, in seconds, that an action has to complete execution. By default, the timeout period is 0, which disables the action timeout.

• workingDirectory(optional): string

  The working directory for the child process. If not set the working directory will be the same as the WebLogic Server parent process.

{
    "type":"object",
    "properties":{
        "enabled":{
            "default":true,
            "type":"boolean",
            "description":"<p>Specifies whether this action is enabled.</p>"
        },
        "environment":{
            "type":"object",
            "description":"<p>A map of environment variables to set for the child process.</p>",
            "additionalProperties":{
                "type":"string"
            },
            "title":"Properties"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p> Return the unique id of this bean instance.</p>"
        },
        "name":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The name of the WebLogic Diagnostic Framework (WLDF) bean.</p>"
        },
        "parameters":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>An array of ordered command-line arguments to the target script.</p>"
        },
        "pathToScript":{
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The full path to the script to execute.</p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "timeout":{
            "default":0,
            "minimum":0,
            "type":"integer",
            "format":"int32",
            "description":"<p>The length of time, in seconds, that an action has to complete execution. By default, the timeout period is 0, which disables the action timeout.</p>"
        },
        "workingDirectory":{
            "type":"string",
            "description":"<p>The working directory for the child process.  If not set the working directory will be the same as the WebLogic Server parent process.</p>"
        }
    },
    "description":""
}

Nested Schema : Properties

Type: object

Title: Properties

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"<p>A map of environment variables to set for the child process.</p>",
    "additionalProperties":{
        "type":"string"
    },
    "title":"Properties"
}

A map of environment variables to set for the child process.

Nested Schema : Items

Type: array

Title: Items

An array of ordered command-line arguments to the target script.

Show Source

• Array of: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>An array of ordered command-line arguments to the target script.</p>"
}

Security

• Admin: basic
  Type: basic

  Description: A user in the Admin security role.
• Deployer: basic
  Type: basic

  Description: A user in the Deployer security role.

Back to Top

Response

201 Response

Back to Top