Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Notes can only have certain fields and have a specific format. Some of these fields are the same as other objects and some are specific to the Note object.
This is a unique value that identifies the Edge. The id
of an Edge is generated automatically. It is a random 7-14 character long string that can contain any of the following values:
The Creation Date or cdate
is a unix timestamp in milliseconds that can be set either in the past or in the future. It usually represents when the Edge was created.
The True Creation Date or tcdate
indicates the date in unix timestamp in milliseconds when the Edge is created. Unlike the cdate
, its value cannot be set or modified by the user and it is not displayed in the UI.
The Modification Date or mdate
shows when the Edge was last modified. The mdate
value is a unix timestamp in milliseconds that can be set either in the past or in the future.
The True Modification Date or tmdate
indicates the date in unix timestamp in milliseconds when the Edge is modified. Unlike the mdate
, its value cannot be set or modified by the user and it is not displayed in the UI.
The Deletion Date or ddate
is used to soft delete an Edge. This means that Edges with a ddate
value can be restored but will appear as deleted. The ddate
value is a unix timestamp in milliseconds that can be set either in the past or in the future.
The signatures
field indicates who created the Edge. Even though the field is an array of strings, only one item can be present in the signatures
field. Users can sign with different ids depending on their permissions.
The readers
field is an array with Group ids that indicates who can retrieve the Edge or see the Edge in the UI.
The nonreaders
field is an array with Group ids that indicates who cannot retrieve the Edge or see the Edge in the UI. This field is useful in case we want to use a group id in the readers
field that contains a member that we want to exclude from the readers
. In this case, we can specify the Group id of that user in the nonreaders
field.
The writers
field is an array with Group ids that indicates who can modify the Edge.
The head
field can contain a Note id or a Group id and connects it to the Note id or Group id defined in the tail
field. This field is always mandatory and cannot be empty.
The tail
field can contain a Note id or a Group id and connects it to the Note id or Group id defined in the head
field. This field is always mandatory and cannot be empty.
The tail
field can contain a Note id or a Group id and connects it to the Note id or Group id defined in the head
field. This field is always mandatory and cannot be empty.
The label
field contains a string that gives extra information to the Edge. This information can be used to classify Edges and differentiate them from other Edges that have the same Invitation, tail and head values.
The weight
field contains a number that defines the weight between two entities defined in head
and tail
.
The invitation
field contains the Invitation id that was used as template to create the Edge.
The tauthor
field contains the identity of the user that created the Edge. This property is only present when the user is writer of the Edge.
Notes can only have certain fields and have a specific format. Some of these fields are the same as other objects and some are specific to the Note object.
This is a unique value that identifies the Note. The id
of a Note is generated automatically. It is a random 7-14 character long string that can contain any of the following values:
Notes contain a number
field that is associated to the first Invitation that is used to create the Note. The number
value is added automatically and it is usually used to give a number id to submissions.
The Creation Date or cdate
is a unix timestamp in milliseconds that can be set either in the past or in the future. It usually represents when the Note was created.
The True Creation Date or tcdate
indicates the date in unix timestamp in milliseconds when the Note is created. Unlike the cdate
, its value cannot be set or modified by the user and it is not displayed in the UI.
The Modification Date or mdate
shows when the Note was last modified. The mdate
value is a unix timestamp in milliseconds that can be set either in the past or in the future.
The True Modification Date or tmdate
indicates the date in unix timestamp in milliseconds when the Note is modified. Unlike the mdate
, its value cannot be set or modified by the user and it is not displayed in the UI.
The Online Date or odate
is used to show when the Note first becomes public. The odate
value is a unix timestamp in milliseconds that can be set either in the past or in the future.
The Publication Date or pdate
is used to show when the Note that represents a submission is marked as Accepted. The pdate
value is a unix timestamp in milliseconds that can be set either in the past or in the future.
The Deletion Date or ddate
is used to soft delete an Note. This means that Notes with a ddate
value can be restored but will appear as deleted. The ddate
value is a unix timestamp in milliseconds that can be set either in the past or in the future.
The invitation
field contains the invitation id that was used to create the Note.
The signatures
field indicates who created the Note. Even though the field is an array of strings, only one item can be present in the signatures
field. Users can sign with different ids depending on their permissions.
The readers
field is an array with Group ids that indicates who can retrieve the Note or see the Note in the UI.
The nonreaders
field is an array with Group ids that indicates who cannot retrieve the Note or see the Note in the UI. This field is useful in case we want to use a group id in the readers
field that contains a member that we want to exclude from the readers
. In this case, we can specify the Group id of that user in the nonreaders
field.
The writers
field is an array with Group ids that indicates who can modify the Note.
The forum
field contains a Note id. When the Note id
field is equal to the forum
field, it indicates that the Note is a submission. Otherwise, it means that the Note is a comment to the submission. In other words, the forum
value indicates the forum the Note belongs to.
The replyto
contains a Note id. This field indicates what Note it is replying to. In other words, Notes that contain this field are comments in a forum.
The content
field is a JSON that can contain any field that is specified in the Invitation. The fields in content
should preferably only contain alphanumeric characters, underscores, and hyphens and have a max length of 80 characters.
Edges are used to represent matching data, like affinity scores, conflicts, custom quotas, etc. The Edge entity contains two main properties: head
and tail
and optionally a label
and weight
. Head
and tail
properties point to other entities in the system like a note, a group or a profile.
Notes are the main containers of data in OpenReview. Notes are used for submissions and comments such as reviews, meta reviews, decisions and public comments. They require an Invitation to be created and modified.
Users can enter data into the system using an invitation. An invitation is roughly a template that indicates required and valid values that will be saved to the database. The invitation contains a list of fields that need to be completed by the user.
When modifying an Invitation's reply field, each field must be a valid JSON with a title and the following optional properties (with the exception of field type, which is required):
field type: the type of the field, which includes value(s), value(s)-regex, value-radio, value(s)-checkbox, value(s)-dropdown, value-file
description: a string describing how users should fill this field
order: a number representing the position in which the field will appear on the form
required: a boolean representing whether the field is required (true) or optional (false)
default: the default value of the field
markdown: a boolean representing whether Markdown is enabled for the field (only valid for value-regex field type)
You can have different types of fields:
value, values: string or array of strings; the value(s) cannot be modified by the user.
value-regex, values-regex: string or array of strings; the value entered by the user should pass the regex validation.
value-radio: string or array of strings; the user can only choose one option.
value-checkbox, values-checkbox: string or array of strings; the user can select one or more options.
value-dropdown, values-dropdown: array of strings; the user can select one or more options from a dropdown.
value-file: a valid JSON specifying the expected upload file type and size in MB; the user can upload one file.
The fileTypes field expects an array of strings specifying the permitted file types that the user can upload. Supported field types are pdf, csv, zip and mp4.
Returns all the Notes by filter.
Note id.
Note ids.
Invitation id used to create the Note(s).
Invitation ids.
Reference referent.
Note id of the forum field.
Note id of the replyto field.
Note number.
Note title.
Note content confidence field value.
Note content strengths field value.
Note content weaknesses field value.
Note content decision field value.
Note content certification field values.
Note content previous_URL field value.
User email in recruitment.
User response in recruitment.
Note venue.
Note venueid.
Note venue_id.
Presentation Type.
Sessions.
Track.
List of tilde ids of registered users or of emails either registered or not.
Whether to get deleted Notes.
paperhash of the Note if exists.
Get Notes authored by user.
Get Notes written by user.
Get Notes signed by user.
Get Notes signed by users.
get Notes that are originals
Comma separated string with specific fields of the Note object to return.
Comma separated values of fields to add to details. Valid values are: replyCount: Number of replies in a forum. Only available if the Note is a forum. original: Include original Note if available. revisions: Boolean indicating whether the Note has revisions. writable: Boolean indicating whether the Note is writable by the user. originalWritable: Boolean indicating whether the original Note is writable by the user. tags: Tags of the Note. invitation: Invitation of the Note. originalInvitation: Invitation of the original Note. directReplyCount: Number of direct replies to the Note. directReplies: Direct replies to the Note. replies: Replies to the Note. Only available if the Note is a forum.
invitee
minimum creation date
due date
Sort returned Notes by field.
Maximum number of results to return.
Offset of the result shown.
Get result from cache. Without the right privileges this parameter will be ignored.
Note response
Get a reference attachment
Note id
attachment field name
attachment
Download an attachment
Note id that contains the attachment.
Attachment field name inside the content of the Note. This is usually pdf or supplementary_material.
Attachment
Download a PDF
Note id that contains the PDF.
Get a PDF
reference id
Gets the next available OpenReview username for the passed names.
first name
middle name
last name
Next available tilde username
Upload an attachment
Attachment field name. This is usually pdf or supplementary_material.
The id of the Invitation that allows to upload the attachment.
Path to the attachment.
Send feedback to the OpenReview team
Email address of the user sending the feedback.
Subject of the feedback.
The feedback.
feedback
Delete an Edge
Edge id of the Edge to delete.
Invitation id used to create the Edge.
Label of the Edge to delete.
Tail value of the Edge to delete.
Head value of the Edge to delete.
Whether to soft delete the Edge. When the Edge is soft deleted, the action can be reversed.
Whether to wait for the Edge(s) to be deleted.
edge
Create an edge
Edge
Get user profiles
Profile id.
Profile ids.
Email associated with the Profile.
Email(s) associated with the Profile.
Confirmed email associated with the Profile.
Confirmed email(s) associated with the Profile.
First name associated with the Profile.
Middle name associated with the Profile.
Last name associated with the Profile.
Email, Fullname or part of the fullname associated with the Profile.
Group id where to get all the member profiles.
Whether to include deleted profiles.
Whether to include blocked profiles.
Whether to return Profiles that need moderation.
Comma separated string with specific fields of the Profile object to return.
Sort returned Profiles by field.
Maximum number of results to return.
Offset of the result shown.
Get result from cache. Without the right privileges this parameter will be ignored.
Profile response
Get edges
Edge id
Maximum number of results to return.
Offset of the result shown.
Sort returned Edges by field.
Invitation id used to create the Edge(s).
head value of the Edge(s).
tail value of the Edge(s).
label of the Edge(s).
Whether to return deleted Edges as well.
Group result by different Edge fields.
Fields of the Edge to return in the result. Requires groupBy.
Comma separated values of fields to add to details. Valid values are head, tail, writable and all.
Get result from cache. Without the right privileges this parameter will be ignored.
edges
Get logs by different filters
log id
Parent Group id
Invitation id that contains the process function.
Status of the process. It can be ok or error.
Maximum number of results to return.
Offset of the result shown.
log response
Reset a user password
reset token
User is logged in after the password is reset.
Email used to log in.
OpenReview Profile id.
Profiles can have more than one username that have the same format as the OpenReview Profile id.
Preferred OpenReview username.
Find messages by different filters
Message id.
Email address of the recipient.
Subject of the Message.
Parent Group the recipient belongs to.
Status of the message.
Email of the author of the message.
Maximum number of results to return.
Offset of the result shown.
Get result from cache. Without the right privileges this parameter will be ignored.
message response
Find tags by different filters
Tag id
comma separated Tag ids
Invitation id used to create the Tag(s).
Tag value
Tag signature
Note id of the forum field.
Invitations should have replyto field
Get tags deleted too.
Get tags authored by user.
Comma separated values of fields to add to details. Valid values are forumContent, all.
Maximum number of results to return.
Offset of the result shown.
Tag response
Returns groups
Group id.
Group ids.
Group id regular expression.
Group id to get its transitive members.
Group id used to sign the returned Groups.
Group id that can is allowed to sign with the returned Groups.
Group id that is writer of the returned Groups.
Comma separated string with specific fields of the Group object to return.
Comma separated values of fields to add to details. Valid value is writable.
Maximum number of results to return.
Offset of the result shown.
Whether to return web ui code
Get result from cache. Without the right privileges this parameter will be ignored.
Group response
Creates or edit a Group
Group object
Group response
Adds members to a Group
Group object
Group id to which memebers will be added.
Members to add to the Group.
Group response
Removes members from a Group
Group object
Group id from which memebers will be removed.
Members to remove from the Group.
Group response
Impersonate a user
User token of the impersonated user and details of the impersonation.
Email used to log in.
OpenReview Profile id.
Profiles can have more than one username that have the same format as the OpenReview Profile id.
Preferred OpenReview username.
OpenReview Profile id.
Profiles can have more than one username that have the same format as the OpenReview Profile id.
Preferred OpenReview username.
Whether the user is allowed to modify data in OpenReview.
List of Group ids that can be impersonated by the logged in user.
Create or edit a Tag
Tag object
Tag response
Register a new user
Email that will be used to log in to OpenReview.
A Profile can contain more than one object name. Setting this field to true will make this the preferred name.
This is a Profile id. This parameter is only required when claiming an existing a Profile in OpenReview.
The Profile that is saved to the database.
Create a direct message
Message object
Subject of the message.
Message body.
Groups the message is sent to.
Groups the message should not be sent to.
Parent group that the groups belong to.
Send the message at a specific UTC time in milliseconds in the future. Maximum is 70 hours.
Email address the recipient should replyto.
Whether to wait for messages to be sent.
Email address the message is sent from.
message response
Search Notes
Search query that that looks inside some of the fields in the content of the Note.
Search term that that looks inside some of the fields in the content of the Note.
Search type
Fields inside content to look for the term.
Group that the Invitation belongs to
Source of the Note
Invitation id used to create the Note(s).
venue of the Note
venue id of the Note
Sort returned Notes by field.
Maximum number of results to return.
Offset of the result shown.
Get result from cache. Without the right privileges this parameter will be ignored.
Note response
Returns all the references by filter
reference id
reference ids
Invitation id used to create the Reference(s).
Invitation ids
Reference referent.
Note id of the forum field.
Note id of the replyto field.
Note number.
Note title.
Note venue.
Note venueid.
List of tilde ids of registered users or of emails either registered or not.
Get Notes deleted too.
paperhash of the Note if exists.
Get Note using pdf hash.
Get Notes authored by user.
Get Notes written by user.
Get Notes signed by user.
Get Notes signed by users.
Get Notes that are originals.
Comma separated string with specific fields of the Reference object to return.
Comma separated values of fields to add to details. Valid values are replyCount, original, overwriting, revisions, writable, forumContent, tags, revisions, invitation, directReplyCount, directReplies, replies, and all
Invitee
Minimum creation date
Due date
Sort returned Notes by field.
Maximum number of results to return.
Offset of the result shown.
Get result from cache. Without the right privileges this parameter will be ignored.
Note response
Returns Invitations
Invitation id
Comma separated Invitation ids
Super Invitation id
Invitation id regular expression
Invitation type
Note id
Invitation id
minimum due date of the Invitation
invitee id
Invitation signature
Invitations should have replyto field
Invitations should have due date
Invitations should be past due
Invitations should be expired
Comma separated string with specific fields of the Invitation object to return.
Comma separated values of fields to add to details. Valid values are replytoNote, repliedNotes, repliedTags, repliedEdges, all.
Get only Tag Invitations
Get only edge Invitations
Get only Note Invitations
Maximum number of results to return.
Offset of the result shown.
Get result from cache. Without the right privileges this parameter will be ignored.
Invitation response
Get user profiles
Profile id
Profile ids
Email associated with the Profile.
Email(s) associated with the Profile.
Confirmed email associated with the Profile.
Confirmed email(s) associated with the Profile.
First name associated with the Profile.
Middle name associated with the Profile.
Last name associated with the Profile.
Email, Fullname or part of the fullname associated with the Profile.
Group id where to get all the member profiles.
Whether to include deleted profiles.
Whether to include blocked profiles.
Whether to return Profiles that need moderation.
Comma separated string with specific fields of the Profile object to return.
Sort returned Profiles by field.
Maximum number of results to return.
Offset of the result shown.
Get result from cache. Without the right privileges this parameter will be ignored.
Profile response
Create or edit an Invitation
Invitation object
Invitation response
Create a Note or reference, edit a Note or reference
Note object
Note response
Save user Profile
Add a new piece of evidence to an existent Profile.
Profile response