Jump to

• Request
• Response

GET A Create Form For This XML Entity Spec Registry Entry Collection

get

/management/weblogic/{version}/edit/XMLRegistries/{name}/XMLEntitySpecRegistryEntryCreateForm

This resource returns a pre-populated XML entity spec registry entry model that can be customized then posted (using the POST method) to the XMLEntitySpecRegistryEntries collection resource to create a new XML entity spec registry entry.

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 XML entity spec registry entry.

This method can return the following links:

• rel=create uri=/management/weblogic/{version}/edit/XMLRegistries/{name}/XMLEntitySpecRegistryEntries

  The collection resource for this create form resource.

Body ()

Root Schema : XML Entity Spec Registry Entry

Type: object

Show Source

• cacheTimeoutInterval(optional): integer(int32)
  Minimum Value: -1

  Default Value: -1

  Specifies the default timeout interval (in seconds) of the external entity cache.

  A value of -1 means that the entity cache timeout interval defers to the one specified for the XML registry of which this Entity Spec entry is a part.

• dynamicallyCreated(optional): boolean
  Read Only: true

  Default Value: false

  Return whether the MBean was created dynamically or is persisted to config.xml

• entityURI(optional): string

  The location of the external entity, either a pathname or URI.

  The location of the external entity can be either a pathname relative to the XML Registry directories, reachable by the Administration Server, or a URI of the entity location in some local repository.

• handleEntityInvalidation(optional): string
  Default Value: defer-to-registry-setting

  Allowed Values: [ "true", "false", "defer-to-registry-setting" ]

  Whether cached DTD/schema is invalidated when parsing error is encountered.

• id(optional): integer(int64)
  Read Only: true

  Return the unique id of this MBean instance

• name(optional): string
  Read Only: true

  The user-specified name of this MBean instance.

  This name is included as one of the key properties in the MBean's javax.management.ObjectName

  Name=user-specified-name

  Constraints

  • legal null
• notes(optional): string

  Optional information that you can include to describe this configuration.

  WebLogic Server saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the xml entity <. Carriage returns/line feeds are preserved.

  Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

• publicId(optional): string

  The public ID of the external entity.

  When WebLogic Server is parsing an XML document and it encounters an external entity with this public ID, WebLogic Server resolves the entity (to either a local file or a URL resource) according to the values set for this Entity spec entry.

• systemId(optional): string

  The system ID of the external entity.

  When WebLogic Server is parsing an XML document and it encounters an external entity with this system ID, WebLogic Server resolves the entity (to either a local file or a URL resource) according to the values set for this Entity spec entry.

• tags(optional): array Items
  Title: Items

  Return all tags on this Configuration MBean

• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable
• whenToCache(optional): string
  Default Value: defer-to-registry-setting

  Allowed Values: [ "cache-on-reference", "cache-at-initialization", "cache-never", "defer-to-registry-setting" ]

  Specifies when WebLogic Server should cache the external entities it retrieves from the Web.

  WebLogic Server can cache the entities when they are referenced, as soon as possible (that is, on initialization) or never. Additionally, WebLogic Server can defer to the XML registry's cache setting.

{
    "type":"object",
    "properties":{
        "cacheTimeoutInterval":{
            "default":-1,
            "minimum":-1,
            "type":"integer",
            "format":"int32",
            "description":"<p>Specifies the default timeout interval (in seconds) of the external entity cache.</p><p>A value of <code>-1</code> means that the entity cache timeout interval defers to the one specified for the XML registry of which this Entity Spec entry is a part.</p>"
        },
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p>"
        },
        "entityURI":{
            "type":"string",
            "description":"<p>The location of the external entity, either a pathname or URI.</p><p>The location of the external entity can be either a pathname relative to the XML Registry directories, reachable by the Administration Server, or a URI of the entity location in some local repository.</p>"
        },
        "handleEntityInvalidation":{
            "default":"defer-to-registry-setting",
            "enum":[
                "true",
                "false",
                "defer-to-registry-setting"
            ],
            "type":"string",
            "description":"<p>Whether cached DTD/schema is invalidated when parsing error is encountered.</p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The user-specified name of this MBean instance.</p><p>This name is included as one of the key properties in the MBean's <code>javax.management.ObjectName</code></p><p><code>Name=<i>user-specified-name</i></code></p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "notes":{
            "type":"string",
            "description":"<p>Optional information that you can include to describe this configuration.</p><p>WebLogic Server saves this note in the domain's configuration file (<code>config.xml</code>) as XML PCDATA. All left angle brackets (<) are converted to the XML entity <code>&lt;</code>. Carriage returns/line feeds are preserved.</p><p>Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.</p>"
        },
        "publicId":{
            "type":"string",
            "description":"<p>The public ID of the external entity.</p><p>When WebLogic Server is parsing an XML document and it encounters an external entity with this public ID, WebLogic Server resolves the entity (to either a local file or a URL resource) according to the values set for this Entity spec entry.</p>"
        },
        "systemId":{
            "type":"string",
            "description":"<p>The system ID of the external entity.</p><p>When WebLogic Server is parsing an XML document and it encounters an external entity with this system ID, WebLogic Server resolves the entity (to either a local file or a URL resource) according to the values set for this Entity spec entry.</p>"
        },
        "tags":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</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>"
        },
        "whenToCache":{
            "default":"defer-to-registry-setting",
            "enum":[
                "cache-on-reference",
                "cache-at-initialization",
                "cache-never",
                "defer-to-registry-setting"
            ],
            "type":"string",
            "description":"<p>Specifies when WebLogic Server should cache the external entities it retrieves from the Web.</p><p>WebLogic Server can cache the entities when they are referenced, as soon as possible (that is, on initialization) or never. Additionally, WebLogic Server can defer to the XML registry's cache setting.</p>"
        }
    },
    "description":""
}

Nested Schema : Items

Type: array

Title: Items

Return all tags on this Configuration MBean

Show Source

• Array of: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Return all tags on this Configuration MBean</p>"
}

Back to Top