POST api/Companies/{companyId}/Udfs

Request Information

URI Parameters

Name	Description	Type	Additional information
companyId		integer	Required

Body Parameters

UdfTransfer

Name	Type	Additional information
UDFList	Collection of UdfContext	None.
CompanyId	integer	None.
TableId	string	None.
Udfs	string	None.
Id	integer	None.
CreatedDate	date	None.
CreatedBy	string	None.
UpdateDate	date	None.
UpdatedBy	string	None.
IsActive	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "UDFList": [
    {
      "TableId": "sample string 1",
      "Name": "sample string 2",
      "Description": "sample string 3",
      "FieldType": "sample string 4",
      "Values": "sample string 5",
      "MappedValues": [
        {
          "Value": "sample string 1",
          "Description": "sample string 2",
          "IsActive": true
        },
        {
          "Value": "sample string 1",
          "Description": "sample string 2",
          "IsActive": true
        }
      ],
      "DataSource": "sample string 6",
      "TargetToOverride": "sample string 7",
      "PostTransactionObject": "sample string 8",
      "IsActive": true,
      "IsRequired": true,
      "IsRendered": true,
      "IsTypehead": true,
      "FieldID": 13,
      "HeaderId": 1,
      "LinesId": 1,
      "DescriptionLines": "sample string 14"
    },
    {
      "TableId": "sample string 1",
      "Name": "sample string 2",
      "Description": "sample string 3",
      "FieldType": "sample string 4",
      "Values": "sample string 5",
      "MappedValues": [
        {
          "Value": "sample string 1",
          "Description": "sample string 2",
          "IsActive": true
        },
        {
          "Value": "sample string 1",
          "Description": "sample string 2",
          "IsActive": true
        }
      ],
      "DataSource": "sample string 6",
      "TargetToOverride": "sample string 7",
      "PostTransactionObject": "sample string 8",
      "IsActive": true,
      "IsRequired": true,
      "IsRendered": true,
      "IsTypehead": true,
      "FieldID": 13,
      "HeaderId": 1,
      "LinesId": 1,
      "DescriptionLines": "sample string 14"
    }
  ],
  "CompanyId": 1,
  "TableId": "sample string 2",
  "Udfs": "sample string 3",
  "Id": 4,
  "CreatedDate": "2025-04-03T20:49:42.962171-06:00",
  "CreatedBy": "sample string 6",
  "UpdateDate": "2025-04-03T20:49:42.962171-06:00",
  "UpdatedBy": "sample string 7",
  "IsActive": true
}

application/xml, text/xml

Sample:

<UdfTransfer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.Udf">
  <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 6</CreatedBy>
  <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-04-03T20:49:42.962171-06:00</CreatedDate>
  <Id xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">4</Id>
  <IsActive xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">true</IsActive>
  <UpdateDate xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">2025-04-03T20:49:42.962171-06:00</UpdateDate>
  <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.PresentationEntities">sample string 7</UpdatedBy>
  <CompanyId>1</CompanyId>
  <TableId>sample string 2</TableId>
  <Udfs>sample string 3</Udfs>
  <UDFList>
    <UdfContext>
      <DataSource>sample string 6</DataSource>
      <Description>sample string 3</Description>
      <DescriptionLines>sample string 14</DescriptionLines>
      <FieldID>13</FieldID>
      <FieldType>sample string 4</FieldType>
      <HeaderId>1</HeaderId>
      <IsActive>true</IsActive>
      <IsRendered>true</IsRendered>
      <IsRequired>true</IsRequired>
      <IsTypehead>true</IsTypehead>
      <LinesId>1</LinesId>
      <MappedValues>
        <UdfInvoke>
          <Description>sample string 2</Description>
          <IsActive>true</IsActive>
          <Value>sample string 1</Value>
        </UdfInvoke>
        <UdfInvoke>
          <Description>sample string 2</Description>
          <IsActive>true</IsActive>
          <Value>sample string 1</Value>
        </UdfInvoke>
      </MappedValues>
      <Name>sample string 2</Name>
      <PostTransactionObject>sample string 8</PostTransactionObject>
      <TableId>sample string 1</TableId>
      <TargetToOverride>sample string 7</TargetToOverride>
      <Values>sample string 5</Values>
    </UdfContext>
    <UdfContext>
      <DataSource>sample string 6</DataSource>
      <Description>sample string 3</Description>
      <DescriptionLines>sample string 14</DescriptionLines>
      <FieldID>13</FieldID>
      <FieldType>sample string 4</FieldType>
      <HeaderId>1</HeaderId>
      <IsActive>true</IsActive>
      <IsRendered>true</IsRendered>
      <IsRequired>true</IsRequired>
      <IsTypehead>true</IsTypehead>
      <LinesId>1</LinesId>
      <MappedValues>
        <UdfInvoke>
          <Description>sample string 2</Description>
          <IsActive>true</IsActive>
          <Value>sample string 1</Value>
        </UdfInvoke>
        <UdfInvoke>
          <Description>sample string 2</Description>
          <IsActive>true</IsActive>
          <Value>sample string 1</Value>
        </UdfInvoke>
      </MappedValues>
      <Name>sample string 2</Name>
      <PostTransactionObject>sample string 8</PostTransactionObject>
      <TableId>sample string 1</TableId>
      <TargetToOverride>sample string 7</TargetToOverride>
      <Values>sample string 5</Values>
    </UdfContext>
  </UDFList>
</UdfTransfer>

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.