ADITION technologies - API Documentation

CustomReportService WSDL

This service is stateless.

Examples +

enqueue report
get progress
download

downloadReportFiletop

Description

Enqueue report first using enqueueReport method and check the finished progress state with
getCustomReportGenerationProgress method.
Report gets deleted at download.

CustomReportFile downloadReportFile(int $report_id, string $file_type)

Parameters

int	$report_id
string	$file_type	Allowed types: csv, xls, xlsx

Return Values

CustomReportFile

enqueueReporttop

Description

int enqueueReport(CustomReport $report)

Parameters

CustomReport

$report

Return Values

int	The id of the report

Faults

ValidationErrorMessageList

getAttributesThatAllowSubAttributestop

Description

CustomReportAttributeList getAttributesThatAllowSubAttributes(int $perspective_id)

Parameters

int

$perspective_id

Return Values

CustomReportAttributeList

getCounttop

Description

Requires administrator permissions.

int getCount()

Return Values

int

getCustomAutoReportByTemplateIdtop

Description

CustomAutoReport getCustomAutoReportByTemplateId(int $template_id)

Parameters

int

$template_id

Return Values

CustomAutoReport

getCustomReportBaseByIdtop

Description

CustomReportBase getCustomReportBaseById(int $report_id)

Parameters

int

$report_id

Return Values

CustomReportBase

getCustomReportByTemplateIdtop

Description

CustomReport getCustomReportByTemplateId(int $template_id)

Parameters

int

$template_id

Return Values

CustomReport

getCustomReportFilterableAttributestop

Description

CustomReportAttributeList getCustomReportFilterableAttributes(int $perspective_id)

Parameters

int

$perspective_id

Return Values

CustomReportAttributeList

getCustomReportGenerationProgresstop

Description

CustomReportProgress getCustomReportGenerationProgress(int $report_id)

Parameters

int

$report_id

Return Values

CustomReportProgress

getCustomReportTemplateByReportIdtop

Description

CustomReportTemplate getCustomReportTemplateByReportId(int $report_id)

Parameters

int

$report_id

Return Values

CustomReportTemplate

getPerspectivestop

Description

CustomReportPerspectiveList getPerspectives()

Return Values

CustomReportPerspectiveList

getReportAttributeByDimensionAndNametop

Description

CustomReportAttribute getReportAttributeByDimensionAndName(string $dimension_name, string $attribute_name)

Parameters

string	$dimension_name
string	$attribute_name

Return Values

CustomReportAttribute

getReportAttributeByIdtop

Description

CustomReportAttribute getReportAttributeById(int $attribute_id)

Parameters

int

$attribute_id

Return Values

CustomReportAttribute

getReportAttributesForPerspectiveIdtop

Description

CustomReportAttributeList getReportAttributesForPerspectiveId(int $perspective_id)

Parameters

int

$perspective_id

Return Values

CustomReportAttributeList

getSoaCollectionPagetop

Description

Requires administrator permissions.

CustomReportList getSoaCollectionPage(KeySetPagedSoaCollectionConfiguration $configuration)

Parameters

KeySetPagedSoaCollectionConfiguration

$configuration

Return Values

CustomReportList

getSubAttributeInfoListForAttributetop

Description

CustomReportSubAttributeInfoList getSubAttributeInfoListForAttribute(CustomReportAttribute $attribute)

Parameters

CustomReportAttribute

$attribute

Return Values

CustomReportSubAttributeInfoList

getValidSoaCollectionFiltertop

Description

SoaCollectionValidFilterList getValidSoaCollectionFilter()

Return Values

SoaCollectionValidFilterList

logintop

Description

Initializes a new session with given information

boolean login(string $user, string $pass, int $network)

Parameters

string	$user	Username
string	$pass	Password
int	$network	$network Network ID

Return Values

boolean

true on success, false on fail

logouttop

Description

Destroys the active session, logging out the user.

boolean logout()

Return Values

boolean

true on success, false on fail

removeByIdtop

Description

Remove CustomReportTemplates, CustomAutoreports and CustomReports by id

boolean removeById(int $id)

Parameters

int

$id

Return Values

boolean

saveCustomAutoreporttop

Description

int saveCustomAutoreport(CustomAutoReport $autoreport)

Parameters

CustomAutoReport

$autoreport

Return Values

int	The id of the autoreport

Faults

ValidationErrorMessageList

saveCustomReportTemplatetop

Description

int saveCustomReportTemplate(CustomReportTemplate $template)

Parameters

CustomReportTemplate

$template

Return Values

int	The id of the template

Faults

ValidationErrorMessageList

CustomAutoReporttop

Definition

object CustomAutoReport extends CustomReportBase {

- boolean $active

required

- Array <int> $recipientUserIds

optional

See: UserService

- Array <int> $recipientsContactIds

optional

See: ContactService

- Array <int> $recipientFtpAccountIds

optional

See: FtpAccountService

- Array <string> $recipientEmails

optional

- Array <int> $recipientUserGroupIds

optional

See: UserGroupService

- ShortEmailTemplate $emailTemplate

optional

See: EmailTemplateService

- string $deliveryFormat

required

One of: 'csv','xls' or 'xlsx'

- string $deliveryInterval

required

One of: 'daily','weekly','monthly' or 'none'

- string $reportingInterval

required

One of: 'daily','weekly','biweekly','monthly','quarter','6month' or 'none'

- string $reportingIntervalStartDate

optional

This becomes required if you selected a reportingInterval as 'none'
Date with the format YYYY-MM-DD

- string $reportingIntervalEndDate

optional

Date with the format YYYY-MM-DD

- string $deliveryIntervalEndDate

optional

Date with the format YYYY-MM-DD

}

CustomReporttop

Definition

object CustomReport extends CustomReportBase {

- string $startDate

required

Start date with the format YYYY-MM-DD

- string $endDate

required

End date with the format YYYY-MM-DD

}

CustomReportAttributetop

Definition

Inheriting types:
- CustomReportFilterableAttribute

object CustomReportAttribute {

- int $id

required

- string $name

required

- string $dimensionName

required

}

CustomReportAttributeListtop

Definition

object CustomReportAttributeList {

- Array <CustomReportAttribute> $attributes

required

}

CustomReportBasetop

Definition

Inheriting types:
- CustomReport
- CustomReportTemplate
- CustomAutoReport

object abstractCustomReportBase {

- int $id

optional

- string $language

optional

Eg: 'en_US'
The default language is 'de_DE'

- boolean $showNetworkLogo

optional

The default value is true

- Array <CustomReportDefinition> $definitions

required

- string $name

optional

Maximum string length is 255 characters

- int $perspectiveId

required

- boolean $enableSettings

required

Enable to show report settings

- Array <CustomReportFilter> $filters

optional

}

CustomReportDefinitiontop

Definition

object CustomReportDefinition {

- int $attributeId

required

- int $sortPosition

required

Each definition has a unique sort position index

- string $sortOrder

required

One of: 'asc' or 'desc'

- int $subAttributeId

optional

}

CustomReportFiletop

Definition

object CustomReportFile {

- string $base64FileContent

required

The file is base64 encoded. For csv chosen fileType, the file is compressed in zip format.

- string $fileName

required

}

CustomReportFiltertop

Definition

object CustomReportFilter {

- int $filterableAttributeId

required

See getCustomReportFilterableAttributes method

- int $value

required

Id value of the business object to be filtered

- int $subAttributeId

optional

}

CustomReportFilterableAttributetop

Definition

object CustomReportFilterableAttribute extends CustomReportAttribute {

}

CustomReportListtop

Definition

object CustomReportList {

- Array <CustomReportBase> $customReports

optional

- Array <NamedStringValue> $lastKeySet

optional

}

CustomReportPerspectivetop

Definition

object CustomReportPerspective {

- string $name

required

- int $id

required

}

CustomReportPerspectiveListtop

Definition

object CustomReportPerspectiveList {

- Array <CustomReportPerspective> $perspectives

required

}

CustomReportProgresstop

Definition

object CustomReportProgress {

- string $state

required

One of: 'waiting','processing','error' or 'finished'

}

CustomReportSubAttributeInfotop

Definition

object CustomReportSubAttributeInfo {

- int $id

required

- string $name

required

- string $description

required

}

CustomReportSubAttributeInfoListtop

Definition

object CustomReportSubAttributeInfoList {

- Array <CustomReportSubAttributeInfo> $attributeInfos

required

}

CustomReportTemplatetop

Definition

object CustomReportTemplate extends CustomReportBase {

- string $startDate

required

Start date with the format YYYY-MM-DD

- string $endDate

required

End date with the format YYYY-MM-DD

}

KeySetPagedSoaCollectionConfigurationtop

Definition

object KeySetPagedSoaCollectionConfiguration {

- Array <SoaCollectionFilter> $filters

optional

See SoaCollection::addQualifiedFilter()

- int $pageSize

required

- Array <NamedStringValue> $lastKeySet

optional

Read-only specification of the last collection element for key-set based paging.
The value is an implementation detail and must only be used for passing it directly
to getSoaCollectionPage() in order to navigate to the next collection page.
The value must be retrieved from the "lastKeySet" property of the previous getSoaCollectionPage() call.
To be left empty for the very first getSoaCollectionPage() call (default).

- boolean $useReplication

optional

Enables usage of replicated data increasing the performance and stability of search operations.

Regardless of this setting live data will be used instead in case of replication having
a lag of more than a couple of seconds.

}

NamedStringValuetop

Definition

object NamedStringValue {

- string $name

required

- string $value

required

}

ShortEmailTemplatetop

Definition

object ShortEmailTemplate {

- int $id

optional

- string $name

required

- string $description

optional

- string $subject

required

- string $language

required

- string $body

required

- string $replyTo

optional

- boolean $sendBcc

required

When true, an bcc mail will always be sent to the replyTo address

}

SoaCollectionFiltertop

Definition

See SoaCollection::addQualifiedFilter().

object SoaCollectionFilter {

- string $target

required

- string $value

required

- int $qualifier

required

}

SoaCollectionFilterQualifiertop

Definition

Describes the possible qualifiers for a filter target

object SoaCollectionFilterQualifier {

- string $name

required

- int $value

required

}

SoaCollectionValidFiltertop

Definition

Describes the possible qualifiers for a filter target

object SoaCollectionValidFilter {

- string $target

required

- Array <SoaCollectionFilterQualifier> $qualifiers

optional

}

SoaCollectionValidFilterListtop

Definition

A list of valid filters and their qualifiers

object SoaCollectionValidFilterList {

- Array <SoaCollectionValidFilter> $validFilters

optional

}

ValidationErrorMessagetop

Definition

object ValidationErrorMessage {

- string $identifier

required

- Array <string> $messages

required

}

ValidationErrorMessageListtop

Definition

object ValidationErrorMessageList {

- Array <ValidationErrorMessage> $messages

optional

}