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:4053
Parameters
Returns AxiosPromise < void >
createApplicationProfileRequest: function
createApplicationProfileRequest( applicationProfileForCreationDto?: ApplicationProfileForCreationDto , options?: any ) : AxiosPromise < ApplicationProfileForCreationDtoResponse >
Defined in Coscine.Api/api.ts:4062
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:4073
Parameters
profile: string
Optional format: RdfFormat
Optional acceptLanguage: AcceptedLanguage
Optional options: any
Returns AxiosPromise < ApplicationProfileDtoResponse >
getApplicationProfiles: function
getApplicationProfiles( language?: AcceptedLanguage , pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < ApplicationProfileDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:4085
Parameters
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:4094
Parameters
profile: string
Optional options: any
Returns AxiosPromise < string >
Const BlobApi
BlobApi: { blobDeleteFileWithParameter: any ; blobGetFileWithParameter: any ; blobUploadFileWithParameter: any } = ...
Type declaration
blobDeleteFileWithParameter: function
blobDeleteFileWithParameter( resourceId: string , path?: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Blob/api.ts:233
Parameters
resourceId: string
Optional path: string
Optional options: any
Returns AxiosPromise < any >
blobGetFileWithParameter: function
blobGetFileWithParameter( resourceId: string , path?: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Blob/api.ts:244
Parameters
resourceId: string
Optional path: string
Optional options: any
Returns AxiosPromise < any >
blobUploadFileWithParameter: function
blobUploadFileWithParameter( resourceId: string , path?: string , files?: any [] , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Blob/api.ts:256
Parameters
resourceId: string
Optional path: string
Optional files: any []
Optional options: any
Returns AxiosPromise < any >
Const DisciplineApi
DisciplineApi: { apiV2DisciplinesOptions: any ; getDiscipline: any ; getDisciplines: any } = ...
Type declaration
apiV2DisciplinesOptions: function
apiV2DisciplinesOptions( options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:4345
Parameters
Returns AxiosPromise < void >
getDiscipline: function
getDiscipline( disciplineId: string , options?: any ) : AxiosPromise < DisciplineDtoResponse >
Defined in Coscine.Api/api.ts:4354
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:4365
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:4591
Parameters
Returns AxiosPromise < void >
getLanguage: function
getLanguage( languageId: string , options?: any ) : AxiosPromise < LanguageDtoResponse >
Defined in Coscine.Api/api.ts:4600
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:4611
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:4837
Parameters
Returns AxiosPromise < void >
getLicense: function
getLicense( licenseId: string , options?: any ) : AxiosPromise < LicenseDtoResponse >
Defined in Coscine.Api/api.ts:4846
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:4857
Parameters
Optional pageNumber: number
Optional pageSize: number
Optional orderBy: string
Optional options: any
Returns AxiosPromise < LicenseDtoIEnumerablePagedResponse >
Const MaintenanceApi
MaintenanceApi: { apiV2MaintenancesOptions: any ; getCurrentMaintenance: any } = ...
Type declaration
apiV2MaintenancesOptions: function
apiV2MaintenancesOptions( options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:5019
Parameters
Returns AxiosPromise < void >
getCurrentMaintenance: function
getCurrentMaintenance( options?: any ) : AxiosPromise < MaintenanceDtoResponse >
Defined in Coscine.Api/api.ts:5027
Parameters
Returns AxiosPromise < MaintenanceDtoResponse >
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:5245
Parameters
Returns AxiosPromise < void >
getOrganization: function
getOrganization( organizationRorUrl: string , options?: any ) : AxiosPromise < OrganizationDtoResponse >
Defined in Coscine.Api/api.ts:5254
Parameters
organizationRorUrl: 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:5266
Parameters
Optional searchTerm: string
Optional pageNumber: number
Optional pageSize: number
Optional orderBy: string
Optional options: any
Returns AxiosPromise < OrganizationDtoIEnumerablePagedResponse >
Const PidApi
PidApi: { apiV2PidsOptions: any ; sendEmailToOwner: any ; validatePid: any } = ...
Type declaration
apiV2PidsOptions: function
apiV2PidsOptions( options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:5495
Parameters
Returns AxiosPromise < void >
sendEmailToOwner: function
sendEmailToOwner( prefix: string , id: string , pidEnquiryDto?: PidEnquiryDto , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:5506
Parameters
prefix: string
id: string
Optional pidEnquiryDto: PidEnquiryDto
Optional options: any
Returns AxiosPromise < void >
validatePid: function
validatePid( prefix: string , id: string , options?: any ) : AxiosPromise < PidValidationDtoResponse >
Defined in Coscine.Api/api.ts:5516
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:5898
Parameters
Returns AxiosPromise < void >
createProject: function
createProject( projectForCreationDto?: ProjectForCreationDto , options?: any ) : AxiosPromise < ProjectDtoResponse >
Defined in Coscine.Api/api.ts:5907
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:5916
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:5926
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:5938
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:5948
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 ; resolveProjectInvitation: any } = ...
Type declaration
apiV2ProjectsProjectIdInvitationsOptions: function
apiV2ProjectsProjectIdInvitationsOptions( projectId: string , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:6379
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:6389
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:6399
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:6409
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:6421
Parameters
projectId: string
Optional pageNumber: number
Optional pageSize: number
Optional orderBy: string
Optional options: any
Returns AxiosPromise < ProjectInvitationDtoIEnumerablePagedResponse >
resolveProjectInvitation: function
resolveProjectInvitation( projectId: string , projectInvitationResolveDto?: ProjectInvitationResolveDto , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:6431
Parameters
projectId: string
Optional projectInvitationResolveDto: ProjectInvitationResolveDto
Optional options: any
Returns AxiosPromise < void >
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:6871
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:6880
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:6890
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:6900
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:6912
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:6923
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:7261
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:7271
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:7283
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:7294
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:7710
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:7720
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:7730
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:7740
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:7752
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:7763
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:7987
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:7997
Parameters
projectId: string
resourceId: string
Optional options: any
Returns AxiosPromise < ResourceQuotaDtoResponse >
Const ProjectResourceTypeApi
ProjectResourceTypeApi: { apiV2ProjectsProjectIdResourcesTypesOptions: any ; getAvailableResourceTypesInformationForProject: any } = ...
Type declaration
apiV2ProjectsProjectIdResourcesTypesOptions: function
apiV2ProjectsProjectIdResourcesTypesOptions( projectId: string , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:8160
Parameters
projectId: string
Optional options: any
Returns AxiosPromise < void >
getAvailableResourceTypesInformationForProject: function
getAvailableResourceTypesInformationForProject( projectId: string , options?: any ) : AxiosPromise < ResourceTypeInformationDtoIEnumerableResponse >
Defined in Coscine.Api/api.ts:8169
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:8324
Parameters
Returns AxiosPromise < void >
getResource: function
getResource( resourceId: string , options?: any ) : AxiosPromise < ResourceDtoResponse >
Defined in Coscine.Api/api.ts:8333
Parameters
resourceId: string
Optional options: any
Returns AxiosPromise < ResourceDtoResponse >
Const ResourceTypeApi
ResourceTypeApi: { apiV2ResourcesTypesOptions: any ; getAllGitlabBranchesForProject: any ; getAllGitlabProjects: any ; getAllResourceTypesInformation: any ; getGitlabProject: any ; getResourceTypeInformation: any } = ...
Type declaration
apiV2ResourcesTypesOptions: function
apiV2ResourcesTypesOptions( options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:8709
Parameters
Returns AxiosPromise < void >
getAllGitlabBranchesForProject: function
getAllGitlabBranchesForProject( gitlabProjectId: number , domain: string , accessToken: string , options?: any ) : AxiosPromise < GitlabBranchDtoIEnumerableResponse >
Defined in Coscine.Api/api.ts:8720
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:8730
Parameters
domain: string
accessToken: string
Optional options: any
Returns AxiosPromise < GitlabProjectDtoIEnumerableResponse >
getAllResourceTypesInformation: function
getAllResourceTypesInformation( options?: any ) : AxiosPromise < ResourceTypeInformationDtoIEnumerableResponse >
Defined in Coscine.Api/api.ts:8738
Parameters
Returns AxiosPromise < ResourceTypeInformationDtoIEnumerableResponse >
getGitlabProject: function
getGitlabProject( gitlabProjectId: number , domain: string , accessToken: string , options?: any ) : AxiosPromise < GitlabProjectDtoResponse >
Defined in Coscine.Api/api.ts:8749
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:8758
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:9019
Parameters
Returns AxiosPromise < void >
getRole: function
getRole( roleId: string , options?: any ) : AxiosPromise < RoleDtoResponse >
Defined in Coscine.Api/api.ts:9028
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:9039
Parameters
Optional pageNumber: number
Optional pageSize: number
Optional orderBy: string
Optional options: any
Returns AxiosPromise < RoleDtoIEnumerablePagedResponse >
Const SearchApi
SearchApi: { searchSearch: any } = ...
Type declaration
searchSearch: function
searchSearch( searchQuery?: string , includeUsers?: boolean , useAdvancedSyntax?: boolean , includedLanguages?: string [] , categoryFilter?: CategoryFilter , orderBy?: OrderBy , pageNumber?: number , pageSize?: number , options?: any ) : AxiosPromise < ItemSearchResult [] >
Defined in Coscine.Api.Search/api.ts:221
Parameters
Optional searchQuery: string
Optional includeUsers: boolean
Optional useAdvancedSyntax: boolean
Optional includedLanguages: string []
Optional categoryFilter: CategoryFilter
Optional orderBy: OrderBy
Optional pageNumber: number
Optional pageSize: number
Optional options: any
Returns AxiosPromise < ItemSearchResult [] >
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:9265
Parameters
Returns AxiosPromise < void >
getTitle: function
getTitle( titleId: string , options?: any ) : AxiosPromise < TitleDtoResponse >
Defined in Coscine.Api/api.ts:9274
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:9285
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:9447
Parameters
Returns AxiosPromise < void >
getToS: function
getToS( options?: any ) : AxiosPromise < TermsOfServiceDtoResponse >
Defined in Coscine.Api/api.ts:9455
Parameters
Returns AxiosPromise < TermsOfServiceDtoResponse >
Const TokenApi
TokenApi: { apiV2UsersSelfTokensOptions: any ; createApiToken: any ; getAllApiTokens: any ; getApiToken: any ; revokeToken: any } = ...
Type declaration
apiV2UsersSelfTokensOptions: function
apiV2UsersSelfTokensOptions( options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:10255
Parameters
Returns AxiosPromise < void >
createApiToken: function
createApiToken( apiTokenForCreationDto?: ApiTokenForCreationDto , options?: any ) : AxiosPromise < ApiTokenDtoResponse >
Defined in Coscine.Api/api.ts:10264
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:10275
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:10284
Parameters
apiTokenId: string
Optional options: any
Returns AxiosPromise < ApiTokenDtoResponse >
revokeToken: function
revokeToken( apiTokenId: string , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:10293
Parameters
apiTokenId: string
Optional options: any
Returns AxiosPromise < void >
Const TreeApi
TreeApi: { treeGetMetadataWithParameter: any ; treeStoreMetadataForFileWithParameter: any } = ...
Type declaration
treeGetMetadataWithParameter: function
treeGetMetadataWithParameter( resourceId: string , path?: string , mimeType?: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Tree/api.ts:180
Parameters
resourceId: string
Optional path: string
Optional mimeType: string
Optional options: any
Returns AxiosPromise < any >
treeStoreMetadataForFileWithParameter: function
treeStoreMetadataForFileWithParameter( resourceId: string , path?: string , mimeType?: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Tree/api.ts:192
Parameters
resourceId: string
Optional path: string
Optional mimeType: string
Optional options: any
Returns AxiosPromise < any >
Const UserApi
UserApi: { acceptCurrentToS: any ; apiV2UsersOptions: any ; confirmUserEmail: any ; getCurrentUser: any ; getUsers: any ; initiateUserMerge: any ; updateCurrentUser: any } = ...
Type declaration
acceptCurrentToS: function
acceptCurrentToS( options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:9843
Parameters
Returns AxiosPromise < void >
apiV2UsersOptions: function
apiV2UsersOptions( options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:9851
Parameters
Returns AxiosPromise < void >
confirmUserEmail: function
confirmUserEmail( confirmationToken: string , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:9860
Parameters
confirmationToken: string
Optional options: any
Returns AxiosPromise < void >
getCurrentUser: function
getCurrentUser( options?: any ) : AxiosPromise < UserDtoResponse >
Defined in Coscine.Api/api.ts:9868
Parameters
Returns AxiosPromise < UserDtoResponse >
getUsers: function
getUsers( searchTerm: string , orderBy?: string , options?: any ) : AxiosPromise < PublicUserDtoIEnumerableResponse >
Defined in Coscine.Api/api.ts:9878
Parameters
searchTerm: string
Optional orderBy: string
Optional options: any
Returns AxiosPromise < PublicUserDtoIEnumerableResponse >
initiateUserMerge: function
initiateUserMerge( externalAuthenticator: ExternalAuthenticators , options?: any ) : AxiosPromise < UserMergeDtoResponse >
Defined in Coscine.Api/api.ts:9887
Parameters
externalAuthenticator: ExternalAuthenticators
Optional options: any
Returns AxiosPromise < UserMergeDtoResponse >
updateCurrentUser: function
updateCurrentUser( userForUpdateDto?: UserForUpdateDto , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:9896
Parameters
Optional userForUpdateDto: UserForUpdateDto
Optional options: any
Returns AxiosPromise < void >
Const VisibilityApi
VisibilityApi: { apiV2VisibilitiesOptions: any ; getVisibilities: any ; getVisibility: any } = ...
Type declaration
apiV2VisibilitiesOptions: function
apiV2VisibilitiesOptions( options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:10541
Parameters
Returns AxiosPromise < void >
getVisibilities: function
getVisibilities( pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < VisibilityDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:10552
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:10561
Parameters
visibilityId: string
Optional options: any
Returns AxiosPromise < VisibilityDtoResponse >
Const VocabularyApi
VocabularyApi: { apiV2VocabulariesOptions: any ; getInstance: any ; getVocabularies: any ; getVocabularyInstances: any } = ...
Type declaration
apiV2VocabulariesOptions: function
apiV2VocabulariesOptions( options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:10884
Parameters
Returns AxiosPromise < void >
getInstance: function
getInstance( instance: string , acceptLanguage?: AcceptedLanguage , options?: any ) : AxiosPromise < VocabularyDtoResponse >
Defined in Coscine.Api/api.ts:10894
Parameters
instance: string
Optional acceptLanguage: AcceptedLanguage
Optional options: any
Returns AxiosPromise < VocabularyDtoResponse >
getVocabularies: function
getVocabularies( searchTerm?: string , language?: AcceptedLanguage , pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < VocabularyDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:10907
Parameters
Optional searchTerm: string
Optional language: AcceptedLanguage
Optional pageNumber: number
Optional pageSize: number
Optional orderBy: string
Optional options: any
Returns AxiosPromise < VocabularyDtoIEnumerablePagedResponse >
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:10921
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: { blobDeleteFileWithParameter: any ; blobGetFileWithParameter: any ; blobUploadFileWithParameter: 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 ; getCurrentMaintenance: any } ; MergeApi: { mergeCallback: any ; mergeLogin: any } ; ORCiDApi: { oRCiDLoginGET: any ; oRCiDLoginPOST: any } ; OrganizationApi: { apiV2OrganizationsOptions: any ; getOrganization: any ; getOrganizations: any } ; PidApi: { apiV2PidsOptions: any ; sendEmailToOwner: 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 ; resolveProjectInvitation: 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: { apiV2ProjectsProjectIdResourcesTypesOptions: any ; getAvailableResourceTypesInformationForProject: any } ; ResourceApi: { apiV2ResourcesOptions: any ; getResource: any } ; ResourceTypeApi: { apiV2ResourcesTypesOptions: any ; getAllGitlabBranchesForProject: any ; getAllGitlabProjects: any ; getAllResourceTypesInformation: any ; getGitlabProject: any ; getResourceTypeInformation: any } ; RoleApi: { apiV2RolesOptions: any ; getRole: any ; getRoles: any } ; SearchApi: { searchSearch: any } ; ShibbolethApi: { shibbolethCallback: any ; shibbolethLogin: any } ; TitleApi: { apiV2TitlesOptions: any ; getTitle: any ; getTitles: any } ; ToSApi: { apiV2TosOptions: any ; getToS: any } ; TokenApi: { apiV2UsersSelfTokensOptions: any ; createApiToken: any ; getAllApiTokens: any ; getApiToken: any ; revokeToken: any } ; TreeApi: { treeGetMetadataWithParameter: any ; treeStoreMetadataForFileWithParameter: any } ; UserApi: { acceptCurrentToS: any ; apiV2UsersOptions: any ; confirmUserEmail: any ; getCurrentUser: any ; getUsers: any ; initiateUserMerge: any ; updateCurrentUser: any } ; VisibilityApi: { apiV2VisibilitiesOptions: any ; getVisibilities: any ; getVisibility: any } ; VocabularyApi: { apiV2VocabulariesOptions: any ; getInstance: any ; getVocabularies: 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:4053
Parameters
Returns AxiosPromise < void >
createApplicationProfileRequest: function
createApplicationProfileRequest( applicationProfileForCreationDto?: ApplicationProfileForCreationDto , options?: any ) : AxiosPromise < ApplicationProfileForCreationDtoResponse >
Defined in Coscine.Api/api.ts:4062
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:4073
Parameters
profile: string
Optional format: RdfFormat
Optional acceptLanguage: AcceptedLanguage
Optional options: any
Returns AxiosPromise < ApplicationProfileDtoResponse >
getApplicationProfiles: function
getApplicationProfiles( language?: AcceptedLanguage , pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < ApplicationProfileDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:4085
Parameters
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:4094
Parameters
profile: string
Optional options: any
Returns AxiosPromise < string >
BlobApi: { blobDeleteFileWithParameter: any ; blobGetFileWithParameter: any ; blobUploadFileWithParameter: any }
blobDeleteFileWithParameter: function
blobDeleteFileWithParameter( resourceId: string , path?: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Blob/api.ts:233
Parameters
resourceId: string
Optional path: string
Optional options: any
Returns AxiosPromise < any >
blobGetFileWithParameter: function
blobGetFileWithParameter( resourceId: string , path?: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Blob/api.ts:244
Parameters
resourceId: string
Optional path: string
Optional options: any
Returns AxiosPromise < any >
blobUploadFileWithParameter: function
blobUploadFileWithParameter( resourceId: string , path?: string , files?: any [] , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Blob/api.ts:256
Parameters
resourceId: string
Optional path: string
Optional files: any []
Optional options: any
Returns AxiosPromise < any >
DisciplineApi: { apiV2DisciplinesOptions: any ; getDiscipline: any ; getDisciplines: any }
apiV2DisciplinesOptions: function
apiV2DisciplinesOptions( options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:4345
Parameters
Returns AxiosPromise < void >
getDiscipline: function
getDiscipline( disciplineId: string , options?: any ) : AxiosPromise < DisciplineDtoResponse >
Defined in Coscine.Api/api.ts:4354
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:4365
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:4591
Parameters
Returns AxiosPromise < void >
getLanguage: function
getLanguage( languageId: string , options?: any ) : AxiosPromise < LanguageDtoResponse >
Defined in Coscine.Api/api.ts:4600
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:4611
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:4837
Parameters
Returns AxiosPromise < void >
getLicense: function
getLicense( licenseId: string , options?: any ) : AxiosPromise < LicenseDtoResponse >
Defined in Coscine.Api/api.ts:4846
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:4857
Parameters
Optional pageNumber: number
Optional pageSize: number
Optional orderBy: string
Optional options: any
Returns AxiosPromise < LicenseDtoIEnumerablePagedResponse >
MaintenanceApi: { apiV2MaintenancesOptions: any ; getCurrentMaintenance: any }
apiV2MaintenancesOptions: function
apiV2MaintenancesOptions( options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:5019
Parameters
Returns AxiosPromise < void >
getCurrentMaintenance: function
getCurrentMaintenance( options?: any ) : AxiosPromise < MaintenanceDtoResponse >
Defined in Coscine.Api/api.ts:5027
Parameters
Returns AxiosPromise < MaintenanceDtoResponse >
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:5245
Parameters
Returns AxiosPromise < void >
getOrganization: function
getOrganization( organizationRorUrl: string , options?: any ) : AxiosPromise < OrganizationDtoResponse >
Defined in Coscine.Api/api.ts:5254
Parameters
organizationRorUrl: 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:5266
Parameters
Optional searchTerm: string
Optional pageNumber: number
Optional pageSize: number
Optional orderBy: string
Optional options: any
Returns AxiosPromise < OrganizationDtoIEnumerablePagedResponse >
PidApi: { apiV2PidsOptions: any ; sendEmailToOwner: any ; validatePid: any }
apiV2PidsOptions: function
apiV2PidsOptions( options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:5495
Parameters
Returns AxiosPromise < void >
sendEmailToOwner: function
sendEmailToOwner( prefix: string , id: string , pidEnquiryDto?: PidEnquiryDto , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:5506
Parameters
prefix: string
id: string
Optional pidEnquiryDto: PidEnquiryDto
Optional options: any
Returns AxiosPromise < void >
validatePid: function
validatePid( prefix: string , id: string , options?: any ) : AxiosPromise < PidValidationDtoResponse >
Defined in Coscine.Api/api.ts:5516
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:5898
Parameters
Returns AxiosPromise < void >
createProject: function
createProject( projectForCreationDto?: ProjectForCreationDto , options?: any ) : AxiosPromise < ProjectDtoResponse >
Defined in Coscine.Api/api.ts:5907
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:5916
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:5926
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:5938
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:5948
Parameters
projectId: string
Optional projectForUpdateDto: ProjectForUpdateDto
Optional options: any
Returns AxiosPromise < void >
ProjectInvitationApi: { apiV2ProjectsProjectIdInvitationsOptions: any ; createProjectInvitation: any ; deleteProjectInvitation: any ; getProjectInvitation: any ; getProjectInvitations: any ; resolveProjectInvitation: any }
apiV2ProjectsProjectIdInvitationsOptions: function
apiV2ProjectsProjectIdInvitationsOptions( projectId: string , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:6379
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:6389
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:6399
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:6409
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:6421
Parameters
projectId: string
Optional pageNumber: number
Optional pageSize: number
Optional orderBy: string
Optional options: any
Returns AxiosPromise < ProjectInvitationDtoIEnumerablePagedResponse >
resolveProjectInvitation: function
resolveProjectInvitation( projectId: string , projectInvitationResolveDto?: ProjectInvitationResolveDto , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:6431
Parameters
projectId: string
Optional projectInvitationResolveDto: ProjectInvitationResolveDto
Optional options: any
Returns AxiosPromise < void >
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:6871
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:6880
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:6890
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:6900
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:6912
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:6923
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:7261
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:7271
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:7283
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:7294
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:7710
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:7720
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:7730
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:7740
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:7752
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:7763
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:7987
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:7997
Parameters
projectId: string
resourceId: string
Optional options: any
Returns AxiosPromise < ResourceQuotaDtoResponse >
ProjectResourceTypeApi: { apiV2ProjectsProjectIdResourcesTypesOptions: any ; getAvailableResourceTypesInformationForProject: any }
apiV2ProjectsProjectIdResourcesTypesOptions: function
apiV2ProjectsProjectIdResourcesTypesOptions( projectId: string , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:8160
Parameters
projectId: string
Optional options: any
Returns AxiosPromise < void >
getAvailableResourceTypesInformationForProject: function
getAvailableResourceTypesInformationForProject( projectId: string , options?: any ) : AxiosPromise < ResourceTypeInformationDtoIEnumerableResponse >
Defined in Coscine.Api/api.ts:8169
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:8324
Parameters
Returns AxiosPromise < void >
getResource: function
getResource( resourceId: string , options?: any ) : AxiosPromise < ResourceDtoResponse >
Defined in Coscine.Api/api.ts:8333
Parameters
resourceId: string
Optional options: any
Returns AxiosPromise < ResourceDtoResponse >
ResourceTypeApi: { apiV2ResourcesTypesOptions: any ; getAllGitlabBranchesForProject: any ; getAllGitlabProjects: any ; getAllResourceTypesInformation: any ; getGitlabProject: any ; getResourceTypeInformation: any }
apiV2ResourcesTypesOptions: function
apiV2ResourcesTypesOptions( options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:8709
Parameters
Returns AxiosPromise < void >
getAllGitlabBranchesForProject: function
getAllGitlabBranchesForProject( gitlabProjectId: number , domain: string , accessToken: string , options?: any ) : AxiosPromise < GitlabBranchDtoIEnumerableResponse >
Defined in Coscine.Api/api.ts:8720
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:8730
Parameters
domain: string
accessToken: string
Optional options: any
Returns AxiosPromise < GitlabProjectDtoIEnumerableResponse >
getAllResourceTypesInformation: function
getAllResourceTypesInformation( options?: any ) : AxiosPromise < ResourceTypeInformationDtoIEnumerableResponse >
Defined in Coscine.Api/api.ts:8738
Parameters
Returns AxiosPromise < ResourceTypeInformationDtoIEnumerableResponse >
getGitlabProject: function
getGitlabProject( gitlabProjectId: number , domain: string , accessToken: string , options?: any ) : AxiosPromise < GitlabProjectDtoResponse >
Defined in Coscine.Api/api.ts:8749
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:8758
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:9019
Parameters
Returns AxiosPromise < void >
getRole: function
getRole( roleId: string , options?: any ) : AxiosPromise < RoleDtoResponse >
Defined in Coscine.Api/api.ts:9028
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:9039
Parameters
Optional pageNumber: number
Optional pageSize: number
Optional orderBy: string
Optional options: any
Returns AxiosPromise < RoleDtoIEnumerablePagedResponse >
SearchApi: { searchSearch: any }
searchSearch: function
searchSearch( searchQuery?: string , includeUsers?: boolean , useAdvancedSyntax?: boolean , includedLanguages?: string [] , categoryFilter?: CategoryFilter , orderBy?: OrderBy , pageNumber?: number , pageSize?: number , options?: any ) : AxiosPromise < ItemSearchResult [] >
Defined in Coscine.Api.Search/api.ts:221
Parameters
Optional searchQuery: string
Optional includeUsers: boolean
Optional useAdvancedSyntax: boolean
Optional includedLanguages: string []
Optional categoryFilter: CategoryFilter
Optional orderBy: OrderBy
Optional pageNumber: number
Optional pageSize: number
Optional options: any
Returns AxiosPromise < ItemSearchResult [] >
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:9265
Parameters
Returns AxiosPromise < void >
getTitle: function
getTitle( titleId: string , options?: any ) : AxiosPromise < TitleDtoResponse >
Defined in Coscine.Api/api.ts:9274
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:9285
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:9447
Parameters
Returns AxiosPromise < void >
getToS: function
getToS( options?: any ) : AxiosPromise < TermsOfServiceDtoResponse >
Defined in Coscine.Api/api.ts:9455
Parameters
Returns AxiosPromise < TermsOfServiceDtoResponse >
TokenApi: { apiV2UsersSelfTokensOptions: any ; createApiToken: any ; getAllApiTokens: any ; getApiToken: any ; revokeToken: any }
apiV2UsersSelfTokensOptions: function
apiV2UsersSelfTokensOptions( options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:10255
Parameters
Returns AxiosPromise < void >
createApiToken: function
createApiToken( apiTokenForCreationDto?: ApiTokenForCreationDto , options?: any ) : AxiosPromise < ApiTokenDtoResponse >
Defined in Coscine.Api/api.ts:10264
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:10275
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:10284
Parameters
apiTokenId: string
Optional options: any
Returns AxiosPromise < ApiTokenDtoResponse >
revokeToken: function
revokeToken( apiTokenId: string , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:10293
Parameters
apiTokenId: string
Optional options: any
Returns AxiosPromise < void >
TreeApi: { treeGetMetadataWithParameter: any ; treeStoreMetadataForFileWithParameter: any }
treeGetMetadataWithParameter: function
treeGetMetadataWithParameter( resourceId: string , path?: string , mimeType?: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Tree/api.ts:180
Parameters
resourceId: string
Optional path: string
Optional mimeType: string
Optional options: any
Returns AxiosPromise < any >
treeStoreMetadataForFileWithParameter: function
treeStoreMetadataForFileWithParameter( resourceId: string , path?: string , mimeType?: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Tree/api.ts:192
Parameters
resourceId: string
Optional path: string
Optional mimeType: string
Optional options: any
Returns AxiosPromise < any >
UserApi: { acceptCurrentToS: any ; apiV2UsersOptions: any ; confirmUserEmail: any ; getCurrentUser: any ; getUsers: any ; initiateUserMerge: any ; updateCurrentUser: any }
acceptCurrentToS: function
acceptCurrentToS( options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:9843
Parameters
Returns AxiosPromise < void >
apiV2UsersOptions: function
apiV2UsersOptions( options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:9851
Parameters
Returns AxiosPromise < void >
confirmUserEmail: function
confirmUserEmail( confirmationToken: string , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:9860
Parameters
confirmationToken: string
Optional options: any
Returns AxiosPromise < void >
getCurrentUser: function
getCurrentUser( options?: any ) : AxiosPromise < UserDtoResponse >
Defined in Coscine.Api/api.ts:9868
Parameters
Returns AxiosPromise < UserDtoResponse >
getUsers: function
getUsers( searchTerm: string , orderBy?: string , options?: any ) : AxiosPromise < PublicUserDtoIEnumerableResponse >
Defined in Coscine.Api/api.ts:9878
Parameters
searchTerm: string
Optional orderBy: string
Optional options: any
Returns AxiosPromise < PublicUserDtoIEnumerableResponse >
initiateUserMerge: function
initiateUserMerge( externalAuthenticator: ExternalAuthenticators , options?: any ) : AxiosPromise < UserMergeDtoResponse >
Defined in Coscine.Api/api.ts:9887
Parameters
externalAuthenticator: ExternalAuthenticators
Optional options: any
Returns AxiosPromise < UserMergeDtoResponse >
updateCurrentUser: function
updateCurrentUser( userForUpdateDto?: UserForUpdateDto , options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:9896
Parameters
Optional userForUpdateDto: UserForUpdateDto
Optional options: any
Returns AxiosPromise < void >
VisibilityApi: { apiV2VisibilitiesOptions: any ; getVisibilities: any ; getVisibility: any }
apiV2VisibilitiesOptions: function
apiV2VisibilitiesOptions( options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:10541
Parameters
Returns AxiosPromise < void >
getVisibilities: function
getVisibilities( pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < VisibilityDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:10552
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:10561
Parameters
visibilityId: string
Optional options: any
Returns AxiosPromise < VisibilityDtoResponse >
VocabularyApi: { apiV2VocabulariesOptions: any ; getInstance: any ; getVocabularies: any ; getVocabularyInstances: any }
apiV2VocabulariesOptions: function
apiV2VocabulariesOptions( options?: any ) : AxiosPromise < void >
Defined in Coscine.Api/api.ts:10884
Parameters
Returns AxiosPromise < void >
getInstance: function
getInstance( instance: string , acceptLanguage?: AcceptedLanguage , options?: any ) : AxiosPromise < VocabularyDtoResponse >
Defined in Coscine.Api/api.ts:10894
Parameters
instance: string
Optional acceptLanguage: AcceptedLanguage
Optional options: any
Returns AxiosPromise < VocabularyDtoResponse >
getVocabularies: function
getVocabularies( searchTerm?: string , language?: AcceptedLanguage , pageNumber?: number , pageSize?: number , orderBy?: string , options?: any ) : AxiosPromise < VocabularyDtoIEnumerablePagedResponse >
Defined in Coscine.Api/api.ts:10907
Parameters
Optional searchTerm: string
Optional language: AcceptedLanguage
Optional pageNumber: number
Optional pageSize: number
Optional orderBy: string
Optional options: any
Returns AxiosPromise < VocabularyDtoIEnumerablePagedResponse >
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:10921
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}