Jump to

• Request
• Response

View This Deployment Progress Object

get

/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name}

View this deployment progress object.

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 deployment progress object.

This method can return the following links:

• rel=action title=cancel uri=/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name}/cancel

  This resource's cancel action resource.

• rel=action title=getExceptions uri=/management/weblogic/{version}/domainRuntime/deploymentManager/deploymentProgressObjects/{name}/getExceptions

  This resource's getExceptions action resource.

Body ()

Root Schema : Deployment Progress Object

Type: object

Show Source

• applicationName(optional): string
  Read Only: true

  The name of the application for the current deployment operation.

• completed(optional): boolean

  This property indicates whether an asynchronous job has completed.

• deploymentMessages(optional): array Items
  Title: Items

  Read Only: true

  Provides an ordered array of status messages generated for the current deployment operation.

• endTime(optional): 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
• failedTargets(optional): array Items
  Title: Items

  Read Only: true

  The targets on which the current deployment operation failed.

• id(optional): string
  Read Only: true

  The unique ID for the current deployment operation.

• name(optional): string
  Read Only: true

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

  Constraints

  • unharvestable
• operationType(optional): integer(int32)
  Read Only: true

  The deployment operation type for the current deployment operation. Possible values are 1 (start) and 2 (stop).

• progress(optional): string
  Allowed Values: [ "succeeded", "processing", "failed" ]

  This property indicates whether an asynchronous job has succeeded, failed, or is in progress.

• rootExceptions(optional): array Items
  Title: Items

  Read Only: true

  If the current deployment operation has failed, this method may return zero or more exception(s) which represent the root cause of the failure. The array will not contain WLS exception classes; instead they will be new Exceptions containing the stack traces and messages from the original WLS Exceptions.

• startTime(optional): 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(optional): integer(int64)
  Read Only: true

  The time that the current deployment operation began. The value is in milliseconds consistent with the system time.

• state(optional): string
  Read Only: true

  The state of the current deployment operation. Possible values are STATE_INITIALIZED, STATE_RUNNING, STATE_COMPLETED, STATE_FAILED and STATE_DEFERRED.

• targets(optional): array Items
  Title: Items

  Read Only: true

  The targets specified for the current deployment operation.

• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable

{
    "type":"object",
    "properties":{
        "applicationName":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The name of the application for the current deployment operation.</p>"
        },
        "completed":{
            "type":"boolean",
            "description":"<p>This property indicates whether an asynchronous job has completed.</p>"
        },
        "deploymentMessages":{
            "readOnly":true,
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Provides an ordered array of status messages generated for the current deployment operation.</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"
        },
        "failedTargets":{
            "readOnly":true,
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>The targets on which the current deployment operation failed.</p>"
        },
        "id":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The unique ID for the current deployment operation.</p>"
        },
        "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>"
        },
        "operationType":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The deployment operation type for the current deployment operation. Possible values are 1 (start) and 2 (stop).</p>"
        },
        "progress":{
            "enum":[
                "succeeded",
                "processing",
                "failed"
            ],
            "type":"string",
            "description":"<p>This property indicates whether an asynchronous job has succeeded, failed, or is in progress.</p>"
        },
        "rootExceptions":{
            "readOnly":true,
            "title":"Items",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Throwable"
            },
            "description":"<p>If the current deployment operation has failed, this method may return zero or more exception(s) which represent the root cause of the failure. The array will not contain WLS exception classes; instead they will be new Exceptions containing the stack traces and messages from the original WLS Exceptions.</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 that the current deployment operation began. The value is in milliseconds consistent with the system time.</p>"
        },
        "state":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The state of the current deployment operation. Possible values are STATE_INITIALIZED, STATE_RUNNING, STATE_COMPLETED, STATE_FAILED and STATE_DEFERRED.</p>"
        },
        "targets":{
            "readOnly":true,
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>The targets specified for the current deployment operation.</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 : Items

Type: array

Title: Items

Read Only: true

Provides an ordered array of status messages generated for the current deployment operation.

Show Source

• Array of: string

{
    "readOnly":true,
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Provides an ordered array of status messages generated for the current deployment operation.</p>"
}

Nested Schema : Items

Type: array

Title: Items

Read Only: true

The targets on which the current deployment operation failed.

Show Source

• Array of: string

{
    "readOnly":true,
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>The targets on which the current deployment operation failed.</p>"
}

Nested Schema : Items

Type: array

Title: Items

Read Only: true

If the current deployment operation has failed, this method may return zero or more exception(s) which represent the root cause of the failure. The array will not contain WLS exception classes; instead they will be new Exceptions containing the stack traces and messages from the original WLS Exceptions.

Show Source

• Array of: object Throwable

  Represents errors and exceptions.

{
    "readOnly":true,
    "title":"Items",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Throwable"
    },
    "description":"<p>If the current deployment operation has failed, this method may return zero or more exception(s) which represent the root cause of the failure. The array will not contain WLS exception classes; instead they will be new Exceptions containing the stack traces and messages from the original WLS Exceptions.</p>"
}

Nested Schema : Items

Type: array

Title: Items

Read Only: true

The targets specified for the current deployment operation.

Show Source

• Array of: string

{
    "readOnly":true,
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>The targets specified for the current deployment operation.</p>"
}

Nested Schema : Throwable

Type: object

Represents errors and exceptions.

Show Source

• cause(optional): object Throwable

  Represents errors and exceptions.

• message(optional): string

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

• state(optional): 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