Jump to

• Request
• Response

View This No SQL Resource

get

/management/weblogic/{version}/domainConfig/noSQLSystemResources/{name}/noSQLResource

View this no SQL resource.

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 no SQL resource.

This method can return the following links:

• rel=properties uri=/management/weblogic/{version}/domainConfig/noSQLSystemResources/{name}/noSQLResource/properties

  This resource's properties singleton resource.

Body ()

Root Schema : No SQL Resource

Type: object

Show Source

• databaseType: string
  Default Value: DOCUMENT

  Allowed Values: [ "DOCUMENT", "KEY_VALUE", "COLUMN", "GRAPH" ]

  Returns the provider-neutral Jakarta Data database type for this resource.

  The legal values identify database types that may be supported by providers installed in the domain. A legal descriptor value does not imply that every provider supports that type. When a resource is targeted, WebLogic validates the selected provider and database-type combination. Provider capabilities and available WebLogic managed runtime implementations are validated separately.

• defaultResource: boolean

  Returns whether this resource is eligible for default selection when a Jakarta NoSQL-backed repository omits dataStore.

  Default selection requires exactly one valid, locally targeted resource explicitly bound to the application and marked as a default.

  This setting does not establish an application binding or grant authorization.

• JNDIName: string

  Returns the JNDI name assigned to this NoSQL resource.

• name: string
  Read Only: true

  Returns the unique name that identifies this NoSQL resource in the WebLogic domain.

• providerName: string
  Allowed Values: [ "oracle-nosql", "mongodb", "dynamodb", "couchbase", "couchdb", "elasticsearch", "solr" ]

  Returns the name of the NoSQL provider used by this resource.

{
    "type":"object",
    "properties":{
        "JNDIName":{
            "type":"string",
            "description":"<p>Returns the JNDI name assigned to this NoSQL resource.</p>"
        },
        "databaseType":{
            "default":"DOCUMENT",
            "enum":[
                "DOCUMENT",
                "KEY_VALUE",
                "COLUMN",
                "GRAPH"
            ],
            "type":"string",
            "description":"<p>Returns the provider-neutral Jakarta Data database type for this resource.  </p><p>The legal values identify database types that may be supported by providers installed in the domain. A legal descriptor value does not imply that every provider supports that type. When a resource is targeted, WebLogic validates the selected provider and database-type combination. Provider capabilities and available WebLogic managed runtime implementations are validated separately.</p>"
        },
        "defaultResource":{
            "type":"boolean",
            "description":"<p>Returns whether this resource is eligible for default selection when a Jakarta NoSQL-backed repository omits <code>dataStore</code>.  </p><p>Default selection requires exactly one valid, locally targeted resource explicitly bound to the application and marked as a default.</p><p>This setting does not establish an application binding or grant authorization.</p>"
        },
        "name":{
            "readOnly":true,
            "type":"string",
            "description":"<p>Returns the unique name that identifies this NoSQL resource in the WebLogic domain.</p>"
        },
        "providerName":{
            "enum":[
                "oracle-nosql",
                "mongodb",
                "dynamodb",
                "couchbase",
                "couchdb",
                "elasticsearch",
                "solr"
            ],
            "type":"string",
            "description":"<p>Returns the name of the NoSQL provider used by this resource.</p>"
        }
    },
    "description":""
}

Back to Top