Skip to main content
Regenerate Index

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$select
string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

Body

RunAsBatch

RegenerateIndex: Wipe and regenerate the freetext index by scanning the database (freetext search will be unavailable while this operation runs

RunAsBatch
boolean

Response

OK

BatchTaskInfo contains information about one batch task. Carrier object for BatchTaskInfo. Services for the BatchTaskInfo Carrier is available from the Batch Agent.

Id
integer<int32>

Id of the task.

Name
string

Name of the task.

AssociateId
integer<int32>

Task owner. If it is a System task, AssociateId = 0.

DetailsTable
integer<int32>

Id of table with more information about the task.

DetailsRecord
integer<int32>

Record Id of a row in the DetailsTable containing more info about the task.

IsSystemTask
boolean

If IsSystemTask is true, the task is not initiated by an associate.

IsInternalTask
boolean

If IsInternalTask is true, this task will not add a trace to the database.

ParameterObject
object

ParameterObject will be serialized to a binary blob and saved in the BinaryObject table. The link to the BinaryObject will be set using DetailsTable and DetailsRecord.

LastStarted
string<date-time>

When was the task last started.

Created
string<date-time>

Task creation time.

StartCount
integer<int32>

Maps to the startcount field in the batchtask table.

DatabaseSerialNumber
string

Serial number of the database the task is to run on.

Context
string

Context for the executing task.

Result
string

Maps to the result field in the batchtask table.

State
enum<string>

BatchTaskState of the task.

Available options:
Unknown,
New,
Aquired,
Started,
Succeeded,
Failed,
SucceededManualCleanup,
All
Description
string

Description of the task.

Response
string

Maps to the response field in the batchtask table.

Request
string

Maps to the request field in the batchtask table.

ProgressDescription
string

Descriptive text for the current stage

ProgressPercent
integer<int32>

Task progress, in percent of estimated total

FileName
string

The filename related to the batchtask.

CancellationBehaviour
enum<string>

Indicate if the task can be stopped.

Available options:
CanCancel,
CancelWithWarning,
CannotCancel
TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.