Get Dimension

Retrieves a specific dimension.

Request

Retrieve a dimension via the following request:

HTTP Method	Request URI
GET	https://api.vdms.io/report-builder/v1/dimensions/Dimension 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
Dimension	Replace this variable with the system-defined ID of the desired dimension. Use the Get All Dimensions endpoint to retrieve a list of dimensions 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 dimension.
@type	String	Returns Dimension.
description	String	Describes the purpose of the current dimension.
field_type	String	Indicates the dimension's data type.
groups	Array of String Values	Reserved for future use.
id	String	Identifies the dimension by its system-defined ID.
name	String	Identifies the dimension 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/dimensions/time",
	"@type": "Dimension",
	"description": "The time of the request",
	"field_type": "date_time",
	"groups": [
		"default",
		"url"
	],
	"id": "time",
	"name": "Time"
}