View.SetFields
  • 14 May 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

View.SetFields

  • Dark
    Light
  • PDF

Article summary

Description

Sets the fields that are included in the view and their order.
To setup a view for a collection click here.

URL parameters

URL parameter ordering

The URL parameters below are listed in the order they should be entered in the API URL.

NameRequiredTypeDescription
ViewIDTruenumericUnique identifier of the view.
FieldsFalsestringComma-separated list of field names to be included in the view.

Responses

NameTypeDescription
ResultstringSuccess if the operation was successful.

Sample request

curl -X GET "https://api.mozenda.com/rest?WebServiceKey=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&Service=Mozenda10&Operation=View.SetFields&ViewID=1111&Fields=Season,TVTitle"

Sample responses

XML

<?xml version="1.0" encoding="utf-8" ?>
<ViewSetFieldsResponse
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<Result>Success</Result>
</ViewSetFieldsResponse>

JSON (add &ResponseFormat=JSON)

{
  "JsonResult": {
    "Command": "View.SetFields",
    "AutoLoggedIn": false,
    "WebConsoleKey": "",
    "Result": "Success",
    "ErrorCode": "",
    "ErrorDescription": "",
    "ErrorList": [],
    "ExecutionTime": {
      "Ticks": 0,
      "Days": 0,
      "Hours": 0,
      "Milliseconds": 0,
      "Minutes": 0,
      "Seconds": 0,
      "TotalDays": 0,
      "TotalHours": 0,
      "TotalMilliseconds": 0,
      "TotalMinutes": 0,
      "TotalSeconds": 0
    }
  }
}

Was this article helpful?