Developer Guide
API Reference
jobs.terminatejobs.retrieveUtilizationjobs.followjobs.extendjobs.suspendjobs.openInteractiveSessionjobs.createjobs.retrieveProductsjobs.retrievejobs.browsejobs.searchjobs.initjobs.updateAclingresses.createingresses.retrieveingresses.retrieveProductsingresses.deleteingresses.searchingresses.browseingresses.initingresses.updateAcljobs.compute.PROVIDERID.shell.opennetworkips.provider.PROVIDERID.updateFirewallnetworkips.provider.PROVIDERID.deletenetworkips.provider.PROVIDERID.createnetworkips.provider.PROVIDERID.initnetworkips.provider.PROVIDERID.retrieveProductsnetworkips.provider.PROVIDERID.updateAclnetworkips.provider.PROVIDERID.verifyproject.createproject.viewMemberInProjectproject.inviteproject.acceptInviteproject.rejectInviteproject.listIngoingInvitesproject.listOutgoingInvitesproject.transferPiRoleproject.leaveProjectproject.deleteMemberproject.changeUserRoleproject.listFavoriteProjectsproject.listProjectsproject.viewProjectproject.verifyMembershipproject.archiveproject.archiveBulkproject.existsproject.listSubProjectsproject.countSubProjectsproject.viewAncestorsproject.lookupByPathproject.lookupByIdproject.lookupByIdBulkproject.lookupPrincipalInvestigatorproject.renameproject.toggleRenamingproject.allowsRenamingproject.allowsSubProjectRenamingproject.updateDataManagementPlanproject.fetchDataManagementPlanproject.searchgifts.claimGiftgifts.availableGiftsgifts.createGiftgifts.deleteGiftexample.provider.PROVIDERID.deleteexample.provider.PROVIDERID.createexample.provider.PROVIDERID.initexample.provider.PROVIDERID.retrieveProductsexample.provider.PROVIDERID.updateAclexample.provider.PROVIDERID.verifyaccounting.visualization.retrieveUsageaccounting.visualization.retrieveBreakdownshares.control.browseshares.control.chargeCreditsshares.control.checkCreditsshares.control.registershares.control.retrieveshares.control.updatemail.sendSupportmail.sendToUsermail.toggleEmailSettingsmail.retrieveEmailSettingsproject.members.userStatusproject.members.searchproject.members.countproject.members.lookupAdminsproject.members.lookupAdminsBulkingresses.provider.PROVIDERID.deleteingresses.provider.PROVIDERID.createingresses.provider.PROVIDERID.initingresses.provider.PROVIDERID.retrieveProductsingresses.provider.PROVIDERID.updateAclingresses.provider.PROVIDERID.verifyfiles.metadata.createfiles.metadata.moveMetadatafiles.metadata.deletefiles.metadata.retrieveAllfiles.metadata.approvefiles.metadata.rejectfiles.metadata.browsetask.listtask.viewtask.listentask.createtask.postStatustask.markAsCompleteslack.sendAlertslack.sendSupportlicenses.control.browselicenses.control.chargeCreditslicenses.control.checkCreditslicenses.control.registerlicenses.control.retrievelicenses.control.updatefiles.collections.control.browsefiles.collections.control.chargeCreditsfiles.collections.control.checkCreditsfiles.collections.control.registerfiles.collections.control.retrievefiles.collections.control.updatefiles.provider.PROVIDERID.browsefiles.provider.PROVIDERID.retrievefiles.provider.PROVIDERID.movefiles.provider.PROVIDERID.copyfiles.provider.PROVIDERID.createFolderfiles.provider.PROVIDERID.trashfiles.provider.PROVIDERID.emptyTrashfiles.provider.PROVIDERID.createUploadfiles.provider.PROVIDERID.createDownloadfiles.provider.PROVIDERID.searchfiles.provider.PROVIDERID.deletefiles.provider.PROVIDERID.createfiles.provider.PROVIDERID.initfiles.provider.PROVIDERID.retrieveProductsfiles.provider.PROVIDERID.updateAclfiles.provider.PROVIDERID.verifyjobs.provider.PROVIDERID.extendjobs.provider.PROVIDERID.terminatejobs.provider.PROVIDERID.suspendjobs.provider.PROVIDERID.followjobs.provider.PROVIDERID.openInteractiveSessionjobs.provider.PROVIDERID.retrieveUtilizationjobs.provider.PROVIDERID.retrieveProductsjobs.provider.PROVIDERID.createjobs.provider.PROVIDERID.verifyjobs.provider.PROVIDERID.initjobs.provider.PROVIDERID.updateAclproducts.createproducts.retrieveproducts.browselicenses.provider.PROVIDERID.deletelicenses.provider.PROVIDERID.createlicenses.provider.PROVIDERID.initlicenses.provider.PROVIDERID.retrieveProductslicenses.provider.PROVIDERID.updateAcllicenses.provider.PROVIDERID.verifylicenses.createlicenses.retrieveProductslicenses.retrievelicenses.deletelicenses.searchlicenses.browselicenses.initlicenses.updateAclnetworkips.control.browsenetworkips.control.chargeCreditsnetworkips.control.checkCreditsnetworkips.control.registernetworkips.control.retrievenetworkips.control.updateavatar.updateavatar.findAvataravatar.findBulkgrant.submitApplicationgrant.editApplicationgrant.closeApplicationgrant.transferApplicationgrant.browseProjectsgrant.retrieveAffiliationsgrant.viewApplicationfiles.control.addUpdatefiles.control.markAsCompleteshares.approveshares.rejectshares.updatePermissionsshares.browseOutgoingshares.createshares.browseshares.deleteshares.searchshares.initshares.retrieveshares.retrieveProductsshares.updateAclauth.twofactor.createCredentialsauth.twofactor.answerChallengeauth.twofactor.twoFactorStatusnotifications.listnotifications.markAsReadnotifications.markAllAsReadnotifications.createnotifications.deletenotifications.subscriptionnotifications.internalNotificationsupport.createTicketfiles.metadataTemplates.createTemplatefiles.metadataTemplates.retrieveLatestfiles.metadataTemplates.retrieveTemplatefiles.metadataTemplates.browseTemplatesfiles.metadataTemplates.deprecatefiles.metadataTemplates.browsefiles.metadataTemplates.createfiles.metadataTemplates.initfiles.metadataTemplates.retrievefiles.metadataTemplates.retrieveProductsfiles.metadataTemplates.updateAclauth.users.createNewUserauth.users.updateUserInfoauth.users.getUserInfoauth.users.retrievePrincipalauth.users.changePasswordauth.users.changePasswordWithResetauth.users.lookupUsersauth.users.lookupEmailauth.users.lookupUserWithEmailauth.users.openUserIteratorauth.users.fetchNextIteratorauth.users.closeIteratorproject.group.createproject.group.listGroupsWithSummaryproject.group.listAllGroupMembersproject.group.deleteproject.group.addGroupMemberproject.group.removeGroupMemberproject.group.updateGroupNameproject.group.listGroupMembersproject.group.isMemberproject.group.groupExistsproject.group.countproject.group.viewproject.group.lookupByTitleproject.group.lookupProjectAndGroupproject.group.listAllGroupIdsAndTitlesproviders.renewTokenproviders.retrieveSpecificationproviders.requestApprovalproviders.approveproviders.retrieveproviders.browseproviders.createproviders.searchproviders.initproviders.updateAclnetworkips.updateFirewallnetworkips.retrieveProductsnetworkips.createnetworkips.retrievenetworkips.deletenetworkips.searchnetworkips.browsenetworkips.initnetworkips.updateAcljobs.control.updatejobs.control.chargeCreditsjobs.control.browsejobs.control.checkCreditsjobs.control.registerjobs.control.retrievesla.findsla.acceptproject.favorite.toggleFavoritePROVIDERID.uploadChunkaccounting.chargeaccounting.depositaccounting.transferaccounting.updateAllocationaccounting.checkaccounting.rootDepositauth.refreshauth.webRefreshauth.bulkInvalidateauth.logoutauth.webLogoutauth.claimauth.requestOneTimeTokenWithAudienceauth.tokenExtensionauth.passwordLoginauth.listUserSessionsauth.invalidateSessionspassword.reset.resetpassword.reset.newPasswordexample.createexample.deleteexample.searchexample.browseexample.retrieveexample.retrieveProductsexample.updateAclexample.initexample.control.retrieveexample.control.browseexample.control.chargeCreditsexample.control.checkCreditsexample.control.registerexample.control.updatefiles.collections.renamefiles.collections.retrievefiles.collections.retrieveProductsfiles.collections.browsefiles.collections.createfiles.collections.deletefiles.collections.searchfiles.collections.initfiles.collections.updateAclhpc.tools.findByNameAndVersionhpc.tools.findByNamehpc.tools.listAllhpc.tools.createhpc.tools.uploadLogohpc.tools.clearLogohpc.tools.fetchLogohpc.apps.toggleFavoritehpc.apps.retrieveFavoriteshpc.apps.searchTagshpc.apps.searchAppshpc.apps.findByNamehpc.apps.isPublichpc.apps.setPublichpc.apps.advancedSearchhpc.apps.findByNameAndVersionhpc.apps.hasPermissionhpc.apps.listAclhpc.apps.updateAclhpc.apps.findBySupportedFileExtensionhpc.apps.findLatestByToolhpc.apps.listAllhpc.apps.createhpc.apps.deletehpc.apps.createTaghpc.apps.removeTaghpc.apps.uploadLogohpc.apps.clearLogohpc.apps.fetchLogoingresses.control.browseingresses.control.chargeCreditsingresses.control.checkCreditsingresses.control.registeringresses.control.retrieveingresses.control.updateauth.providers.registerauth.providers.claimauth.providers.renewauth.providers.refreshauth.providers.retrievePublicKeyauth.providers.refreshAsOrchestratorauth.providers.generateKeyPairfiles.collections.provider.PROVIDERID.renamefiles.collections.provider.PROVIDERID.deletefiles.collections.provider.PROVIDERID.createfiles.collections.provider.PROVIDERID.initfiles.collections.provider.PROVIDERID.retrieveProductsfiles.collections.provider.PROVIDERID.updateAclfiles.collections.provider.PROVIDERID.verifyaccounting.wallets.pushaccounting.wallets.registeraccounting.wallets.browseaccounting.wallets.searchSubAllocationsaccounting.wallets.browseSubAllocationsaccounting.wallets.retrieveRecipientnews.newPostnews.updatePostnews.deletePostnews.togglePostHiddennews.listCategoriesnews.listPostsnews.listDowntimesnews.getPostByfiles.movefiles.copyfiles.createUploadfiles.createDownloadfiles.createFolderfiles.trashfiles.emptyTrashfiles.browsefiles.retrievefiles.deletefiles.retrieveProductsfiles.updateAclfiles.searchfiles.initshares.provider.PROVIDERID.deleteshares.provider.PROVIDERID.createshares.provider.PROVIDERID.initshares.provider.PROVIDERID.retrieveProductsshares.provider.PROVIDERID.updateAclshares.provider.PROVIDERID.verifygifts.claimGiftgifts.claimGift¶
Claims a Gift to the calling user’s personal project
| Request | Response | Error |
|---|---|---|
ClaimGiftRequest |
Unit |
CommonErrorMessage |
User errors:
Users who are not eligible for claiming this Gift will receive an appropriate error code.
If the gifting project has run out of resources then this endpoint will fail. The gift will not be marked as claimed.
