CommentService

• getComment
• getCommentsByIds
• getCommentIdsByType
• getCommentsByReferenceAndType
• searchForCommentIds
• searchForComments
• createComment
• updateComment
• deleteComment
• deleteCommentsByReference
• validateComment
• getTag
• getTagsByIds
• getTagIdsByType
• getTagsByReferenceAndType
• searchForTagIds
• searchForTags
• createTag
• deleteTagsByReference
• deleteTag
• getObjectStructure
• getObjectTypes

• CommentInfo
• QueryByCriteria
• StatusInfo
• ValidationResultInfo
• TagInfo
• ObjectStructureDefinition

Method	getComment
Description	Retrieves information about a comment.
Parameters	String	commentId	comment identifier
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CommentInfo		information about a comment
Errors	DoesNotExistException		specified commentId not found
	InvalidParameterException		invalid commentId
	MissingParameterException		commentId, contextInfo not specified
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCommentsByIds
Description	Retrieves a list of Comments corresponding to the given list of Comment Ids
Parameters	StringList	commentIds	list of Comments to be retrieved
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CommentInfoList		list of Comment information
Errors	DoesNotExistException		an commentKey in list not found
	InvalidParameterException		invalid commentKey
	MissingParameterException		commentIds, contextInfo not specified
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCommentIdsByType
Description	Retrieves a list of Comments of the specified type.
Parameters	String	commentTypeKey	type to be retrieved
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		a list of Comment keys
Errors	InvalidParameterException		invalid commentTypeKey
	MissingParameterException		commentTypeKey, contextInfo not specified
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCommentsByReferenceAndType
Description	Retrieves comment information for a reference. The expected behavior is that if the caller is not authorized to invoke the getCommentsByReferenceAndType operation, a PERMISSION_DENIED error is returned. Assuming that the caller is authorized to invoke getCommentsByReferenceAndType, only comments that the caller is authorized to view are included in the returned commentInfoList; comments that the caller is unauthorized to view are filtered out of the return parameter.
Parameters	String	referenceId	reference identifier
	String	referenceTypeKey	reference type
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CommentInfoList		Comment information
Errors	DoesNotExistException		specified referenceId, referenceTypeKey not found
	InvalidParameterException		invalid referenceId, referenceTypeKey
	MissingParameterException		referenceId, referenceTypeKey, contextInfo not specified
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	searchForCommentIds
Description	Searches for Comments based on the criteria and returns a list of Comment identifiers which match the search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		list of Comment Ids
Errors	InvalidParameterException		invalid parameter
	MissingParameterException		criteria, contextInfo not specified
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	searchForComments
Description	Searches for Comments based on the criteria and returns a list of Comments which match the search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CommentInfoList		list of Comment information
Errors	InvalidParameterException		invalid parameter
	MissingParameterException		criteria, contextInfo not specified
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	createComment
Description	Adds a comment to a reference.
Parameters	String	referenceId	identifier of reference
	String	referenceTypeKey	reference type
	String	commentTypeKey	comment type
	CommentInfo	commentInfo	detailed information about the comment
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CommentInfo		detailed information about the comment
Errors	DataValidationErrorException		One or more values invalid for this operation
	DoesNotExistException		Id or Key does not exist
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	ReadOnlyException		attempted update of readonly data

Back to Operations

Method	updateComment
Description	Updates a comment for a reference.
Parameters	String	commentId	comment identifier
	CommentInfo	commentInfo	detailed information about the comment
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CommentInfo		detailed information about the comment
Errors	DataValidationErrorException		One or more values invalid for this operation
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		commentId, commentInfo not specified
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	DoesNotExistException		comment does not exist
	VersionMismatchException		The action was attempted on an out of date version.
	ReadOnlyException		attempted update of readonly data

Back to Operations

Method	deleteComment
Description	Removes a comment from a reference.
Parameters	String	commentId	identifier of the comment
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation (success, failed)
Errors	DoesNotExistException		commentId, referenceId does not exist
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		commentId, contextInfo not specified
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	deleteCommentsByReference
Description	Removes all comments associated with a single reference
Parameters	String	referenceId	identifier of the reference
	String	referenceTypeKey	reference type
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation (success, failed)
Errors	DoesNotExistException		referenceId does not exist
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		referenceId, referenceTypeKey not specified
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	validateComment
Description	Validates a comment. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the comment (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the comment can be shifted to the new values. If an identifier is not present or a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationType to the current object.
Parameters	String	validationTypeKey	identifier of the extent of validation
	CommentInfo	commentInfo	comment information to be tested
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ValidationResultInfoList		results from performing the validation
Errors	DoesNotExistException		validationTypeKey not found
	InvalidParameterException		invalid validationTypeKey, commentInfo
	MissingParameterException		validationTypeKey, commentInfo, contextInfo not specified
	OperationFailedException		unable to complete request

Back to Operations

Method	getTag
Description	Retrieves information about a tag.
Parameters	String	tagId	tag identifier
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TagInfo		information about a tag
Errors	DoesNotExistException		specified tagId not found
	InvalidParameterException		invalid tagId
	MissingParameterException		tagId, contextInfo not specified
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getTagsByIds
Description	Retrieves a list of Tags corresponding to the given list of Tag keys.
Parameters	StringList	tagIds	list of Tags to be retrieved
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TagInfoList		list of Tag information for the given list of Tag Ids
Errors	DoesNotExistException		an tagKey in list not found
	InvalidParameterException		invalid tagKey
	MissingParameterException		tagIds, contextInfo not specified
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getTagIdsByType
Description	Retrieves a list of Tags of the specified type.
Parameters	String	tagTypeKey	type to be retrieved
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		a list of Tag Ids
Errors	InvalidParameterException		invalid tagTypeKey
	MissingParameterException		tagTypeKey, contextInfo not specified
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getTagsByReferenceAndType
Description	Retrieves tag information for a reference. The expected behavior is that if the caller is not authorized to invoke the getTags operation, a PERMISSION_DENIED error is returned. Assuming that the caller is authorized to invoke getTags, only tags that the caller is authorized to view are included in the returned tagInfoList; tags that the caller is unauthorized to view are filtered out of the return parameter.
Parameters	String	referenceId	reference identifier
	String	referenceTypeKey	reference type
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TagInfoList		list of tag information for the given object ref id and type
Errors	DoesNotExistException		specified referenceId, referenceTypeKey not found
	InvalidParameterException		invalid referenceId, referenceTypeKey
	MissingParameterException		referenceId, referenceTypeKey, contextInfo not specified
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	searchForTagIds
Description	Searches for Tags based on the criteria and returns a list of Tag identifiers which match the search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		list of Tag Ids
Errors	InvalidParameterException		invalid parameter
	MissingParameterException		criteria, contextInfo not specified
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	searchForTags
Description	Searches for Tags based on the criteria and returns a list of Tags which match the search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TagInfoList		list of Tag information
Errors	InvalidParameterException		invalid parameter
	MissingParameterException		criteria, contextInfo not specified
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	createTag
Description	Adds a tag to a reference.
Parameters	String	referenceId	identifier of reference
	String	referenceTypeKey	reference type
	TagInfo	tagInfo	detailed information about the tag
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TagInfo		detailed information about the tag
Errors	DataValidationErrorException		One or more values invalid for this operation
	DoesNotExistException		Id or Key does not exist
	AlreadyExistsException		tag of that namespace, predicate and value already exists for that reference id
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		referenceId, referenceTypeKey, tagInfo, contextInfo not specified
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	ReadOnlyException		attempted update of readonly data

Back to Operations

Method	deleteTagsByReference
Description	Removes all tags associated with a single reference
Parameters	String	referenceId	identifier of the reference
	String	referenceTypeKey	reference type
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation (success, failed)
Errors	DoesNotExistException		tagId, referenceId does not exist
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		referenceId, referenceTypeKey, contextInfo not specified
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	deleteTag
Description	Removes a tag from all references to which it is linked.
Parameters	String	tagId	identifier of the tag
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation (success, failed)
Errors	DoesNotExistException		tagId does not exist
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		tagId, contextInfo not specified
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getObjectStructure
Description	??? ============== Deprecated ===============
Parameters	String	objectTypeKey	???
Return	ObjectStructureDefinition		???
Errors	NONE		No Errors

Back to Operations

Method	getObjectTypes
Description	??? ============== Deprecated ===============
Parameters	None	None	No Parameters
Return	StringList		???
Errors	NONE		No Errors

Back to Operations