{"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":""}},"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":{"type":"string","enum":["RW3","RW2"],"description":""}},"type":"object","required":["userName","password","system"]},"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"]},"UserBulkActionResponse":{"description":"","properties":{"modifiedCount":{"type":"integer","format":"int32","description":""},"matchedCount":{"type":"integer","format":"int32","description":""}},"type":"object","required":["modifiedCount","matchedCount"]},"UserBulkActionRequest":{"description":"","properties":{"action":{"type":"string","enum":["ACTIVE","INACTIVE","MAKE_ADMIN","REVOKE_ADMIN"],"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"},"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":{"type":"string","enum":["WINDOWS","MAC"],"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"},"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":{"type":"string","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"],"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"}},"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"]},"RaiseEventRequest":{"description":"","properties":{"eventType":{"type":"string","enum":["ERROR","WARNING"],"description":""},"message":{"type":"string","description":""}},"type":"object","required":["eventType","message"]},"Style":{"description":"","properties":{"id":{"type":"string","description":""},"styleType":{"type":"string","enum":["csl","refworks"],"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"]},"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":""}},"type":"object","required":["inline","biblio","note","status","styleId"]},"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 *"}},"type":"object","required":["indexGroup","referenceMetaList"]},"FormatterRequest":{"description":"","properties":{"format":{"type":"string","enum":["text","html","json"],"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 *"}},"type":"object","required":["language","references"]},"FormatterBlobResponse":{"description":"","properties":{"data":{"$ref":"#/definitions/BiblioData"}},"type":"object","required":["data"]},"ProjectResponse":{"description":"","properties":{"totalProjects":{"type":"number","format":"double","description":""},"projects":{"type":"array","items":{"type":"object"},"description":""}},"type":"object","required":["totalProjects","projects"]},"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":""}},"type":"object","required":["id","userId","name","created","lastModified","lastAccessed","isArchived"]},"ProjectRequest":{"description":"","properties":{"name":{"type":"string","description":""},"isArchived":{"type":"boolean","description":""}},"type":"object"},"ProjectIdentifier":{"description":"","properties":{"id":{"type":"string","description":""}},"type":"object","required":["id"]},"PublicCitationsRequest":{"description":"","properties":{"selectionType":{"type":"string","enum":["selected","folder","search","all"],"description":""},"format":{"type":"string","enum":["text","html","json"],"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":{"type":"string","enum":["selected","folder","search","all"],"description":""},"format":{"type":"string","enum":["text","html","json"],"description":""},"folderId":{"type":"string","description":""},"style":{"type":"string","enum":[0,1,2,3],"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"]}},"info":{"description":"To use endpoints that need authentication you will need to 1. Call the sessions endpoint first and retrieve the auth-cookie that comes a response in the headers. 2. Use the 'auth-cookie' value to send it as a cookieString header when calling endpoint that need authentication. If the cookieString is missing we will attempt to generate it from Cookies. You must send id and user_token as part of the cookies and we generate the cookieString for you.","title":"RefWorks API","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":"This operation is used to get the healthcheck information for the API.","tags":["monitor"],"parameters":[]}},"/folders":{"get":{"operationId":"FolderGetAllFolders","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"array","items":{"$ref":"#/definitions/FolderInfo"}}},"401":{"description":"The user is unauthorized.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Gets all the folders for a given user account.","tags":["folders"],"parameters":[{"description":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]},"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":"The user is unauthorized.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Create a new folder for a given user account.","tags":["folders"],"consumes":["application/json"],"parameters":[{"description":"\"Name\" of the folder to be created.\n\"ParentId\" needed if the folder is a subfolder of another folder.","in":"body","name":"requestData","required":true,"schema":{"$ref":"#/definitions/FolderRequest"}},{"description":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]}},"/folders/{folderId}":{"delete":{"operationId":"FolderDeleteFolder","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"401":{"description":"The user is unauthorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"Not found","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Deletes the specified folder for a given user account.","tags":["folders"],"parameters":[{"description":"The id of the folder to be deleted. If it includes subfolders, those will be deleted as well.","in":"path","name":"folderId","required":true,"type":"string"},{"description":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]}},"/folders/{folderId}/move":{"patch":{"operationId":"FolderMoveFolder","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/FolderInfo"}},"400":{"description":"Either beforeId or afterId must be specified.","schema":{"$ref":"#/definitions/ErrorModel"}},"401":{"description":"The user is unauthorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"Not found","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Move a folder before or after another one. This requires beforeId OR afterId parameters to be sent. (Only one)","tags":["folders"],"consumes":["application/json"],"parameters":[{"description":"Id of the folder meant 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":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]}},"/folders/public":{"get":{"operationId":"FolderGetPublicFolders","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"array","items":{"$ref":"#/definitions/FolderPublicInfo"}}},"401":{"description":"The user is unauthorized.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Returns the public sharing folders for the user's.","tags":["folders"],"parameters":[{"description":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]}},"/folders/{folderId}/public":{"get":{"operationId":"FolderGetFolderPublicData","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/FolderPublicInfo"}},"401":{"description":"The user is unauthorized.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Gets public sharing data of the given folder.","tags":["folders"],"parameters":[{"description":"","in":"path","name":"folderId","required":true,"type":"string"},{"description":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]},"post":{"operationId":"FolderGeneratePublicUrl","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/FolderPublicInfo"}},"401":{"description":"The user is unauthorized.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Generates the public sharing url of the given folder.","tags":["folders"],"consumes":["application/json"],"parameters":[{"description":"","in":"path","name":"folderId","required":true,"type":"string"},{"description":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]},"put":{"operationId":"FolderUpdatePublicUrl","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/FolderPublicInfo"}},"401":{"description":"The user is unauthorized.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Generates the public sharing url of the given folder.","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":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]},"delete":{"operationId":"FolderDeleteFolderPublicData","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"401":{"description":"The user is unauthorized.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Removes the public sharing url of the given folder.","tags":["folders"],"parameters":[{"description":"","in":"path","name":"folderId","required":true,"type":"string"},{"description":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]}},"/sessions":{"post":{"operationId":"SessionCreate","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"400":{"description":"Bad Request: Invalid input in the payload.","schema":{"$ref":"#/definitions/ErrorModel"}},"401":{"description":"Authorization failed. Bad username or password","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Create a new session given a username, a password and the Refworks system.\nThis will return an authToken that can be used to invoke the endpoints that require authentication.","tags":["sessions"],"consumes":["application/json"],"parameters":[{"description":"\"system\" value can be RW2 or RW3 to log into Refworks 2 or Refworks 3 respectively.","in":"body","name":"sessionRequest","required":true,"schema":{"$ref":"#/definitions/CreateSessionRequest"}},{"description":"Pass \"cookie\" if you to get only an authentication cookie as the body of the response.","in":"query","name":"outputAs","required":false,"type":"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":"The user is unauthorized.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Retrieves a list of References depending on the parameters used. For NRW users it uses a minimal projection unless *fields* is set.\n ","tags":["references"],"parameters":[{"description":"Cannot be higher than 2000, if so, only 2000 records will be returned.","in":"query","name":"pageSize","required":true,"type":"number","format":"double"},{"description":"URIEncoded, a comma separated list of extra Reference field to be returned (For RW3 users only).\nCheck Reference model for allowed field names","in":"query","name":"fields","required":false,"type":"string"},{"description":"For RW3 users, only \"LastImported\" is supported (created in last 30 days).\nFor Legacy accounts: Check http://www.refworks.com/rwapireference/","in":"query","name":"filter","required":false,"type":"string"},{"description":"When used in conjunction with pageSize, if bigger than zero, start with that record. Defaults to zero.","in":"query","name":"fromIndex","required":false,"type":"number","format":"double"},{"description":"Possible values [date-added, date-accessed, date-published, author, title]. Defaults to date-added.","in":"query","name":"sortOrder","required":false,"type":"string"},{"description":"Allows a search to be performed based upon the given query.\nFor RW3 accounts: Queries are made based on lucene index sintax, ex. q=title:\"Some Title\"\nFor Legacy accounts: Check http://www.refworks.com/rwapireference/","in":"query","name":"q","required":false,"type":"string"},{"description":"If present, result is narrowed to References present in the specified folder.\nex: folder=project:577cfc28e4b03eb5f1034a61","in":"query","name":"folder","required":false,"type":"string"},{"description":"Allows a search to be performed based upon a list of reference ids. If present, it does override other filters.\nex: ids=doc:567479b5e4b0d7026421e522,doc:567479b5e4b0d7026421e523,doc:567479b5e4b0d7026421e524","in":"query","name":"ids","required":false,"type":"string"},{"description":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]}},"/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":"The user is unauthorized.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Gets References inside user's folder (:folderId) as selected by query params. All query params are optional\n \t ","tags":["references"],"parameters":[{"description":"Id of the desired folder","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 >0, start with that record. defaults to 0","in":"query","name":"fromIndex","required":false,"type":"string"},{"description":"defaults to 0 which means get all records","in":"query","name":"pageSize","required":false,"type":"string"},{"description":"defaults to date-added from [date-added, date-accessed, date-published, author, title]","in":"query","name":"sortOrder","required":false,"type":"string"},{"description":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]}},"/references/enrichment":{"get":{"operationId":"ReferenceGetEnrichmentByDoi","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/SummonResponse"}},"401":{"description":"The user is unauthorized.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Gets alternate ReferenceModels from a DOI","tags":["references"],"parameters":[{"description":"","in":"query","name":"doi","required":true,"type":"string"},{"description":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]}},"/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":"Returns all the styles available","tags":["citationstyles"],"parameters":[{"description":"Possible values: [refworks, csl, all].","in":"query","name":"source","required":false,"type":"string"},{"description":"Lucene style query, either 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. Defaults to 0","in":"query","name":"from","required":false,"type":"number","format":"double"},{"description":"Page size. Defaults to 10","in":"query","name":"size","required":false,"type":"number","format":"double"},{"description":"Fields to return as a comma separated list, defaults to 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":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]},"post":{"operationId":"BibliographyCreateStyles","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"201":{"description":"Successfully created the new CSL style","schema":{"type":"object"}},"400":{"description":"Invalid request","schema":{"$ref":"#/definitions/ErrorModel"}},"401":{"description":"The user is unauthorized.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Creates a new CSL style in RefWorks","tags":["citationstyles"],"consumes":["application/json"],"parameters":[{"description":"","in":"body","name":"request","required":true,"schema":{"$ref":"#/definitions/CslStyleRequest"}},{"description":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]}},"/citationstyles/recent":{"get":{"operationId":"BibliographyGetRecentCitationStyles","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"array","items":{"$ref":"#/definitions/Style"}}},"401":{"description":"The user is unauthorized.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Returns the recent styles for a user (up to 6)","tags":["citationstyles"],"parameters":[{"description":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]}},"/citationstyles/{id}":{"patch":{"operationId":"BibliographyUpdateCslStyle","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"400":{"description":"Invalid request","schema":{"$ref":"#/definitions/ErrorModel"}},"401":{"description":"The user is unauthorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"No matching CSL style found to update","schema":{"type":"object"}}},"description":"Updates an existing CSL style in RefWorks","tags":["citationstyles"],"consumes":["application/json"],"parameters":[{"description":"The id of the style to be updated.","in":"path","name":"id","required":true,"type":"string"},{"description":"","in":"body","name":"request","required":true,"schema":{"$ref":"#/definitions/CslStyleRequest"}},{"description":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]},"get":{"operationId":"BibliographyGetCitationStyle","produces":["application/json","text/html"],"responses":{"200":{"description":"Ok","schema":{"type":"string"}},"401":{"description":"The user is unauthorized.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Returns a style given the id","tags":["citationstyles"],"parameters":[{"description":"The id of the style.","in":"path","name":"id","required":true,"type":"string"},{"description":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]}},"/citationstyles/locales":{"post":{"operationId":"BibliographyCreateCslLocale","produces":["application/json","text/html"],"responses":{"201":{"description":"Successfully created a new CSL locale","schema":{"type":"object"}},"204":{"description":"No content"},"400":{"description":"Invalid request","schema":{"$ref":"#/definitions/ErrorModel"}},"401":{"description":"User is not authorized to create a new CSL Locale","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Create a new CSL Locale.","tags":["citationstyles"],"consumes":["application/json"],"parameters":[{"description":"","in":"body","name":"request","required":true,"schema":{"$ref":"#/definitions/CslLocale"}},{"description":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]}},"/citationstyles/locales/{id}":{"patch":{"operationId":"BibliographyUpdateCslLocale","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"400":{"description":"Invalid request","schema":{"$ref":"#/definitions/ErrorModel"}},"401":{"description":"The user is unauthorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"No matching CSL locale found to update","schema":{"type":"object"}}},"description":"Updates an existing CSL Locale in RefWorks","tags":["citationstyles"],"consumes":["application/json"],"parameters":[{"description":"The id of the style to be updated.","in":"path","name":"id","required":true,"type":"string"},{"description":"","in":"body","name":"request","required":true,"schema":{"$ref":"#/definitions/CslLocale"}},{"description":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]}},"/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":"Produces output in map format where key as the passed indexGroup and value is the formatted information","tags":["formatter"],"consumes":["application/json"],"parameters":[{"description":"Value must be one of [inline, bibliographic, note]","in":"query","name":"citation-type","required":true,"type":"string"},{"description":"Style id to apply for this formatting. Refworks has unique style id for each styles from CSL or RW3.","in":"path","name":"id","required":true,"type":"string"},{"description":"\"format\" must be one of [text, html, json]\n\"language\" must be in the following format: ex. en-US\n\"isRefworks\" - set this to true if the call is from within Refworks.\n\"indexGroup\" will be the index associated to the returning map.","in":"body","name":"formatterRequest","required":true,"schema":{"$ref":"#/definitions/FormatterRequest"}},{"description":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]}},"/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":"Produces blob output(RW3 terminology which gathers all formatting info in one place).","tags":["formatter"],"consumes":["application/json"],"parameters":[{"description":"Value must be one of [inline, bibliographic, note]","in":"query","name":"citation-type","required":true,"type":"string"},{"description":"Style id to apply for this formatting. Refworks has unique style id for each styles from CSL or RW3.","in":"path","name":"id","required":true,"type":"string"},{"description":"\"format\" must be one of [text, html, json]\n\"language\" must be in the following format: ex. en-US\n\"isRefworks\": set this to true if the call is from within Refworks.","in":"body","name":"formatterRequest","required":true,"schema":{"$ref":"#/definitions/FormatterRequest"}},{"description":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]}},"/projects":{"get":{"operationId":"ProjectGetProjects","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/ProjectResponse"}},"400":{"description":"Invalid input request. RW2 does not have Projects.","schema":{"$ref":"#/definitions/ErrorModel"}},"401":{"description":"The user is unauthorized.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Returns all the RW3 projects available","tags":["projects"],"parameters":[{"description":"The start offset for use when paging results. Defaults to 0","in":"query","name":"from","required":false,"type":"number","format":"double"},{"description":"Page size. Defaults to 10","in":"query","name":"size","required":false,"type":"number","format":"double"},{"description":"Fields to return as a comma separated list, defaults to 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":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]},"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":"Create a new Project in RefWorks","tags":["projects"],"consumes":["application/json"],"parameters":[{"description":"","in":"body","name":"request","required":true,"schema":{"$ref":"#/definitions/ProjectRequest"}},{"description":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]}},"/projects/{id}":{"get":{"operationId":"ProjectGetProject","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/Project"}},"400":{"description":"Invalid input request. RW2 does not have Projects.","schema":{"$ref":"#/definitions/ErrorModel"}},"401":{"description":"The user is unauthorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"Not found","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Returns a Project given the id","tags":["projects"],"parameters":[{"description":"The id of the project.","in":"path","name":"id","required":true,"type":"string"},{"description":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]},"patch":{"operationId":"ProjectUpdateProject","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/Project"}},"400":{"description":"Invalid input request. RW2 does not have Projects.","schema":{"$ref":"#/definitions/ErrorModel"}},"401":{"description":"The user is unauthorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"No matching Project found to update","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 attempted is not permitted.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Updates an existing Project in RefWorks","tags":["projects"],"consumes":["application/json"],"parameters":[{"description":"The id of the project to be updated.","in":"path","name":"id","required":true,"type":"string"},{"description":"","in":"body","name":"request","required":true,"schema":{"$ref":"#/definitions/ProjectRequest"}},{"description":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]}},"/projects/name/{projectName}":{"get":{"operationId":"ProjectGetProjectByName","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/Project"}},"400":{"description":"Invalid input request. RW2 does not have Projects.","schema":{"$ref":"#/definitions/ErrorModel"}},"401":{"description":"The user is unauthorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"Not found","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Returns a Project given the name","tags":["projects"],"parameters":[{"description":"The name of the project.","in":"path","name":"projectName","required":true,"type":"string"},{"description":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]}},"/projects/current":{"get":{"operationId":"ProjectGetCurrentProject","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/Project"}},"400":{"description":"Invalid input request. RW2 does not have Projects.","schema":{"$ref":"#/definitions/ErrorModel"}},"401":{"description":"The user is unauthorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"Not found","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Returns a Project that is the current project","tags":["projects"],"parameters":[{"description":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]},"put":{"operationId":"ProjectSetCurrentProject","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"$ref":"#/definitions/Project"}},"400":{"description":"Invalid input request. RW2 does not have Projects.","schema":{"$ref":"#/definitions/ErrorModel"}},"401":{"description":"The user is unauthorized.","schema":{"$ref":"#/definitions/ErrorModel"}},"404":{"description":"Not found","schema":{"$ref":"#/definitions/ErrorModel"}},"412":{"description":"The project id sent is not a valid ID","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Sets a Project to be the current project","tags":["projects"],"consumes":["application/json"],"parameters":[{"description":"","in":"body","name":"request","required":true,"schema":{"$ref":"#/definitions/ProjectIdentifier"}},{"description":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]}},"/public/{publicId}":{"get":{"operationId":"PublicGetPublicFolderInfo","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"}}},"description":"Gets the information for the root public 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":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]}},"/public/{publicId}/references":{"get":{"operationId":"PublicGetPublicFolderReferences","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"}}},"description":"Gets the list of all the references for the user for the public 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":"","in":"query","name":"pageNumber","required":false,"type":"number","format":"double"},{"description":"Page size. Defaults to 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":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]}},"/public/{publicId}/folders":{"get":{"operationId":"PublicGetPublicFolderFolders","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"}}},"description":"Gets the list of the first level of folders for the given public 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":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]}},"/public/{publicId}/folders/{folderId}/references":{"get":{"operationId":"PublicGetPublicFolderReferencesByFolderId","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"400":{"description":"Public folder and folderId are not associated."},"401":{"description":"A valid PublicID must be specified on the path."},"403":{"description":"PublicID must be specified on the path."}},"description":"Gets the list of all the references contained in the given 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 contained in the public folder.","in":"path","name":"folderId","required":true,"type":"string"},{"description":"The start offset for use when paging results. Defaults to 0","in":"query","name":"pageNumber","required":false,"type":"number","format":"double"},{"description":"Page size. Defaults to 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":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]}},"/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 on the path."},"403":{"description":"Reference id must be specified on the path."},"404":{"description":"No reference found for this id."}},"description":"Gets the details of a reference.","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 reference contained in the public folder.","in":"path","name":"referenceId","required":true,"type":"string"},{"description":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]}},"/public/{publicId}/folders/{folderId}/subfolders":{"get":{"operationId":"PublicGetPublicFolderFoldersByFolderId","produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"type":"object"}},"400":{"description":"Public folder and folderId are not associated."},"401":{"description":"A valid PublicID must be specified on the path."},"403":{"description":"PublicID must be specified on the path."}},"description":"Gets the list of all the first level folders contained in the given 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 contained in the public folder.","in":"path","name":"folderId","required":true,"type":"string"},{"description":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]}},"/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 on the path."},"403":{"description":"Reference id must be specified on the path."}},"description":"Gets the list of all the reference's attachments","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 reference contained in the public folder.","in":"path","name":"referenceId","required":true,"type":"string"},{"description":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]}},"/public/{publicId}/references/download/{attachmentId}/":{"get":{"operationId":"PublicGetPublicFolderReferenceAttachmentByAttachmentId","produces":["text/html"],"responses":{"204":{"description":"No content"},"401":{"description":"A valid reference id must be specified on the path."},"403":{"description":"Reference id must be specified on the path."},"404":{"description":"No attachment found for this id."}},"description":"Returns the attachment as a file according to the attachment id","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 an attachment contained in the public folder.","in":"path","name":"attachmentId","required":true,"type":"string"},{"description":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]}},"/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 on the path.","schema":{"$ref":"#/definitions/ErrorModel"}},"403":{"description":"PublicID must be specified on the path.","schema":{"$ref":"#/definitions/ErrorModel"}}},"description":"Gets the list of the popular citation styles for public access.","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":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]}},"/public/{publicId}/citationstyles":{"post":{"operationId":"PublicFormatPublicCitations","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":"Gets the citations formatted given the requested params.","tags":["public"],"consumes":["application/json"],"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":"Uses the following fields:\nstyleId - The id of the style to be used.\nbibliographyOnly - This works only with CSL styles. Only returns the bibliography. Defaults to false.\nisRefworks - This works only with Refworks styles. Send true if formatter needs to apply custom Refworks rules. Defaults to false.\nformat - The format in which we return the citations. Values: \"html\", \"text\".\nselectionType - Is the type of references selection to be used. Values: \"selected\", \"folder\". Coming soon: \"search\", \"all\".\nfolderId - If selectionType is \"folder\" this indicates the id of the folder used.\nquery - If selectionType is \"search\" the query used in the search must be passed here.\nreferences - If selectionType is \"selected\" the selected reference ids must be passed here.","in":"body","name":"citationsRequest","required":true,"schema":{"$ref":"#/definitions/PublicCitationsRequest"}},{"description":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]}},"/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":"Gets the citations formatted given the requested params.","tags":["public"],"consumes":["application/json"],"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":"Uses the following fields:\nstyle - The style used to be exported. Values: \"bibtex\", \"ris\", \"tabDelimited\", \"xml\".\nisRefworks - This works only with Refworks styles. Send true if formatter needs to apply custom Refworks rules. Defaults to false.\nselectionType - Is the type of references selection to be used. Values: \"selected\", \"folder\". Coming soon: \"search\", \"all\".\nfolderId - If selectionType is \"folder\" this indicates the id of the folder used. Do not send it otherwise.\nquery - If selectionType is \"search\" the query used in the search must be passed here. Do not send it otherwise.\nreferences - If selectionType is \"selected\" the selected reference ids must be passed here. Do not send it otherwise.","in":"body","name":"formatterRequest","required":true,"schema":{"$ref":"#/definitions/PublicFormatterRequest"}},{"description":"Cookie string for authentication. Required for calls to secured endpoints.","in":"header","name":"cookieString","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"}]}}},"swagger":"2.0","securityDefinitions":{},"produces":["application/json"],"tags":[{"name":"monitor","description":"Services to monitor application health"},{"name":"sessions","description":"User session related services"},{"name":"citationstyles","description":"Services related to manage the citation styles"},{"name":"folders","description":"Folders related services"},{"name":"formatter","description":"Services to handle the citation styles formatting"},{"name":"references","description":"Reference related services"}],"validatorUrl":null},"customOptions":{}}