Annotations

Create annotation

Create an annotation thread on a dataset, dataview, or workflow.

post/workspaces/{workspace_id}/projects/{project_id}/annotations

Request

  • Base URL: https://app.mammoth.io/api/v2
  • URL: https://app.mammoth.io/api/v2/workspaces/{workspace_id}/projects/{project_id}/annotations
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-KEY and API key in header X-API-SECRET and API key in header X-WORKSPACE-ID

Path parameters

workspace_idinteger required

Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.

Example:4
project_idinteger required

Project ID of the workspace

Example:4

Request body

target_type'dataset' | 'dataview' | 'workflow' required

Type of the annotated resource: dataset, dataview, or workflow

target_idinteger required

ID of the annotated resource

bodystring required

Initial comment body

Response

Document created, URL follows

idinteger required
target_typestring required
target_idinteger required
project_idinteger required
statusstring required
resolved_byinteger nullable
resolved_atstring nullable
created_byinteger required
created_atstring nullable

Changes

No recorded changes to this operation across all 3 revisions of this API.