Skip to main content
Export Target Group To Excel

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

TargetGroupId

ExportTargetGroupToExcel: Renders the given targetgroup to excel, and returns the path to the temporary file.

TargetGroupId
integer<int32>

Response

OK

Carrier object for ExportArchiveResult. Services for the ExportArchiveResult Carrier is available from the Archive Agent.

BatchTaskId
integer<int32>

Id of the BatchTask created. <=0 if no BatchTask was created.

FileName
string

The path to the output file created, if it exists. Will be an empty string if no file was created.

Message
string

Descriptive messages; errors, etc.

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.