EndNote REST API

{"swagger":"2.0","info":{"title":"EndNote REST API","description":"Create and update references in an Endnote library","contact":{"name":"EndNote API Beta Coordinator","email":"gillian.neff@clarivate.com"},"version":"1.0.0"},"host":"api.clarivate.com","basePath":"/api/endnote/v1","schemes":["https"],"consumes":["application/json"],"produces":["application/json"],"paths":{"/user_space/attachment_size":{"get":{"summary":"Retrieve the current total space of the all user's attachments","description":"If user's total space is not unlimited, this size cannot be more than totalSpace field. ","operationId":"readuserAttachmentSize","responses":{"200":{"description":"Retrieve the content of this resource. ","schema":{"description":"A resource is any object addressed by a URI. it is actually a wrapper of the object, and it can wrap either a single object or a collection of objects (Collection resource).It is basically the URI object with resource content. Properties id and display are not included because either are included in the resource content or are irrelevant.Property result value has the name of the property a GET operation will include resource data. Property on contains the timestamp when this request was processed by the server. Server has included this date in any property of type DATE processed by it (system or readOnly).  If the resource is collection, this object will have additional properties and uris, implementing Collection Iterator pattern.Property pageSize value is the amount of objets from the server.Property page value is the page number of the iteration.Property orderBy is a collection of ORDER object that specifies the collection sorting.If the size of the collection is smaller than pageSize value, property total will be included with the size of the collection, and server will include no other collection property but pageSize.first, previous, next, last are uri properties that replacing the current uri property will set the collection to first, previous, next or last page. Total uri will complete this object by including properties total and lastPage.","properties":{"referenceUserSpaceUri":{"$ref":"#/definitions/uri"},"totalSpace":{"format":"int64","description":"Total attachment size allowed to have in User's workspace.A positive Number","readOnly":true,"default":0,"type":"integer"},"results":{"description":"Name of the property whose value will be the data of this resource.","type":"string"},"referenceLimit":{"format":"int64","description":"Total Amount of references allowed to have in User's workspace.A positive Number","readOnly":true,"default":0,"type":"integer"},"data":{"$ref":"#/definitions/userspaceresource"},"referenceCount":{"format":"int64","description":"Current Amount of references in the User's space.A positive Number","readOnly":true,"default":0,"type":"integer"},"on":{"format":"int64","description":"TimeStamp of the processing of the current request. Its value is actually a date: milliseconds since 01/01/1970 in GMT","type":"integer"},"sizeAvailable":{"format":"int64","description":"Current space size available in the User's space.A positive Number","readOnly":true,"default":0,"type":"integer"},"unlimitedSpace":{"description":"As true, the user has unlimited space for attachments. ","readOnly":true,"default":false,"type":"boolean"},"uri":{"$ref":"#/definitions/uri"},"attachmentSize":{"format":"int64","description":"Current size of all attachments in the User's workspace.A positive Number","readOnly":true,"default":0,"type":"integer"},"referenceCountRemaining":{"format":"int64","description":"Current Amount of references allowed to create in User's workspace.A positive Number","readOnly":true,"default":0,"type":"integer"}},"type":"object"}}}},"parameters":[{"$ref":"#/parameters/routingHeader"},{"$ref":"#/parameters/acceptHeader"},{"$ref":"#/parameters/contentTypeHeader"}]},"/user_space/attachments":{"get":{"summary":"Retrieve the total space available for a user","description":"If the total space is not unlimited, it includes current used space and remaining. ","operationId":"readuserAttachmentSpace","responses":{"200":{"description":"Retrieve the content of this resource. ","schema":{"description":"A resource is any object addressed by a URI. it is actually a wrapper of the object, and it can wrap either a single object or a collection of objects (Collection resource).It is basically the URI object with resource content. Properties id and display are not included because either are included in the resource content or are irrelevant.Property result value has the name of the property a GET operation will include resource data. Property on contains the timestamp when this request was processed by the server. Server has included this date in any property of type DATE processed by it (system or readOnly).  If the resource is collection, this object will have additional properties and uris, implementing Collection Iterator pattern.Property pageSize value is the amount of objets from the server.Property page value is the page number of the iteration.Property orderBy is a collection of ORDER object that specifies the collection sorting.If the size of the collection is smaller than pageSize value, property total will be included with the size of the collection, and server will include no other collection property but pageSize.first, previous, next, last are uri properties that replacing the current uri property will set the collection to first, previous, next or last page. Total uri will complete this object by including properties total and lastPage.","properties":{"referenceUserSpaceUri":{"$ref":"#/definitions/uri"},"totalSpace":{"format":"int64","description":"Total attachment size allowed to have in User's workspace.A positive Number","readOnly":true,"default":0,"type":"integer"},"results":{"description":"Name of the property whose value will be the data of this resource.","type":"string"},"referenceLimit":{"format":"int64","description":"Total Amount of references allowed to have in User's workspace.A positive Number","readOnly":true,"default":0,"type":"integer"},"data":{"$ref":"#/definitions/userspaceresource"},"referenceCount":{"format":"int64","description":"Current Amount of references in the User's space.A positive Number","readOnly":true,"default":0,"type":"integer"},"on":{"format":"int64","description":"TimeStamp of the processing of the current request. Its value is actually a date: milliseconds since 01/01/1970 in GMT","type":"integer"},"sizeAvailable":{"format":"int64","description":"Current space size available in the User's space.A positive Number","readOnly":true,"default":0,"type":"integer"},"unlimitedSpace":{"description":"As true, the user has unlimited space for attachments. ","readOnly":true,"default":false,"type":"boolean"},"uri":{"$ref":"#/definitions/uri"},"attachmentSize":{"format":"int64","description":"Current size of all attachments in the User's workspace.A positive Number","readOnly":true,"default":0,"type":"integer"},"referenceCountRemaining":{"format":"int64","description":"Current Amount of references allowed to create in User's workspace.A positive Number","readOnly":true,"default":0,"type":"integer"}},"type":"object"}}}},"parameters":[{"$ref":"#/parameters/routingHeader"},{"$ref":"#/parameters/acceptHeader"},{"$ref":"#/parameters/contentTypeHeader"}]},"/reference/types":{"get":{"summary":"Retrieves the full collection of all reference types","description":"The collection is not framed by any query parameter. Server respond with 200 and the collection is sent in a payload to the client application. ","operationId":"readtypes","consumes":["application/json"],"produces":["application/json"],"responses":{"200":{"description":"Retrieve the content of this resource. ","schema":{"description":"A resource is any object addressed by a URI. it is actually a wrapper of the object, and it can wrap either a single object or a collection of objects (Collection resource).It is basically the URI object with resource content. Properties id and display are not included because either are included in the resource content or are irrelevant.Property result value has the name of the property a GET operation will include resource data. Property on contains the timestamp when this request was processed by the server. Server has included this date in any property of type DATE processed by it (system or readOnly).  If the resource is collection, this object will have additional properties and uris, implementing Collection Iterator pattern.Property pageSize value is the amount of objets from the server.Property page value is the page number of the iteration.Property orderBy is a collection of ORDER object that specifies the collection sorting.If the size of the collection is smaller than pageSize value, property total will be included with the size of the collection, and server will include no other collection property but pageSize.first, previous, next, last are uri properties that replacing the current uri property will set the collection to first, previous, next or last page. Total uri will complete this object by including properties total and lastPage.","properties":{"results":{"description":"Name of the property whose value will be the data of this resource.","type":"string"},"data":{"$ref":"#/definitions/referencetype"},"on":{"format":"int64","description":"TimeStamp of the processing of the current request. Its value is actually a date: milliseconds since 01/01/1970 in GMT","type":"integer"}},"type":"object"}}}},"parameters":[{"$ref":"#/parameters/routingHeader"},{"$ref":"#/parameters/acceptHeader"},{"$ref":"#/parameters/contentTypeHeader"}]},"/user_space":{"get":{"summary":"Retrieve user's space of the library","description":"User's space includes the amount of objects, references and attachments, that a user currently has in the library, the maximum amount of these objects a user can have in the library, and the amount of these objects that a user can still add.","operationId":"readuserSpace","responses":{"200":{"description":"Retrieve the content of this resource. ","schema":{"description":"A resource is any object addressed by a URI. it is actually a wrapper of the object, and it can wrap either a single object or a collection of objects (Collection resource).It is basically the URI object with resource content. Properties id and display are not included because either are included in the resource content or are irrelevant.Property result value has the name of the property a GET operation will include resource data. Property on contains the timestamp when this request was processed by the server. Server has included this date in any property of type DATE processed by it (system or readOnly).  If the resource is collection, this object will have additional properties and uris, implementing Collection Iterator pattern.Property pageSize value is the amount of objets from the server.Property page value is the page number of the iteration.Property orderBy is a collection of ORDER object that specifies the collection sorting.If the size of the collection is smaller than pageSize value, property total will be included with the size of the collection, and server will include no other collection property but pageSize.first, previous, next, last are uri properties that replacing the current uri property will set the collection to first, previous, next or last page. Total uri will complete this object by including properties total and lastPage.","properties":{"referenceUserSpaceUri":{"$ref":"#/definitions/uri"},"totalSpace":{"format":"int64","description":"Total attachment size allowed to have in User's workspace.A positive Number","readOnly":true,"default":0,"type":"integer"},"results":{"description":"Name of the property whose value will be the data of this resource.","type":"string"},"referenceLimit":{"format":"int64","description":"Total Amount of references allowed to have in User's workspace.A positive Number","readOnly":true,"default":0,"type":"integer"},"data":{"$ref":"#/definitions/userspaceresource"},"referenceCount":{"format":"int64","description":"Current Amount of references in the User's space.A positive Number","readOnly":true,"default":0,"type":"integer"},"on":{"format":"int64","description":"TimeStamp of the processing of the current request. Its value is actually a date: milliseconds since 01/01/1970 in GMT","type":"integer"},"sizeAvailable":{"format":"int64","description":"Current space size available in the User's space.A positive Number","readOnly":true,"default":0,"type":"integer"},"unlimitedSpace":{"description":"As true, the user has unlimited space for attachments. ","readOnly":true,"default":false,"type":"boolean"},"uri":{"$ref":"#/definitions/uri"},"attachmentSize":{"format":"int64","description":"Current size of all attachments in the User's workspace.A positive Number","readOnly":true,"default":0,"type":"integer"},"referenceCountRemaining":{"format":"int64","description":"Current Amount of references allowed to create in User's workspace.A positive Number","readOnly":true,"default":0,"type":"integer"}},"type":"object"}}}},"parameters":[{"$ref":"#/parameters/routingHeader"},{"$ref":"#/parameters/acceptHeader"},{"$ref":"#/parameters/contentTypeHeader"}]},"/user_space/references":{"get":{"summary":"Retrieve the amount of references that a user currently has, the amount of references a user can have in the library, and the amount of references that a user can still add.","operationId":"readuserReferenceSpace","responses":{"200":{"description":"Retrieve the content of this resource. ","schema":{"description":"A resource is any object addressed by a URI. it is actually a wrapper of the object, and it can wrap either a single object or a collection of objects (Collection resource).It is basically the URI object with resource content. Properties id and display are not included because either are included in the resource content or are irrelevant.Property result value has the name of the property a GET operation will include resource data. Property on contains the timestamp when this request was processed by the server. Server has included this date in any property of type DATE processed by it (system or readOnly).  If the resource is collection, this object will have additional properties and uris, implementing Collection Iterator pattern.Property pageSize value is the amount of objets from the server.Property page value is the page number of the iteration.Property orderBy is a collection of ORDER object that specifies the collection sorting.If the size of the collection is smaller than pageSize value, property total will be included with the size of the collection, and server will include no other collection property but pageSize.first, previous, next, last are uri properties that replacing the current uri property will set the collection to first, previous, next or last page. Total uri will complete this object by including properties total and lastPage.","properties":{"referenceUserSpaceUri":{"$ref":"#/definitions/uri"},"totalSpace":{"format":"int64","description":"Total attachment size allowed to have in User's workspace.A positive Number","readOnly":true,"default":0,"type":"integer"},"results":{"description":"Name of the property whose value will be the data of this resource.","type":"string"},"referenceLimit":{"format":"int64","description":"Total Amount of references allowed to have in User's workspace.A positive Number","readOnly":true,"default":0,"type":"integer"},"data":{"$ref":"#/definitions/userspaceresource"},"referenceCount":{"format":"int64","description":"Current Amount of references in the User's space.A positive Number","readOnly":true,"default":0,"type":"integer"},"on":{"format":"int64","description":"TimeStamp of the processing of the current request. Its value is actually a date: milliseconds since 01/01/1970 in GMT","type":"integer"},"sizeAvailable":{"format":"int64","description":"Current space size available in the User's space.A positive Number","readOnly":true,"default":0,"type":"integer"},"unlimitedSpace":{"description":"As true, the user has unlimited space for attachments. ","readOnly":true,"default":false,"type":"boolean"},"uri":{"$ref":"#/definitions/uri"},"attachmentSize":{"format":"int64","description":"Current size of all attachments in the User's workspace.A positive Number","readOnly":true,"default":0,"type":"integer"},"referenceCountRemaining":{"format":"int64","description":"Current Amount of references allowed to create in User's workspace.A positive Number","readOnly":true,"default":0,"type":"integer"}},"type":"object"}}}},"parameters":[{"$ref":"#/parameters/routingHeader"},{"$ref":"#/parameters/acceptHeader"},{"$ref":"#/parameters/contentTypeHeader"}]},"/references/{guid}/file":{"post":{"summary":"Create a file attached to this reference","description":"File Content must send in the request body. Client Application must provide the guid of the attaching reference in request header x-enws-reference-guid as well as name in request header x-enws-name and checksum (CRC32) in request header x-enws-checksumA file name is mandatory when creating an attachment. Client Application can send it in the request header: x-enws-name. The server will respond with 400 if any mandatory header is missing. If succeed, the server will respond with 201 created, and place in responde header Location the specific URI to this attachment. ","operationId":"create/references/{guid}/file","consumes":["application/octet-stream"],"produces":["application/json"],"parameters":[{"description":"File content as stream of bytes.","name":"content","in":"body","schema":{"format":"binary","type":"string"}}],"responses":{"201":{"description":"Create a new file attachment. "}}},"parameters":[{"name":"guid","in":"path","required":true,"type":"string"},{"$ref":"#/parameters/routingHeader"},{"$ref":"#/parameters/acceptHeader"},{"$ref":"#/parameters/contentTypeHeader"}]},"/reference":{"get":{"summary":"Retrieve the reference specified in header x-enws-guid","description":"Use it when Client application has a reference object, but not its URI, it can use this in order to get the current state of that reference by including its guid in that request header. If Client Application does not provide any value in header x-enws-guid, server responds with 400 Bad Request, otherwise the response code will be 200 and the reference will be sent it back in a payload. If the reference does not exist or it is in the trash, no reference will be found in the payload. ","operationId":"read/reference","consumes":["application/json"],"produces":["application/json"],"responses":{"200":{"description":"Retrieve the content of this resource. ","schema":{"description":"A resource is any object addressed by a URI. it is actually a wrapper of the object, and it can wrap either a single object or a collection of objects (Collection resource).It is basically the URI object with resource content. Properties id and display are not included because either are included in the resource content or are irrelevant.Property result value has the name of the property a GET operation will include resource data. Property on contains the timestamp when this request was processed by the server. Server has included this date in any property of type DATE processed by it (system or readOnly).  If the resource is collection, this object will have additional properties and uris, implementing Collection Iterator pattern.Property pageSize value is the amount of objets from the server.Property page value is the page number of the iteration.Property orderBy is a collection of ORDER object that specifies the collection sorting.If the size of the collection is smaller than pageSize value, property total will be included with the size of the collection, and server will include no other collection property but pageSize.first, previous, next, last are uri properties that replacing the current uri property will set the collection to first, previous, next or last page. Total uri will complete this object by including properties total and lastPage.","properties":{"results":{"description":"Name of the property whose value will be the data of this resource.","type":"string"},"data":{"$ref":"#/definitions/roareference"},"on":{"format":"int64","description":"TimeStamp of the processing of the current request. Its value is actually a date: milliseconds since 01/01/1970 in GMT","type":"integer"}},"type":"object"}},"201":{"description":"Create a new resource in the server or a new URI to address it. "}}},"put":{"summary":"Change a set of a reference bibliographic content fields","description":"Field biblioContent, guid, and updateSequenceNumber are required in the request. It must contains at least the set of field values the user would like to change, but it can include unchanged fields too by submitting the whole reference object. If the user has made some changes in this reference with another application, the server will respond with 409 Conflict, and it will send the current state of this reference in the server in the field conflicts. Client applications may ask the user to resolve this conflict. Include the updateSequenceNumber field retrieved by the server, otherwise server will keep responding with 409. Server will respond with 201 and will place a new URI to access to this reference in LOCATION header. This new URI includes the current updateSequenceNumber, soit must replece the original one in order to send the next update without conflicts. ","operationId":"update/reference","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"roareference","in":"body","schema":{"$ref":"#/definitions/roareference"}}],"responses":{"200":{"description":"Retrieve the content of this resource. ","schema":{"description":"A resource is any object addressed by a URI. it is actually a wrapper of the object, and it can wrap either a single object or a collection of objects (Collection resource).It is basically the URI object with resource content. Properties id and display are not included because either are included in the resource content or are irrelevant.Property result value has the name of the property a GET operation will include resource data. Property on contains the timestamp when this request was processed by the server. Server has included this date in any property of type DATE processed by it (system or readOnly).  If the resource is collection, this object will have additional properties and uris, implementing Collection Iterator pattern.Property pageSize value is the amount of objets from the server.Property page value is the page number of the iteration.Property orderBy is a collection of ORDER object that specifies the collection sorting.If the size of the collection is smaller than pageSize value, property total will be included with the size of the collection, and server will include no other collection property but pageSize.first, previous, next, last are uri properties that replacing the current uri property will set the collection to first, previous, next or last page. Total uri will complete this object by including properties total and lastPage.","properties":{"results":{"description":"Name of the property whose value will be the data of this resource.","type":"string"},"data":{"$ref":"#/definitions/roareference"},"on":{"format":"int64","description":"TimeStamp of the processing of the current request. Its value is actually a date: milliseconds since 01/01/1970 in GMT","type":"integer"}},"type":"object"}},"201":{"description":"Create a new resource in the server or a new URI to address it. "}}},"post":{"summary":"Creates a reference from a set of its fields","description":"BiblioContent field is required in the request body and it must have at least one field with valid value. Otherwise, the server will not create a new reference, and it will response with 400 bad request. Content-Type request header will contain the format of the set of data in the request body. By default, we accept application/json. If client application provides data in a format that server is not able to process, the server will respond with 415. The server will create a unique value in field guid, and set a value to updateSequenceNumber. It also assign the current time to dates fields created and updated. After a successful process of this operation, the server respond with 201 created, and it will place in Location response header the individual uri to this reference. Client application can use this URI in order to send changes in the biblioContent field. ","operationId":"create/reference","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"roareference","in":"body","schema":{"$ref":"#/definitions/roareference"}}],"responses":{"200":{"description":"Retrieve the content of this resource. ","schema":{"description":"A resource is any object addressed by a URI. it is actually a wrapper of the object, and it can wrap either a single object or a collection of objects (Collection resource).It is basically the URI object with resource content. Properties id and display are not included because either are included in the resource content or are irrelevant.Property result value has the name of the property a GET operation will include resource data. Property on contains the timestamp when this request was processed by the server. Server has included this date in any property of type DATE processed by it (system or readOnly).  If the resource is collection, this object will have additional properties and uris, implementing Collection Iterator pattern.Property pageSize value is the amount of objets from the server.Property page value is the page number of the iteration.Property orderBy is a collection of ORDER object that specifies the collection sorting.If the size of the collection is smaller than pageSize value, property total will be included with the size of the collection, and server will include no other collection property but pageSize.first, previous, next, last are uri properties that replacing the current uri property will set the collection to first, previous, next or last page. Total uri will complete this object by including properties total and lastPage.","properties":{"results":{"description":"Name of the property whose value will be the data of this resource.","type":"string"},"data":{"$ref":"#/definitions/roareference"},"on":{"format":"int64","description":"TimeStamp of the processing of the current request. Its value is actually a date: milliseconds since 01/01/1970 in GMT","type":"integer"}},"type":"object"}},"201":{"description":"Create a new resource in the server or a new URI to address it. "}}},"parameters":[{"$ref":"#/parameters/routingHeader"},{"$ref":"#/parameters/acceptHeader"},{"$ref":"#/parameters/contentTypeHeader"}]},"/references/{guid}":{"get":{"summary":"Retreive the set of fields of a specific reference","description":"Accept request header will contain the format of the set of data in the response body. By default, we accept application/json. If client application request a reference content in a format that server is not able to process, the server will respond with 406.After a successful process of this operation, the server respond with 200. Field result contains the name of the field that will contain the reference content. By default, it is data.If a client application has previously deleted this reference, there will be no field containing this reference content, but the server still responds with 200. ","operationId":"read/references/{guid}","consumes":["application/json"],"produces":["application/json"],"responses":{"200":{"description":"Retrieve the content of this resource. ","schema":{"description":"A resource is any object addressed by a URI. it is actually a wrapper of the object, and it can wrap either a single object or a collection of objects (Collection resource).It is basically the URI object with resource content. Properties id and display are not included because either are included in the resource content or are irrelevant.Property result value has the name of the property a GET operation will include resource data. Property on contains the timestamp when this request was processed by the server. Server has included this date in any property of type DATE processed by it (system or readOnly).  If the resource is collection, this object will have additional properties and uris, implementing Collection Iterator pattern.Property pageSize value is the amount of objets from the server.Property page value is the page number of the iteration.Property orderBy is a collection of ORDER object that specifies the collection sorting.If the size of the collection is smaller than pageSize value, property total will be included with the size of the collection, and server will include no other collection property but pageSize.first, previous, next, last are uri properties that replacing the current uri property will set the collection to first, previous, next or last page. Total uri will complete this object by including properties total and lastPage.","properties":{"attachmentLimit":{"format":"int64","description":"Total amount of files that can be attached to this reference. A positive Number","default":0,"type":"integer"},"results":{"description":"Name of the property whose value will be the data of this resource.","type":"string"},"data":{"$ref":"#/definitions/roareference"},"on":{"format":"int64","description":"TimeStamp of the processing of the current request. Its value is actually a date: milliseconds since 01/01/1970 in GMT","type":"integer"},"figureLimit":{"format":"int64","description":"Total amount of figures that can be attached to this reference. A positive Number","default":0,"type":"integer"}},"type":"object"}},"201":{"description":"Create a new resource in the server or a new URI to address it. "}}},"put":{"summary":"Change a set of this reference bibliographic content fields","description":"Field biblioContent is a required field in the request. It must contains at least the set of field values the user would like to change, but it can include unchanged fields too. If the user has made some changes in this reference with another application, the server will respond with 409 Conflict, and it will send the current state of this reference in the server in the field conflicts. Client applications may ask the user to resolve this conflict. Replace this url with the url included in the field uri, otherwise server will keep responding with 409. Server will respond with 201 and will place a new URI to access to this reference in LOCATION header. This new URI includes the current updateSequenceNumber, soit must replece the original one in order to send the next update without conflicts. ","operationId":"update/references/{guid}","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"roareference","in":"body","schema":{"$ref":"#/definitions/roareference"}}],"responses":{"200":{"description":"Retrieve the content of this resource. ","schema":{"description":"A resource is any object addressed by a URI. it is actually a wrapper of the object, and it can wrap either a single object or a collection of objects (Collection resource).It is basically the URI object with resource content. Properties id and display are not included because either are included in the resource content or are irrelevant.Property result value has the name of the property a GET operation will include resource data. Property on contains the timestamp when this request was processed by the server. Server has included this date in any property of type DATE processed by it (system or readOnly).  If the resource is collection, this object will have additional properties and uris, implementing Collection Iterator pattern.Property pageSize value is the amount of objets from the server.Property page value is the page number of the iteration.Property orderBy is a collection of ORDER object that specifies the collection sorting.If the size of the collection is smaller than pageSize value, property total will be included with the size of the collection, and server will include no other collection property but pageSize.first, previous, next, last are uri properties that replacing the current uri property will set the collection to first, previous, next or last page. Total uri will complete this object by including properties total and lastPage.","properties":{"attachmentLimit":{"format":"int64","description":"Total amount of files that can be attached to this reference. A positive Number","default":0,"type":"integer"},"results":{"description":"Name of the property whose value w

# --- truncated at 32 KB (46 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/clarivate/refs/heads/main/openapi/clarivate-endnote-openapi.json