Jump to

• Request
• Response

Modify This Singleton Service

post

/management/weblogic/{version}/edit/singletonServices/{name}

Modify this singleton service.

Request

Supported Media Types

• application/json

Path Parameters

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

Header Parameters

• X-Requested-By: string
  The 'X-Requested-By' header is used to protect against Cross-Site Request Forgery (CSRF) attacks. The value is an arbitrary name such as 'MyClient'.

Body ()

Must contain the modified singleton service model.

Root Schema : Singleton Service

Type: object

Show Source

• additionalMigrationAttempts(optional): integer(int32)
  Default Value: 2

  A migratable service could fail to come up on every possible configured server. This attribute controls how many further attempts, after the service has failed on every server at least once, should be tried. Note that each attempt specified here indicates another full circuit of migrations amongst all the configured servers. So for a 3-server cluster, and a value of 2, a total of 4 additional migrations will be attempted. (the original server is never a valid destination)

• allCandidateServers(optional): array Server References
  Title: Server References

  Contains the array of server references.

  Return a list of servers that are candidates to host the services deployed to this migratable target. If the ConstrainedCandidateServer list is empty, all servers in the cluster are returned. If the ConstrainedCandidateServer is not empty those servers only will be returned. The user preferred server will be the first element in the list returned.

• className(optional): string

  The fully qualified name of a class to load and run. The class must be on the server's classpath.

  For example, mycompany.mypackage.myclass

  Constraints

  • legal null
• cluster(optional): array Cluster Reference
  Title: Cluster Reference

  Contains the cluster reference.

  Returns the cluster this singleton service is associated with.

  Constraints

  • restart required
• constrainedCandidateServers(optional): array Server References
  Title: Server References

  Contains the array of server references.

  Returns the (user restricted) list of servers that may host the migratable target. The target will not be allowed to migrate to a server that is not in the returned list of servers. This feature is used to e.g. configure the two server that have access to a dual ported disk. All servers in this list must be part of the cluster that is associated with the migratable target.

  Constraints

  • restart required
• dynamicallyCreated(optional): boolean
  Read Only: true

  Default Value: false

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

• hostingServer(optional): array Server Reference
  Title: Server Reference

  Read Only: true

  Contains the server reference.

  Returns the name of the server that currently hosts the singleton service.

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

  Return the unique id of this MBean instance

• millisToSleepBetweenAttempts(optional): integer(int32)
  Default Value: 300000

  Controls how long of a pause there should be between the migration attempts described in getAdditionalMigrationAttempts(). Note that this delay only happens when the service has failed to come up on every server. It does not cause any sort of delay between attempts to migrate otherwise.

• 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.

• 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
• userPreferredServer(optional): array Server Reference
  Title: Server Reference

  Contains the server reference.

  Returns the server that the user prefers the singleton service to be active on.

{
    "type":"object",
    "properties":{
        "additionalMigrationAttempts":{
            "default":2,
            "type":"integer",
            "format":"int32",
            "description":"<p>A migratable service could fail to come up on every possible configured server. This attribute controls how many further attempts, after the service has failed on every server at least once, should be tried. Note that each attempt specified here indicates another full circuit of migrations amongst all the configured servers. So for a 3-server cluster, and a value of 2, a total of 4 additional migrations will be attempted. (the original server is never a valid destination)</p>"
        },
        "allCandidateServers":{
            "title":"Server References",
            "type":"array",
            "items":{
                "title":"Server Reference",
                "type":"object",
                "properties":{
                    "identity":{
                        "title":"Identity",
                        "type":"array",
                        "items":{
                            "type":"string",
                            "description":""
                        },
                        "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
                    }
                },
                "description":"Contains the server reference."
            },
            "description":"Contains the array of server references. <p>Return a list of servers that are candidates to host the services deployed to this migratable target. If the ConstrainedCandidateServer list is empty, all servers in the cluster are returned. If the ConstrainedCandidateServer is not empty those servers only will be returned. The user preferred server will be the first element in the list returned.</p>"
        },
        "className":{
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The fully qualified name of a class to load and run. The class must be on the server's classpath.</p><p>For example, <code>mycompany.mypackage.myclass</code></p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "cluster":{
            "x-weblogic-restartRequired":true,
            "title":"Cluster Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the cluster reference. <p>Returns the cluster this singleton service is associated with.</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
        },
        "constrainedCandidateServers":{
            "x-weblogic-restartRequired":true,
            "title":"Server References",
            "type":"array",
            "items":{
                "title":"Server Reference",
                "type":"object",
                "properties":{
                    "identity":{
                        "title":"Identity",
                        "type":"array",
                        "items":{
                            "type":"string",
                            "description":""
                        },
                        "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
                    }
                },
                "description":"Contains the server reference."
            },
            "description":"Contains the array of server references. <p>Returns the (user restricted) list of servers that may host the migratable target. The target will not be allowed to migrate to a server that is not in the returned list of servers. This feature is used to e.g. configure the two server that have access to a dual ported disk. All servers in this list must be part of the cluster that is associated with the migratable target.</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
        },
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p>"
        },
        "hostingServer":{
            "readOnly":true,
            "title":"Server Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the server reference. <p>Returns the name of the server that currently hosts the singleton service.</p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p>"
        },
        "millisToSleepBetweenAttempts":{
            "default":300000,
            "type":"integer",
            "format":"int32",
            "description":"<p>Controls how long of a pause there should be between the migration attempts described in getAdditionalMigrationAttempts(). Note that this delay only happens when the service has failed to come up on every server. It does not cause any sort of delay between attempts to migrate otherwise.</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>"
        },
        "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>"
        },
        "userPreferredServer":{
            "title":"Server Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the server reference. <p>Returns the server that the user prefers the singleton service to be active on.</p>"
        }
    },
    "description":""
}

Nested Schema : Server References

Type: array

Title: Server References

Contains the array of server references.

Return a list of servers that are candidates to host the services deployed to this migratable target. If the ConstrainedCandidateServer list is empty, all servers in the cluster are returned. If the ConstrainedCandidateServer is not empty those servers only will be returned. The user preferred server will be the first element in the list returned.

Show Source

• Array of: object Server Reference
  Title: Server Reference

  Contains the server reference.

{
    "title":"Server References",
    "type":"array",
    "items":{
        "title":"Server Reference",
        "type":"object",
        "properties":{
            "identity":{
                "title":"Identity",
                "type":"array",
                "items":{
                    "type":"string",
                    "description":""
                },
                "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
            }
        },
        "description":"Contains the server reference."
    },
    "description":"Contains the array of server references. <p>Return a list of servers that are candidates to host the services deployed to this migratable target. If the ConstrainedCandidateServer list is empty, all servers in the cluster are returned. If the ConstrainedCandidateServer is not empty those servers only will be returned. The user preferred server will be the first element in the list returned.</p>"
}

Nested Schema : Cluster Reference

Type: array

Title: Cluster Reference

Contains the cluster reference.

Returns the cluster this singleton service is associated with.

Constraints

• restart required

Show Source

• Array of: string

{
    "x-weblogic-restartRequired":true,
    "title":"Cluster Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the cluster reference. <p>Returns the cluster this singleton service is associated with.</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
}

Nested Schema : Server References

Type: array

Title: Server References

Contains the array of server references.

Returns the (user restricted) list of servers that may host the migratable target. The target will not be allowed to migrate to a server that is not in the returned list of servers. This feature is used to e.g. configure the two server that have access to a dual ported disk. All servers in this list must be part of the cluster that is associated with the migratable target.

Constraints

• restart required

Show Source

• Array of: object Server Reference
  Title: Server Reference

  Contains the server reference.

{
    "x-weblogic-restartRequired":true,
    "title":"Server References",
    "type":"array",
    "items":{
        "title":"Server Reference",
        "type":"object",
        "properties":{
            "identity":{
                "title":"Identity",
                "type":"array",
                "items":{
                    "type":"string",
                    "description":""
                },
                "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
            }
        },
        "description":"Contains the server reference."
    },
    "description":"Contains the array of server references. <p>Returns the (user restricted) list of servers that may host the migratable target. The target will not be allowed to migrate to a server that is not in the returned list of servers. This feature is used to e.g. configure the two server that have access to a dual ported disk. All servers in this list must be part of the cluster that is associated with the migratable target.</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
}

Nested Schema : Server Reference

Type: array

Title: Server Reference

Read Only: true

Contains the server reference.

Returns the name of the server that currently hosts the singleton service.

Show Source

• Array of: string

{
    "readOnly":true,
    "title":"Server Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the server reference. <p>Returns the name of the server that currently hosts the singleton service.</p>"
}

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>"
}

Nested Schema : Server Reference

Type: array

Title: Server Reference

Contains the server reference.

Returns the server that the user prefers the singleton service to be active on.

Show Source

• Array of: string

{
    "title":"Server Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the server reference. <p>Returns the server that the user prefers the singleton service to be active on.</p>"
}

Nested Schema : Server Reference

Type: object

Title: Server Reference

Contains the server reference.

Show Source

• identity(optional): array Identity
  Title: Identity

  DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.

{
    "title":"Server Reference",
    "type":"object",
    "properties":{
        "identity":{
            "title":"Identity",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
        }
    },
    "description":"Contains the server reference."
}

Nested Schema : Identity

Type: array

Title: Identity

DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.

Show Source

• Array of: string

{
    "title":"Identity",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
}

Nested Schema : Server Reference

Type: object

Title: Server Reference

Contains the server reference.

Show Source

• identity(optional): array Identity
  Title: Identity

  DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.

{
    "title":"Server Reference",
    "type":"object",
    "properties":{
        "identity":{
            "title":"Identity",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
        }
    },
    "description":"Contains the server reference."
}

Nested Schema : Identity

Type: array

Title: Identity

DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.

Show Source

• Array of: string

{
    "title":"Identity",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
}

Security

• Admin: basic
  Type: basic

  Description: A user in the Admin security role.

Back to Top

Response

200 Response

Back to Top