Class ReportsApiExecutor

Inheritance
System.Object
ReportsApiExecutor
Implements
Namespace: Crowdin.Api.Reports
Assembly: Crowdin.Api.dll
Syntax
public class ReportsApiExecutor : object, IReportsApiExecutor

Constructors

| Improve this Doc View Source

ReportsApiExecutor(ICrowdinApiClient)

Declaration
public ReportsApiExecutor(ICrowdinApiClient apiClient)
Parameters
Type Name Description
ICrowdinApiClient apiClient
| Improve this Doc View Source

ReportsApiExecutor(ICrowdinApiClient, IJsonParser)

Declaration
public ReportsApiExecutor(ICrowdinApiClient apiClient, IJsonParser jsonParser)
Parameters
Type Name Description
ICrowdinApiClient apiClient
IJsonParser jsonParser

Methods

| Improve this Doc View Source

AddReportSettingsTemplate(Int32, AddReportSettingsTemplateRequest)

Add report settings template. Documentation: Crowdin API Crowdin Enterprise API

Declaration
public async Task<ReportSettingsTemplateBase> AddReportSettingsTemplate(int projectId, AddReportSettingsTemplateRequest request)
Parameters
Type Name Description
System.Int32 projectId
AddReportSettingsTemplateRequest request
Returns
Type Description
Task<ReportSettingsTemplateBase>
| Improve this Doc View Source

AddUserReportSettingsTemplate(Int32, AddUserReportSettingsTemplateRequest)

Add User Report Settings Template. Documentation: Crowdin API Crowdin String Based API Crowdin Enterprise API

Declaration
public async Task<UserReportSettingsTemplate> AddUserReportSettingsTemplate(int userId, AddUserReportSettingsTemplateRequest request)
Parameters
Type Name Description
System.Int32 userId
AddUserReportSettingsTemplateRequest request
Returns
Type Description
Task<UserReportSettingsTemplate>
| Improve this Doc View Source

CheckGroupReportGenerationStatus(Int32, Int32)

Check group report generation status. Documentation: Crowdin Enterprise API

Declaration
public async Task<GroupReportStatus> CheckGroupReportGenerationStatus(int groupId, int reportId)
Parameters
Type Name Description
System.Int32 groupId
System.Int32 reportId
Returns
Type Description
Task<GroupReportStatus>
| Improve this Doc View Source

CheckOrganizationReportGenerationStatus(Int32)

Check organization report generation status. Documentation: Crowdin Enterprise API

Declaration
public async Task<GroupReportStatus> CheckOrganizationReportGenerationStatus(int reportId)
Parameters
Type Name Description
System.Int32 reportId
Returns
Type Description
Task<GroupReportStatus>
| Improve this Doc View Source

CheckReportArchiveExportStatus(Nullable<Int32>, Int32, String)

Check Report Archive Export Status. Documentation: Crowdin API Crowdin Enterprise API

Declaration
public async Task<GroupReportStatus> CheckReportArchiveExportStatus(int? userId, int archiveId, string exportId)
Parameters
Type Name Description
System.Nullable<System.Int32> userId
System.Int32 archiveId
System.String exportId
Returns
Type Description
Task<GroupReportStatus>
| Improve this Doc View Source

CheckReportGenerationStatus(Int32, String)

Check report generation status. Documentation: Crowdin API Crowdin Enterprise API

Declaration
public async Task<ReportStatus> CheckReportGenerationStatus(int projectId, string reportId)
Parameters
Type Name Description
System.Int32 projectId
System.String reportId
Returns
Type Description
Task<ReportStatus>
| Improve this Doc View Source

DeleteReportArchive(Nullable<Int32>, Int32)

Delete Report Archive. Documentation: Crowdin API Crowdin Enterprise API

Declaration
public async Task DeleteReportArchive(int? userId, int archiveId)
Parameters
Type Name Description
System.Nullable<System.Int32> userId
System.Int32 archiveId
Returns
Type Description
Task
| Improve this Doc View Source

DeleteReportSettingsTemplate(Int32, Int32)

Delete report settings template. Documentation: Crowdin API Crowdin Enterprise API

Declaration
public async Task DeleteReportSettingsTemplate(int projectId, int reportSettingsTemplateId)
Parameters
Type Name Description
System.Int32 projectId
System.Int32 reportSettingsTemplateId
Returns
Type Description
Task
| Improve this Doc View Source

DeleteUserReportSettingsTemplate(Int32, Int32)

Delete User Report Settings Template. Documentation: Crowdin API Crowdin String Based API Crowdin Enterprise API

Declaration
public async Task DeleteUserReportSettingsTemplate(int userId, int reportSettingsTemplateId)
Parameters
Type Name Description
System.Int32 userId
System.Int32 reportSettingsTemplateId
Returns
Type Description
Task
| Improve this Doc View Source

DownloadGroupReport(Int32, Int32)

Download group report. Documentation: Crowdin Enterprise API

Declaration
public async Task<DownloadLink> DownloadGroupReport(int groupId, int reportId)
Parameters
Type Name Description
System.Int32 groupId
System.Int32 reportId
Returns
Type Description
Task<DownloadLink>
| Improve this Doc View Source

DownloadOrganizationReport(Int32)

Download organization report. Documentation: Crowdin Enterprise API

Declaration
public async Task<DownloadLink> DownloadOrganizationReport(int reportId)
Parameters
Type Name Description
System.Int32 reportId
Returns
Type Description
Task<DownloadLink>
| Improve this Doc View Source

DownloadReport(Int32, String)

Download report. Documentation: Crowdin API Crowdin Enterprise API

Declaration
public async Task<DownloadLink> DownloadReport(int projectId, string reportId)
Parameters
Type Name Description
System.Int32 projectId
System.String reportId
Returns
Type Description
Task<DownloadLink>
| Improve this Doc View Source

DownloadReportArchive(Nullable<Int32>, Int32, String)

Download Report Archive. Documentation: Crowdin API Crowdin Enterprise API

Declaration
public async Task<DownloadLink> DownloadReportArchive(int? userId, int archiveId, string exportId)
Parameters
Type Name Description
System.Nullable<System.Int32> userId
System.Int32 archiveId
System.String exportId
Returns
Type Description
Task<DownloadLink>
| Improve this Doc View Source

EditReportSettingsTemplate(Int32, Int32, IEnumerable<ReportSettingsTemplatePatch>)

Edit report settings template. Documentation: Crowdin API Crowdin Enterprise API

Declaration
public async Task<ReportSettingsTemplateBase> EditReportSettingsTemplate(int projectId, int reportSettingsTemplateId, IEnumerable<ReportSettingsTemplatePatch> patches)
Parameters
Type Name Description
System.Int32 projectId
System.Int32 reportSettingsTemplateId
IEnumerable<ReportSettingsTemplatePatch> patches
Returns
Type Description
Task<ReportSettingsTemplateBase>
| Improve this Doc View Source

EditUserReportSettingsTemplate(Int32, Int32, IEnumerable<UserReportSettingsTemplatePatch>)

Edit User Report Settings Template. Documentation: Crowdin API Crowdin String Based API Crowdin Enterprise API

Declaration
public async Task<UserReportSettingsTemplate> EditUserReportSettingsTemplate(int userId, int reportSettingsTemplateId, IEnumerable<UserReportSettingsTemplatePatch> patches)
Parameters
Type Name Description
System.Int32 userId
System.Int32 reportSettingsTemplateId
IEnumerable<UserReportSettingsTemplatePatch> patches
Returns
Type Description
Task<UserReportSettingsTemplate>
| Improve this Doc View Source

ExportReportArchive(Nullable<Int32>, Int32, ExportReportArchiveRequest)

Export Report Archive. Documentation: Crowdin API Crowdin Enterprise API

Declaration
public async Task<GroupReportStatus> ExportReportArchive(int? userId, int archiveId, ExportReportArchiveRequest request)
Parameters
Type Name Description
System.Nullable<System.Int32> userId
System.Int32 archiveId
ExportReportArchiveRequest request
Returns
Type Description
Task<GroupReportStatus>
| Improve this Doc View Source

GenerateGroupReport(Int32, GenerateGroupReportRequest)

Generate group report. Documentation: Crowdin Enterprise API

Declaration
public async Task<GroupReportStatus> GenerateGroupReport(int groupId, GenerateGroupReportRequest request)
Parameters
Type Name Description
System.Int32 groupId
GenerateGroupReportRequest request
Returns
Type Description
Task<GroupReportStatus>
| Improve this Doc View Source

GenerateOrganizationReport(GenerateGroupReportRequest)

Generate organization report. Documentation: Crowdin Enterprise API

Declaration
public async Task<GroupReportStatus> GenerateOrganizationReport(GenerateGroupReportRequest request)
Parameters
Type Name Description
GenerateGroupReportRequest request
Returns
Type Description
Task<GroupReportStatus>
| Improve this Doc View Source

GenerateReport(Int32, GenerateReportRequest)

Generate report. Documentation: Crowdin API Crowdin Enterprise API

Declaration
public async Task<ReportStatus> GenerateReport(int projectId, GenerateReportRequest request)
Parameters
Type Name Description
System.Int32 projectId
GenerateReportRequest request
Returns
Type Description
Task<ReportStatus>
| Improve this Doc View Source

GetReportArchive(Nullable<Int32>, Int32)

Get Report Archive. Documentation: Crowdin API Crowdin Enterprise API

Declaration
public async Task<ReportArchive> GetReportArchive(int? userId, int archiveId)
Parameters
Type Name Description
System.Nullable<System.Int32> userId
System.Int32 archiveId
Returns
Type Description
Task<ReportArchive>
| Improve this Doc View Source

GetReportSettingsTemplate(Int32, Int32)

Get report settings template. Documentation: Crowdin API Crowdin Enterprise API

Declaration
public async Task<ReportSettingsTemplateBase> GetReportSettingsTemplate(int projectId, int reportSettingsTemplateId)
Parameters
Type Name Description
System.Int32 projectId
System.Int32 reportSettingsTemplateId
Returns
Type Description
Task<ReportSettingsTemplateBase>
| Improve this Doc View Source

GetUserReportSettingsTemplate(Int32, Int32)

Get User Report Settings Template. Documentation: Crowdin API Crowdin String Based API Crowdin Enterprise API

Declaration
public async Task<UserReportSettingsTemplate> GetUserReportSettingsTemplate(int userId, int reportSettingsTemplateId)
Parameters
Type Name Description
System.Int32 userId
System.Int32 reportSettingsTemplateId
Returns
Type Description
Task<UserReportSettingsTemplate>
| Improve this Doc View Source

ListReportArchives(Nullable<Int32>, Nullable<ScopeType>, Nullable<Int32>, Int32, Int32)

List Report Archives. Documentation: Crowdin API Crowdin Enterprise API

Declaration
public async Task<ResponseList<ReportArchive>> ListReportArchives(int? userId, ScopeType? scopeType = null, int? scopeId = null, int limit = 25, int offset = 0)
Parameters
Type Name Description
System.Nullable<System.Int32> userId
System.Nullable<ScopeType> scopeType
System.Nullable<System.Int32> scopeId
System.Int32 limit
System.Int32 offset
Returns
Type Description
Task<ResponseList<ReportArchive>>
| Improve this Doc View Source

ListReportSettingsTemplates(Int32, Int32, Int32)

List report settings templates. Documentation: Crowdin API Crowdin Enterprise API

Declaration
public async Task<ResponseList<ReportSettingsTemplateBase>> ListReportSettingsTemplates(int projectId, int limit = 25, int offset = 0)
Parameters
Type Name Description
System.Int32 projectId
System.Int32 limit
System.Int32 offset
Returns
Type Description
Task<ResponseList<ReportSettingsTemplateBase>>
| Improve this Doc View Source

ListUserReportSettingsTemplates(Int32, Int32, Int32)

List User Report Settings Templates. Documentation: Crowdin API Crowdin String Based API Crowdin Enterprise API

Declaration
public async Task<ResponseList<UserReportSettingsTemplate>> ListUserReportSettingsTemplates(int userId, int limit = 25, int offset = 0)
Parameters
Type Name Description
System.Int32 userId
System.Int32 limit
System.Int32 offset
Returns
Type Description
Task<ResponseList<UserReportSettingsTemplate>>

Implements