GET api/taskprocessor/processes?activesOnly={activesOnly}

Gets processes.

Request Information

URI Parameters

Name	Description	Type	Additional information
activesOnly	Get only active processes	boolean	Required

Body Parameters

None.

Response Information

Resource Description

TaskProcessorProcessModel

Name	Type	Additional information
Id	integer	None.
ProcessName	string	None.
Description	string	None.
TimerInterval	integer	None.
TimerIntervalUnit	TimePeriodEnum	None.
Starts	time interval	None.
Ends	time interval	None.
IsActive	boolean	None.
CreatedOn	date	None.
IsSingleRequestProcess	boolean	None.
RequestConfig	TaskProcessorProcessRequestConfigModel	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "processName": "sample string 2",
  "description": "sample string 3",
  "timerInterval": 4,
  "timerIntervalUnit": 1,
  "starts": "00:00:00.1234567",
  "ends": "00:00:00.1234567",
  "isActive": true,
  "createdOn": "2024-10-14T08:27:44.9679545-04:00",
  "isSingleRequestProcess": true,
  "requestConfig": {
    "processId": 1,
    "requestType": 1,
    "route": "sample string 2",
    "userId": 3,
    "parameters": "sample string 4",
    "requestBody": "sample string 5"
  }
}

application/xml, text/xml

Sample:

<TaskProcessorProcessModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.Core.Models">
  <CreatedOn>2024-10-14T08:27:44.9679545-04:00</CreatedOn>
  <Description>sample string 3</Description>
  <Ends>PT0.1234567S</Ends>
  <Id>1</Id>
  <IsActive>true</IsActive>
  <IsSingleRequestProcess>true</IsSingleRequestProcess>
  <ProcessName>sample string 2</ProcessName>
  <RequestConfig>
    <Parameters>sample string 4</Parameters>
    <ProcessId>1</ProcessId>
    <RequestBody>sample string 5</RequestBody>
    <RequestType>Post</RequestType>
    <Route>sample string 2</Route>
    <UserId>3</UserId>
  </RequestConfig>
  <Starts>PT0.1234567S</Starts>
  <TimerInterval>4</TimerInterval>
  <TimerIntervalUnit>Milisecond</TimerIntervalUnit>
</TaskProcessorProcessModel>