POST api/Forms/CreateGroup

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
TermGroup	string	None.
TermSetName	string	None.
FormContext	FormContext	None.

Request Formats

application/json, text/json

Sample:

{
  "TermGroup": "sample string 1",
  "TermSetName": "sample string 2",
  "FormContext": {
    "DisplayMode": "sample string 1",
    "ListName": "sample string 2",
    "ListGuid": "df45e2e8-6ddf-45eb-89a0-56c611015cd9",
    "HistoryListGuid": "3c168e45-5c28-4554-bf2a-d6230753127f",
    "ItemId": 5,
    "itemId": "sample string 6",
    "ItemUniqueId": "f8fcaa05-d60d-4538-ae00-f606aa1b10d7",
    "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": "b10ae030-9ac8-4391-a5cc-2363de4d899f",
    "DocLibListGuid": "e44191f7-2bce-4647-9f1b-eb0b29847af0",
    "Settings": {
      "BackendApiUrl": "sample string 1",
      "EOfficeDataSiteUrl": "sample string 2",
      "HTTMSiteURL": "sample string 3"
    },
    "FormItem": {
      "Id": 1,
      "UniqueId": "29e5ffec-448d-4fa6-96e5-9add4b0247c9",
      "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": "9aeaa803-b5c0-4c4a-a276-80db62200f65",
      "FormTemplateSiteGuid": "53d096b6-8b04-4fa8-ace9-7c68dd795229",
      "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": "77c65ea6-29e9-41cf-b946-9f688ce05040",
      "DiscussionListGuid": "6c521326-bd89-41de-af03-325fea487a8f",
      "DocLibListGuid": "0749835a-121e-4d1e-b1d5-6c6bddd68a6b",
      "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": "a02a55fa-a8eb-49b8-95a2-b96e46669f89",
        "ListGuid": "7aec8fdd-79b4-4d45-a56e-3b3242a767e9",
        "WebGuid": "89ff163b-4416-4fcf-9c28-c21f5455577c",
        "ItemId": 7,
        "RefDisplayHTML": "sample string 8",
        "FormCode": "sample string 9",
        "WebUrl": "sample string 10",
        "FormType": "sample string 11"
      },
      "PRItemDetailListGuid": "e3b31bd3-7b8a-4836-8304-b47a8365cffc"
    },
    "ClearAdditionalItemOnly": true,
    "ClearApprovalGroup": true,
    "SiteGuid": "956f36b7-dab6-4d3d-b972-990c338ec6de",
    "WebGuid": "28daa0b6-1b65-4997-b8ac-109206be0bca",
    "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
  }
}

application/xml, text/xml

Sample:

<CreateGroupTermset xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Appvity.eOffice.Backend.Models">
  <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>b10ae030-9ac8-4391-a5cc-2363de4d899f</DiscussionListGuid>
    <DisplayMode>sample string 1</DisplayMode>
    <DocLibListGuid>e44191f7-2bce-4647-9f1b-eb0b29847af0</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>6c521326-bd89-41de-af03-325fea487a8f</DiscussionListGuid>
      <DocLibListGuid>0749835a-121e-4d1e-b1d5-6c6bddd68a6b</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>53d096b6-8b04-4fa8-ace9-7c68dd795229</FormTemplateSiteGuid>
      <FormTemplateWebGuid>9aeaa803-b5c0-4c4a-a276-80db62200f65</FormTemplateWebGuid>
      <FormType>sample string 5</FormType>
      <Group>sample string 18</Group>
      <HasIsoNumber>sample string 17</HasIsoNumber>
      <HasTemplate>sample string 16</HasTemplate>
      <HistoryListGuid>77c65ea6-29e9-41cf-b946-9f688ce05040</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>7aec8fdd-79b4-4d45-a56e-3b3242a767e9</d4p1:ListGuid>
        <d4p1:Ref>sample string 3</d4p1:Ref>
        <d4p1:RefDisplayHTML>sample string 8</d4p1:RefDisplayHTML>
        <d4p1:SiteGuid>a02a55fa-a8eb-49b8-95a2-b96e46669f89</d4p1:SiteGuid>
        <d4p1:Title>sample string 2</d4p1:Title>
        <d4p1:WebGuid>89ff163b-4416-4fcf-9c28-c21f5455577c</d4p1:WebGuid>
        <d4p1:WebUrl>sample string 10</d4p1:WebUrl>
      </MFItem>
      <PRItemDetailListGuid>e3b31bd3-7b8a-4836-8304-b47a8365cffc</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>29e5ffec-448d-4fa6-96e5-9add4b0247c9</UniqueId>
      <WFName>sample string 11</WFName>
    </FormItem>
    <FormType>sample string 21</FormType>
    <HistoryListGuid>3c168e45-5c28-4554-bf2a-d6230753127f</HistoryListGuid>
    <IsGenerateApprovalMatrix>true</IsGenerateApprovalMatrix>
    <ItemId>5</ItemId>
    <ItemUniqueId>f8fcaa05-d60d-4538-ae00-f606aa1b10d7</ItemUniqueId>
    <KeyValue>sample string 22</KeyValue>
    <ListGuid>df45e2e8-6ddf-45eb-89a0-56c611015cd9</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>956f36b7-dab6-4d3d-b972-990c338ec6de</SiteGuid>
    <SyncPermission>true</SyncPermission>
    <WFName>sample string 18</WFName>
    <WebGuid>28daa0b6-1b65-4997-b8ac-109206be0bca</WebGuid>
    <WebRelativeUrl>sample string 8</WebRelativeUrl>
    <WebUrl>sample string 10</WebUrl>
    <itemId>sample string 6</itemId>
  </FormContext>
  <TermGroup>sample string 1</TermGroup>
  <TermSetName>sample string 2</TermSetName>
</CreateGroupTermset>

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

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.