Create Annotations

You can create Document Annotation from here

api/Viewer/CreateUpdateAnnotation

Query String

ParameterRequiredValue

Request Header

ParameterRequiredValue
Content-TypeMandatoryapplication/json
TokenKeyMandatoryUser Input
PINProjectIDMandatoryUser Input
Accept-EncodingOptionalgzip
Accept-LanguageOptionalen-US

Request Body

ParameterRequiredValue
AnnotationNameMandatoryUser Input
SecondaryObjectIDOptionalUser Input
RefObjectTypeOptionalUser Input
RefObjectIdOptionalUser Input
PINProjectIDMandatoryUser Input
PageNoMandatoryUser Input
OriginalFileNameMandatoryUser Input
ObjectTypeMandatoryUser Input
ObjectIDMandatoryUser Input
IsPublicOptionalUser Input
IsLockedOptionalUser Input
HyperlinkExistOptionalUser Input
HyperlinkCountOptionalUser Input
WidthOptionalUser Input
HeightOptionalUser Input
CreateByMandatoryUser Input
ClientRefIDOptionalUser Input
AnnotationJsonOptionalUser Input

Example : Request Body

Response

ObjectAnnotationID: XXX-XXX

Enum : Object Type

Property NameDescription
1 - DocumentsProject Files
2 - AttachmentAttached Documents

Enum : Ref Object Type

Property NameDescription
0 - NoneNone
1 - RFIRFI
2 - PhotoPhoto
3 - PunchListPunch List
4 - PreExistHyperlinkPre- Existing Hyper Link
5 - AutoHyperlinkAuto-Hyper Link

Document Annotation Entity

Property NameType
ObjectAnnotationIDInteger
PINProjectIDInteger
ObjectIDInteger
ObjectTypeInteger
SecondaryObjectIDInteger
PageNoInteger
AnnotationCountInteger
RefObjectIdInteger
RefObjectTypeInteger
ClientRefIDInteger
HyperlinkCountInteger
CreateByInteger
ModifyByInteger
FirstNameString
LastNameString
CreateByNameString
CreateDateDate Time
ModifyDateDate Time
HeightDecimal
WidthDecimal
IsPublicBoolean
IsLockedBoolean
HyperlinkExistBoolean
IsDeletedBoolean
AnnotationNameString
AnnotationJsonString
DeviceAnnotationJsonString
OriginalFileNameString
MarkupDataString
MarkupJsonDataString

Remarks