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 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 ContactChangeApi
ContactChangeApi: { contactChangeChangeContactEmail: any ; contactChangeConfirmContactEmail: any ; contactChangeConfirmationStatus: any } = ...
Type declaration
contactChangeChangeContactEmail: function
contactChangeChangeContactEmail( body: string , options?: any ) : AxiosPromise < ContactChangeObject >
Defined in Coscine.Api.User/api.ts:428
Parameters
body: string
Optional options: any
Returns AxiosPromise < ContactChangeObject >
contactChangeConfirmContactEmail: function
contactChangeConfirmContactEmail( verification: string , options?: any ) : AxiosPromise < UserObject >
Defined in Coscine.Api.User/api.ts:438
Parameters
verification: string
Optional options: any
Returns AxiosPromise < UserObject >
contactChangeConfirmationStatus: function
contactChangeConfirmationStatus( options?: any ) : AxiosPromise < ContactChangeObject [] >
Defined in Coscine.Api.User/api.ts:447
Parameters
Returns AxiosPromise < ContactChangeObject [] >
Const DisciplineApi
DisciplineApi: { disciplineIndex: any } = ...
Type declaration
disciplineIndex: function
disciplineIndex( options?: any ) : AxiosPromise < DisciplineObject [] >
Defined in Coscine.Api.Project/api.ts:855
Parameters
Returns AxiosPromise < DisciplineObject [] >
Const GitLabApi
GitLabApi: { gitLabGetAllProjects: any ; gitLabGetBranchesForProject: any ; gitLabGetProject: any } = ...
Type declaration
gitLabGetAllProjects: function
gitLabGetAllProjects( domain?: string , accessToken?: string , options?: any ) : AxiosPromise < Project [] >
Defined in Coscine.Api.Resources/api.ts:1303
Parameters
Optional domain: string
Optional accessToken: string
Optional options: any
Returns AxiosPromise < Project [] >
gitLabGetBranchesForProject: function
gitLabGetBranchesForProject( projectId: number , domain?: string , accessToken?: string , options?: any ) : AxiosPromise < Branch [] >
Defined in Coscine.Api.Resources/api.ts:1315
Parameters
projectId: number
Optional domain: string
Optional accessToken: string
Optional options: any
Returns AxiosPromise < Branch [] >
gitLabGetProject: function
gitLabGetProject( projectId: number , domain?: string , accessToken?: string , options?: any ) : AxiosPromise < Project >
Defined in Coscine.Api.Resources/api.ts:1327
Parameters
projectId: number
Optional domain: string
Optional accessToken: string
Optional options: any
Returns AxiosPromise < Project >
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: { languageIndex: any } = ...
Type declaration
languageIndex: function
languageIndex( options?: any ) : AxiosPromise < LanguageObject [] >
Defined in Coscine.Api.User/api.ts:572
Parameters
Returns AxiosPromise < LanguageObject [] >
Const LicenseApi
LicenseApi: { licenseIndex: any } = ...
Type declaration
licenseIndex: function
licenseIndex( options?: any ) : AxiosPromise < LicenseObject [] >
Defined in Coscine.Api.Project/api.ts:956
Parameters
Returns AxiosPromise < LicenseObject [] >
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 MetadataApi
MetadataApi: { metadataGetClassInstances: any ; metadataGetProfile: any ; metadataGetProfiles: any ; metadataGetVocabularies: any ; metadataGetVocabulary: any ; metadataSaveApplicationProfile: any } = ...
Type declaration
metadataGetClassInstances: function
metadataGetClassInstances( className: string , options?: any ) : AxiosPromise < BilingualLabels >
Defined in Coscine.Api.Metadata/api.ts:407
Parameters
className: string
Optional options: any
Returns AxiosPromise < BilingualLabels >
metadataGetProfile: function
metadataGetProfile( profile: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Metadata/api.ts:417
Parameters
profile: string
Optional options: any
Returns AxiosPromise < any >
metadataGetProfiles: function
metadataGetProfiles( options?: any ) : AxiosPromise < string [] >
Defined in Coscine.Api.Metadata/api.ts:426
Parameters
Returns AxiosPromise < string [] >
metadataGetVocabularies: function
metadataGetVocabularies( options?: any ) : AxiosPromise < string [] >
Defined in Coscine.Api.Metadata/api.ts:435
Parameters
Returns AxiosPromise < string [] >
metadataGetVocabulary: function
metadataGetVocabulary( path: string , options?: any ) : AxiosPromise < BilingualLabels >
Defined in Coscine.Api.Metadata/api.ts:445
Parameters
path: string
Optional options: any
Returns AxiosPromise < BilingualLabels >
metadataSaveApplicationProfile: function
metadataSaveApplicationProfile( applicationProfile: ApplicationProfile , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Metadata/api.ts:455
Parameters
applicationProfile: ApplicationProfile
Optional options: any
Returns AxiosPromise < any >
Const NoticeApi
NoticeApi: { noticeGetMaintenance: any ; noticeGetNotice: any } = ...
Type declaration
noticeGetMaintenance: function
noticeGetMaintenance( options?: any ) : AxiosPromise < MaintenanceReturnObject >
Defined in Coscine.Api.Notices/api.ts:199
Parameters
Returns AxiosPromise < MaintenanceReturnObject >
noticeGetNotice: function
noticeGetNotice( documentSlug: string , language?: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Notices/api.ts:211
Parameters
documentSlug: string
Optional language: 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: { organizationGetOrganization: any ; organizationGetROR: any ; organizationIndex: any ; organizationIsMember: any ; organizationIsMember2: any } = ...
Type declaration
organizationGetOrganization: function
organizationGetOrganization( url: string , options?: any ) : AxiosPromise < WrapperObject >
Defined in Coscine.Api.Organization/api.ts:352
Parameters
url: string
Optional options: any
Returns AxiosPromise < WrapperObject >
organizationGetROR: function
organizationGetROR( filter?: string , options?: any ) : AxiosPromise < WrapperObject >
Defined in Coscine.Api.Organization/api.ts:362
Parameters
Optional filter: string
Optional options: any
Returns AxiosPromise < WrapperObject >
organizationIndex: function
organizationIndex( member?: number , filter?: string , options?: any ) : AxiosPromise < WrapperObject >
Defined in Coscine.Api.Organization/api.ts:373
Parameters
Optional member: number
Optional filter: string
Optional options: any
Returns AxiosPromise < WrapperObject >
organizationIsMember: function
organizationIsMember( url: string , options?: any ) : AxiosPromise < IsMemberObject >
Defined in Coscine.Api.Organization/api.ts:383
Parameters
url: string
Optional options: any
Returns AxiosPromise < IsMemberObject >
organizationIsMember2: function
organizationIsMember2( options?: any ) : AxiosPromise < WrapperObject >
Defined in Coscine.Api.Organization/api.ts:392
Parameters
Returns AxiosPromise < WrapperObject >
Const PidApi
PidApi: { pidIsValid: any ; pidSendMailToOwner: any } = ...
Type declaration
pidIsValid: function
pidIsValid( pid: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Pid/api.ts:199
Parameters
pid: string
Optional options: any
Returns AxiosPromise < any >
pidSendMailToOwner: function
pidSendMailToOwner( messageObject: MessageObject , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Pid/api.ts:209
Parameters
messageObject: MessageObject
Optional options: any
Returns AxiosPromise < any >
Const ProjectApi
ProjectApi: { projectCreateApplicationProfile: any ; projectDelete: any ; projectDeleteInvitation: any ; projectGet: any ; projectGetBySlug: any ; projectGetResources: any ; projectGetTopLevelProjects: any ; projectIndex: any ; projectListInvitations: any ; projectResolveInvitation: any ; projectSendInvitation: any ; projectStore: any ; projectUpdate: any } = ...
Type declaration
projectCreateApplicationProfile: function
projectCreateApplicationProfile( projectId: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Project/api.ts:1640
Parameters
projectId: string
Optional options: any
Returns AxiosPromise < any >
projectDelete: function
projectDelete( id: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Project/api.ts:1650
Parameters
id: string
Optional options: any
Returns AxiosPromise < any >
projectDeleteInvitation: function
projectDeleteInvitation( invitationId: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Project/api.ts:1660
Parameters
invitationId: string
Optional options: any
Returns AxiosPromise < any >
projectGet: function
projectGet( id: string , options?: any ) : AxiosPromise < ProjectObject >
Defined in Coscine.Api.Project/api.ts:1670
Parameters
id: string
Optional options: any
Returns AxiosPromise < ProjectObject >
projectGetBySlug: function
projectGetBySlug( slug: string , options?: any ) : AxiosPromise < ProjectObject >
Defined in Coscine.Api.Project/api.ts:1680
Parameters
slug: string
Optional options: any
Returns AxiosPromise < ProjectObject >
projectGetResources: function
projectGetResources( id: string , options?: any ) : AxiosPromise < ResourceObject [] >
Defined in Coscine.Api.Project/api.ts:1690
Parameters
id: string
Optional options: any
Returns AxiosPromise < ResourceObject [] >
projectGetTopLevelProjects: function
projectGetTopLevelProjects( options?: any ) : AxiosPromise < ProjectObject [] >
Defined in Coscine.Api.Project/api.ts:1699
Parameters
Returns AxiosPromise < ProjectObject [] >
projectIndex: function
projectIndex( options?: any ) : AxiosPromise < ProjectObject [] >
Defined in Coscine.Api.Project/api.ts:1708
Parameters
Returns AxiosPromise < ProjectObject [] >
projectListInvitations: function
projectListInvitations( projectId: string , options?: any ) : AxiosPromise < InvitationReturnObject [] >
Defined in Coscine.Api.Project/api.ts:1718
Parameters
projectId: string
Optional options: any
Returns AxiosPromise < InvitationReturnObject [] >
projectResolveInvitation: function
projectResolveInvitation( invitationToken: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Project/api.ts:1728
Parameters
invitationToken: string
Optional options: any
Returns AxiosPromise < any >
projectSendInvitation: function
projectSendInvitation( sendInvitationObject: SendInvitationObject , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Project/api.ts:1738
Parameters
sendInvitationObject: SendInvitationObject
Optional options: any
Returns AxiosPromise < any >
projectStore: function
projectStore( projectObject: ProjectObject , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Project/api.ts:1748
Parameters
projectObject: ProjectObject
Optional options: any
Returns AxiosPromise < any >
projectUpdate: function
projectUpdate( id: string , projectObject: ProjectObject , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Project/api.ts:1759
Parameters
id: string
projectObject: ProjectObject
Optional options: any
Returns AxiosPromise < any >
Const ProjectQuotaApi
ProjectQuotaApi: { projectQuotaQuota: any ; projectQuotaQuotas: any ; projectQuotaUpdateQuota: any } = ...
Type declaration
projectQuotaQuota: function
projectQuotaQuota( id: string , resourceTypeId: string , options?: any ) : AxiosPromise < ProjectQuotaExtendedReturnObject >
Defined in Coscine.Api.Project/api.ts:2124
Parameters
id: string
resourceTypeId: string
Optional options: any
Returns AxiosPromise < ProjectQuotaExtendedReturnObject >
projectQuotaQuotas: function
projectQuotaQuotas( id: string , options?: any ) : AxiosPromise < ProjectQuotaReturnObject [] >
Defined in Coscine.Api.Project/api.ts:2134
Parameters
id: string
Optional options: any
Returns AxiosPromise < ProjectQuotaReturnObject [] >
projectQuotaUpdateQuota: function
projectQuotaUpdateQuota( id: string , resourceTypeId: string , updateProjectQuotaObject: UpdateProjectQuotaObject , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Project/api.ts:2146
Parameters
id: string
resourceTypeId: string
updateProjectQuotaObject: UpdateProjectQuotaObject
Optional options: any
Returns AxiosPromise < any >
Const ProjectRoleApi
ProjectRoleApi: { projectRoleDelete: any ; projectRoleDelete2: any ; projectRoleGet: any ; projectRoleIndex: any ; projectRoleSet: any } = ...
Type declaration
projectRoleDelete: function
projectRoleDelete( projectId: string , userId: string , roleId: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Project/api.ts:2487
Parameters
projectId: string
userId: string
roleId: string
Optional options: any
Returns AxiosPromise < any >
projectRoleDelete2: function
projectRoleDelete2( projectId: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Project/api.ts:2497
Parameters
projectId: string
Optional options: any
Returns AxiosPromise < any >
projectRoleGet: function
projectRoleGet( projectId: string , options?: any ) : AxiosPromise < ProjectRoleObject [] >
Defined in Coscine.Api.Project/api.ts:2507
Parameters
projectId: string
Optional options: any
Returns AxiosPromise < ProjectRoleObject [] >
projectRoleIndex: function
projectRoleIndex( projectId: string , options?: any ) : AxiosPromise < ProjectRoleObject [] >
Defined in Coscine.Api.Project/api.ts:2517
Parameters
projectId: string
Optional options: any
Returns AxiosPromise < ProjectRoleObject [] >
projectRoleSet: function
projectRoleSet( projectRoleObject: ProjectRoleObject , options?: any ) : AxiosPromise < ProjectRoleObject >
Defined in Coscine.Api.Project/api.ts:2527
Parameters
projectRoleObject: ProjectRoleObject
Optional options: any
Returns AxiosPromise < ProjectRoleObject >
Const ResourceApi
ResourceApi: { resourceDelete: any ; resourceGet: any ; resourceIndex: any ; resourceIsUserResourceCreator: any ; resourceSetResourceReadonly: any ; resourceStoreToProject: any ; resourceUpdate: any } = ...
Type declaration
resourceDelete: function
resourceDelete( id: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Resources/api.ts:1767
Parameters
id: string
Optional options: any
Returns AxiosPromise < any >
resourceGet: function
resourceGet( id: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Resources/api.ts:1777
Parameters
id: string
Optional options: any
Returns AxiosPromise < any >
resourceIndex: function
resourceIndex( options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Resources/api.ts:1786
Parameters
Returns AxiosPromise < any >
resourceIsUserResourceCreator: function
resourceIsUserResourceCreator( id: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Resources/api.ts:1796
Parameters
id: string
Optional options: any
Returns AxiosPromise < any >
resourceSetResourceReadonly: function
resourceSetResourceReadonly( id: string , status?: boolean , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Resources/api.ts:1807
Parameters
id: string
Optional status: boolean
Optional options: any
Returns AxiosPromise < any >
resourceStoreToProject: function
resourceStoreToProject( projectId: string , resourceObject: ResourceObject , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Resources/api.ts:1818
Parameters
projectId: string
resourceObject: ResourceObject
Optional options: any
Returns AxiosPromise < any >
resourceUpdate: function
resourceUpdate( id: string , resourceObject: ResourceObject , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Resources/api.ts:1829
Parameters
id: string
resourceObject: ResourceObject
Optional options: any
Returns AxiosPromise < any >
Const ResourceQuotaApi
ResourceQuotaApi: { resourceQuotaGetResourceQuota: any ; resourceQuotaUpdateResourceQuota: any } = ...
Type declaration
resourceQuotaGetResourceQuota: function
resourceQuotaGetResourceQuota( id: string , options?: any ) : AxiosPromise < ResourceQuotaReturnObject >
Defined in Coscine.Api.Resources/api.ts:2066
Parameters
id: string
Optional options: any
Returns AxiosPromise < ResourceQuotaReturnObject >
resourceQuotaUpdateResourceQuota: function
resourceQuotaUpdateResourceQuota( id: string , updateResourceObject: UpdateResourceObject , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Resources/api.ts:2077
Parameters
id: string
updateResourceObject: UpdateResourceObject
Optional options: any
Returns AxiosPromise < any >
Const ResourceTypeApi
ResourceTypeApi: { resourceTypeGetEnabledResourceTypes: any ; resourceTypeGetEnabledResourceTypesAll: any ; resourceTypeGetResourceType: any ; resourceTypeGetResourceTypes: any } = ...
Type declaration
resourceTypeGetEnabledResourceTypes: function
resourceTypeGetEnabledResourceTypes( options?: any ) : AxiosPromise < ResourceTypeInformation [] >
Defined in Coscine.Api.Resources/api.ts:2331
Parameters
Returns AxiosPromise < ResourceTypeInformation [] >
resourceTypeGetEnabledResourceTypesAll: function
resourceTypeGetEnabledResourceTypesAll( id: string , options?: any ) : AxiosPromise < ResourceTypeInformation [] >
Defined in Coscine.Api.Resources/api.ts:2341
Parameters
id: string
Optional options: any
Returns AxiosPromise < ResourceTypeInformation [] >
resourceTypeGetResourceType: function
resourceTypeGetResourceType( id: string , options?: any ) : AxiosPromise < ResourceTypeInformation >
Defined in Coscine.Api.Resources/api.ts:2351
Parameters
id: string
Optional options: any
Returns AxiosPromise < ResourceTypeInformation >
resourceTypeGetResourceTypes: function
resourceTypeGetResourceTypes( options?: any ) : AxiosPromise < ResourceTypeInformation [] >
Defined in Coscine.Api.Resources/api.ts:2360
Parameters
Returns AxiosPromise < ResourceTypeInformation [] >
Const RoleApi
RoleApi: { roleIndex: any } = ...
Type declaration
roleIndex: function
roleIndex( options?: any ) : AxiosPromise < RoleObject [] >
Defined in Coscine.Api.Project/api.ts:2679
Parameters
Returns AxiosPromise < RoleObject [] >
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 SubProjectApi
SubProjectApi: { subProjectGet: any ; subProjectGetAccessibleParent: any } = ...
Type declaration
subProjectGet: function
subProjectGet( parentId: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Project/api.ts:2836
Parameters
parentId: string
Optional options: any
Returns AxiosPromise < any >
subProjectGetAccessibleParent: function
subProjectGetAccessibleParent( childId: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Project/api.ts:2847
Parameters
childId: string
Optional options: any
Returns AxiosPromise < any >
Const TOSApi
TOSApi: { tOSAcceptCurrentTOSVersion: any ; tOSAcceptedTOSVersion: any ; tOSGetCurrentTOSVersion: any } = ...
Type declaration
tOSAcceptCurrentTOSVersion: function
tOSAcceptCurrentTOSVersion( options?: any ) : AxiosPromise < string >
Defined in Coscine.Api.User/api.ts:759
Parameters
Returns AxiosPromise < string >
tOSAcceptedTOSVersion: function
tOSAcceptedTOSVersion( options?: any ) : AxiosPromise < Tos >
Defined in Coscine.Api.User/api.ts:768
Parameters
Returns AxiosPromise < Tos >
tOSGetCurrentTOSVersion: function
tOSGetCurrentTOSVersion( options?: any ) : AxiosPromise < string >
Defined in Coscine.Api.User/api.ts:777
Parameters
Returns AxiosPromise < string >
Const TitleApi
TitleApi: { titleIndex: any } = ...
Type declaration
titleIndex: function
titleIndex( options?: any ) : AxiosPromise < TitleObject [] >
Defined in Coscine.Api.User/api.ts:900
Parameters
Returns AxiosPromise < TitleObject [] >
Const TokenApi
TokenApi: { tokenAddToken: any ; tokenGetTokenValidityBounds: any ; tokenGetUserToken: any ; tokenGetUserTokens: any ; tokenRevokeToken: any } = ...
Type declaration
tokenAddToken: function
tokenAddToken( addApiTokenParameter: AddApiTokenParameter , options?: any ) : AxiosPromise < CreatedApiTokenObject >
Defined in Coscine.Api.Token/api.ts:409
Parameters
addApiTokenParameter: AddApiTokenParameter
Optional options: any
Returns AxiosPromise < CreatedApiTokenObject >
tokenGetTokenValidityBounds: function
tokenGetTokenValidityBounds( options?: any ) : AxiosPromise < TokenValidityObject >
Defined in Coscine.Api.Token/api.ts:418
Parameters
Returns AxiosPromise < TokenValidityObject >
tokenGetUserToken: function
tokenGetUserToken( tokenId: string , options?: any ) : AxiosPromise < ApiTokenObject >
Defined in Coscine.Api.Token/api.ts:428
Parameters
tokenId: string
Optional options: any
Returns AxiosPromise < ApiTokenObject >
tokenGetUserTokens: function
tokenGetUserTokens( options?: any ) : AxiosPromise < ApiTokenObject [] >
Defined in Coscine.Api.Token/api.ts:437
Parameters
Returns AxiosPromise < ApiTokenObject [] >
tokenRevokeToken: function
tokenRevokeToken( tokenId: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Token/api.ts:447
Parameters
tokenId: string
Optional options: any
Returns AxiosPromise < any >
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: { userGetUser: any ; userQuery: any ; userSetAndReturnMergeToken: any ; userUpdateUser: any } = ...
Type declaration
userGetUser: function
userGetUser( options?: any ) : AxiosPromise < UserObject >
Defined in Coscine.Api.User/api.ts:1152
Parameters
Returns AxiosPromise < UserObject >
userQuery: function
userQuery( queryString: string , projectId: string , options?: any ) : AxiosPromise < UserObject [] >
Defined in Coscine.Api.User/api.ts:1163
Parameters
queryString: string
projectId: string
Optional options: any
Returns AxiosPromise < UserObject [] >
userSetAndReturnMergeToken: function
userSetAndReturnMergeToken( provider: string , options?: any ) : AxiosPromise < string >
Defined in Coscine.Api.User/api.ts:1173
Parameters
provider: string
Optional options: any
Returns AxiosPromise < string >
userUpdateUser: function
userUpdateUser( userObject: UserObject , options?: any ) : AxiosPromise < number >
Defined in Coscine.Api.User/api.ts:1183
Parameters
userObject: UserObject
Optional options: any
Returns AxiosPromise < number >
Const VisibilityApi
VisibilityApi: { visibilityIndex: any } = ...
Type declaration
visibilityIndex: function
visibilityIndex( options?: any ) : AxiosPromise < VisibilityObject [] >
Defined in Coscine.Api.Project/api.ts:2962
Parameters
Returns AxiosPromise < VisibilityObject [] >
Const default
default: { AccountApi: { accountGetLoginUrls: any ; accountLogout: any } ; AdminApi: { adminGetProject: any ; adminUpdateQuota: any } ; BlobApi: { blobDeleteFileWithParameter: any ; blobGetFileWithParameter: any ; blobUploadFileWithParameter: any } ; ContactChangeApi: { contactChangeChangeContactEmail: any ; contactChangeConfirmContactEmail: any ; contactChangeConfirmationStatus: any } ; DisciplineApi: { disciplineIndex: any } ; GitLabApi: { gitLabGetAllProjects: any ; gitLabGetBranchesForProject: any ; gitLabGetProject: any } ; HomeApi: { homeIndex: any } ; LanguageApi: { languageIndex: any } ; LicenseApi: { licenseIndex: any } ; MergeApi: { mergeCallback: any ; mergeLogin: any } ; MetadataApi: { metadataGetClassInstances: any ; metadataGetProfile: any ; metadataGetProfiles: any ; metadataGetVocabularies: any ; metadataGetVocabulary: any ; metadataSaveApplicationProfile: any } ; NoticeApi: { noticeGetMaintenance: any ; noticeGetNotice: any } ; ORCiDApi: { oRCiDLoginGET: any ; oRCiDLoginPOST: any } ; OrganizationApi: { organizationGetOrganization: any ; organizationGetROR: any ; organizationIndex: any ; organizationIsMember: any ; organizationIsMember2: any } ; PidApi: { pidIsValid: any ; pidSendMailToOwner: any } ; ProjectApi: { projectCreateApplicationProfile: any ; projectDelete: any ; projectDeleteInvitation: any ; projectGet: any ; projectGetBySlug: any ; projectGetResources: any ; projectGetTopLevelProjects: any ; projectIndex: any ; projectListInvitations: any ; projectResolveInvitation: any ; projectSendInvitation: any ; projectStore: any ; projectUpdate: any } ; ProjectQuotaApi: { projectQuotaQuota: any ; projectQuotaQuotas: any ; projectQuotaUpdateQuota: any } ; ProjectRoleApi: { projectRoleDelete: any ; projectRoleDelete2: any ; projectRoleGet: any ; projectRoleIndex: any ; projectRoleSet: any } ; ResourceApi: { resourceDelete: any ; resourceGet: any ; resourceIndex: any ; resourceIsUserResourceCreator: any ; resourceSetResourceReadonly: any ; resourceStoreToProject: any ; resourceUpdate: any } ; ResourceQuotaApi: { resourceQuotaGetResourceQuota: any ; resourceQuotaUpdateResourceQuota: any } ; ResourceTypeApi: { resourceTypeGetEnabledResourceTypes: any ; resourceTypeGetEnabledResourceTypesAll: any ; resourceTypeGetResourceType: any ; resourceTypeGetResourceTypes: any } ; RoleApi: { roleIndex: any } ; SearchApi: { searchSearch: any } ; ShibbolethApi: { shibbolethCallback: any ; shibbolethLogin: any } ; SubProjectApi: { subProjectGet: any ; subProjectGetAccessibleParent: any } ; TOSApi: { tOSAcceptCurrentTOSVersion: any ; tOSAcceptedTOSVersion: any ; tOSGetCurrentTOSVersion: any } ; TitleApi: { titleIndex: any } ; TokenApi: { tokenAddToken: any ; tokenGetTokenValidityBounds: any ; tokenGetUserToken: any ; tokenGetUserTokens: any ; tokenRevokeToken: any } ; TreeApi: { treeGetMetadataWithParameter: any ; treeStoreMetadataForFileWithParameter: any } ; UserApi: { userGetUser: any ; userQuery: any ; userSetAndReturnMergeToken: any ; userUpdateUser: any } ; VisibilityApi: { visibilityIndex: 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 >
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 >
ContactChangeApi: { contactChangeChangeContactEmail: any ; contactChangeConfirmContactEmail: any ; contactChangeConfirmationStatus: any }
contactChangeChangeContactEmail: function
contactChangeChangeContactEmail( body: string , options?: any ) : AxiosPromise < ContactChangeObject >
Defined in Coscine.Api.User/api.ts:428
Parameters
body: string
Optional options: any
Returns AxiosPromise < ContactChangeObject >
contactChangeConfirmContactEmail: function
contactChangeConfirmContactEmail( verification: string , options?: any ) : AxiosPromise < UserObject >
Defined in Coscine.Api.User/api.ts:438
Parameters
verification: string
Optional options: any
Returns AxiosPromise < UserObject >
contactChangeConfirmationStatus: function
contactChangeConfirmationStatus( options?: any ) : AxiosPromise < ContactChangeObject [] >
Defined in Coscine.Api.User/api.ts:447
Parameters
Returns AxiosPromise < ContactChangeObject [] >
DisciplineApi: { disciplineIndex: any }
disciplineIndex: function
disciplineIndex( options?: any ) : AxiosPromise < DisciplineObject [] >
Defined in Coscine.Api.Project/api.ts:855
Parameters
Returns AxiosPromise < DisciplineObject [] >
GitLabApi: { gitLabGetAllProjects: any ; gitLabGetBranchesForProject: any ; gitLabGetProject: any }
gitLabGetAllProjects: function
gitLabGetAllProjects( domain?: string , accessToken?: string , options?: any ) : AxiosPromise < Project [] >
Defined in Coscine.Api.Resources/api.ts:1303
Parameters
Optional domain: string
Optional accessToken: string
Optional options: any
Returns AxiosPromise < Project [] >
gitLabGetBranchesForProject: function
gitLabGetBranchesForProject( projectId: number , domain?: string , accessToken?: string , options?: any ) : AxiosPromise < Branch [] >
Defined in Coscine.Api.Resources/api.ts:1315
Parameters
projectId: number
Optional domain: string
Optional accessToken: string
Optional options: any
Returns AxiosPromise < Branch [] >
gitLabGetProject: function
gitLabGetProject( projectId: number , domain?: string , accessToken?: string , options?: any ) : AxiosPromise < Project >
Defined in Coscine.Api.Resources/api.ts:1327
Parameters
projectId: number
Optional domain: string
Optional accessToken: string
Optional options: any
Returns AxiosPromise < Project >
HomeApi: { homeIndex: any }
homeIndex: function
homeIndex( options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.STS/api.ts:296
Parameters
Returns AxiosPromise < any >
LanguageApi: { languageIndex: any }
languageIndex: function
languageIndex( options?: any ) : AxiosPromise < LanguageObject [] >
Defined in Coscine.Api.User/api.ts:572
Parameters
Returns AxiosPromise < LanguageObject [] >
LicenseApi: { licenseIndex: any }
licenseIndex: function
licenseIndex( options?: any ) : AxiosPromise < LicenseObject [] >
Defined in Coscine.Api.Project/api.ts:956
Parameters
Returns AxiosPromise < LicenseObject [] >
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 >
MetadataApi: { metadataGetClassInstances: any ; metadataGetProfile: any ; metadataGetProfiles: any ; metadataGetVocabularies: any ; metadataGetVocabulary: any ; metadataSaveApplicationProfile: any }
metadataGetClassInstances: function
metadataGetClassInstances( className: string , options?: any ) : AxiosPromise < BilingualLabels >
Defined in Coscine.Api.Metadata/api.ts:407
Parameters
className: string
Optional options: any
Returns AxiosPromise < BilingualLabels >
metadataGetProfile: function
metadataGetProfile( profile: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Metadata/api.ts:417
Parameters
profile: string
Optional options: any
Returns AxiosPromise < any >
metadataGetProfiles: function
metadataGetProfiles( options?: any ) : AxiosPromise < string [] >
Defined in Coscine.Api.Metadata/api.ts:426
Parameters
Returns AxiosPromise < string [] >
metadataGetVocabularies: function
metadataGetVocabularies( options?: any ) : AxiosPromise < string [] >
Defined in Coscine.Api.Metadata/api.ts:435
Parameters
Returns AxiosPromise < string [] >
metadataGetVocabulary: function
metadataGetVocabulary( path: string , options?: any ) : AxiosPromise < BilingualLabels >
Defined in Coscine.Api.Metadata/api.ts:445
Parameters
path: string
Optional options: any
Returns AxiosPromise < BilingualLabels >
metadataSaveApplicationProfile: function
metadataSaveApplicationProfile( applicationProfile: ApplicationProfile , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Metadata/api.ts:455
Parameters
applicationProfile: ApplicationProfile
Optional options: any
Returns AxiosPromise < any >
NoticeApi: { noticeGetMaintenance: any ; noticeGetNotice: any }
noticeGetMaintenance: function
noticeGetMaintenance( options?: any ) : AxiosPromise < MaintenanceReturnObject >
Defined in Coscine.Api.Notices/api.ts:199
Parameters
Returns AxiosPromise < MaintenanceReturnObject >
noticeGetNotice: function
noticeGetNotice( documentSlug: string , language?: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Notices/api.ts:211
Parameters
documentSlug: string
Optional language: 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: { organizationGetOrganization: any ; organizationGetROR: any ; organizationIndex: any ; organizationIsMember: any ; organizationIsMember2: any }
organizationGetOrganization: function
organizationGetOrganization( url: string , options?: any ) : AxiosPromise < WrapperObject >
Defined in Coscine.Api.Organization/api.ts:352
Parameters
url: string
Optional options: any
Returns AxiosPromise < WrapperObject >
organizationGetROR: function
organizationGetROR( filter?: string , options?: any ) : AxiosPromise < WrapperObject >
Defined in Coscine.Api.Organization/api.ts:362
Parameters
Optional filter: string
Optional options: any
Returns AxiosPromise < WrapperObject >
organizationIndex: function
organizationIndex( member?: number , filter?: string , options?: any ) : AxiosPromise < WrapperObject >
Defined in Coscine.Api.Organization/api.ts:373
Parameters
Optional member: number
Optional filter: string
Optional options: any
Returns AxiosPromise < WrapperObject >
organizationIsMember: function
organizationIsMember( url: string , options?: any ) : AxiosPromise < IsMemberObject >
Defined in Coscine.Api.Organization/api.ts:383
Parameters
url: string
Optional options: any
Returns AxiosPromise < IsMemberObject >
organizationIsMember2: function
organizationIsMember2( options?: any ) : AxiosPromise < WrapperObject >
Defined in Coscine.Api.Organization/api.ts:392
Parameters
Returns AxiosPromise < WrapperObject >
PidApi: { pidIsValid: any ; pidSendMailToOwner: any }
pidIsValid: function
pidIsValid( pid: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Pid/api.ts:199
Parameters
pid: string
Optional options: any
Returns AxiosPromise < any >
pidSendMailToOwner: function
pidSendMailToOwner( messageObject: MessageObject , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Pid/api.ts:209
Parameters
messageObject: MessageObject
Optional options: any
Returns AxiosPromise < any >
ProjectApi: { projectCreateApplicationProfile: any ; projectDelete: any ; projectDeleteInvitation: any ; projectGet: any ; projectGetBySlug: any ; projectGetResources: any ; projectGetTopLevelProjects: any ; projectIndex: any ; projectListInvitations: any ; projectResolveInvitation: any ; projectSendInvitation: any ; projectStore: any ; projectUpdate: any }
projectCreateApplicationProfile: function
projectCreateApplicationProfile( projectId: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Project/api.ts:1640
Parameters
projectId: string
Optional options: any
Returns AxiosPromise < any >
projectDelete: function
projectDelete( id: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Project/api.ts:1650
Parameters
id: string
Optional options: any
Returns AxiosPromise < any >
projectDeleteInvitation: function
projectDeleteInvitation( invitationId: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Project/api.ts:1660
Parameters
invitationId: string
Optional options: any
Returns AxiosPromise < any >
projectGet: function
projectGet( id: string , options?: any ) : AxiosPromise < ProjectObject >
Defined in Coscine.Api.Project/api.ts:1670
Parameters
id: string
Optional options: any
Returns AxiosPromise < ProjectObject >
projectGetBySlug: function
projectGetBySlug( slug: string , options?: any ) : AxiosPromise < ProjectObject >
Defined in Coscine.Api.Project/api.ts:1680
Parameters
slug: string
Optional options: any
Returns AxiosPromise < ProjectObject >
projectGetResources: function
projectGetResources( id: string , options?: any ) : AxiosPromise < ResourceObject [] >
Defined in Coscine.Api.Project/api.ts:1690
Parameters
id: string
Optional options: any
Returns AxiosPromise < ResourceObject [] >
projectGetTopLevelProjects: function
projectGetTopLevelProjects( options?: any ) : AxiosPromise < ProjectObject [] >
Defined in Coscine.Api.Project/api.ts:1699
Parameters
Returns AxiosPromise < ProjectObject [] >
projectIndex: function
projectIndex( options?: any ) : AxiosPromise < ProjectObject [] >
Defined in Coscine.Api.Project/api.ts:1708
Parameters
Returns AxiosPromise < ProjectObject [] >
projectListInvitations: function
projectListInvitations( projectId: string , options?: any ) : AxiosPromise < InvitationReturnObject [] >
Defined in Coscine.Api.Project/api.ts:1718
Parameters
projectId: string
Optional options: any
Returns AxiosPromise < InvitationReturnObject [] >
projectResolveInvitation: function
projectResolveInvitation( invitationToken: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Project/api.ts:1728
Parameters
invitationToken: string
Optional options: any
Returns AxiosPromise < any >
projectSendInvitation: function
projectSendInvitation( sendInvitationObject: SendInvitationObject , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Project/api.ts:1738
Parameters
sendInvitationObject: SendInvitationObject
Optional options: any
Returns AxiosPromise < any >
projectStore: function
projectStore( projectObject: ProjectObject , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Project/api.ts:1748
Parameters
projectObject: ProjectObject
Optional options: any
Returns AxiosPromise < any >
projectUpdate: function
projectUpdate( id: string , projectObject: ProjectObject , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Project/api.ts:1759
Parameters
id: string
projectObject: ProjectObject
Optional options: any
Returns AxiosPromise < any >
ProjectQuotaApi: { projectQuotaQuota: any ; projectQuotaQuotas: any ; projectQuotaUpdateQuota: any }
projectQuotaQuota: function
projectQuotaQuota( id: string , resourceTypeId: string , options?: any ) : AxiosPromise < ProjectQuotaExtendedReturnObject >
Defined in Coscine.Api.Project/api.ts:2124
Parameters
id: string
resourceTypeId: string
Optional options: any
Returns AxiosPromise < ProjectQuotaExtendedReturnObject >
projectQuotaQuotas: function
projectQuotaQuotas( id: string , options?: any ) : AxiosPromise < ProjectQuotaReturnObject [] >
Defined in Coscine.Api.Project/api.ts:2134
Parameters
id: string
Optional options: any
Returns AxiosPromise < ProjectQuotaReturnObject [] >
projectQuotaUpdateQuota: function
projectQuotaUpdateQuota( id: string , resourceTypeId: string , updateProjectQuotaObject: UpdateProjectQuotaObject , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Project/api.ts:2146
Parameters
id: string
resourceTypeId: string
updateProjectQuotaObject: UpdateProjectQuotaObject
Optional options: any
Returns AxiosPromise < any >
ProjectRoleApi: { projectRoleDelete: any ; projectRoleDelete2: any ; projectRoleGet: any ; projectRoleIndex: any ; projectRoleSet: any }
projectRoleDelete: function
projectRoleDelete( projectId: string , userId: string , roleId: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Project/api.ts:2487
Parameters
projectId: string
userId: string
roleId: string
Optional options: any
Returns AxiosPromise < any >
projectRoleDelete2: function
projectRoleDelete2( projectId: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Project/api.ts:2497
Parameters
projectId: string
Optional options: any
Returns AxiosPromise < any >
projectRoleGet: function
projectRoleGet( projectId: string , options?: any ) : AxiosPromise < ProjectRoleObject [] >
Defined in Coscine.Api.Project/api.ts:2507
Parameters
projectId: string
Optional options: any
Returns AxiosPromise < ProjectRoleObject [] >
projectRoleIndex: function
projectRoleIndex( projectId: string , options?: any ) : AxiosPromise < ProjectRoleObject [] >
Defined in Coscine.Api.Project/api.ts:2517
Parameters
projectId: string
Optional options: any
Returns AxiosPromise < ProjectRoleObject [] >
projectRoleSet: function
projectRoleSet( projectRoleObject: ProjectRoleObject , options?: any ) : AxiosPromise < ProjectRoleObject >
Defined in Coscine.Api.Project/api.ts:2527
Parameters
projectRoleObject: ProjectRoleObject
Optional options: any
Returns AxiosPromise < ProjectRoleObject >
ResourceApi: { resourceDelete: any ; resourceGet: any ; resourceIndex: any ; resourceIsUserResourceCreator: any ; resourceSetResourceReadonly: any ; resourceStoreToProject: any ; resourceUpdate: any }
resourceDelete: function
resourceDelete( id: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Resources/api.ts:1767
Parameters
id: string
Optional options: any
Returns AxiosPromise < any >
resourceGet: function
resourceGet( id: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Resources/api.ts:1777
Parameters
id: string
Optional options: any
Returns AxiosPromise < any >
resourceIndex: function
resourceIndex( options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Resources/api.ts:1786
Parameters
Returns AxiosPromise < any >
resourceIsUserResourceCreator: function
resourceIsUserResourceCreator( id: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Resources/api.ts:1796
Parameters
id: string
Optional options: any
Returns AxiosPromise < any >
resourceSetResourceReadonly: function
resourceSetResourceReadonly( id: string , status?: boolean , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Resources/api.ts:1807
Parameters
id: string
Optional status: boolean
Optional options: any
Returns AxiosPromise < any >
resourceStoreToProject: function
resourceStoreToProject( projectId: string , resourceObject: ResourceObject , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Resources/api.ts:1818
Parameters
projectId: string
resourceObject: ResourceObject
Optional options: any
Returns AxiosPromise < any >
resourceUpdate: function
resourceUpdate( id: string , resourceObject: ResourceObject , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Resources/api.ts:1829
Parameters
id: string
resourceObject: ResourceObject
Optional options: any
Returns AxiosPromise < any >
ResourceQuotaApi: { resourceQuotaGetResourceQuota: any ; resourceQuotaUpdateResourceQuota: any }
resourceQuotaGetResourceQuota: function
resourceQuotaGetResourceQuota( id: string , options?: any ) : AxiosPromise < ResourceQuotaReturnObject >
Defined in Coscine.Api.Resources/api.ts:2066
Parameters
id: string
Optional options: any
Returns AxiosPromise < ResourceQuotaReturnObject >
resourceQuotaUpdateResourceQuota: function
resourceQuotaUpdateResourceQuota( id: string , updateResourceObject: UpdateResourceObject , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Resources/api.ts:2077
Parameters
id: string
updateResourceObject: UpdateResourceObject
Optional options: any
Returns AxiosPromise < any >
ResourceTypeApi: { resourceTypeGetEnabledResourceTypes: any ; resourceTypeGetEnabledResourceTypesAll: any ; resourceTypeGetResourceType: any ; resourceTypeGetResourceTypes: any }
resourceTypeGetEnabledResourceTypes: function
resourceTypeGetEnabledResourceTypes( options?: any ) : AxiosPromise < ResourceTypeInformation [] >
Defined in Coscine.Api.Resources/api.ts:2331
Parameters
Returns AxiosPromise < ResourceTypeInformation [] >
resourceTypeGetEnabledResourceTypesAll: function
resourceTypeGetEnabledResourceTypesAll( id: string , options?: any ) : AxiosPromise < ResourceTypeInformation [] >
Defined in Coscine.Api.Resources/api.ts:2341
Parameters
id: string
Optional options: any
Returns AxiosPromise < ResourceTypeInformation [] >
resourceTypeGetResourceType: function
resourceTypeGetResourceType( id: string , options?: any ) : AxiosPromise < ResourceTypeInformation >
Defined in Coscine.Api.Resources/api.ts:2351
Parameters
id: string
Optional options: any
Returns AxiosPromise < ResourceTypeInformation >
resourceTypeGetResourceTypes: function
resourceTypeGetResourceTypes( options?: any ) : AxiosPromise < ResourceTypeInformation [] >
Defined in Coscine.Api.Resources/api.ts:2360
Parameters
Returns AxiosPromise < ResourceTypeInformation [] >
RoleApi: { roleIndex: any }
roleIndex: function
roleIndex( options?: any ) : AxiosPromise < RoleObject [] >
Defined in Coscine.Api.Project/api.ts:2679
Parameters
Returns AxiosPromise < RoleObject [] >
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 >
SubProjectApi: { subProjectGet: any ; subProjectGetAccessibleParent: any }
subProjectGet: function
subProjectGet( parentId: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Project/api.ts:2836
Parameters
parentId: string
Optional options: any
Returns AxiosPromise < any >
subProjectGetAccessibleParent: function
subProjectGetAccessibleParent( childId: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Project/api.ts:2847
Parameters
childId: string
Optional options: any
Returns AxiosPromise < any >
TOSApi: { tOSAcceptCurrentTOSVersion: any ; tOSAcceptedTOSVersion: any ; tOSGetCurrentTOSVersion: any }
tOSAcceptCurrentTOSVersion: function
tOSAcceptCurrentTOSVersion( options?: any ) : AxiosPromise < string >
Defined in Coscine.Api.User/api.ts:759
Parameters
Returns AxiosPromise < string >
tOSAcceptedTOSVersion: function
tOSAcceptedTOSVersion( options?: any ) : AxiosPromise < Tos >
Defined in Coscine.Api.User/api.ts:768
Parameters
Returns AxiosPromise < Tos >
tOSGetCurrentTOSVersion: function
tOSGetCurrentTOSVersion( options?: any ) : AxiosPromise < string >
Defined in Coscine.Api.User/api.ts:777
Parameters
Returns AxiosPromise < string >
TitleApi: { titleIndex: any }
titleIndex: function
titleIndex( options?: any ) : AxiosPromise < TitleObject [] >
Defined in Coscine.Api.User/api.ts:900
Parameters
Returns AxiosPromise < TitleObject [] >
TokenApi: { tokenAddToken: any ; tokenGetTokenValidityBounds: any ; tokenGetUserToken: any ; tokenGetUserTokens: any ; tokenRevokeToken: any }
tokenAddToken: function
tokenAddToken( addApiTokenParameter: AddApiTokenParameter , options?: any ) : AxiosPromise < CreatedApiTokenObject >
Defined in Coscine.Api.Token/api.ts:409
Parameters
addApiTokenParameter: AddApiTokenParameter
Optional options: any
Returns AxiosPromise < CreatedApiTokenObject >
tokenGetTokenValidityBounds: function
tokenGetTokenValidityBounds( options?: any ) : AxiosPromise < TokenValidityObject >
Defined in Coscine.Api.Token/api.ts:418
Parameters
Returns AxiosPromise < TokenValidityObject >
tokenGetUserToken: function
tokenGetUserToken( tokenId: string , options?: any ) : AxiosPromise < ApiTokenObject >
Defined in Coscine.Api.Token/api.ts:428
Parameters
tokenId: string
Optional options: any
Returns AxiosPromise < ApiTokenObject >
tokenGetUserTokens: function
tokenGetUserTokens( options?: any ) : AxiosPromise < ApiTokenObject [] >
Defined in Coscine.Api.Token/api.ts:437
Parameters
Returns AxiosPromise < ApiTokenObject [] >
tokenRevokeToken: function
tokenRevokeToken( tokenId: string , options?: any ) : AxiosPromise < any >
Defined in Coscine.Api.Token/api.ts:447
Parameters
tokenId: string
Optional options: any
Returns AxiosPromise < any >
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: { userGetUser: any ; userQuery: any ; userSetAndReturnMergeToken: any ; userUpdateUser: any }
userGetUser: function
userGetUser( options?: any ) : AxiosPromise < UserObject >
Defined in Coscine.Api.User/api.ts:1152
Parameters
Returns AxiosPromise < UserObject >
userQuery: function
userQuery( queryString: string , projectId: string , options?: any ) : AxiosPromise < UserObject [] >
Defined in Coscine.Api.User/api.ts:1163
Parameters
queryString: string
projectId: string
Optional options: any
Returns AxiosPromise < UserObject [] >
userSetAndReturnMergeToken: function
userSetAndReturnMergeToken( provider: string , options?: any ) : AxiosPromise < string >
Defined in Coscine.Api.User/api.ts:1173
Parameters
provider: string
Optional options: any
Returns AxiosPromise < string >
userUpdateUser: function
userUpdateUser( userObject: UserObject , options?: any ) : AxiosPromise < number >
Defined in Coscine.Api.User/api.ts:1183
Parameters
userObject: UserObject
Optional options: any
Returns AxiosPromise < number >
VisibilityApi: { visibilityIndex: any }
visibilityIndex: function
visibilityIndex( options?: any ) : AxiosPromise < VisibilityObject [] >
Defined in Coscine.Api.Project/api.ts:2962
Parameters
Returns AxiosPromise < VisibilityObject [] >
Return relevant URLs for logging the user in
{RequiredError}