GET api/Variable/ByName?sName={sName}

Request Information

URI Parameters

Name	Description	Type	Additional information
sName		string	Required

Body Parameters

None.

Response Information

Resource Description

Variable

Name	Type	Additional information
VariableId	string	None.
Name	string	None.
DisplayName	string	None.
DataType	DataType	None.
ODTerm	boolean	None.
HasPicklist	boolean	None.
Bands	Collection of Band	None.
AutoRules	Collection of AutoRule	None.

Response Formats

application/json, text/json

Sample:

{
  "VariableId": "sample string 1",
  "Name": "sample string 2",
  "DisplayName": "sample string 3",
  "DataType": "String",
  "ODTerm": true,
  "HasPicklist": true,
  "Bands": [
    {
      "Beg": "sample string 1",
      "End": "sample string 2",
      "Display": "sample string 3"
    },
    {
      "Beg": "sample string 1",
      "End": "sample string 2",
      "Display": "sample string 3"
    }
  ],
  "AutoRules": [
    {
      "SrcValue": "sample string 1",
      "DstName": "sample string 2",
      "Dstv1Value": "sample string 3",
      "Dstv2Value": "sample string 4"
    },
    {
      "SrcValue": "sample string 1",
      "DstName": "sample string 2",
      "Dstv1Value": "sample string 3",
      "Dstv2Value": "sample string 4"
    }
  ],
  "ImportName": "sample string 6",
  "v1Picklist": [
    "sample string 1",
    "sample string 2"
  ],
  "v2Picklist": [
    "sample string 1",
    "sample string 2"
  ],
  "ValidValues": [
    "sample string 1",
    "sample string 2"
  ],
  "Min": "sample string 7",
  "Max": "sample string 8",
  "Translates": [
    {
      "From": "sample string 1",
      "To": "sample string 2"
    },
    {
      "From": "sample string 1",
      "To": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<Variable xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="f1">
  <AutoRules>
    <AutoRule>
      <DstName>sample string 2</DstName>
      <Dstv1Value>sample string 3</Dstv1Value>
      <Dstv2Value>sample string 4</Dstv2Value>
      <SrcValue>sample string 1</SrcValue>
    </AutoRule>
    <AutoRule>
      <DstName>sample string 2</DstName>
      <Dstv1Value>sample string 3</Dstv1Value>
      <Dstv2Value>sample string 4</Dstv2Value>
      <SrcValue>sample string 1</SrcValue>
    </AutoRule>
  </AutoRules>
  <Bands>
    <Band>
      <Beg>sample string 1</Beg>
      <Display>sample string 3</Display>
      <End>sample string 2</End>
    </Band>
    <Band>
      <Beg>sample string 1</Beg>
      <Display>sample string 3</Display>
      <End>sample string 2</End>
    </Band>
  </Bands>
  <DataType>String</DataType>
  <DisplayName>sample string 3</DisplayName>
  <HasPicklist>true</HasPicklist>
  <Name>sample string 2</Name>
  <ODTerm>true</ODTerm>
  <VariableId>sample string 1</VariableId>
</Variable>