POST v1/Batch/Settings/Update

Get TitleSettings for this publication

Roles Allowed

admin, editor

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Prefix	string	None.
ProcessorTypeId	integer	None.
MetadataFileEnding	string	None.
PageMapFileEnding	string	None.
DatabaseServer	string	None.
DatabaseName	string	None.
DatabaseUsername	string	None.
DatabasePassword	string	None.
InputStorageAccountName	string	None.
InputStorageAccountKey	string	None.
InputStorageContainerName	string	None.
InputBaseFolder	string	None.
OriginalStorageAccountName	string	None.
OriginalStorageAccountKey	string	None.
OriginalContainerPrefix	string	None.
OutputStorageAccountName	string	None.
OutputStorageAccountKey	string	None.
OutputContainerPrefix	string	None.
LogStorageAccountName	string	None.
LogStorageAccountKey	string	None.
LogTableName	string	None.
CleanWordRegex	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.
ImageFileProcessingThreads	byte	None.
FileUploadingMaxCount	byte	None.
InputBaseFolderDebug	string	None.
AdminSiteHostHeader	string	None.
BaseThumbUrl	string	None.
SmallImageUrl	string	None.
MediumImageUrl	string	None.
LargeImageUrl	string	None.
ApiKey	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Prefix": "sample string 1",
  "ProcessorTypeId": 2,
  "MetadataFileEnding": "sample string 3",
  "PageMapFileEnding": "sample string 4",
  "DatabaseServer": "sample string 5",
  "DatabaseName": "sample string 6",
  "DatabaseUsername": "sample string 7",
  "DatabasePassword": "sample string 8",
  "InputStorageAccountName": "sample string 9",
  "InputStorageAccountKey": "sample string 10",
  "InputStorageContainerName": "sample string 11",
  "InputBaseFolder": "sample string 12",
  "OriginalStorageAccountName": "sample string 13",
  "OriginalStorageAccountKey": "sample string 14",
  "OriginalContainerPrefix": "sample string 15",
  "OutputStorageAccountName": "sample string 16",
  "OutputStorageAccountKey": "sample string 17",
  "OutputContainerPrefix": "sample string 18",
  "LogStorageAccountName": "sample string 19",
  "LogStorageAccountKey": "sample string 20",
  "LogTableName": "sample string 21",
  "CleanWordRegex": "sample string 22",
  "RunPreflight": true,
  "OverwriteExisting": true,
  "RunCoverThumbnails": true,
  "RunPageThumbnails": true,
  "RunSpreadThumbnails": true,
  "RunDatabaseIngest": true,
  "RunMobileImages": true,
  "RunMediaThumbnails": true,
  "RunWordLocations": true,
  "RunOriginalAzureUpload": true,
  "IncludeExternalLinks": true,
  "ErrorCheckExternalLinks": true,
  "ImageFileProcessingThreads": 64,
  "FileUploadingMaxCount": 64,
  "InputBaseFolderDebug": "sample string 37",
  "AdminSiteHostHeader": "sample string 38",
  "BaseThumbUrl": "sample string 39",
  "SmallImageUrl": "sample string 40",
  "MediumImageUrl": "sample string 41",
  "LargeImageUrl": "sample string 42",
  "ApiKey": "sample string 43"
}

application/xml, text/xml

Sample:

<TitleSetting xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bondi.Admin.Db.IX">
  <AdminSiteHostHeader>sample string 38</AdminSiteHostHeader>
  <ApiKey>sample string 43</ApiKey>
  <BaseThumbUrl>sample string 39</BaseThumbUrl>
  <CleanWordRegex>sample string 22</CleanWordRegex>
  <DatabaseName>sample string 6</DatabaseName>
  <DatabasePassword>sample string 8</DatabasePassword>
  <DatabaseServer>sample string 5</DatabaseServer>
  <DatabaseUsername>sample string 7</DatabaseUsername>
  <ErrorCheckExternalLinks>true</ErrorCheckExternalLinks>
  <FileUploadingMaxCount>64</FileUploadingMaxCount>
  <ImageFileProcessingThreads>64</ImageFileProcessingThreads>
  <IncludeExternalLinks>true</IncludeExternalLinks>
  <InputBaseFolder>sample string 12</InputBaseFolder>
  <InputBaseFolderDebug>sample string 37</InputBaseFolderDebug>
  <InputStorageAccountKey>sample string 10</InputStorageAccountKey>
  <InputStorageAccountName>sample string 9</InputStorageAccountName>
  <InputStorageContainerName>sample string 11</InputStorageContainerName>
  <LargeImageUrl>sample string 42</LargeImageUrl>
  <LogStorageAccountKey>sample string 20</LogStorageAccountKey>
  <LogStorageAccountName>sample string 19</LogStorageAccountName>
  <LogTableName>sample string 21</LogTableName>
  <MediumImageUrl>sample string 41</MediumImageUrl>
  <MetadataFileEnding>sample string 3</MetadataFileEnding>
  <OriginalContainerPrefix>sample string 15</OriginalContainerPrefix>
  <OriginalStorageAccountKey>sample string 14</OriginalStorageAccountKey>
  <OriginalStorageAccountName>sample string 13</OriginalStorageAccountName>
  <OutputContainerPrefix>sample string 18</OutputContainerPrefix>
  <OutputStorageAccountKey>sample string 17</OutputStorageAccountKey>
  <OutputStorageAccountName>sample string 16</OutputStorageAccountName>
  <OverwriteExisting>true</OverwriteExisting>
  <PageMapFileEnding>sample string 4</PageMapFileEnding>
  <Prefix>sample string 1</Prefix>
  <ProcessorTypeId>2</ProcessorTypeId>
  <RunCoverThumbnails>true</RunCoverThumbnails>
  <RunDatabaseIngest>true</RunDatabaseIngest>
  <RunMediaThumbnails>true</RunMediaThumbnails>
  <RunMobileImages>true</RunMobileImages>
  <RunOriginalAzureUpload>true</RunOriginalAzureUpload>
  <RunPageThumbnails>true</RunPageThumbnails>
  <RunPreflight>true</RunPreflight>
  <RunSpreadThumbnails>true</RunSpreadThumbnails>
  <RunWordLocations>true</RunWordLocations>
  <SmallImageUrl>sample string 40</SmallImageUrl>
</TitleSetting>

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.