Ontology Notes - Revision history

Darren Weber: /* Creating a 'New Term Proposal' proposal / resolve inconsistency in parameter names between 'signature' and 'arguments'. The 'new' parameters don't work.

2013-03-22T22:06:28Z

Creating a 'New Term Proposal' proposal: resolve inconsistency in parameter names between 'signature' and 'arguments'. The 'new*' parameters don't work.

Palexand: /* Creating a 'New Term Proposal' proposal */

2012-06-15T18:56:22Z

Creating a 'New Term Proposal' proposal

Palexand at 18:48, 15 June 2012

2012-06-15T18:48:29Z

Palexand: /* Web services to submit Notes */

2012-03-21T00:02:39Z

Web services to submit Notes

Whetzel: /* Services to access and generate notes */

2011-11-30T10:09:08Z

Services to access and generate notes

Whetzel at 10:06, 30 November 2011

2011-11-30T10:06:57Z

Whetzel: /* Get notes for an ontology by virtual id */

2011-05-22T17:02:33Z

Get notes for an ontology by virtual id

Whetzel at 20:32, 16 May 2011

2011-05-16T20:32:20Z

Whetzel: /* Get notes for an ontology by virtual id */

2011-04-26T15:13:33Z

Get notes for an ontology by virtual id

Whetzel: /* Get notes for an ontology by version id */

2011-04-26T15:11:34Z

Get notes for an ontology by version id

@@ Line 338: / Line 338: @@
 === Creating a 'New Term Proposal' proposal ===
-* '''Signature (HTTP POST)''': ./virtual/notes/{ontology virtual id}?type=ProposalForCreateEntity&appliesto={appliestoid}&appliestotype=Ontology&subject={subject}&reasonforchange={reasonforchange}&author={author}&newtermdefinition={definition}&newtermparent={termparent}&newtermpreferredname={preferredname}&email={email_address}
+* '''Signature (HTTP POST)''': ./virtual/notes/{ontology virtual id}?type=ProposalForCreateEntity&appliesto={appliestoid}&appliestotype=Ontology&subject={subject}&reasonforchange={reasonforchange}&author={author}&termdefinition={definition}&termparent={termparent}&termpreferredname={preferredname}&email={email_address}
-* '''Alt Signature (HTTP POST)''': ./notes/{ontology version id}?type=ProposalForCreateEntity&appliesto={appliestoid}&appliestotype=Ontology&subject={subject}&reasonforchange={reasonforchange}&author={author}&newtermdefinition={definition}&newtermparent={termparent}&newtermpreferredname={preferredname}&email={email_address}
+* '''Alt Signature (HTTP POST)''': ./notes/{ontology version id}?type=ProposalForCreateEntity&appliesto={appliestoid}&appliestotype=Ontology&subject={subject}&reasonforchange={reasonforchange}&author={author}&termdefinition={definition}&termparent={termparent}&termpreferredname={preferredname}&email={email_address}
 * '''Description''': creates a new note of the type 'New Term Proposal'
 * '''Arguments''' (* required):

@@ Line 338: / Line 338: @@
 === Creating a 'New Term Proposal' proposal ===
-* '''Signature (HTTP POST)''': ./virtual/notes/{ontology virtual id}?type=ProposalForCreateEntity&appliesto={appliestoid}&appliestotype=Ontology&subject={subject}&reasonforchange={reasonforchange}&author={author}&newtermdefinition={definition}&newtermid={termid}&newtermparent={termparent}&newtermpreferredname={preferredname}&email={email_address}
+* '''Signature (HTTP POST)''': ./virtual/notes/{ontology virtual id}?type=ProposalForCreateEntity&appliesto={appliestoid}&appliestotype=Ontology&subject={subject}&reasonforchange={reasonforchange}&author={author}&newtermdefinition={definition}&newtermparent={termparent}&newtermpreferredname={preferredname}&email={email_address}
-* '''Alt Signature (HTTP POST)''': ./notes/{ontology version id}?type=ProposalForCreateEntity&appliesto={appliestoid}&appliestotype=Ontology&subject={subject}&reasonforchange={reasonforchange}&author={author}&newtermdefinition={definition}&newtermid={termid}&newtermparent={termparent}&newtermpreferredname={preferredname}&email={email_address}
+* '''Alt Signature (HTTP POST)''': ./notes/{ontology version id}?type=ProposalForCreateEntity&appliesto={appliestoid}&appliestotype=Ontology&subject={subject}&reasonforchange={reasonforchange}&author={author}&newtermdefinition={definition}&newtermparent={termparent}&newtermpreferredname={preferredname}&email={email_address}
 * '''Description''': creates a new note of the type 'New Term Proposal'
-* '''Arguments''':
+* '''Arguments''' (* required):
-** type=ProposalForCreateEntity - the type of note to create.
+** * type=ProposalForCreateEntity - the type of note to create.
-** appliesto={appliestoid} - The id of the thing to associate the note with. This can be a class (term), individual, property, or another note. For classes, individuals, and properties, the specified id must exist in the target ontology. URIs must be URL-encoded.
+** * appliesto={appliestoid} - The id of the thing to associate the note with. This can be a class (term), individual, property, or another note. For classes, individuals, and properties, the specified id must exist in the target ontology. URIs must be URL-encoded.
-** appliestotype={Ontology|Class} - The type of the thing that the note is associated with.
+** * appliestotype={Ontology|Class} - The type of the thing that the note is associated with.
 ** subject={subject} - The subject for the comment.
 ** content={content} - The content of the comment.
 ** contactinfo={contact information} - Contact information for the entity making the request.
 ** termsynonyms={synonym1,synonym2,synonym3} - Synonyms for the new term. Can be a single entry or comma-separated list.
 ** status={status} - Status for this notes. The Changes and Annotation Ontology provides a default set of statuses for proposals (Submitted, Rejected, Under Discussion, Under Review, Approved, Rejected, Implemented, Published) but the service also accepts arbitrary strings.

@@ Line 67: / Line 67: @@
 Some elements have a range of possible returned values.
 * appliesTo/type: Ontology|Class|Individual|Property|Note
-* noteBean/type: Comment|ProposalForNewEntity|ProposalForChangeHierarchy|ProposalForPropertyValueChange
+* noteBean/type: Comment|ProposalForCreateEntity|ProposalForChangeHierarchy|ProposalForPropertyValueChange
 ** Notes with types other than Comment will have an element in noteBean/values that matches the noteBean/type. This contains information specific to these Notes types.
@@ Line 111: / Line 111: @@
          <id>Note_f8bb4dc0-10b3-48b9-ab69-79aed042c0ff</id>
          <ontologyId>1104</ontologyId>
-         <type>ProposalForNewEntity</type>
+         <type>ProposalForCreateEntity</type>
          <author>1234</author>
          <created>1272319359680</created>
@@ Line 124: / Line 124: @@
          </appliesToList>
          <values>
-           <ProposalForNewEntity>
+           <ProposalForCreateEntity>
              <reasonForChange>Bad data</reasonForChange>
              <contactInfo>palexander@stanford.edu</contactInfo>
@@ Line 138: / Line 138: @@
                <string>http://www.owl-ontologies.com/2009/9/24/Ontology1253802770.owl#Summary</string>
              </parent>
-           </ProposalForNewEntity>
+           </ProposalForCreateEntity>
          </values>
        </noteBean>
@@ Line 338: / Line 338: @@
 === Creating a 'New Term Proposal' proposal ===
-* '''Signature (HTTP POST)''': ./virtual/notes/{ontology virtual id}?type=ProposalForNewEntity&appliesto={appliestoid}&appliestotype=Ontology&subject={subject}&reasonforchange={reasonforchange}&author={author}&newtermdefinition={definition}&newtermid={termid}&newtermparent={termparent}&newtermpreferredname={preferredname}&email={email_address}
+* '''Signature (HTTP POST)''': ./virtual/notes/{ontology virtual id}?type=ProposalForCreateEntity&appliesto={appliestoid}&appliestotype=Ontology&subject={subject}&reasonforchange={reasonforchange}&author={author}&newtermdefinition={definition}&newtermid={termid}&newtermparent={termparent}&newtermpreferredname={preferredname}&email={email_address}
-* '''Alt Signature (HTTP POST)''': ./notes/{ontology version id}?type=ProposalForNewEntity&appliesto={appliestoid}&appliestotype=Ontology&subject={subject}&reasonforchange={reasonforchange}&author={author}&newtermdefinition={definition}&newtermid={termid}&newtermparent={termparent}&newtermpreferredname={preferredname}&email={email_address}
+* '''Alt Signature (HTTP POST)''': ./notes/{ontology version id}?type=ProposalForCreateEntity&appliesto={appliestoid}&appliestotype=Ontology&subject={subject}&reasonforchange={reasonforchange}&author={author}&newtermdefinition={definition}&newtermid={termid}&newtermparent={termparent}&newtermpreferredname={preferredname}&email={email_address}
 * '''Description''': creates a new note of the type 'New Term Proposal'
 * '''Arguments''':

@@ Line 307: / Line 307: @@
 </pre>
-== Web services to submit Notes ==
+= Creating Notes in BioPortal =
 * See http://www.bioontology.org/wiki/index.php/BioPortal_Provisional_Terms

@@ Line 31: / Line 31: @@
 * (future implementation) Usage-guideline notes
-== Services to access and generate notes ==
+== Web services to access and generate notes ==
 If you have specific requirements that the list of services below does not satisfy, please contact us at [mailto:support@bioontology.org support@bioontology.org]
@@ Line 306: / Line 306: @@
 </success>
 </pre>
 == Web services to submit Notes ==
 * See http://www.bioontology.org/wiki/index.php/BioPortal_Provisional_Terms

← Older revision		Revision as of 10:06, 30 November 2011
Line 306:		Line 306:
	</success>		</success>
	</pre>		</pre>
		+
		+
		+	== Web services to submit Notes ==
		+	* See http://www.bioontology.org/wiki/index.php/BioPortal_Provisional_Terms

@@ Line 55: / Line 55: @@
 * '''Optional arguments:'''
 ** conceptid={conceptid} - returns notes associated with the given term.
-** instanceid={isntanceid} - returns notes associated with the given instance (individual).
+** instanceid={instanceid} - returns notes associated with the given instance (individual).
 ** noteid={noteid} - returns notes associated with the given note id.
 ** threaded=[true|false] - returns notes in a threaded format where responses are nested in their parent notes. Default is false.

← Older revision		Revision as of 20:32, 16 May 2011
Line 4:		Line 4:

	* '''<font color='red'>Note</font>''': All NCBO REST Web services will be required to contain the parameter "apikey=YourApiKey" starting June 2011. The parameter will be added to all Web service calls for the April 27, 2011 release but will not be required until June 2011. To obtain an API key, login to BioPortal and go to "Account" where your API key will be displayed. The addition of the API key replaces the use of the email parameter.		* '''<font color='red'>Note</font>''': All NCBO REST Web services will be required to contain the parameter "apikey=YourApiKey" starting June 2011. The parameter will be added to all Web service calls for the April 27, 2011 release but will not be required until June 2011. To obtain an API key, login to BioPortal and go to "Account" where your API key will be displayed. The addition of the API key replaces the use of the email parameter.
		+	* '''''Note for Application Developers''''': Application developers will also need to include the apikey parameter on all NCBO Web service calls. This allows us to track usage of our system at the level of an application. To obtain an API key, login to BioPortal and go to "Account" where your API key will be displayed. The addition of the API key replaces the use of the email parameter.

	== Types of notes in BioPortal ==		== Types of notes in BioPortal ==

@@ Line 50: / Line 50: @@
 * '''Signature''': ./virtual/notes/{ontology virtual id}?apikey={YourAPIKey}
 * '''Description''': returns all notes for the virtual ontology, i.e., all notes associated with any version of this ontology
 * '''Optional arguments:'''

@@ Line 36: / Line 36: @@
 * '''Signature''': ./notes/{ontology version id}?apikey={YourAPIKey}
 * '''Description''': returns all notes for a specific version of the ontology
 * '''Optional arguments:'''

Ontology Notes - Revision history

Darren Weber: /* Creating a 'New Term Proposal' proposal */ resolve inconsistency in parameter names between 'signature' and 'arguments'. The 'new*' parameters don't work.

Palexand: /* Creating a 'New Term Proposal' proposal */

Palexand at 18:48, 15 June 2012

Palexand: /* Web services to submit Notes */

Whetzel: /* Services to access and generate notes */

Whetzel at 10:06, 30 November 2011

Whetzel: /* Get notes for an ontology by virtual id */

Whetzel at 20:32, 16 May 2011

Whetzel: /* Get notes for an ontology by virtual id */

Whetzel: /* Get notes for an ontology by version id */

Darren Weber: /* Creating a 'New Term Proposal' proposal / resolve inconsistency in parameter names between 'signature' and 'arguments'. The 'new' parameters don't work.