AnnotationController.CreateAnnotation Method |
Creates an annotation.
Namespace:
Dundas.BI.WebApi.Controllers
Assembly:
Dundas.BI.WebApi (in Dundas.BI.WebApi.dll) Version: 2.0.0.0 (25.2.0.1000)
Syntax[HttpPostAttribute]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(405)]
[ProducesResponseTypeAttribute(410)]
[ProducesResponseTypeAttribute(440)]
public ActionResult<AnnotationData> CreateAnnotation(
[FromBodyAttribute] CreateAnnotationOptions options,
Guid? sessionId = null
)
<HttpPostAttribute>
<ProducesResponseTypeAttribute(403)>
<ProducesResponseTypeAttribute(405)>
<ProducesResponseTypeAttribute(410)>
<ProducesResponseTypeAttribute(440)>
Public Function CreateAnnotation (
<FromBodyAttribute> options As CreateAnnotationOptions,
Optional sessionId As Guid? = Nothing
) As ActionResult(Of AnnotationData)
public:
[HttpPostAttribute]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(405)]
[ProducesResponseTypeAttribute(410)]
[ProducesResponseTypeAttribute(440)]
ActionResult<AnnotationData^>^ CreateAnnotation(
[FromBodyAttribute] CreateAnnotationOptions^ options,
Nullable<Guid> sessionId = nullptr
)
[<HttpPostAttribute>]
[<ProducesResponseTypeAttribute(403)>]
[<ProducesResponseTypeAttribute(405)>]
[<ProducesResponseTypeAttribute(410)>]
[<ProducesResponseTypeAttribute(440)>]
member CreateAnnotation :
[<FromBodyAttribute>] options : CreateAnnotationOptions *
?sessionId : Nullable<Guid>
(* Defaults:
let _sessionId = defaultArg sessionId null
*)
-> ActionResult<AnnotationData>
Parameters
- options
- Type: Dundas.BI.WebApi.Models.CreateAnnotationOptions
The annotation options to be created. - sessionId (Optional)
- Type: System.Nullable<Guid>
Current session ID.
Return Value
Type:
ActionResult<AnnotationData>The operation completed successfully. The payload contains an
AnnotationData object.
See Also