Amster

HttpClientService

Global Operations

Resource path:

/global-config/services/httpclient

Resource version: 1.0

getAllTypes

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

Usage

am> action HttpClientService --global --actionName getAllTypes

getCreatableTypes

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

Usage

am> action HttpClientService --global --actionName getCreatableTypes

nextdescendents

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

Usage

am> action HttpClientService --global --actionName nextdescendents

read

Usage

am> read HttpClientService --global

update

Usage

am> update HttpClientService --global --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" : ""
        }
      }
    },
    "defaults" : {
      "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" : ""
            }
          }
        }
      },
      "type" : "object",
      "title" : "Realm Defaults"
    }
  }
}