POST api/services/import/v1/queue/batch

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Title	string	None.
ActiveOnly	boolean	None.
FinishedOnly	boolean	None.
DistinctOnly	boolean	None.
ImportType	string	None.
ImportMode	string	None.
ImportState	string	None.
StartDate	date	None.
EndDate	date	None.
User	string	None.
Division	string	None.
IsUserAdmin	boolean	None.
CurrentUserOnly	boolean	None.
UserDivisions	Collection of string	None.
ImportStates	Collection of string	None.
BatchNumber	integer	None.
BatchSize	integer	None.
IncludeCount	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "Title": "sample string 1",
  "ActiveOnly": true,
  "FinishedOnly": true,
  "DistinctOnly": true,
  "ImportType": "sample string 5",
  "ImportMode": "sample string 6",
  "ImportState": "sample string 7",
  "StartDate": "2025-04-04T23:06:41.4746672+02:00",
  "EndDate": "2025-04-04T23:06:41.4746672+02:00",
  "User": "sample string 10",
  "Division": "sample string 11",
  "IsUserAdmin": true,
  "CurrentUserOnly": true,
  "UserDivisions": [
    "sample string 1",
    "sample string 2"
  ],
  "ImportStates": [
    "sample string 1",
    "sample string 2"
  ],
  "BatchNumber": 14,
  "BatchSize": 15,
  "IncludeCount": true
}

application/xml, text/xml

Sample:

<FilterOptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Andritz.AES.SPC.ImportTool.JobManagement.Monitoring">
  <ActiveOnly>true</ActiveOnly>
  <BatchNumber>14</BatchNumber>
  <BatchSize>15</BatchSize>
  <CurrentUserOnly>true</CurrentUserOnly>
  <DistinctOnly>true</DistinctOnly>
  <Division>sample string 11</Division>
  <EndDate>2025-04-04T23:06:41.4746672+02:00</EndDate>
  <FinishedOnly>true</FinishedOnly>
  <ImportMode>sample string 6</ImportMode>
  <ImportState>sample string 7</ImportState>
  <ImportStates xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ImportStates>
  <ImportType>sample string 5</ImportType>
  <IncludeCount>true</IncludeCount>
  <IsUserAdmin>true</IsUserAdmin>
  <StartDate>2025-04-04T23:06:41.4746672+02:00</StartDate>
  <Title>sample string 1</Title>
  <User>sample string 10</User>
  <UserDivisions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </UserDivisions>
</FilterOptions>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DataBatch

Name	Type	Additional information
batchNumber	integer	None.
batchSize	integer	None.
queueData	Collection of QueueData	None.
totalCount	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "batchNumber": 1,
  "batchSize": 2,
  "queueData": [
    {
      "Id": 1,
      "Title": "sample string 2",
      "ImportType": "PID",
      "ImportMode": "Import",
      "ImportState": "Created",
      "JobStartTime": "2025-04-04T23:06:41.4902897+02:00",
      "JobEndTime": "2025-04-04T23:06:41.4902897+02:00",
      "User": "sample string 4",
      "NumberOfErrors": "sample string 5",
      "ToolVersion": "sample string 6",
      "IsActionDisabled": true,
      "TaskIdWhileActive": 8,
      "Division": "sample string 9",
      "LastChanged": "2025-04-04T23:06:41.4902897+02:00",
      "ImportErrorType": "Default",
      "QueuePosition": 1,
      "QueueLength": 10,
      "ImportJobType": "ImportProcess"
    },
    {
      "Id": 1,
      "Title": "sample string 2",
      "ImportType": "PID",
      "ImportMode": "Import",
      "ImportState": "Created",
      "JobStartTime": "2025-04-04T23:06:41.4902897+02:00",
      "JobEndTime": "2025-04-04T23:06:41.4902897+02:00",
      "User": "sample string 4",
      "NumberOfErrors": "sample string 5",
      "ToolVersion": "sample string 6",
      "IsActionDisabled": true,
      "TaskIdWhileActive": 8,
      "Division": "sample string 9",
      "LastChanged": "2025-04-04T23:06:41.4902897+02:00",
      "ImportErrorType": "Default",
      "QueuePosition": 1,
      "QueueLength": 10,
      "ImportJobType": "ImportProcess"
    }
  ],
  "totalCount": 1
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.