Variables
Const AccountApi
AccountApi: { accountGetLoginUrls: any ; accountLogout: any } = ...
Type declaration
accountGetLoginUrls: function
accountGetLoginUrls( options?: any ) : AxiosPromise < LoginUrls >
Defined in Coscine.Api.STS/api.ts:175
Parameters
Returns AxiosPromise < LoginUrls >
accountLogout: function
accountLogout( options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.STS/api.ts:184
Parameters
Returns AxiosPromise < any >
Const AdminApi
AdminApi: { adminGetProject: any ; adminUpdateQuota: any } = ...
Type declaration
adminGetProject: function
adminGetProject( projectString: string , options?: any ) : AxiosPromise < AdminProjectObject >
Defined in Coscine.Api.Admin/api.ts:287
Parameters
projectString: string
Optional options: any
Returns AxiosPromise < AdminProjectObject >
adminUpdateQuota: function
adminUpdateQuota( projectId: string , resourceTypeId: string , updateQuotaParameterObject: UpdateQuotaParameterObject , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Admin/api.ts:299
Parameters
projectId: string
resourceTypeId: string
updateQuotaParameterObject: UpdateQuotaParameterObject
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 >
Defined in Coscine.Api/api.ts:4514
Parameters
Returns AxiosPromise < void >
createApplicationProfileRequest: function
createApplicationProfileRequest( applicationProfileForCreationDto?: ApplicationProfileForCreationDto , options?: any ) : AxiosPromise < ApplicationProfileForCreationDtoResponse >
Defined in Coscine.Api/api.ts:4524
Parameters
Optional applicationProfileForCreationDto: ApplicationProfileForCreationDto
Optional options: any
Returns AxiosPromise < ApplicationProfileForCreationDtoResponse >
getApplicationProfile: function
getApplicationProfile( profile: string , format?: RdfFormat , acceptLanguage?: AcceptedLanguage , options?: any ) : AxiosPromise < ApplicationProfileDtoResponse >
Defined in Coscine.Api/api.ts:4536
Parameters
profile: string
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 >
Defined in Coscine.Api/api.ts:4550
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 >
Defined in Coscine.Api/api.ts:4560
Parameters
profile: string
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 >
Defined in Coscine.Api/api.ts:4979
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 >
Defined in Coscine.Api/api.ts:4992
Parameters
projectId: string
resourceId: string
key: string
Optional file: any
Optional options: any
Returns AxiosPromise < void >
deleteBlob: function
deleteBlob( projectId: string , resourceId: string , key: string , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:5004
Parameters
projectId: string
resourceId: string
key: string
Optional options: any
Returns AxiosPromise < void >
getBlob: function
getBlob( projectId: string , resourceId: string , key: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api/api.ts:5016
Parameters
projectId: string
resourceId: string
key: string
Optional options: any
Returns AxiosPromise < any >
updateBlob: function
updateBlob( projectId: string , resourceId: string , key: string , file?: any , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:5029
Parameters
projectId: string
resourceId: string
key: string
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 >
Defined in Coscine.Api/api.ts:5299
Parameters
Returns AxiosPromise < void >
getDiscipline: function
getDiscipline( disciplineId: string , options?: any ) : AxiosPromise < DisciplineDtoResponse >
Defined in Coscine.Api/api.ts:5309
Parameters
disciplineId: string
Optional options: any
Returns AxiosPromise < DisciplineDtoResponse >
getDisciplines: function
getDisciplines( pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < DisciplineDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:5321
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 >
Defined in Coscine.Api.STS/api.ts:296
Parameters
Returns AxiosPromise < any >
Const LanguageApi
LanguageApi: { apiV2LanguagesOptions: any ; getLanguage: any ; getLanguages: any } = ...
Type declaration
apiV2LanguagesOptions: function
apiV2LanguagesOptions( options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:5557
Parameters
Returns AxiosPromise < void >
getLanguage: function
getLanguage( languageId: string , options?: any ) : AxiosPromise < LanguageDtoResponse >
Defined in Coscine.Api/api.ts:5567
Parameters
languageId: string
Optional options: any
Returns AxiosPromise < LanguageDtoResponse >
getLanguages: function
getLanguages( pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < LanguageDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:5579
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 >
Defined in Coscine.Api/api.ts:5815
Parameters
Returns AxiosPromise < void >
getLicense: function
getLicense( licenseId: string , options?: any ) : AxiosPromise < LicenseDtoResponse >
Defined in Coscine.Api/api.ts:5825
Parameters
licenseId: string
Optional options: any
Returns AxiosPromise < LicenseDtoResponse >
getLicenses: function
getLicenses( pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < LicenseDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:5837
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 >
Defined in Coscine.Api/api.ts:6007
Parameters
Returns AxiosPromise < void >
getCurrentMaintenances: function
getCurrentMaintenances( options?: any ) : AxiosPromise < MaintenanceDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:6016
Parameters
Returns AxiosPromise < MaintenanceDtoIEnumerablePagedResponse >
Const MergeApi
MergeApi: { mergeCallback: any ; mergeLogin: any } = ...
Type declaration
mergeCallback: function
mergeCallback( returnUrl?: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.STS/api.ts:448
Parameters
Optional returnUrl: string
Optional options: any
Returns AxiosPromise < any >
mergeLogin: function
mergeLogin( returnUrl?: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.STS/api.ts:457
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 >
Defined in Coscine.Api.STS/api.ts:631
Parameters
Optional returnUrl: string
Optional options: any
Returns AxiosPromise < any >
oRCiDLoginPOST: function
oRCiDLoginPOST( oRCiDJWT?: string , returnUrl?: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.STS/api.ts:642
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 >
Defined in Coscine.Api/api.ts:6243
Parameters
Returns AxiosPromise < void >
getOrganization: function
getOrganization( organizationRorUri: string , options?: any ) : AxiosPromise < OrganizationDtoResponse >
Defined in Coscine.Api/api.ts:6253
Parameters
organizationRorUri: string
Optional options: any
Returns AxiosPromise < OrganizationDtoResponse >
getOrganizations: function
getOrganizations( searchTerm?: string , pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < OrganizationDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:6266
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 >
Defined in Coscine.Api/api.ts:6505
Parameters
Returns AxiosPromise < void >
sendRequestToOwner: function
sendRequestToOwner( prefix: string , id: string , pidRequestDto?: PidRequestDto , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:6517
Parameters
prefix: string
id: string
Optional pidRequestDto: PidRequestDto
Optional options: any
Returns AxiosPromise < void >
validatePid: function
validatePid( prefix: string , id: string , options?: any ) : AxiosPromise < PidValidationDtoResponse >
Defined in Coscine.Api/api.ts:6528
Parameters
prefix: string
id: string
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 >
Defined in Coscine.Api/api.ts:6926
Parameters
Returns AxiosPromise < void >
createProject: function
createProject( projectForCreationDto?: ProjectForCreationDto , options?: any ) : AxiosPromise < ProjectDtoResponse >
Defined in Coscine.Api/api.ts:6936
Parameters
Optional projectForCreationDto: ProjectForCreationDto
Optional options: any
Returns AxiosPromise < ProjectDtoResponse >
deleteProject: function
deleteProject( projectId: string , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:6946
Parameters
projectId: string
Optional options: any
Returns AxiosPromise < void >
getProject: function
getProject( projectId: string , includeSubProjects?: boolean , options?: any ) : AxiosPromise < ProjectDtoResponse >
Defined in Coscine.Api/api.ts:6957
Parameters
projectId: string
Optional includeSubProjects: boolean
Optional options: any
Returns AxiosPromise < ProjectDtoResponse >
getProjects: function
getProjects( topLevel?: boolean , pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < ProjectDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:6970
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 >
Defined in Coscine.Api/api.ts:6981
Parameters
projectId: string
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 >
Defined in Coscine.Api/api.ts:7378
Parameters
projectId: string
Optional options: any
Returns AxiosPromise < void >
createProjectInvitation: function
createProjectInvitation( projectId: string , projectInvitationForProjectManipulationDto?: ProjectInvitationForProjectManipulationDto , options?: any ) : AxiosPromise < ProjectInvitationDtoResponse >
Defined in Coscine.Api/api.ts:7389
Parameters
projectId: string
Optional projectInvitationForProjectManipulationDto: ProjectInvitationForProjectManipulationDto
Optional options: any
Returns AxiosPromise < ProjectInvitationDtoResponse >
deleteProjectInvitation: function
deleteProjectInvitation( projectId: string , projectInvitationId: string , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:7400
Parameters
projectId: string
projectInvitationId: string
Optional options: any
Returns AxiosPromise < void >
getProjectInvitation: function
getProjectInvitation( projectId: string , projectInvitationId: string , options?: any ) : AxiosPromise < ProjectInvitationDtoResponse >
Defined in Coscine.Api/api.ts:7411
Parameters
projectId: string
projectInvitationId: string
Optional options: any
Returns AxiosPromise < ProjectInvitationDtoResponse >
getProjectInvitations: function
getProjectInvitations( projectId: string , pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < ProjectInvitationDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:7424
Parameters
projectId: string
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 >
Defined in Coscine.Api/api.ts:7870
Parameters
projectId: string
Optional projectRoleForProjectCreationDto: ProjectRoleForProjectCreationDto
Optional options: any
Returns AxiosPromise < ProjectRoleDtoResponse >
apiV2ProjectsProjectIdMembersOptions: function
apiV2ProjectsProjectIdMembersOptions( projectId: string , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:7880
Parameters
projectId: string
Optional options: any
Returns AxiosPromise < void >
deleteMembership: function
deleteMembership( projectId: string , membershipId: string , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:7891
Parameters
projectId: string
membershipId: string
Optional options: any
Returns AxiosPromise < void >
getMembership: function
getMembership( projectId: string , membershipId: string , options?: any ) : AxiosPromise < ProjectRoleDtoResponse >
Defined in Coscine.Api/api.ts:7902
Parameters
projectId: string
membershipId: string
Optional options: any
Returns AxiosPromise < ProjectRoleDtoResponse >
getMemberships: function
getMemberships( projectId: string , pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < ProjectRoleDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:7915
Parameters
projectId: string
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 >
Defined in Coscine.Api/api.ts:7927
Parameters
projectId: string
membershipId: string
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 >
Defined in Coscine.Api/api.ts:8280
Parameters
projectId: string
Optional options: any
Returns AxiosPromise < void >
getProjectQuota: function
getProjectQuota( projectId: string , resourceTypeId: string , options?: any ) : AxiosPromise < ProjectQuotaDtoResponse >
Defined in Coscine.Api/api.ts:8291
Parameters
projectId: string
resourceTypeId: string
Optional options: any
Returns AxiosPromise < ProjectQuotaDtoResponse >
getProjectQuotas: function
getProjectQuotas( projectId: string , pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < ProjectQuotaDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:8304
Parameters
projectId: string
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 >
Defined in Coscine.Api/api.ts:8316
Parameters
projectId: string
resourceTypeId: string
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 >
Defined in Coscine.Api/api.ts:8749
Parameters
projectId: string
Optional options: any
Returns AxiosPromise < void >
createResourceForProject: function
createResourceForProject( projectId: string , resourceForCreationDto?: ResourceForCreationDto , options?: any ) : AxiosPromise < ResourceDtoResponse >
Defined in Coscine.Api/api.ts:8760
Parameters
projectId: string
Optional resourceForCreationDto: ResourceForCreationDto
Optional options: any
Returns AxiosPromise < ResourceDtoResponse >
deleteResourceForProject: function
deleteResourceForProject( projectId: string , resourceId: string , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:8771
Parameters
projectId: string
resourceId: string
Optional options: any
Returns AxiosPromise < void >
getResourceForProject: function
getResourceForProject( projectId: string , resourceId: string , options?: any ) : AxiosPromise < ResourceDtoResponse >
Defined in Coscine.Api/api.ts:8782
Parameters
projectId: string
resourceId: string
Optional options: any
Returns AxiosPromise < ResourceDtoResponse >
getResourcesForProject: function
getResourcesForProject( projectId: string , pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < ResourceDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:8795
Parameters
projectId: string
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 >
Defined in Coscine.Api/api.ts:8807
Parameters
projectId: string
resourceId: string
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 >
Defined in Coscine.Api/api.ts:9042
Parameters
projectId: string
resourceId: string
Optional options: any
Returns AxiosPromise < void >
getQuotaForResourceForProject: function
getQuotaForResourceForProject( projectId: string , resourceId: string , options?: any ) : AxiosPromise < ResourceQuotaDtoResponse >
Defined in Coscine.Api/api.ts:9053
Parameters
projectId: string
resourceId: string
Optional options: any
Returns AxiosPromise < ResourceQuotaDtoResponse >
Const ProjectResourceTypeApi
ProjectResourceTypeApi: { apiV2ProjectsProjectIdResourceTypesOptions: any ; getAvailableResourceTypesInformationForProject: any } = ...
Type declaration
apiV2ProjectsProjectIdResourceTypesOptions: function
apiV2ProjectsProjectIdResourceTypesOptions( projectId: string , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:9223
Parameters
projectId: string
Optional options: any
Returns AxiosPromise < void >
getAvailableResourceTypesInformationForProject: function
getAvailableResourceTypesInformationForProject( projectId: string , options?: any ) : AxiosPromise < ResourceTypeInformationDtoIEnumerableResponse >
Defined in Coscine.Api/api.ts:9233
Parameters
projectId: string
Optional options: any
Returns AxiosPromise < ResourceTypeInformationDtoIEnumerableResponse >
Const ResourceApi
ResourceApi: { apiV2ResourcesOptions: any ; getResource: any } = ...
Type declaration
apiV2ResourcesOptions: function
apiV2ResourcesOptions( options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:9395
Parameters
Returns AxiosPromise < void >
getResource: function
getResource( resourceId: string , options?: any ) : AxiosPromise < ResourceDtoResponse >
Defined in Coscine.Api/api.ts:9405
Parameters
resourceId: string
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 >
Defined in Coscine.Api/api.ts:9796
Parameters
Returns AxiosPromise < void >
getAllGitlabBranchesForProject: function
getAllGitlabBranchesForProject( gitlabProjectId: number , domain: string , accessToken: string , options?: any ) : AxiosPromise < GitlabBranchDtoIEnumerableResponse >
Defined in Coscine.Api/api.ts:9808
Parameters
gitlabProjectId: number
domain: string
accessToken: string
Optional options: any
Returns AxiosPromise < GitlabBranchDtoIEnumerableResponse >
getAllGitlabProjects: function
getAllGitlabProjects( domain: string , accessToken: string , options?: any ) : AxiosPromise < GitlabProjectDtoIEnumerableResponse >
Defined in Coscine.Api/api.ts:9819
Parameters
domain: string
accessToken: string
Optional options: any
Returns AxiosPromise < GitlabProjectDtoIEnumerableResponse >
getAllResourceTypesInformation: function
getAllResourceTypesInformation( options?: any ) : AxiosPromise < ResourceTypeInformationDtoIEnumerableResponse >
Defined in Coscine.Api/api.ts:9828
Parameters
Returns AxiosPromise < ResourceTypeInformationDtoIEnumerableResponse >
getGitlabProject: function
getGitlabProject( gitlabProjectId: number , domain: string , accessToken: string , options?: any ) : AxiosPromise < GitlabProjectDtoResponse >
Defined in Coscine.Api/api.ts:9840
Parameters
gitlabProjectId: number
domain: string
accessToken: string
Optional options: any
Returns AxiosPromise < GitlabProjectDtoResponse >
getResourceTypeInformation: function
getResourceTypeInformation( resourceTypeId: string , options?: any ) : AxiosPromise < ResourceTypeInformationDtoResponse >
Defined in Coscine.Api/api.ts:9850
Parameters
resourceTypeId: string
Optional options: any
Returns AxiosPromise < ResourceTypeInformationDtoResponse >
Const RoleApi
RoleApi: { apiV2RolesOptions: any ; getRole: any ; getRoles: any } = ...
Type declaration
apiV2RolesOptions: function
apiV2RolesOptions( options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:10124
Parameters
Returns AxiosPromise < void >
getRole: function
getRole( roleId: string , options?: any ) : AxiosPromise < RoleDtoResponse >
Defined in Coscine.Api/api.ts:10134
Parameters
roleId: string
Optional options: any
Returns AxiosPromise < RoleDtoResponse >
getRoles: function
getRoles( pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < RoleDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:10146
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 >
Defined in Coscine.Api/api.ts:10358
Parameters
Returns AxiosPromise < void >
getSearchResults: function
getSearchResults( query?: string , useAdvancedSyntax?: boolean , languages?: string [] , category?: SearchCategoryType , pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < SearchResultDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:10374
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 >
Defined in Coscine.Api/api.ts:10783
Parameters
Optional userTermsOfServiceAcceptDto: UserTermsOfServiceAcceptDto
Optional options: any
Returns AxiosPromise < void >
apiV2SelfOptions: function
apiV2SelfOptions( options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:10792
Parameters
Returns AxiosPromise < void >
confirmUserEmail: function
confirmUserEmail( confirmationToken: string , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:10802
Parameters
confirmationToken: string
Optional options: any
Returns AxiosPromise < void >
getCurrentUser: function
getCurrentUser( options?: any ) : AxiosPromise < UserDtoResponse >
Defined in Coscine.Api/api.ts:10811
Parameters
Returns AxiosPromise < UserDtoResponse >
initiateUserMerge: function
initiateUserMerge( identityProvider: IdentityProviders , options?: any ) : AxiosPromise < UserMergeDtoResponse >
Defined in Coscine.Api/api.ts:10821
Parameters
identityProvider: IdentityProviders
Optional options: any
Returns AxiosPromise < UserMergeDtoResponse >
resolveProjectInvitation: function
resolveProjectInvitation( projectInvitationResolveDto?: ProjectInvitationResolveDto , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:10831
Parameters
Optional projectInvitationResolveDto: ProjectInvitationResolveDto
Optional options: any
Returns AxiosPromise < void >
updateCurrentUser: function
updateCurrentUser( userForUpdateDto?: UserForUpdateDto , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:10841
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 >
Defined in Coscine.Api/api.ts:11218
Parameters
Returns AxiosPromise < void >
createApiToken: function
createApiToken( apiTokenForCreationDto?: ApiTokenForCreationDto , options?: any ) : AxiosPromise < ApiTokenDtoResponse >
Defined in Coscine.Api/api.ts:11228
Parameters
Optional apiTokenForCreationDto: ApiTokenForCreationDto
Optional options: any
Returns AxiosPromise < ApiTokenDtoResponse >
getAllApiTokens: function
getAllApiTokens( pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < ApiTokenDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:11240
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 >
Defined in Coscine.Api/api.ts:11250
Parameters
apiTokenId: string
Optional options: any
Returns AxiosPromise < ApiTokenDtoResponse >
revokeToken: function
revokeToken( apiTokenId: string , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:11260
Parameters
apiTokenId: string
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 >
Defined in Coscine.Api.STS/api.ts:826
Parameters
Optional returnUrl: string
Optional remoteError: string
Optional options: any
Returns AxiosPromise < any >
shibbolethLogin: function
shibbolethLogin( returnUrl?: string , entityId?: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.STS/api.ts:837
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 >
Defined in Coscine.Api/api.ts:11520
Parameters
Returns AxiosPromise < void >
getTitle: function
getTitle( titleId: string , options?: any ) : AxiosPromise < TitleDtoResponse >
Defined in Coscine.Api/api.ts:11530
Parameters
titleId: string
Optional options: any
Returns AxiosPromise < TitleDtoResponse >
getTitles: function
getTitles( pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < TitleDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:11542
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 >
Defined in Coscine.Api/api.ts:11712
Parameters
Returns AxiosPromise < void >
getTos: function
getTos( options?: any ) : AxiosPromise < TermsOfServiceDtoResponse >
Defined in Coscine.Api/api.ts:11721
Parameters
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 >
Defined in Coscine.Api/api.ts:12121
Parameters
projectId: string
resourceId: string
Optional options: any
Returns AxiosPromise < void >
createMetadataTree: function
createMetadataTree( projectId: string , resourceId: string , metadataTreeForCreationDto?: MetadataTreeForCreationDto , options?: any ) : AxiosPromise < MetadataTreeDtoResponse >
Defined in Coscine.Api/api.ts:12133
Parameters
projectId: string
resourceId: string
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 >
Defined in Coscine.Api/api.ts:12148
Parameters
projectId: string
resourceId: string
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 >
Defined in Coscine.Api/api.ts:12164
Parameters
projectId: string
resourceId: string
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 >
Defined in Coscine.Api/api.ts:12176
Parameters
projectId: string
resourceId: string
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 >
Defined in Coscine.Api/api.ts:12399
Parameters
Returns AxiosPromise < void >
getUsers: function
getUsers( searchTerm: string , orderBy?: string , options?: any ) : AxiosPromise < PublicUserDtoIEnumerableResponse >
Defined in Coscine.Api/api.ts:12410
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 >
Defined in Coscine.Api/api.ts:12633
Parameters
Returns AxiosPromise < void >
getVisibilities: function
getVisibilities( pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < VisibilityDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:12645
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 >
Defined in Coscine.Api/api.ts:12655
Parameters
visibilityId: string
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 >
Defined in Coscine.Api/api.ts:12990
Parameters
Returns AxiosPromise < void >
getVocabularies: function
getVocabularies( searchTerm?: string , language?: AcceptedLanguage , pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < VocabularyDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:13004
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 >
Defined in Coscine.Api/api.ts:13015
Parameters
instance: string
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 >
Defined in Coscine.Api/api.ts:13030
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 >
Defined in Coscine.Api.STS/api.ts:175
Parameters
Returns AxiosPromise < LoginUrls >
accountLogout: function
accountLogout( options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.STS/api.ts:184
Parameters
Returns AxiosPromise < any >
AdminApi: { adminGetProject: any ; adminUpdateQuota: any }
adminGetProject: function
adminGetProject( projectString: string , options?: any ) : AxiosPromise < AdminProjectObject >
Defined in Coscine.Api.Admin/api.ts:287
Parameters
projectString: string
Optional options: any
Returns AxiosPromise < AdminProjectObject >
adminUpdateQuota: function
adminUpdateQuota( projectId: string , resourceTypeId: string , updateQuotaParameterObject: UpdateQuotaParameterObject , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Admin/api.ts:299
Parameters
projectId: string
resourceTypeId: string
updateQuotaParameterObject: UpdateQuotaParameterObject
Optional options: any
Returns AxiosPromise < any >
ApplicationProfileApi: { apiV2ApplicationProfilesOptions: any ; createApplicationProfileRequest: any ; getApplicationProfile: any ; getApplicationProfiles: any ; getRawApplicationProfile: any }
apiV2ApplicationProfilesOptions: function
apiV2ApplicationProfilesOptions( options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:4514
Parameters
Returns AxiosPromise < void >
createApplicationProfileRequest: function
createApplicationProfileRequest( applicationProfileForCreationDto?: ApplicationProfileForCreationDto , options?: any ) : AxiosPromise < ApplicationProfileForCreationDtoResponse >
Defined in Coscine.Api/api.ts:4524
Parameters
Optional applicationProfileForCreationDto: ApplicationProfileForCreationDto
Optional options: any
Returns AxiosPromise < ApplicationProfileForCreationDtoResponse >
getApplicationProfile: function
getApplicationProfile( profile: string , format?: RdfFormat , acceptLanguage?: AcceptedLanguage , options?: any ) : AxiosPromise < ApplicationProfileDtoResponse >
Defined in Coscine.Api/api.ts:4536
Parameters
profile: string
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 >
Defined in Coscine.Api/api.ts:4550
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 >
Defined in Coscine.Api/api.ts:4560
Parameters
profile: string
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 >
Defined in Coscine.Api/api.ts:4979
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 >
Defined in Coscine.Api/api.ts:4992
Parameters
projectId: string
resourceId: string
key: string
Optional file: any
Optional options: any
Returns AxiosPromise < void >
deleteBlob: function
deleteBlob( projectId: string , resourceId: string , key: string , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:5004
Parameters
projectId: string
resourceId: string
key: string
Optional options: any
Returns AxiosPromise < void >
getBlob: function
getBlob( projectId: string , resourceId: string , key: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api/api.ts:5016
Parameters
projectId: string
resourceId: string
key: string
Optional options: any
Returns AxiosPromise < any >
updateBlob: function
updateBlob( projectId: string , resourceId: string , key: string , file?: any , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:5029
Parameters
projectId: string
resourceId: string
key: string
Optional file: any
Optional options: any
Returns AxiosPromise < void >
DisciplineApi: { apiV2DisciplinesOptions: any ; getDiscipline: any ; getDisciplines: any }
apiV2DisciplinesOptions: function
apiV2DisciplinesOptions( options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:5299
Parameters
Returns AxiosPromise < void >
getDiscipline: function
getDiscipline( disciplineId: string , options?: any ) : AxiosPromise < DisciplineDtoResponse >
Defined in Coscine.Api/api.ts:5309
Parameters
disciplineId: string
Optional options: any
Returns AxiosPromise < DisciplineDtoResponse >
getDisciplines: function
getDisciplines( pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < DisciplineDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:5321
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 >
Defined in Coscine.Api.STS/api.ts:296
Parameters
Returns AxiosPromise < any >
LanguageApi: { apiV2LanguagesOptions: any ; getLanguage: any ; getLanguages: any }
apiV2LanguagesOptions: function
apiV2LanguagesOptions( options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:5557
Parameters
Returns AxiosPromise < void >
getLanguage: function
getLanguage( languageId: string , options?: any ) : AxiosPromise < LanguageDtoResponse >
Defined in Coscine.Api/api.ts:5567
Parameters
languageId: string
Optional options: any
Returns AxiosPromise < LanguageDtoResponse >
getLanguages: function
getLanguages( pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < LanguageDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:5579
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 >
Defined in Coscine.Api/api.ts:5815
Parameters
Returns AxiosPromise < void >
getLicense: function
getLicense( licenseId: string , options?: any ) : AxiosPromise < LicenseDtoResponse >
Defined in Coscine.Api/api.ts:5825
Parameters
licenseId: string
Optional options: any
Returns AxiosPromise < LicenseDtoResponse >
getLicenses: function
getLicenses( pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < LicenseDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:5837
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 >
Defined in Coscine.Api/api.ts:6007
Parameters
Returns AxiosPromise < void >
getCurrentMaintenances: function
getCurrentMaintenances( options?: any ) : AxiosPromise < MaintenanceDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:6016
Parameters
Returns AxiosPromise < MaintenanceDtoIEnumerablePagedResponse >
MergeApi: { mergeCallback: any ; mergeLogin: any }
mergeCallback: function
mergeCallback( returnUrl?: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.STS/api.ts:448
Parameters
Optional returnUrl: string
Optional options: any
Returns AxiosPromise < any >
mergeLogin: function
mergeLogin( returnUrl?: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.STS/api.ts:457
Parameters
Optional returnUrl: string
Optional options: any
Returns AxiosPromise < any >
ORCiDApi: { oRCiDLoginGET: any ; oRCiDLoginPOST: any }
oRCiDLoginGET: function
oRCiDLoginGET( returnUrl?: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.STS/api.ts:631
Parameters
Optional returnUrl: string
Optional options: any
Returns AxiosPromise < any >
oRCiDLoginPOST: function
oRCiDLoginPOST( oRCiDJWT?: string , returnUrl?: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.STS/api.ts:642
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 >
Defined in Coscine.Api/api.ts:6243
Parameters
Returns AxiosPromise < void >
getOrganization: function
getOrganization( organizationRorUri: string , options?: any ) : AxiosPromise < OrganizationDtoResponse >
Defined in Coscine.Api/api.ts:6253
Parameters
organizationRorUri: string
Optional options: any
Returns AxiosPromise < OrganizationDtoResponse >
getOrganizations: function
getOrganizations( searchTerm?: string , pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < OrganizationDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:6266
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 >
Defined in Coscine.Api/api.ts:6505
Parameters
Returns AxiosPromise < void >
sendRequestToOwner: function
sendRequestToOwner( prefix: string , id: string , pidRequestDto?: PidRequestDto , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:6517
Parameters
prefix: string
id: string
Optional pidRequestDto: PidRequestDto
Optional options: any
Returns AxiosPromise < void >
validatePid: function
validatePid( prefix: string , id: string , options?: any ) : AxiosPromise < PidValidationDtoResponse >
Defined in Coscine.Api/api.ts:6528
Parameters
prefix: string
id: string
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 >
Defined in Coscine.Api/api.ts:6926
Parameters
Returns AxiosPromise < void >
createProject: function
createProject( projectForCreationDto?: ProjectForCreationDto , options?: any ) : AxiosPromise < ProjectDtoResponse >
Defined in Coscine.Api/api.ts:6936
Parameters
Optional projectForCreationDto: ProjectForCreationDto
Optional options: any
Returns AxiosPromise < ProjectDtoResponse >
deleteProject: function
deleteProject( projectId: string , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:6946
Parameters
projectId: string
Optional options: any
Returns AxiosPromise < void >
getProject: function
getProject( projectId: string , includeSubProjects?: boolean , options?: any ) : AxiosPromise < ProjectDtoResponse >
Defined in Coscine.Api/api.ts:6957
Parameters
projectId: string
Optional includeSubProjects: boolean
Optional options: any
Returns AxiosPromise < ProjectDtoResponse >
getProjects: function
getProjects( topLevel?: boolean , pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < ProjectDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:6970
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 >
Defined in Coscine.Api/api.ts:6981
Parameters
projectId: string
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 >
Defined in Coscine.Api/api.ts:7378
Parameters
projectId: string
Optional options: any
Returns AxiosPromise < void >
createProjectInvitation: function
createProjectInvitation( projectId: string , projectInvitationForProjectManipulationDto?: ProjectInvitationForProjectManipulationDto , options?: any ) : AxiosPromise < ProjectInvitationDtoResponse >
Defined in Coscine.Api/api.ts:7389
Parameters
projectId: string
Optional projectInvitationForProjectManipulationDto: ProjectInvitationForProjectManipulationDto
Optional options: any
Returns AxiosPromise < ProjectInvitationDtoResponse >
deleteProjectInvitation: function
deleteProjectInvitation( projectId: string , projectInvitationId: string , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:7400
Parameters
projectId: string
projectInvitationId: string
Optional options: any
Returns AxiosPromise < void >
getProjectInvitation: function
getProjectInvitation( projectId: string , projectInvitationId: string , options?: any ) : AxiosPromise < ProjectInvitationDtoResponse >
Defined in Coscine.Api/api.ts:7411
Parameters
projectId: string
projectInvitationId: string
Optional options: any
Returns AxiosPromise < ProjectInvitationDtoResponse >
getProjectInvitations: function
getProjectInvitations( projectId: string , pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < ProjectInvitationDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:7424
Parameters
projectId: string
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 >
Defined in Coscine.Api/api.ts:7870
Parameters
projectId: string
Optional projectRoleForProjectCreationDto: ProjectRoleForProjectCreationDto
Optional options: any
Returns AxiosPromise < ProjectRoleDtoResponse >
apiV2ProjectsProjectIdMembersOptions: function
apiV2ProjectsProjectIdMembersOptions( projectId: string , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:7880
Parameters
projectId: string
Optional options: any
Returns AxiosPromise < void >
deleteMembership: function
deleteMembership( projectId: string , membershipId: string , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:7891
Parameters
projectId: string
membershipId: string
Optional options: any
Returns AxiosPromise < void >
getMembership: function
getMembership( projectId: string , membershipId: string , options?: any ) : AxiosPromise < ProjectRoleDtoResponse >
Defined in Coscine.Api/api.ts:7902
Parameters
projectId: string
membershipId: string
Optional options: any
Returns AxiosPromise < ProjectRoleDtoResponse >
getMemberships: function
getMemberships( projectId: string , pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < ProjectRoleDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:7915
Parameters
projectId: string
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 >
Defined in Coscine.Api/api.ts:7927
Parameters
projectId: string
membershipId: string
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 >
Defined in Coscine.Api/api.ts:8280
Parameters
projectId: string
Optional options: any
Returns AxiosPromise < void >
getProjectQuota: function
getProjectQuota( projectId: string , resourceTypeId: string , options?: any ) : AxiosPromise < ProjectQuotaDtoResponse >
Defined in Coscine.Api/api.ts:8291
Parameters
projectId: string
resourceTypeId: string
Optional options: any
Returns AxiosPromise < ProjectQuotaDtoResponse >
getProjectQuotas: function
getProjectQuotas( projectId: string , pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < ProjectQuotaDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:8304
Parameters
projectId: string
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 >
Defined in Coscine.Api/api.ts:8316
Parameters
projectId: string
resourceTypeId: string
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 >
Defined in Coscine.Api/api.ts:8749
Parameters
projectId: string
Optional options: any
Returns AxiosPromise < void >
createResourceForProject: function
createResourceForProject( projectId: string , resourceForCreationDto?: ResourceForCreationDto , options?: any ) : AxiosPromise < ResourceDtoResponse >
Defined in Coscine.Api/api.ts:8760
Parameters
projectId: string
Optional resourceForCreationDto: ResourceForCreationDto
Optional options: any
Returns AxiosPromise < ResourceDtoResponse >
deleteResourceForProject: function
deleteResourceForProject( projectId: string , resourceId: string , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:8771
Parameters
projectId: string
resourceId: string
Optional options: any
Returns AxiosPromise < void >
getResourceForProject: function
getResourceForProject( projectId: string , resourceId: string , options?: any ) : AxiosPromise < ResourceDtoResponse >
Defined in Coscine.Api/api.ts:8782
Parameters
projectId: string
resourceId: string
Optional options: any
Returns AxiosPromise < ResourceDtoResponse >
getResourcesForProject: function
getResourcesForProject( projectId: string , pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < ResourceDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:8795
Parameters
projectId: string
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 >
Defined in Coscine.Api/api.ts:8807
Parameters
projectId: string
resourceId: string
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 >
Defined in Coscine.Api/api.ts:9042
Parameters
projectId: string
resourceId: string
Optional options: any
Returns AxiosPromise < void >
getQuotaForResourceForProject: function
getQuotaForResourceForProject( projectId: string , resourceId: string , options?: any ) : AxiosPromise < ResourceQuotaDtoResponse >
Defined in Coscine.Api/api.ts:9053
Parameters
projectId: string
resourceId: string
Optional options: any
Returns AxiosPromise < ResourceQuotaDtoResponse >
ProjectResourceTypeApi: { apiV2ProjectsProjectIdResourceTypesOptions: any ; getAvailableResourceTypesInformationForProject: any }
apiV2ProjectsProjectIdResourceTypesOptions: function
apiV2ProjectsProjectIdResourceTypesOptions( projectId: string , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:9223
Parameters
projectId: string
Optional options: any
Returns AxiosPromise < void >
getAvailableResourceTypesInformationForProject: function
getAvailableResourceTypesInformationForProject( projectId: string , options?: any ) : AxiosPromise < ResourceTypeInformationDtoIEnumerableResponse >
Defined in Coscine.Api/api.ts:9233
Parameters
projectId: string
Optional options: any
Returns AxiosPromise < ResourceTypeInformationDtoIEnumerableResponse >
ResourceApi: { apiV2ResourcesOptions: any ; getResource: any }
apiV2ResourcesOptions: function
apiV2ResourcesOptions( options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:9395
Parameters
Returns AxiosPromise < void >
getResource: function
getResource( resourceId: string , options?: any ) : AxiosPromise < ResourceDtoResponse >
Defined in Coscine.Api/api.ts:9405
Parameters
resourceId: string
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 >
Defined in Coscine.Api/api.ts:9796
Parameters
Returns AxiosPromise < void >
getAllGitlabBranchesForProject: function
getAllGitlabBranchesForProject( gitlabProjectId: number , domain: string , accessToken: string , options?: any ) : AxiosPromise < GitlabBranchDtoIEnumerableResponse >
Defined in Coscine.Api/api.ts:9808
Parameters
gitlabProjectId: number
domain: string
accessToken: string
Optional options: any
Returns AxiosPromise < GitlabBranchDtoIEnumerableResponse >
getAllGitlabProjects: function
getAllGitlabProjects( domain: string , accessToken: string , options?: any ) : AxiosPromise < GitlabProjectDtoIEnumerableResponse >
Defined in Coscine.Api/api.ts:9819
Parameters
domain: string
accessToken: string
Optional options: any
Returns AxiosPromise < GitlabProjectDtoIEnumerableResponse >
getAllResourceTypesInformation: function
getAllResourceTypesInformation( options?: any ) : AxiosPromise < ResourceTypeInformationDtoIEnumerableResponse >
Defined in Coscine.Api/api.ts:9828
Parameters
Returns AxiosPromise < ResourceTypeInformationDtoIEnumerableResponse >
getGitlabProject: function
getGitlabProject( gitlabProjectId: number , domain: string , accessToken: string , options?: any ) : AxiosPromise < GitlabProjectDtoResponse >
Defined in Coscine.Api/api.ts:9840
Parameters
gitlabProjectId: number
domain: string
accessToken: string
Optional options: any
Returns AxiosPromise < GitlabProjectDtoResponse >
getResourceTypeInformation: function
getResourceTypeInformation( resourceTypeId: string , options?: any ) : AxiosPromise < ResourceTypeInformationDtoResponse >
Defined in Coscine.Api/api.ts:9850
Parameters
resourceTypeId: string
Optional options: any
Returns AxiosPromise < ResourceTypeInformationDtoResponse >
RoleApi: { apiV2RolesOptions: any ; getRole: any ; getRoles: any }
apiV2RolesOptions: function
apiV2RolesOptions( options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:10124
Parameters
Returns AxiosPromise < void >
getRole: function
getRole( roleId: string , options?: any ) : AxiosPromise < RoleDtoResponse >
Defined in Coscine.Api/api.ts:10134
Parameters
roleId: string
Optional options: any
Returns AxiosPromise < RoleDtoResponse >
getRoles: function
getRoles( pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < RoleDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:10146
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 >
Defined in Coscine.Api/api.ts:10358
Parameters
Returns AxiosPromise < void >
getSearchResults: function
getSearchResults( query?: string , useAdvancedSyntax?: boolean , languages?: string [] , category?: SearchCategoryType , pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < SearchResultDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:10374
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 >
Defined in Coscine.Api/api.ts:10783
Parameters
Optional userTermsOfServiceAcceptDto: UserTermsOfServiceAcceptDto
Optional options: any
Returns AxiosPromise < void >
apiV2SelfOptions: function
apiV2SelfOptions( options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:10792
Parameters
Returns AxiosPromise < void >
confirmUserEmail: function
confirmUserEmail( confirmationToken: string , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:10802
Parameters
confirmationToken: string
Optional options: any
Returns AxiosPromise < void >
getCurrentUser: function
getCurrentUser( options?: any ) : AxiosPromise < UserDtoResponse >
Defined in Coscine.Api/api.ts:10811
Parameters
Returns AxiosPromise < UserDtoResponse >
initiateUserMerge: function
initiateUserMerge( identityProvider: IdentityProviders , options?: any ) : AxiosPromise < UserMergeDtoResponse >
Defined in Coscine.Api/api.ts:10821
Parameters
identityProvider: IdentityProviders
Optional options: any
Returns AxiosPromise < UserMergeDtoResponse >
resolveProjectInvitation: function
resolveProjectInvitation( projectInvitationResolveDto?: ProjectInvitationResolveDto , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:10831
Parameters
Optional projectInvitationResolveDto: ProjectInvitationResolveDto
Optional options: any
Returns AxiosPromise < void >
updateCurrentUser: function
updateCurrentUser( userForUpdateDto?: UserForUpdateDto , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:10841
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 >
Defined in Coscine.Api/api.ts:11218
Parameters
Returns AxiosPromise < void >
createApiToken: function
createApiToken( apiTokenForCreationDto?: ApiTokenForCreationDto , options?: any ) : AxiosPromise < ApiTokenDtoResponse >
Defined in Coscine.Api/api.ts:11228
Parameters
Optional apiTokenForCreationDto: ApiTokenForCreationDto
Optional options: any
Returns AxiosPromise < ApiTokenDtoResponse >
getAllApiTokens: function
getAllApiTokens( pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < ApiTokenDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:11240
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 >
Defined in Coscine.Api/api.ts:11250
Parameters
apiTokenId: string
Optional options: any
Returns AxiosPromise < ApiTokenDtoResponse >
revokeToken: function
revokeToken( apiTokenId: string , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:11260
Parameters
apiTokenId: string
Optional options: any
Returns AxiosPromise < void >
ShibbolethApi: { shibbolethCallback: any ; shibbolethLogin: any }
shibbolethCallback: function
shibbolethCallback( returnUrl?: string , remoteError?: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.STS/api.ts:826
Parameters
Optional returnUrl: string
Optional remoteError: string
Optional options: any
Returns AxiosPromise < any >
shibbolethLogin: function
shibbolethLogin( returnUrl?: string , entityId?: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.STS/api.ts:837
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 >
Defined in Coscine.Api/api.ts:11520
Parameters
Returns AxiosPromise < void >
getTitle: function
getTitle( titleId: string , options?: any ) : AxiosPromise < TitleDtoResponse >
Defined in Coscine.Api/api.ts:11530
Parameters
titleId: string
Optional options: any
Returns AxiosPromise < TitleDtoResponse >
getTitles: function
getTitles( pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < TitleDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:11542
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 >
Defined in Coscine.Api/api.ts:11712
Parameters
Returns AxiosPromise < void >
getTos: function
getTos( options?: any ) : AxiosPromise < TermsOfServiceDtoResponse >
Defined in Coscine.Api/api.ts:11721
Parameters
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 >
Defined in Coscine.Api/api.ts:12121
Parameters
projectId: string
resourceId: string
Optional options: any
Returns AxiosPromise < void >
createMetadataTree: function
createMetadataTree( projectId: string , resourceId: string , metadataTreeForCreationDto?: MetadataTreeForCreationDto , options?: any ) : AxiosPromise < MetadataTreeDtoResponse >
Defined in Coscine.Api/api.ts:12133
Parameters
projectId: string
resourceId: string
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 >
Defined in Coscine.Api/api.ts:12148
Parameters
projectId: string
resourceId: string
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 >
Defined in Coscine.Api/api.ts:12164
Parameters
projectId: string
resourceId: string
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 >
Defined in Coscine.Api/api.ts:12176
Parameters
projectId: string
resourceId: string
Optional metadataTreeForUpdateDto: MetadataTreeForUpdateDto
Optional options: any
Returns AxiosPromise < void >
UserApi: { apiV2UsersOptions: any ; getUsers: any }
apiV2UsersOptions: function
apiV2UsersOptions( options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:12399
Parameters
Returns AxiosPromise < void >
getUsers: function
getUsers( searchTerm: string , orderBy?: string , options?: any ) : AxiosPromise < PublicUserDtoIEnumerableResponse >
Defined in Coscine.Api/api.ts:12410
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 >
Defined in Coscine.Api/api.ts:12633
Parameters
Returns AxiosPromise < void >
getVisibilities: function
getVisibilities( pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < VisibilityDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:12645
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 >
Defined in Coscine.Api/api.ts:12655
Parameters
visibilityId: string
Optional options: any
Returns AxiosPromise < VisibilityDtoResponse >
VocabularyApi: { apiV2VocabulariesOptions: any ; getVocabularies: any ; getVocabularyInstance: any ; getVocabularyInstances: any }
apiV2VocabulariesOptions: function
apiV2VocabulariesOptions( options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:12990
Parameters
Returns AxiosPromise < void >
getVocabularies: function
getVocabularies( searchTerm?: string , language?: AcceptedLanguage , pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < VocabularyDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:13004
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 >
Defined in Coscine.Api/api.ts:13015
Parameters
instance: string
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 >
Defined in Coscine.Api/api.ts:13030
Parameters
_class: string
Optional searchTerm: string
Optional language: AcceptedLanguage
Optional pageNumber: number
Optional pageSize: number
Optional orderBy: string
Optional options: any
Returns AxiosPromise < VocabularyInstanceDtoIEnumerablePagedResponse >
Return relevant URLs for logging the user in
{RequiredError}