# Petro.ai Comments Service API Reference

# /api/Comments

# GET

# Summary:

Retrieve Comment document(s)

# Description:

Retrieve Comment document(s) from the Anahita Database

# Parameters

Name	Located in	Description	Required	Schema
Ids	query	List of row/document Ids to find in the database	No	[ string ]
Parents	query	List of parent Ids to find in the database	No	[ string ]
Users	query	List of User Ids to find in the database	No	[ string ]
OrgIds	query	List of Organization Ids to find in the database	No	[ string ]
ThreadIds	query	List of the threadIds to find in the database	No	[ string ]
RelatedIds	query	List of related/external Ids to find in the database	No	[ string ]
AnnotationTypes	query	List of the threadIds to find in the database	No	[ string ]
Limit	query	Limit the number of results returned from the database	No	integer
SortBy	query	Field to sort the return by	No	string
SortOrder	query	Ascending, Descending or None Sort Order	No	string
TextSearch	query	String to search the database by	No	string
TagSearch	query	Tag to search the database by	No	string
IsSubstrSearch	query	Whether the text/tag search is substring based or whole-word based Default value is false (whole-word based search)	No	boolean
TagSuggest	query	Suggest tag based on prefix supplied	No	string
FeedSize	query	Feedsize to show latest comments/tags sorted by created timestamp	No	integer
MentionIds	query	Mention Ids	No	[ string ]

# Responses

Code	Description	Schema
200	Success	AnnotationsResult[Comment]

# PUT

# Summary:

Upsert Comment document(s)

# Description:

Upsert Comment document(s) from the Anahita Database

# Parameters

Name	Located in	Description	Required	Schema
comments	body		No	AnahitaUpsertOptions[Comment]

# Responses

Code	Description	Schema
200	Success	AnnotationsResult[Comment]

# POST

# Summary:

Create Comment document(s)

# Description:

Create Comment document(s) within the Anahita Database

# Parameters

Name	Located in	Description	Required	Schema
comments	body		No	AnahitaInsertOptions[Comment]

# Responses

Code	Description	Schema
200	Success	AnnotationsResult[Comment]

# DELETE

# Summary:

Delete Comment document(s)

# Description:

Delete Comment document(s) from the Anahita Database

# Parameters

Name	Located in	Description	Required	Schema
Ids	query	List of row/document to delete in the database	No	[ string ]
Secure	query	Secure option, check authentication before delete	No	boolean

# Responses

Code	Description	Schema
200	Success	AnnotationsResult[Comment]

# PATCH

# Summary:

Patch/Update Comment document(s)

# Description:

Patch/Update Comment document(s) from the Anahita Database

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	AnahitaUpdateOptions[Comment]

# Responses

Code	Description	Schema
200	Success	AnnotationsResult[Comment]

# /api/Notifications

# GET

# Summary:

Retrieve Notification (s)

# Description:

Retrieve Comment document(s) to be notified

# Parameters

Name	Located in	Description	Required	Schema
Limit	query	Limit the number of results returned from the database	No	integer
SortBy	query	Field to sort the return by	No	string
SortOrder	query	Ascending, Descending or None Sort Order	No	string
Cutoff	query	Cutoff date for notification, default to one month from current date	No	dateTime

# Responses

Code	Description	Schema
200	Success	AnnotationsResult[NotificationResult[Comment]]

# POST

# Summary:

Update notification status(es)

# Description:

Mark notification(s) with a new status within the Anahita Database

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	NotificationsStatusUpdateOptions

# Responses

Code	Description	Schema
200	Success	AnnotationsResult[NotificationStatusUpdate]

# /api/Tags

# GET

# Summary:

Retrieve AnahitaTag document(s)

# Description:

Retrieve AnahitaTag document(s) from the Anahita Database

# Parameters

Name	Located in	Description	Required	Schema
Ids	query	List of row/document Ids to find in the database	No	[ string ]
Parents	query	List of parent Ids to find in the database	No	[ string ]
Users	query	List of User Ids to find in the database	No	[ string ]
OrgIds	query	List of Organization Ids to find in the database	No	[ string ]
ThreadIds	query	List of the threadIds to find in the database	No	[ string ]
RelatedIds	query	List of related/external Ids to find in the database	No	[ string ]
AnnotationTypes	query	List of the threadIds to find in the database	No	[ string ]
Limit	query	Limit the number of results returned from the database	No	integer
SortBy	query	Field to sort the return by	No	string
SortOrder	query	Ascending, Descending or None Sort Order	No	string
TextSearch	query	String to search the database by	No	string
TagSearch	query	Tag to search the database by	No	string
IsSubstrSearch	query	Whether the text/tag search is substring based or whole-word based Default value is false (whole-word based search)	No	boolean
TagSuggest	query	Suggest tag based on prefix supplied	No	string
FeedSize	query	Feedsize to show latest comments/tags sorted by created timestamp	No	integer
MentionIds	query	Mention Ids	No	[ string ]

# Responses

Code	Description	Schema
200	Success	AnnotationsResult[AnahitaTag]

# PUT

# Summary:

Upsert AnahitaTag document(s)

# Description:

Upsert AnahitaTag document(s) from the Anahita Database

# Parameters

Name	Located in	Description	Required	Schema
anahitaTags	body		No	AnahitaUpsertOptions[AnahitaTag]

# Responses

Code	Description	Schema
200	Success	AnnotationsResult[AnahitaTag]

# POST

# Summary:

Create AnahitaTag document(s)

# Description:

Create AnahitaTag document(s) within the Anahita Database

# Parameters

Name	Located in	Description	Required	Schema
anahitaTags	body		No	AnahitaInsertOptions[AnahitaTag]

# Responses

Code	Description	Schema
200	Success	AnnotationsResult[AnahitaTag]

# DELETE

# Summary:

Delete AnahitaTag document(s)

# Description:

Delete AnahitaTag document(s) from the Anahita Database

# Parameters

Name	Located in	Description	Required	Schema
Ids	query	List of row/document to delete in the database	No	[ string ]
Secure	query	Secure option, check authentication before delete	No	boolean

# Responses

Code	Description	Schema
200	Success	AnnotationsResult[AnahitaTag]

# PATCH

# Summary:

Patch/Update AnahitaTag document(s)

# Description:

Patch/Update AnahitaTag document(s) from the Anahita Database

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	AnahitaUpdateOptions[AnahitaTag]

# Responses

Code	Description	Schema
200	Success	AnnotationsResult[AnahitaTag]

# Models

# AnnotationsResult[Comment]

Generic Result class for passing back data from a Annotations.ai Database

Name	Type	Description	Required
data	[ Comment ]	Collection of results from the database	No
success	boolean	Were the results successful?	No
count	long	How many items were affected by the action?	No
total	long	Total results of a query irrespective of skip and limit	No
message	string	Message to send back	No
errors	[ AnnotationsResultError ]	Collection of errors that occurred during the building of this AnnotationsResult	No
hasErrors	boolean	Flag indicating if the results contain errors	No
insertedIds	[ string ]	List of Ids that were added on insert	No
updatedIds	[ string ]	List of Ids that were updated	No
deletedIds	[ string ]	List of Ids that were deleted	No
idsNotFound	[ string ]	List of Ids that were unable to be found (where'd they go? ¯_(ツ)_/¯)	No
idsNotPermitted	[ string ]	List of Ids that did not permit the operation for security (where'd they go? ¯_(ツ)_/¯)	No

# Comment

Name	Type	Required
tagIds	[ string ]	No
mentionIds	[ string ]	No
id	string	No
userId	string	No
orgId	string	No
parentId	string	No
threadId	string	No
annotationType	string	No
content	string	No
metadata	object	No
lastUpdatedAt	dateTime	No
createdAt	dateTime	No
relatedIds	[ string ]	No

# AnnotationsResultError

Class for handling errors inside of the AnnotationsResult

Name	Type	Description	Required
message	string	Message from the error	No

# AnahitaInsertOptions[Comment]

Name	Type	Description	Required
data	[ Comment ]		No

# AnahitaUpsertOptions[Comment]

Name	Type	Description	Required
data	[ Comment ]		No
secure	boolean	Secure option, check authentication before delete	No

# AnahitaUpdateOptions[Comment]

Name	Type	Description	Required
data	[ Comment ]		No
secure	boolean	Secure option, check authentication before delete	No

# AnnotationsResult[NotificationResult[Comment]]

Generic Result class for passing back data from a Annotations.ai Database

Name	Type	Description	Required
data	[ NotificationResult[Comment] ]	Collection of results from the database	No
success	boolean	Were the results successful?	No
count	long	How many items were affected by the action?	No
total	long	Total results of a query irrespective of skip and limit	No
message	string	Message to send back	No
errors	[ AnnotationsResultError ]	Collection of errors that occurred during the building of this AnnotationsResult	No
hasErrors	boolean	Flag indicating if the results contain errors	No
insertedIds	[ string ]	List of Ids that were added on insert	No
updatedIds	[ string ]	List of Ids that were updated	No
deletedIds	[ string ]	List of Ids that were deleted	No
idsNotFound	[ string ]	List of Ids that were unable to be found (where'd they go? ¯_(ツ)_/¯)	No
idsNotPermitted	[ string ]	List of Ids that did not permit the operation for security (where'd they go? ¯_(ツ)_/¯)	No

# NotificationResult[Comment]

Name	Type	Required
item	Comment	No
status	string	No
type	string	No
notificationId	string	No

# NotificationsStatusUpdateOptions

Generic query and API options for updating notification status in Petro.ai DB.

Name	Type	Description	Required
data	[ NotificationStatusUpdate ]		No

# NotificationStatusUpdate

Name	Type	Required
notificationId	string	No
itemId	string	No
type	string	No
status	string	No

# AnnotationsResult[NotificationStatusUpdate]

Generic Result class for passing back data from a Annotations.ai Database

Name	Type	Description	Required
data	[ NotificationStatusUpdate ]	Collection of results from the database	No
success	boolean	Were the results successful?	No
count	long	How many items were affected by the action?	No
total	long	Total results of a query irrespective of skip and limit	No
message	string	Message to send back	No
errors	[ AnnotationsResultError ]	Collection of errors that occurred during the building of this AnnotationsResult	No
hasErrors	boolean	Flag indicating if the results contain errors	No
insertedIds	[ string ]	List of Ids that were added on insert	No
updatedIds	[ string ]	List of Ids that were updated	No
deletedIds	[ string ]	List of Ids that were deleted	No
idsNotFound	[ string ]	List of Ids that were unable to be found (where'd they go? ¯_(ツ)_/¯)	No
idsNotPermitted	[ string ]	List of Ids that did not permit the operation for security (where'd they go? ¯_(ツ)_/¯)	No

# AnnotationsResult[AnahitaTag]

Generic Result class for passing back data from a Annotations.ai Database

Name	Type	Description	Required
data	[ AnahitaTag ]	Collection of results from the database	No
success	boolean	Were the results successful?	No
count	long	How many items were affected by the action?	No
total	long	Total results of a query irrespective of skip and limit	No
message	string	Message to send back	No
errors	[ AnnotationsResultError ]	Collection of errors that occurred during the building of this AnnotationsResult	No
hasErrors	boolean	Flag indicating if the results contain errors	No
insertedIds	[ string ]	List of Ids that were added on insert	No
updatedIds	[ string ]	List of Ids that were updated	No
deletedIds	[ string ]	List of Ids that were deleted	No
idsNotFound	[ string ]	List of Ids that were unable to be found (where'd they go? ¯_(ツ)_/¯)	No
idsNotPermitted	[ string ]	List of Ids that did not permit the operation for security (where'd they go? ¯_(ツ)_/¯)	No

# AnahitaTag

Name	Type	Required
approvalStatus	string	No
id	string	No
userId	string	No
orgId	string	No
parentId	string	No
threadId	string	No
annotationType	string	No
content	string	No
metadata	object	No
lastUpdatedAt	dateTime	No
createdAt	dateTime	No
relatedIds	[ string ]	No

# AnahitaInsertOptions[AnahitaTag]

Name	Type	Description	Required
data	[ AnahitaTag ]		No

# AnahitaUpsertOptions[AnahitaTag]

Name	Type	Description	Required
data	[ AnahitaTag ]		No
secure	boolean	Secure option, check authentication before delete	No

# AnahitaUpdateOptions[AnahitaTag]

Name	Type	Description	Required
data	[ AnahitaTag ]		No
secure	boolean	Secure option, check authentication before delete	No

← Petro.ai 5 API