PUT api/widget/{id}/variable

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

string

Required

Body Parameters

WidgetVariable
NameDescriptionTypeAdditional information
WidgetVariableId

integer

None.

WidgetId

integer

None.

VariableName

string

None.

VariableCodeName

string

None.

VariableDescription

string

None.

WidgetVariableType

VariableType

None.

VariableOrder

integer

None.

VariableActive

integer

None.

VariableActiveDate

date

None.

WidgetVariableOptions

Collection of WidgetVariableOption

None.

Request Formats

application/json, text/json

Sample:
{
  "WidgetVariableId": 1,
  "WidgetId": 2,
  "VariableName": "sample string 3",
  "VariableCodeName": "sample string 4",
  "VariableDescription": "sample string 5",
  "WidgetVariableType": {
    "VariableTypeId": 1,
    "VariableTypeName": "sample string 2",
    "VariableTypeCodeName": "sample string 3",
    "VariableTypeDescription": "sample string 4",
    "VariableValueType": "sample string 5",
    "VariableTypeActive": 6,
    "VariableTypeActiveDate": "2020-04-01T16:02:38.9094712-05:00"
  },
  "VariableOrder": 6,
  "VariableActive": 7,
  "VariableActiveDate": "2020-04-01T16:02:38.9094712-05:00",
  "WidgetVariableOptions": [
    {
      "WidgetVariableOptionId": 1,
      "WidgetVariableId": 2,
      "WidgetVariableOptionName": "sample string 3",
      "WidgetVariableOptionValue": "sample string 4",
      "WidgetVariableOptionValueNumber": 5.1,
      "WidgetVariableOptionOrder": 6
    },
    {
      "WidgetVariableOptionId": 1,
      "WidgetVariableId": 2,
      "WidgetVariableOptionName": "sample string 3",
      "WidgetVariableOptionValue": "sample string 4",
      "WidgetVariableOptionValueNumber": 5.1,
      "WidgetVariableOptionOrder": 6
    }
  ]
}

text/html

Sample:
{"WidgetVariableId":1,"WidgetId":2,"VariableName":"sample string 3","VariableCodeName":"sample string 4","VariableDescription":"sample string 5","WidgetVariableType":{"VariableTypeId":1,"VariableTypeName":"sample string 2","VariableTypeCodeName":"sample string 3","VariableTypeDescription":"sample string 4","VariableValueType":"sample string 5","VariableTypeActive":6,"VariableTypeActiveDate":"2020-04-01T16:02:38.9094712-05:00"},"VariableOrder":6,"VariableActive":7,"VariableActiveDate":"2020-04-01T16:02:38.9094712-05:00","WidgetVariableOptions":[{"WidgetVariableOptionId":1,"WidgetVariableId":2,"WidgetVariableOptionName":"sample string 3","WidgetVariableOptionValue":"sample string 4","WidgetVariableOptionValueNumber":5.1,"WidgetVariableOptionOrder":6},{"WidgetVariableOptionId":1,"WidgetVariableId":2,"WidgetVariableOptionName":"sample string 3","WidgetVariableOptionValue":"sample string 4","WidgetVariableOptionValueNumber":5.1,"WidgetVariableOptionOrder":6}]}

application/xml, text/xml

Sample:
<WidgetVariable xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FeedFlowAPI.Models.Out">
  <VariableActive>7</VariableActive>
  <VariableActiveDate>2020-04-01T16:02:38.9094712-05:00</VariableActiveDate>
  <VariableCodeName>sample string 4</VariableCodeName>
  <VariableDescription>sample string 5</VariableDescription>
  <VariableName>sample string 3</VariableName>
  <VariableOrder>6</VariableOrder>
  <WidgetId>2</WidgetId>
  <WidgetVariableId>1</WidgetVariableId>
  <WidgetVariableOptions>
    <WidgetVariableOption>
      <WidgetVariableId>2</WidgetVariableId>
      <WidgetVariableOptionId>1</WidgetVariableOptionId>
      <WidgetVariableOptionName>sample string 3</WidgetVariableOptionName>
      <WidgetVariableOptionOrder>6</WidgetVariableOptionOrder>
      <WidgetVariableOptionValue>sample string 4</WidgetVariableOptionValue>
      <WidgetVariableOptionValueNumber>5.1</WidgetVariableOptionValueNumber>
    </WidgetVariableOption>
    <WidgetVariableOption>
      <WidgetVariableId>2</WidgetVariableId>
      <WidgetVariableOptionId>1</WidgetVariableOptionId>
      <WidgetVariableOptionName>sample string 3</WidgetVariableOptionName>
      <WidgetVariableOptionOrder>6</WidgetVariableOptionOrder>
      <WidgetVariableOptionValue>sample string 4</WidgetVariableOptionValue>
      <WidgetVariableOptionValueNumber>5.1</WidgetVariableOptionValueNumber>
    </WidgetVariableOption>
  </WidgetVariableOptions>
  <WidgetVariableType>
    <VariableTypeActive>6</VariableTypeActive>
    <VariableTypeActiveDate>2020-04-01T16:02:38.9094712-05:00</VariableTypeActiveDate>
    <VariableTypeCodeName>sample string 3</VariableTypeCodeName>
    <VariableTypeDescription>sample string 4</VariableTypeDescription>
    <VariableTypeId>1</VariableTypeId>
    <VariableTypeName>sample string 2</VariableTypeName>
    <VariableValueType>sample string 5</VariableValueType>
  </WidgetVariableType>
</WidgetVariable>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'WidgetVariable'.

Response Information

Resource Description

Collection of WidgetVariable
NameDescriptionTypeAdditional information
WidgetVariableId

integer

None.

WidgetId

integer

None.

VariableName

string

None.

VariableCodeName

string

None.

VariableDescription

string

None.

WidgetVariableType

VariableType

None.

VariableOrder

integer

None.

VariableActive

integer

None.

VariableActiveDate

date

None.

WidgetVariableOptions

Collection of WidgetVariableOption

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "WidgetVariableId": 1,
    "WidgetId": 2,
    "VariableName": "sample string 3",
    "VariableCodeName": "sample string 4",
    "VariableDescription": "sample string 5",
    "WidgetVariableType": {
      "VariableTypeId": 1,
      "VariableTypeName": "sample string 2",
      "VariableTypeCodeName": "sample string 3",
      "VariableTypeDescription": "sample string 4",
      "VariableValueType": "sample string 5",
      "VariableTypeActive": 6,
      "VariableTypeActiveDate": "2020-04-01T16:02:38.9114712-05:00"
    },
    "VariableOrder": 6,
    "VariableActive": 7,
    "VariableActiveDate": "2020-04-01T16:02:38.9114712-05:00",
    "WidgetVariableOptions": [
      {
        "WidgetVariableOptionId": 1,
        "WidgetVariableId": 2,
        "WidgetVariableOptionName": "sample string 3",
        "WidgetVariableOptionValue": "sample string 4",
        "WidgetVariableOptionValueNumber": 5.1,
        "WidgetVariableOptionOrder": 6
      },
      {
        "WidgetVariableOptionId": 1,
        "WidgetVariableId": 2,
        "WidgetVariableOptionName": "sample string 3",
        "WidgetVariableOptionValue": "sample string 4",
        "WidgetVariableOptionValueNumber": 5.1,
        "WidgetVariableOptionOrder": 6
      }
    ]
  },
  {
    "WidgetVariableId": 1,
    "WidgetId": 2,
    "VariableName": "sample string 3",
    "VariableCodeName": "sample string 4",
    "VariableDescription": "sample string 5",
    "WidgetVariableType": {
      "VariableTypeId": 1,
      "VariableTypeName": "sample string 2",
      "VariableTypeCodeName": "sample string 3",
      "VariableTypeDescription": "sample string 4",
      "VariableValueType": "sample string 5",
      "VariableTypeActive": 6,
      "VariableTypeActiveDate": "2020-04-01T16:02:38.9114712-05:00"
    },
    "VariableOrder": 6,
    "VariableActive": 7,
    "VariableActiveDate": "2020-04-01T16:02:38.9114712-05:00",
    "WidgetVariableOptions": [
      {
        "WidgetVariableOptionId": 1,
        "WidgetVariableId": 2,
        "WidgetVariableOptionName": "sample string 3",
        "WidgetVariableOptionValue": "sample string 4",
        "WidgetVariableOptionValueNumber": 5.1,
        "WidgetVariableOptionOrder": 6
      },
      {
        "WidgetVariableOptionId": 1,
        "WidgetVariableId": 2,
        "WidgetVariableOptionName": "sample string 3",
        "WidgetVariableOptionValue": "sample string 4",
        "WidgetVariableOptionValueNumber": 5.1,
        "WidgetVariableOptionOrder": 6
      }
    ]
  }
]

text/html

Sample:
[{"WidgetVariableId":1,"WidgetId":2,"VariableName":"sample string 3","VariableCodeName":"sample string 4","VariableDescription":"sample string 5","WidgetVariableType":{"VariableTypeId":1,"VariableTypeName":"sample string 2","VariableTypeCodeName":"sample string 3","VariableTypeDescription":"sample string 4","VariableValueType":"sample string 5","VariableTypeActive":6,"VariableTypeActiveDate":"2020-04-01T16:02:38.9114712-05:00"},"VariableOrder":6,"VariableActive":7,"VariableActiveDate":"2020-04-01T16:02:38.9114712-05:00","WidgetVariableOptions":[{"WidgetVariableOptionId":1,"WidgetVariableId":2,"WidgetVariableOptionName":"sample string 3","WidgetVariableOptionValue":"sample string 4","WidgetVariableOptionValueNumber":5.1,"WidgetVariableOptionOrder":6},{"WidgetVariableOptionId":1,"WidgetVariableId":2,"WidgetVariableOptionName":"sample string 3","WidgetVariableOptionValue":"sample string 4","WidgetVariableOptionValueNumber":5.1,"WidgetVariableOptionOrder":6}]},{"WidgetVariableId":1,"WidgetId":2,"VariableName":"sample string 3","VariableCodeName":"sample string 4","VariableDescription":"sample string 5","WidgetVariableType":{"VariableTypeId":1,"VariableTypeName":"sample string 2","VariableTypeCodeName":"sample string 3","VariableTypeDescription":"sample string 4","VariableValueType":"sample string 5","VariableTypeActive":6,"VariableTypeActiveDate":"2020-04-01T16:02:38.9114712-05:00"},"VariableOrder":6,"VariableActive":7,"VariableActiveDate":"2020-04-01T16:02:38.9114712-05:00","WidgetVariableOptions":[{"WidgetVariableOptionId":1,"WidgetVariableId":2,"WidgetVariableOptionName":"sample string 3","WidgetVariableOptionValue":"sample string 4","WidgetVariableOptionValueNumber":5.1,"WidgetVariableOptionOrder":6},{"WidgetVariableOptionId":1,"WidgetVariableId":2,"WidgetVariableOptionName":"sample string 3","WidgetVariableOptionValue":"sample string 4","WidgetVariableOptionValueNumber":5.1,"WidgetVariableOptionOrder":6}]}]

application/xml, text/xml

Sample:
<ArrayOfWidgetVariable xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FeedFlowAPI.Models.Out">
  <WidgetVariable>
    <VariableActive>7</VariableActive>
    <VariableActiveDate>2020-04-01T16:02:38.9114712-05:00</VariableActiveDate>
    <VariableCodeName>sample string 4</VariableCodeName>
    <VariableDescription>sample string 5</VariableDescription>
    <VariableName>sample string 3</VariableName>
    <VariableOrder>6</VariableOrder>
    <WidgetId>2</WidgetId>
    <WidgetVariableId>1</WidgetVariableId>
    <WidgetVariableOptions>
      <WidgetVariableOption>
        <WidgetVariableId>2</WidgetVariableId>
        <WidgetVariableOptionId>1</WidgetVariableOptionId>
        <WidgetVariableOptionName>sample string 3</WidgetVariableOptionName>
        <WidgetVariableOptionOrder>6</WidgetVariableOptionOrder>
        <WidgetVariableOptionValue>sample string 4</WidgetVariableOptionValue>
        <WidgetVariableOptionValueNumber>5.1</WidgetVariableOptionValueNumber>
      </WidgetVariableOption>
      <WidgetVariableOption>
        <WidgetVariableId>2</WidgetVariableId>
        <WidgetVariableOptionId>1</WidgetVariableOptionId>
        <WidgetVariableOptionName>sample string 3</WidgetVariableOptionName>
        <WidgetVariableOptionOrder>6</WidgetVariableOptionOrder>
        <WidgetVariableOptionValue>sample string 4</WidgetVariableOptionValue>
        <WidgetVariableOptionValueNumber>5.1</WidgetVariableOptionValueNumber>
      </WidgetVariableOption>
    </WidgetVariableOptions>
    <WidgetVariableType>
      <VariableTypeActive>6</VariableTypeActive>
      <VariableTypeActiveDate>2020-04-01T16:02:38.9114712-05:00</VariableTypeActiveDate>
      <VariableTypeCodeName>sample string 3</VariableTypeCodeName>
      <VariableTypeDescription>sample string 4</VariableTypeDescription>
      <VariableTypeId>1</VariableTypeId>
      <VariableTypeName>sample string 2</VariableTypeName>
      <VariableValueType>sample string 5</VariableValueType>
    </WidgetVariableType>
  </WidgetVariable>
  <WidgetVariable>
    <VariableActive>7</VariableActive>
    <VariableActiveDate>2020-04-01T16:02:38.9114712-05:00</VariableActiveDate>
    <VariableCodeName>sample string 4</VariableCodeName>
    <VariableDescription>sample string 5</VariableDescription>
    <VariableName>sample string 3</VariableName>
    <VariableOrder>6</VariableOrder>
    <WidgetId>2</WidgetId>
    <WidgetVariableId>1</WidgetVariableId>
    <WidgetVariableOptions>
      <WidgetVariableOption>
        <WidgetVariableId>2</WidgetVariableId>
        <WidgetVariableOptionId>1</WidgetVariableOptionId>
        <WidgetVariableOptionName>sample string 3</WidgetVariableOptionName>
        <WidgetVariableOptionOrder>6</WidgetVariableOptionOrder>
        <WidgetVariableOptionValue>sample string 4</WidgetVariableOptionValue>
        <WidgetVariableOptionValueNumber>5.1</WidgetVariableOptionValueNumber>
      </WidgetVariableOption>
      <WidgetVariableOption>
        <WidgetVariableId>2</WidgetVariableId>
        <WidgetVariableOptionId>1</WidgetVariableOptionId>
        <WidgetVariableOptionName>sample string 3</WidgetVariableOptionName>
        <WidgetVariableOptionOrder>6</WidgetVariableOptionOrder>
        <WidgetVariableOptionValue>sample string 4</WidgetVariableOptionValue>
        <WidgetVariableOptionValueNumber>5.1</WidgetVariableOptionValueNumber>
      </WidgetVariableOption>
    </WidgetVariableOptions>
    <WidgetVariableType>
      <VariableTypeActive>6</VariableTypeActive>
      <VariableTypeActiveDate>2020-04-01T16:02:38.9114712-05:00</VariableTypeActiveDate>
      <VariableTypeCodeName>sample string 3</VariableTypeCodeName>
      <VariableTypeDescription>sample string 4</VariableTypeDescription>
      <VariableTypeId>1</VariableTypeId>
      <VariableTypeName>sample string 2</VariableTypeName>
      <VariableValueType>sample string 5</VariableValueType>
    </WidgetVariableType>
  </WidgetVariable>
</ArrayOfWidgetVariable>