POST api/FormHistoryController/CreateItemVD

Request Information

URI Parameters

None.

Body Parameters

FormHistoryVD
NameDescriptionTypeAdditional information
Id

integer

None.

Title

string

None.

Body

string

None.

ActionType

string

None.

ActionDate

date

None.

ActionUser

FormUser

None.

TenderUser

string

None.

Recipients

Collection of FormUser

None.

ItemId

integer

None.

ListGuid

string

None.

FormContext

FormContext

None.

Module

string

None.

SiteUrl

string

None.

Reason

string

None.

FormCode

string

None.

WFName

string

None.

FormType

string

None.

SubmitCounter

integer

None.

SelectedVendorLists

Collection of string

None.

Description

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Title": "sample string 2",
  "Body": "sample string 3",
  "ActionType": "sample string 4",
  "ActionDate": "2025-07-17T10:33:35.5418505+07:00",
  "ActionUser": {
    "Id": 1,
    "Email": "sample string 2",
    "Username": "sample string 3",
    "DisplayName": "sample string 4",
    "PictureURL": "sample string 5"
  },
  "TenderUser": "sample string 6",
  "Recipients": [
    {
      "Id": 1,
      "Email": "sample string 2",
      "Username": "sample string 3",
      "DisplayName": "sample string 4",
      "PictureURL": "sample string 5"
    },
    {
      "Id": 1,
      "Email": "sample string 2",
      "Username": "sample string 3",
      "DisplayName": "sample string 4",
      "PictureURL": "sample string 5"
    }
  ],
  "ItemId": 7,
  "ListGuid": "sample string 8",
  "FormContext": {
    "DisplayMode": "sample string 1",
    "ListName": "sample string 2",
    "ListGuid": "45204d0b-bea3-4d32-a252-541e9a2af221",
    "HistoryListGuid": "d89abb8a-8f1d-421a-9266-ed93b4a50680",
    "ItemId": 5,
    "itemId": "sample string 6",
    "ItemUniqueId": "088ddb92-c83f-4b1c-bc3b-23d6e6c9c5bf",
    "CurrentUser": {
      "Id": 1,
      "Email": "sample string 2",
      "Username": "sample string 3",
      "DisplayName": "sample string 4",
      "PictureURL": "sample string 5"
    },
    "WebRelativeUrl": "sample string 8",
    "RootSiteUrl": "sample string 9",
    "WebUrl": "sample string 10",
    "DiscussionListGuid": "d6c30e8a-b40a-478e-966e-cc36b2bd205a",
    "DocLibListGuid": "2ad33bf0-725b-4827-a4e0-416af0ec1199",
    "Settings": {
      "BackendApiUrl": "sample string 1",
      "EOfficeDataSiteUrl": "sample string 2",
      "HTTMSiteURL": "sample string 3"
    },
    "FormItem": {
      "Id": 1,
      "UniqueId": "994fab06-b42d-4cb8-b331-d70f99500731",
      "Title": "sample string 2",
      "Ref": "sample string 3",
      "Requester": {
        "Id": 1,
        "Email": "sample string 2",
        "Username": "sample string 3",
        "DisplayName": "sample string 4",
        "PictureURL": "sample string 5"
      },
      "FormCode": "sample string 4",
      "FormType": "sample string 5",
      "FormTemplate": "sample string 6",
      "FormNumber": "sample string 7",
      "FormTemplateID": 8,
      "FormTemplateWebGuid": "a2008915-de32-4df4-96c6-d1a3f9efb7d0",
      "FormTemplateSiteGuid": "1997b15c-60aa-4ae3-833a-85826f2c290a",
      "FormPublishedDate": "2025-07-17T10:33:35.5418505+07:00",
      "ApprovalStatus": "sample string 9",
      "CurrentApprovers": [
        {
          "Id": 1,
          "Email": "sample string 2",
          "Username": "sample string 3",
          "DisplayName": "sample string 4",
          "PictureURL": "sample string 5"
        },
        {
          "Id": 1,
          "Email": "sample string 2",
          "Username": "sample string 3",
          "DisplayName": "sample string 4",
          "PictureURL": "sample string 5"
        }
      ],
      "HistoryListGuid": "32978187-b97f-4b92-9d5c-ee5ff686d12c",
      "DiscussionListGuid": "af0fcfa0-d10c-41cd-946d-fef06e81e977",
      "DocLibListGuid": "ade4a521-a195-462b-8b19-831f18484266",
      "FormCategory": "sample string 10",
      "Department": {
        "Label": "sample string 1",
        "TermGuid": "sample string 2",
        "WssId": 3,
        "TypeId": "{19e70ed0-4177-456b-8156-015e4d163ff8}"
      },
      "WFName": "sample string 11",
      "CurrentApproverDueDate": "2025-07-17T10:33:35.5418505+07:00",
      "SubmittedDate": "2025-07-17T10:33:35.5418505+07:00",
      "CurrentGroup": "sample string 12",
      "CurrentApproverJobTitle": "sample string 13",
      "SubmitCounter": 14,
      "EffectiveDate": "2025-07-17T10:33:35.5418505+07:00",
      "IsoNumber": "sample string 15",
      "HasTemplate": "sample string 16",
      "HasIsoNumber": "sample string 17",
      "Group": "sample string 18",
      "DepartmentCode": {},
      "FormSetItemID": "sample string 20",
      "RefDisplayHTML": "sample string 21",
      "MFItem": {
        "Id": 1,
        "Title": "sample string 2",
        "Ref": "sample string 3",
        "SiteGuid": "d49d894f-743b-4606-803d-cca84993aaac",
        "ListGuid": "a9a064a6-9797-4ed7-af32-3a4c9ca8a41e",
        "WebGuid": "6142ff45-c284-4773-b235-6c8f89af8b87",
        "ItemId": 7,
        "RefDisplayHTML": "sample string 8",
        "FormCode": "sample string 9",
        "WebUrl": "sample string 10",
        "FormType": "sample string 11"
      },
      "PRItemDetailListGuid": "56106997-a7da-497f-8c0a-8ed409560006"
    },
    "ClearAdditionalItemOnly": true,
    "ClearApprovalGroup": true,
    "SiteGuid": "0bd2b22d-1193-42f4-afc6-a89e60189850",
    "WebGuid": "c259e214-c78a-4d65-86a1-d9e9c53c7269",
    "SyncPermission": true,
    "ClearApprovalMatrix": true,
    "WFName": "sample string 18",
    "EOfficeDataSiteUrl": "sample string 19",
    "FormCode": "sample string 20",
    "FormType": "sample string 21",
    "KeyValue": "sample string 22",
    "IsGenerateApprovalMatrix": true
  },
  "Module": "sample string 9",
  "SiteUrl": "sample string 10",
  "Reason": "sample string 11",
  "FormCode": "sample string 12",
  "WFName": "sample string 13",
  "FormType": "sample string 14",
  "SubmitCounter": 15,
  "SelectedVendorLists": [
    "sample string 1",
    "sample string 2"
  ],
  "Description": "sample string 16"
}

application/xml, text/xml

Sample:
<FormHistoryVD xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Appvity.eOffice.Backend.Models">
  <ActionDate>2025-07-17T10:33:35.5418505+07:00</ActionDate>
  <ActionType>sample string 4</ActionType>
  <ActionUser>
    <DisplayName>sample string 4</DisplayName>
    <Email>sample string 2</Email>
    <Id>1</Id>
    <PictureURL>sample string 5</PictureURL>
    <Username>sample string 3</Username>
  </ActionUser>
  <Body>sample string 3</Body>
  <Description>sample string 16</Description>
  <FormCode>sample string 12</FormCode>
  <FormContext>
    <ClearAdditionalItemOnly>true</ClearAdditionalItemOnly>
    <ClearApprovalGroup>true</ClearApprovalGroup>
    <ClearApprovalMatrix>true</ClearApprovalMatrix>
    <CurrentUser>
      <DisplayName>sample string 4</DisplayName>
      <Email>sample string 2</Email>
      <Id>1</Id>
      <PictureURL>sample string 5</PictureURL>
      <Username>sample string 3</Username>
    </CurrentUser>
    <DiscussionListGuid>d6c30e8a-b40a-478e-966e-cc36b2bd205a</DiscussionListGuid>
    <DisplayMode>sample string 1</DisplayMode>
    <DocLibListGuid>2ad33bf0-725b-4827-a4e0-416af0ec1199</DocLibListGuid>
    <EOfficeDataSiteUrl>sample string 19</EOfficeDataSiteUrl>
    <FormCode>sample string 20</FormCode>
    <FormItem>
      <ApprovalStatus>sample string 9</ApprovalStatus>
      <CurrentApproverDueDate>2025-07-17T10:33:35.5418505+07:00</CurrentApproverDueDate>
      <CurrentApproverJobTitle>sample string 13</CurrentApproverJobTitle>
      <CurrentApprovers>
        <FormUser>
          <DisplayName>sample string 4</DisplayName>
          <Email>sample string 2</Email>
          <Id>1</Id>
          <PictureURL>sample string 5</PictureURL>
          <Username>sample string 3</Username>
        </FormUser>
        <FormUser>
          <DisplayName>sample string 4</DisplayName>
          <Email>sample string 2</Email>
          <Id>1</Id>
          <PictureURL>sample string 5</PictureURL>
          <Username>sample string 3</Username>
        </FormUser>
      </CurrentApprovers>
      <CurrentGroup>sample string 12</CurrentGroup>
      <Department xmlns:d4p1="http://schemas.datacontract.org/2004/07/Microsoft.SharePoint.Client.Taxonomy">
        <d4p1:Label>sample string 1</d4p1:Label>
        <d4p1:TermGuid>sample string 2</d4p1:TermGuid>
        <d4p1:WssId>3</d4p1:WssId>
      </Department>
      <DiscussionListGuid>af0fcfa0-d10c-41cd-946d-fef06e81e977</DiscussionListGuid>
      <DocLibListGuid>ade4a521-a195-462b-8b19-831f18484266</DocLibListGuid>
      <EffectiveDate>2025-07-17T10:33:35.5418505+07:00</EffectiveDate>
      <FormCategory>sample string 10</FormCategory>
      <FormCode>sample string 4</FormCode>
      <FormNumber>sample string 7</FormNumber>
      <FormPublishedDate>2025-07-17T10:33:35.5418505+07:00</FormPublishedDate>
      <FormSetItemID>sample string 20</FormSetItemID>
      <FormTemplate>sample string 6</FormTemplate>
      <FormTemplateID>8</FormTemplateID>
      <FormTemplateSiteGuid>1997b15c-60aa-4ae3-833a-85826f2c290a</FormTemplateSiteGuid>
      <FormTemplateWebGuid>a2008915-de32-4df4-96c6-d1a3f9efb7d0</FormTemplateWebGuid>
      <FormType>sample string 5</FormType>
      <Group>sample string 18</Group>
      <HasIsoNumber>sample string 17</HasIsoNumber>
      <HasTemplate>sample string 16</HasTemplate>
      <HistoryListGuid>32978187-b97f-4b92-9d5c-ee5ff686d12c</HistoryListGuid>
      <Id>1</Id>
      <IsoNumber>sample string 15</IsoNumber>
      <MFItem xmlns:d4p1="http://schemas.datacontract.org/2004/07/Appvity.eOffice.Backend.Services.MFService">
        <d4p1:FormCode>sample string 9</d4p1:FormCode>
        <d4p1:FormType>sample string 11</d4p1:FormType>
        <d4p1:Id>1</d4p1:Id>
        <d4p1:ItemId>7</d4p1:ItemId>
        <d4p1:ListGuid>a9a064a6-9797-4ed7-af32-3a4c9ca8a41e</d4p1:ListGuid>
        <d4p1:Ref>sample string 3</d4p1:Ref>
        <d4p1:RefDisplayHTML>sample string 8</d4p1:RefDisplayHTML>
        <d4p1:SiteGuid>d49d894f-743b-4606-803d-cca84993aaac</d4p1:SiteGuid>
        <d4p1:Title>sample string 2</d4p1:Title>
        <d4p1:WebGuid>6142ff45-c284-4773-b235-6c8f89af8b87</d4p1:WebGuid>
        <d4p1:WebUrl>sample string 10</d4p1:WebUrl>
      </MFItem>
      <PRItemDetailListGuid>56106997-a7da-497f-8c0a-8ed409560006</PRItemDetailListGuid>
      <Ref>sample string 3</Ref>
      <RefDisplayHTML>sample string 21</RefDisplayHTML>
      <Requester>
        <DisplayName>sample string 4</DisplayName>
        <Email>sample string 2</Email>
        <Id>1</Id>
        <PictureURL>sample string 5</PictureURL>
        <Username>sample string 3</Username>
      </Requester>
      <SubmitCounter>14</SubmitCounter>
      <SubmittedDate>2025-07-17T10:33:35.5418505+07:00</SubmittedDate>
      <Title>sample string 2</Title>
      <UniqueId>994fab06-b42d-4cb8-b331-d70f99500731</UniqueId>
      <WFName>sample string 11</WFName>
    </FormItem>
    <FormType>sample string 21</FormType>
    <HistoryListGuid>d89abb8a-8f1d-421a-9266-ed93b4a50680</HistoryListGuid>
    <IsGenerateApprovalMatrix>true</IsGenerateApprovalMatrix>
    <ItemId>5</ItemId>
    <ItemUniqueId>088ddb92-c83f-4b1c-bc3b-23d6e6c9c5bf</ItemUniqueId>
    <KeyValue>sample string 22</KeyValue>
    <ListGuid>45204d0b-bea3-4d32-a252-541e9a2af221</ListGuid>
    <ListName>sample string 2</ListName>
    <RootSiteUrl>sample string 9</RootSiteUrl>
    <Settings>
      <BackendApiUrl>sample string 1</BackendApiUrl>
      <EOfficeDataSiteUrl>sample string 2</EOfficeDataSiteUrl>
      <HTTMSiteURL>sample string 3</HTTMSiteURL>
    </Settings>
    <SiteGuid>0bd2b22d-1193-42f4-afc6-a89e60189850</SiteGuid>
    <SyncPermission>true</SyncPermission>
    <WFName>sample string 18</WFName>
    <WebGuid>c259e214-c78a-4d65-86a1-d9e9c53c7269</WebGuid>
    <WebRelativeUrl>sample string 8</WebRelativeUrl>
    <WebUrl>sample string 10</WebUrl>
    <itemId>sample string 6</itemId>
  </FormContext>
  <FormType>sample string 14</FormType>
  <Id>1</Id>
  <ItemId>7</ItemId>
  <ListGuid>sample string 8</ListGuid>
  <Module>sample string 9</Module>
  <Reason>sample string 11</Reason>
  <Recipients>
    <FormUser>
      <DisplayName>sample string 4</DisplayName>
      <Email>sample string 2</Email>
      <Id>1</Id>
      <PictureURL>sample string 5</PictureURL>
      <Username>sample string 3</Username>
    </FormUser>
    <FormUser>
      <DisplayName>sample string 4</DisplayName>
      <Email>sample string 2</Email>
      <Id>1</Id>
      <PictureURL>sample string 5</PictureURL>
      <Username>sample string 3</Username>
    </FormUser>
  </Recipients>
  <SelectedVendorLists xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </SelectedVendorLists>
  <SiteUrl>sample string 10</SiteUrl>
  <SubmitCounter>15</SubmitCounter>
  <TenderUser>sample string 6</TenderUser>
  <Title>sample string 2</Title>
  <WFName>sample string 13</WFName>
</FormHistoryVD>

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 'FormHistoryVD'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.