POST api/DocumentImport/RulePost

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ProjectID	globally unique identifier	None.
ProjectTemplateID	globally unique identifier	None.
Validate	boolean	None.
ImportDataList	Collection of DocumentImportDataViewModel	None.
ImportRuleDataList	Collection of DocumentImportRuleDataViewModel	None.
ImportFeatureDataList	Collection of DocumentImportFeatureDataViewModel	None.
CompanyID	integer	None.
Language	string	None.
CreatedDate	date	None.
CreatedUserID	globally unique identifier	None.
ModifiedDate	date	None.
ModifiedUserID	globally unique identifier	None.
FeatureID	globally unique identifier	None.
Token	globally unique identifier	None.
Action	Actions	None.
FilterText	string	None.
CurrentIndex	integer	None.
PageSize	integer	None.
TotalRecords	integer	None.
SortColumn	string	None.
Sortby	SortDirection	None.
ImageId	integer	None.
IsDeleted	boolean	None.
IsActive	boolean	None.
Sort	integer	None.
Messages	Collection of ErrorMessage	None.

Request Formats

application/json, text/json

Sample:

{
  "ProjectID": "f911caee-6cbe-40b6-966a-d4ff9e3da47e",
  "ProjectTemplateID": "d0e3d10d-86c3-4cc9-ac83-14f797cfc9eb",
  "Validate": true,
  "ImportDataList": [
    {
      "Module": "sample string 1",
      "People": "sample string 2",
      "BusinessObject": "sample string 3",
      "Action": "sample string 4",
      "ApplicationType": "sample string 5",
      "Page": "sample string 6",
      "Complexity": "sample string 7",
      "Weight": 8,
      "Priority": 9,
      "Process": "sample string 10"
    },
    {
      "Module": "sample string 1",
      "People": "sample string 2",
      "BusinessObject": "sample string 3",
      "Action": "sample string 4",
      "ApplicationType": "sample string 5",
      "Page": "sample string 6",
      "Complexity": "sample string 7",
      "Weight": 8,
      "Priority": 9,
      "Process": "sample string 10"
    }
  ],
  "ImportRuleDataList": [
    {
      "Module": "sample string 1",
      "Name": "sample string 2",
      "Event": "sample string 3",
      "Type": "sample string 4",
      "Description": "sample string 5",
      "Specification": "sample string 6",
      "Link": "sample string 7",
      "LinkToField": "sample string 8"
    },
    {
      "Module": "sample string 1",
      "Name": "sample string 2",
      "Event": "sample string 3",
      "Type": "sample string 4",
      "Description": "sample string 5",
      "Specification": "sample string 6",
      "Link": "sample string 7",
      "LinkToField": "sample string 8"
    }
  ],
  "ImportFeatureDataList": [
    {
      "Module": "sample string 1",
      "BusinessObjectName": "sample string 2",
      "FieldName": "sample string 3",
      "Description": "sample string 4",
      "FieldType": "sample string 5",
      "FieldFormat": "sample string 6",
      "FieldMask": "sample string 7",
      "IsID": "sample string 8",
      "IsUnique": "sample string 9",
      "IsRequired": "sample string 10",
      "IsRelated": "sample string 11",
      "RelatedBusinessObjectName": "sample string 12",
      "FieldCode": "sample string 13",
      "Length": 1.0,
      "ListValues": "sample string 14",
      "IsAggregate": "sample string 15"
    },
    {
      "Module": "sample string 1",
      "BusinessObjectName": "sample string 2",
      "FieldName": "sample string 3",
      "Description": "sample string 4",
      "FieldType": "sample string 5",
      "FieldFormat": "sample string 6",
      "FieldMask": "sample string 7",
      "IsID": "sample string 8",
      "IsUnique": "sample string 9",
      "IsRequired": "sample string 10",
      "IsRelated": "sample string 11",
      "RelatedBusinessObjectName": "sample string 12",
      "FieldCode": "sample string 13",
      "Length": 1.0,
      "ListValues": "sample string 14",
      "IsAggregate": "sample string 15"
    }
  ],
  "CompanyID": 4,
  "Language": "sample string 5",
  "CreatedDate": "2026-01-07T20:21:13.3500378+00:00",
  "CreatedUserID": "102e8916-1cd6-4183-a0d7-fddd44075b93",
  "ModifiedDate": "2026-01-07T20:21:13.3500378+00:00",
  "ModifiedUserID": "6a4dc31e-d161-46ac-b441-58efef9d0ad0",
  "FeatureID": "92bb75f6-803f-4dd9-9528-e45deb9a8188",
  "Token": "f2c40b85-07a2-4eca-802c-3753ed06a7fb",
  "Action": 0,
  "FilterText": "sample string 12",
  "CurrentIndex": 13,
  "PageSize": 14,
  "TotalRecords": 15,
  "SortColumn": "sample string 16",
  "Sortby": 0,
  "ImageId": 1,
  "IsDeleted": true,
  "IsActive": true,
  "Sort": 1,
  "Messages": [
    {
      "ErrorType": 1,
      "Message": "sample string 2"
    },
    {
      "ErrorType": 1,
      "Message": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<DocumentImportViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core.ProjectModels">
  <Action xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">View</Action>
  <CompanyID xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">4</CompanyID>
  <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">2026-01-07T20:21:13.3500378+00:00</CreatedDate>
  <CreatedUserID xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">102e8916-1cd6-4183-a0d7-fddd44075b93</CreatedUserID>
  <CurrentIndex xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">13</CurrentIndex>
  <FeatureID xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">92bb75f6-803f-4dd9-9528-e45deb9a8188</FeatureID>
  <FilterText xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">sample string 12</FilterText>
  <ImageId xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">1</ImageId>
  <IsActive xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">true</IsActive>
  <IsDeleted xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">true</IsDeleted>
  <Language xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">sample string 5</Language>
  <Messages xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">
    <ErrorMessage>
      <ErrorType>1</ErrorType>
      <Message>sample string 2</Message>
    </ErrorMessage>
    <ErrorMessage>
      <ErrorType>1</ErrorType>
      <Message>sample string 2</Message>
    </ErrorMessage>
  </Messages>
  <ModifiedDate xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">2026-01-07T20:21:13.3500378+00:00</ModifiedDate>
  <ModifiedUserID xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">6a4dc31e-d161-46ac-b441-58efef9d0ad0</ModifiedUserID>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">14</PageSize>
  <Sort xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">1</Sort>
  <SortColumn xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">sample string 16</SortColumn>
  <Sortby xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">Asc</Sortby>
  <Token xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">f2c40b85-07a2-4eca-802c-3753ed06a7fb</Token>
  <TotalRecords xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">15</TotalRecords>
  <ImportDataList>
    <DocumentImportDataViewModel>
      <Action>sample string 4</Action>
      <ApplicationType>sample string 5</ApplicationType>
      <BusinessObject>sample string 3</BusinessObject>
      <Complexity>sample string 7</Complexity>
      <Module>sample string 1</Module>
      <Page>sample string 6</Page>
      <People>sample string 2</People>
      <Priority>9</Priority>
      <Process>sample string 10</Process>
      <Weight>8</Weight>
    </DocumentImportDataViewModel>
    <DocumentImportDataViewModel>
      <Action>sample string 4</Action>
      <ApplicationType>sample string 5</ApplicationType>
      <BusinessObject>sample string 3</BusinessObject>
      <Complexity>sample string 7</Complexity>
      <Module>sample string 1</Module>
      <Page>sample string 6</Page>
      <People>sample string 2</People>
      <Priority>9</Priority>
      <Process>sample string 10</Process>
      <Weight>8</Weight>
    </DocumentImportDataViewModel>
  </ImportDataList>
  <ImportFeatureDataList>
    <DocumentImportFeatureDataViewModel>
      <BusinessObjectName>sample string 2</BusinessObjectName>
      <Description>sample string 4</Description>
      <FieldCode>sample string 13</FieldCode>
      <FieldFormat>sample string 6</FieldFormat>
      <FieldMask>sample string 7</FieldMask>
      <FieldName>sample string 3</FieldName>
      <FieldType>sample string 5</FieldType>
      <IsAggregate>sample string 15</IsAggregate>
      <IsID>sample string 8</IsID>
      <IsRelated>sample string 11</IsRelated>
      <IsRequired>sample string 10</IsRequired>
      <IsUnique>sample string 9</IsUnique>
      <Length>1</Length>
      <ListValues>sample string 14</ListValues>
      <Module>sample string 1</Module>
      <RelatedBusinessObjectName>sample string 12</RelatedBusinessObjectName>
    </DocumentImportFeatureDataViewModel>
    <DocumentImportFeatureDataViewModel>
      <BusinessObjectName>sample string 2</BusinessObjectName>
      <Description>sample string 4</Description>
      <FieldCode>sample string 13</FieldCode>
      <FieldFormat>sample string 6</FieldFormat>
      <FieldMask>sample string 7</FieldMask>
      <FieldName>sample string 3</FieldName>
      <FieldType>sample string 5</FieldType>
      <IsAggregate>sample string 15</IsAggregate>
      <IsID>sample string 8</IsID>
      <IsRelated>sample string 11</IsRelated>
      <IsRequired>sample string 10</IsRequired>
      <IsUnique>sample string 9</IsUnique>
      <Length>1</Length>
      <ListValues>sample string 14</ListValues>
      <Module>sample string 1</Module>
      <RelatedBusinessObjectName>sample string 12</RelatedBusinessObjectName>
    </DocumentImportFeatureDataViewModel>
  </ImportFeatureDataList>
  <ImportRuleDataList>
    <DocumentImportRuleDataViewModel>
      <Description>sample string 5</Description>
      <Event>sample string 3</Event>
      <Link>sample string 7</Link>
      <LinkToField>sample string 8</LinkToField>
      <Module>sample string 1</Module>
      <Name>sample string 2</Name>
      <Specification>sample string 6</Specification>
      <Type>sample string 4</Type>
    </DocumentImportRuleDataViewModel>
    <DocumentImportRuleDataViewModel>
      <Description>sample string 5</Description>
      <Event>sample string 3</Event>
      <Link>sample string 7</Link>
      <LinkToField>sample string 8</LinkToField>
      <Module>sample string 1</Module>
      <Name>sample string 2</Name>
      <Specification>sample string 6</Specification>
      <Type>sample string 4</Type>
    </DocumentImportRuleDataViewModel>
  </ImportRuleDataList>
  <ProjectID>f911caee-6cbe-40b6-966a-d4ff9e3da47e</ProjectID>
  <ProjectTemplateID>d0e3d10d-86c3-4cc9-ac83-14f797cfc9eb</ProjectTemplateID>
  <Validate>true</Validate>
</DocumentImportViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.