View.GetFields

Prev Next

Description

Gets the fields that are included in the view.

URL parameters

Name Required Type Description
ViewID True numeric Unique identifier of the view.

Responses

Name Type Description
Result string Success 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"

Sample responses

XML

<?xml version="1.0" encoding="utf-8"?>
<ViewGetFieldsResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <Result>Success</Result>
    <FieldList>
        <Field>
            <FieldID>35606</FieldID>
            <Name>ItemID</Name>
            <Description>A unique number that identifies the item.</Description>
            <Format>Number</Format>
            <IsSystem>True</IsSystem>
            <IsUnique>False</IsUnique>
            <IsWatched>False</IsWatched>
        </Field>
        <Field>
            <FieldID>35609</FieldID>
            <Name>Number</Name>
            <Description/>
            <Format>Text</Format>
            <IsSystem>False</IsSystem>
            <IsUnique>False</IsUnique>
            <IsWatched>False</IsWatched>
        </Field>
    </FieldList>
</ViewGetFieldsResponse>

JSON (add &ResponseFormat=JSON)

{
  "Field": [
    {
      "FieldID": 35606,
      "Name": "ItemID",
      "Description": "A unique number that identifies the item.",
      "Format": "Number",
      "IsSystem": true,
      "IsUnique": false,
      "IsWatched": false
    },
    {
      "FieldID": 35609,
      "Name": "Number",
      "Description": "",
      "Format": "Text",
      "IsSystem": false,
      "IsUnique": false,
      "IsWatched": false
    }
  ],
  "JsonResult": {
    "Command": "View.GetFields",
    "AutoLoggedIn": false,
    "WebConsoleKey": "",
    "Result": "Success",
    "ErrorCode": "",
    "ErrorDescription": "",
    "ErrorList": []
  }
}