HTTP Protocol

Created on June 21, 2022

HTTP Protocol details that will be used when Protocol=”HTTP”.

Example:

"HTTP": {
        "URL": "https://some.example.url/",
        "Compression": "None",
        "Method": "POST",
        "RequestURIParameter": [{
            "Name": "profileName",
            "Reference": "Profile.Name"
        }, {
            "Name": "reportVersion",
            "Reference": "Profile.Version"
        }]
    }

HTTP Protocol Properties

Property

Type

Required

URLstringRequired
CompressionstringRequired
MethodstringRequired
RequestURIParameterarrayOptional

URL

The URL to which the generated report should be uploaded.

URL

  • is required
  • Type: string


Compression

Compression scheme to be used in the generated report.

NOTE: Only “None” is currently supported in Telemetry 2.0.

Compression

  • is required
  • Type: string

Compression Constraints

enum: the value of this property must be equal to one of the following values:

Value

Explanation

"None"No compression is applied to the report data.


Method

HTTP method to be used to upload the generated report.

NOTE: Only “POST” is currently supported in Telemetry 2.0.

Method

  • is required
  • Type: string

Method Constraints

enum: the value of this property must be equal to one of the following values:

Value

Explanation

"POST"
"PUT"


RequestURIParameter

Optional query parameters to be included in the report’s upload to HTTP URL.

RequestURIParameter

  • is optional
  • Type: object[]

RequestURIParameter Type

object[] (Details)


Go To Top