Jump to

• Request
• Response

GET A Create Form For This WLDF Script Action Collection

get

/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/WLDFSystemResources/{name}/WLDFResource/watchNotification/scriptActionCreateForm

This resource returns a pre-populated WLDF script action model that can be customized then posted (using the POST method) to the scriptActions collection resource to create a new WLDF script action.

Request

Path Parameters

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

Query Parameters

• excludeFields(optional): string
  The 'excludeFields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields whose name is not on the list will be returned. If not present, all fields are returned (unless the 'fields' query parameter is specified). Note: 'fields' must not be specified if 'excludeFields' is specified.
• excludeLinks(optional): string
  The 'excludeLinks' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links whose relationship name is not on the list will be returned. If not present, all links are returned (unless the 'links' query parameter is specified). Note: 'links' must not be specified if 'excludeLinks' is specified.
• fields(optional): string
  The 'fields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields with matching names are returned. If not present, all fields are returned (unless the 'excludeFields' query parameter is specified). Note: 'excludeFields' must not be specified if 'fields' is specified.
• links(optional): string
  The 'links' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links with matching relationship names are returned. If not present, all links are returned (unless the 'excludeLinks' query parameter is specified). Note: 'excludeLinks' must not be specified if 'links' is specified.

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.
• Monitor: basic
  Type: basic

  Description: A user in the Monitor security role.
• Operator: basic
  Type: basic

  Description: A user in the Operator security role.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns this WLDF script action.

This method can return the following links:

• rel=create uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/WLDFSystemResources/{name}/WLDFResource/watchNotification/scriptActions

  The collection resource for this create form resource.

Body ()

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>"
}

Back to Top