Skip to main content

LIST Experiment Annotations‚Äč

Required Permissions: Annotation List or Annotation Admin

Query Parameters
    sort string

    The object key to sort the results by.

    sort_asc boolean
    page integer
    items integer
    experiment_id integer

    Filter experiment annotations by experiment_id

Responses

A JSON Object containing an array of all experiment annotations.


Schema
    items integer
    page integer

    Possible values: >= 1

    total integer
    experiment_annotations object[]
  • Array [
  • id integer
    timestamp date-time
    description string
    color string

    Possible values: Value must match regular expression ^#[A-Fa-f0-9]{6}

    type

    Possible values: [local, global]

    experiment_id integer
    created_at date-time
    created_by_user_id integer
    updated_at date-time nullable
    updated_by_user_id integer nullable
    created_by object
    archived boolean
    avatar object nullable
    avatar_file_upload_url string
    created_at date-time
    created_by_user_id integer

    Possible values: >= 1

    department string
    email email
    updated_by object nullable
    archived boolean
    avatar object nullable
    avatar_file_upload_url string
    created_at date-time
    created_by_user_id integer

    Possible values: >= 1

    department string
    email email
  • ]
Loading...