PUT api/Configuration/AddUdfsToCustomTab

Add Udfs to Custom Tab Only accessible by Administrative Users Invalid Udf Ids are ignored

Request Information

URI Parameters

None.

Body Parameters

UdfCustomTabObject
NameDescriptionTypeAdditional information
udfList

Collection of Udf

None.

requestTabId

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "udfList": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Value": "sample string 3",
      "UdfValue": "sample string 4",
      "UdfValue2": "sample string 5",
      "DefaultQuery": "sample string 6",
      "SpecialNotes": "sample string 7",
      "InputType": 8,
      "DisplayOrder": 9,
      "Required": true,
      "AdminOnly": true,
      "UdfTypeId": 12,
      "UdfTypeDescription": "sample string 13",
      "ShowOnEvents": true,
      "Searchable": true,
      "ParentUdfId": 16,
      "Type": 17,
      "RequestTabId": 18,
      "EntryId": 19
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Value": "sample string 3",
      "UdfValue": "sample string 4",
      "UdfValue2": "sample string 5",
      "DefaultQuery": "sample string 6",
      "SpecialNotes": "sample string 7",
      "InputType": 8,
      "DisplayOrder": 9,
      "Required": true,
      "AdminOnly": true,
      "UdfTypeId": 12,
      "UdfTypeDescription": "sample string 13",
      "ShowOnEvents": true,
      "Searchable": true,
      "ParentUdfId": 16,
      "Type": 17,
      "RequestTabId": 18,
      "EntryId": 19
    }
  ],
  "requestTabId": 1
}

application/xml, text/xml

Sample:
<ConfigurationController.UdfCustomTabObject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RSMCP.RESTApi.Controllers">
  <requestTabId>1</requestTabId>
  <udfList xmlns:d2p1="http://schemas.datacontract.org/2004/07/RSMCP.Entities">
    <d2p1:Udf>
      <d2p1:AdminOnly>true</d2p1:AdminOnly>
      <d2p1:DefaultQuery>sample string 6</d2p1:DefaultQuery>
      <d2p1:DisplayOrder>9</d2p1:DisplayOrder>
      <d2p1:EntryId>19</d2p1:EntryId>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:InputType>8</d2p1:InputType>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:ParentUdfId>16</d2p1:ParentUdfId>
      <d2p1:RequestTabId>18</d2p1:RequestTabId>
      <d2p1:Required>true</d2p1:Required>
      <d2p1:Searchable>true</d2p1:Searchable>
      <d2p1:ShowOnEvents>true</d2p1:ShowOnEvents>
      <d2p1:SpecialNotes>sample string 7</d2p1:SpecialNotes>
      <d2p1:Type>17</d2p1:Type>
      <d2p1:UdfTypeDescription>sample string 13</d2p1:UdfTypeDescription>
      <d2p1:UdfTypeId>12</d2p1:UdfTypeId>
      <d2p1:UdfValue>sample string 4</d2p1:UdfValue>
      <d2p1:UdfValue2>sample string 5</d2p1:UdfValue2>
      <d2p1:Value>sample string 3</d2p1:Value>
    </d2p1:Udf>
    <d2p1:Udf>
      <d2p1:AdminOnly>true</d2p1:AdminOnly>
      <d2p1:DefaultQuery>sample string 6</d2p1:DefaultQuery>
      <d2p1:DisplayOrder>9</d2p1:DisplayOrder>
      <d2p1:EntryId>19</d2p1:EntryId>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:InputType>8</d2p1:InputType>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:ParentUdfId>16</d2p1:ParentUdfId>
      <d2p1:RequestTabId>18</d2p1:RequestTabId>
      <d2p1:Required>true</d2p1:Required>
      <d2p1:Searchable>true</d2p1:Searchable>
      <d2p1:ShowOnEvents>true</d2p1:ShowOnEvents>
      <d2p1:SpecialNotes>sample string 7</d2p1:SpecialNotes>
      <d2p1:Type>17</d2p1:Type>
      <d2p1:UdfTypeDescription>sample string 13</d2p1:UdfTypeDescription>
      <d2p1:UdfTypeId>12</d2p1:UdfTypeId>
      <d2p1:UdfValue>sample string 4</d2p1:UdfValue>
      <d2p1:UdfValue2>sample string 5</d2p1:UdfValue2>
      <d2p1:Value>sample string 3</d2p1:Value>
    </d2p1:Udf>
  </udfList>
</ConfigurationController.UdfCustomTabObject>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.