Amster

HttpClient

Realm Operations

Resource path:

/realm-config/services/httpclient

Resource version: 2.0

create

Usage

am> create HttpClient --realm Realm --body body

Parameters

--body

The resource in JSON format, described by the following JSON schema:

{
  "type" : "object",
  "properties" : {
    "core" : {
      "type" : "object",
      "title" : "Configuration",
      "propertyOrder" : 0,
      "properties" : {
        "enabled" : {
          "title" : "Enabled",
          "description" : "Enables or disables this Http Client Service. If disabled, the Http Client instances defined within this service will not be usable. Http requests will instead be made using the default Http Client instance, which is configured using the Server Advanced properties for http client connections.",
          "propertyOrder" : 1,
          "required" : true,
          "type" : "boolean",
          "exampleValue" : ""
        }
      }
    }
  }
}

delete

Usage

am> delete HttpClient --realm Realm

getAllTypes

Obtain the collection of all secondary configuration types related to the resource.

Usage

am> action HttpClient --realm Realm --actionName getAllTypes

getCreatableTypes

Obtain the collection of secondary configuration types that have yet to be added to the resource.

Usage

am> action HttpClient --realm Realm --actionName getCreatableTypes

nextdescendents

Obtain the collection of secondary configuration instances that have been added to the resource.

Usage

am> action HttpClient --realm Realm --actionName nextdescendents

read

Usage

am> read HttpClient --realm Realm

update

Usage

am> update HttpClient --realm Realm --body body

Parameters

--body

The resource in JSON format, described by the following JSON schema:

{
  "type" : "object",
  "properties" : {
    "core" : {
      "type" : "object",
      "title" : "Configuration",
      "propertyOrder" : 0,
      "properties" : {
        "enabled" : {
          "title" : "Enabled",
          "description" : "Enables or disables this Http Client Service. If disabled, the Http Client instances defined within this service will not be usable. Http requests will instead be made using the default Http Client instance, which is configured using the Server Advanced properties for http client connections.",
          "propertyOrder" : 1,
          "required" : true,
          "type" : "boolean",
          "exampleValue" : ""
        }
      }
    }
  }
}