This library provides a module with all methods supported by octra-backend API.
-
npm install @octra/ngx-octra-api - Import Module
NgxOctraApiModule:
@NgModule({
declarations: [AppComponent],
imports: [
BrowserModule,
BrowserAnimationsModule,
HttpClientModule,
NgxOctraApiModule // <-- IMPORT
],
providers: [],
bootstrap: [AppComponent],
exports: [],
})
export class AppModule {}- 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);
}
// ...
}- Now see chapter Methods for more information about supported API functions. Refer to the API reference generated by an octra-server for more information.
addBatchUploadTaskData(
session_timestamp,session_id,project_id,properties,inputs,outputs):Observable<HttpEvent<unknown>>
adds a new batch upload operation
Allowed user roles: administrator, project_admin, data_delivery
• session_timestamp: number
• session_id: string
• project_id: string
• properties: TaskProperties
• inputs: File[]
• outputs: File[] = []
Observable<HttpEvent<unknown>>
assignProjectRoles(
project_id,dto):Observable<any[]>
assigns roles for an account to a specific project.
Allowed user roles: administrator, project_admin
• project_id: string
• dto: any[]
Observable<any[]>
cancelBatchSession(
project_id,session_id,session_timestamp):Observable<void>
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
• project_id: string
• session_id: string
• session_timestamp: number
Observable<void>
changeAppToken(
id,tokenData):Observable<AppTokenDto>
changes an app token.
Allowed user roles: administrator
• id: string
• tokenData: AppTokenChangeDto
Observable<AppTokenDto>
changeEmailTemplateTranslation(
templateID,translationID,body):Observable<EmailTemplateTranslationDto>
changes a email template translation
Allowed user roles: administrator
• templateID: number
• translationID: string
• body: EmailTranslationChangeRequestDto
Observable<EmailTemplateTranslationDto>
changeImprint(
data):Observable<ImprintDto>
returns an object containing the imprint
Allowed user roles: administrator
• data: ImprintSaveDto
Observable<ImprintDto>
changeLink(
project_id,link_id,dto):Observable<LinkDto>
changes given link from project.
Allowed user roles: administrator, project_admin
• project_id: string
• link_id: string
• dto: LinkOptionsDto
Observable<LinkDto>
changeMyPassword(
oldPassword,newPassword):Observable<void>
changes the password of the current account.
• oldPassword: string
• newPassword: string
Observable<void>
changeMyPersonalAccountInformation(
data):Observable<void>
sets personal information about the own account.
Allowed user roles: administrator, user
• data: ChangeAccountInformationDto
Observable<void>
changePolicyTranslation(
policy_id,policy_translation_id,dto):Observable<PolicyTranslationDto>
updates a policy translation.
Allowed user roles: administrator
• policy_id: number
• policy_translation_id: number
• dto: PolicyCreateTranslationDto
Observable<PolicyTranslationDto>
changeProject(
id,requestData):Observable<void>
changes a specific project.
Allowed user roles: administrator, project_admin
• id: string
• requestData: ProjectRequestDto
Observable<void>
changeProjectRole(
project_id,role_id,data):Observable<ProjectRoleResultDto>
• project_id: string
• role_id: string
• data: any
Observable<ProjectRoleResultDto>
changeRole(
id,dto):Observable<RoleDto>
changes a specific role.
Allowed user roles: administrator
• id: string
• dto: RoleCreateDto
Observable<RoleDto>
changeTaskData(
projectID,taskID,properties,inputs,outputs,log,inputsMetaData,outputsMetaData):Observable<HttpEvent<unknown>>
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
• projectID: string
• taskID: string
• properties: TaskSaveDtoProperties
• inputs: File[] = []
• outputs: File[] = []
• log: undefined | File = undefined
• inputsMetaData: IOMetaData[] = []
• outputsMetaData: IOMetaData[] = []
Observable<HttpEvent<unknown>>
changeTool(
id,dto):Observable<ToolDto>
changes a registered tool.
Allowed user roles: administrator
• id: number
• dto: ToolChangeRequestDto
Observable<ToolDto>
changeToolConfiguration(
projectId,configId,dto):Observable<ToolConfigurationDto>
• projectId: string
• configId: string
• dto: ToolConfigurationChangeDto
Observable<ToolConfigurationDto>
checkIfProjectFilesExist(
projectId,dto):Observable<ProjectFileExistResponseDto>
• projectId: string
• dto: ProjectFileExistRequestDto
Observable<ProjectFileExistResponseDto>
continueTask(
projectID,taskID):Observable<TaskDto>
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
• projectID: string
• taskID: string
Observable<TaskDto>
convertTaskIOToOCBJSONFileReference(
io):OCBJSONFileReference
• io: TaskInputOutputDto
OCBJSONFileReference
createAccount(
dto):Observable<AccountDto>
creates a new account.
Allowed user roles: administrator
• dto: AccountCreateRequestDto
Observable<AccountDto>
createAppToken(
tokenData):Observable<boolean>
creates a new app token.
Allowed user roles: administrator
• tokenData: AppTokenCreateDto
Observable<boolean>
createEmailTemplateTranslation(
templateID,body):Observable<EmailTemplateTranslationDto>
creates a new translation for a given template
Allowed user roles: administrator
• templateID: number
• body: EmailTranslationChangeRequestDto
Observable<EmailTemplateTranslationDto>
createPolicy(
dto):Observable<PolicyDto>
adds a new policy with undefined publish date (draft). Only one draft per policy type may exist.
Allowed user roles: administrator
• dto: PolicyCreateRequestDto
Observable<PolicyDto>
createPolicyTranslation(
policy_id,dto):Observable<PolicyTranslationDto>
adds a new policy translation.
Allowed user roles: administrator
• policy_id: number
• dto: PolicyCreateTranslationDto
Observable<PolicyTranslationDto>
createProject(
projectData):Observable<ProjectDto>
creates a new project.
Allowed user roles: administrator
• projectData: ProjectRequestDto
Observable<ProjectDto>
createProjectFolder(
project_id,dto):Observable<void>
• project_id: string
• dto: ProjectFileCreateFolderRequestDto
Observable<void>
createRole(
dto):Observable<RoleDto>
create a new role.
Allowed user roles: administrator
• dto: RoleCreateDto
Observable<RoleDto>
createToolConfiguration(
projectId,dto):Observable<ToolConfigurationDto>
• projectId: string
• dto: ToolConfigurationCreateDto
Observable<ToolConfigurationDto>
deleteEmailTemplateTranslation(
templateID,translationID):Observable<void>
removes a given translation
Allowed user roles: administrator
• templateID: number
• translationID: string
Observable<void>
deleteProjectFiles(
projectID,items):Observable<void>
• projectID: string
• items: DeleteProjectFilesRequest[]
Observable<void>
deleteToolConfiguration(
projectId,configId):Observable<void>
• projectId: string
• configId: string
Observable<void>
downloadDataPackage(
project_id,data):Observable<unknown>
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
• project_id: string
• data: DownloadPackageOptionsDto
Observable<unknown>
duplicateToolConfiguration(
projectId,configId):Observable<ToolConfigurationDto>
• projectId: string
• configId: string
Observable<ToolConfigurationDto>
freeTask(
projectID,taskID):Observable<TaskDto>
sets the status from 'BUSY' to 'FREE' of a task.
Allowed user roles: all with access
• projectID: string
• taskID: string
Observable<TaskDto>
getAccountInformation(
id):Observable<AccountDto>
returns information about a specific account.
Allowed user roles: administrator
• id: string
Observable<AccountDto>
getAllStatistics():
Observable<AllStatisticsDto>
returns statistics about number of accounts, roles, projects, tasks and app tokens. The response is cached every 15 minutes.
Observable<AllStatisticsDto>
getAppProperties():
Observable<AppPropertiesDto>
Observable<AppPropertiesDto>
getAppToken(
id):Observable<AppTokenDto>
returns one specific app token.
Allowed user roles: administrator
• id: string
Observable<AppTokenDto>
getCookie(
cname):undefined|string
• cname: string
undefined | string
getEmailTemplate(
id,queryParams?):Observable<EmailTemplateDto>
retrieves a specific template and its translations
Allowed user roles: administrator
• id: string
• queryParams?: StandardPageQueryParamsDto
Observable<EmailTemplateDto>
getEmailTemplateTranslation(
templateID,translationID):Observable<EmailTemplateTranslationDto>
retrieves a specific translation from a given translation.
Allowed user roles: administrator
• templateID: number
• translationID: string
Observable<EmailTemplateTranslationDto>
getImprint():
Observable<ImprintDto>
returns an object containing the imprint
Allowed user roles: administrator
Observable<ImprintDto>
getMyAccountInformation():
Observable<CurrentAccountDto>
returns information about the own account.
Allowed user roles: administrator, user
Observable<CurrentAccountDto>
getMyAccountPersonalInformation():
Observable<AccountDto>
returns personal information about the own account.
Allowed user roles: administrator, user
Observable<AccountDto>
getPolicy(
id):Observable<PolicyDto>
get specific policy
Allowed user roles: administrator
• id: number
Observable<PolicyDto>
getProject(
id,queryParams?):Observable<ProjectDto>
returns a project. Administrator and project administrator see all information, others limited information.
Allowed user roles: all
• id: string
• queryParams?: ProjectQueryParamsDto
Observable<ProjectDto>
getProjectStatistics(
id):Observable<ProjectStatisticsDto>
returns statistics about a project.
Allowed user roles: administrator, project_admin
• id: string
Observable<ProjectStatisticsDto>
getRole(
id):Observable<RoleDto>
• id: string
Observable<RoleDto>
getRunningBackup():
Observable<null|RunningBackupDto>
returns the backup that is currently running.
Allowed user roles: administrator
Observable<null | RunningBackupDto>
getTask(
projectID,taskID):Observable<TaskDto>
returns a task.
Allowed user roles: all
• projectID: string
• taskID: string
Observable<TaskDto>
getTool(
id):Observable<ToolDto>
returns a tool by id.
Allowed user roles: administrator
• id: number
Observable<ToolDto>
init(
apiURL,appToken,webToken,useCookieStrategy):Observable<AppPropertiesDto>
• apiURL: string
• appToken: string
• webToken: undefined | string
• useCookieStrategy: boolean
Observable<AppPropertiesDto>
installTool(
folder):Observable<ToolDto>
changes a registered tool.
Allowed user roles: administrator
• folder: string
Observable<ToolDto>
listAccountFields():
Observable<AccountFieldValueDefinitionDto[]>
returns a list of existing account fields.
Allowed user roles: all
Observable<AccountFieldValueDefinitionDto[]>
listAccounts(
queryParams?):Observable<AccountMinimalListDto>
returns a list of existing accounts.
Allowed user roles: administrator
• queryParams?: AccountListQueryParamsDto
Observable<AccountMinimalListDto>
listAppTokens(
queryParams?):Observable<AppTokenListDto>
returns a list of app tokens.
Allowed user roles: administrator
• queryParams?: ProjectListQueryParamsDto
Observable<AppTokenListDto>
listBackups(
queryParams?):Observable<BackupDto[]>
lists backups.
Allowed user roles: administrator
• queryParams?: ProjectListQueryParamsDto
Observable<BackupDto[]>
listEmailTemplates(
queryParams?):Observable<EmailTemplateDto[]>
lists email templates.
Allowed user roles: administrator
• queryParams?: StandardPageQueryParamsDto
Observable<EmailTemplateDto[]>
listLatestPolicies():
Observable<PolicyListItemDto[]>
Observable<PolicyListItemDto[]>
listPolicies():
Observable<PolicyMinimalDto[]>
returns a list of policies
Allowed user roles: administrator
Observable<PolicyMinimalDto[]>
listProjectFiles(
projectID,path,showOutputs):Observable<ProjectFileDto[]>
• projectID: string
• path: string = ''
• showOutputs: boolean = false
Observable<ProjectFileDto[]>
listProjectLinks(
project_id):Observable<LinkDto[]>
lists all links from specific project.
Allowed user roles: administrator, project_admin
• project_id: string
Observable<LinkDto[]>
listProjectRoles(
projectID):Observable<ProjectRoleDto[]>
returns all roles associated to the project.
Allowed user roles: administrator, project_admin
• projectID: string
Observable<ProjectRoleDto[]>
listProjects(
queryParams?):Observable<ProjectListDto>
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
• queryParams?: ProjectListQueryParamsDto
Observable<ProjectListDto>
listRoles():
Observable<RoleDto[]>
Observable<RoleDto[]>
listTasks(
projectID,order?,start?,length?):Observable<TaskDto[][]>
lists tasks grouped by chains as arrays of arrays.
Allowed user roles: administrator, project_admin, data_delivery
• projectID: string
• order?: "desc" | "asc"
• start?: number
• length?: number
Observable<TaskDto[][]>
listToolConfigurations(
projectID,start?,length?):Observable<ToolConfigurationDto[]>
• projectID: string
• start?: number
• length?: number
Observable<ToolConfigurationDto[]>
listTools(
queryParams?):Observable<ToolListDto>
lists tools.
Allowed user roles: administrator, project_admin
• queryParams?: StandardPageQueryParamsDto
Observable<ToolListDto>
login(
type,usernameOrEmail?,password?):Observable<AuthDto>
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.
• type: AccountLoginMethod
• usernameOrEmail?: string
• password?: string
Observable<AuthDto>
logout():
Observable<unknown>
does logout process
Observable<unknown>
moveProjectFileOrFolder(
project_id,dto):Observable<void>
• project_id: string
• dto: ProjectFileMoveRequestDto
Observable<void>
postOnNewTab(
partURL,data,target?):void
• partURL: string
• data: any
• target?: string
void
prepareFileURL(
fileURL):string
• fileURL: string
string
publishPolicies(
dto):Observable<unknown>
publishes selected policies with given dates.
Allowed user roles: administrator
• dto: PolicyPublishRequestDto
Observable<unknown>
refreshAppToken(
id):Observable<AppTokenDto>
overwrites an existing app token with a new auto-generated token.
Allowed user roles: administrator
• id: string
Observable<AppTokenDto>
registerAccount(
dto):Observable<AccountRegisterResponseDto>
• dto: AccountRegisterRequestDto
Observable<AccountRegisterResponseDto>
removeAccount(
id):Observable<void>
• id: string
Observable<void>
removeAppToken(
id):Observable<void>
deletes an existing app token.
Allowed user roles: administrator
• id: string
Observable<void>
removePolicy(
policy_id):Observable<void>
removes a policy (only if there is no active user consent connected to it).
Allowed user roles: administrator
• policy_id: number
Observable<void>
removePolicyTranslation(
policy_id,translation_id):Observable<void>
• policy_id: number
• translation_id: number
Observable<void>
removeProject(
id,reqData):Observable<void>
removes a specific project.
Allowed user roles: administrator
• id: string
• reqData
• reqData.removeProjectFiles?: boolean
Observable<void>
removeProjectLink(
project_id,link_id):Observable<void>
removes given link from project.
Allowed user roles: administrator, project_admin
• project_id: string
• link_id: string
Observable<void>
removeProjectRole(
project_id,account_id):Observable<void>
• project_id: string
• account_id: string
Observable<void>
removeRole(
id):Observable<void>
removes a specific role.
Allowed user roles: administrator
• id: string
Observable<void>
removeTask(
project_id,task_id):Observable<void>
• project_id: string
• task_id: string
Observable<void>
removeTool(
id):Observable<void>
removes a registered tool.
Allowed user roles: administrator
• id: number
Observable<void>
removeToolByFolderName(
folderName):Observable<void>
removes a registered tool.
Allowed user roles: administrator
• folderName: string
Observable<void>
renameProjectFileOrFolder(
project_id,dto):Observable<void>
• project_id: string
• dto: ProjectFileRenameRequestDto
Observable<void>
requestPasswordReset(
dto):Observable<any>
sends an E-Mail with a request to reset the password. It always returns 200 even if account was not found.
• dto: ResetPasswordRequestDto
Observable<any>
restart():
Observable<unknown>
saves the general settings. "shutdown" option for app token must be enabled. Linux and MacOS only.
Allowed user roles: administrator
Observable<unknown>
runBackup():
Observable<void>
runs a manual command
Allowed user roles: administrator
Observable<void>
runBatchAction(
dto):Observable<void>
runs an action on given accounts. This functions doesn't wait for emails to be sent.
Allowed user roles: administrator
• dto: AccountBatchActionDto
Observable<void>
saveAccountFieldValues(
data):Observable<void>
saves values of account fields.
Allowed user roles: all
• data: Record<string, any>
Observable<void>
saveAccountInformation(
id,dto):Observable<AccountDto>
saves information about a specific account.
Allowed user roles: administrator
• id: string
• dto: AccountChangeDto
Observable<AccountDto>
saveMyAccountSettings(
data):Observable<void>
• data: AccountSettingsDto
Observable<void>
saveTask(
projectID,taskID,properties,log,outputs):Observable<TaskDto>
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
• projectID: string
• taskID: string
• properties: TaskSaveDtoProperties
• log: undefined | File = undefined
• outputs: File[] = []
Observable<TaskDto>
searchAccounts(
keyword):Observable<AccountSearchResultDto[]>
• keyword: string
Observable<AccountSearchResultDto[]>
sendFeedback(
properties,protocol?,appending?):Observable<HttpEvent<unknown>>
• properties: FeedbackRequestPropertiesDto
• protocol?: File
• appending?: File[] = []
Observable<HttpEvent<unknown>>
shutdown():
Observable<unknown>
shutdowns the system asap. "shutdown" option for app token must be enabled. Linux and MacOS only.
Allowed user roles: administrator, project_admin
Observable<unknown>
startBatchSession(
project_id):Observable<TaskBatchSessionDto>
starts a new session for batch upload.
Allowed user roles: administrator, project_admin, data_delivery
• project_id: string
Observable<TaskBatchSessionDto>
startTask(
projectID,data):Observable<TaskDto>
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
• projectID: string
• data: TaskStartActionDto
Observable<TaskDto>
submitBatchSession(
project_id,session_id,session_timestamp):Observable<void>
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
• project_id: string
• session_id: string
• session_timestamp: number
Observable<void>
updateAppProperties():
Observable<AppPropertiesDto>
Observable<AppPropertiesDto>
updatePolicy(
id,dto):Observable<PolicyDto>
updates a policy.
Allowed user roles: administrator
• id: number
• dto: any
Observable<PolicyDto>
uploadProjectFiles(
project_id,target_path,files,force_overwrite):Observable<HttpEvent<FileProjectDto[]>>
• project_id: string
• target_path: string
• files: File[]
• force_overwrite: boolean
Observable<HttpEvent<FileProjectDto[]>>
uploadTaskData(
project_id,properties,inputs,outputs,log):Observable<HttpEvent<unknown>>
creates a new task with the uploaded data.
Notice: If you want to add urls you need to create a file that contains OCBJSONFileReference.
Allowed user roles: administrator, project_admin, data_delivery
• project_id: string
• properties: TaskProperties
• inputs: File[]
• outputs: File[] = []
• log: undefined | File = undefined
Observable<HttpEvent<unknown>>