UrlAlias

Short name or alias of a url. It is used to represent the url.

JSON Example

{
    "alias": "string",
    "keystore_info": {
        "keystore": "string",
        "keystore_alias": "string",
        "keystore_phrase": "string",
        "truststore": "string"
    },
    "query": "string",
    "request_body": {},
    "request_headers": {},
    "request_method": "string",
    "url": "string"
}

string

alias

Optional

Constraints: maxLength: 255

Short name or alias of url, if any. If not specified, the url can be referenced by its index in the array of urls of the datasource instance as $ (for example, $0).

KeyStoreInfo

keystore_info

Optional

Key Store information about the url alias or datasource.

string

query

Optional

Constraints: maxLength: 1024

Search query to be applied, if any. If query string is not provided, it will be ignored.

object

request_body

Optional

A raw request body in the form json format for a given url. This request body will be submitted along with request while giving a post api call.

object

request_headers

Optional

A raw request header in the form json format for a given url. This request header will be submitted along with request while giving a api call.

string

request_method

Optional

Constraints: default: Get

Type of the http method (Get, Post) to be used while invoking the given url through dashboard datasource framework.

Possible values are : Get, Post,

string

url

Required

Constraints: maxLength: 1024

Url to fetch data from.

Property Of

Datasource