POST api/Configuration/AddCustomTab

Add Custom Tab Udfs are added separately Only accessible by Administrative Users

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
RequestTabId	integer	None.
RequestTabName	string	None.
RequestTabDescription	string	None.
IconFile	string	None.
ImageId	integer	None.
ContactEmailAddress	string	None.
NotifyWhenUtilized	boolean	None.
AdditionalEmailAddress	string	None.
PageHeader	string	None.
PageFooter	string	None.
CustomTabType	integer	None.
UdfList	Collection of Udf	None.

Request Formats

application/json, text/json

Sample:

{
  "RequestTabId": 1,
  "RequestTabName": "sample string 2",
  "RequestTabDescription": "sample string 3",
  "IconFile": "sample string 4",
  "ImageId": 1,
  "ContactEmailAddress": "sample string 5",
  "NotifyWhenUtilized": true,
  "AdditionalEmailAddress": "sample string 7",
  "PageHeader": "sample string 8",
  "PageFooter": "sample string 9",
  "CustomTabType": 10,
  "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
    }
  ]
}

application/xml, text/xml

Sample:

<CustomTab xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RSMCP.Entities">
  <AdditionalEmailAddress>sample string 7</AdditionalEmailAddress>
  <ContactEmailAddress>sample string 5</ContactEmailAddress>
  <CustomTabType>10</CustomTabType>
  <IconFile>sample string 4</IconFile>
  <ImageId>1</ImageId>
  <NotifyWhenUtilized>true</NotifyWhenUtilized>
  <PageFooter>sample string 9</PageFooter>
  <PageHeader>sample string 8</PageHeader>
  <RequestTabDescription>sample string 3</RequestTabDescription>
  <RequestTabId>1</RequestTabId>
  <RequestTabName>sample string 2</RequestTabName>
  <UdfList>
    <Udf>
      <AdminOnly>true</AdminOnly>
      <DefaultQuery>sample string 6</DefaultQuery>
      <DisplayOrder>9</DisplayOrder>
      <EntryId>19</EntryId>
      <Id>1</Id>
      <InputType>8</InputType>
      <Name>sample string 2</Name>
      <ParentUdfId>16</ParentUdfId>
      <RequestTabId>18</RequestTabId>
      <Required>true</Required>
      <Searchable>true</Searchable>
      <ShowOnEvents>true</ShowOnEvents>
      <SpecialNotes>sample string 7</SpecialNotes>
      <Type>17</Type>
      <UdfTypeDescription>sample string 13</UdfTypeDescription>
      <UdfTypeId>12</UdfTypeId>
      <UdfValue>sample string 4</UdfValue>
      <UdfValue2>sample string 5</UdfValue2>
      <Value>sample string 3</Value>
    </Udf>
    <Udf>
      <AdminOnly>true</AdminOnly>
      <DefaultQuery>sample string 6</DefaultQuery>
      <DisplayOrder>9</DisplayOrder>
      <EntryId>19</EntryId>
      <Id>1</Id>
      <InputType>8</InputType>
      <Name>sample string 2</Name>
      <ParentUdfId>16</ParentUdfId>
      <RequestTabId>18</RequestTabId>
      <Required>true</Required>
      <Searchable>true</Searchable>
      <ShowOnEvents>true</ShowOnEvents>
      <SpecialNotes>sample string 7</SpecialNotes>
      <Type>17</Type>
      <UdfTypeDescription>sample string 13</UdfTypeDescription>
      <UdfTypeId>12</UdfTypeId>
      <UdfValue>sample string 4</UdfValue>
      <UdfValue2>sample string 5</UdfValue2>
      <Value>sample string 3</Value>
    </Udf>
  </UdfList>
</CustomTab>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.