POST api/DeclareIP/CreateItemDeclareIP
Request Information
URI Parameters
None.
Body Parameters
DeclareIPName | Description | Type | Additional information |
---|---|---|---|
FormContext | FormContext |
None. |
|
IPUrl | string |
None. |
|
WebUrl | string |
None. |
|
EOfficeDataSiteUrl | string |
None. |
|
EmailUserCreate | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "FormContext": { "DisplayMode": "sample string 1", "ListName": "sample string 2", "ListGuid": "a44bf55b-ba98-4525-b407-5d017eb5f647", "HistoryListGuid": "6d805d26-410e-4c08-b3b3-c1e563fe9c98", "ItemId": 5, "itemId": "sample string 6", "ItemUniqueId": "c4f3c11f-a905-454f-be81-2b681c148439", "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": "3ba48330-28e3-4da5-8803-7c50cb2edc42", "DocLibListGuid": "85f4f65b-4901-4eb9-8ebd-157f4fc81a17", "Settings": { "BackendApiUrl": "sample string 1", "EOfficeDataSiteUrl": "sample string 2", "HTTMSiteURL": "sample string 3" }, "FormItem": { "Id": 1, "UniqueId": "afafaf49-a65c-4e1c-bb29-0c793dbd1610", "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": "1ad7b879-ab8b-4771-b18e-34cf6d68ad72", "FormTemplateSiteGuid": "2c2346b8-2717-41b5-a095-5e7bb2bdcf90", "FormPublishedDate": "2025-07-17T11:38:53.3313073+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": "cc25b6ba-e314-47e5-b53c-f7fa23232dd2", "DiscussionListGuid": "6e7804e3-67e1-4806-bcf9-b6e45a6f23d0", "DocLibListGuid": "cb96106e-aa97-4017-a1c9-0dcc8a5c730a", "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-17T11:38:53.3313073+07:00", "SubmittedDate": "2025-07-17T11:38:53.3313073+07:00", "CurrentGroup": "sample string 12", "CurrentApproverJobTitle": "sample string 13", "SubmitCounter": 14, "EffectiveDate": "2025-07-17T11:38:53.3313073+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": "a10dbf91-91fd-4cf3-92c0-f4cc0d191fd7", "ListGuid": "939bc0cb-ac33-4944-82b2-ab62521e1d08", "WebGuid": "40e206fa-5acd-4a57-99ca-f4232a956177", "ItemId": 7, "RefDisplayHTML": "sample string 8", "FormCode": "sample string 9", "WebUrl": "sample string 10", "FormType": "sample string 11" }, "PRItemDetailListGuid": "4545a96b-ca9d-414e-b2f7-d9f73e0e89c5" }, "ClearAdditionalItemOnly": true, "ClearApprovalGroup": true, "SiteGuid": "2f502b53-85f3-403f-bd8d-aa620c63c4a8", "WebGuid": "7923e875-bb7c-4f43-b277-1db3ae853c1c", "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 }, "IPUrl": "sample string 1", "WebUrl": "sample string 2", "EOfficeDataSiteUrl": "sample string 3", "EmailUserCreate": "sample string 4" }
application/xml, text/xml
Sample:
<DeclareIP xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Appvity.eOffice.Backend.Services.DeclareIPService"> <EOfficeDataSiteUrl>sample string 3</EOfficeDataSiteUrl> <EmailUserCreate>sample string 4</EmailUserCreate> <FormContext xmlns:d2p1="http://schemas.datacontract.org/2004/07/Appvity.eOffice.Backend.Models"> <d2p1:ClearAdditionalItemOnly>true</d2p1:ClearAdditionalItemOnly> <d2p1:ClearApprovalGroup>true</d2p1:ClearApprovalGroup> <d2p1:ClearApprovalMatrix>true</d2p1:ClearApprovalMatrix> <d2p1:CurrentUser> <d2p1:DisplayName>sample string 4</d2p1:DisplayName> <d2p1:Email>sample string 2</d2p1:Email> <d2p1:Id>1</d2p1:Id> <d2p1:PictureURL>sample string 5</d2p1:PictureURL> <d2p1:Username>sample string 3</d2p1:Username> </d2p1:CurrentUser> <d2p1:DiscussionListGuid>3ba48330-28e3-4da5-8803-7c50cb2edc42</d2p1:DiscussionListGuid> <d2p1:DisplayMode>sample string 1</d2p1:DisplayMode> <d2p1:DocLibListGuid>85f4f65b-4901-4eb9-8ebd-157f4fc81a17</d2p1:DocLibListGuid> <d2p1:EOfficeDataSiteUrl>sample string 19</d2p1:EOfficeDataSiteUrl> <d2p1:FormCode>sample string 20</d2p1:FormCode> <d2p1:FormItem> <d2p1:ApprovalStatus>sample string 9</d2p1:ApprovalStatus> <d2p1:CurrentApproverDueDate>2025-07-17T11:38:53.3313073+07:00</d2p1:CurrentApproverDueDate> <d2p1:CurrentApproverJobTitle>sample string 13</d2p1:CurrentApproverJobTitle> <d2p1:CurrentApprovers> <d2p1:FormUser> <d2p1:DisplayName>sample string 4</d2p1:DisplayName> <d2p1:Email>sample string 2</d2p1:Email> <d2p1:Id>1</d2p1:Id> <d2p1:PictureURL>sample string 5</d2p1:PictureURL> <d2p1:Username>sample string 3</d2p1:Username> </d2p1:FormUser> <d2p1:FormUser> <d2p1:DisplayName>sample string 4</d2p1:DisplayName> <d2p1:Email>sample string 2</d2p1:Email> <d2p1:Id>1</d2p1:Id> <d2p1:PictureURL>sample string 5</d2p1:PictureURL> <d2p1:Username>sample string 3</d2p1:Username> </d2p1:FormUser> </d2p1:CurrentApprovers> <d2p1:CurrentGroup>sample string 12</d2p1:CurrentGroup> <d2p1: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> </d2p1:Department> <d2p1:DiscussionListGuid>6e7804e3-67e1-4806-bcf9-b6e45a6f23d0</d2p1:DiscussionListGuid> <d2p1:DocLibListGuid>cb96106e-aa97-4017-a1c9-0dcc8a5c730a</d2p1:DocLibListGuid> <d2p1:EffectiveDate>2025-07-17T11:38:53.3313073+07:00</d2p1:EffectiveDate> <d2p1:FormCategory>sample string 10</d2p1:FormCategory> <d2p1:FormCode>sample string 4</d2p1:FormCode> <d2p1:FormNumber>sample string 7</d2p1:FormNumber> <d2p1:FormPublishedDate>2025-07-17T11:38:53.3313073+07:00</d2p1:FormPublishedDate> <d2p1:FormSetItemID>sample string 20</d2p1:FormSetItemID> <d2p1:FormTemplate>sample string 6</d2p1:FormTemplate> <d2p1:FormTemplateID>8</d2p1:FormTemplateID> <d2p1:FormTemplateSiteGuid>2c2346b8-2717-41b5-a095-5e7bb2bdcf90</d2p1:FormTemplateSiteGuid> <d2p1:FormTemplateWebGuid>1ad7b879-ab8b-4771-b18e-34cf6d68ad72</d2p1:FormTemplateWebGuid> <d2p1:FormType>sample string 5</d2p1:FormType> <d2p1:Group>sample string 18</d2p1:Group> <d2p1:HasIsoNumber>sample string 17</d2p1:HasIsoNumber> <d2p1:HasTemplate>sample string 16</d2p1:HasTemplate> <d2p1:HistoryListGuid>cc25b6ba-e314-47e5-b53c-f7fa23232dd2</d2p1:HistoryListGuid> <d2p1:Id>1</d2p1:Id> <d2p1:IsoNumber>sample string 15</d2p1:IsoNumber> <d2p1: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>939bc0cb-ac33-4944-82b2-ab62521e1d08</d4p1:ListGuid> <d4p1:Ref>sample string 3</d4p1:Ref> <d4p1:RefDisplayHTML>sample string 8</d4p1:RefDisplayHTML> <d4p1:SiteGuid>a10dbf91-91fd-4cf3-92c0-f4cc0d191fd7</d4p1:SiteGuid> <d4p1:Title>sample string 2</d4p1:Title> <d4p1:WebGuid>40e206fa-5acd-4a57-99ca-f4232a956177</d4p1:WebGuid> <d4p1:WebUrl>sample string 10</d4p1:WebUrl> </d2p1:MFItem> <d2p1:PRItemDetailListGuid>4545a96b-ca9d-414e-b2f7-d9f73e0e89c5</d2p1:PRItemDetailListGuid> <d2p1:Ref>sample string 3</d2p1:Ref> <d2p1:RefDisplayHTML>sample string 21</d2p1:RefDisplayHTML> <d2p1:Requester> <d2p1:DisplayName>sample string 4</d2p1:DisplayName> <d2p1:Email>sample string 2</d2p1:Email> <d2p1:Id>1</d2p1:Id> <d2p1:PictureURL>sample string 5</d2p1:PictureURL> <d2p1:Username>sample string 3</d2p1:Username> </d2p1:Requester> <d2p1:SubmitCounter>14</d2p1:SubmitCounter> <d2p1:SubmittedDate>2025-07-17T11:38:53.3313073+07:00</d2p1:SubmittedDate> <d2p1:Title>sample string 2</d2p1:Title> <d2p1:UniqueId>afafaf49-a65c-4e1c-bb29-0c793dbd1610</d2p1:UniqueId> <d2p1:WFName>sample string 11</d2p1:WFName> </d2p1:FormItem> <d2p1:FormType>sample string 21</d2p1:FormType> <d2p1:HistoryListGuid>6d805d26-410e-4c08-b3b3-c1e563fe9c98</d2p1:HistoryListGuid> <d2p1:IsGenerateApprovalMatrix>true</d2p1:IsGenerateApprovalMatrix> <d2p1:ItemId>5</d2p1:ItemId> <d2p1:ItemUniqueId>c4f3c11f-a905-454f-be81-2b681c148439</d2p1:ItemUniqueId> <d2p1:KeyValue>sample string 22</d2p1:KeyValue> <d2p1:ListGuid>a44bf55b-ba98-4525-b407-5d017eb5f647</d2p1:ListGuid> <d2p1:ListName>sample string 2</d2p1:ListName> <d2p1:RootSiteUrl>sample string 9</d2p1:RootSiteUrl> <d2p1:Settings> <d2p1:BackendApiUrl>sample string 1</d2p1:BackendApiUrl> <d2p1:EOfficeDataSiteUrl>sample string 2</d2p1:EOfficeDataSiteUrl> <d2p1:HTTMSiteURL>sample string 3</d2p1:HTTMSiteURL> </d2p1:Settings> <d2p1:SiteGuid>2f502b53-85f3-403f-bd8d-aa620c63c4a8</d2p1:SiteGuid> <d2p1:SyncPermission>true</d2p1:SyncPermission> <d2p1:WFName>sample string 18</d2p1:WFName> <d2p1:WebGuid>7923e875-bb7c-4f43-b277-1db3ae853c1c</d2p1:WebGuid> <d2p1:WebRelativeUrl>sample string 8</d2p1:WebRelativeUrl> <d2p1:WebUrl>sample string 10</d2p1:WebUrl> <d2p1:itemId>sample string 6</d2p1:itemId> </FormContext> <IPUrl>sample string 1</IPUrl> <WebUrl>sample string 2</WebUrl> </DeclareIP>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.