Jump to

• Request
• Response

Get Global configurations.

get

/connectedWorker/clientapi/v2/configurations

This operation retrieves the details of the Global configurations.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Global configurations were successfully retrieved.

Body ()

Root Schema : Configurations

Type: object

Show Source

• items: array items
• links(optional): array links
  Read Only: true

{
    "required":[
        "items"
    ],
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Configuration"
            }
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Configuration

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Configuration"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Configuration

Type: object

Show Source

• key: string
  Key that identifies the configuration item

  Example: my.key
• links(optional): array links
  Read Only: true
• value: object value
  Value of the configuration item. Supported types are boolean, double, string, array of doubles and array of strings

{
    "required":[
        "key",
        "value"
    ],
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "description":"Key that identifies the configuration item",
            "example":"my.key"
        },
        "value":{
            "type":"object",
            "description":"Value of the configuration item. Supported types are boolean, double, string, array of doubles and array of strings"
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : value

Type: object

Value of the configuration item. Supported types are boolean, double, string, array of doubles and array of strings

Nested Schema : Link

Type: object

Show Source

• href: string
  The target resource's URI
• rel: string
  Relation type

{
    "required":[
        "href",
        "rel"
    ],
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Relation type"
        },
        "href":{
            "type":"string",
            "description":"The target resource's URI"
        }
    }
}

Back to Top