Jump to

• Request
• Response

View This Connector Component Runtime

get

/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/connectorServiceRuntime/RAs/{name}/connectorServiceRuntime/inactiveRAs/{name}

View this connector component runtime.

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 connector component runtime.

This method can return the following links:

• rel=action title=getConfiguration uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/connectorServiceRuntime/RAs/{name}/connectorServiceRuntime/inactiveRAs/{name}/getConfiguration

  This resource's getConfiguration action resource.

• rel=action title=getConnectionPool uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/connectorServiceRuntime/RAs/{name}/connectorServiceRuntime/inactiveRAs/{name}/getConnectionPool

  This resource's getConnectionPool action resource.

• rel=action title=getInboundConnection uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/connectorServiceRuntime/RAs/{name}/connectorServiceRuntime/inactiveRAs/{name}/getInboundConnection

  This resource's getInboundConnection action resource.

• rel=action title=getSchema uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/connectorServiceRuntime/RAs/{name}/connectorServiceRuntime/inactiveRAs/{name}/getSchema

  This resource's getSchema action resource.

• rel=action title=resume uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/connectorServiceRuntime/RAs/{name}/connectorServiceRuntime/inactiveRAs/{name}/resume

  This resource's resume action resource.

• rel=action title=resumeAll uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/connectorServiceRuntime/RAs/{name}/connectorServiceRuntime/inactiveRAs/{name}/resumeAll

  This resource's resumeAll action resource.

• rel=action title=suspend uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/connectorServiceRuntime/RAs/{name}/connectorServiceRuntime/inactiveRAs/{name}/suspend

  This resource's suspend action resource.

• rel=action title=suspendAll uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/connectorServiceRuntime/RAs/{name}/connectorServiceRuntime/inactiveRAs/{name}/suspendAll

  This resource's suspendAll action resource.

• rel=connectionPools uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/connectorServiceRuntime/RAs/{name}/connectorServiceRuntime/inactiveRAs/{name}/connectionPools

  This resource's connectionPools collection resource.

• rel=connectorServiceRuntime uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/connectorServiceRuntime/RAs/{name}/connectorServiceRuntime/inactiveRAs/{name}/connectorServiceRuntime

  This resource's connectorServiceRuntime singleton resource.

• rel=connectorWorkManagerRuntime uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/connectorServiceRuntime/RAs/{name}/connectorServiceRuntime/inactiveRAs/{name}/connectorWorkManagerRuntime

  This resource's connectorWorkManagerRuntime singleton resource.

• rel=inboundConnections uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/connectorServiceRuntime/RAs/{name}/connectorServiceRuntime/inactiveRAs/{name}/inboundConnections

  This resource's inboundConnections collection resource.

• rel=workManagerRuntime uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/connectorServiceRuntime/RAs/{name}/connectorServiceRuntime/inactiveRAs/{name}/workManagerRuntime

  This resource's workManagerRuntime singleton resource.

• rel=workManagerRuntimes uri=/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/connectorServiceRuntime/RAs/{name}/connectorServiceRuntime/inactiveRAs/{name}/workManagerRuntimes

  This resource's workManagerRuntimes collection resource.

Body ()

Root Schema : Connector Component Runtime

Type: object

Show Source

• activeVersion(optional): boolean
  Read Only: true

  Return true if this version is the active version. Returns true if this resource adapter is not versioned.

• activeVersionId(optional): string
  Read Only: true

  Get the active version Id.

• componentName(optional): string
  Read Only: true

  Get the name of the connector component.

  Constraints

  • unharvestable
• configuration(optional): string
  Read Only: true

  Return the xml string representing the RA configuration. The xml corresponding to the latest schema is returned. The current supported version is "1.0"

  Constraints

  • unharvestable
• configurationVersion(optional): string
  Read Only: true

  Return the latest configuration version.

• configuredProperties(optional): object Properties
  Title: Properties

  Read Only: true

  Additional Properties Allowed: additionalProperties

  Gets a subset of the resource adapter descriptor information.

• connectionPoolCount(optional): integer(int32)
  Read Only: true

  The number of connection pools.

• deploymentState(optional): integer(int32)
  Read Only: true

  The current deployment state of the module.

  A module can be in one and only one of the following states. State can be changed via deployment or administrator console.

  • UNPREPARED. State indicating at this module is neither prepared or active.

  • PREPARED. State indicating at this module of this application is prepared, but not active. The classes have been loaded and the module has been validated.

  • ACTIVATED. State indicating at this module is currently active.

  • NEW. State indicating this module has just been created and is being initialized.

• description(optional): string
  Read Only: true

  Get the Description for the resource adapter.

  Constraints

  • unharvestable
• descriptions(optional): array Items
  Title: Items

  Read Only: true

  Get the Descriptions for the resource adapter.

  Constraints

  • unharvestable
• EISResourceId(optional): string
  Read Only: true

  Returns the EISResourceId for the component.

  Constraints

  • unharvestable
• EISType(optional): string
  Read Only: true

  Get the EIS type.

  Constraints

  • unharvestable
• healthState(optional): object Health State

  Represents the health of the services that are in a WebLogic server domain. Selected subsystems within each WebLogic Server instance monitor their health status based on criteria specific to the subsystem.

• inboundConnectionsCount(optional): integer(int32)
  Read Only: true

  The number of inbound connections for the resource adapter.

• jndiName(optional): string
  Read Only: true

  Get the Jndi name of the resource adapter.

  Constraints

  • unharvestable
• linkref(optional): string
  Read Only: true

  Get the linkref.

  Constraints

  • unharvestable
• moduleId(optional): string
  Read Only: true

  Returns the identifier for this Component. The identifier is unique within the application.

  Typical modules will use the URI for their id. Web Modules will return their context-root since the web-uri may not be unique within an EAR.

  Constraints

  • unharvestable
• name(optional): string
  Read Only: true

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

  Constraints

  • unharvestable
• schema(optional): string
  Read Only: true

  Get the latest schema for RA configuration.

  Constraints

  • unharvestable
• specVersion(optional): string
  Read Only: true

  Get the spec version.

  Constraints

  • unharvestable
• state(optional): string
  Read Only: true

  Get the state of the resource adapter.

• suspendedState(optional): integer(int32)
  Read Only: true

  Gets the suspended state information of the resource adapter.

  If getState() returns SUSPENDED then getSuspendedState() returns an integer describing which functions of the resource adapter are suspended: one or more of INBOUND, OUTBOUND or WORK (or ALL) or 0 for nothing suspended

• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable
• vendorName(optional): string
  Read Only: true

  Get the vendor name.

  Constraints

  • unharvestable
• version(optional): string
  Read Only: true

  Get the version.

  Constraints

  • unharvestable
• versioned(optional): boolean
  Read Only: true

  Check if the resource adapter is versioned. Returns true if it is.

• versionId(optional): string
  Read Only: true

  Get the version Id.

{
    "type":"object",
    "properties":{
        "EISResourceId":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Returns the EISResourceId for the component.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "EISType":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Get the EIS type.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "activeVersion":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Return true if this version is the active version. Returns true if this resource adapter is not versioned.</p>"
        },
        "activeVersionId":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Get the active version Id.</p>"
        },
        "componentName":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Get the name of the connector component.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "configuration":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Return the xml string representing the RA configuration. The xml corresponding to the latest schema is returned. The current supported version is \"1.0\"</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "configurationVersion":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Return the latest configuration version.</p>"
        },
        "configuredProperties":{
            "readOnly":true,
            "type":"object",
            "description":"<p> Gets a subset of the resource adapter descriptor information. </p>",
            "additionalProperties":{
                "type":"string"
            },
            "title":"Properties"
        },
        "connectionPoolCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The number of connection pools.</p>"
        },
        "deploymentState":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The current deployment state of the module.</p><p>A module can be in one and only one of the following states. State can be changed via deployment or administrator console.</p><ul><li><p>UNPREPARED. State indicating at this  module is neither  prepared or active.</p></li><li><p>PREPARED. State indicating at this module of this application is prepared, but not active. The classes have been loaded and the module has been validated.</p></li><li><p>ACTIVATED. State indicating at this module  is currently active.</p></li><li><p>NEW. State indicating this module has just been created and is being initialized.</p></li></ul>"
        },
        "description":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Get the Description for the resource adapter.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "descriptions":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Get the Descriptions for the resource adapter.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "healthState":{
            "readOnly":true,
            "$ref":"#/definitions/Health State"
        },
        "inboundConnectionsCount":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The number of inbound connections for the resource adapter.</p>"
        },
        "jndiName":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Get the Jndi name of the resource adapter.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "linkref":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Get the linkref.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "moduleId":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Returns the identifier for this Component.  The identifier is unique within the application.</p><p>Typical modules will use the URI for their id.  Web Modules will return their context-root since the web-uri may not be unique within an EAR.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "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>"
        },
        "schema":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Get the latest schema for RA configuration.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "specVersion":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Get the spec version.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "state":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Get the state of the resource adapter.</p>"
        },
        "suspendedState":{
            "readOnly":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>Gets the suspended state information of the resource adapter.</p><p>If getState() returns SUSPENDED then getSuspendedState() returns an integer describing which functions of the resource adapter are suspended: one or more of INBOUND, OUTBOUND or WORK (or ALL) or 0 for nothing suspended</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>"
        },
        "vendorName":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Get the vendor name.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "version":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Get the version.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "versionId":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Get the version Id.</p>"
        },
        "versioned":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Check if the resource adapter is versioned. Returns true if it is.</p>"
        }
    },
    "description":""
}

Nested Schema : Properties

Type: object

Title: Properties

Read Only: true

Additional Properties Allowed

Show Source

• string

{
    "readOnly":true,
    "type":"object",
    "description":"<p> Gets a subset of the resource adapter descriptor information. </p>",
    "additionalProperties":{
        "type":"string"
    },
    "title":"Properties"
}

Gets a subset of the resource adapter descriptor information.

Nested Schema : Items

Type: array

Title: Items

Read Only: true

Get the Descriptions for the resource adapter.

Constraints

• unharvestable

Show Source

• Array of: string

{
    "readOnly":true,
    "x-weblogic-unharvestable":true,
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Get the Descriptions for the resource adapter.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
}

Nested Schema : Health State

Type: object

Represents the health of the services that are in a WebLogic server domain. Selected subsystems within each WebLogic Server instance monitor their health status based on criteria specific to the subsystem.

Show Source

• partitionName(optional): string

  This property indicates the partition name for which the health state is reported.

• state(optional): string

  This property indicates the reported state as:

  • OK - Service is healthy.

  • WARN - Service could have problems in the future

  • CRITICAL - Something must be done now to prevent service failure

  • FAILED - Service has failed and must be restarted

  • OVERLOADED - Service is functioning normally but there is too much work in it

  • UNKNOWN - Service state cannot be determined

• subsystemName(optional): string

  This property indicates the service for which the health state is reported.

• symptoms(optional): array Items
  Title: Items

  This property indicates the cause of the reported state.

{
    "type":"object",
    "properties":{
        "partitionName":{
            "type":"string",
            "description":"<p>This property indicates the partition name for which the health state is reported.</p>"
        },
        "state":{
            "type":"string",
            "description":"<p>This property indicates the reported state as:</p><ul><li><p>OK - Service is healthy.</p></li><li><p>WARN -  Service could have problems in the future</p></li><li><p>CRITICAL - Something must be done now to prevent service failure</p></li><li><p>FAILED - Service has failed and must be restarted</p></li><li><p>OVERLOADED -  Service is functioning normally but there is too much work in it</p></li><li><p>UNKNOWN - Service state cannot be determined</p></li></ul>"
        },
        "subsystemName":{
            "type":"string",
            "description":"<p>This property indicates the service for which the health state is reported.</p>"
        },
        "symptoms":{
            "title":"Items",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Symptom"
            },
            "description":"<p>This property indicates the cause of the reported state.</p>"
        }
    },
    "description":"<p>Represents the health of the services that are in a WebLogic server domain. Selected subsystems within each WebLogic Server instance monitor their health status based on criteria specific to the subsystem.</p>"
}

Nested Schema : Items

Type: array

Title: Items

This property indicates the cause of the reported state.

Show Source

• Array of: object Symptom

  Represents an observation reported by a service with its health state. A symptom can be used to determine the reason for the current health state of a WebLogic server.

{
    "title":"Items",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Symptom"
    },
    "description":"<p>This property indicates the cause of the reported state.</p>"
}

Nested Schema : Symptom

Type: object

Represents an observation reported by a service with its health state. A symptom can be used to determine the reason for the current health state of a WebLogic server.

Show Source

• info(optional): string

  This property provides additional information about the symptom if available.

• instanceId(optional): string

  This property represents an identifier for the symptom.

• severity(optional): string

  This property indicates a low, medium, or high severity level.

• type(optional): string

  This property represents the cause of the symptom (low memory, network error, stuck threads, and so on).

{
    "type":"object",
    "properties":{
        "info":{
            "type":"string",
            "description":"<p>This property provides additional information about the symptom if available.</p>"
        },
        "instanceId":{
            "type":"string",
            "description":"<p>This property represents an identifier for the symptom.</p>"
        },
        "severity":{
            "type":"string",
            "description":"<p>This property indicates a low, medium, or high severity level.</p>"
        },
        "type":{
            "type":"string",
            "description":"<p>This property represents the cause of the symptom (low memory, network error, stuck threads, and so on).</p>"
        }
    },
    "description":"<p>Represents an observation reported by a service with its health state. A symptom can be used to determine the reason for the current health state of a WebLogic server.</p>"
}

Back to Top