1 of 15

OpenAPI definition

Entities

Edge

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.

Fields

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.

id

This is a unique value that identifies the Edge. The id of an Edge is generated automatically. It is a random 14 character long string that can contain any of the following values:

cdate

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.

tcdate

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.

mdate

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.

tmdate

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.

ddate

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.

signatures

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.

readers

The readers field is an array with Group ids that indicates who can retrieve the Edge or see the Edge in the UI.

nonreaders

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.

writers

The writers field is an array with Group ids that indicates who can modify the Edge.

head

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.

tail

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.

label

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.

weight

The weight field contains a number that defines the weight between two entities defined in head and tail.

invitation

The invitation field contains the Invitation id that was used as template to create the Edge.

tauthor

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.

Note

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.

Fields

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.

id

This is a unique value that identifies the Note. The id of a Note is generated automatically. It is a random 10 character long string that can contain any of the following values:

Invitation

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.

The subsections contain information on the types of Invitations, their structure, the fields it can have, and how to define them with different specifiers.

Fields

Invitations 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 Invitation object.

id

This is a unique value that identifies the Invitation. Its value, which will always contain the string /-/ determines the parent group it belongs to as well as the value that is displayed when creating buttons in the UI. For example, the Invitation id OpenReview.net/Venue_Organizers/-/Submission belongs to the group

Dollar Sign Notation

The dollar sign notation is used to copy values from one field whose path is specified inside the dollar sign notation to the one where the dollar sign notation was specified. The path defined in the field is a relative path and can only refer to fields that are passed when the object is posted or to fields that are generated by the backend before it gets saved to the database.

The dollar sign notation is a string has the following format:

${<integer>/path/to/other/field/value}

Probably the most common and simple example is the one for signatures and Note number. Consider the following simplified Note Edit Invitation:

Then a valid Note Edit replying to this Invitation will look like this:

The final Edit that will be saved to the database after all values have been resolved will look like this:

According to the Note Edit Invitation there are only 2 fields that the user needs to fill up: signatures and the value of the title because those are the only 2 fields with the param keyword. The rest of the field values are populated by what is defined in the Invitation as constants. Refer to the subsection for more information.

There are 3 fields that contain the dollar sign notation and 4 values that need to be resolved. Let us start with the one inside edit/readers/1. The value ${2/signatures} means that it will go up twice and then select the value of edit/signatures. Note that the value here is [ "~Test_User1" ]. The array will replace the value where ${2/signatures} would be located in the Note Edit and then flattened. In a similar way, the value inside edit/note/writers/1 will be resolved and flattened. The only difference is that the relative path is different, but they resolve to the same value.

The other example refers to the field number. This field is not defined when the Note Edit is posted, because it is created by the backend. However, the field can be referred to when creating the Note Edit. The number field is the only exception to the rule where all the field values that can be referred to with the dollar sign notation need to be present when the Note Edit is posted. As you can see, when the Note number value is resolved it replaces the value of the dollar sign with the number of the Note.

The dollar sign notation cannot refer to values that are at the root of the Invitation. This is because when an object is created, it only has access to its own fields, not to the fields of the Invitation that allows its creation.

Edit

Edits are used to create Invitations, Groups and Notes. Therefore, there are three kinds of Edits: Invitation Edits, Group Edits and Note Edits. Once an Edit is created, it goes through the process of inference to create the corresponding entity. Consequently, Edits contain the history of changes of the entity that they create. Adding, removing or modifying an existing Edit will change the resulting entity.

Fields

Edits 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 Edit object.

id

This is a unique value that identifies the Edit. The id of an Edit is generated automatically. It is a random 10 character long string that can contain any of the following values:

Dollar Sign Notation

The dollar sign notation is a string has the following format:

${<integer>/path/to/other/field/value}

Probably the most common and simple example is the one for signatures and Note number. Consider the following simplified Note Edit Invitation:

{
  id: "OpenReview.net/Venue_Organizers/-/Submission",
  signatures: [ "OpenReview.net/Venue_Organizers" ],
  writers: [ "OpenReview.net/Venue_Organizers" ],
  invitees: [ "~" ],
  readers: [ "everyone" ],
  edit : {
    signatures: { param: { regex: ".+" } },
    readers: [
      "OpenReview.net/Venue_Organizers",
      "${2/signatures}"
    ],
    writers: [ "OpenReview.net/Venue_Organizers" ],
    note: {
      signatures: [ "OpenReview.net/Paper${2/number}/Authors" ],
      readers: [ "everyone" ],
      writers: [
        "OpenReview.net/Venue_Organizers",
        "${3/signatures}",
        "OpenReview.net/Paper${2/number}/Authors"
      ],
      content: {
        title: {
          value: { param: { type: "string" } }
        }
      }
    }
  }
}

Then a valid Note Edit replying to this Invitation will look like this:

{
  signatures: [ "~Test_User1" ],
  note: {
    content: {
      title: {
        value: "This is a title"
      }
    }
  }
}

The final Edit that will be saved to the database after all values have been resolved will look like this:

{
  signatures: [ "~Test_User1" ],
  readers: [
    "OpenReview.net/Venue_Organizers",
    "~Test_User1"
  ],
  writers: [ "OpenReview.net/Venue_Organizers" ],
  note: {
    signatures: [ "OpenReview.net/Paper1/Authors" ],
    readers: [ "everyone" ],
    writers: [
      "OpenReview.net/Venue_Organizers",
      "~Test_User1",
      "OpenReview.net/Paper1/Authors"
    ],
    content: {
      title: {
        value: "This is a title"
      }
    }
  }
}

Fields

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.

id

This is a unique value that identifies the Edge. The id of an Edge is generated automatically. It is a random 14 character long string that can contain any of the following values:

0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ

cdate

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.

tcdate

mdate

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.

tmdate

ddate

signatures

readers

The readers field is an array with Group ids that indicates who can retrieve the Edge or see the Edge in the UI.

nonreaders

writers

The writers field is an array with Group ids that indicates who can modify the Edge.

head

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.

tail

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.

label

weight

The weight field contains a number that defines the weight between two entities defined in head and tail.

invitation

The invitation field contains the Invitation id that was used as template to create the Edge.

tauthor

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.

Get user profiles

Authorizations

openreview.accessTokenstringRequired

Query parameters

idstring · min: 1Optional

Profile id

Pattern: ^~.*\d+$

idsany ofOptional

Profile ids

stringOptional

string[]Optional

emailstring · min: 1Optional

Email associated with the Profile.

emailsany ofOptional

Email(s) associated with the Profile.

stringOptional

string[]Optional

confirmedEmailstring · min: 1Optional

Confirmed email associated with the Profile.

confirmedEmailsany ofOptional

Confirmed email(s) associated with the Profile.

stringOptional

string[]Optional

firststring · min: 1Optional

First name associated with the Profile.

middlestring · nullableOptional

Middle name associated with the Profile.

laststring · min: 1Optional

Last name associated with the Profile.

termstring · min: 1Optional

Email, Fullname or part of the fullname associated with the Profile.

groupstring · min: 1Optional

Group id where to get all the member profiles.

trashbooleanOptional

Whether to include deleted profiles.

withBlockedbooleanOptional

Whether to include blocked profiles.

needsModerationbooleanOptional

Whether to return Profiles that need moderation.

selectstring · min: 1Optional

Comma separated string with specific fields of the Profile object to return.

Example: id,content.names,content.emails

statestring · enumOptional

State of the Profile.

Possible values:

sortstring · min: 1Optional

Sort returned Profiles by field.

limitinteger · min: 1Optional

Maximum number of results to return.

offsetintegerOptional

Offset of the result shown.

cachebooleanOptional

Get result from cache. Without the right privileges this parameter will be ignored.

Responses

200

Profile response

application/json

idstringRequired

activebooleanOptional

passwordbooleanOptional

invitationstringRequired

metaContentobjectOptional

tcdateintegerOptional

tmdateintegerOptional

tauthorstringOptional

readersstring[]Required

nonreadersstring[]Optional

writersstring[]Required

signaturesstring[]Required

get

/profiles

200

Profile response

Get user profiles

Authorizations

openreview.accessTokenstringRequired

Query parameters

idstring · min: 1Optional

Profile id

Pattern: ^~.*\d+$

idsany ofOptional

Profile ids

stringOptional

string[]Optional

emailstring · min: 1Optional

Email associated with the Profile.

emailsany ofOptional

Email(s) associated with the Profile.

stringOptional

string[]Optional

confirmedEmailstring · min: 1Optional

Confirmed email associated with the Profile.

confirmedEmailsany ofOptional

Confirmed email(s) associated with the Profile.

stringOptional

string[]Optional

firststring · min: 1Optional

First name associated with the Profile.

middlestring · nullableOptional

Middle name associated with the Profile.

laststring · min: 1Optional

Last name associated with the Profile.

termstring · min: 1Optional

Email, Fullname or part of the fullname associated with the Profile.

groupstring · min: 1Optional

Group id where to get all the member profiles.

trashbooleanOptional

Whether to include deleted profiles.

withBlockedbooleanOptional

Whether to include blocked profiles.

needsModerationbooleanOptional

Whether to return Profiles that need moderation.

selectstring · min: 1Optional

Comma separated string with specific fields of the Profile object to return.

Example: id,content.names,content.emails

statestring · enumOptional

State of the Profile.

Possible values:

sortstring · min: 1Optional

Sort returned Profiles by field.

limitinteger · min: 1Optional

Maximum number of results to return.

offsetintegerOptional

Offset of the result shown.

cachebooleanOptional

Get result from cache. Without the right privileges this parameter will be ignored.

Responses

200

Profile response

application/json

idstringRequired

activebooleanOptional

passwordbooleanOptional

invitationstringRequired

metaContentobjectOptional

tcdateintegerOptional

tmdateintegerOptional

tauthorstringOptional

readersstring[]Required

nonreadersstring[]Optional

writersstring[]Required

signaturesstring[]Required

get

/profiles/search

200

Profile response

Returns all the Notes by filter.

Authorizations

openreview.accessTokenstringRequired

Query parameters

idstring · min: 1Optional

Note id.

idsany ofOptional

Note ids.

stringOptional

string[]Optional

invitationstring · min: 1Optional

Invitation id used to create the Note(s).

Example: ICLR.cc/2018/Conference/-/Blind_Submission

invitationsany ofOptional

Invitation ids.

stringOptional

string[]Optional

referentstring · min: 1Optional

Reference referent.

forumany ofOptional

Note id of the forum field.

stringOptional

string[]Optional

replytoany ofOptional

Note id of the replyto field.

stringOptional

string[]Optional

numberany ofOptional

Note number.

integer · min: 1Optional

string · min: 1OptionalPattern: ^([1-9][0-9]*,?)*[1-9][0-9]*$

integer[] · min: 1Optional

content.titlestring · min: 1Optional

Note title.

content.confidencestring · min: 1Optional

Note content confidence field value.

content.strengthsstring · min: 1Optional

Note content strengths field value.

content.weaknessesstring · min: 1Optional

Note content weaknesses field value.

content.decisionstring · min: 1Optional

Note content decision field value.

content.certificationsstring · min: 1Optional

Note content certification field values.

content.previous_URLstring · min: 1Optional

Note content previous_URL field value.

content.userstring · min: 1Optional

User email in recruitment.

content.responsestring · min: 1Optional

User response in recruitment.

content.submission_idstring · min: 1Optional

content.venuestring · min: 1Optional

Note venue.

content.venueidstring · min: 1Optional

Note venueid.

content.venue_idstring · min: 1Optional

Note venue_id.

content.presentation_typestring · min: 1Optional

Presentation Type.

content.sessionsstring · min: 1Optional

Sessions.

content.trackstring · min: 1Optional

Track.

content.authoridsany ofOptional

List of tilde ids of registered users or of emails either registered or not.

stringOptionalExample: ~Andrew_McCallum1

string[]Optional

trashbooleanOptional

Whether to get deleted Notes.

paperhashstringOptionalDeprecated

paperhash of the Note if exists.

Example: das|go_for_a_walk_and_arrive_at_the_answer_reasoning_over_paths_in_knowledge_bases_using_reinforcement_learning.

tauthorbooleanOptional

Get Notes authored by user.

writerstring · min: 1Optional

Get Notes written by user.

signaturestring · min: 1Optional

Get Notes signed by user.

transitiveMembersbooleanOptional

Include transitive members of signature if it's passed as a parameter.

signaturesany ofOptional

Get Notes signed by users.

stringOptional

string[]Optional

originalany ofOptional

get Notes that are originals

booleanOptional

string · min: 1Optional

selectstring · min: 1Optional

Comma separated string with specific fields of the Note object to return.

Example: id,content.title,content.abstract

detailsstring · min: 1Optional

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

Example: all

inviteebooleanOptional

invitee

mintcdateintegerOptional

minimum creation date

duedatebooleanOptional

due date

sortstring · min: 1Optional

Sort returned Notes by field.

limitintegerOptional

Maximum number of results to return.

offsetintegerOptional

Offset of the result shown.

cachebooleanOptional

Get result from cache. Without the right privileges this parameter will be ignored.

Responses

200

Note response

application/json

idstring · min: 1Optional

invitationstring · min: 1Optional

numberinteger · min: 1Optional

forumstring · min: 1Optional

replytoany ofOptional

string · min: 1Optional

contentobjectOptional

cdateany ofOptional

integer · min: 1Optional

pdateany ofOptional

integer · min: 1Optional

ddateany ofOptional

integerOptional

mdateany ofOptional

integerOptional

readersany ofOptional

string[]Optional

nonreadersany ofOptional

string[]Optional

writersany ofOptional

string[]Optional

signaturesstring[]Optional

default

Error

application/json

get

/notes

Search Notes

Authorizations

openreview.accessTokenstringRequired

Query parameters

querystring · min: 1Optional

Search query that that looks inside some of the fields in the content of the Note.

termstring · min: 1Optional

Search term that that looks inside some of the fields in the content of the Note.

typestring · enumOptional

Search type

Possible values:

contentstring · min: 1Optional

Fields inside content to look for the term.

Default: all

groupstring · min: 1Optional

Group that the Invitation belongs to

sourcestring · enumOptional

Source of the Note

Default: allPossible values:

invitationstring · min: 1Optional

Invitation id used to create the Note(s).

Example: ICLR.cc/2018/Conference/-/Submission

venuestring · min: 1Optional

Venue of the Note

venueidstring · min: 1Optional

Venue id of the Note

sortstring · min: 1Optional

Sort returned Notes by field.

Example: tmdate:desc

limitintegerOptional

Maximum number of results to return.

offsetintegerOptional

Offset of the result shown.

cachebooleanOptional

Get result from cache. Without the right privileges this parameter will be ignored.

Responses

200

Note response

application/json

idstring · min: 1Optional

invitationstring · min: 1Optional

numberinteger · min: 1Optional

forumstring · min: 1Optional

replytoany ofOptional

string · min: 1Optional

contentobjectOptional

cdateany ofOptional

integer · min: 1Optional

pdateany ofOptional

integer · min: 1Optional

ddateany ofOptional

integerOptional

mdateany ofOptional

integerOptional

readersany ofOptional

string[]Optional

nonreadersany ofOptional

string[]Optional

writersany ofOptional

string[]Optional

signaturesstring[]Optional

default

Error

application/json

Returns Invitations

Authorizations

openreview.accessTokenstringRequired

Query parameters

idstring · min: 1Optional

Invitation id

idsany ofOptional

Invitation ids

stringOptional

string[]Optional

invitationstring · min: 1Optional

Invitation used to validate this invitation.

prefixstring · min: 1Optional

Invitation id prefix

domainstring · min: 1Optional

Invitation domain

typestring · enumOptional

Invitation type

Possible values:

replyForumstring · min: 1Optional

Note id

replyInvitationstring · min: 1Optional

Invitation id

minduedateintegerOptional

minimum due date of the Invitation

inviteeany ofOptional

invitee id

booleanOptional

string · min: 1Optional

signaturestring · min: 1Optional

Invitation signature

replytobooleanOptional

Invitations should have replyto field

duedatebooleanOptional

Invitations should have due date

pastduebooleanOptional

Invitations should be past due

expiredbooleanOptional

Invitations should be expired

selectstring · min: 1Optional

Comma separated string with specific fields of the Invitation object to return.

Example: id,content,readers,invitees

detailsstring · min: 1Optional

Comma separated values of fields to add to details. Valid values are replytoNote, repliedNotes, repliedTags, repliedEdges, all.

tagsbooleanOptionalDeprecated

Get only Tag Invitations

edgesbooleanOptionalDeprecated

Get only edge Invitations

notesbooleanOptionalDeprecated

Get only Note Invitations

sortstring · min: 1Optional

Sort returned Invitations by field.

limitinteger · min: 1Optional

Maximum number of results to return.

offsetintegerOptional

Offset of the result shown.

cachebooleanOptional

Get result from cache. Without the right privileges this parameter will be ignored.

Responses

200

Invitation response

application/json

idstring · min: 1Optional

editanyOptional

cdateany ofOptional

integerOptional

ddateany ofOptional

integerOptional

duedateany ofOptional

integerOptional

expdateany ofOptional

integerOptional

maxRepliesany ofOptional

integer · min: 1Optional

minRepliesany ofOptional

integerOptional

taskCompletionCountinteger · nullableOptional

replyForumViewsany ofOptional

preprocessany ofOptional

stringOptional

processany ofOptional

stringOptional

dateprocessesany ofOptional

webany ofOptional

string · min: 1Optional

readersany ofOptional

string[]Optional

nonreadersany ofOptional

string[]Optional

writersany ofOptional

string[]Optional

signaturesstring[]Optional

inviteesany ofOptional

string[]Optional

noninviteesany ofOptional

string[]Optional

default

Error

application/json

get

/invitations

{ "id": "text", "invitation": "text", "number": 1, "forum": "text", "replyto": "text", "content": {}, "cdate": 1, "pdate": 1, "ddate": 1, "mdate": 1, "readers": [ "text" ], "nonreaders": [ "text" ], "writers": [ "text" ], "signatures": [ "text" ], "details": { "replyCount": 1, "writable": true, "revisions": true, "original": {}, "overwritting": [ "text" ], "forumContent": {}, "tags": [], "invitation": { "id": "text", "edge": { "id": "text", "invitation": "text", "head": "text", "tail": "text", "label": "text", "weight": 1, "ddate": 1, "readers": [ "text" ], "nonreaders": [ "text" ], "writers": [ "text" ], "signatures": [ "text" ] }, "tag": { "id": "text", "invitation": "text", "forum": "text", "replyto": "text", "tag": "text", "cdate": 1, "ddate": 1, "readers": [ "text" ], "nonreaders": [ "text" ], "signatures": [ "text" ] }, "edit": null, "cdate": 1, "ddate": 1, "duedate": 1, "expdate": 1, "details": { "writable": true, "replytoNote": { "id": "text", "invitation": "text", "number": 1, "forum": "text", "replyto": "text", "content": {}, "cdate": 1, "pdate": 1, "ddate": 1, "mdate": 1, "readers": [ "text" ], "nonreaders": [ "text" ], "writers": [ "text" ], "signatures": [ "text" ], "details": { "replyCount": 1, "writable": true, "revisions": true, "original": {}, "overwritting": [ "text" ], "forumContent": {}, "tags": [], "invitation": "[Circular Reference]", "directReplyCount": 1, "directReplies": [ {} ], "replies": [ {} ] } }, "repliedNotes": [], "repliedEdits": [], "repliedTags": [], "withRepliedEdges": [], "withWritableWith": [] }, "maxReplies": 1, "minReplies": 1, "taskCompletionCount": 1, "replyForumViews": [ { "id": "text", "label": "text", "filter": "text", "layout": 1, "sort": "text" } ], "preprocess": "text", "process": "text", "dateprocesses": [ { "script": "text", "delay": 1 } ], "web": "text", "readers": [ "text" ], "nonreaders": [ "text" ], "writers": [ "text" ], "signatures": [ "text" ], "invitees": [ "text" ], "noninvitees": [ "text" ] }, "directReplyCount": 1, "directReplies": [ {} ], "replies": [ {} ] } }

{ "id": "text", "invitations": "text", "replacement": true, "content": {}, "invitation": { "id": "text", "edge": { "id": "text", "invitation": "text", "head": "text", "tail": "text", "label": "text", "weight": 1, "ddate": 1, "readers": [ "text" ], "nonreaders": [ "text" ], "writers": [ "text" ], "signatures": [ "text" ] }, "tag": { "id": "text", "invitation": "text", "forum": "text", "replyto": "text", "tag": "text", "cdate": 1, "ddate": 1, "readers": [ "text" ], "nonreaders": [ "text" ], "signatures": [ "text" ] }, "edit": { "id": "text", "invitations": "text", "replacement": true, "content": {}, "invitation": { "id": "text", "edge": { "id": "text", "invitation": "text", "head": "text", "tail": "text", "label": "text", "weight": 1, "ddate": 1, "readers": [ "text" ], "nonreaders": [ "text" ], "writers": [ "text" ], "signatures": [ "text" ] }, "tag": { "id": "text", "invitation": "text", "forum": "text", "replyto": "text", "tag": "text", "cdate": 1, "ddate": 1, "readers": [ "text" ], "nonreaders": [ "text" ], "signatures": [ "text" ] }, "edit": "[Circular Reference]", "bulk": true, "content": {}, "cdate": 1, "ddate": 1, "duedate": 1, "expdate": 1, "maxReplies": 1, "minReplies": 1, "taskCompletionCount": 1, "replyForumViews": [ { "id": "text", "label": "text", "filter": "text", "layout": 1, "sort": "text" } ], "preprocess": "text", "process": "text", "dateprocesses": [ { "script": "text", "delay": 1 } ], "web": "text", "readers": [ "text" ], "nonreaders": [ "text" ], "writers": [ "text" ], "signatures": [ "text" ], "invitees": [ "text" ], "noninvitees": [ "text" ] }, "cdate": 1, "readers": [ "text" ], "nonreaders": [ "text" ], "writers": [ "text" ], "signatures": [ "text" ] }, "bulk": true, "content": {}, "cdate": 1, "ddate": 1, "duedate": 1, "expdate": 1, "maxReplies": 1, "minReplies": 1, "taskCompletionCount": 1, "replyForumViews": [ { "id": "text", "label": "text", "filter": "text", "layout": 1, "sort": "text" } ], "preprocess": "text", "process": "text", "dateprocesses": [ { "script": "text", "delay": 1 } ], "web": "text", "readers": [ "text" ], "nonreaders": [ "text" ], "writers": [ "text" ], "signatures": [ "text" ], "invitees": [ "text" ], "noninvitees": [ "text" ] }, "cdate": 1, "readers": [ "text" ], "nonreaders": [ "text" ], "writers": [ "text" ], "signatures": [ "text" ] }

POST /profiles HTTP/1.1 Host: api.openreview.net Content-Type: application/json Accept: */* Content-Length: 1886 { "id": "text", "invitation": "text", "referent": "text", "tcdate": 1, "tmdate": 1, "ddate": 1, "packaging": {}, "active": true, "password": true, "tauthor": "text", "state": "Active", "content": { "preferredEmail": "text", "gender": "text", "yearOfBirth": 1, "homepage": "text", "dblp": "text", "gscholar": "text", "wikipedia": "text", "linkedin": "text", "orcid": "text", "semanticScholar": "text", "names": [ { "preferred": true, "first": "text", "middle": "text", "last": "text", "username": "text" } ], "emails": [ "text" ], "emailsConfirmed": [ "text" ], "history": [ { "position": "text", "institution": { "name": "text", "domain": "text" }, "start": 1, "end": 1 } ], "relations": [ { "relation": "text", "name": "text", "email": "text", "start": 1, "end": 1, "readers": [ "text" ] } ], "expertise": [ { "keywords": [ "text" ], "start": 1, "end": 1 } ] }, "metaContent": { "preferredEmail": { "values": [ "text" ], "weights": [ 1 ], "signatures": [ "text" ] }, "gender": { "values": [ "text" ], "weights": [ 1 ], "signatures": [ "text" ] }, "yearOfBirth": { "values": [ 1 ], "weights": [ 1 ], "signatures": [ "text" ] }, "homepage": { "values": [ "text" ], "weights": [ 1 ], "signatures": [ "text" ] }, "dblp": { "values": [ "text" ], "weights": [ 1 ], "signatures": [ "text" ] }, "gscholar": { "values": [ "text" ], "weights": [ 1 ], "signatures": [ "text" ] }, "wikipedia": { "values": [ "text" ], "weights": [ 1 ], "signatures": [ "text" ] }, "linkedin": { "values": [ "text" ], "weights": [ 1 ], "signatures": [ "text" ] }, "orcid": { "values": [ "text" ], "weights": [ 1 ], "signatures": [ "text" ] }, "semanticScholar": { "values": [ "text" ], "weights": [ 1 ], "signatures": [ "text" ] }, "names": { "values": [ { "first": "text", "middle": "text", "last": "text", "username": "text", "preferred": true } ], "weights": [ 1 ] }, "emails": { "values": [ "text" ], "weights": [ 1 ] }, "history": [ { "values": [ {} ], "weights": [ 1 ] } ], "relations": { "values": [ { "name": "text", "email": "text", "relation": "text", "start": 1, "end": 1, "readers": [ "text" ] } ], "weights": [ 1 ] }, "expertise": [ { "values": [ {} ], "weights": [ 1 ] } ] }, "readers": [ "text" ], "nonreaders": [ "text" ], "writers": [ "text" ], "signatures": [ "text" ] }

POST /invitations/edits HTTP/1.1 Host: api.openreview.net Content-Type: application/json Accept: */* Content-Length: 1986 { "id": "text", "invitations": "text", "replacement": true, "content": {}, "invitation": { "id": "text", "edge": { "id": "text", "invitation": "text", "head": "text", "tail": "text", "label": "text", "weight": 1, "ddate": 1, "readers": [ "text" ], "nonreaders": [ "text" ], "writers": [ "text" ], "signatures": [ "text" ] }, "tag": { "id": "text", "invitation": "text", "forum": "text", "replyto": "text", "tag": "text", "cdate": 1, "ddate": 1, "readers": [ "text" ], "nonreaders": [ "text" ], "signatures": [ "text" ] }, "edit": { "id": "text", "invitations": "text", "replacement": true, "content": {}, "invitation": { "id": "text", "edge": { "id": "text", "invitation": "text", "head": "text", "tail": "text", "label": "text", "weight": 1, "ddate": 1, "readers": [ "text" ], "nonreaders": [ "text" ], "writers": [ "text" ], "signatures": [ "text" ] }, "tag": { "id": "text", "invitation": "text", "forum": "text", "replyto": "text", "tag": "text", "cdate": 1, "ddate": 1, "readers": [ "text" ], "nonreaders": [ "text" ], "signatures": [ "text" ] }, "edit": "[Circular Reference]", "bulk": true, "content": {}, "cdate": 1, "ddate": 1, "duedate": 1, "expdate": 1, "maxReplies": 1, "minReplies": 1, "taskCompletionCount": 1, "replyForumViews": [ { "id": "text", "label": "text", "filter": "text", "layout": 1, "sort": "text" } ], "preprocess": "text", "process": "text", "dateprocesses": [ { "script": "text", "delay": 1 } ], "web": "text", "readers": [ "text" ], "nonreaders": [ "text" ], "writers": [ "text" ], "signatures": [ "text" ], "invitees": [ "text" ], "noninvitees": [ "text" ] }, "cdate": 1, "readers": [ "text" ], "nonreaders": [ "text" ], "writers": [ "text" ], "signatures": [ "text" ] }, "bulk": true, "content": {}, "cdate": 1, "ddate": 1, "duedate": 1, "expdate": 1, "maxReplies": 1, "minReplies": 1, "taskCompletionCount": 1, "replyForumViews": [ { "id": "text", "label": "text", "filter": "text", "layout": 1, "sort": "text" } ], "preprocess": "text", "process": "text", "dateprocesses": [ { "script": "text", "delay": 1 } ], "web": "text", "readers": [ "text" ], "nonreaders": [ "text" ], "writers": [ "text" ], "signatures": [ "text" ], "invitees": [ "text" ], "noninvitees": [ "text" ] }, "cdate": 1, "readers": [ "text" ], "nonreaders": [ "text" ], "writers": [ "text" ], "signatures": [ "text" ] }

Types and Structure

The fields of an Invitation vary depending on the object that will be created with it. There are 6 different types of invitations:

Meta Invitations
Invitations for Edges

Meta Invitations

Meta Invitations are admin Invitations which are created when the venue is deployed and are available to venue organizers. There is only 1 available per venue and should be used with care and sparingly. Meta Invitations can modify any object in the system that is associated to the venue. Therefore, before using the Meta Invitation, make sure there is no other Invitation that can be used instead. Using an Invitation other than the Meta Invitation is preferred to avoid errors when modifying an object.

There is only 1 available per venue and should be used with care and sparingly.

Meta Invitations can modify any object in the system that is associated to the venue.

Meta Invitations have the structure shown below. They can be identified because of the property edit: true inside the invitation field.

Invitations for Edges

Edge Invitations are used to create Edges and contain the edge field that defines the template for the Edges. This means that when creating an Edge object with the Invitation below, the rules and structure defined inside the edge field will need to be followed.

Do NOT copy the values from this example in your venue. This example is a simplified version of an Edge Invitation and it is only used to understand its structure.

Invitations for Tags

Tag Invitations are used to create Tags and contain the tag field that defines the template for the Tags. This means that when creating a Tag object with the Invitation below, the rules defined and structure inside the tag field will need to be followed.

Do NOT copy the values from this example in your venue. This example is a simplified version of a Tag Invitation and it is only used to understand its structure.

Invitations for Group Edits

Group Edit Invitations are used to create Group Edits and contain the edit field that defines the template for the Group Edits. This means that when creating a Group Edit object with the Invitation below, the rules and structure defined inside the edit field will need to be followed.

Do NOT copy the values from this example in your venue. This example is a simplified version of a Group Edit Invitation and it is only used to understand its structure.

Invitations for Note Edits

Note Edit Invitations are used to create Note Edits and contain the edit field that defines the template for the Note Edits. This means that when creating a Note Edit object with the Invitation below, the rules and structure defined inside the edit field will need to be followed.

Do NOT copy the values from this example in your venue. This example is a simplified version of a Note Edit Invitation and it is only used to understand its structure.

Invitations for Invitation Edits

Invitation Edit Invitations are used to create Invitation Edits and contain the edit field that defines the template for the Invitation Edits. This means that when creating an Invitation Edit object with the Invitation below, the rules and structure defined inside the edit field will need to be followed.

Invitations that are used to create Invitation Edits are the most complex ones. Theoretically, they can have any depth, but you will probably hit restrictions if you try to create a very big Invitation.

Do NOT copy the values from this example in your venue. This example is a simplified version of an Invitation Edit Invitation and it is only used to understand its structure.

{ id: "OpenReview.net/Venue_Organizers/-/Invitation", signatures: [ "OpenReview.net/Venue_Organizers" ], writers: [ "OpenReview.net/Venue_Organizers" ], invitees: [ "~" ], readers: [ "everyone" ], edit: { signatures: { param: { regex: ".+" } }, content: { title: { value: { param: { type: "string", regex: ".*" } } }, duedate: { value: { param: { type: "integer" } } } }, readers: [ "OpenReview.net/Venue_Organizers", "${2/signatures}" ], writers: [ "OpenReview.net/Venue_Organizers" ], invitation: { id: "OpenReview.net/-/Submission", signatures: [ "${3/signatures}" ], readers: [ "~" ], writers: [ "OpenReview.net/Venue_Organizers", "${3/signatures}" ], invitees: [ "${3/content/invitees/value}" ], duedate: "${2/content/duedate/value}", content: { optional: { value: { param: { type: "string", optional: true } } } }, edit: { signatures: { param: { regex: ".*" } }, readers: [ "OpenReview.net/Venue_Organizers", "${2/signatures}" ], writers: [ "OpenReview.net/Venue_Organizers", "${2/signatures}" ], note: { signatures: [ "${3/signatures}" ], readers: [ "OpenReview.net/Venue_Organizers", "${3/signatures}" ], writers: [ "OpenReview.net/Venue_Organizers", "${3/signatures}" ], content: { title: { value: { param: { type: "string", regex: "${8/content/title/value}" } } }, authors: { value: { param: { type: "string[]", regex: ".*", optional: true } }, readers: [ "OpenReview.net/Venue_Organizers", "${5/signatures}" ] }, authorids: { value: { param: { type: "group[]", regex: ".*", optional: true } }, readers: [ "OpenReview.net/Venue_Organizers", "${5/signatures}" ] } } } } } } }

Inference

The process of inference combines Edits to create an entity before saving it to the database. In other words, entities such as Invitations, Groups or Notes cannot be created directly, they need to be created through Edits and the process of inference.

Edits are sorted in a fixed chronological order using the tcdate field during inference. Since the tcdate value can never be modified, Edits can never change their position in the history of changes. However, the history of changes can be modified by destructively changing an Edit. This is only possible if the user has writer permissions on the Edit.

The process of inference can add, remove and replace fields as long as the Invitation used to create the Edit allows it. To illustrate this, we will focus on inference used to create Notes, however, the same rules apply to Invitations and Groups.

For the following examples, assume that the following is used:

Creating Notes

Suppose the following Note Edit is created:

Since this is the first an only Edit the resulting Note will only contain the fields and values inside the note field of the Edit.

You may have noticed the fields id, invitations and domain that were not included in the Edit but still appear after the inference runs. These fields are set automatically and cannot be manually modified. The invitations field shows all the different Invitations that have contributed to the modification of the Note. The field domain shows the venue that the Note belongs to and it is present in every single object created.

Adding Fields

Let's say that we now want to add the field abstract to the Note. We can create a new Note Edit:

Notice that we now pass the field note.id to the Edit. This indicates what Note we want to modify. The resulting Note will then contain the abstract field:

Replacing Field Values

Values can be overwritten by passing the same field with a new value. For example, if we want to update the abstract field that we just added, we can create the following Note Edit

The resulting Note will look like this:

Removing Fields

In order to remove a field from a Note, we can pass the object { delete: true } as value to the field.

The resulting Note will look like this:

The resulting Note will look exactly the same as the first Note that was created from the first Edit. The difference is that we can see the history of changes by querying the Edits associated to the Note.

Destructive Changes

Edits can be modified directly and alter the history of changes. This can achieved by passing the id of the Edit that we want to modify like so:

Replacement

The field replacement can be used when we want to restart the history of changes. In other words, Edits created before the one that contains replacement: true will be ignored during inference. The ignored Edits will still exist but will not be considered for the resulting values of the entity. Consider the following Edit:

The resulting Note looks like this:

As you can see, the Edit containing the replacement: true is considered to be the first Edit during inference. If a subsequent Edit contains replacement: true then that Edit will considered to be the first Edit and the previous Edits will be ignored.

OpenAPI definition

Entities

Edge

Fields

hashtagid

hashtagcdate

hashtagtcdate

hashtagmdate

hashtagtmdate

hashtagddate

hashtagsignatures

hashtagreaders

hashtagnonreaders

hashtagwriters

hashtaghead

hashtagtail

hashtaglabel

hashtagweight

hashtaginvitation

hashtagtauthor

Note

Fields

hashtagid

Invitation

Fields

hashtagid

Dollar Sign Notation

Edit

Fields

hashtagid

OpenAPI definition

Entities

Dollar Sign Notation

Invitation

Edit

Note

Edge

Fields

hashtagid

hashtagcdate

hashtagtcdate

hashtagmdate

hashtagtmdate

hashtagddate

hashtagsignatures

hashtagreaders

hashtagnonreaders

hashtagwriters

hashtaghead

hashtagtail

hashtaglabel

hashtagweight

hashtaginvitation

hashtagtauthor

Fields

hashtagid

hashtagcdate

hashtagtcdate

hashtagmdate

hashtagtmdate

hashtagodate

hashtagpdate

hashtagddate

hashtaginvitations

hashtagdomain

hashtagsignatures

hashtagreaders

hashtagnonreaders

hashtagwriters

hashtagforum

hashtagreplyto

hashtagcontent

Fields

hashtagid

Fields

hashtagid

hashtagmaxReplies

hashtagminReplies

hashtagcdate

hashtagtcdate

id

cdate

tcdate

mdate

tmdate

ddate

signatures

readers

nonreaders

writers

head

tail

label

weight

invitation

tauthor

id

id

id

id

cdate

tcdate

mdate

tmdate

ddate

signatures

readers

nonreaders

writers

head

tail

label

weight

invitation

tauthor

id

cdate

tcdate

mdate

tmdate

odate

pdate

ddate

invitations

domain

signatures

readers

nonreaders

writers

forum

replyto

content

id

id

maxReplies

minReplies

cdate

tcdate

mdate

tmdate

expdate

duedate

ddate

invitations

domain

signatures

readers

nonreaders

writers

invitees

noninvitees

preprocess

process

dateprocesses

web

replyForumViews

edit

edge

tag

content