Jump to

• Request
• Response

View This System Component Life Cycle Task Runtime

get

/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}

View this system component life cycle task runtime.

Request

Path Parameters

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

Query Parameters

• excludeFields: 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: 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: 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: 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 system component life cycle task runtime.

This method can return the following links:

• rel=action title=cancel uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/cancel

  This resource's cancel action resource.

• rel=parentTask

  This resource's parentTask reference to a task runtime resource.

• rel=subTasks uri=/management/weblogic/{version}/domainRuntime/systemComponentLifeCycleRuntimes/{name}/tasks/{name}/subTasks

  This resource's subTasks collection resource.

Body ()

Root Schema : System Component Life Cycle Task Runtime

Type: object

Show Source

• completed: boolean

  This property indicates whether an asynchronous job has completed.

• description: string
  Read Only: true

  A description of this task.

• endTime: string(date-time)

  This property indicates the time when the asynchronous job ended.

  This value represents a date as a string in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSXXX
• name: string
  Read Only: true

  The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

  Constraints

  • unharvestable
• operation: string
  Read Only: true

  Gets the name of the method that was invoked on the ServerLifeCycleRuntime to initiate this task.

• parentTask: array Task Runtime Reference
  Title: Task Runtime Reference

  Read Only: true

  Contains the task runtime reference.

  The task of which this task is a part.

  A value of null indicates that this task is not a subtask.

• progress: string
  Read Only: true

  The progress of this task.

• running: boolean
  Read Only: true

  Indicates whether the task is still running.

• serverName: string
  Read Only: true

  The name of the server.

• startTime: string(date-time)

  This property indicates the time when an asynchronous job was started.

  This value represents a date as a string in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSXXX
• startTimeAsLong: integer(int64)
  Read Only: true

  The time at which this task was started.

• systemTask: boolean
  Read Only: true

  Indicates whether this task was initiated by the server versus a user.

• taskError: object Throwable

  Represents errors and exceptions.

• taskStatus: string
  Read Only: true

  The status of this task.

• type: string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable

{
    "type":"object",
    "properties":{
        "completed":{
            "type":"boolean",
            "description":"<p>This property indicates whether an asynchronous job has completed.</p>"
        },
        "description":{
            "readOnly":true,
            "type":"string",
            "description":"<p>A description of this task.</p>"
        },
        "endTime":{
            "type":"string",
            "format":"date-time",
            "description":"<p>This property indicates the time when the asynchronous job ended.</p> This value represents a date as a string in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSXXX"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "operation":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Gets the name of the method that was invoked on the ServerLifeCycleRuntime to initiate this task.</p>"
        },
        "parentTask":{
            "readOnly":true,
            "title":"Task Runtime Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the task runtime reference. <p>The task of which this task is a part.</p><p>A value of <code>null</code> indicates that this task is not a subtask.</p>"
        },
        "progress":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The progress of this task.</p>"
        },
        "running":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates whether the task is still running.</p>"
        },
        "serverName":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The name of the server.</p>"
        },
        "startTime":{
            "type":"string",
            "format":"date-time",
            "description":"<p>This property indicates the time when an asynchronous job was started.</p> This value represents a date as a string in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSXXX"
        },
        "startTimeAsLong":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The time at which this task was started.</p>"
        },
        "systemTask":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates whether this task was initiated by the server versus a user.</p>"
        },
        "taskError":{
            "readOnly":true,
            "$ref":"#/definitions/Throwable"
        },
        "taskStatus":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The status of this task.</p>"
        },
        "type":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Returns the type of the MBean.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        }
    },
    "description":""
}

Nested Schema : Task Runtime Reference

Type: array

Title: Task Runtime Reference

Read Only: true

Contains the task runtime reference.

The task of which this task is a part.

A value of null indicates that this task is not a subtask.

Show Source

• Array of: string

{
    "readOnly":true,
    "title":"Task Runtime Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the task runtime reference. <p>The task of which this task is a part.</p><p>A value of <code>null</code> indicates that this task is not a subtask.</p>"
}

Nested Schema : Throwable

Type: object

Represents errors and exceptions.

Show Source

• cause: object Throwable

  Represents errors and exceptions.

• message: string

  This property contains the reason why the error or exception was thrown.

• state: string

{
    "type":"object",
    "properties":{
        "cause":{
            "$ref":"#/definitions/Throwable"
        },
        "message":{
            "type":"string",
            "description":"<p>This property contains the reason why the error or exception was thrown.</p>"
        },
        "state":{
            "type":"string",
            "description":""
        }
    },
    "description":"<p>Represents errors and exceptions.</p>"
}

Back to Top