Get Operator

Retrieves a specific comparison operator.

Request

Retrieve a comparison operator via the following request:

HTTP Method	Request URI
GET	https://api.vdms.io/report-builder/v1/operations/Operator ID

Define the following variables when submitting the above request:

VariableA variable represents a value that must be replaced. A variable consists of either a URL segment (e.g., "0001" in /0001/) or a query string value (e.g., "3" in mediaTypes=3).	Description
Operator ID	Replace this variable with the system-defined ID of the desired comparison operator. Use the Get All Operators endpoint to retrieve a list of comparison operators and their system-defined IDs.

Request Headers

This endpointIdentifies a request's connection point to our REST API service. only takes advantage of common request headers.

Unlike requests to api.edgecast.com, requests to our API gateway (api.vdms.io) require an access token (OAuth).

Request Body

Request body parameters are not required by this endpoint.

Response

The response to the above request includes an HTTP status code, response headers, and a response body.

Status Code

A status code indicates whether the request was successfully performed.

Response Headers

The response for this endpoint only includes standard HTTP response headers.

View common response headers.

Response Body

The response body for a successful request contains the following response elements:

Name	Data Type	Description
@id	String	Indicates the relative path to an endpoint through which you may retrieve the current comparison operator.
@type	String	Returns Operation.
description	String	Describes the purpose of the current comparison operator.
field_types	Array of String Values	Indicates the data types that are supported by this comparison operator. A comparison operator may only be leveraged with dimensions whose data type is listed within this array.
friendly_name	String	Identifies the comparison operator by its friendly name.
id	String	Identifies the comparison operator by its system-defined ID.
multi_value	Boolean	Determines whether the comparison operator supports multiple values. true: The comparison operator supports one or more values. The data type for a filter's value is an array of number or string values. The type of array is determined by the dimension's field_type property. false | missing: The comparison operator only supports a single value. The data type for a filter's value is solely determined by the dimension's field_type property.
name	String	Identifies the comparison operator by its friendly name.

Errors

The response body for an unsuccessful request will contain an error response that provides additional information.

Sample Request and Response

A sample JSON request is shown below.

A sample JSON response is shown below.

{
	"@id": "/report-builder/v1/operations/equals",
	"@type": "Operation",
	"description": "Performs the Equals operation",
	"field_types": ["number", "date_time", "string"],
	"friendly_name": "Equals",
	"id": "equals",
	"name": "Equals"
}