Options
All
  • Public
  • Public/Protected
  • All
Menu

@coscine/api-client

Index

Variables

Const AccountApi

AccountApi: { accountGetLoginUrls: any; accountLogout: any } = ...

Type declaration

  • accountGetLoginUrls: function
    • accountGetLoginUrls(options?: any): AxiosPromise<LoginUrls>
    • summary

      Return relevant URLs for logging the user in

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<LoginUrls>

  • accountLogout: function
    • accountLogout(options?: any): AxiosPromise<any>
    • summary

      Route for logging the user out of Coscine

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<any>

Const AdminApi

AdminApi: { adminGetProject: any; adminUpdateQuota: any } = ...

Type declaration

  • adminGetProject: function
    • adminGetProject(projectString: string, options?: any): AxiosPromise<AdminProjectObject>
    • summary

      Find the project related to the projectString(GUID or slug)

      throws

      {RequiredError}

      Parameters

      • projectString: string

        The project id (GUID) or slug (from URL).

      • Optional options: any

      Returns AxiosPromise<AdminProjectObject>

  • adminUpdateQuota: function
    • adminUpdateQuota(projectId: string, resourceTypeId: string, updateQuotaParameterObject: UpdateQuotaParameterObject, options?: any): AxiosPromise<any>
    • summary

      Update a project maximum and allocated quota

      throws

      {RequiredError}

      Parameters

      • projectId: string

        Id of the project

      • resourceTypeId: string

        Id of the resource type

      • updateQuotaParameterObject: UpdateQuotaParameterObject

        JSON object for updating the project maximum and allocated quota.

      • Optional options: any

      Returns AxiosPromise<any>

Const ApplicationProfileApi

ApplicationProfileApi: { apiV2ApplicationProfilesOptions: any; createApplicationProfileRequest: any; getApplicationProfile: any; getApplicationProfiles: any; getRawApplicationProfile: any } = ...

Type declaration

  • apiV2ApplicationProfilesOptions: function
    • apiV2ApplicationProfilesOptions(options?: any): AxiosPromise<void>
    • summary

      Responds with the HTTP methods allowed for the endpoint.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<void>

  • createApplicationProfileRequest: function
    • createApplicationProfileRequest(applicationProfileForCreationDto?: ApplicationProfileForCreationDto, options?: any): AxiosPromise<ApplicationProfileForCreationDtoResponse>
    • summary

      Submits a request to create a new application profile.

      throws

      {RequiredError}

      Parameters

      • Optional applicationProfileForCreationDto: ApplicationProfileForCreationDto
      • Optional options: any

      Returns AxiosPromise<ApplicationProfileForCreationDtoResponse>

  • getApplicationProfile: function
    • getApplicationProfile(profile: string, format?: RdfFormat, acceptLanguage?: AcceptedLanguage, options?: any): AxiosPromise<ApplicationProfileDtoResponse>
    • summary

      Retrieves an application profile by its URI.

      throws

      {RequiredError}

      Parameters

      • profile: string

        The URI of the application profile to retrieve.

      • Optional format: RdfFormat
      • Optional acceptLanguage: AcceptedLanguage
      • Optional options: any

      Returns AxiosPromise<ApplicationProfileDtoResponse>

  • getApplicationProfiles: function
    • getApplicationProfiles(searchTerm?: string, language?: AcceptedLanguage, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<ApplicationProfileDtoIEnumerablePagedResponse>
    • summary

      Retrieves all application profiles.

      throws

      {RequiredError}

      Parameters

      • Optional searchTerm: string
      • Optional language: AcceptedLanguage
      • Optional pageNumber: number
      • Optional pageSize: number
      • Optional orderBy: string
      • Optional options: any

      Returns AxiosPromise<ApplicationProfileDtoIEnumerablePagedResponse>

  • getRawApplicationProfile: function
    • getRawApplicationProfile(profile: string, options?: any): AxiosPromise<string>
    • summary

      Retrieves the raw application profile definition by its URI.

      throws

      {RequiredError}

      Parameters

      • profile: string

        The URI of the application profile.

      • Optional options: any

      Returns AxiosPromise<string>

Const BlobApi

BlobApi: { apiV2ProjectsProjectIdResourcesResourceIdBlobsOptions: any; createBlob: any; deleteBlob: any; getBlob: any; updateBlob: any } = ...

Type declaration

  • apiV2ProjectsProjectIdResourcesResourceIdBlobsOptions: function
    • apiV2ProjectsProjectIdResourcesResourceIdBlobsOptions(projectId: string, resourceId: string, options?: any): AxiosPromise<void>
    • summary

      Responds with the HTTP methods allowed for the endpoint.

      throws

      {RequiredError}

      Parameters

      • projectId: string
      • resourceId: string
      • Optional options: any

      Returns AxiosPromise<void>

  • createBlob: function
    • createBlob(projectId: string, resourceId: string, key: string, file?: any, options?: any): AxiosPromise<void>
    • summary

      Creates a new blob for a resource.

      throws

      {RequiredError}

      Parameters

      • projectId: string

        The identifier or slug of the project.

      • resourceId: string

        The identifier of the resource.

      • key: string

        The key for the new blob.

      • Optional file: any
      • Optional options: any

      Returns AxiosPromise<void>

  • deleteBlob: function
    • deleteBlob(projectId: string, resourceId: string, key: string, options?: any): AxiosPromise<void>
    • summary

      Deletes a blob from a resource.

      throws

      {RequiredError}

      Parameters

      • projectId: string

        The identifier or slug of the project.

      • resourceId: string

        The identifier of the resource.

      • key: string

        The key associated with the blob to delete.

      • Optional options: any

      Returns AxiosPromise<void>

  • getBlob: function
    • getBlob(projectId: string, resourceId: string, key: string, options?: any): AxiosPromise<any>
    • summary

      Download a blob from a resource.

      throws

      {RequiredError}

      Parameters

      • projectId: string

        The identifier or slug of the project.

      • resourceId: string

        The identifier of the resource.

      • key: string

        The key associated with the blob.

      • Optional options: any

      Returns AxiosPromise<any>

  • updateBlob: function
    • updateBlob(projectId: string, resourceId: string, key: string, file?: any, options?: any): AxiosPromise<void>
    • summary

      Updates an existing blob of a resource.

      throws

      {RequiredError}

      Parameters

      • projectId: string

        The identifier or slug of the project.

      • resourceId: string

        The identifier of the resource.

      • key: string

        The key associated with the blob to update.

      • Optional file: any
      • Optional options: any

      Returns AxiosPromise<void>

Const DisciplineApi

DisciplineApi: { apiV2DisciplinesOptions: any; getDiscipline: any; getDisciplines: any } = ...

Type declaration

  • apiV2DisciplinesOptions: function
    • apiV2DisciplinesOptions(options?: any): AxiosPromise<void>
    • summary

      Responds with the HTTP methods allowed for the endpoint.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<void>

  • getDiscipline: function
    • getDiscipline(disciplineId: string, options?: any): AxiosPromise<DisciplineDtoResponse>
    • summary

      Retrieves a discipline with the specified ID.

      throws

      {RequiredError}

      Parameters

      • disciplineId: string

        The ID of the discipline.

      • Optional options: any

      Returns AxiosPromise<DisciplineDtoResponse>

  • getDisciplines: function
    • getDisciplines(pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<DisciplineDtoIEnumerablePagedResponse>
    • summary

      Retrieves all disciplines.

      throws

      {RequiredError}

      Parameters

      • Optional pageNumber: number
      • Optional pageSize: number
      • Optional orderBy: string
      • Optional options: any

      Returns AxiosPromise<DisciplineDtoIEnumerablePagedResponse>

Const HomeApi

HomeApi: { homeIndex: any } = ...

Type declaration

  • homeIndex: function
    • homeIndex(options?: any): AxiosPromise<any>
    • summary

      The controller that the user is automatically entering when accesing the route .../coscine/api/Coscine.STS/

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<any>

Const LanguageApi

LanguageApi: { apiV2LanguagesOptions: any; getLanguage: any; getLanguages: any } = ...

Type declaration

  • apiV2LanguagesOptions: function
    • apiV2LanguagesOptions(options?: any): AxiosPromise<void>
    • summary

      Responds with the HTTP methods allowed for the endpoint.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<void>

  • getLanguage: function
    • getLanguage(languageId: string, options?: any): AxiosPromise<LanguageDtoResponse>
    • summary

      Retrieves a language by ID.

      throws

      {RequiredError}

      Parameters

      • languageId: string

        The ID of the language.

      • Optional options: any

      Returns AxiosPromise<LanguageDtoResponse>

  • getLanguages: function
    • getLanguages(pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<LanguageDtoIEnumerablePagedResponse>
    • summary

      Retrieves all languages.

      throws

      {RequiredError}

      Parameters

      • Optional pageNumber: number
      • Optional pageSize: number
      • Optional orderBy: string
      • Optional options: any

      Returns AxiosPromise<LanguageDtoIEnumerablePagedResponse>

Const LicenseApi

LicenseApi: { apiV2LicensesOptions: any; getLicense: any; getLicenses: any } = ...

Type declaration

  • apiV2LicensesOptions: function
    • apiV2LicensesOptions(options?: any): AxiosPromise<void>
    • summary

      Responds with the HTTP methods allowed for the endpoint.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<void>

  • getLicense: function
    • getLicense(licenseId: string, options?: any): AxiosPromise<LicenseDtoResponse>
    • summary

      Retrieves a license with the specified ID.

      throws

      {RequiredError}

      Parameters

      • licenseId: string

        The ID of the license.

      • Optional options: any

      Returns AxiosPromise<LicenseDtoResponse>

  • getLicenses: function
    • getLicenses(pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<LicenseDtoIEnumerablePagedResponse>
    • summary

      Retrieves all licenses.

      throws

      {RequiredError}

      Parameters

      • Optional pageNumber: number
      • Optional pageSize: number
      • Optional orderBy: string
      • Optional options: any

      Returns AxiosPromise<LicenseDtoIEnumerablePagedResponse>

Const MaintenanceApi

MaintenanceApi: { apiV2MaintenancesOptions: any; getCurrentMaintenances: any } = ...

Type declaration

  • apiV2MaintenancesOptions: function
    • apiV2MaintenancesOptions(options?: any): AxiosPromise<void>
    • summary

      Responds with the HTTP methods allowed for the endpoint.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<void>

  • getCurrentMaintenances: function
    • getCurrentMaintenances(options?: any): AxiosPromise<MaintenanceDtoIEnumerablePagedResponse>
    • summary

      Retrieves the current maintenance messages.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<MaintenanceDtoIEnumerablePagedResponse>

Const MergeApi

MergeApi: { mergeCallback: any; mergeLogin: any } = ...

Type declaration

  • mergeCallback: function
    • mergeCallback(returnUrl?: string, options?: any): AxiosPromise<any>
    • throws

      {RequiredError}

      Parameters

      • Optional returnUrl: string
      • Optional options: any

      Returns AxiosPromise<any>

  • mergeLogin: function
    • mergeLogin(returnUrl?: string, options?: any): AxiosPromise<any>
    • throws

      {RequiredError}

      Parameters

      • Optional returnUrl: string
      • Optional options: any

      Returns AxiosPromise<any>

Const ORCiDApi

ORCiDApi: { oRCiDLoginGET: any; oRCiDLoginPOST: any } = ...

Type declaration

  • oRCiDLoginGET: function
    • oRCiDLoginGET(returnUrl?: string, options?: any): AxiosPromise<any>
    • summary

      ORCiD Login Route

      throws

      {RequiredError}

      Parameters

      • Optional returnUrl: string
      • Optional options: any

      Returns AxiosPromise<any>

  • oRCiDLoginPOST: function
    • oRCiDLoginPOST(oRCiDJWT?: string, returnUrl?: string, options?: any): AxiosPromise<any>
    • summary

      Execute ORCiD validation and login

      throws

      {RequiredError}

      Parameters

      • Optional oRCiDJWT: string
      • Optional returnUrl: string
      • Optional options: any

      Returns AxiosPromise<any>

Const OrganizationApi

OrganizationApi: { apiV2OrganizationsOptions: any; getOrganization: any; getOrganizations: any } = ...

Type declaration

  • apiV2OrganizationsOptions: function
    • apiV2OrganizationsOptions(options?: any): AxiosPromise<void>
    • summary

      Responds with the HTTP methods allowed for the endpoint.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<void>

  • getOrganization: function
    • getOrganization(organizationRorUri: string, options?: any): AxiosPromise<OrganizationDtoResponse>
    • summary

      Retrieves an organization.

      throws

      {RequiredError}

      Parameters

      • organizationRorUri: string
      • Optional options: any

      Returns AxiosPromise<OrganizationDtoResponse>

  • getOrganizations: function
    • getOrganizations(searchTerm?: string, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<OrganizationDtoIEnumerablePagedResponse>
    • summary

      Retrieves all organizations.

      throws

      {RequiredError}

      Parameters

      • Optional searchTerm: string
      • Optional pageNumber: number
      • Optional pageSize: number
      • Optional orderBy: string
      • Optional options: any

      Returns AxiosPromise<OrganizationDtoIEnumerablePagedResponse>

Const PidApi

PidApi: { apiV2PidsOptions: any; sendRequestToOwner: any; validatePid: any } = ...

Type declaration

  • apiV2PidsOptions: function
    • apiV2PidsOptions(options?: any): AxiosPromise<void>
    • summary

      Responds with the HTTP methods allowed for the endpoint.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<void>

  • sendRequestToOwner: function
    • sendRequestToOwner(prefix: string, id: string, pidRequestDto?: PidRequestDto, options?: any): AxiosPromise<void>
    • summary

      Sends an inquiry to the owner of the given PID.

      throws

      {RequiredError}

      Parameters

      • prefix: string

        The PID prefix of a project or a resource to validate

      • id: string

        The PID body of a project or a resource to validate

      • Optional pidRequestDto: PidRequestDto
      • Optional options: any

      Returns AxiosPromise<void>

  • validatePid: function
    • validatePid(prefix: string, id: string, options?: any): AxiosPromise<PidValidationDtoResponse>
    • summary

      Validates the given PID.

      throws

      {RequiredError}

      Parameters

      • prefix: string

        The PID prefix of a project or a resource to validate

      • id: string

        The PID body of a project or a resource to validate

      • Optional options: any

      Returns AxiosPromise<PidValidationDtoResponse>

Const ProjectApi

ProjectApi: { apiV2ProjectsOptions: any; createProject: any; deleteProject: any; getProject: any; getProjects: any; updateProject: any } = ...

Type declaration

  • apiV2ProjectsOptions: function
    • apiV2ProjectsOptions(options?: any): AxiosPromise<void>
    • summary

      Responds with the HTTP methods allowed for the endpoint.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<void>

  • createProject: function
    • createProject(projectForCreationDto?: ProjectForCreationDto, options?: any): AxiosPromise<ProjectDtoResponse>
    • summary

      Creates a new project.

      throws

      {RequiredError}

      Parameters

      • Optional projectForCreationDto: ProjectForCreationDto
      • Optional options: any

      Returns AxiosPromise<ProjectDtoResponse>

  • deleteProject: function
    • deleteProject(projectId: string, options?: any): AxiosPromise<void>
    • summary

      Deletes a project.

      throws

      {RequiredError}

      Parameters

      • projectId: string

        The ID of the project.

      • Optional options: any

      Returns AxiosPromise<void>

  • getProject: function
    • getProject(projectId: string, includeSubProjects?: boolean, options?: any): AxiosPromise<ProjectDtoResponse>
    • summary

      Retrieves a project.

      throws

      {RequiredError}

      Parameters

      • projectId: string

        The ID of the project.

      • Optional includeSubProjects: boolean
      • Optional options: any

      Returns AxiosPromise<ProjectDtoResponse>

  • getProjects: function
    • getProjects(topLevel?: boolean, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<ProjectDtoIEnumerablePagedResponse>
    • summary

      Retrieves all projects.

      throws

      {RequiredError}

      Parameters

      • Optional topLevel: boolean
      • Optional pageNumber: number
      • Optional pageSize: number
      • Optional orderBy: string
      • Optional options: any

      Returns AxiosPromise<ProjectDtoIEnumerablePagedResponse>

  • updateProject: function
    • updateProject(projectId: string, projectForUpdateDto?: ProjectForUpdateDto, options?: any): AxiosPromise<void>
    • summary

      Updates a project.

      throws

      {RequiredError}

      Parameters

      • projectId: string

        The ID of the project.

      • Optional projectForUpdateDto: ProjectForUpdateDto
      • Optional options: any

      Returns AxiosPromise<void>

Const ProjectInvitationApi

ProjectInvitationApi: { apiV2ProjectsProjectIdInvitationsOptions: any; createProjectInvitation: any; deleteProjectInvitation: any; getProjectInvitation: any; getProjectInvitations: any } = ...

Type declaration

  • apiV2ProjectsProjectIdInvitationsOptions: function
    • apiV2ProjectsProjectIdInvitationsOptions(projectId: string, options?: any): AxiosPromise<void>
    • summary

      Responds with the HTTP methods allowed for the endpoint.

      throws

      {RequiredError}

      Parameters

      • projectId: string
      • Optional options: any

      Returns AxiosPromise<void>

  • createProjectInvitation: function
    • createProjectInvitation(projectId: string, projectInvitationForProjectManipulationDto?: ProjectInvitationForProjectManipulationDto, options?: any): AxiosPromise<ProjectInvitationDtoResponse>
    • summary

      Creates a project invitation for a specified project.

      throws

      {RequiredError}

      Parameters

      • projectId: string

        The Id or slug of the project.

      • Optional projectInvitationForProjectManipulationDto: ProjectInvitationForProjectManipulationDto
      • Optional options: any

      Returns AxiosPromise<ProjectInvitationDtoResponse>

  • deleteProjectInvitation: function
    • deleteProjectInvitation(projectId: string, projectInvitationId: string, options?: any): AxiosPromise<void>
    • summary

      Deletes a project invitation for a specified project.

      throws

      {RequiredError}

      Parameters

      • projectId: string

        The Id or slug of the project.

      • projectInvitationId: string

        The ID of the project invitation to delete.

      • Optional options: any

      Returns AxiosPromise<void>

  • getProjectInvitation: function
    • getProjectInvitation(projectId: string, projectInvitationId: string, options?: any): AxiosPromise<ProjectInvitationDtoResponse>
    • summary

      Retrieves a project invitation for a specified project.

      throws

      {RequiredError}

      Parameters

      • projectId: string

        The Id or slug of the project.

      • projectInvitationId: string

        The ID of the project invitation to retrieve.

      • Optional options: any

      Returns AxiosPromise<ProjectInvitationDtoResponse>

  • getProjectInvitations: function
    • getProjectInvitations(projectId: string, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<ProjectInvitationDtoIEnumerablePagedResponse>
    • summary

      Retrieves all project invitations for a specified project.

      throws

      {RequiredError}

      Parameters

      • projectId: string

        The Id or slug of the project.

      • Optional pageNumber: number
      • Optional pageSize: number
      • Optional orderBy: string
      • Optional options: any

      Returns AxiosPromise<ProjectInvitationDtoIEnumerablePagedResponse>

Const ProjectMemberApi

ProjectMemberApi: { addMembership: any; apiV2ProjectsProjectIdMembersOptions: any; deleteMembership: any; getMembership: any; getMemberships: any; updateMembership: any } = ...

Type declaration

  • addMembership: function
    • addMembership(projectId: string, projectRoleForProjectCreationDto?: ProjectRoleForProjectCreationDto, options?: any): AxiosPromise<ProjectRoleDtoResponse>
    • summary

      Creates a project membership for a specified project.

      throws

      {RequiredError}

      Parameters

      • projectId: string

        The Id or slug of the project.

      • Optional projectRoleForProjectCreationDto: ProjectRoleForProjectCreationDto
      • Optional options: any

      Returns AxiosPromise<ProjectRoleDtoResponse>

  • apiV2ProjectsProjectIdMembersOptions: function
    • apiV2ProjectsProjectIdMembersOptions(projectId: string, options?: any): AxiosPromise<void>
    • summary

      Responds with the HTTP methods allowed for the endpoint.

      throws

      {RequiredError}

      Parameters

      • projectId: string
      • Optional options: any

      Returns AxiosPromise<void>

  • deleteMembership: function
    • deleteMembership(projectId: string, membershipId: string, options?: any): AxiosPromise<void>
    • summary

      Deletes a project membership for a specified project.

      throws

      {RequiredError}

      Parameters

      • projectId: string

        The Id or slug of the project.

      • membershipId: string

        The ID of the project membership to delete.

      • Optional options: any

      Returns AxiosPromise<void>

  • getMembership: function
    • getMembership(projectId: string, membershipId: string, options?: any): AxiosPromise<ProjectRoleDtoResponse>
    • summary

      Retrieves a project membership for a specified project.

      throws

      {RequiredError}

      Parameters

      • projectId: string

        The Id or slug of the project.

      • membershipId: string

        The ID of the project membership to retrieve.

      • Optional options: any

      Returns AxiosPromise<ProjectRoleDtoResponse>

  • getMemberships: function
    • getMemberships(projectId: string, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<ProjectRoleDtoIEnumerablePagedResponse>
    • summary

      Retrieves all project memberships for a specified project.

      throws

      {RequiredError}

      Parameters

      • projectId: string

        The Id or slug of the project.

      • Optional pageNumber: number
      • Optional pageSize: number
      • Optional orderBy: string
      • Optional options: any

      Returns AxiosPromise<ProjectRoleDtoIEnumerablePagedResponse>

  • updateMembership: function
    • updateMembership(projectId: string, membershipId: string, projectRoleForProjectManipulationDto?: ProjectRoleForProjectManipulationDto, options?: any): AxiosPromise<void>
    • summary

      Updates a project membership for a specified project.

      throws

      {RequiredError}

      Parameters

      • projectId: string

        The Id or slug of the project.

      • membershipId: string

        The ID of the project membership to update.

      • Optional projectRoleForProjectManipulationDto: ProjectRoleForProjectManipulationDto
      • Optional options: any

      Returns AxiosPromise<void>

Const ProjectQuotaApi

ProjectQuotaApi: { apiV2ProjectsProjectIdQuotasOptions: any; getProjectQuota: any; getProjectQuotas: any; updateProjectQuota: any } = ...

Type declaration

  • apiV2ProjectsProjectIdQuotasOptions: function
    • apiV2ProjectsProjectIdQuotasOptions(projectId: string, options?: any): AxiosPromise<void>
    • summary

      Responds with the HTTP methods allowed for the endpoint.

      throws

      {RequiredError}

      Parameters

      • projectId: string
      • Optional options: any

      Returns AxiosPromise<void>

  • getProjectQuota: function
    • getProjectQuota(projectId: string, resourceTypeId: string, options?: any): AxiosPromise<ProjectQuotaDtoResponse>
    • summary

      Retrieves a project quota for a specified project and resource type.

      throws

      {RequiredError}

      Parameters

      • projectId: string

        The Id or slug of the project.

      • resourceTypeId: string

        The ID of the resource type.

      • Optional options: any

      Returns AxiosPromise<ProjectQuotaDtoResponse>

  • getProjectQuotas: function
    • getProjectQuotas(projectId: string, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<ProjectQuotaDtoIEnumerablePagedResponse>
    • summary

      Retrieves all project quotas for a specified project.

      throws

      {RequiredError}

      Parameters

      • projectId: string

        The Id or slug of the project.

      • Optional pageNumber: number
      • Optional pageSize: number
      • Optional orderBy: string
      • Optional options: any

      Returns AxiosPromise<ProjectQuotaDtoIEnumerablePagedResponse>

  • updateProjectQuota: function
    • updateProjectQuota(projectId: string, resourceTypeId: string, projectQuotaForUpdateDto?: ProjectQuotaForUpdateDto, options?: any): AxiosPromise<void>
    • summary

      Updates a project quota for a specified project and resource type.

      throws

      {RequiredError}

      Parameters

      • projectId: string

        The Id or slug of the project.

      • resourceTypeId: string

        The ID of the resource type.

      • Optional projectQuotaForUpdateDto: ProjectQuotaForUpdateDto
      • Optional options: any

      Returns AxiosPromise<void>

Const ProjectResourceApi

ProjectResourceApi: { apiV2ProjectsProjectIdResourcesOptions: any; createResourceForProject: any; deleteResourceForProject: any; getResourceForProject: any; getResourcesForProject: any; updateResourceForProject: any } = ...

Type declaration

  • apiV2ProjectsProjectIdResourcesOptions: function
    • apiV2ProjectsProjectIdResourcesOptions(projectId: string, options?: any): AxiosPromise<void>
    • summary

      Responds with the HTTP methods allowed for the endpoint.

      throws

      {RequiredError}

      Parameters

      • projectId: string
      • Optional options: any

      Returns AxiosPromise<void>

  • createResourceForProject: function
    • createResourceForProject(projectId: string, resourceForCreationDto?: ResourceForCreationDto, options?: any): AxiosPromise<ResourceDtoResponse>
    • summary

      Creates a new resource for a specified project.

      throws

      {RequiredError}

      Parameters

      • projectId: string

        The Id or slug of the project.

      • Optional resourceForCreationDto: ResourceForCreationDto
      • Optional options: any

      Returns AxiosPromise<ResourceDtoResponse>

  • deleteResourceForProject: function
    • deleteResourceForProject(projectId: string, resourceId: string, options?: any): AxiosPromise<void>
    • summary

      Deletes a resource for a specified project.

      throws

      {RequiredError}

      Parameters

      • projectId: string

        The Id or slug of the project.

      • resourceId: string

        The ID of the resource to delete.

      • Optional options: any

      Returns AxiosPromise<void>

  • getResourceForProject: function
    • getResourceForProject(projectId: string, resourceId: string, options?: any): AxiosPromise<ResourceDtoResponse>
    • summary

      Retrieves a resource for a specified project.

      throws

      {RequiredError}

      Parameters

      • projectId: string

        The Id or slug of the project.

      • resourceId: string

        The ID of the resource to retrieve.

      • Optional options: any

      Returns AxiosPromise<ResourceDtoResponse>

  • getResourcesForProject: function
    • getResourcesForProject(projectId: string, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<ResourceDtoIEnumerablePagedResponse>
    • summary

      Retrieves all resources for a specified project.

      throws

      {RequiredError}

      Parameters

      • projectId: string

        The Id or slug of the project.

      • Optional pageNumber: number
      • Optional pageSize: number
      • Optional orderBy: string
      • Optional options: any

      Returns AxiosPromise<ResourceDtoIEnumerablePagedResponse>

  • updateResourceForProject: function
    • updateResourceForProject(projectId: string, resourceId: string, resourceForUpdateDto?: ResourceForUpdateDto, options?: any): AxiosPromise<void>
    • summary

      Updates a resource for a specified project.

      throws

      {RequiredError}

      Parameters

      • projectId: string

        The Id or slug of the project.

      • resourceId: string

        The ID of the resource to update.

      • Optional resourceForUpdateDto: ResourceForUpdateDto
      • Optional options: any

      Returns AxiosPromise<void>

Const ProjectResourceQuotaApi

ProjectResourceQuotaApi: { apiV2ProjectsProjectIdResourcesResourceIdQuotaOptions: any; getQuotaForResourceForProject: any } = ...

Type declaration

  • apiV2ProjectsProjectIdResourcesResourceIdQuotaOptions: function
    • apiV2ProjectsProjectIdResourcesResourceIdQuotaOptions(projectId: string, resourceId: string, options?: any): AxiosPromise<void>
    • summary

      Responds with the HTTP methods allowed for the endpoint.

      throws

      {RequiredError}

      Parameters

      • projectId: string
      • resourceId: string
      • Optional options: any

      Returns AxiosPromise<void>

  • getQuotaForResourceForProject: function
    • getQuotaForResourceForProject(projectId: string, resourceId: string, options?: any): AxiosPromise<ResourceQuotaDtoResponse>
    • summary

      Retrieves the resource quota for a specific resource in a project.

      throws

      {RequiredError}

      Parameters

      • projectId: string

        The Id or slug of the project.

      • resourceId: string

        The ID of the resource.

      • Optional options: any

      Returns AxiosPromise<ResourceQuotaDtoResponse>

Const ProjectResourceTypeApi

ProjectResourceTypeApi: { apiV2ProjectsProjectIdResourceTypesOptions: any; getAvailableResourceTypesInformationForProject: any } = ...

Type declaration

  • apiV2ProjectsProjectIdResourceTypesOptions: function
    • apiV2ProjectsProjectIdResourceTypesOptions(projectId: string, options?: any): AxiosPromise<void>
    • summary

      Responds with the HTTP methods allowed for the endpoint.

      throws

      {RequiredError}

      Parameters

      • projectId: string
      • Optional options: any

      Returns AxiosPromise<void>

  • getAvailableResourceTypesInformationForProject: function
    • getAvailableResourceTypesInformationForProject(projectId: string, options?: any): AxiosPromise<ResourceTypeInformationDtoIEnumerableResponse>
    • summary

      Retrieves the available resource types information for a specific project.

      throws

      {RequiredError}

      Parameters

      • projectId: string

        The Id or slug of the project.

      • Optional options: any

      Returns AxiosPromise<ResourceTypeInformationDtoIEnumerableResponse>

Const ResourceApi

ResourceApi: { apiV2ResourcesOptions: any; getResource: any } = ...

Type declaration

  • apiV2ResourcesOptions: function
    • apiV2ResourcesOptions(options?: any): AxiosPromise<void>
    • summary

      Responds with the HTTP methods allowed for the endpoint.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<void>

  • getResource: function
    • getResource(resourceId: string, options?: any): AxiosPromise<ResourceDtoResponse>
    • summary

      Retrieves a resource by its ID.

      throws

      {RequiredError}

      Parameters

      • resourceId: string

        The ID of the resource to retrieve.

      • Optional options: any

      Returns AxiosPromise<ResourceDtoResponse>

Const ResourceTypeApi

ResourceTypeApi: { apiV2ResourceTypesOptions: any; getAllGitlabBranchesForProject: any; getAllGitlabProjects: any; getAllResourceTypesInformation: any; getGitlabProject: any; getResourceTypeInformation: any } = ...

Type declaration

  • apiV2ResourceTypesOptions: function
    • apiV2ResourceTypesOptions(options?: any): AxiosPromise<void>
    • summary

      Responds with the HTTP methods allowed for the endpoint.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<void>

  • getAllGitlabBranchesForProject: function
    • getAllGitlabBranchesForProject(gitlabProjectId: number, domain: string, accessToken: string, options?: any): AxiosPromise<GitlabBranchDtoIEnumerableResponse>
    • summary

      Retrieves all branches of a GitLab project, that the user is a member of, based on the provided credentials.

      throws

      {RequiredError}

      Parameters

      • gitlabProjectId: number

        The ID of the GitLab project.

      • domain: string
      • accessToken: string
      • Optional options: any

      Returns AxiosPromise<GitlabBranchDtoIEnumerableResponse>

  • getAllGitlabProjects: function
    • getAllGitlabProjects(domain: string, accessToken: string, options?: any): AxiosPromise<GitlabProjectDtoIEnumerableResponse>
    • summary

      Retrieves all GitLab projects, that the user is a member of, based on the provided credentials.

      throws

      {RequiredError}

      Parameters

      • domain: string
      • accessToken: string
      • Optional options: any

      Returns AxiosPromise<GitlabProjectDtoIEnumerableResponse>

  • getAllResourceTypesInformation: function
    • getAllResourceTypesInformation(options?: any): AxiosPromise<ResourceTypeInformationDtoIEnumerableResponse>
    • summary

      Retrieves the entire global resource types information.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<ResourceTypeInformationDtoIEnumerableResponse>

  • getGitlabProject: function
    • getGitlabProject(gitlabProjectId: number, domain: string, accessToken: string, options?: any): AxiosPromise<GitlabProjectDtoResponse>
    • summary

      Retrieves a single GitLab project, that the user is a member of, based on the provided credentials.

      throws

      {RequiredError}

      Parameters

      • gitlabProjectId: number

        The ID of the GitLab project.

      • domain: string
      • accessToken: string
      • Optional options: any

      Returns AxiosPromise<GitlabProjectDtoResponse>

  • getResourceTypeInformation: function
    • getResourceTypeInformation(resourceTypeId: string, options?: any): AxiosPromise<ResourceTypeInformationDtoResponse>
    • summary

      Retrieves the resource type information for a specific resource type.

      throws

      {RequiredError}

      Parameters

      • resourceTypeId: string

        The ID of the resource type to retrieve.

      • Optional options: any

      Returns AxiosPromise<ResourceTypeInformationDtoResponse>

Const RoleApi

RoleApi: { apiV2RolesOptions: any; getRole: any; getRoles: any } = ...

Type declaration

  • apiV2RolesOptions: function
    • apiV2RolesOptions(options?: any): AxiosPromise<void>
    • summary

      Responds with the HTTP methods allowed for the endpoint.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<void>

  • getRole: function
    • getRole(roleId: string, options?: any): AxiosPromise<RoleDtoResponse>
    • summary

      Retrieves a role by ID.

      throws

      {RequiredError}

      Parameters

      • roleId: string

        The ID of the role.

      • Optional options: any

      Returns AxiosPromise<RoleDtoResponse>

  • getRoles: function
    • getRoles(pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<RoleDtoIEnumerablePagedResponse>
    • summary

      Retrieves all roles.

      throws

      {RequiredError}

      Parameters

      • Optional pageNumber: number
      • Optional pageSize: number
      • Optional orderBy: string
      • Optional options: any

      Returns AxiosPromise<RoleDtoIEnumerablePagedResponse>

Const SearchApi

SearchApi: { apiV2SearchOptions: any; getSearchResults: any } = ...

Type declaration

  • apiV2SearchOptions: function
    • apiV2SearchOptions(options?: any): AxiosPromise<void>
    • summary

      Responds with the HTTP methods allowed for the endpoint.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<void>

  • getSearchResults: function
    • getSearchResults(query?: string, useAdvancedSyntax?: boolean, languages?: string[], category?: SearchCategoryType, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<SearchResultDtoIEnumerablePagedResponse>
    • summary

      Retrieves a search result by given search parameters.

      throws

      {RequiredError}

      Parameters

      • Optional query: string
      • Optional useAdvancedSyntax: boolean
      • Optional languages: string[]
      • Optional category: SearchCategoryType
      • Optional pageNumber: number
      • Optional pageSize: number
      • Optional orderBy: string
      • Optional options: any

      Returns AxiosPromise<SearchResultDtoIEnumerablePagedResponse>

Const SelfApi

SelfApi: { acceptCurrentTos: any; apiV2SelfOptions: any; confirmUserEmail: any; getCurrentUser: any; initiateUserMerge: any; resolveProjectInvitation: any; updateCurrentUser: any } = ...

Type declaration

  • acceptCurrentTos: function
    • acceptCurrentTos(userTermsOfServiceAcceptDto?: UserTermsOfServiceAcceptDto, options?: any): AxiosPromise<void>
    • summary

      Accepts the current Terms Of Service for the current authenticated user.

      throws

      {RequiredError}

      Parameters

      • Optional userTermsOfServiceAcceptDto: UserTermsOfServiceAcceptDto
      • Optional options: any

      Returns AxiosPromise<void>

  • apiV2SelfOptions: function
    • apiV2SelfOptions(options?: any): AxiosPromise<void>
    • summary

      Responds with the HTTP methods allowed for the endpoint.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<void>

  • confirmUserEmail: function
    • confirmUserEmail(confirmationToken: string, options?: any): AxiosPromise<void>
    • summary

      Confirms the email of a user.

      throws

      {RequiredError}

      Parameters

      • confirmationToken: string
      • Optional options: any

      Returns AxiosPromise<void>

  • getCurrentUser: function
    • getCurrentUser(options?: any): AxiosPromise<UserDtoResponse>
    • summary

      Retrieves the current authenticated user.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<UserDtoResponse>

  • initiateUserMerge: function
    • initiateUserMerge(identityProvider: IdentityProviders, options?: any): AxiosPromise<UserMergeDtoResponse>
    • summary

      Initiates user merging for the current user.

      throws

      {RequiredError}

      Parameters

      • identityProvider: IdentityProviders
      • Optional options: any

      Returns AxiosPromise<UserMergeDtoResponse>

  • resolveProjectInvitation: function
    • resolveProjectInvitation(projectInvitationResolveDto?: ProjectInvitationResolveDto, options?: any): AxiosPromise<void>
    • summary

      Resolves a project invitation for the authenticated user.

      throws

      {RequiredError}

      Parameters

      • Optional projectInvitationResolveDto: ProjectInvitationResolveDto
      • Optional options: any

      Returns AxiosPromise<void>

  • updateCurrentUser: function
    • updateCurrentUser(userForUpdateDto?: UserForUpdateDto, options?: any): AxiosPromise<void>
    • summary

      Updates the current authenticated user.

      throws

      {RequiredError}

      Parameters

      • Optional userForUpdateDto: UserForUpdateDto
      • Optional options: any

      Returns AxiosPromise<void>

Const SelfApiTokenApi

SelfApiTokenApi: { apiV2SelfApiTokensOptions: any; createApiToken: any; getAllApiTokens: any; getApiToken: any; revokeToken: any } = ...

Type declaration

  • apiV2SelfApiTokensOptions: function
    • apiV2SelfApiTokensOptions(options?: any): AxiosPromise<void>
    • summary

      Responds with the HTTP methods allowed for the endpoint.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<void>

  • createApiToken: function
    • createApiToken(apiTokenForCreationDto?: ApiTokenForCreationDto, options?: any): AxiosPromise<ApiTokenDtoResponse>
    • summary

      Creates an API token for the current authenticated user.

      throws

      {RequiredError}

      Parameters

      • Optional apiTokenForCreationDto: ApiTokenForCreationDto
      • Optional options: any

      Returns AxiosPromise<ApiTokenDtoResponse>

  • getAllApiTokens: function
    • getAllApiTokens(pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<ApiTokenDtoIEnumerablePagedResponse>
    • summary

      Retrieves all API tokens for the current authenticated user.

      throws

      {RequiredError}

      Parameters

      • Optional pageNumber: number
      • Optional pageSize: number
      • Optional orderBy: string
      • Optional options: any

      Returns AxiosPromise<ApiTokenDtoIEnumerablePagedResponse>

  • getApiToken: function
    • getApiToken(apiTokenId: string, options?: any): AxiosPromise<ApiTokenDtoResponse>
    • summary

      Retrieves an API token for the current authenticated user.

      throws

      {RequiredError}

      Parameters

      • apiTokenId: string

        The ID of the token.

      • Optional options: any

      Returns AxiosPromise<ApiTokenDtoResponse>

  • revokeToken: function
    • revokeToken(apiTokenId: string, options?: any): AxiosPromise<void>
    • summary

      Revokes an API token for the current authenticated user.

      throws

      {RequiredError}

      Parameters

      • apiTokenId: string

        The ID of the token.

      • Optional options: any

      Returns AxiosPromise<void>

Const ShibbolethApi

ShibbolethApi: { shibbolethCallback: any; shibbolethLogin: any } = ...

Type declaration

  • shibbolethCallback: function
    • shibbolethCallback(returnUrl?: string, remoteError?: string, options?: any): AxiosPromise<any>
    • summary

      Callback method to catch the login

      throws

      {RequiredError}

      Parameters

      • Optional returnUrl: string
      • Optional remoteError: string
      • Optional options: any

      Returns AxiosPromise<any>

  • shibbolethLogin: function
    • shibbolethLogin(returnUrl?: string, entityId?: string, options?: any): AxiosPromise<any>
    • summary

      This method is the central route for logging into an identity provider. On default, the user is redirected to the WAFY of the DFN-AAI. Setting the "entityId" parameter allows the application to redirect to a specific identity provider defined by DFN-AAI.

      throws

      {RequiredError}

      Parameters

      • Optional returnUrl: string
      • Optional entityId: string
      • Optional options: any

      Returns AxiosPromise<any>

Const TitleApi

TitleApi: { apiV2TitlesOptions: any; getTitle: any; getTitles: any } = ...

Type declaration

  • apiV2TitlesOptions: function
    • apiV2TitlesOptions(options?: any): AxiosPromise<void>
    • summary

      Responds with the HTTP methods allowed for the endpoint.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<void>

  • getTitle: function
    • getTitle(titleId: string, options?: any): AxiosPromise<TitleDtoResponse>
    • summary

      Retrieves a title by ID.

      throws

      {RequiredError}

      Parameters

      • titleId: string

        The ID of the title.

      • Optional options: any

      Returns AxiosPromise<TitleDtoResponse>

  • getTitles: function
    • getTitles(pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<TitleDtoIEnumerablePagedResponse>
    • summary

      Retrieves all titles.

      throws

      {RequiredError}

      Parameters

      • Optional pageNumber: number
      • Optional pageSize: number
      • Optional orderBy: string
      • Optional options: any

      Returns AxiosPromise<TitleDtoIEnumerablePagedResponse>

Const TosApi

TosApi: { apiV2TosOptions: any; getTos: any } = ...

Type declaration

  • apiV2TosOptions: function
    • apiV2TosOptions(options?: any): AxiosPromise<void>
    • summary

      Responds with the HTTP methods allowed for the endpoint.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<void>

  • getTos: function
    • getTos(options?: any): AxiosPromise<TermsOfServiceDtoResponse>
    • summary

      Retrieves the current Terms of Service version.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<TermsOfServiceDtoResponse>

Const TreeApi

TreeApi: { apiV2ProjectsProjectIdResourcesResourceIdTreesOptions: any; createMetadataTree: any; getFileTree: any; getMetadataTree: any; updateMetadataTree: any } = ...

Type declaration

  • apiV2ProjectsProjectIdResourcesResourceIdTreesOptions: function
    • apiV2ProjectsProjectIdResourcesResourceIdTreesOptions(projectId: string, resourceId: string, options?: any): AxiosPromise<void>
    • summary

      Responds with the HTTP methods allowed for the endpoint.

      throws

      {RequiredError}

      Parameters

      • projectId: string
      • resourceId: string
      • Optional options: any

      Returns AxiosPromise<void>

  • createMetadataTree: function
    • createMetadataTree(projectId: string, resourceId: string, metadataTreeForCreationDto?: MetadataTreeForCreationDto, options?: any): AxiosPromise<MetadataTreeDtoResponse>
    • summary

      Creates a new metadata tree for a resource.

      throws

      {RequiredError}

      Parameters

      • projectId: string

        The unique identifier or slug of the project.

      • resourceId: string

        The unique identifier of the resource.

      • Optional metadataTreeForCreationDto: MetadataTreeForCreationDto
      • Optional options: any

      Returns AxiosPromise<MetadataTreeDtoResponse>

  • getFileTree: function
    • getFileTree(projectId: string, resourceId: string, path?: string, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<FileTreeDtoIEnumerablePagedResponse>
    • The OrderBy query is currently not supported.

      summary

      Retrieves the file tree associated with a resource.

      throws

      {RequiredError}

      Parameters

      • projectId: string

        The unique identifier or slug of the project.

      • resourceId: string

        The unique identifier of the resource.

      • Optional path: string
      • Optional pageNumber: number
      • Optional pageSize: number
      • Optional orderBy: string
      • Optional options: any

      Returns AxiosPromise<FileTreeDtoIEnumerablePagedResponse>

  • getMetadataTree: function
    • getMetadataTree(projectId: string, resourceId: string, path?: string, format?: RdfFormat, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<MetadataTreeDtoIEnumerablePagedResponse>
    • summary

      Retrieves the metadata tree associated with a resource.

      throws

      {RequiredError}

      Parameters

      • projectId: string

        The unique identifier or slug of the project.

      • resourceId: string

        The unique identifier of the resource.

      • Optional path: string
      • Optional format: RdfFormat
      • Optional pageNumber: number
      • Optional pageSize: number
      • Optional orderBy: string
      • Optional options: any

      Returns AxiosPromise<MetadataTreeDtoIEnumerablePagedResponse>

  • updateMetadataTree: function
    • updateMetadataTree(projectId: string, resourceId: string, metadataTreeForUpdateDto?: MetadataTreeForUpdateDto, options?: any): AxiosPromise<void>
    • summary

      Updates an existing metadata tree of a resource.

      throws

      {RequiredError}

      Parameters

      • projectId: string

        The unique identifier or slug of the project.

      • resourceId: string

        The unique identifier of the resource.

      • Optional metadataTreeForUpdateDto: MetadataTreeForUpdateDto
      • Optional options: any

      Returns AxiosPromise<void>

Const UserApi

UserApi: { apiV2UsersOptions: any; getUsers: any } = ...

Type declaration

  • apiV2UsersOptions: function
    • apiV2UsersOptions(options?: any): AxiosPromise<void>
    • summary

      Responds with the HTTP methods allowed for the endpoint.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<void>

  • getUsers: function
    • getUsers(searchTerm: string, orderBy?: string, options?: any): AxiosPromise<PublicUserDtoIEnumerableResponse>
    • summary

      Retrieves all users.

      throws

      {RequiredError}

      Parameters

      • searchTerm: string
      • Optional orderBy: string
      • Optional options: any

      Returns AxiosPromise<PublicUserDtoIEnumerableResponse>

Const VisibilityApi

VisibilityApi: { apiV2VisibilitiesOptions: any; getVisibilities: any; getVisibility: any } = ...

Type declaration

  • apiV2VisibilitiesOptions: function
    • apiV2VisibilitiesOptions(options?: any): AxiosPromise<void>
    • summary

      Responds with the HTTP methods allowed for the endpoint.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<void>

  • getVisibilities: function
    • getVisibilities(pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<VisibilityDtoIEnumerablePagedResponse>
    • summary

      Retrieves all visibilities.

      throws

      {RequiredError}

      Parameters

      • Optional pageNumber: number
      • Optional pageSize: number
      • Optional orderBy: string
      • Optional options: any

      Returns AxiosPromise<VisibilityDtoIEnumerablePagedResponse>

  • getVisibility: function
    • getVisibility(visibilityId: string, options?: any): AxiosPromise<VisibilityDtoResponse>
    • summary

      Retrieves a visibility by ID.

      throws

      {RequiredError}

      Parameters

      • visibilityId: string

        The ID of the visibility.

      • Optional options: any

      Returns AxiosPromise<VisibilityDtoResponse>

Const VocabularyApi

VocabularyApi: { apiV2VocabulariesOptions: any; getVocabularies: any; getVocabularyInstance: any; getVocabularyInstances: any } = ...

Type declaration

  • apiV2VocabulariesOptions: function
    • apiV2VocabulariesOptions(options?: any): AxiosPromise<void>
    • summary

      Responds with the HTTP methods allowed for the endpoint.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<void>

  • getVocabularies: function
    • getVocabularies(searchTerm?: string, language?: AcceptedLanguage, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<VocabularyDtoIEnumerablePagedResponse>
    • summary

      Retrieves top-level instances from vocabularies.

      throws

      {RequiredError}

      Parameters

      • Optional searchTerm: string
      • Optional language: AcceptedLanguage
      • Optional pageNumber: number
      • Optional pageSize: number
      • Optional orderBy: string
      • Optional options: any

      Returns AxiosPromise<VocabularyDtoIEnumerablePagedResponse>

  • getVocabularyInstance: function
    • getVocabularyInstance(instance: string, acceptLanguage?: AcceptedLanguage, options?: any): AxiosPromise<VocabularyInstanceDtoResponse>
    • Could be a top-level instance, or an intermediate-level instance from a vocabulary.

      summary

      Retrieves a single instance from a vocabulary.

      throws

      {RequiredError}

      Parameters

      • instance: string

        The URI of the vocabulary instance to retrieve.

      • Optional acceptLanguage: AcceptedLanguage
      • Optional options: any

      Returns AxiosPromise<VocabularyInstanceDtoResponse>

  • getVocabularyInstances: function
    • getVocabularyInstances(_class: string, searchTerm?: string, language?: AcceptedLanguage, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<VocabularyInstanceDtoIEnumerablePagedResponse>
    • summary

      Retrieves vocabulary instances.

      throws

      {RequiredError}

      Parameters

      • _class: string
      • Optional searchTerm: string
      • Optional language: AcceptedLanguage
      • Optional pageNumber: number
      • Optional pageSize: number
      • Optional orderBy: string
      • Optional options: any

      Returns AxiosPromise<VocabularyInstanceDtoIEnumerablePagedResponse>

Const default

default: { AccountApi: { accountGetLoginUrls: any; accountLogout: any }; AdminApi: { adminGetProject: any; adminUpdateQuota: any }; ApplicationProfileApi: { apiV2ApplicationProfilesOptions: any; createApplicationProfileRequest: any; getApplicationProfile: any; getApplicationProfiles: any; getRawApplicationProfile: any }; BlobApi: { apiV2ProjectsProjectIdResourcesResourceIdBlobsOptions: any; createBlob: any; deleteBlob: any; getBlob: any; updateBlob: any }; DisciplineApi: { apiV2DisciplinesOptions: any; getDiscipline: any; getDisciplines: any }; HomeApi: { homeIndex: any }; LanguageApi: { apiV2LanguagesOptions: any; getLanguage: any; getLanguages: any }; LicenseApi: { apiV2LicensesOptions: any; getLicense: any; getLicenses: any }; MaintenanceApi: { apiV2MaintenancesOptions: any; getCurrentMaintenances: any }; MergeApi: { mergeCallback: any; mergeLogin: any }; ORCiDApi: { oRCiDLoginGET: any; oRCiDLoginPOST: any }; OrganizationApi: { apiV2OrganizationsOptions: any; getOrganization: any; getOrganizations: any }; PidApi: { apiV2PidsOptions: any; sendRequestToOwner: any; validatePid: any }; ProjectApi: { apiV2ProjectsOptions: any; createProject: any; deleteProject: any; getProject: any; getProjects: any; updateProject: any }; ProjectInvitationApi: { apiV2ProjectsProjectIdInvitationsOptions: any; createProjectInvitation: any; deleteProjectInvitation: any; getProjectInvitation: any; getProjectInvitations: any }; ProjectMemberApi: { addMembership: any; apiV2ProjectsProjectIdMembersOptions: any; deleteMembership: any; getMembership: any; getMemberships: any; updateMembership: any }; ProjectQuotaApi: { apiV2ProjectsProjectIdQuotasOptions: any; getProjectQuota: any; getProjectQuotas: any; updateProjectQuota: any }; ProjectResourceApi: { apiV2ProjectsProjectIdResourcesOptions: any; createResourceForProject: any; deleteResourceForProject: any; getResourceForProject: any; getResourcesForProject: any; updateResourceForProject: any }; ProjectResourceQuotaApi: { apiV2ProjectsProjectIdResourcesResourceIdQuotaOptions: any; getQuotaForResourceForProject: any }; ProjectResourceTypeApi: { apiV2ProjectsProjectIdResourceTypesOptions: any; getAvailableResourceTypesInformationForProject: any }; ResourceApi: { apiV2ResourcesOptions: any; getResource: any }; ResourceTypeApi: { apiV2ResourceTypesOptions: any; getAllGitlabBranchesForProject: any; getAllGitlabProjects: any; getAllResourceTypesInformation: any; getGitlabProject: any; getResourceTypeInformation: any }; RoleApi: { apiV2RolesOptions: any; getRole: any; getRoles: any }; SearchApi: { apiV2SearchOptions: any; getSearchResults: any }; SelfApi: { acceptCurrentTos: any; apiV2SelfOptions: any; confirmUserEmail: any; getCurrentUser: any; initiateUserMerge: any; resolveProjectInvitation: any; updateCurrentUser: any }; SelfApiTokenApi: { apiV2SelfApiTokensOptions: any; createApiToken: any; getAllApiTokens: any; getApiToken: any; revokeToken: any }; ShibbolethApi: { shibbolethCallback: any; shibbolethLogin: any }; TitleApi: { apiV2TitlesOptions: any; getTitle: any; getTitles: any }; TosApi: { apiV2TosOptions: any; getTos: any }; TreeApi: { apiV2ProjectsProjectIdResourcesResourceIdTreesOptions: any; createMetadataTree: any; getFileTree: any; getMetadataTree: any; updateMetadataTree: any }; UserApi: { apiV2UsersOptions: any; getUsers: any }; VisibilityApi: { apiV2VisibilitiesOptions: any; getVisibilities: any; getVisibility: any }; VocabularyApi: { apiV2VocabulariesOptions: any; getVocabularies: any; getVocabularyInstance: any; getVocabularyInstances: any } } = ...

Type declaration

  • AccountApi: { accountGetLoginUrls: any; accountLogout: any }
    • accountGetLoginUrls: function
      • accountGetLoginUrls(options?: any): AxiosPromise<LoginUrls>
      • summary

        Return relevant URLs for logging the user in

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<LoginUrls>

    • accountLogout: function
      • accountLogout(options?: any): AxiosPromise<any>
      • summary

        Route for logging the user out of Coscine

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<any>

  • AdminApi: { adminGetProject: any; adminUpdateQuota: any }
    • adminGetProject: function
      • adminGetProject(projectString: string, options?: any): AxiosPromise<AdminProjectObject>
      • summary

        Find the project related to the projectString(GUID or slug)

        throws

        {RequiredError}

        Parameters

        • projectString: string

          The project id (GUID) or slug (from URL).

        • Optional options: any

        Returns AxiosPromise<AdminProjectObject>

    • adminUpdateQuota: function
      • adminUpdateQuota(projectId: string, resourceTypeId: string, updateQuotaParameterObject: UpdateQuotaParameterObject, options?: any): AxiosPromise<any>
      • summary

        Update a project maximum and allocated quota

        throws

        {RequiredError}

        Parameters

        • projectId: string

          Id of the project

        • resourceTypeId: string

          Id of the resource type

        • updateQuotaParameterObject: UpdateQuotaParameterObject

          JSON object for updating the project maximum and allocated quota.

        • Optional options: any

        Returns AxiosPromise<any>

  • ApplicationProfileApi: { apiV2ApplicationProfilesOptions: any; createApplicationProfileRequest: any; getApplicationProfile: any; getApplicationProfiles: any; getRawApplicationProfile: any }
    • apiV2ApplicationProfilesOptions: function
      • apiV2ApplicationProfilesOptions(options?: any): AxiosPromise<void>
      • summary

        Responds with the HTTP methods allowed for the endpoint.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<void>

    • createApplicationProfileRequest: function
      • createApplicationProfileRequest(applicationProfileForCreationDto?: ApplicationProfileForCreationDto, options?: any): AxiosPromise<ApplicationProfileForCreationDtoResponse>
      • summary

        Submits a request to create a new application profile.

        throws

        {RequiredError}

        Parameters

        • Optional applicationProfileForCreationDto: ApplicationProfileForCreationDto
        • Optional options: any

        Returns AxiosPromise<ApplicationProfileForCreationDtoResponse>

    • getApplicationProfile: function
      • getApplicationProfile(profile: string, format?: RdfFormat, acceptLanguage?: AcceptedLanguage, options?: any): AxiosPromise<ApplicationProfileDtoResponse>
      • summary

        Retrieves an application profile by its URI.

        throws

        {RequiredError}

        Parameters

        • profile: string

          The URI of the application profile to retrieve.

        • Optional format: RdfFormat
        • Optional acceptLanguage: AcceptedLanguage
        • Optional options: any

        Returns AxiosPromise<ApplicationProfileDtoResponse>

    • getApplicationProfiles: function
      • getApplicationProfiles(searchTerm?: string, language?: AcceptedLanguage, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<ApplicationProfileDtoIEnumerablePagedResponse>
      • summary

        Retrieves all application profiles.

        throws

        {RequiredError}

        Parameters

        • Optional searchTerm: string
        • Optional language: AcceptedLanguage
        • Optional pageNumber: number
        • Optional pageSize: number
        • Optional orderBy: string
        • Optional options: any

        Returns AxiosPromise<ApplicationProfileDtoIEnumerablePagedResponse>

    • getRawApplicationProfile: function
      • getRawApplicationProfile(profile: string, options?: any): AxiosPromise<string>
      • summary

        Retrieves the raw application profile definition by its URI.

        throws

        {RequiredError}

        Parameters

        • profile: string

          The URI of the application profile.

        • Optional options: any

        Returns AxiosPromise<string>

  • BlobApi: { apiV2ProjectsProjectIdResourcesResourceIdBlobsOptions: any; createBlob: any; deleteBlob: any; getBlob: any; updateBlob: any }
    • apiV2ProjectsProjectIdResourcesResourceIdBlobsOptions: function
      • apiV2ProjectsProjectIdResourcesResourceIdBlobsOptions(projectId: string, resourceId: string, options?: any): AxiosPromise<void>
      • summary

        Responds with the HTTP methods allowed for the endpoint.

        throws

        {RequiredError}

        Parameters

        • projectId: string
        • resourceId: string
        • Optional options: any

        Returns AxiosPromise<void>

    • createBlob: function
      • createBlob(projectId: string, resourceId: string, key: string, file?: any, options?: any): AxiosPromise<void>
      • summary

        Creates a new blob for a resource.

        throws

        {RequiredError}

        Parameters

        • projectId: string

          The identifier or slug of the project.

        • resourceId: string

          The identifier of the resource.

        • key: string

          The key for the new blob.

        • Optional file: any
        • Optional options: any

        Returns AxiosPromise<void>

    • deleteBlob: function
      • deleteBlob(projectId: string, resourceId: string, key: string, options?: any): AxiosPromise<void>
      • summary

        Deletes a blob from a resource.

        throws

        {RequiredError}

        Parameters

        • projectId: string

          The identifier or slug of the project.

        • resourceId: string

          The identifier of the resource.

        • key: string

          The key associated with the blob to delete.

        • Optional options: any

        Returns AxiosPromise<void>

    • getBlob: function
      • getBlob(projectId: string, resourceId: string, key: string, options?: any): AxiosPromise<any>
      • summary

        Download a blob from a resource.

        throws

        {RequiredError}

        Parameters

        • projectId: string

          The identifier or slug of the project.

        • resourceId: string

          The identifier of the resource.

        • key: string

          The key associated with the blob.

        • Optional options: any

        Returns AxiosPromise<any>

    • updateBlob: function
      • updateBlob(projectId: string, resourceId: string, key: string, file?: any, options?: any): AxiosPromise<void>
      • summary

        Updates an existing blob of a resource.

        throws

        {RequiredError}

        Parameters

        • projectId: string

          The identifier or slug of the project.

        • resourceId: string

          The identifier of the resource.

        • key: string

          The key associated with the blob to update.

        • Optional file: any
        • Optional options: any

        Returns AxiosPromise<void>

  • DisciplineApi: { apiV2DisciplinesOptions: any; getDiscipline: any; getDisciplines: any }
    • apiV2DisciplinesOptions: function
      • apiV2DisciplinesOptions(options?: any): AxiosPromise<void>
      • summary

        Responds with the HTTP methods allowed for the endpoint.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<void>

    • getDiscipline: function
      • getDiscipline(disciplineId: string, options?: any): AxiosPromise<DisciplineDtoResponse>
      • summary

        Retrieves a discipline with the specified ID.

        throws

        {RequiredError}

        Parameters

        • disciplineId: string

          The ID of the discipline.

        • Optional options: any

        Returns AxiosPromise<DisciplineDtoResponse>

    • getDisciplines: function
      • getDisciplines(pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<DisciplineDtoIEnumerablePagedResponse>
      • summary

        Retrieves all disciplines.

        throws

        {RequiredError}

        Parameters

        • Optional pageNumber: number
        • Optional pageSize: number
        • Optional orderBy: string
        • Optional options: any

        Returns AxiosPromise<DisciplineDtoIEnumerablePagedResponse>

  • HomeApi: { homeIndex: any }
    • homeIndex: function
      • homeIndex(options?: any): AxiosPromise<any>
      • summary

        The controller that the user is automatically entering when accesing the route .../coscine/api/Coscine.STS/

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<any>

  • LanguageApi: { apiV2LanguagesOptions: any; getLanguage: any; getLanguages: any }
    • apiV2LanguagesOptions: function
      • apiV2LanguagesOptions(options?: any): AxiosPromise<void>
      • summary

        Responds with the HTTP methods allowed for the endpoint.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<void>

    • getLanguage: function
      • getLanguage(languageId: string, options?: any): AxiosPromise<LanguageDtoResponse>
      • summary

        Retrieves a language by ID.

        throws

        {RequiredError}

        Parameters

        • languageId: string

          The ID of the language.

        • Optional options: any

        Returns AxiosPromise<LanguageDtoResponse>

    • getLanguages: function
      • getLanguages(pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<LanguageDtoIEnumerablePagedResponse>
      • summary

        Retrieves all languages.

        throws

        {RequiredError}

        Parameters

        • Optional pageNumber: number
        • Optional pageSize: number
        • Optional orderBy: string
        • Optional options: any

        Returns AxiosPromise<LanguageDtoIEnumerablePagedResponse>

  • LicenseApi: { apiV2LicensesOptions: any; getLicense: any; getLicenses: any }
    • apiV2LicensesOptions: function
      • apiV2LicensesOptions(options?: any): AxiosPromise<void>
      • summary

        Responds with the HTTP methods allowed for the endpoint.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<void>

    • getLicense: function
      • getLicense(licenseId: string, options?: any): AxiosPromise<LicenseDtoResponse>
      • summary

        Retrieves a license with the specified ID.

        throws

        {RequiredError}

        Parameters

        • licenseId: string

          The ID of the license.

        • Optional options: any

        Returns AxiosPromise<LicenseDtoResponse>

    • getLicenses: function
      • getLicenses(pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<LicenseDtoIEnumerablePagedResponse>
      • summary

        Retrieves all licenses.

        throws

        {RequiredError}

        Parameters

        • Optional pageNumber: number
        • Optional pageSize: number
        • Optional orderBy: string
        • Optional options: any

        Returns AxiosPromise<LicenseDtoIEnumerablePagedResponse>

  • MaintenanceApi: { apiV2MaintenancesOptions: any; getCurrentMaintenances: any }
    • apiV2MaintenancesOptions: function
      • apiV2MaintenancesOptions(options?: any): AxiosPromise<void>
      • summary

        Responds with the HTTP methods allowed for the endpoint.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<void>

    • getCurrentMaintenances: function
      • getCurrentMaintenances(options?: any): AxiosPromise<MaintenanceDtoIEnumerablePagedResponse>
      • summary

        Retrieves the current maintenance messages.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<MaintenanceDtoIEnumerablePagedResponse>

  • MergeApi: { mergeCallback: any; mergeLogin: any }
    • mergeCallback: function
      • mergeCallback(returnUrl?: string, options?: any): AxiosPromise<any>
      • throws

        {RequiredError}

        Parameters

        • Optional returnUrl: string
        • Optional options: any

        Returns AxiosPromise<any>

    • mergeLogin: function
      • mergeLogin(returnUrl?: string, options?: any): AxiosPromise<any>
      • throws

        {RequiredError}

        Parameters

        • Optional returnUrl: string
        • Optional options: any

        Returns AxiosPromise<any>

  • ORCiDApi: { oRCiDLoginGET: any; oRCiDLoginPOST: any }
    • oRCiDLoginGET: function
      • oRCiDLoginGET(returnUrl?: string, options?: any): AxiosPromise<any>
      • summary

        ORCiD Login Route

        throws

        {RequiredError}

        Parameters

        • Optional returnUrl: string
        • Optional options: any

        Returns AxiosPromise<any>

    • oRCiDLoginPOST: function
      • oRCiDLoginPOST(oRCiDJWT?: string, returnUrl?: string, options?: any): AxiosPromise<any>
      • summary

        Execute ORCiD validation and login

        throws

        {RequiredError}

        Parameters

        • Optional oRCiDJWT: string
        • Optional returnUrl: string
        • Optional options: any

        Returns AxiosPromise<any>

  • OrganizationApi: { apiV2OrganizationsOptions: any; getOrganization: any; getOrganizations: any }
    • apiV2OrganizationsOptions: function
      • apiV2OrganizationsOptions(options?: any): AxiosPromise<void>
      • summary

        Responds with the HTTP methods allowed for the endpoint.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<void>

    • getOrganization: function
      • getOrganization(organizationRorUri: string, options?: any): AxiosPromise<OrganizationDtoResponse>
      • summary

        Retrieves an organization.

        throws

        {RequiredError}

        Parameters

        • organizationRorUri: string
        • Optional options: any

        Returns AxiosPromise<OrganizationDtoResponse>

    • getOrganizations: function
      • getOrganizations(searchTerm?: string, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<OrganizationDtoIEnumerablePagedResponse>
      • summary

        Retrieves all organizations.

        throws

        {RequiredError}

        Parameters

        • Optional searchTerm: string
        • Optional pageNumber: number
        • Optional pageSize: number
        • Optional orderBy: string
        • Optional options: any

        Returns AxiosPromise<OrganizationDtoIEnumerablePagedResponse>

  • PidApi: { apiV2PidsOptions: any; sendRequestToOwner: any; validatePid: any }
    • apiV2PidsOptions: function
      • apiV2PidsOptions(options?: any): AxiosPromise<void>
      • summary

        Responds with the HTTP methods allowed for the endpoint.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<void>

    • sendRequestToOwner: function
      • sendRequestToOwner(prefix: string, id: string, pidRequestDto?: PidRequestDto, options?: any): AxiosPromise<void>
      • summary

        Sends an inquiry to the owner of the given PID.

        throws

        {RequiredError}

        Parameters

        • prefix: string

          The PID prefix of a project or a resource to validate

        • id: string

          The PID body of a project or a resource to validate

        • Optional pidRequestDto: PidRequestDto
        • Optional options: any

        Returns AxiosPromise<void>

    • validatePid: function
      • validatePid(prefix: string, id: string, options?: any): AxiosPromise<PidValidationDtoResponse>
      • summary

        Validates the given PID.

        throws

        {RequiredError}

        Parameters

        • prefix: string

          The PID prefix of a project or a resource to validate

        • id: string

          The PID body of a project or a resource to validate

        • Optional options: any

        Returns AxiosPromise<PidValidationDtoResponse>

  • ProjectApi: { apiV2ProjectsOptions: any; createProject: any; deleteProject: any; getProject: any; getProjects: any; updateProject: any }
    • apiV2ProjectsOptions: function
      • apiV2ProjectsOptions(options?: any): AxiosPromise<void>
      • summary

        Responds with the HTTP methods allowed for the endpoint.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<void>

    • createProject: function
      • createProject(projectForCreationDto?: ProjectForCreationDto, options?: any): AxiosPromise<ProjectDtoResponse>
      • summary

        Creates a new project.

        throws

        {RequiredError}

        Parameters

        • Optional projectForCreationDto: ProjectForCreationDto
        • Optional options: any

        Returns AxiosPromise<ProjectDtoResponse>

    • deleteProject: function
      • deleteProject(projectId: string, options?: any): AxiosPromise<void>
      • summary

        Deletes a project.

        throws

        {RequiredError}

        Parameters

        • projectId: string

          The ID of the project.

        • Optional options: any

        Returns AxiosPromise<void>

    • getProject: function
      • getProject(projectId: string, includeSubProjects?: boolean, options?: any): AxiosPromise<ProjectDtoResponse>
      • summary

        Retrieves a project.

        throws

        {RequiredError}

        Parameters

        • projectId: string

          The ID of the project.

        • Optional includeSubProjects: boolean
        • Optional options: any

        Returns AxiosPromise<ProjectDtoResponse>

    • getProjects: function
      • getProjects(topLevel?: boolean, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<ProjectDtoIEnumerablePagedResponse>
      • summary

        Retrieves all projects.

        throws

        {RequiredError}

        Parameters

        • Optional topLevel: boolean
        • Optional pageNumber: number
        • Optional pageSize: number
        • Optional orderBy: string
        • Optional options: any

        Returns AxiosPromise<ProjectDtoIEnumerablePagedResponse>

    • updateProject: function
      • updateProject(projectId: string, projectForUpdateDto?: ProjectForUpdateDto, options?: any): AxiosPromise<void>
      • summary

        Updates a project.

        throws

        {RequiredError}

        Parameters

        • projectId: string

          The ID of the project.

        • Optional projectForUpdateDto: ProjectForUpdateDto
        • Optional options: any

        Returns AxiosPromise<void>

  • ProjectInvitationApi: { apiV2ProjectsProjectIdInvitationsOptions: any; createProjectInvitation: any; deleteProjectInvitation: any; getProjectInvitation: any; getProjectInvitations: any }
    • apiV2ProjectsProjectIdInvitationsOptions: function
      • apiV2ProjectsProjectIdInvitationsOptions(projectId: string, options?: any): AxiosPromise<void>
      • summary

        Responds with the HTTP methods allowed for the endpoint.

        throws

        {RequiredError}

        Parameters

        • projectId: string
        • Optional options: any

        Returns AxiosPromise<void>

    • createProjectInvitation: function
      • createProjectInvitation(projectId: string, projectInvitationForProjectManipulationDto?: ProjectInvitationForProjectManipulationDto, options?: any): AxiosPromise<ProjectInvitationDtoResponse>
      • summary

        Creates a project invitation for a specified project.

        throws

        {RequiredError}

        Parameters

        • projectId: string

          The Id or slug of the project.

        • Optional projectInvitationForProjectManipulationDto: ProjectInvitationForProjectManipulationDto
        • Optional options: any

        Returns AxiosPromise<ProjectInvitationDtoResponse>

    • deleteProjectInvitation: function
      • deleteProjectInvitation(projectId: string, projectInvitationId: string, options?: any): AxiosPromise<void>
      • summary

        Deletes a project invitation for a specified project.

        throws

        {RequiredError}

        Parameters

        • projectId: string

          The Id or slug of the project.

        • projectInvitationId: string

          The ID of the project invitation to delete.

        • Optional options: any

        Returns AxiosPromise<void>

    • getProjectInvitation: function
      • getProjectInvitation(projectId: string, projectInvitationId: string, options?: any): AxiosPromise<ProjectInvitationDtoResponse>
      • summary

        Retrieves a project invitation for a specified project.

        throws

        {RequiredError}

        Parameters

        • projectId: string

          The Id or slug of the project.

        • projectInvitationId: string

          The ID of the project invitation to retrieve.

        • Optional options: any

        Returns AxiosPromise<ProjectInvitationDtoResponse>

    • getProjectInvitations: function
      • getProjectInvitations(projectId: string, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<ProjectInvitationDtoIEnumerablePagedResponse>
      • summary

        Retrieves all project invitations for a specified project.

        throws

        {RequiredError}

        Parameters

        • projectId: string

          The Id or slug of the project.

        • Optional pageNumber: number
        • Optional pageSize: number
        • Optional orderBy: string
        • Optional options: any

        Returns AxiosPromise<ProjectInvitationDtoIEnumerablePagedResponse>

  • ProjectMemberApi: { addMembership: any; apiV2ProjectsProjectIdMembersOptions: any; deleteMembership: any; getMembership: any; getMemberships: any; updateMembership: any }
    • addMembership: function
      • addMembership(projectId: string, projectRoleForProjectCreationDto?: ProjectRoleForProjectCreationDto, options?: any): AxiosPromise<ProjectRoleDtoResponse>
      • summary

        Creates a project membership for a specified project.

        throws

        {RequiredError}

        Parameters

        • projectId: string

          The Id or slug of the project.

        • Optional projectRoleForProjectCreationDto: ProjectRoleForProjectCreationDto
        • Optional options: any

        Returns AxiosPromise<ProjectRoleDtoResponse>

    • apiV2ProjectsProjectIdMembersOptions: function
      • apiV2ProjectsProjectIdMembersOptions(projectId: string, options?: any): AxiosPromise<void>
      • summary

        Responds with the HTTP methods allowed for the endpoint.

        throws

        {RequiredError}

        Parameters

        • projectId: string
        • Optional options: any

        Returns AxiosPromise<void>

    • deleteMembership: function
      • deleteMembership(projectId: string, membershipId: string, options?: any): AxiosPromise<void>
      • summary

        Deletes a project membership for a specified project.

        throws

        {RequiredError}

        Parameters

        • projectId: string

          The Id or slug of the project.

        • membershipId: string

          The ID of the project membership to delete.

        • Optional options: any

        Returns AxiosPromise<void>

    • getMembership: function
      • getMembership(projectId: string, membershipId: string, options?: any): AxiosPromise<ProjectRoleDtoResponse>
      • summary

        Retrieves a project membership for a specified project.

        throws

        {RequiredError}

        Parameters

        • projectId: string

          The Id or slug of the project.

        • membershipId: string

          The ID of the project membership to retrieve.

        • Optional options: any

        Returns AxiosPromise<ProjectRoleDtoResponse>

    • getMemberships: function
      • getMemberships(projectId: string, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<ProjectRoleDtoIEnumerablePagedResponse>
      • summary

        Retrieves all project memberships for a specified project.

        throws

        {RequiredError}

        Parameters

        • projectId: string

          The Id or slug of the project.

        • Optional pageNumber: number
        • Optional pageSize: number
        • Optional orderBy: string
        • Optional options: any

        Returns AxiosPromise<ProjectRoleDtoIEnumerablePagedResponse>

    • updateMembership: function
      • updateMembership(projectId: string, membershipId: string, projectRoleForProjectManipulationDto?: ProjectRoleForProjectManipulationDto, options?: any): AxiosPromise<void>
      • summary

        Updates a project membership for a specified project.

        throws

        {RequiredError}

        Parameters

        • projectId: string

          The Id or slug of the project.

        • membershipId: string

          The ID of the project membership to update.

        • Optional projectRoleForProjectManipulationDto: ProjectRoleForProjectManipulationDto
        • Optional options: any

        Returns AxiosPromise<void>

  • ProjectQuotaApi: { apiV2ProjectsProjectIdQuotasOptions: any; getProjectQuota: any; getProjectQuotas: any; updateProjectQuota: any }
    • apiV2ProjectsProjectIdQuotasOptions: function
      • apiV2ProjectsProjectIdQuotasOptions(projectId: string, options?: any): AxiosPromise<void>
      • summary

        Responds with the HTTP methods allowed for the endpoint.

        throws

        {RequiredError}

        Parameters

        • projectId: string
        • Optional options: any

        Returns AxiosPromise<void>

    • getProjectQuota: function
      • getProjectQuota(projectId: string, resourceTypeId: string, options?: any): AxiosPromise<ProjectQuotaDtoResponse>
      • summary

        Retrieves a project quota for a specified project and resource type.

        throws

        {RequiredError}

        Parameters

        • projectId: string

          The Id or slug of the project.

        • resourceTypeId: string

          The ID of the resource type.

        • Optional options: any

        Returns AxiosPromise<ProjectQuotaDtoResponse>

    • getProjectQuotas: function
      • getProjectQuotas(projectId: string, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<ProjectQuotaDtoIEnumerablePagedResponse>
      • summary

        Retrieves all project quotas for a specified project.

        throws

        {RequiredError}

        Parameters

        • projectId: string

          The Id or slug of the project.

        • Optional pageNumber: number
        • Optional pageSize: number
        • Optional orderBy: string
        • Optional options: any

        Returns AxiosPromise<ProjectQuotaDtoIEnumerablePagedResponse>

    • updateProjectQuota: function
      • updateProjectQuota(projectId: string, resourceTypeId: string, projectQuotaForUpdateDto?: ProjectQuotaForUpdateDto, options?: any): AxiosPromise<void>
      • summary

        Updates a project quota for a specified project and resource type.

        throws

        {RequiredError}

        Parameters

        • projectId: string

          The Id or slug of the project.

        • resourceTypeId: string

          The ID of the resource type.

        • Optional projectQuotaForUpdateDto: ProjectQuotaForUpdateDto
        • Optional options: any

        Returns AxiosPromise<void>

  • ProjectResourceApi: { apiV2ProjectsProjectIdResourcesOptions: any; createResourceForProject: any; deleteResourceForProject: any; getResourceForProject: any; getResourcesForProject: any; updateResourceForProject: any }
    • apiV2ProjectsProjectIdResourcesOptions: function
      • apiV2ProjectsProjectIdResourcesOptions(projectId: string, options?: any): AxiosPromise<void>
      • summary

        Responds with the HTTP methods allowed for the endpoint.

        throws

        {RequiredError}

        Parameters

        • projectId: string
        • Optional options: any

        Returns AxiosPromise<void>

    • createResourceForProject: function
      • createResourceForProject(projectId: string, resourceForCreationDto?: ResourceForCreationDto, options?: any): AxiosPromise<ResourceDtoResponse>
      • summary

        Creates a new resource for a specified project.

        throws

        {RequiredError}

        Parameters

        • projectId: string

          The Id or slug of the project.

        • Optional resourceForCreationDto: ResourceForCreationDto
        • Optional options: any

        Returns AxiosPromise<ResourceDtoResponse>

    • deleteResourceForProject: function
      • deleteResourceForProject(projectId: string, resourceId: string, options?: any): AxiosPromise<void>
      • summary

        Deletes a resource for a specified project.

        throws

        {RequiredError}

        Parameters

        • projectId: string

          The Id or slug of the project.

        • resourceId: string

          The ID of the resource to delete.

        • Optional options: any

        Returns AxiosPromise<void>

    • getResourceForProject: function
      • getResourceForProject(projectId: string, resourceId: string, options?: any): AxiosPromise<ResourceDtoResponse>
      • summary

        Retrieves a resource for a specified project.

        throws

        {RequiredError}

        Parameters

        • projectId: string

          The Id or slug of the project.

        • resourceId: string

          The ID of the resource to retrieve.

        • Optional options: any

        Returns AxiosPromise<ResourceDtoResponse>

    • getResourcesForProject: function
      • getResourcesForProject(projectId: string, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<ResourceDtoIEnumerablePagedResponse>
      • summary

        Retrieves all resources for a specified project.

        throws

        {RequiredError}

        Parameters

        • projectId: string

          The Id or slug of the project.

        • Optional pageNumber: number
        • Optional pageSize: number
        • Optional orderBy: string
        • Optional options: any

        Returns AxiosPromise<ResourceDtoIEnumerablePagedResponse>

    • updateResourceForProject: function
      • updateResourceForProject(projectId: string, resourceId: string, resourceForUpdateDto?: ResourceForUpdateDto, options?: any): AxiosPromise<void>
      • summary

        Updates a resource for a specified project.

        throws

        {RequiredError}

        Parameters

        • projectId: string

          The Id or slug of the project.

        • resourceId: string

          The ID of the resource to update.

        • Optional resourceForUpdateDto: ResourceForUpdateDto
        • Optional options: any

        Returns AxiosPromise<void>

  • ProjectResourceQuotaApi: { apiV2ProjectsProjectIdResourcesResourceIdQuotaOptions: any; getQuotaForResourceForProject: any }
    • apiV2ProjectsProjectIdResourcesResourceIdQuotaOptions: function
      • apiV2ProjectsProjectIdResourcesResourceIdQuotaOptions(projectId: string, resourceId: string, options?: any): AxiosPromise<void>
      • summary

        Responds with the HTTP methods allowed for the endpoint.

        throws

        {RequiredError}

        Parameters

        • projectId: string
        • resourceId: string
        • Optional options: any

        Returns AxiosPromise<void>

    • getQuotaForResourceForProject: function
      • getQuotaForResourceForProject(projectId: string, resourceId: string, options?: any): AxiosPromise<ResourceQuotaDtoResponse>
      • summary

        Retrieves the resource quota for a specific resource in a project.

        throws

        {RequiredError}

        Parameters

        • projectId: string

          The Id or slug of the project.

        • resourceId: string

          The ID of the resource.

        • Optional options: any

        Returns AxiosPromise<ResourceQuotaDtoResponse>

  • ProjectResourceTypeApi: { apiV2ProjectsProjectIdResourceTypesOptions: any; getAvailableResourceTypesInformationForProject: any }
    • apiV2ProjectsProjectIdResourceTypesOptions: function
      • apiV2ProjectsProjectIdResourceTypesOptions(projectId: string, options?: any): AxiosPromise<void>
      • summary

        Responds with the HTTP methods allowed for the endpoint.

        throws

        {RequiredError}

        Parameters

        • projectId: string
        • Optional options: any

        Returns AxiosPromise<void>

    • getAvailableResourceTypesInformationForProject: function
      • getAvailableResourceTypesInformationForProject(projectId: string, options?: any): AxiosPromise<ResourceTypeInformationDtoIEnumerableResponse>
      • summary

        Retrieves the available resource types information for a specific project.

        throws

        {RequiredError}

        Parameters

        • projectId: string

          The Id or slug of the project.

        • Optional options: any

        Returns AxiosPromise<ResourceTypeInformationDtoIEnumerableResponse>

  • ResourceApi: { apiV2ResourcesOptions: any; getResource: any }
    • apiV2ResourcesOptions: function
      • apiV2ResourcesOptions(options?: any): AxiosPromise<void>
      • summary

        Responds with the HTTP methods allowed for the endpoint.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<void>

    • getResource: function
      • getResource(resourceId: string, options?: any): AxiosPromise<ResourceDtoResponse>
      • summary

        Retrieves a resource by its ID.

        throws

        {RequiredError}

        Parameters

        • resourceId: string

          The ID of the resource to retrieve.

        • Optional options: any

        Returns AxiosPromise<ResourceDtoResponse>

  • ResourceTypeApi: { apiV2ResourceTypesOptions: any; getAllGitlabBranchesForProject: any; getAllGitlabProjects: any; getAllResourceTypesInformation: any; getGitlabProject: any; getResourceTypeInformation: any }
    • apiV2ResourceTypesOptions: function
      • apiV2ResourceTypesOptions(options?: any): AxiosPromise<void>
      • summary

        Responds with the HTTP methods allowed for the endpoint.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<void>

    • getAllGitlabBranchesForProject: function
      • getAllGitlabBranchesForProject(gitlabProjectId: number, domain: string, accessToken: string, options?: any): AxiosPromise<GitlabBranchDtoIEnumerableResponse>
      • summary

        Retrieves all branches of a GitLab project, that the user is a member of, based on the provided credentials.

        throws

        {RequiredError}

        Parameters

        • gitlabProjectId: number

          The ID of the GitLab project.

        • domain: string
        • accessToken: string
        • Optional options: any

        Returns AxiosPromise<GitlabBranchDtoIEnumerableResponse>

    • getAllGitlabProjects: function
      • getAllGitlabProjects(domain: string, accessToken: string, options?: any): AxiosPromise<GitlabProjectDtoIEnumerableResponse>
      • summary

        Retrieves all GitLab projects, that the user is a member of, based on the provided credentials.

        throws

        {RequiredError}

        Parameters

        • domain: string
        • accessToken: string
        • Optional options: any

        Returns AxiosPromise<GitlabProjectDtoIEnumerableResponse>

    • getAllResourceTypesInformation: function
      • getAllResourceTypesInformation(options?: any): AxiosPromise<ResourceTypeInformationDtoIEnumerableResponse>
      • summary

        Retrieves the entire global resource types information.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<ResourceTypeInformationDtoIEnumerableResponse>

    • getGitlabProject: function
      • getGitlabProject(gitlabProjectId: number, domain: string, accessToken: string, options?: any): AxiosPromise<GitlabProjectDtoResponse>
      • summary

        Retrieves a single GitLab project, that the user is a member of, based on the provided credentials.

        throws

        {RequiredError}

        Parameters

        • gitlabProjectId: number

          The ID of the GitLab project.

        • domain: string
        • accessToken: string
        • Optional options: any

        Returns AxiosPromise<GitlabProjectDtoResponse>

    • getResourceTypeInformation: function
      • getResourceTypeInformation(resourceTypeId: string, options?: any): AxiosPromise<ResourceTypeInformationDtoResponse>
      • summary

        Retrieves the resource type information for a specific resource type.

        throws

        {RequiredError}

        Parameters

        • resourceTypeId: string

          The ID of the resource type to retrieve.

        • Optional options: any

        Returns AxiosPromise<ResourceTypeInformationDtoResponse>

  • RoleApi: { apiV2RolesOptions: any; getRole: any; getRoles: any }
    • apiV2RolesOptions: function
      • apiV2RolesOptions(options?: any): AxiosPromise<void>
      • summary

        Responds with the HTTP methods allowed for the endpoint.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<void>

    • getRole: function
      • getRole(roleId: string, options?: any): AxiosPromise<RoleDtoResponse>
      • summary

        Retrieves a role by ID.

        throws

        {RequiredError}

        Parameters

        • roleId: string

          The ID of the role.

        • Optional options: any

        Returns AxiosPromise<RoleDtoResponse>

    • getRoles: function
      • getRoles(pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<RoleDtoIEnumerablePagedResponse>
      • summary

        Retrieves all roles.

        throws

        {RequiredError}

        Parameters

        • Optional pageNumber: number
        • Optional pageSize: number
        • Optional orderBy: string
        • Optional options: any

        Returns AxiosPromise<RoleDtoIEnumerablePagedResponse>

  • SearchApi: { apiV2SearchOptions: any; getSearchResults: any }
    • apiV2SearchOptions: function
      • apiV2SearchOptions(options?: any): AxiosPromise<void>
      • summary

        Responds with the HTTP methods allowed for the endpoint.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<void>

    • getSearchResults: function
      • getSearchResults(query?: string, useAdvancedSyntax?: boolean, languages?: string[], category?: SearchCategoryType, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<SearchResultDtoIEnumerablePagedResponse>
      • summary

        Retrieves a search result by given search parameters.

        throws

        {RequiredError}

        Parameters

        • Optional query: string
        • Optional useAdvancedSyntax: boolean
        • Optional languages: string[]
        • Optional category: SearchCategoryType
        • Optional pageNumber: number
        • Optional pageSize: number
        • Optional orderBy: string
        • Optional options: any

        Returns AxiosPromise<SearchResultDtoIEnumerablePagedResponse>

  • SelfApi: { acceptCurrentTos: any; apiV2SelfOptions: any; confirmUserEmail: any; getCurrentUser: any; initiateUserMerge: any; resolveProjectInvitation: any; updateCurrentUser: any }
    • acceptCurrentTos: function
      • acceptCurrentTos(userTermsOfServiceAcceptDto?: UserTermsOfServiceAcceptDto, options?: any): AxiosPromise<void>
      • summary

        Accepts the current Terms Of Service for the current authenticated user.

        throws

        {RequiredError}

        Parameters

        • Optional userTermsOfServiceAcceptDto: UserTermsOfServiceAcceptDto
        • Optional options: any

        Returns AxiosPromise<void>

    • apiV2SelfOptions: function
      • apiV2SelfOptions(options?: any): AxiosPromise<void>
      • summary

        Responds with the HTTP methods allowed for the endpoint.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<void>

    • confirmUserEmail: function
      • confirmUserEmail(confirmationToken: string, options?: any): AxiosPromise<void>
      • summary

        Confirms the email of a user.

        throws

        {RequiredError}

        Parameters

        • confirmationToken: string
        • Optional options: any

        Returns AxiosPromise<void>

    • getCurrentUser: function
      • getCurrentUser(options?: any): AxiosPromise<UserDtoResponse>
      • summary

        Retrieves the current authenticated user.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<UserDtoResponse>

    • initiateUserMerge: function
      • initiateUserMerge(identityProvider: IdentityProviders, options?: any): AxiosPromise<UserMergeDtoResponse>
      • summary

        Initiates user merging for the current user.

        throws

        {RequiredError}

        Parameters

        • identityProvider: IdentityProviders
        • Optional options: any

        Returns AxiosPromise<UserMergeDtoResponse>

    • resolveProjectInvitation: function
      • resolveProjectInvitation(projectInvitationResolveDto?: ProjectInvitationResolveDto, options?: any): AxiosPromise<void>
      • summary

        Resolves a project invitation for the authenticated user.

        throws

        {RequiredError}

        Parameters

        • Optional projectInvitationResolveDto: ProjectInvitationResolveDto
        • Optional options: any

        Returns AxiosPromise<void>

    • updateCurrentUser: function
      • updateCurrentUser(userForUpdateDto?: UserForUpdateDto, options?: any): AxiosPromise<void>
      • summary

        Updates the current authenticated user.

        throws

        {RequiredError}

        Parameters

        • Optional userForUpdateDto: UserForUpdateDto
        • Optional options: any

        Returns AxiosPromise<void>

  • SelfApiTokenApi: { apiV2SelfApiTokensOptions: any; createApiToken: any; getAllApiTokens: any; getApiToken: any; revokeToken: any }
    • apiV2SelfApiTokensOptions: function
      • apiV2SelfApiTokensOptions(options?: any): AxiosPromise<void>
      • summary

        Responds with the HTTP methods allowed for the endpoint.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<void>

    • createApiToken: function
      • createApiToken(apiTokenForCreationDto?: ApiTokenForCreationDto, options?: any): AxiosPromise<ApiTokenDtoResponse>
      • summary

        Creates an API token for the current authenticated user.

        throws

        {RequiredError}

        Parameters

        • Optional apiTokenForCreationDto: ApiTokenForCreationDto
        • Optional options: any

        Returns AxiosPromise<ApiTokenDtoResponse>

    • getAllApiTokens: function
      • getAllApiTokens(pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<ApiTokenDtoIEnumerablePagedResponse>
      • summary

        Retrieves all API tokens for the current authenticated user.

        throws

        {RequiredError}

        Parameters

        • Optional pageNumber: number
        • Optional pageSize: number
        • Optional orderBy: string
        • Optional options: any

        Returns AxiosPromise<ApiTokenDtoIEnumerablePagedResponse>

    • getApiToken: function
      • getApiToken(apiTokenId: string, options?: any): AxiosPromise<ApiTokenDtoResponse>
      • summary

        Retrieves an API token for the current authenticated user.

        throws

        {RequiredError}

        Parameters

        • apiTokenId: string

          The ID of the token.

        • Optional options: any

        Returns AxiosPromise<ApiTokenDtoResponse>

    • revokeToken: function
      • revokeToken(apiTokenId: string, options?: any): AxiosPromise<void>
      • summary

        Revokes an API token for the current authenticated user.

        throws

        {RequiredError}

        Parameters

        • apiTokenId: string

          The ID of the token.

        • Optional options: any

        Returns AxiosPromise<void>

  • ShibbolethApi: { shibbolethCallback: any; shibbolethLogin: any }
    • shibbolethCallback: function
      • shibbolethCallback(returnUrl?: string, remoteError?: string, options?: any): AxiosPromise<any>
      • summary

        Callback method to catch the login

        throws

        {RequiredError}

        Parameters

        • Optional returnUrl: string
        • Optional remoteError: string
        • Optional options: any

        Returns AxiosPromise<any>

    • shibbolethLogin: function
      • shibbolethLogin(returnUrl?: string, entityId?: string, options?: any): AxiosPromise<any>
      • summary

        This method is the central route for logging into an identity provider. On default, the user is redirected to the WAFY of the DFN-AAI. Setting the "entityId" parameter allows the application to redirect to a specific identity provider defined by DFN-AAI.

        throws

        {RequiredError}

        Parameters

        • Optional returnUrl: string
        • Optional entityId: string
        • Optional options: any

        Returns AxiosPromise<any>

  • TitleApi: { apiV2TitlesOptions: any; getTitle: any; getTitles: any }
    • apiV2TitlesOptions: function
      • apiV2TitlesOptions(options?: any): AxiosPromise<void>
      • summary

        Responds with the HTTP methods allowed for the endpoint.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<void>

    • getTitle: function
      • getTitle(titleId: string, options?: any): AxiosPromise<TitleDtoResponse>
      • summary

        Retrieves a title by ID.

        throws

        {RequiredError}

        Parameters

        • titleId: string

          The ID of the title.

        • Optional options: any

        Returns AxiosPromise<TitleDtoResponse>

    • getTitles: function
      • getTitles(pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<TitleDtoIEnumerablePagedResponse>
      • summary

        Retrieves all titles.

        throws

        {RequiredError}

        Parameters

        • Optional pageNumber: number
        • Optional pageSize: number
        • Optional orderBy: string
        • Optional options: any

        Returns AxiosPromise<TitleDtoIEnumerablePagedResponse>

  • TosApi: { apiV2TosOptions: any; getTos: any }
    • apiV2TosOptions: function
      • apiV2TosOptions(options?: any): AxiosPromise<void>
      • summary

        Responds with the HTTP methods allowed for the endpoint.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<void>

    • getTos: function
      • getTos(options?: any): AxiosPromise<TermsOfServiceDtoResponse>
      • summary

        Retrieves the current Terms of Service version.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<TermsOfServiceDtoResponse>

  • TreeApi: { apiV2ProjectsProjectIdResourcesResourceIdTreesOptions: any; createMetadataTree: any; getFileTree: any; getMetadataTree: any; updateMetadataTree: any }
    • apiV2ProjectsProjectIdResourcesResourceIdTreesOptions: function
      • apiV2ProjectsProjectIdResourcesResourceIdTreesOptions(projectId: string, resourceId: string, options?: any): AxiosPromise<void>
      • summary

        Responds with the HTTP methods allowed for the endpoint.

        throws

        {RequiredError}

        Parameters

        • projectId: string
        • resourceId: string
        • Optional options: any

        Returns AxiosPromise<void>

    • createMetadataTree: function
      • createMetadataTree(projectId: string, resourceId: string, metadataTreeForCreationDto?: MetadataTreeForCreationDto, options?: any): AxiosPromise<MetadataTreeDtoResponse>
      • summary

        Creates a new metadata tree for a resource.

        throws

        {RequiredError}

        Parameters

        • projectId: string

          The unique identifier or slug of the project.

        • resourceId: string

          The unique identifier of the resource.

        • Optional metadataTreeForCreationDto: MetadataTreeForCreationDto
        • Optional options: any

        Returns AxiosPromise<MetadataTreeDtoResponse>

    • getFileTree: function
      • getFileTree(projectId: string, resourceId: string, path?: string, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<FileTreeDtoIEnumerablePagedResponse>
      • The OrderBy query is currently not supported.

        summary

        Retrieves the file tree associated with a resource.

        throws

        {RequiredError}

        Parameters

        • projectId: string

          The unique identifier or slug of the project.

        • resourceId: string

          The unique identifier of the resource.

        • Optional path: string
        • Optional pageNumber: number
        • Optional pageSize: number
        • Optional orderBy: string
        • Optional options: any

        Returns AxiosPromise<FileTreeDtoIEnumerablePagedResponse>

    • getMetadataTree: function
      • getMetadataTree(projectId: string, resourceId: string, path?: string, format?: RdfFormat, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<MetadataTreeDtoIEnumerablePagedResponse>
      • summary

        Retrieves the metadata tree associated with a resource.

        throws

        {RequiredError}

        Parameters

        • projectId: string

          The unique identifier or slug of the project.

        • resourceId: string

          The unique identifier of the resource.

        • Optional path: string
        • Optional format: RdfFormat
        • Optional pageNumber: number
        • Optional pageSize: number
        • Optional orderBy: string
        • Optional options: any

        Returns AxiosPromise<MetadataTreeDtoIEnumerablePagedResponse>

    • updateMetadataTree: function
      • updateMetadataTree(projectId: string, resourceId: string, metadataTreeForUpdateDto?: MetadataTreeForUpdateDto, options?: any): AxiosPromise<void>
      • summary

        Updates an existing metadata tree of a resource.

        throws

        {RequiredError}

        Parameters

        • projectId: string

          The unique identifier or slug of the project.

        • resourceId: string

          The unique identifier of the resource.

        • Optional metadataTreeForUpdateDto: MetadataTreeForUpdateDto
        • Optional options: any

        Returns AxiosPromise<void>

  • UserApi: { apiV2UsersOptions: any; getUsers: any }
    • apiV2UsersOptions: function
      • apiV2UsersOptions(options?: any): AxiosPromise<void>
      • summary

        Responds with the HTTP methods allowed for the endpoint.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<void>

    • getUsers: function
      • getUsers(searchTerm: string, orderBy?: string, options?: any): AxiosPromise<PublicUserDtoIEnumerableResponse>
      • summary

        Retrieves all users.

        throws

        {RequiredError}

        Parameters

        • searchTerm: string
        • Optional orderBy: string
        • Optional options: any

        Returns AxiosPromise<PublicUserDtoIEnumerableResponse>

  • VisibilityApi: { apiV2VisibilitiesOptions: any; getVisibilities: any; getVisibility: any }
    • apiV2VisibilitiesOptions: function
      • apiV2VisibilitiesOptions(options?: any): AxiosPromise<void>
      • summary

        Responds with the HTTP methods allowed for the endpoint.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<void>

    • getVisibilities: function
      • getVisibilities(pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<VisibilityDtoIEnumerablePagedResponse>
      • summary

        Retrieves all visibilities.

        throws

        {RequiredError}

        Parameters

        • Optional pageNumber: number
        • Optional pageSize: number
        • Optional orderBy: string
        • Optional options: any

        Returns AxiosPromise<VisibilityDtoIEnumerablePagedResponse>

    • getVisibility: function
      • getVisibility(visibilityId: string, options?: any): AxiosPromise<VisibilityDtoResponse>
      • summary

        Retrieves a visibility by ID.

        throws

        {RequiredError}

        Parameters

        • visibilityId: string

          The ID of the visibility.

        • Optional options: any

        Returns AxiosPromise<VisibilityDtoResponse>

  • VocabularyApi: { apiV2VocabulariesOptions: any; getVocabularies: any; getVocabularyInstance: any; getVocabularyInstances: any }
    • apiV2VocabulariesOptions: function
      • apiV2VocabulariesOptions(options?: any): AxiosPromise<void>
      • summary

        Responds with the HTTP methods allowed for the endpoint.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<void>

    • getVocabularies: function
      • getVocabularies(searchTerm?: string, language?: AcceptedLanguage, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<VocabularyDtoIEnumerablePagedResponse>
      • summary

        Retrieves top-level instances from vocabularies.

        throws

        {RequiredError}

        Parameters

        • Optional searchTerm: string
        • Optional language: AcceptedLanguage
        • Optional pageNumber: number
        • Optional pageSize: number
        • Optional orderBy: string
        • Optional options: any

        Returns AxiosPromise<VocabularyDtoIEnumerablePagedResponse>

    • getVocabularyInstance: function
      • getVocabularyInstance(instance: string, acceptLanguage?: AcceptedLanguage, options?: any): AxiosPromise<VocabularyInstanceDtoResponse>
      • Could be a top-level instance, or an intermediate-level instance from a vocabulary.

        summary

        Retrieves a single instance from a vocabulary.

        throws

        {RequiredError}

        Parameters

        • instance: string

          The URI of the vocabulary instance to retrieve.

        • Optional acceptLanguage: AcceptedLanguage
        • Optional options: any

        Returns AxiosPromise<VocabularyInstanceDtoResponse>

    • getVocabularyInstances: function
      • getVocabularyInstances(_class: string, searchTerm?: string, language?: AcceptedLanguage, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<VocabularyInstanceDtoIEnumerablePagedResponse>
      • summary

        Retrieves vocabulary instances.

        throws

        {RequiredError}

        Parameters

        • _class: string
        • Optional searchTerm: string
        • Optional language: AcceptedLanguage
        • Optional pageNumber: number
        • Optional pageSize: number
        • Optional orderBy: string
        • Optional options: any

        Returns AxiosPromise<VocabularyInstanceDtoIEnumerablePagedResponse>

Generated using TypeDoc