@octra/ngx-octra-api

This library provides a module with all methods supported by octra-backend API.

Installation

1. npm install @octra/ngx-octra-api

2. Import Module NgxOctraApiModule:

@NgModule({
  declarations: [AppComponent],
  imports: [
    BrowserModule,
    BrowserAnimationsModule,
    HttpClientModule,
    NgxOctraApiModule, // <-- IMPORT
  ],
  providers: [],
  bootstrap: [AppComponent],
  exports: [],
})
export class AppModule {}

3. Initialize the API Service:

// ...
class AppComponent {
  constructor(private apiService: OctraAPIService) {
    const url = '';
    const appToken = '';
    const webToken = '';
    const useCookies = true;

    this.apiService.init(url, appToken, webToken, useCookies);
  }
  // ...
}

4. Now see chapter Methods for more information about supported API functions. Refer to the API reference generated by an octra-server for more information.

Methods

addBatchUploadTaskData()

addBatchUploadTaskData(session_timestamp, session_id, project_id, properties, inputs, outputs): Observable<HttpEvent<unknown>>

Defined in: octra-api.service.ts:1141

adds a new batch upload operation

Allowed user roles: administrator, project_admin, data_delivery

Parameters

session_timestamp

number

session_id

string

project_id

string

properties

TaskProperties

inputs

File[]

outputs

File[] = []

Returns

Observable<HttpEvent<unknown>>

applyTaskBatchAction()

applyTaskBatchAction(project_id, dto): Observable<TaskListItemDto[][]>

Defined in: octra-api.service.ts:1713

applies an action (edit, delete, duplicate) on selected tasks. Set one of the properties duplicate, move, delete to determin

Allowed user roles: administrator, project_admin

Parameters

project_id

string

dto

TaskApplyBatchActionDto

Returns

Observable<TaskListItemDto[][]>

assignProjectRoles()

assignProjectRoles(project_id, dto): Observable<ProjectRoleResultDto[]>

Defined in: octra-api.service.ts:1307

assigns roles for an account to a specific project.

Allowed user roles: administrator

Parameters

project_id

string

dto

(ProjectAssignRoleByAccountIDDto | ProjectAssignRoleByEmailAddressDto)[]

Returns

Observable<ProjectRoleResultDto[]>

cancelBatchSession()

cancelBatchSession(project_id, session_id, session_timestamp): Observable<void>

Defined in: octra-api.service.ts:1104

cancels an existing session and removes all its temporary data. Recommended to save disk space on server.

Allowed user roles: administrator, project_admin, data_delivery

Parameters

project_id

string

session_id

string

session_timestamp

number

Returns

Observable<void>

changeAppToken()

changeAppToken(id, tokenData): Observable<AppTokenDto>

Defined in: octra-api.service.ts:616

changes an app token.

Allowed user roles: administrator

Parameters

id

string

tokenData

AppTokenChangeDto

Returns

Observable<AppTokenDto>

changeEmailTemplateTranslation()

changeEmailTemplateTranslation(templateID, translationID, body): Observable<EmailTemplateTranslationDto>

Defined in: octra-api.service.ts:1677

changes a email template translation

Allowed user roles: administrator

Parameters

templateID

number

translationID

string

body

EmailTranslationChangeRequestDto

Returns

Observable<EmailTemplateTranslationDto>

changeImprint()

changeImprint(data): Observable<ImprintDto>

Defined in: octra-api.service.ts:1521

returns an object containing the imprint

Allowed user roles: administrator

Parameters

data

ImprintSaveDto

Returns

Observable<ImprintDto>

changeLink()

changeLink(project_id, link_id, dto): Observable<LinkDto>

Defined in: octra-api.service.ts:1599

changes given link from project.

Allowed user roles: administrator, project_admin

Parameters

project_id

string

link_id

string

dto

LinkOptionsDto

Returns

Observable<LinkDto>

changeMyJSONQuery()

changeMyJSONQuery(dto, query_id): Observable<JSONQueryDatabaseDto>

Defined in: octra-api.service.ts:796

changes a given query for the current user

Allowed user roles: all

Parameters

dto

JSONQueryCreateDto

query_id

string

Returns

Observable<JSONQueryDatabaseDto>

changeMyPassword()

changeMyPassword(oldPassword, newPassword): Observable<void>

Defined in: octra-api.service.ts:543

changes the password of the current account.

Parameters

oldPassword

string

newPassword

string

Returns

Observable<void>

changeMyPersonalAccountInformation()

changeMyPersonalAccountInformation(data): Observable<void>

Defined in: octra-api.service.ts:1356

sets personal information about the own account.

Allowed user roles: administrator, user

Parameters

data

ChangeAccountInformationDto

Returns

Observable<void>

changePolicyTranslation()

changePolicyTranslation(policy_id, policy_translation_id, dto): Observable<PolicyTranslationDto>

Defined in: octra-api.service.ts:1468

updates a policy translation.

Allowed user roles: administrator

Parameters

policy_id

number

policy_translation_id

number

dto

PolicyCreateTranslationDto

Returns

Observable<PolicyTranslationDto>

changeProject()

changeProject(id, requestData): Observable<void>

Defined in: octra-api.service.ts:595

changes a specific project.

Allowed user roles: administrator, project_admin

Parameters

id

string

requestData

ProjectRequestDto

Returns

Observable<void>

changeProjectJSONQuery()

changeProjectJSONQuery(projectID, dto, query_id): Observable<JSONQueryDatabaseDto>

Defined in: octra-api.service.ts:836

changes a given query for a given project

Allowed user roles: administrator, project_admin

Parameters

projectID

string

dto

JSONQueryCreateDto

query_id

string

Returns

Observable<JSONQueryDatabaseDto>

changeRole()

changeRole(id, dto): Observable<RoleDto>

Defined in: octra-api.service.ts:1282

changes a specific role.

Allowed user roles: administrator

Parameters

id

string

dto

RoleCreateDto

Returns

Observable<RoleDto>

changeTaskData()

changeTaskData(projectID, taskID, properties, inputs, outputs, log, inputsMetaData, outputsMetaData): Observable<HttpEvent<unknown>>

Defined in: octra-api.service.ts:958

changes a task and it's data. If properties.files_destination is set it is going to be applied only on a new media file. If you want to move a already uploaded file, use moveProjectFile() method.

Allowed user roles: administrator, project_admin, data_delivery

Parameters

projectID

string

taskID

string

properties

TaskSaveDtoProperties

inputs

File[] = []

outputs

File[] = []

log

undefined | File

inputsMetaData

IOMetaData[] = []

outputsMetaData

IOMetaData[] = []

Returns

Observable<HttpEvent<unknown>>

changeTool()

changeTool(id, dto): Observable<ToolDto>

Defined in: octra-api.service.ts:446

changes a registered tool.

Allowed user roles: administrator

Parameters

id

number

dto

ToolChangeRequestDto

Returns

Observable<ToolDto>

changeToolConfiguration()

changeToolConfiguration(projectId, configId, dto): Observable<ToolConfigurationDto>

Defined in: octra-api.service.ts:296

changes a configuration of a specific project by a specific id.

Allowed user roles: administrator, project_admin

Parameters

projectId

string

configId

string

dto

ToolConfigurationChangeDto

Returns

Observable<ToolConfigurationDto>

checkIfProjectFilesExist()

checkIfProjectFilesExist(projectId, dto): Observable<ProjectFileExistResponseDto>

Defined in: octra-api.service.ts:332

checks for each given file if it exists in the database,

Parameters

projectId

string

dto

ProjectFileExistRequestDto

Returns

Observable<ProjectFileExistResponseDto>

continueTask()

continueTask(projectID, taskID): Observable<TaskDto>

Defined in: octra-api.service.ts:680

continues a task (only if status is 'BUSY' or 'PAUSED' and worker_id is the same as id by current user).

Allowed user roles: administrator, project_admin

Parameters

projectID

string

taskID

string

Returns

Observable<TaskDto>

convertTaskIOToOCBJSONFileReference()

convertTaskIOToOCBJSONFileReference(io): OCBJSONFileReference

Defined in: octra-api.service.ts:1920

Parameters

io

TaskInputOutputDto

Returns

OCBJSONFileReference

createAccount()

createAccount(dto): Observable<AccountDto>

Defined in: octra-api.service.ts:578

creates a new account.

Allowed user roles: administrator

Parameters

dto

AccountCreateRequestDto

Returns

Observable<AccountDto>

createAppToken()

createAppToken(tokenData): Observable<boolean>

Defined in: octra-api.service.ts:605

creates a new app token.

Allowed user roles: administrator

Parameters

tokenData

AppTokenCreateDto

Returns

Observable<boolean>

createEmailTemplateTranslation()

createEmailTemplateTranslation(templateID, body): Observable<EmailTemplateTranslationDto>

Defined in: octra-api.service.ts:1686

creates a new translation for a given template

Allowed user roles: administrator

Parameters

templateID

number

body

EmailTranslationChangeRequestDto

Returns

Observable<EmailTemplateTranslationDto>

createMyJSONQuery()

createMyJSONQuery(dto): Observable<JSONQueryDatabaseDto>

Defined in: octra-api.service.ts:786

creates a given query for the current user

Allowed user roles: all

Parameters

dto

JSONQueryCreateDto

Returns

Observable<JSONQueryDatabaseDto>

createPolicy()

createPolicy(dto): Observable<PolicyDto>

Defined in: octra-api.service.ts:1409

adds a new policy with undefined publish date (draft). Only one draft per policy type may exist.

Allowed user roles: administrator

Parameters

dto

PolicyCreateRequestDto

Returns

Observable<PolicyDto>

createPolicyTranslation()

createPolicyTranslation(policy_id, dto): Observable<PolicyTranslationDto>

Defined in: octra-api.service.ts:1441

adds a new policy translation.

Allowed user roles: administrator

Parameters

policy_id

number

dto

PolicyCreateTranslationDto

Returns

Observable<PolicyTranslationDto>

createProject()

createProject(projectData): Observable<ProjectDto>

Defined in: octra-api.service.ts:505

creates a new project.

Allowed user roles: administrator

Parameters

projectData

ProjectRequestDto

Returns

Observable<ProjectDto>

createProjectFolder()

createProjectFolder(project_id, dto): Observable<void>

Defined in: octra-api.service.ts:1319

create a folder in a project directory

Allowed user roles: administrator, project_admin

Parameters

project_id

string

dto

ProjectFileCreateFolderRequestDto

Returns

Observable<void>

createProjectJSONQuery()

createProjectJSONQuery(projectID, dto): Observable<JSONQueryDatabaseDto>

Defined in: octra-api.service.ts:826

creates a given query for a given project

Allowed user roles: administrator, project_admin

Parameters

projectID

string

dto

JSONQueryCreateDto

Returns

Observable<JSONQueryDatabaseDto>

createRole()

createRole(dto): Observable<RoleDto>

Defined in: octra-api.service.ts:1271

create a new role.

Allowed user roles: administrator

Parameters

dto

RoleCreateDto

Returns

Observable<RoleDto>

createToolConfiguration()

createToolConfiguration(projectId, dto): Observable<ToolConfigurationDto>

Defined in: octra-api.service.ts:314

creates a new configuration of a specific project and a specific type of task.

Allowed user roles: administrator

Parameters

projectId

string

dto

ToolConfigurationCreateDto

Returns

Observable<ToolConfigurationDto>

deleteEmailTemplateTranslation()

deleteEmailTemplateTranslation(templateID, translationID): Observable<void>

Defined in: octra-api.service.ts:1695

removes a given translation

Allowed user roles: administrator

Parameters

templateID

number

translationID

string

Returns

Observable<void>

deleteMyAccount()

deleteMyAccount(): Observable<void>

Defined in: octra-api.service.ts:1732

sends an email with a request for removing the current account

Allowed user roles: all

Returns

Observable<void>

deleteMyJSONQuery()

deleteMyJSONQuery(query_id): Observable<void>

Defined in: octra-api.service.ts:806

removes a given query by id

Allowed user roles: all

Parameters

query_id

string

Returns

Observable<void>

deleteProjectFiles()

deleteProjectFiles(projectID, items): Observable<void>

Defined in: octra-api.service.ts:485

deletes a list of given project files represented by path or file_project_id

Allowed user roles: administrator, project_admin

Parameters

projectID

string

items

DeleteProjectFilesRequest[]

Returns

Observable<void>

deleteProjectJSONQuery()

deleteProjectJSONQuery(projectID, query_id): Observable<void>

Defined in: octra-api.service.ts:846

removes a given query by id

Allowed user roles: administrator, project_admin

Parameters

projectID

string

query_id

string

Returns

Observable<void>

downloadDataPackage()

downloadDataPackage(project_id, data): Observable<unknown>

Defined in: octra-api.service.ts:1557

requests a download package for the selected options. As soon as requested a link entry is generated with status "WAITING".

urls can not be exported to task_outputs First the output is converted to AnnotJSON and then to other formats some converters need audio information. if a converter can't export data it's skipped.

Allowed user roles: administrator, project_admin

Parameters

project_id

string

data

DownloadPackageOptionsDto

Returns

Observable<unknown>

downloadTasksPackage()

downloadTasksPackage(project_id, data): Observable<TaskBatchDownloadResponseDto>

Defined in: octra-api.service.ts:1566

Parameters

project_id

string

data

TaskBatchDownloadDto

Returns

Observable<TaskBatchDownloadResponseDto>

duplicateProject()

duplicateProject(project_id, dto): Observable<ProjectDto>

Defined in: octra-api.service.ts:1722

duplicates a specific project.

Allowed user roles: administrator

Parameters

project_id

string

dto

ProjectDuplicateDto

Returns

Observable<ProjectDto>

duplicateToolConfiguration()

duplicateToolConfiguration(projectId, configId): Observable<ToolConfigurationDto>

Defined in: octra-api.service.ts:323

duplicates an existing configuration of a specific project.

Allowed user roles: administrator, project_admin

Parameters

projectId

string

configId

string

Returns

Observable<ToolConfigurationDto>

existWithEmailAddresses()

existWithEmailAddresses(dto): Observable<AccountExistByEmailResultDto[]>

Defined in: octra-api.service.ts:1328

checks if a given set of email addresses is registered.

Allowed user roles: administrator, project_admin

Parameters

dto

AccountExistByEmailDto[]

Returns

Observable<AccountExistByEmailResultDto[]>

freeTask()

freeTask(projectID, taskID): Observable<TaskDto>

Defined in: octra-api.service.ts:1013

sets the task status to 'FREE' and resets start and enddate and worker_id. If no assigned_worker_id exists the task can be processed by another worker.

Fails if the signed in user is not equal the worker for this task or the task is already finished.

Allowed user roles: all with access

Parameters

projectID

string

taskID

string

Returns

Observable<TaskDto>

getAccountCreatedStatistics()

getAccountCreatedStatistics(): Observable<AllAccountsTimeSeriesDto>

Defined in: octra-api.service.ts:640

returns a time series about all created users.

Returns

Observable<AllAccountsTimeSeriesDto>

getAccountInformation()

getAccountInformation(id): Observable<AccountDto>

Defined in: octra-api.service.ts:1375

returns information about a specific account.

Allowed user roles: administrator

Parameters

id

string

Returns

Observable<AccountDto>

getAllStatistics()

getAllStatistics(): Observable<AllStatisticsDto>

Defined in: octra-api.service.ts:633

returns statistics about number of accounts, roles, projects, tasks and app tokens. The response is cached every 15 minutes.

Returns

Observable<AllStatisticsDto>

getAppProperties()

getAppProperties(): Observable<AppPropertiesDto>

Defined in: octra-api.service.ts:514

returns properties defined by the server for the current app.

Allowed user roles: administrator

Returns

Observable<AppPropertiesDto>

getAppToken()

getAppToken(id): Observable<AppTokenDto>

Defined in: octra-api.service.ts:234

returns one specific app token.

Allowed user roles: administrator

Parameters

id

string

Returns

Observable<AppTokenDto>

getCookie()

getCookie(cname): undefined | string

Defined in: octra-api.service.ts:1868

Parameters

cname

string

Returns

undefined | string

getEmailTemplate()

getEmailTemplate(id, queryParams?): Observable<EmailTemplateDto>

Defined in: octra-api.service.ts:1667

retrieves a specific template and its translations

Allowed user roles: administrator

Parameters

id

string

queryParams?

StandardPageQueryParamsDto

Returns

Observable<EmailTemplateDto>

getEmailTemplateTranslation()

getEmailTemplateTranslation(templateID, translationID): Observable<EmailTemplateTranslationDto>

Defined in: octra-api.service.ts:1704

retrieves a specific translation from a given translation.

Allowed user roles: administrator

Parameters

templateID

number

translationID

string

Returns

Observable<EmailTemplateTranslationDto>

getHealthOverview()

getHealthOverview(): Observable<HealthOverviewDto>

Defined in: octra-api.service.ts:1750

retrieves a specific translation from a given translation.

Allowed user roles: administrator

Returns

Observable<HealthOverviewDto>

getImprint()

getImprint(): Observable<ImprintDto>

Defined in: octra-api.service.ts:1512

returns an object containing the imprint

Allowed user roles: administrator

Returns

Observable<ImprintDto>

getMyAccountInformation()

getMyAccountInformation(): Observable<CurrentAccountDto>

Defined in: octra-api.service.ts:559

returns information about the own account.

Allowed user roles: administrator, user

Returns

Observable<CurrentAccountDto>

getMyAccountPersonalInformation()

getMyAccountPersonalInformation(): Observable<AccountDto>

Defined in: octra-api.service.ts:568

returns personal information about the own account.

Allowed user roles: administrator, user

Returns

Observable<AccountDto>

getMyJSONQuery()

getMyJSONQuery(query_id): Observable<JSONQueryDatabaseDto>

Defined in: octra-api.service.ts:816

returns a given query by id

Allowed user roles: all

Parameters

query_id

string

Returns

Observable<JSONQueryDatabaseDto>

getPolicy()

getPolicy(id): Observable<PolicyDto>

Defined in: octra-api.service.ts:1419

get specific policy

Allowed user roles: administrator

Parameters

id

number

Returns

Observable<PolicyDto>

getProject()

getProject(id, queryParams?): Observable<ProjectDto>

Defined in: octra-api.service.ts:353

returns a project. Administrator and project administrator see all information, others limited information.

Allowed user roles: all

Parameters

id

string

queryParams?

ProjectQueryParamsDto

Returns

Observable<ProjectDto>

getProjectCreatedStatistics()

getProjectCreatedStatistics(): Observable<AllProjectsTimeSeriesDto>

Defined in: octra-api.service.ts:647

returns a time series about all created projects.

Returns

Observable<AllProjectsTimeSeriesDto>

getProjectJSONQuery()

getProjectJSONQuery(projectID, query_id): Observable<JSONQueryDatabaseDto>

Defined in: octra-api.service.ts:856

returns a given query by id

Allowed user roles: administrator, project_admin

Parameters

projectID

string

query_id

string

Returns

Observable<JSONQueryDatabaseDto>

getProjectStatistics()

getProjectStatistics(id): Observable<ProjectStatisticsDto>

Defined in: octra-api.service.ts:1196

returns statistics about a project.

Allowed user roles: administrator, project_admin

Parameters

id

string

Returns

Observable<ProjectStatisticsDto>

getRole()

getRole(projectID): Observable<RoleDto>

Defined in: octra-api.service.ts:1243

get a specific role

Allowed user roles: administrator

Parameters

projectID

string

Returns

Observable<RoleDto>

getRunningBackup()

getRunningBackup(): Observable<null | RunningBackupDto>

Defined in: octra-api.service.ts:1622

returns the backup that is currently running.

Allowed user roles: administrator

Returns

Observable<null | RunningBackupDto>

getTask()

getTask(projectID, taskID): Observable<TaskDto>

Defined in: octra-api.service.ts:245

returns a task.

Allowed user roles: all

Parameters

projectID

string

taskID

string

Returns

Observable<TaskDto>

getTaskCreatedStatistics()

getTaskCreatedStatistics(): Observable<AllProjectsTimeSeriesDto>

Defined in: octra-api.service.ts:654

returns a time series about all created projects.

Returns

Observable<AllProjectsTimeSeriesDto>

getTool()

getTool(id): Observable<ToolDto>

Defined in: octra-api.service.ts:408

returns a tool by id.

Allowed user roles: administrator

Parameters

id

number

Returns

Observable<ToolDto>

getToolByFolder()

getToolByFolder(folder_name): Observable<ToolDto>

Defined in: octra-api.service.ts:425

returns a tool by folder name (for unregistered tools only).

Parameters

folder_name

string

Returns

Observable<ToolDto>

getToolConfigurationAssetFileURL()

getToolConfigurationAssetFileURL(project_id, config_id, asset_id, filename): string

Defined in: octra-api.service.ts:703

returns a file URL to an asset of a given project and a given tool configuration.

Allowed user roles: all

Parameters

project_id

string

config_id

string

asset_id

string

filename

string

Returns

string

getToolConfigurationFileURL()

getToolConfigurationFileURL(project_id, config_id, filename): string

Defined in: octra-api.service.ts:693

returns a file URL to a projectconfiguration of a given project and a given tool configuration.

Allowed user roles: all

Parameters

project_id

string

config_id

string

filename

string

Returns

string

init()

init(apiURL, appToken, webToken, useCookieStrategy): Observable<AppPropertiesDto>

Defined in: octra-api.service.ts:143

Parameters

apiURL

string

appToken

string

webToken

undefined | string

useCookieStrategy

boolean

Returns

Observable<AppPropertiesDto>

installTool()

installTool(folder): Observable<ToolDto>

Defined in: octra-api.service.ts:435

changes a registered tool.

Allowed user roles: administrator

Parameters

folder

string

Returns

Observable<ToolDto>

listAccountFields()

listAccountFields(): Observable<AccountFieldValueDefinitionDto[]>

Defined in: octra-api.service.ts:1186

returns a list of existing account fields.

Allowed user roles: all

Returns

Observable<AccountFieldValueDefinitionDto[]>

listAccounts()

listAccounts(queryParams?): Observable<AccountMinimalListDto>

Defined in: octra-api.service.ts:364

returns a list of existing accounts.

Allowed user roles: administrator

Parameters

queryParams?

AccountListQueryParamsDto

Returns

Observable<AccountMinimalListDto>

listAppTokens()

listAppTokens(queryParams?): Observable<AppTokenListDto>

Defined in: octra-api.service.ts:223

returns a list of app tokens.

Allowed user roles: administrator

Parameters

queryParams?

ProjectListQueryParamsDto

Returns

Observable<AppTokenListDto>

listBackups()

listBackups(queryParams?): Observable<BackupDto[]>

Defined in: octra-api.service.ts:1612

lists backups.

Allowed user roles: administrator

Parameters

queryParams?

ProjectListQueryParamsDto

Returns

Observable<BackupDto[]>

listEmailTemplates()

listEmailTemplates(queryParams?): Observable<EmailTemplateDto[]>

Defined in: octra-api.service.ts:1657

lists email templates.

Allowed user roles: administrator

Parameters

queryParams?

StandardPageQueryParamsDto

Returns

Observable<EmailTemplateDto[]>

listLatestPolicies()

listLatestPolicies(): Observable<PolicyListItemDto[]>

Defined in: octra-api.service.ts:1399

Returns

Observable<PolicyListItemDto[]>

listManualTools()

listManualTools(queryParams?): Observable<ToolListDto>

Defined in: octra-api.service.ts:397

lists manual tools.

Allowed user roles: all

Parameters

queryParams?

StandardPageQueryParamsDto

Returns

Observable<ToolListDto>

listMyJSONQueries()

listMyJSONQueries(queryParams): Observable<JSONQueryDatabaseListDto>

Defined in: octra-api.service.ts:771

returns a list of previous queries for the current user and the given project

Allowed user roles: all

Parameters

queryParams

length?

number

representation

"page" | "interval"

scope

string

start?

number

Returns

Observable<JSONQueryDatabaseListDto>

listMyProcessedTasks()

listMyProcessedTasks(projectID, queryParams): Observable<ProcessedTaskListDto>

Defined in: octra-api.service.ts:1233

lists all processed tasks for the current project and currrent user. The user must be assigned using "worker_id" and the enddate must exist.

Allowed user roles: all

Parameters

projectID

string

queryParams

ProcessedTaskListQueryParamsDto

Returns

Observable<ProcessedTaskListDto>

listPolicies()

listPolicies(): Observable<PolicyMinimalDto[]>

Defined in: octra-api.service.ts:1395

returns a list of policies

Allowed user roles: administrator

Returns

Observable<PolicyMinimalDto[]>

listProjectFiles()

listProjectFiles(projectID, path, showOutputs): Observable<ProjectFileDto[]>

Defined in: octra-api.service.ts:494

lists all files and folders from a selected path

Allowed user roles: administrator, project_admin

Parameters

projectID

string

path

string = ''

showOutputs

boolean = false

Returns

Observable<ProjectFileDto[]>

listProjectJSONQueries()

listProjectJSONQueries(projectID, query): Observable<JSONQueryDatabaseListDto>

Defined in: octra-api.service.ts:738

returns a list of project queries for the given project

Allowed user roles: administrator, project_admin

Parameters

projectID

string

query

length?

number

representation

"page" | "interval"

scope

string

start?

number

Returns

Observable<JSONQueryDatabaseListDto>

listProjectLinks()

listProjectLinks(project_id): Observable<LinkDto[]>

Defined in: octra-api.service.ts:1576

lists all links from specific project.

Allowed user roles: administrator, project_admin

Parameters

project_id

string

Returns

Observable<LinkDto[]>

listProjectRoles()

listProjectRoles(projectID): Observable<ProjectRoleDto[]>

Defined in: octra-api.service.ts:476

returns all roles associated to the project.

Allowed user roles: administrator, project_admin

Parameters

projectID

string

Returns

Observable<ProjectRoleDto[]>

listProjects()

listProjects(queryParams?): Observable<ProjectListDto>

Defined in: octra-api.service.ts:375

returns a list of projects. Administrators get a more detailed and unfiltered list of projects. If an application uses an app token linked to a specific tool only tasks supported by this tool are used for the statistics.

Allowed user roles: all

Parameters

queryParams?

ProjectListQueryParamsDto

Returns

Observable<ProjectListDto>

listRoles()

listRoles(): Observable<RoleDto[]>

Defined in: octra-api.service.ts:1224

lists all roles;

Allowed user roles: administrator, project_admin

Returns

Observable<RoleDto[]>

listTasks()

listTasks(projectID, order?, start?, length?, returnURLs?): Observable<TaskListDto>

Defined in: octra-api.service.ts:259

lists tasks grouped by chains as arrays of arrays.

Allowed user roles: administrator, project_admin, data_delivery

Parameters

projectID

string

order?

"desc" | "asc"

start?

number

length?

number

returnURLs?

boolean

Returns

Observable<TaskListDto>

listTemporaryJSONQueries()

listTemporaryJSONQueries(projectID, scope): Observable<JSONQueryDatabaseDto[]>

Defined in: octra-api.service.ts:756

returns a list of previous queries for the current user and the given project

Allowed user roles: administrator, project_admin

Parameters

projectID

string

scope

string

Returns

Observable<JSONQueryDatabaseDto[]>

listToolConfigurations()

listToolConfigurations(projectID, start?, length?): Observable<ToolConfigurationDto[]>

Defined in: octra-api.service.ts:278

Parameters

projectID

string

start?

number

length?

number

Returns

Observable<ToolConfigurationDto[]>

listTools()

listTools(queryParams?): Observable<ToolListDto>

Defined in: octra-api.service.ts:386

lists tools.

Allowed user roles: administrator, project_admin

Parameters

queryParams?

StandardPageQueryParamsDto

Returns

Observable<ToolListDto>

login()

login(type, usernameOrEmail?, password?): Observable<AuthDto>

Defined in: octra-api.service.ts:172

authenticates a given account. Two authentication methods are supported: local and shibboleth:

local: the account authenticates using a local account (via credentials). You can choose if session_token and app_token are saved as cookies. shibboleth: the account authenticates via Shibboleth (the shibboleth authentication must be supported by the server). session_token and app_token are saved as cookies.

Parameters

type

AccountLoginMethod

usernameOrEmail?

string

password?

string

Returns

Observable<AuthDto>

logout()

logout(): Observable<unknown>

Defined in: octra-api.service.ts:213

does logout process

Returns

Observable<unknown>

moveProjectFileOrFolder()

moveProjectFileOrFolder(project_id, dto): Observable<void>

Defined in: octra-api.service.ts:1346

moves files and/or folder to a new destination. This does not replace/rename the destination folder, it includes the new files/folders within the destination.

Allowed user roles: administrator, project_admin

Parameters

project_id

string

dto

ProjectFileMoveRequestDto

Returns

Observable<void>

postOnNewTab()

postOnNewTab(partURL, data, target?): void

Defined in: octra-api.service.ts:1895

Parameters

partURL

string

data

any

target?

string

Returns

void

prepareFileURL()

prepareFileURL(fileURL, force): string

Defined in: octra-api.service.ts:1884

Parameters

fileURL

string

force

boolean = false

Returns

string

publishPolicies()

publishPolicies(dto): Observable<unknown>

Defined in: octra-api.service.ts:1503

publishes selected policies with given dates.

Allowed user roles: administrator

Parameters

dto

PolicyPublishRequestDto

Returns

Observable<unknown>

refreshAppToken()

refreshAppToken(id): Observable<AppTokenDto>

Defined in: octra-api.service.ts:626

overwrites an existing app token with a new auto-generated token.

Allowed user roles: administrator

Parameters

id

string

Returns

Observable<AppTokenDto>

registerAccount()

registerAccount(dto): Observable<AccountRegisterResponseDto>

Defined in: octra-api.service.ts:206

creates a new account.

Allowed user roles: administrator

Parameters

dto

AccountRegisterRequestDto

Returns

Observable<AccountRegisterResponseDto>

reloadTool()

reloadTool(id): Observable<ToolDto>

Defined in: octra-api.service.ts:417

overwrites the data in DB with the current information. Updates the hash.

Allowed user roles: administrator

Parameters

id

number

Returns

Observable<ToolDto>

removeAccount()

removeAccount(id): Observable<void>

Defined in: octra-api.service.ts:534

Parameters

id

string

Returns

Observable<void>

removeAppToken()

removeAppToken(id): Observable<void>

Defined in: octra-api.service.ts:342

deletes an existing app token.

Allowed user roles: administrator

Parameters

id

string

Returns

Observable<void>

removePolicy()

removePolicy(policy_id): Observable<void>

Defined in: octra-api.service.ts:1493

removes a policy (only if there is no active user consent connected to it).

Allowed user roles: administrator

Parameters

policy_id

number

Returns

Observable<void>

removePolicyTranslation()

removePolicyTranslation(policy_id, translation_id): Observable<void>

Defined in: octra-api.service.ts:1603

Parameters

policy_id

number

translation_id

number

Returns

Observable<void>

removeProject()

removeProject(id, reqData): Observable<void>

Defined in: octra-api.service.ts:525

removes a specific project.

Allowed user roles: administrator

Parameters

id

string

reqData

removeProjectFiles?

boolean

Returns

Observable<void>

removeProjectLink()

removeProjectLink(project_id, link_id): Observable<void>

Defined in: octra-api.service.ts:1587

removes given link from project.

Allowed user roles: administrator, project_admin

Parameters

project_id

string

link_id

string

Returns

Observable<void>

removeProjectRole()

removeProjectRole(project_id, account_id): Observable<void>

Defined in: octra-api.service.ts:1365

removes a given project role.

Allowed user roles: administrator, project_admin

Parameters

project_id

string

account_id

string

Returns

Observable<void>

removeRole()

removeRole(id): Observable<void>

Defined in: octra-api.service.ts:1292

removes a specific role.

Allowed user roles: administrator

Parameters

id

string

Returns

Observable<void>

removeTask()

removeTask(project_id, task_id): Observable<void>

Defined in: octra-api.service.ts:1177

removes a task.

Allowed user roles: administrator, project_admin, data_delivery

Parameters

project_id

string

task_id

string

Returns

Observable<void>

removeTool()

removeTool(id): Observable<void>

Defined in: octra-api.service.ts:456

removes a registered tool.

Allowed user roles: administrator

Parameters

id

number

Returns

Observable<void>

removeToolByFolderName()

removeToolByFolderName(folderName): Observable<void>

Defined in: octra-api.service.ts:466

removes a registered tool.

Allowed user roles: administrator

Parameters

folderName

string

Returns

Observable<void>

removeToolConfiguration()

removeToolConfiguration(projectId, configId): Observable<void>

Defined in: octra-api.service.ts:305

removes a configuration of a specific project by a specific id.

Allowed user roles: administrator, project_admin

Parameters

projectId

string

configId

string

Returns

Observable<void>

renameProjectFileOrFolder()

renameProjectFileOrFolder(project_id, dto): Observable<void>

Defined in: octra-api.service.ts:1337

renames a file or directory

Allowed user roles: administrator, project_admin

Parameters

project_id

string

dto

ProjectFileRenameRequestDto

Returns

Observable<void>

requestPasswordReset()

requestPasswordReset(dto): Observable<any>

Defined in: octra-api.service.ts:1251

sends an E-Mail with a request to reset the password. It always returns 200 even if account was not found.

Parameters

dto

ResetPasswordRequestDto

Returns

Observable<any>

restart()

restart(): Observable<unknown>

Defined in: octra-api.service.ts:1539

saves the general settings. "shutdown" option for app token must be enabled. Linux and MacOS only.

Allowed user roles: administrator

Returns

Observable<unknown>

runBackup()

runBackup(): Observable<void>

Defined in: octra-api.service.ts:1631

runs a manual command

Allowed user roles: administrator

Returns

Observable<void>

runBatchAction()

runBatchAction(dto): Observable<void>

Defined in: octra-api.service.ts:1261

runs an action on given accounts. This functions doesn't wait for emails to be sent.

Allowed user roles: administrator

Parameters

dto

AccountBatchActionDto

Returns

Observable<void>

runJSONDeleteQuery()

runJSONDeleteQuery(projectID, dto, order?, start?, length?, returnURLs?): Observable<JSONQueryTaskResultListDto>

Defined in: octra-api.service.ts:865

runs a JSON DELETE query

Allowed user roles: administrator, project_admin

Parameters

projectID

string

dto

JSONQueryDeleteDto

order?

"desc" | "asc"

start?

number

length?

number

returnURLs?

boolean

Returns

Observable<JSONQueryTaskResultListDto>

runJSONSelectQuery()

runJSONSelectQuery(projectID, dto, order?, start?, length?): Observable<JSONQueryTaskResultListDto>

Defined in: octra-api.service.ts:713

runs a JSON SELECT query

Allowed user roles: administrator, project_admin

Parameters

projectID

string

dto

JSONQuerySelectDto

order?

"desc" | "asc"

start?

number

length?

number

Returns

Observable<JSONQueryTaskResultListDto>

runJSONUpdateQuery()

runJSONUpdateQuery(projectID, dto, order?, start?, length?, returnURLs?): Observable<JSONQueryTaskResultListDto>

Defined in: octra-api.service.ts:890

runs a JSON UPDATE query

Allowed user roles: administrator, project_admin

Parameters

projectID

string

dto

JSONQueryUpdateDto

order?

"desc" | "asc"

start?

number

length?

number

returnURLs?

boolean

Returns

Observable<JSONQueryTaskResultListDto>

saveAccountFieldValues()

saveAccountFieldValues(data): Observable<void>

Defined in: octra-api.service.ts:1206

saves values of account fields.

Allowed user roles: all

Parameters

data

Record<string, any>

Returns

Observable<void>

saveAccountInformation()

saveAccountInformation(id, dto): Observable<AccountDto>

Defined in: octra-api.service.ts:1386

saves information about a specific account.

Allowed user roles: administrator

Parameters

id

string

dto

AccountChangeDto

Returns

Observable<AccountDto>

saveMyAccountSettings()

saveMyAccountSettings(data): Observable<void>

Defined in: octra-api.service.ts:1215

saves account settings.

Allowed user roles: all

Parameters

data

AccountSettingsDto

Returns

Observable<void>

saveTask()

saveTask(projectID, taskID, properties, log, outputs): Observable<TaskDto>

Defined in: octra-api.service.ts:920

saves the current task by specific type. It doesn't automatically start a new task, it rather responds with the saved annotation.

Allowed user roles: all with access to this project

Parameters

projectID

string

taskID

string

properties

TaskSaveDtoProperties

log

undefined | File

outputs

File[] = []

Returns

Observable<TaskDto>

searchAccounts()

searchAccounts(keyword): Observable<AccountSearchResultDto[]>

Defined in: octra-api.service.ts:1296

Parameters

keyword

string

Returns

Observable<AccountSearchResultDto[]>

sendFeedback()

sendFeedback(properties, protocol?, appending?): Observable<HttpEvent<unknown>>

Defined in: octra-api.service.ts:1635

Parameters

properties

FeedbackRequestPropertiesDto

protocol?

File

appending?

File[] = []

Returns

Observable<HttpEvent<unknown>>

shutdown()

shutdown(): Observable<unknown>

Defined in: octra-api.service.ts:1530

shutdowns the system asap. "shutdown" option for app token must be enabled. Linux and MacOS only.

Allowed user roles: administrator, project_admin

Returns

Observable<unknown>

startBatchSession()

startBatchSession(project_id): Observable<TaskBatchSessionDto>

Defined in: octra-api.service.ts:1092

starts a new session for batch upload.

Allowed user roles: administrator, project_admin, data_delivery

Parameters

project_id

string

Returns

Observable<TaskBatchSessionDto>

startTask()

startTask(projectID, data): Observable<TaskDto>

Defined in: octra-api.service.ts:665

looks for a free task of type task_type (e.g. "annotation"), changes its status to 'BUSY' and returns it.

Allowed user roles: all with access to this project

Parameters

projectID

string

data

TaskStartActionDto

Returns

Observable<TaskDto>

submitBatchSession()

submitBatchSession(project_id, session_id, session_timestamp): Observable<void>

Defined in: octra-api.service.ts:1119

submits a batch session and runs all its transactions. If one of the transaction fails, all previous transactions are reverted and an error is returned

Allowed user roles: administrator, project_admin, data_delivery

Parameters

project_id

string

session_id

string

session_timestamp

number

Returns

Observable<void>

updateAppProperties()

updateAppProperties(): Observable<AppPropertiesDto>

Defined in: [octra-api.service.ts:1841](https://github.com/IPS-LMU/octra-backend/blob/96dc565530bd4b8b4467b6827952427