{"swaggerDoc":{"basePath":"/api-ipa","definitions":{"HealthCheckResponse":{"description":"","properties":{"apiServer":{"type":"string","description":""},"rw2Server":{"type":"string","description":""},"mongo":{"type":"string","description":""},"elasticsearch":{"type":"string","description":""}},"type":"object","required":["apiServer","rw2Server","mongo","elasticsearch"]},"FolderInfo":{"description":"","properties":{"id":{"type":"string","description":""},"userId":{"type":"string","description":""},"name":{"type":"string","description":""},"created":{"type":"string","description":""},"lastModified":{"type":"string","description":""},"position":{"type":"number","format":"double","description":""},"isShared":{"type":"boolean","description":""},"isExampleCollection":{"type":"boolean","description":""},"isMypublicationsCollection":{"type":"boolean","description":""}},"type":"object","required":["id","userId","name","created","lastModified","position","isShared","isExampleCollection","isMypublicationsCollection"]},"ErrorModel":{"description":"","properties":{"serverErrorTime":{"type":"string","format":"date-time","description":""},"message":{"type":"string","description":""},"error":{"type":"string","description":""}},"type":"object","required":["serverErrorTime","message","error"]},"FolderRequest":{"description":"","properties":{"name":{"type":"string","description":""},"parentId":{"type":"string","description":""},"projectId":{"type":"string","description":""}},"type":"object","required":["name"]},"FoldersReferencesRequest":{"description":"","properties":{"folderIds":{"type":"array","items":{"type":"string"},"description":""},"referenceIds":{"type":"array","items":{"type":"string"},"description":""},"action":{"type":"string","description":""}},"type":"object","required":["folderIds","referenceIds","action"]},"FolderName":{"description":"","properties":{"name":{"type":"string","description":""}},"type":"object","required":["name"]},"FolderPublicInfo":{"description":"","properties":{"folderId":{"type":"string","description":""},"publicId":{"type":"string","description":""},"hasFullTextLinker":{"type":"boolean","description":""}},"type":"object","required":["folderId","publicId","hasFullTextLinker"]},"CreateSessionRequest":{"description":"","properties":{"userName":{"type":"string","description":""},"password":{"type":"string","description":""},"system":{"enum":["RW3","RW2"],"type":"string","description":""}},"type":"object","required":["userName","password","system"]},"CreateSessionRequestSSO":{"description":"","properties":{"user":{"type":"string","description":""},"provider":{"type":"string","description":""},"token":{"type":"string","description":""}},"type":"object","required":["user","provider","token"]},"InstitutionUserModel":{"description":"","properties":{"_id":{"type":"string","description":""},"creationDate":{"type":"integer","format":"int64","description":""},"lastModified":{"type":"integer","format":"int64","description":""},"discountGroupId":{"type":"string","description":""},"email":{"type":"string","description":""},"emailSent":{"type":"string","description":""},"isInstitutionAdmin":{"type":"boolean","description":""},"lastActive":{"type":"integer","format":"int64","description":""},"disabled":{"type":"boolean","description":""},"firstName":{"type":"string","description":""},"lastName":{"type":"string","description":""},"status":{"type":"string","description":""},"id":{"type":"string","description":""}},"type":"object","required":["_id","creationDate","lastModified","discountGroupId","email","emailSent","isInstitutionAdmin","lastActive","disabled","firstName","lastName","status","id"]},"InstitutionUsersResponse":{"description":"","properties":{"start":{"type":"integer","format":"int32","description":""},"length":{"type":"integer","format":"int32","description":""},"totalCount":{"type":"integer","format":"int32","description":""},"users":{"type":"array","items":{"$ref":"#/definitions/InstitutionUserModel"},"description":""}},"type":"object","required":["start","length","totalCount","users"]},"UserResponse":{"description":"","properties":{"id":{"type":"string","description":""},"email":{"type":"string","description":""},"currentProjectId":{"type":"string","description":""},"firstName":{"type":"string","description":""},"lastName":{"type":"string","description":""},"institutionId":{"type":"string","description":""},"language":{"type":"string","description":""}},"type":"object","required":["id","email","currentProjectId","firstName","lastName","institutionId","language"]},"InstitutionModel":{"description":"","properties":{"_id":{"type":"string","description":""},"institutionName":{"type":"string","description":""},"code":{"type":"string","description":""}},"type":"object","required":["_id","institutionName","code"]},"UserLanguage":{"description":"","properties":{"language":{"type":"string","description":""}},"type":"object","required":["language"]},"UserAttribute":{"description":"","properties":{"attribute":{"type":"string","description":""},"value":{"type":"string","description":""},"type":{"enum":["BOOLEAN","STRING","LONG"],"type":"string","description":""}},"type":"object","required":["attribute","value","type"]},"UserBulkActionResponse":{"description":"","properties":{"modifiedCount":{"type":"integer","format":"int32","description":""},"matchedCount":{"type":"integer","format":"int32","description":""}},"type":"object","required":["modifiedCount","matchedCount"]},"UserBulkActionRequest":{"description":"","properties":{"action":{"enum":["ACTIVE","INACTIVE","MAKE_ADMIN","REVOKE_ADMIN"],"type":"string","description":""},"all":{"type":"boolean","description":""},"users":{"type":"array","items":{"type":"string"},"description":""}},"type":"object","required":["action","all","users"]},"Number":{"description":"An object that represents a number of any kind. All JavaScript numbers are 64-bit floating-point numbers.","properties":{},"type":"object"},"PrivacyChallengeUpdateResponse":{"description":"","properties":{"_id":{"type":"string","description":""},"userId":{"type":"string","description":""},"institutionId":{"type":"string","description":""},"created":{"$ref":"#/definitions/Number"},"accepted":{"type":"boolean","description":""},"message":{"type":"string","description":""},"error":{"type":"boolean","description":""}},"type":"object"},"AuthorDisambiguationRequest":{"description":"","properties":{"authorDisambiguation":{"type":"string","description":""}},"type":"object","required":["authorDisambiguation"]},"GoogleAppsInviteRequest":{"description":"","properties":{"targetEmail":{"type":"string","description":""},"googleDocId":{"type":"string","description":""}},"type":"object","required":["targetEmail","googleDocId"]},"ErrorReportResponse":{"description":"","properties":{"reportId":{"type":"string","description":""},"checksum":{"type":"string","description":""}},"type":"object","required":["reportId","checksum"]},"ClientApp":{"description":"Metadata for apps that call RefWorks","properties":{"name":{"type":"string","description":""},"version":{"type":"string","description":""},"officeVersion":{"type":"string","description":""}},"type":"object","required":["name","version","officeVersion"]},"Platform":{"description":"","properties":{"name":{"enum":["WINDOWS","MAC"],"type":"string","description":""},"version":{"type":"string","description":""},"architecture":{"type":"string","description":""}},"type":"object","required":["name","version","architecture"]},"ErrorReportRequest":{"description":"","properties":{"userId":{"type":"string","description":""},"app":{"$ref":"#/definitions/ClientApp"},"platform":{"$ref":"#/definitions/Platform"},"userDescription":{"type":"string","description":""}},"type":"object","required":["userId","app","platform","userDescription"]},"UsageReportResponse":{"description":"","properties":{"reportId":{"type":"string","description":""}},"type":"object","required":["reportId"]},"UsageReportRequest":{"description":"","properties":{"app":{"$ref":"#/definitions/ClientApp"},"platform":{"$ref":"#/definitions/Platform"},"language":{"type":"string","description":""},"javaVersion":{"type":"string","description":""},"defaultBrowser":{"type":"string","description":""},"browserVersion":{"type":"string","description":""}},"type":"object","required":["app","platform","language","javaVersion","defaultBrowser","browserVersion"]},"Contributor":{"description":"","properties":{"rawName":{"type":"string","description":""},"lastName":{"type":"string","description":""},"firstNames":{"type":"array","items":{"type":"string"},"description":""}},"type":"object"},"ISSN":{"description":"","properties":{"id":{"type":"string","description":""}},"type":"object","required":["id"]},"ISBN":{"description":"","properties":{"id":{"type":"string","description":""}},"type":"object","required":["id"]},"SSId":{"description":"","properties":{"id":{"type":"string","description":""}},"type":"object","required":["id"]},"Publication":{"description":"","properties":{"title":{"type":"string","description":""},"editors":{"type":"array","items":{"$ref":"#/definitions/Contributor"},"description":""},"issn":{"$ref":"#/definitions/ISSN"},"isbn":{"$ref":"#/definitions/ISBN"},"ssid":{"$ref":"#/definitions/SSId"},"abbrev":{"type":"string","description":""},"latLon":{"type":"string","description":""},"scale":{"type":"string","description":""},"geographicLocation":{"type":"string","description":""}},"type":"object","required":["editors"]},"Series":{"description":"","properties":{"title":{"type":"string","description":""},"edition":{"type":"string","description":""},"editors":{"type":"array","items":{"$ref":"#/definitions/Contributor"},"description":""},"volume":{"type":"string","description":""},"issue":{"type":"string","description":""}},"type":"object","required":["editors"]},"Contributors":{"description":"","properties":{"authorAffiliation":{"type":"string","description":""},"editors":{"type":"array","items":{"$ref":"#/definitions/Contributor"},"description":""},"compilers":{"type":"array","items":{"$ref":"#/definitions/Contributor"},"description":""},"translators":{"type":"array","items":{"$ref":"#/definitions/Contributor"},"description":""},"performers":{"type":"array","items":{"$ref":"#/definitions/Contributor"},"description":""},"producers":{"type":"array","items":{"$ref":"#/definitions/Contributor"},"description":""},"conductors":{"type":"array","items":{"$ref":"#/definitions/Contributor"},"description":""},"recipients":{"type":"array","items":{"$ref":"#/definitions/Contributor"},"description":""},"assignees":{"type":"array","items":{"$ref":"#/definitions/Contributor"},"description":""}},"type":"object","required":["editors","compilers","translators","performers","producers","conductors","recipients","assignees"]},"Legal":{"description":"","properties":{"legislativeBody":{"type":"string","description":""},"legislativeSession":{"type":"string","description":""},"historicalTitle":{"type":"string","description":""},"docNumber":{"type":"string","description":""},"sectionNumber":{"type":"string","description":""},"jurisdiction":{"type":"string","description":""},"lawType":{"type":"string","description":""},"sequenceNumber":{"type":"string","description":""},"committee":{"type":"string","description":""},"subcommittee":{"type":"string","description":""}},"type":"object"},"Pages":{"description":"","properties":{"startPage":{"type":"string","description":""},"rawPages":{"type":"string","description":""},"totalPages":{"type":"string","description":""}},"type":"object"},"Publisher":{"description":"","properties":{"name":{"type":"string","description":""},"location":{"type":"string","description":""},"department":{"type":"string","description":""},"degreeType":{"type":"string","description":""}},"type":"object"},"PubMedId":{"description":"","properties":{"id":{"type":"string","description":""}},"type":"object","required":["id"]},"PubMedCentralId":{"description":"","properties":{"id":{"type":"string","description":""}},"type":"object","required":["id"]},"DOI":{"description":"","properties":{"id":{"type":"string","description":""}},"type":"object","required":["id"]},"SummonGoId":{"description":"","properties":{"id":{"type":"string","description":""}},"type":"object","required":["id"]},"ArXivId":{"description":"","properties":{"id":{"type":"string","description":""}},"type":"object","required":["id"]},"LoCCallNumber":{"description":"","properties":{"id":{"type":"string","description":""}},"type":"object","required":["id"]},"SummonId":{"description":"","properties":{"id":{"type":"string","description":""}},"type":"object","required":["id"]},"PdsPubId":{"description":"","properties":{"id":{"type":"string","description":""}},"type":"object","required":["id"]},"PatentNumber":{"description":"","properties":{"id":{"type":"string","description":""}},"type":"object","required":["id"]},"RegistryNumber":{"description":"","properties":{"id":{"type":"string","description":""}},"type":"object","required":["id"]},"ApplicationNumber":{"description":"","properties":{"id":{"type":"string","description":""}},"type":"object","required":["id"]},"ClassCodeNatl":{"description":"","properties":{"id":{"type":"string","description":""}},"type":"object","required":["id"]},"ClassCodeIntl":{"description":"","properties":{"id":{"type":"string","description":""}},"type":"object","required":["id"]},"ExternalIds":{"description":"","properties":{"pmid":{"$ref":"#/definitions/PubMedId"},"pmcid":{"$ref":"#/definitions/PubMedCentralId"},"doi":{"$ref":"#/definitions/DOI"},"goid":{"$ref":"#/definitions/SummonGoId"},"arXivId":{"$ref":"#/definitions/ArXivId"},"locCallNumber":{"$ref":"#/definitions/LoCCallNumber"},"summonId":{"$ref":"#/definitions/SummonId"},"pdsPubId":{"$ref":"#/definitions/PdsPubId"},"patentNumber":{"$ref":"#/definitions/PatentNumber"},"registryNumber":{"$ref":"#/definitions/RegistryNumber"},"applicationNumber":{"$ref":"#/definitions/ApplicationNumber"},"classCodeNatl":{"$ref":"#/definitions/ClassCodeNatl"},"classCodeIntl":{"$ref":"#/definitions/ClassCodeIntl"},"simpleReferenceId":{"$ref":"#/definitions/Number"},"rw2InstitutionId":{"$ref":"#/definitions/Number"},"rw2UserId":{"$ref":"#/definitions/Number"}},"type":"object"},"RefEvent":{"description":"","properties":{"name":{"type":"string","description":""},"location":{"type":"string","description":""},"date":{"type":"string","description":""}},"type":"object"},"RefSource":{"description":"","properties":{"name":{"type":"string","description":""},"database":{"type":"string","description":""},"library":{"type":"string","description":""},"location":{"type":"string","description":""},"accession":{"type":"string","description":""},"availability":{"type":"string","description":""},"classification":{"type":"string","description":""},"republishedDate":{"type":"string","description":""},"retrievedDate":{"type":"string","description":""},"version":{"type":"string","description":""},"medium":{"type":"string","description":""},"isElectronic":{"type":"boolean","description":""},"extraData":{"type":"string","description":""},"disciplines":{"type":"array","items":{"type":"string"},"description":""}},"type":"object"},"CustomFields":{"description":"","properties":{"val1":{"type":"string","description":""},"val2":{"type":"string","description":""},"val3":{"type":"string","description":""},"val4":{"type":"string","description":""},"val5":{"type":"string","description":""},"val6":{"type":"string","description":""},"val7":{"type":"string","description":""},"val8":{"type":"string","description":""},"val9":{"type":"string","description":""},"val10":{"type":"string","description":""},"val11":{"type":"string","description":""},"val12":{"type":"string","description":""},"val13":{"type":"string","description":""},"val14":{"type":"string","description":""},"val15":{"type":"string","description":""}},"type":"object"},"LinkVendorData":{"description":"","properties":{"key":{"type":"string","description":""},"value":{"type":"string","description":""}},"type":"object","required":["key","value"]},"LinkVendor":{"description":"","properties":{"name":{"type":"string","description":""},"linkVendorData":{"type":"array","items":{"$ref":"#/definitions/LinkVendorData"},"description":""}},"type":"object","required":["name","linkVendorData"]},"Reference":{"description":"","properties":{"id":{"type":"string","description":""},"owner":{"type":"string","description":""},"title":{"type":"string","description":""},"shortTitle":{"type":"string","description":""},"alternateTitle":{"type":"string","description":""},"authors":{"type":"array","items":{"type":"string"},"description":""},"publicationDate":{"type":"string","description":""},"publication":{"$ref":"#/definitions/Publication"},"series":{"$ref":"#/definitions/Series"},"refType":{"enum":["JOURNAL_ARTICLE_REF","ABSTRACT_REF","BOOK_REF","BOOK_SECTION_REF","CONF_REF","PATENT_REF","REPORT_REF","MONOGRAPH_REF","THESIS_REF","WEB_REF","NEWS_REF","BOOK_EDITED_REF","ART_REF","FILM_REF","MAG_REF","MAP_REF","MUSIC_REF","AUDIO_REF","PERSONAL_COMM_REF","UNPUBLISHED_REF","FORUM_REF","COURT_REF","HEARING_REF","LAW_REF","BILL_REF","PROGRAM_REF","GENERIC_REF"],"type":"string","description":""},"abstr":{"type":"string","description":""},"language":{"type":"string","description":""},"url":{"type":"string","description":""},"userNotes":{"type":"string","description":""},"tags":{"type":"array","items":{"type":"string"},"description":""},"contributors":{"$ref":"#/definitions/Contributors"},"legal":{"$ref":"#/definitions/Legal"},"pages":{"$ref":"#/definitions/Pages"},"publisher":{"$ref":"#/definitions/Publisher"},"docIds":{"$ref":"#/definitions/ExternalIds"},"event":{"$ref":"#/definitions/RefEvent"},"source":{"$ref":"#/definitions/RefSource"},"customFields":{"$ref":"#/definitions/CustomFields"},"linkVendor":{"$ref":"#/definitions/LinkVendor"}},"type":"object","required":["id","owner","title","authors","publication","series","refType","tags"]},"ReferenceViewResponse":{"description":"","properties":{"references":{"type":"array","items":{"$ref":"#/definitions/Reference"},"description":""},"totalReferences":{"type":"number","format":"double","description":""}},"type":"object","required":["references","totalReferences"]},"Author":{"description":"","properties":{"lastName":{"type":"string","description":""},"firstNames":{"type":"array","items":{"type":"string"},"description":""},"rawName":{"type":"string","description":""}},"type":"object","required":["lastName","firstNames","rawName"]},"ReferenceModel":{"description":"","properties":{"refType":{"type":"string","description":""},"title":{"type":"string","description":""},"authors":{"type":"array","items":{"$ref":"#/definitions/Author"},"description":""},"contributors":{"$ref":"#/definitions/Contributors"},"abstr":{"type":"string","description":""},"pages":{"$ref":"#/definitions/Pages"},"publication":{"$ref":"#/definitions/Publication"},"publicationDate":{"type":"string","description":""},"series":{"$ref":"#/definitions/Series"},"publisher":{"$ref":"#/definitions/Publisher"}},"type":"object","required":["refType","title","authors","contributors","abstr","pages","publication","publicationDate","series","publisher"]},"SummonResponse":{"description":"","properties":{"summonStatus":{"type":"number","format":"double","description":""},"doi":{"type":"string","description":""},"hitCount":{"type":"number","format":"double","description":""},"matches":{"type":"array","items":{"$ref":"#/definitions/ReferenceModel"},"description":""}},"type":"object","required":["summonStatus","doi","hitCount","matches"]},"ReferencesIds":{"description":"","properties":{"id":{"type":"string","description":""},"rw2InstitutionId":{"type":"number","format":"double","description":""},"rw2UserId":{"type":"number","format":"double","description":""},"simpleReferenceId":{"type":"number","format":"double","description":""}},"type":"object","required":["id","rw2InstitutionId","rw2UserId","simpleReferenceId"]},"ReferenceFullTextRequest":{"description":"","properties":{"referenceId":{"type":"string","description":""},"doi":{"type":"string","description":""},"pmid":{"type":"string","description":""},"pmcid":{"type":"string","description":""}},"type":"object","required":["referenceId","doi","pmid","pmcid"]},"UnpaywallRequest":{"description":"","properties":{"dois":{"type":"array","items":{"type":"string"},"description":""}},"type":"object","required":["dois"]},"ReferenceBatchResponse":{"description":"","properties":{"totalReferences":{"type":"number","format":"double","description":""}},"type":"object","required":["totalReferences"]},"ReferenceBatchRequest":{"description":"","properties":{"references":{"type":"array","items":{"$ref":"#/definitions/Reference"},"description":""}},"type":"object","required":["references"]},"RaiseEventRequest":{"description":"","properties":{"eventType":{"enum":["ERROR","WARNING"],"type":"string","description":""},"message":{"type":"string","description":""}},"type":"object","required":["eventType","message"]},"Style":{"description":"","properties":{"id":{"type":"string","description":""},"styleType":{"enum":["csl","refworks"],"type":"string","description":""},"name":{"type":"string","description":""},"url":{"type":"string","description":""},"isInstitutional":{"type":"boolean","description":""},"isSorted":{"type":"boolean","description":""},"usesNumbers":{"type":"boolean","description":""}},"type":"object","required":["id","styleType","name","url","isInstitutional","isSorted","usesNumbers"]},"Link":{"description":"","properties":{"linkType":{"type":"string","description":""},"url":{"type":"string","description":""}},"type":"object","required":["linkType","url"]},"CslStyleRequest":{"description":"","properties":{"externalId":{"type":"string","description":""},"name":{"type":"string","description":""},"definition":{"type":"string","description":""},"ownerId":{"type":"string","description":""},"styleClass":{"type":"string","description":""},"citationFormat":{"type":"array","items":{"type":"string"},"description":""},"defaultLocale":{"type":"string","description":""},"categories":{"type":"array","items":{"type":"string"},"description":""},"links":{"type":"array","items":{"$ref":"#/definitions/Link"},"description":""}},"type":"object","required":["externalId","name","definition","ownerId","styleClass","citationFormat","defaultLocale","categories","links"]},"CslLocale":{"description":"","properties":{"id":{"type":"string","description":""},"definition":{"type":"string","description":""}},"type":"object","required":["id","definition"]},"BrokenCitation":{"description":"","properties":{"position":{"type":"number","format":"double","description":"Associated with formatter request reference position *"},"referenceIds":{"type":"array","items":{"type":"string"},"description":"Represent the list of references with not PRESENT availability on a formatter citation *"}},"type":"object","required":["position","referenceIds"]},"BiblioData":{"description":"","properties":{"inline":{"type":"array","items":{"type":"string"},"description":"Response has inline citation *"},"biblio":{"type":"string","description":"Response has bibliography *"},"note":{"type":"string","description":"Response has footnote *"},"status":{"type":"string","description":""},"styleId":{"type":"string","description":""},"brokenCitation":{"type":"array","items":{"$ref":"#/definitions/BrokenCitation"},"description":"Response has brokenCitation *"}},"type":"object","required":["inline","biblio","note","status","styleId","brokenCitation"]},"MapData":{"description":"","properties":{},"type":"object","additionalProperties":{"$ref":"#/definitions/BiblioData"}},"FormatterMapResponse":{"description":"","properties":{"data":{"$ref":"#/definitions/MapData"}},"type":"object","required":["data"]},"CitationOptions":{"description":"","properties":{"author":{"type":"boolean","description":"whether to make author part of the citation *"},"year":{"type":"boolean","description":"whether to make year part of the citation *"},"pageReplace":{"type":"string","description":""},"prefix":{"type":"string","description":""},"suffix":{"type":"string","description":""}},"type":"object","required":["author","year","pageReplace","prefix","suffix"]},"ReferenceMeta":{"description":"","properties":{"refId":{"type":"string","description":"Refworks mongo id for the reference doc *"},"options":{"$ref":"#/definitions/CitationOptions"}},"type":"object","required":["refId","options"]},"ReferenceGroup":{"description":"","properties":{"indexGroup":{"type":"string","description":"Used for map response as a key for the group. Not needed for blob response *"},"referenceMetaList":{"type":"array","items":{"$ref":"#/definitions/ReferenceMeta"},"description":"A set of references in a single citation *"},"position":{"enum":["inline","bibliographic","note","dynamic"],"type":"string","description":""}},"type":"object","required":["indexGroup","referenceMetaList","position"]},"FormatterRequest":{"description":"","properties":{"format":{"enum":["text","html","json"],"type":"string","description":"Format can be text, html or json. Default is \"html\""},"language":{"type":"string","description":"IETF language code e.g. en-US. For CSL style locale use."},"isRefworks":{"type":"boolean","description":"Whether or not the missing fields annotation needs to be displayed in the bibliography\nDefault is false/off"},"references":{"type":"array","items":{"$ref":"#/definitions/ReferenceGroup"},"description":"multiple group of references that forms separate citations *"},"ignoreBrokenCitations":{"type":"boolean","description":"Filter out deleted references before call formatter service\nDefault is false"},"authorDisambiguation":{"type":"string","description":""}},"type":"object","required":["language","references","ignoreBrokenCitations"]},"FormatterBlobResponse":{"description":"","properties":{"data":{"$ref":"#/definitions/BiblioData"}},"type":"object","required":["data"]},"SampleData":{"description":"","properties":{"inline":{"type":"string","description":""},"biblio":{"type":"string","description":""},"note":{"type":"string","description":""}},"type":"object","required":["inline","biblio","note"]},"Project":{"description":"","properties":{"id":{"type":"string","description":""},"userId":{"type":"string","description":""},"name":{"type":"string","description":""},"created":{"type":"integer","format":"int64","description":""},"lastModified":{"type":"integer","format":"int64","description":""},"lastAccessed":{"type":"integer","format":"int64","description":""},"isArchived":{"type":"boolean","description":""},"totalUsers":{"type":"number","format":"double","description":""}},"type":"object","required":["id","userId","name","created","lastModified","lastAccessed","isArchived","totalUsers"]},"ProjectIdentifier":{"description":"","properties":{"id":{"type":"string","description":""}},"type":"object","required":["id"]},"ProjectRequest":{"description":"","properties":{"name":{"type":"string","description":""},"isArchived":{"type":"boolean","description":""}},"type":"object"},"ProjectUsersHandler":{"description":"","properties":{"email":{"type":"string","description":""},"status":{"type":"string","description":""},"inviteFromUserId":{"type":"string","description":""},"lastModified":{"type":"integer","format":"int64","description":""},"lastAccessed":{"type":"integer","format":"int64","description":""},"folderSortOrder":{"type":"string","description":""}},"type":"object"},"PublicCitationsRequest":{"description":"","properties":{"selectionType":{"enum":["selected","folder","search","all"],"type":"string","description":""},"format":{"enum":["text","html","json"],"type":"string","description":""},"folderId":{"type":"string","description":""},"styleId":{"type":"string","description":""},"query":{"type":"string","description":""},"bibliographyOnly":{"type":"boolean","description":""},"useRefworks":{"type":"boolean","description":""},"references":{"type":"array","items":{"type":"string"},"description":""}},"type":"object","required":["selectionType","format","folderId","styleId","query","bibliographyOnly","useRefworks","references"]},"PublicFormatterRequest":{"description":"","properties":{"selectionType":{"enum":["selected","folder","search","all"],"type":"string","description":""},"format":{"enum":["text","html","json"],"type":"string","description":""},"folderId":{"type":"string","description":""},"style":{"enum":[0,1,2,3],"type":"number","description":""},"query":{"type":"string","description":""},"isRefworks":{"type":"boolean","description":""},"references":{"type":"array","items":{"type":"string"},"description":""}},"type":"object","required":["selectionType","format","folderId","style","query","isRefworks","references"]},"ProjectUser":{"description":"","properties":{"id":{"type":"string","description":""},"email":{"type":"string","description":""},"status":{"enum":["OWNER","INVITE"],"type":"string","description":""},"folderSortOrder":{"enum":[0,1],"type":"number","description":""}},"type":"object","required":["id","email","status","folderSortOrder"]},"NotificationInfo":{"description":"","properties":{"institutions":{"type":"array","items":{"type":"string"},"description":""},"title":{"type":"string","description":""},"body":{"type":"string","description":""},"startDate":{"type":"string","description":""},"endDate":{"type":"string","description":""},"lastModified":{"type":"number","format":"double","description":""},"id":{"type":"string","description":""}},"type":"object","required":["institutions","title","body","startDate","endDate","lastModified","id"]},"NotificationInstitution":{"description":"","properties":{"id":{"type":"string","description":""},"name":{"type":"string","description":""}},"type":"object","required":["id","name"]},"NotificationUser":{"description":"","properties":{"id":{"type":"string","description":""},"name":{"type":"string","description":""}},"type":"object","required":["id","name"]},"AdminNotificationInfo":{"description":"","properties":{"institutions":{"type":"array","items":{"$ref":"#/definitions/NotificationInstitution"},"description":""},"title":{"type":"string","description":""},"body":{"type":"string","description":""},"startDate":{"type":"string","description":""},"endDate":{"type":"string","description":""},"id":{"type":"string","description":""},"createdBy":{"$ref":"#/definitions/NotificationUser"},"onlyAdmins":{"type":"boolean","description":""}},"type":"object","required":["institutions","title","body","startDate","endDate","id","createdBy","onlyAdmins"]},"NotificationRequest":{"description":"","properties":{"institutions":{"type":"array","items":{"type":"string"},"description":""},"title":{"type":"string","description":""},"body":{"type":"string","description":""},"startDate":{"type":"number","format":"double","description":""},"endDate":{"type":"number","format":"double","description":""},"onlyAdmins":{"type":"boolean","description":""}},"type":"object","required":["institutions","title","body","startDate","endDate","onlyAdmins"]},"File":{"description":"Provides information about files and allows JavaScript in a web page to access their content.","properties":{"lastModified":{"type":"number","format":"double","description":""},"name":{"type":"string","description":""},"webkitRelativePath":{"type":"string","description":""},"size":{"type":"number","format":"double","description":""},"type":{"type":"string","description":""}},"type":"object","required":["lastModified","name","webkitRelativePath","size","type"]},"UploadModel":{"description":"Upload an attachment - request body","properties":{"f":{"$ref":"#/definitions/File"},"projectId":{"type":"string","description":"Required if you are creating a new reference *"},"folderId":{"type":"string","description":"The folder in which the reference is located or should be created *"},"mode":{"type":"string","description":"Indicates if the attachment is being added to an existing reference or a new one. Options: [insert, update] *"},"referenceId":{"type":"string","description":"Required if attaching a file to an existing reference *"}},"type":"object","required":["f","projectId","mode"]},"UploadDuplicateModel":{"description":"","properties":{"referenceId":{"type":"string","description":""},"duplicateReferenceId":{"type":"string","description":""},"folderId":{"type":"string","description":""}},"type":"object","required":["referenceId","duplicateReferenceId","folderId"]},"AuthenticationProvider":{"description":"","properties":{"id":{"type":"string","description":""},"institutionId":{"type":"string","description":""},"identityProvider":{"type":"string","description":""},"type":{"type":"string","description":""},"scope":{"type":"string","description":""},"userAttribute":{"type":"string","description":""},"scopedAffiliationAttribute":{"type":"string","description":""},"authAllowed":{"type":"string","description":""},"alternateIdentityProvider":{"type":"string","description":""},"enabled":{"type":"boolean","description":""},"created":{"type":"string","format":"date-time","description":""},"lastModified":{"type":"string","format":"date-time","description":""},"modifiedUserId":{"type":"string","description":""},"lrwAltSubscriberId":{"type":"string","description":""},"group":{"type":"string","description":""}},"type":"object","required":["id","institutionId","identityProvider","type","scope","userAttribute","scopedAffiliationAttribute","authAllowed","alternateIdentityProvider","enabled","created","lastModified","modifiedUserId","lrwAltSubscriberId","group"]},"AdditionalProfileInformation":{"description":"","properties":{"label":{"type":"string","description":""},"answers":{"type":"array","items":{"type":"string"},"description":""}},"type":"object","required":["label","answers"]},"SharingProfile":{"description":"","properties":{"fulltextSharing":{"type":"boolean","description":""},"dropboxSync":{"type":"boolean","description":""},"searchDatabase":{"type":"boolean","description":""}},"type":"object","required":["fulltextSharing","dropboxSync","searchDatabase"]},"LinkResolver":{"description":"","properties":{"name":{"type":"string","description":""},"url":{"type":"string","description":""}},"type":"object","required":["name","url"]},"GroupSettings":{"description":"","properties":{"pdsInstitutionId":{"type":"string","description":""},"refworksInstitutionId":{"type":"string","description":""},"subscriptionEnd":{"type":"integer","format":"int64","description":""},"subscriptionType":{"type":"boolean","description":""},"trial":{"type":"boolean","description":""},"strictMode":{"type":"boolean","description":""},"supportsUniqueAccessCode":{"type":"boolean","description":""},"emailDomains":{"type":"array","items":{"type":"string"},"description":""},"ipRanges":{"type":"array","items":{"type":"string"},"description":""}},"type":"object","required":["pdsInstitutionId","refworksInstitutionId","subscriptionEnd","subscriptionType","trial","strictMode","supportsUniqueAccessCode","emailDomains","ipRanges"]},"Institution":{"description":"","properties":{"id":{"type":"string","description":""},"institutionId":{"type":"string","description":""},"institutionName":{"type":"string","description":""},"code":{"type":"string","description":""},"roles":{"type":"array","items":{"type":"string"},"description":""},"areaOfFocus":{"type":"array","items":{"type":"string"},"description":""},"profileCreationMessage":{"type":"string","description":""},"additionalProfileInformation":{"$ref":"#/definitions/AdditionalProfileInformation"},"sharingProfile":{"$ref":"#/definitions/SharingProfile"},"created":{"type":"integer","format":"int64","description":""},"lastModified":{"type":"integer","format":"int64","description":""},"subscriptionEnd":{"type":"integer","format":"int64","description":""},"shortName":{"type":"string","description":""},"sponsorText":{"type":"string","description":""},"sponsorURL":{"type":"string","description":""},"groupAccessCode":{"type":"string","description":""},"portable":{"type":"boolean","description":""},"accessCodeEnabled":{"type":"boolean","description":""},"strictMode":{"type":"boolean","description":""},"subscribing":{"type":"boolean","description":""},"trial":{"type":"boolean","description":""},"adminNote":{"type":"string","description":""},"refworksInstitutionId":{"type":"string","description":""},"linkResolver":{"$ref":"#/definitions/LinkResolver"},"referralUrlFilters":{"type":"array","items":{"type":"string"},"description":""},"defaultCitationStyles":{"type":"array","items":{"type":"string"},"description":""},"institutionalStyles":{"type":"array","items":{"type":"string"},"description":""},"emailDomains":{"type":"array","items":{"type":"string"},"description":""},"externalIds":{"type":"array","items":{"type":"string"},"description":""},"groupSettings":{"$ref":"#/definitions/GroupSettings"}},"type":"object","required":["id","institutionId","institutionName","code","roles","areaOfFocus","profileCreationMessage","additionalProfileInformation","sharingProfile","created","lastModified","subscriptionEnd","shortName","sponsorText","sponsorURL","groupAccessCode","portable","accessCodeEnabled","strictMode","subscribing","trial","adminNote","refworksInstitutionId","linkResolver","referralUrlFilters","defaultCitationStyles","institutionalStyles","emailDomains","externalIds","groupSettings"]},"RolesAndAreaOfFocusList":{"description":"","properties":{"roles":{"type":"array","items":{"type":"string"},"description":""},"areaOfFocus":{"type":"array","items":{"type":"string"},"description":""}},"type":"object","required":["roles","areaOfFocus"]},"AddDedupRequest":{"description":"","properties":{"folderIds":{"type":"array","items":{"type":"string"},"description":""},"dedupType":{"type":"string","description":""},"compareDoi":{"type":"boolean","description":""},"compareIssn":{"type":"boolean","description":""},"compareIsbn":{"type":"boolean","description":""},"comparePublicationDate":{"type":"boolean","description":""},"compareAuthors":{"type":"boolean","description":""},"comparePageNumber":{"type":"boolean","description":""},"compareTitle":{"type":"boolean","description":""},"sortOrder":{"type":"string","description":""}},"type":"object","required":["folderIds","dedupType","compareDoi","compareIssn","compareIsbn","comparePublicationDate","compareAuthors","comparePageNumber","compareTitle","sortOrder"]}},"info":{"description":"Use these APIs to perform various RefWorks functions outside your RefWorks account.\nTo use these APIs you will need an access key; [contact RefWorks support ](https://supportcase.exlibrisgroup.com/s/refworks) to obtain a key.\nFor APIs that require authentication, the endpoints in the authentication section should be used:\n1. Call the auth/login endpoint and retrieve an authorization code that is attached to your redirecting URL. \n2. Call auth/token with the authorization code from step 1. It will return an access code.\n3. Use the code from step 2 to access the endpoints exposed here by adding ‘cookieString’ to the headers with value 'access_token=’.\n\n**System requirements:**\n\n1.`TLS 1.2`","title":"RefWorks APIs","version":"0.0.1","termsOfService":"https://refworks.proquest.com/terms-and-conditions/"},"paths":{"/healthcheck":{"get":{"operationId":"HealthCheckGetHealthCheckStatus","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/HealthCheckResponse"}}},"description":"Gets API healthcheck information","tags":["monitor"],"parameters":[]}},"/folders":{"get":{"operationId":"FolderGetAllFolders","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"array","items":{"$ref":"#/definitions/FolderInfo"}}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Gets a user's folders.","tags":["folders"],"parameters":[{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]},"post":{"operationId":"FolderCreateFolder","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/FolderInfo"}},"400":{"description":"Badrequest: Invalid input in the payload.","schema":{"$ref":"#/definitions/ErrorModel"}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Creates a new folder for a user.","tags":["folders"],"consumes":["application/json"],"parameters":[{"description":"\"Name\" of the folder to be created.\n\"ParentId\" is needed if the new folder is a subfolder of an existing folder.","in":"body","name":"requestData","required":true,"schema":{"$ref":"#/definitions/FolderRequest"}},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/folders/references":{"put":{"operationId":"FolderUpdateFoldersInReferences","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"Not found folders or references","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Adds or removes references from folder(s)","tags":["folders"],"consumes":["application/json"],"parameters":[{"description":"","in":"body","name":"requestData","required":true,"schema":{"$ref":"#/definitions/FoldersReferencesRequest"}},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/folders/{folderId}":{"put":{"operationId":"FolderRenameFolder","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"Not found folder","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Renames a user's folder.","tags":["folders"],"consumes":["application/json"],"parameters":[{"description":"","in":"path","name":"folderId","required":true,"type":"string"},{"description":"","in":"body","name":"folderName","required":true,"schema":{"$ref":"#/definitions/FolderName"}},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]},"delete":{"operationId":"FolderDeleteFolder","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"Not found","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Deletes a specific folder for a user.","tags":["folders"],"parameters":[{"description":"The folder id. If the folder includes subfolders, they will be deleted as well","in":"path","name":"folderId","required":true,"type":"string"},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/folders/{folderId}/move":{"patch":{"operationId":"FolderMoveFolder","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/FolderInfo"}},"400":{"description":"bbeforeId or afterId must be specified.","schema":{"$ref":"#/definitions/ErrorModel"}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"Not found","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Moves a folder's position in the folder list. Requires sending beforeId OR afterId parameter.","tags":["folders"],"consumes":["application/json"],"parameters":[{"description":"Id of the folder to be moved","in":"path","name":"folderId","required":true,"type":"string"},{"description":"Move the folder before this folder","in":"query","name":"beforeId","required":true,"type":"string"},{"description":"Move the folder after this folder","in":"query","name":"afterId","required":true,"type":"string"},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/folders/public":{"get":{"operationId":"FolderGetPublicFolders","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"array","items":{"$ref":"#/definitions/FolderPublicInfo"}}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Gets a user's publicly shared folders.","tags":["folders"],"parameters":[{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/folders/{folderId}/public":{"get":{"operationId":"FolderGetFolderPublicData","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/FolderPublicInfo"}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Gets the data of a publicly shared folder: Public id and if a link resolver is configured.","tags":["folders"],"parameters":[{"description":"","in":"path","name":"folderId","required":true,"type":"string"},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]},"post":{"operationId":"FolderGeneratePublicUrl","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/FolderPublicInfo"}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Creates a public URL for a folder to be publicly shared.","tags":["folders"],"consumes":["application/json"],"parameters":[{"description":"","in":"path","name":"folderId","required":true,"type":"string"},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]},"put":{"operationId":"FolderUpdatePublicUrl","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/FolderPublicInfo"}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Creates or updates a public URL for a folder to be publicly shared.","tags":["folders"],"consumes":["application/json"],"parameters":[{"description":"","in":"path","name":"folderId","required":true,"type":"string"},{"description":"","in":"body","name":"payload","required":true,"schema":{"type":"string"}},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]},"delete":{"operationId":"FolderDeleteFolderPublicData","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Removes the public URL of a publicly shared folder.","tags":["folders"],"parameters":[{"description":"","in":"path","name":"folderId","required":true,"type":"string"},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/references":{"get":{"operationId":"ReferenceRetrieve","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/ReferenceViewResponse"}},"400":{"description":"filter attribute value is unknown: ","schema":{"$ref":"#/definitions/ErrorModel"}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Gets references. It uses a minimal projection unless *fields* is set.","tags":["references"],"parameters":[{"description":"Cannot be higher than 2000","in":"query","name":"pageSize","required":true,"type":"number","format":"double"},{"description":"URIEncoded, a comma separated list of additional reference fields to be returned\nCheck Models section for allowed field names","in":"query","name":"fields","required":false,"type":"string"},{"description":"Only \"LastImported\" is supported (imported or created in last 30 days)","in":"query","name":"filter","required":false,"type":"string"},{"description":"If larger than zero, start with that record. Default is zero","in":"query","name":"fromIndex","required":false,"type":"number","format":"double"},{"description":"Options: [date-added, date-accessed, date-published, author, title]. Default is date-added","in":"query","name":"sortOrder","required":false,"type":"string"},{"description":"Allows a search to be performed based on the given query. Queries are made based on lucene index syntax, for example. q=title:\"Some Title\"","in":"query","name":"q","required":false,"type":"string"},{"description":"If present, results are limited to the specified folder. For example: folder=project:577cfc28e4b03eb5f1034a61","in":"query","name":"folder","required":false,"type":"string"},{"description":"Allows a search to be performed based on a list of reference IDs. If present, it overrides other filters.\nFor example: ids=doc:567479b5e4b0d7026421e522,doc:567479b5e4b0d7026421e523,doc:567479b5e4b0d7026421e524","in":"query","name":"ids","required":false,"type":"string"},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]},"post":{"operationId":"ReferenceBatchReferences","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/ReferenceBatchResponse"}},"400":{"description":"Reference list cannot be empty.","schema":{"$ref":"#/definitions/ErrorModel"}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"FolderId does not exist.","schema":{"$ref":"#/definitions/ErrorModel"}},"412":{"description":"Validation error.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Create one or more references in a user's folder (:folderId) if present as part of a list of references","tags":["references"],"consumes":["application/json"],"parameters":[{"description":"","in":"body","name":"referenceBatchRequest","required":true,"schema":{"$ref":"#/definitions/ReferenceBatchRequest"}},{"description":"Id of the desired folder","in":"query","name":"folderId","required":false,"type":"string"},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/references/folders/{folderId}":{"get":{"operationId":"ReferenceRetrieveFromFolder","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"400":{"description":"folderId is missing.","schema":{"$ref":"#/definitions/ErrorModel"}},"401":{"description":"This user is notauthorized.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Gets references in a specific folder (:folderId) as selected by query params. All query params are optional.","tags":["references"],"parameters":[{"description":"Folder id","in":"path","name":"folderId","required":true,"type":"string"},{"description":"URIEncoded, a comma separated list of extra Reference fields to be returned (content* are ignored)","in":"query","name":"fields","required":false,"type":"string"},{"description":"If larger than zero, start with that record. Default is zero","in":"query","name":"fromIndex","required":false,"type":"string"},{"description":"Default is zero which gets all references","in":"query","name":"pageSize","required":false,"type":"string"},{"description":"Options: [date-added, date-accessed, date-published, author, title]. Default is date-added","in":"query","name":"sortOrder","required":false,"type":"string"},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/references/enrichment":{"get":{"operationId":"ReferenceGetEnrichmentByField","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/SummonResponse"}},"401":{"description":"This user is notauthorized.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Gets alternate reference data for a specific reference field","tags":["references"],"parameters":[{"description":"","in":"query","name":"field","required":true,"type":"string"},{"description":"","in":"query","name":"data","required":true,"type":"string"},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/references/fulltext":{"post":{"operationId":"ReferenceAttachFullTextPDF","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"Reference was not found.","schema":{"$ref":"#/definitions/ErrorModel"}},"412":{"description":"Reference file url is not valid.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Attaches the full text (PDF) when importing references with Direct Export.","tags":["references"],"consumes":["application/json"],"parameters":[{"description":"","in":"body","name":"referenceFullTextRequest","required":true,"schema":{"$ref":"#/definitions/ReferenceFullTextRequest"}},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/references/unpaywall/search/dois":{"post":{"operationId":"ReferenceSearchUnpaywall","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"The requested DOIs were not found.","schema":{"$ref":"#/definitions/ErrorModel"}},"412":{"description":"DOI list is empty.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"","tags":["references"],"consumes":["application/json"],"parameters":[{"description":"","in":"body","name":"unpaywallRequest","required":true,"schema":{"$ref":"#/definitions/UnpaywallRequest"}},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/references/public/{refId}":{"put":{"operationId":"ReferenceUpdateUserReference","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"Reference not found.","schema":{"$ref":"#/definitions/ErrorModel"}},"412":{"description":"Reference id was not present.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Get a reference id in the url an editing it by changing to the new reference that is getting by the body.","tags":["references"],"consumes":["application/json"],"parameters":[{"description":"","in":"path","name":"refId","required":true,"type":"string"},{"description":"","in":"body","name":"reference","required":true,"schema":{"$ref":"#/definitions/Reference"}},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/references/trash":{"put":{"operationId":"ReferenceTrashReference","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"400":{"description":"Reference list cannot be empty.","schema":{"$ref":"#/definitions/ErrorModel"}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"412":{"description":"Validation error.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Putting a references list in the trash by getting a list or references ids.\n There is a limit for 500 references that could send to the trash in one time.","tags":["references"],"consumes":["application/json"],"parameters":[{"description":"","in":"body","name":"referenceIds","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/citationstyles":{"get":{"operationId":"BibliographyGetCitationStyles","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"401":{"description":"The user is unauthorized.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Gets all styles.","tags":["citationstyles"],"parameters":[{"description":"Options: [refworks, csl, all]","in":"query","name":"source","required":false,"type":"string"},{"description":"Lucene query, plain text or in the format {field}:{search string}","in":"query","name":"q","required":false,"type":"string"},{"description":"The start offset for use when paging results. Default is 0","in":"query","name":"from","required":false,"type":"number","format":"double"},{"description":"Page size. Default is 10","in":"query","name":"size","required":false,"type":"number","format":"double"},{"description":"Fields to return as a comma separated list, default is all fields","in":"query","name":"fields","required":false,"type":"string"},{"description":"Sort order in the form {field}: [asc | desc]. For example: sort=title:asc","in":"query","name":"sort","required":false,"type":"string"},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]},"post":{"operationId":"BibliographyCreateStyles","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"201":{"description":"Successfully added the new CSL style","schema":{"type":"object"}},"400":{"description":"Invalid request","schema":{"$ref":"#/definitions/ErrorModel"}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Adds a new CSL style.","tags":["citationstyles"],"consumes":["application/json"],"parameters":[{"description":"","in":"body","name":"request","required":true,"schema":{"$ref":"#/definitions/CslStyleRequest"}},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/citationstyles/recent":{"get":{"operationId":"BibliographyGetRecentCitationStyles","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"array","items":{"$ref":"#/definitions/Style"}}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Gets a user's Recent styles.","tags":["citationstyles"],"parameters":[{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]},"post":{"operationId":"BibliographySetRecentCitationStyle","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/Style"}},"400":{"description":"Style is required.","schema":{"$ref":"#/definitions/ErrorModel"}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Sets a Recent style for a user.","tags":["citationstyles"],"consumes":["application/json"],"parameters":[{"description":"","in":"body","name":"style","required":true,"schema":{"$ref":"#/definitions/Style"}},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/citationstyles/favorites":{"post":{"operationId":"BibliographyAddFavoriteCitationStyle","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"400":{"description":"Style is required.","schema":{"$ref":"#/definitions/ErrorModel"}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"412":{"description":"This style is already in the user's Favorite styles.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Sets a Favorite style for a user.","tags":["citationstyles"],"consumes":["application/json"],"parameters":[{"description":"","in":"body","name":"styleId","required":true,"schema":{"type":"string"}},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]},"get":{"operationId":"BibliographyGetFavoriteCitationStyles","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Gets a user's Favorite styles.","tags":["citationstyles"],"parameters":[{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/citationstyles/favorites/{styleId}":{"delete":{"operationId":"BibliographyDeleteFavoriteCitationStyle","produces":["application/json","text/html"],"responses":{"200":{"description":"Ok","schema":{"type":"string"}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"Unable to find Favorite.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Deletes a Favorite style for a user.","tags":["citationstyles"],"parameters":[{"description":"","in":"path","name":"styleId","required":true,"type":"string"},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/citationstyles/{id}":{"patch":{"operationId":"BibliographyUpdateCslStyle","produces":["application/json"],"responses":{"200":{"description":"CSL style updated successfully","schema":{"type":"object"}},"400":{"description":"Invalid request","schema":{"$ref":"#/definitions/ErrorModel"}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"No matching CSL style found","schema":{"type":"object"}}},"description":"Updates an existing CSL style.","tags":["citationstyles"],"consumes":["application/json"],"parameters":[{"description":"The style id","in":"path","name":"id","required":true,"type":"string"},{"description":"","in":"body","name":"request","required":true,"schema":{"$ref":"#/definitions/CslStyleRequest"}},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]},"get":{"operationId":"BibliographyGetCitationStyle","produces":["application/json","text/html"],"responses":{"200":{"description":"Ok","schema":{"type":"string"}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Gets a specific style.","tags":["citationstyles"],"parameters":[{"description":"The style id","in":"path","name":"id","required":true,"type":"string"},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/citationstyles/locales":{"post":{"operationId":"BibliographyCreateCslLocale","produces":["application/json","text/html"],"responses":{"201":{"description":"Successfully added a new CSL locale","schema":{"type":"object"}},"204":{"description":"No content"},"400":{"description":"Invalid request","schema":{"$ref":"#/definitions/ErrorModel"}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Adds a new CSL Locale.","tags":["citationstyles"],"consumes":["application/json"],"parameters":[{"description":"","in":"body","name":"request","required":true,"schema":{"$ref":"#/definitions/CslLocale"}},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/citationstyles/locales/{id}":{"patch":{"operationId":"BibliographyUpdateCslLocale","produces":["application/json"],"responses":{"200":{"description":"CSL locale updated successfully","schema":{"type":"object"}},"400":{"description":"Invalid request","schema":{"$ref":"#/definitions/ErrorModel"}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"No matching CSL locale found","schema":{"type":"object"}}},"description":"Updates an existing CSL Locale.","tags":["citationstyles"],"consumes":["application/json"],"parameters":[{"description":"The style id","in":"path","name":"id","required":true,"type":"string"},{"description":"","in":"body","name":"request","required":true,"schema":{"$ref":"#/definitions/CslLocale"}},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/citationstyles/{id}/map":{"post":{"operationId":"FormatterFormatWithMapOutput","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/FormatterMapResponse"}},"400":{"description":"Invalid request","schema":{"$ref":"#/definitions/ErrorModel"}},"401":{"description":"User is not authorized","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"Not found","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Creates a citation or bibliography entry, in map format, for a reference and additional optional data.\nCheck Example Value below for additional optional data details","tags":["formatter"],"consumes":["application/json"],"parameters":[{"description":"Options: [inline, bibliographic, note], note refers to footnote citations","in":"query","name":"citation-type","required":true,"type":"string"},{"description":"The id of the desired style","in":"path","name":"id","required":true,"type":"string"},{"description":"\"format\" options: [text, html, json]\n\"authorDisambiguation\" options: [surname, surname_initials_same_year, surname_initials_any_year, surname_firstname]\n\"language\" options: [en, es, fr, zh, zh-tw, ja, ko, de, it]\n\"indexGroup\" will be the index associated to the returning map","in":"body","name":"formatterRequest","required":true,"schema":{"$ref":"#/definitions/FormatterRequest"}},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/citationstyles/{id}/blob":{"post":{"operationId":"FormatterFormatWithBlobOutput","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/FormatterBlobResponse"}},"400":{"description":"Invalid request","schema":{"$ref":"#/definitions/ErrorModel"}},"401":{"description":"User is not authorized","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"Not found","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Creates a citation or bibliography entry, in blob format, for a reference and additional optional data.\nCheck Example Value below for additional optional data details","tags":["formatter"],"consumes":["application/json"],"parameters":[{"description":"Options: [inline, bibliographic, note, dynamic], note refers to footnote citations, dynamic is inline/note AND bibliographic","in":"query","name":"citation-type","required":true,"type":"string"},{"description":"The id of the desired style","in":"path","name":"id","required":true,"type":"string"},{"description":"\"format\" options: [text, html, json]\n\"authorDisambiguation\" options: [surname, surname_initials_same_year, surname_initials_any_year, surname_firstname]\n\"language\" options: [en, es, fr, zh, zh-tw, ja, ko, de, it]\n\nbrokenCitation list field is returned as part of the response. It contains two fields:\n- position: to connect the index of the same referenceId present in the references field in the request\n- referencesIds: list of referencesIds that are not availabile, they are TRASHED or DELETED","in":"body","name":"formatterRequest","required":true,"schema":{"$ref":"#/definitions/FormatterRequest"}},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/citationstyles/{id}/preview":{"get":{"operationId":"FormatterFormatSampleWithBlobOutput","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/SampleData"}},"400":{"description":"Invalid request","schema":{"$ref":"#/definitions/ErrorModel"}},"401":{"description":"User is not authorized","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"Not found","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Creates a citation and bibliography entry preview for a specific style.","tags":["formatter"],"parameters":[{"description":"The id of the desired style","in":"path","name":"id","required":true,"type":"string"},{"description":"Options: [surname, surname_initials_same_year, surname_initials_any_year, surname_firstname]\nbrokenCitation list field is returned as part of the response. It contains two fields:\n- position: to connect the index of the same referenceId present in the references field in the request\n- referencesIds: list of referencesIds that are not availabile, they are TRASHED or DELETED","in":"query","name":"authorDisambiguation","required":true,"type":"string"},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/projects/current":{"get":{"operationId":"ProjectGetCurrentProject","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/Project"}},"400":{"description":"Invalid input request. Legacy RefWorks does not have Projects.","schema":{"$ref":"#/definitions/ErrorModel"}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"Not found","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Gets the current Project.","tags":["projects"],"parameters":[{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]},"put":{"operationId":"ProjectSetCurrentProject","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/Project"}},"400":{"description":"Invalid input request. Legacy RefWorks does not have Projects.","schema":{"$ref":"#/definitions/ErrorModel"}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"Not found","schema":{"$ref":"#/definitions/ErrorModel"}},"412":{"description":"The project id is not valid","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Sets the current Project.","tags":["projects"],"consumes":["application/json"],"parameters":[{"description":"","in":"body","name":"request","required":true,"schema":{"$ref":"#/definitions/ProjectIdentifier"}},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/projects":{"get":{"operationId":"ProjectGetProjects","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"array","items":{"$ref":"#/definitions/Project"}}},"400":{"description":"Invalid input request. Legacy RefWorks does not have Projects.","schema":{"$ref":"#/definitions/ErrorModel"}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Gets all Projects.","tags":["projects"],"parameters":[{"description":"The start offset for use when paging results. Default is 0","in":"query","name":"from","required":false,"type":"number","format":"double"},{"description":"Page size. Default is 25","in":"query","name":"size","required":false,"type":"number","format":"double"},{"description":"Fields to return as a comma separated list, default is all fields","in":"query","name":"fields","required":false,"type":"string"},{"description":"Sort order in the form {field}: [asc | desc]. For example: sort=name:asc","in":"query","name":"sort","required":false,"type":"string"},{"description":"","in":"query","name":"archived","required":false,"type":"boolean"},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]},"post":{"operationId":"ProjectCreateProject","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/Project"}},"201":{"description":"Successfully created the new Project","schema":{"type":"object"}},"400":{"description":"Invalid request","schema":{"$ref":"#/definitions/ErrorModel"}},"409":{"description":"This Project name already exists. Please enter a unique Project name.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Creates a new Project.","tags":["projects"],"consumes":["application/json"],"parameters":[{"description":"","in":"body","name":"request","required":true,"schema":{"$ref":"#/definitions/ProjectRequest"}},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/projects/{id}":{"get":{"operationId":"ProjectGetProject","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/Project"}},"400":{"description":"Invalid input request. Legacy RefWorks does not have Projects.","schema":{"$ref":"#/definitions/ErrorModel"}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"Not found","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Gets a specific Project by id.","tags":["projects"],"parameters":[{"description":"The project id","in":"path","name":"id","required":true,"type":"string"},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]},"patch":{"operationId":"ProjectUpdateProject","produces":["application/json"],"responses":{"200":{"description":"Project updated successfully","schema":{"type":"object"}},"400":{"description":"Invalid input request. Legacy RefWorks does not have Projects.","schema":{"$ref":"#/definitions/ErrorModel"}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"No matching Project found","schema":{"type":"object"}},"409":{"description":"This Project name already exists. Please enter a unique Project name.","schema":{"$ref":"#/definitions/ErrorModel"}},"412":{"description":"This Project is the current Project. The update is not permitted.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Updates an existing Project.","tags":["projects"],"consumes":["application/json"],"parameters":[{"description":"The project id","in":"path","name":"id","required":true,"type":"string"},{"description":"","in":"body","name":"request","required":true,"schema":{"$ref":"#/definitions/ProjectRequest"}},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/projects/{id}/sortFolders":{"patch":{"operationId":"ProjectUpdateProjectUser","produces":["application/json"],"responses":{"200":{"description":"Project updated successfully","schema":{"type":"object"}},"400":{"description":"Invalid input request. Legacy RefWorks does not have Projects.","schema":{"$ref":"#/definitions/ErrorModel"}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"No matching Project found","schema":{"type":"object"}}},"description":"Sorts the Project folders.","tags":["projects"],"consumes":["application/json"],"parameters":[{"description":"The Project id","in":"path","name":"id","required":true,"type":"string"},{"description":"","in":"body","name":"request","required":true,"schema":{"$ref":"#/definitions/ProjectUsersHandler"}},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/projects/name/{projectName}":{"get":{"operationId":"ProjectGetProjectByName","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/Project"}},"400":{"description":"Invalid input request. Legacy RefWorks does not have Projects.","schema":{"$ref":"#/definitions/ErrorModel"}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"Not found","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Gets a specific Project by name.","tags":["projects"],"parameters":[{"description":"The Project name","in":"path","name":"projectName","required":true,"type":"string"},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/public/{publicId}":{"get":{"operationId":"PublicGetPublicFolderInfo","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"401":{"description":"A valid PublicID must be specified.","schema":{"$ref":"#/definitions/ErrorModel"}},"403":{"description":"A PublicID must be specified.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Gets information of the root folder that is publicly shared.","tags":["public"],"parameters":[{"description":"The id of the publicly shared folder. It is generated with POST /folders/{folderId}/public","in":"path","name":"publicId","required":true,"type":"string"},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/public/{publicId}/references":{"get":{"operationId":"PublicGetPublicFolderReferences","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"401":{"description":"A valid PublicID must be specified.","schema":{"$ref":"#/definitions/ErrorModel"}},"403":{"description":"A PublicID must be specified.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Gets the references in the publicly shared folder.","tags":["public"],"parameters":[{"description":"The id of the publicly shared folder. It is generated with POST /folders/{folderId}/public","in":"path","name":"publicId","required":true,"type":"string"},{"description":"","in":"query","name":"pageNumber","required":false,"type":"number","format":"double"},{"description":"Page size. Default is 25, maximum 2000","in":"query","name":"pageSize","required":false,"type":"number","format":"double"},{"description":"Sort order in the form {field}: [asc | desc]. For example: sortBy=name:asc","in":"query","name":"sortBy","required":false,"type":"string"},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/public/{publicId}/folders":{"get":{"operationId":"PublicGetPublicFolderFolders","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"401":{"description":"A valid PublicID must be specified.","schema":{"$ref":"#/definitions/ErrorModel"}},"403":{"description":"A PublicID must be specified.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Gets the publicly shared folder's first level of folders.","tags":["public"],"parameters":[{"description":"The id of the public folder. It is generated with POST /folders/{folderId}/public","in":"path","name":"publicId","required":true,"type":"string"},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/public/{publicId}/folders/{folderId}/references":{"get":{"operationId":"PublicGetPublicFolderReferencesByFolderId","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"400":{"description":"Publicly shared folder and folderId are not associated."},"401":{"description":"A valid PublicID must be specified."},"403":{"description":"A PublicID must be specified."}},"description":"Gets the references in a specific folder within the publicly shared folder.","tags":["public"],"parameters":[{"description":"The id of the publicly shared folder. It is generated with POST /folders/{folderId}/public","in":"path","name":"publicId","required":true,"type":"string"},{"description":"The id of a folder within the publicly shared folder","in":"path","name":"folderId","required":true,"type":"string"},{"description":"The start offset for use when paging results. Default is 0","in":"query","name":"pageNumber","required":false,"type":"number","format":"double"},{"description":"Page size. Default is 25, maximum 2000","in":"query","name":"pageSize","required":false,"type":"number","format":"double"},{"description":"Sort order in the form {field}: [asc | desc]. For example: sortBy=name:asc","in":"query","name":"sortBy","required":false,"type":"string"},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/public/{publicId}/references/{referenceId}":{"get":{"operationId":"PublicGetReferenceDetails","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"401":{"description":"A valid reference id must be specified."},"403":{"description":"A reference id must be specified."},"404":{"description":"No reference found for this id."}},"description":"Gets a reference's details.","tags":["public"],"parameters":[{"description":"The id of the publicly shared folder. It is generated with POST /folders/{folderId}/public","in":"path","name":"publicId","required":true,"type":"string"},{"description":"The id of a reference in the publicly shared folder","in":"path","name":"referenceId","required":true,"type":"string"},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/public/{publicId}/folders/{folderId}/subfolders":{"get":{"operationId":"PublicGetPublicFolderFoldersByFolderId","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"400":{"description":"Publicly shared folder and folderId are not associated."},"401":{"description":"A valid PublicID must be specified."},"403":{"description":"A PublicID must be specified."}},"description":"Gets the first level folders in a specific folder within the publicly shared folder","tags":["public"],"parameters":[{"description":"The id of the public folder. It is generated with POST /folders/{folderId}/public","in":"path","name":"publicId","required":true,"type":"string"},{"description":"The id of a folder within the publicly shared folder","in":"path","name":"folderId","required":true,"type":"string"},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/public/{publicId}/references/{referenceId}/attachments":{"get":{"operationId":"PublicGetPublicFolderReferenceAttachmentByReferenceId","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"401":{"description":"A valid reference id must be specified."},"403":{"description":"A reference id must be specified."}},"description":"Gets a list of reference attachments.","tags":["public"],"parameters":[{"description":"The id of the publicly shared folder. It is generated with POST /folders/{folderId}/public","in":"path","name":"publicId","required":true,"type":"string"},{"description":"The id of a reference within the publicly shared folder","in":"path","name":"referenceId","required":true,"type":"string"},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/public/{publicId}/references/download/{attachmentId}/":{"get":{"operationId":"PublicGetPublicFolderReferenceAttachmentByAttachmentId","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"401":{"description":"A valid reference id must be specified."},"403":{"description":"A reference id must be specified."},"404":{"description":"No attachment found for this id."}},"description":"Gets a reference's attachment","tags":["public"],"parameters":[{"description":"The id of the publicly shared folder. It is generated with POST /folders/{folderId}/public","in":"path","name":"publicId","required":true,"type":"string"},{"description":"The id of an attachment within the publicly shared folder","in":"path","name":"attachmentId","required":true,"type":"string"},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/public/{publicId}/citationstyles/popular":{"get":{"operationId":"PublicGetPublicPopularStyles","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"401":{"description":"A valid PublicID must be specified.","schema":{"$ref":"#/definitions/ErrorModel"}},"403":{"description":"A PublicID must be specified.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Gets the citation styles available for publicly shared folders.","tags":["public"],"parameters":[{"description":"The id of the publicly shared folder. It is generated with POST /folders/{folderId}/public","in":"path","name":"publicId","required":true,"type":"string"},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/public/{publicId}/citationstyles":{"post":{"operationId":"PublicFormatPublicCitations","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"401":{"description":"A valid PublicID must be specified.","schema":{"$ref":"#/definitions/ErrorModel"}},"403":{"description":"A PublicID must be specified.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"StyleId is not valid.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Creates citations.","tags":["public"],"consumes":["application/json"],"parameters":[{"description":"The id of the publicly shared folder. It is generated with POST /folders/{folderId}/public","in":"path","name":"publicId","required":true,"type":"string"},{"description":"Uses the following fields:\nstyleId - The id of the desired style\nbibliographyOnly - For CSL styles only. Returns the bibliography. Default is false\nisRefworks - For Refworks styles only. Send true if formatter should apply custom Refworks rules. Default is false\nformat - The format for returning the citations. Options: [html, text]\nselectionType - The references that should be formatted. Options: [selected, folder]\nfolderId - If selectionType is \"folder\" this is the folder id. Do not send it otherwise\nreferences - If selectionType is \"selected\" this is the selected reference ids. Do not send it otherwise","in":"body","name":"citationsRequest","required":true,"schema":{"$ref":"#/definitions/PublicCitationsRequest"}},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/public/{publicId}/citationstyles/export":{"post":{"operationId":"PublicExportPublicReferences","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"401":{"description":"A valid PublicID must be specified on the path.","schema":{"$ref":"#/definitions/ErrorModel"}},"403":{"description":"PublicID must be specified on the path.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"StyleId was not a valid one.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Exports references.","tags":["public"],"consumes":["application/json"],"parameters":[{"description":"The id of the publicly shared folder. It is generated with POST /folders/{folderId}/public","in":"path","name":"publicId","required":true,"type":"string"},{"description":"Uses the following fields:\nstyle - The export format. Options: [bibtex, ris, tabDelimited, xml]\nisRefworks - For Refworks styles only. Send true if formatter should apply custom Refworks rules. Default is false\nselectionType - The references that should be exported. Options: [selected, folder]\nfolderId - If selectionType is \"folder\" this is the folder id. Do not send it otherwise\nreferences - If selectionType is \"selected\" this is selected reference ids. Do not send it otherwise","in":"body","name":"formatterRequest","required":true,"schema":{"$ref":"#/definitions/PublicFormatterRequest"}},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/projects/{projectId}/users":{"get":{"operationId":"ProjectUserGetAllProjectUsers","produces":["application/json"],"responses":{"200":{"description":"Successfully got users","schema":{"type":"object"}},"401":{"description":"The user is unauthorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"Not found","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Gets all the users for a given project.","tags":["projects"],"parameters":[{"description":"The id of the project from which to get users","in":"path","name":"projectId","required":true,"type":"string"},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]},"post":{"operationId":"ProjectUserGenerateProjectUsers","produces":["application/json"],"responses":{"200":{"description":"Returns the list of users for a project.","schema":{"type":"object"}},"401":{"description":"The user is unauthorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"project does not exist.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"invites all users listed in the body to a given project.","tags":["projects"],"consumes":["application/json"],"parameters":[{"description":"The id of the project to which users are to be added","in":"path","name":"projectId","required":true,"type":"string"},{"description":"A list of emails of users to be added.","in":"body","name":"users","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]},"delete":{"operationId":"ProjectUserDeleteAllProjectUsers","produces":["application/json"],"responses":{"200":{"description":"The users were successfully removed from the project.","schema":{"type":"object"}},"403":{"description":"The user making call is not in project.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"project does not exist.","schema":{"$ref":"#/definitions/ErrorModel"}},"412":{"description":"There is a user using projectId as current project.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Removes all users from a given project except user making call","tags":["projects"],"parameters":[{"description":"The id of the project from which the users are to be deleted.","in":"path","name":"projectId","required":true,"type":"string"},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/projects/{projectId}/users/{userEmail}":{"delete":{"operationId":"ProjectUserDeleteUserFromProject","produces":["application/json"],"responses":{"200":{"description":"The user was successfully removed from the project.","schema":{"type":"object"}},"401":{"description":"The user is unauthorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"403":{"description":"The user does not have access to this project","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"project does not exist for user making call","schema":{"$ref":"#/definitions/ErrorModel"}},"412":{"description":"The users has project as current project.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Deletes the specified user for a given project.","tags":["projects"],"parameters":[{"description":"The id of the project from which the user is to be deleted.","in":"path","name":"projectId","required":true,"type":"string"},{"description":"The user that is to be deleted","in":"path","name":"userEmail","required":true,"type":"string"},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/projects/invitations":{"get":{"operationId":"ProjectUserRetrieveInvitations","produces":["application/json"],"responses":{"200":{"description":"Successfully retrieved invitations.","schema":{"type":"object"}},"401":{"description":"The user is unauthorized.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Retrieves all pending invitations for the authenticated user","tags":["projects"],"parameters":[{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/projects/{projectId}/users/accept":{"post":{"operationId":"ProjectUserAcceptProjectShareInvitation","produces":["application/json"],"responses":{"200":{"description":"The user accepts the invitation.","schema":{"type":"object"}},"401":{"description":"The user is unauthorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"Project does not exist.","schema":{"$ref":"#/definitions/ErrorModel"}},"412":{"description":"Project User status is not INVITE.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Accepts the pending invitation for the given projectId","tags":["projects"],"consumes":["application/json"],"parameters":[{"description":"The id of the project to which users are to be added","in":"path","name":"projectId","required":true,"type":"string"},{"description":"","in":"body","name":"users","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/projects/{projectId}/users/decline":{"post":{"operationId":"ProjectUserDeclineProjectShareInvitation","produces":["application/json"],"responses":{"200":{"description":"The user declines the invitation.","schema":{"type":"object"}},"401":{"description":"The user is unauthorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"project does not exist.","schema":{"$ref":"#/definitions/ErrorModel"}},"412":{"description":"Project User status is not INVITE.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Accepts the pending invitation for the given projectId","tags":["projects"],"consumes":["application/json"],"parameters":[{"description":"The id of the project to which users are to be added","in":"path","name":"projectId","required":true,"type":"string"},{"description":"","in":"body","name":"users","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/projects/{projectId}/users/leave":{"delete":{"operationId":"ProjectUserLeaveProject","produces":["application/json"],"responses":{"200":{"description":"The authenticated user was successfully removed from the project.","schema":{"type":"object"}},"403":{"description":"The user making call is not in project.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"Project does not exist.","schema":{"$ref":"#/definitions/ErrorModel"}},"409":{"description":"The user is the only user in the project.","schema":{"$ref":"#/definitions/ErrorModel"}},"412":{"description":"The user is using projectId as current project.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Removes the user from a given project","tags":["projects"],"parameters":[{"description":"The id of the project from which the currently authenticated user wants to leave.","in":"path","name":"projectId","required":true,"type":"string"},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/references/uploads":{"post":{"operationId":"UploadAttachUpload","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"412":{"description":"Validation error. Please check the request is correct.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Adds an attachment to a reference or creates a new reference with the attachment.","tags":["references"],"consumes":["application/json"],"parameters":[{"description":"","in":"body","name":"upload","required":true,"schema":{"$ref":"#/definitions/UploadModel"}},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/references/uploads/copy/attachment":{"post":{"operationId":"UploadCopyAttachments","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"Not found","schema":{"$ref":"#/definitions/ErrorModel"}},"412":{"description":"Validation error. Please check the request is correct.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"","tags":["references"],"consumes":["application/json"],"parameters":[{"description":"","in":"body","name":"upload","required":true,"schema":{"$ref":"#/definitions/UploadDuplicateModel"}},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/institution/rolesAndAreaOfFocus":{"get":{"operationId":"InstitutionGetRolesAndAreaOfFocus","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/Institution"}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"This institution does not exist.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Gest the institution's Roles and Areas of Focus.","tags":["institution"],"parameters":[{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]},"post":{"operationId":"InstitutionUpdateRolesAndAreaOfFocus","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/Institution"}},"401":{"description":"This user is not authorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"This institution Id does not exist.","schema":{"$ref":"#/definitions/ErrorModel"}},"412":{"description":"Bad request: Invalid input in the payload.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Updates the institution's Roles and Areas of Focus.","tags":["institution"],"consumes":["application/json"],"parameters":[{"description":"","in":"body","name":"requestData","required":true,"schema":{"$ref":"#/definitions/RolesAndAreaOfFocusList"}},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/auth/login":{"post":{"operationId":"ExternalAuthenticationExternalLogin","produces":["text/html"],"responses":{"204":{"description":"No content"}},"description":"Starts the user login to RefWorks. Redirects to the RefWorks login page if the user was not logged in previously.\nAdds authorization_code parameter to the redirect_url. This code is needed in the POST /auth/post.\n\nRequest body model as \"Form data\":\nclient_id Your system's client id in Refworks\nredirect_url The URL to be redirected to after logging the user into RefWorks","tags":["authentication"],"consumes":["application/json"],"parameters":[]}},"/auth/token":{"post":{"operationId":"ExternalAuthenticationCreateToken","produces":["application/json","text/html"],"responses":{"204":{"description":"No content"},"400":{"description":"Bad request: Invalid input in the payload.","schema":{"$ref":"#/definitions/ErrorModel"}},"412":{"description":"Missing fields in the notification request.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Handshake to confirm the user's login. Given an authorization code it returns an access_token that can be used to access the API as the user.\nRequest body model as \"Form data\":\ncode The authorization code obtained from POST /auth/login\nclient_id Your system's client id in RefWorks\nclient_secret Your system's secret key","tags":["authentication"],"consumes":["application/json"],"parameters":[]}},"/auth/logout":{"post":{"operationId":"ExternalAuthenticationExternalLogout","produces":["application/json","text/html"],"responses":{"204":{"description":"No content"},"400":{"description":"Bad request: Invalid input in the payload.","schema":{"$ref":"#/definitions/ErrorModel"}},"412":{"description":"Missing fields in the notification request.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Logs the user out of their RefWorks account.\nRequest body model as \"Form data\":\nredirect_uri The URL to be redirected to after logging the user out of RefWorks","tags":["authentication"],"consumes":["application/json"],"parameters":[]}},"/express":{"post":{"operationId":"ExpressDirectExportPost","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"412":{"description":"A param or few params are wrong.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Proxy to call ExpressImport.asp in RW1.","tags":["express"],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"description":"","in":"formData","name":"ImportData","required":false,"type":"object"},{"description":"","in":"query","name":"vendor","required":false,"type":"string"},{"description":"","in":"query","name":"filter","required":false,"type":"string"},{"description":"","in":"query","name":"flow","required":false,"type":"string"},{"description":"","in":"query","name":"database","required":false,"type":"string"},{"description":"","in":"query","name":"encoding","required":false,"type":"string"},{"description":"","in":"query","name":"providerID","required":false,"type":"string"},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]},"get":{"operationId":"ExpressDirectExportCallback","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"412":{"description":"A param or few params are wrong.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"","tags":["express"],"parameters":[{"description":"","in":"query","name":"vendor","required":false,"type":"string"},{"description":"","in":"query","name":"filter","required":false,"type":"string"},{"description":"","in":"query","name":"flow","required":false,"type":"string"},{"description":"","in":"query","name":"database","required":false,"type":"string"},{"description":"","in":"query","name":"url","required":false,"type":"string"},{"description":"","in":"query","name":"encoding","required":false,"type":"string"},{"description":"","in":"query","name":"providerID","required":false,"type":"string"},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}},"/express/data":{"get":{"operationId":"ExpressGetXmlFile","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"412":{"description":"A param or few params are wrong.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Proxy to call RW2api and return xml file.","tags":["express"],"parameters":[{"description":"","in":"query","name":"method","required":true,"type":"string"},{"description":"","in":"query","name":"expires","required":true,"type":"string"},{"description":"","in":"query","name":"accesskeyid","required":true,"type":"string"},{"description":"","in":"query","name":"signature","required":true,"type":"string"},{"description":"","in":"query","name":"encoding","required":true,"type":"string"},{"description":"","in":"query","name":"class","required":true,"type":"string"},{"description":"","in":"query","name":"detoken","required":true,"type":"string"},{"description":"Application ID. To keep track of who is requesting the endpoint.","in":"header","name":"appid","required":true,"type":"string"},{"description":"Version of the API. It must be set to 1","in":"header","name":"apiVersion","required":false,"type":"string"}],"security":[{"cookie_string":[]}]}}},"swagger":"2.0","securityDefinitions":{"cookie_string":{"type":"apiKey","name":"cookiestring","in":"header"}},"produces":["application/json"],"host":"api.refworks.proquest.com","tags":[{"name":"authentication","description":"User authentication"},{"name":"citationstyles","description":"Citation style management"},{"name":"folders","description":"Folder management"},{"name":"formatter","description":"Citation style formatting"},{"name":"institution","description":"Roles and Areas of Focus"},{"name":"monitor","description":"Application healthcheck"},{"name":"references","description":"Reference management"},{"name":"projects","description":"Project management"},{"name":"public","description":"Publicly shared folder management"}],"validatorUrl":null},"customOptions":{}}