Jump to

• Request
• Response

Get all Web Application definitions

get

/serviceapi/apm.dataserver/api/v1/webApps/getAll

Retrieve the list of configured Web Applications.

Request

Query Parameters

• filters(optional): string
  Specifies the attribute(s), operator and value, to filter on. For more information see the "filters" parameter.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Completed successfully, list may be empty. See Status Codes for information about other possible HTTP response status codes.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object WsWebApp

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/WsWebApp"
    }
}

Nested Schema : WsWebApp

Type: object

Show Source

• condition(optional): object WsCondition
• creator(optional): string
• description(optional): string
• enabled(optional): boolean
  Default Value: false
• mtime(optional): integer(int64)
• name(optional): string
• rules(optional): array rules
• system(optional): boolean
  Default Value: false

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "creator":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "mtime":{
            "type":"integer",
            "format":"int64"
        },
        "enabled":{
            "type":"boolean",
            "default":false
        },
        "condition":{
            "$ref":"#/definitions/WsCondition"
        },
        "rules":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/WsRule"
            }
        },
        "system":{
            "type":"boolean",
            "default":false
        }
    }
}

Nested Schema : WsCondition

Type: object

Show Source

• children(optional): array children
• group(optional): boolean
  Default Value: false
• id(optional): integer(int64)
• search(optional): string
• target(optional): string
• type(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64"
        },
        "type":{
            "type":"string"
        },
        "search":{
            "type":"string"
        },
        "target":{
            "type":"string"
        },
        "children":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/WsCondition"
            }
        },
        "group":{
            "type":"boolean",
            "default":false
        }
    }
}

Nested Schema : rules

Type: array

Show Source

• Array of: object WsRule

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/WsRule"
    }
}

Nested Schema : children

Type: array

Show Source

• Array of: object WsCondition

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/WsCondition"
    }
}

Nested Schema : WsRule

Type: object

Show Source

• argument(optional): string
• regexes(optional): array regexes
• source(optional): string
• target(optional): string

{
    "type":"object",
    "properties":{
        "source":{
            "type":"string"
        },
        "target":{
            "type":"string"
        },
        "argument":{
            "type":"string"
        },
        "regexes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/WsRegex"
            }
        }
    }
}

Nested Schema : regexes

Type: array

Show Source

• Array of: object WsRegex

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/WsRegex"
    }
}

Nested Schema : WsRegex

Type: object

Show Source

• description(optional): string
• replace(optional): string
• search(optional): string

{
    "type":"object",
    "properties":{
        "search":{
            "type":"string"
        },
        "replace":{
            "type":"string"
        },
        "description":{
            "type":"string"
        }
    }
}

Back to Top