POST api/DocumentTestPlan/Run

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ID	integer	None.
DocumentID	integer	None.
WorkflowID	integer	None.
WorkflowVersionID	string	None.
StatusIDSource	integer	None.
StatusIDTarget	integer	None.
ReasonID	integer	None.
Date	date	None.
Comment	string	None.
UserID	globally unique identifier	None.
DocumentIDs	string	None.
DocumentTypeID	integer	None.
ProjectID	globally unique identifier	None.
ExecutionHistories	Collection of DocumentTestPlanStepExecutionHistoryViewModel	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:

{
  "ID": 1,
  "DocumentID": 2,
  "WorkflowID": 3,
  "WorkflowVersionID": "sample string 4",
  "StatusIDSource": 5,
  "StatusIDTarget": 6,
  "ReasonID": 1,
  "Date": "2025-08-29T01:01:54.111544+00:00",
  "Comment": "sample string 8",
  "UserID": "31984142-916f-4808-af80-1eb7ca229b2b",
  "DocumentIDs": "sample string 10",
  "DocumentTypeID": 11,
  "ProjectID": "c30ab2e0-ea6a-407c-83fb-f3320911f3b5",
  "ExecutionHistories": [
    {
      "StepID": 1,
      "ID": 2,
      "HistoryID": 3,
      "StatusID": 4,
      "Comment": "sample string 5"
    },
    {
      "StepID": 1,
      "ID": 2,
      "HistoryID": 3,
      "StatusID": 4,
      "Comment": "sample string 5"
    }
  ],
  "CompanyID": 13,
  "Language": "sample string 14",
  "CreatedDate": "2025-08-29T01:01:54.111544+00:00",
  "CreatedUserID": "c381da18-2987-43a8-bc31-202e138fb7ed",
  "ModifiedDate": "2025-08-29T01:01:54.111544+00:00",
  "ModifiedUserID": "2dea5ade-af9d-447a-9b67-b309fae68570",
  "FeatureID": "2ae59345-0618-4469-b082-c0c35f64f7e1",
  "Token": "f6f8d1e4-eafd-4529-ba86-bb83e3128897",
  "Action": 0,
  "FilterText": "sample string 21",
  "CurrentIndex": 22,
  "PageSize": 23,
  "TotalRecords": 24,
  "SortColumn": "sample string 25",
  "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:

<WorkflowHistoryLogViewModel 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">13</CompanyID>
  <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">2025-08-29T01:01:54.111544+00:00</CreatedDate>
  <CreatedUserID xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">c381da18-2987-43a8-bc31-202e138fb7ed</CreatedUserID>
  <CurrentIndex xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">22</CurrentIndex>
  <FeatureID xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">2ae59345-0618-4469-b082-c0c35f64f7e1</FeatureID>
  <FilterText xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">sample string 21</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 14</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">2025-08-29T01:01:54.111544+00:00</ModifiedDate>
  <ModifiedUserID xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">2dea5ade-af9d-447a-9b67-b309fae68570</ModifiedUserID>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">23</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 25</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">f6f8d1e4-eafd-4529-ba86-bb83e3128897</Token>
  <TotalRecords xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">24</TotalRecords>
  <Comment>sample string 8</Comment>
  <Date>2025-08-29T01:01:54.111544+00:00</Date>
  <DocumentID>2</DocumentID>
  <DocumentIDs>sample string 10</DocumentIDs>
  <DocumentTypeID>11</DocumentTypeID>
  <ExecutionHistories>
    <DocumentTestPlanStepExecutionHistoryViewModel>
      <Comment>sample string 5</Comment>
      <HistoryID>3</HistoryID>
      <ID>2</ID>
      <StatusID>4</StatusID>
      <StepID>1</StepID>
    </DocumentTestPlanStepExecutionHistoryViewModel>
    <DocumentTestPlanStepExecutionHistoryViewModel>
      <Comment>sample string 5</Comment>
      <HistoryID>3</HistoryID>
      <ID>2</ID>
      <StatusID>4</StatusID>
      <StepID>1</StepID>
    </DocumentTestPlanStepExecutionHistoryViewModel>
  </ExecutionHistories>
  <ID>1</ID>
  <ProjectID>c30ab2e0-ea6a-407c-83fb-f3320911f3b5</ProjectID>
  <ReasonID>1</ReasonID>
  <StatusIDSource>5</StatusIDSource>
  <StatusIDTarget>6</StatusIDTarget>
  <UserID>31984142-916f-4808-af80-1eb7ca229b2b</UserID>
  <WorkflowID>3</WorkflowID>
  <WorkflowVersionID>sample string 4</WorkflowVersionID>
</WorkflowHistoryLogViewModel>

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.