POST v1/Batch/Add

Finds the article matching the specified articleKey.

Roles Allowed

admin, editor

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
BatchId	integer	None.
Prefix	string	None.
StartDate	date	None.
EndDate	date	None.
Cancelled	boolean	None.
VerboseLogging	boolean	None.
AddedBy	string	None.
CancelledBy	string	None.
InputBaseFolder	string	None.
RunPreflight	boolean	None.
OverwriteExisting	boolean	None.
RunCoverThumbnails	boolean	None.
RunPageThumbnails	boolean	None.
RunSpreadThumbnails	boolean	None.
RunDatabaseIngest	boolean	None.
RunMobileImages	boolean	None.
RunMediaThumbnails	boolean	None.
RunWordLocations	boolean	None.
RunOriginalAzureUpload	boolean	None.
IncludeExternalLinks	boolean	None.
ErrorCheckExternalLinks	boolean	None.
VerboseLoggingOnError	boolean	None.
Debug	boolean	None.
Processed	boolean	None.
IssueProcesses	Collection of IssueProcess	None.

Request Formats

application/json, text/json

Sample:

{
  "BatchId": 1,
  "Prefix": "sample string 2",
  "StartDate": "2025-11-04T02:07:06.040546+00:00",
  "EndDate": "2025-11-04T02:07:06.040546+00:00",
  "Cancelled": true,
  "VerboseLogging": true,
  "AddedBy": "sample string 6",
  "CancelledBy": "sample string 7",
  "InputBaseFolder": "sample string 8",
  "RunPreflight": true,
  "OverwriteExisting": true,
  "RunCoverThumbnails": true,
  "RunPageThumbnails": true,
  "RunSpreadThumbnails": true,
  "RunDatabaseIngest": true,
  "RunMobileImages": true,
  "RunMediaThumbnails": true,
  "RunWordLocations": true,
  "RunOriginalAzureUpload": true,
  "IncludeExternalLinks": true,
  "ErrorCheckExternalLinks": true,
  "VerboseLoggingOnError": true,
  "Debug": true,
  "Processed": true,
  "IssueProcesses": [
    {
      "IssueProcessId": 1,
      "BatchId": 2,
      "Prefix": "sample string 3",
      "StartDate": "2025-11-04T02:07:06.040546+00:00",
      "EndDate": "2025-11-04T02:07:06.040546+00:00",
      "Cancelled": true,
      "IssueKey": 5,
      "PageMapPath": "sample string 6",
      "Debug": true,
      "Error": true,
      "ProcessedItems": 1,
      "TotalItems": 1
    },
    {
      "IssueProcessId": 1,
      "BatchId": 2,
      "Prefix": "sample string 3",
      "StartDate": "2025-11-04T02:07:06.040546+00:00",
      "EndDate": "2025-11-04T02:07:06.040546+00:00",
      "Cancelled": true,
      "IssueKey": 5,
      "PageMapPath": "sample string 6",
      "Debug": true,
      "Error": true,
      "ProcessedItems": 1,
      "TotalItems": 1
    }
  ]
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HTTP 200 with the article if it is found, HTTP 404 if article is not found

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.