Dendra API Documentation

Aggregate

A definition for an automated data agregate calculation based on datapoints.

Show properties and constraints defined on the object

POST
Create aggregate

Create a new aggregate.

POST aggregates

Optional parameters

Name /type

Description /example

Constraints

_id
string

The unique document identifier

"rollupDatapoints-0C97-4378-F4DA-A1FD-7353-EFBB-B379-9CBD-4B78-1927-44D2-790D-25BA-A086-BCEC-0D93"
  • max length: 120

build_at
string

When this aggregate is scheduled to be built

"2017-05-28T09:50:23.106Z"
  • pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}[T][0-9]{2}:[0-9]{2}:[0-9]{2}|.|[0-9]{0,3}Z$

build_every
string

How often this aggregate should be automatically rebuilt

"1_d"
  • pattern: ^[0-9]+_[mhdwMQy]$

description
string

Text describing this document

"Blue Oak Ranch daily cumulative precipitation."

    expires_at
    string

    When this aggregate definition is scheduled to be groomed

    "2017-05-28T09:50:23.106Z"
    • pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}[T][0-9]{2}:[0-9]{2}:[0-9]{2}|.|[0-9]{0,3}Z$

    method
    string

    The aggregation method to invoke when building the aggregate

    "rollupDatapoints"

      name
      string

      "Daily Cumulative Precipitation"

        spec
        object

        A unique user-provided specification passed to the aggregation method

        { "big_math": true, "query": { "datastream_id": "5ae879c9fe27f428ce102df9", "time_local": true }, "rollups": [ { "aggregations": [ { "alias": "v_sum", "field": "v", "filter": "optional", "func": "sum" } ], "window": "1_h" } ], "shift": "so_M", "time_cursor": "1_d", "time_gte": "2017-01-01", "time_lt": "2018-01-01" }

          cURL

          curl -X POST "http://api.dendra.science/v1/aggregates" \
               -H "Content-Type: application/json" \
               --data '{"_id":"rollupDatapoints-0C97-4378-F4DA-A1FD-7353-EFBB-B379-9CBD-4B78-1927-44D2-790D-25BA-A086-BCEC-0D93","build_at":"2017-05-28T09:50:23.106Z","build_every":"1_d","description":"Blue Oak Ranch daily cumulative precipitation.","expires_at":"2017-05-28T09:50:23.106Z","method":"rollupDatapoints","name":"Daily Cumulative Precipitation","spec":{"big_math":true,"query":{"datastream_id":"5ae879c9fe27f428ce102df9","time_local":true},"rollups":[{"aggregations":[{"alias":"v_sum","field":"v","filter":"optional","func":"sum"}],"window":"1_h"}],"shift":"so_M","time_cursor":"1_d","time_gte":"2017-01-01","time_lt":"2018-01-01"}}'

          Response

          {}

          DELETE
          Remove aggregate

          Remove an existing aggregate.

          DELETE aggregates/:_id

          cURL

          curl -X DELETE "http://api.dendra.science/v1/aggregates/rollupDatapoints-0C97-4378-F4DA-A1FD-7353-EFBB-B379-9CBD-4B78-1927-44D2-790D-25BA-A086-BCEC-0D93" \
               -H "Content-Type: application/json"

          Response

          {}

          GET
          Aggregate info

          Return a specific aggregate.

          GET aggregates/:_id

          cURL

          curl -X GET "http://api.dendra.science/v1/aggregates/rollupDatapoints-0C97-4378-F4DA-A1FD-7353-EFBB-B379-9CBD-4B78-1927-44D2-790D-25BA-A086-BCEC-0D93" \
               -H "Content-Type: application/json"

          Response

          {}

          GET
          List aggregates

          Find one or more aggregates based on the query parameters.

          GET aggregates

          Optional parameters

          Name /type

          Description /example

          Constraints

          field_name

          Filter where a field is equal to the supplied value

          "field_value"

            field_name[$op]

            Filter using advanced query operators: $in, $nin, $lt, $lte, $gt, $gte, $ne, and $or

            "field_value"

              $limit
              integer

              Specify the maximum number of items to return

              10
              • default value: 20
              • max value:2000

              $skip
              integer

              Specify the number of items to skip over (offset)

              2
              • default value: 0

              $sort[field_name]

              Specify the fields to sort by and the respective sort order

              1
              • valid values: -1, 1

              $select[field_name]

              Pick which fields to include in the results

              1
              • valid values: 1

              cURL

              curl -X GET "http://api.dendra.science/v1/aggregates?field_name=field_value&field_name[$op]=field_value&$limit=10&$skip=2&$sort[field_name]=1&$select[field_name]=1" \
                   -H "Content-Type: application/json"

              Response

              {
                "total": 1,
                "limit": 10,
                "skip": 2,
                "data": [
                  {}
                ]
              }

              POST
              Request aggregate

              Request an aggregate result. Creates and builds the aggregate if it does not exist.

              POST aggregates/request

              Optional parameters

              Name /type

              Description /example

              Constraints

              build_at
              string

              When this aggregate is scheduled to be built

              "2017-05-28T09:50:23.106Z"
              • pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}[T][0-9]{2}:[0-9]{2}:[0-9]{2}|.|[0-9]{0,3}Z$

              build_every
              string

              How often this aggregate should be automatically rebuilt

              "1_d"
              • pattern: ^[0-9]+_[mhdwMQy]$

              description
              string

              Text describing this document

              "Blue Oak Ranch daily cumulative precipitation."

                expires_at
                string

                When this aggregate definition is scheduled to be groomed

                "2017-05-28T09:50:23.106Z"
                • pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}[T][0-9]{2}:[0-9]{2}:[0-9]{2}|.|[0-9]{0,3}Z$

                method
                string

                The aggregation method to invoke when building the aggregate

                "rollupDatapoints"

                  name
                  string

                  "Daily Cumulative Precipitation"

                    spec
                    object

                    A unique user-provided specification passed to the aggregation method

                    { "big_math": true, "query": { "datastream_id": "5ae879c9fe27f428ce102df9", "time_local": true }, "rollups": [ { "aggregations": [ { "alias": "v_sum", "field": "v", "filter": "optional", "func": "sum" } ], "window": "1_h" } ], "shift": "so_M", "time_cursor": "1_d", "time_gte": "2017-01-01", "time_lt": "2018-01-01" }

                      cURL

                      curl -X POST "http://api.dendra.science/v1/aggregates/request" \
                           -H "Content-Type: application/json" \
                           --data '{"build_at":"2017-05-28T09:50:23.106Z","build_every":"1_d","description":"Blue Oak Ranch daily cumulative precipitation.","expires_at":"2017-05-28T09:50:23.106Z","method":"rollupDatapoints","name":"Daily Cumulative Precipitation","spec":{"big_math":true,"query":{"datastream_id":"5ae879c9fe27f428ce102df9","time_local":true},"rollups":[{"aggregations":[{"alias":"v_sum","field":"v","filter":"optional","func":"sum"}],"window":"1_h"}],"shift":"so_M","time_cursor":"1_d","time_gte":"2017-01-01","time_lt":"2018-01-01"}}'

                      Response

                      {}

                      GET
                      Aggregate result

                      Request a specific pre-built aggregate result.

                      GET aggregates/result/:_id

                      cURL

                      curl -X GET "http://api.dendra.science/v1/aggregates/result/rollupDatapoints-0C97-4378-F4DA-A1FD-7353-EFBB-B379-9CBD-4B78-1927-44D2-790D-25BA-A086-BCEC-0D93" \
                           -H "Content-Type: application/json"

                      Response

                      {
                        "request": {
                          "_id": "rollupDatapoints-0C97-4378-F4DA-A1FD-7353-EFBB-B379-9CBD-4B78-1927-44D2-790D-25BA-A086-BCEC-0D93",
                          "created_at": "2017-05-28T09:50:23.106Z",
                          "updated_at": "2017-05-28T09:50:23.106Z",
                          "build_at": "2017-05-28T09:50:23.106Z",
                          "build_every": "1_d",
                          "build_info": {
                            "request_subject": "dendra.aggregateBuild.v1.req",
                            "requested_at": "2017-05-11T00:00:00Z"
                          },
                          "description": "Blue Oak Ranch daily cumulative precipitation.",
                          "expires_at": "2017-05-28T09:50:23.106Z",
                          "method": "rollupDatapoints",
                          "name": "Daily Cumulative Precipitation",
                          "spec": {
                            "big_math": true,
                            "query": {
                              "datastream_id": "5ae879c9fe27f428ce102df9",
                              "time_local": true
                            },
                            "rollups": [
                              {
                                "aggregations": [
                                  {
                                    "alias": "v_sum",
                                    "field": "v",
                                    "filter": "optional",
                                    "func": "sum"
                                  }
                                ],
                                "window": "1_h"
                              }
                            ],
                            "shift": "so_M",
                            "time_cursor": "1_d",
                            "time_gte": "2017-01-01",
                            "time_lt": "2018-01-01"
                          }
                        },
                        "result": {
                          "build_info": {
                            "duration": 13336,
                            "finished_at": "2018-06-25T18:49:43.705Z",
                            "started_at": "2018-06-25T18:49:30.369Z"
                          },
                          "data": []
                        }
                      }

                      Dashboard

                      A collection of graphs and widgets displaying realtime data.

                      Show properties and constraints defined on the object

                      POST
                      Create dashboard

                      Create a new dashboard.

                      POST dashboards

                      Optional parameters

                      Name /type

                      Description /example

                      Constraints

                      enabled
                      boolean

                      Whether this dashboard is enabled (shown) in any user interface

                      true
                      • valid values: (true,false)

                      station_id
                      string

                      The station to which a dashboard belongs

                      "592f155746a1b867a114e060"
                      • max length: 24
                      • pattern: ^[a-fA-F0-9]{24}$

                      organization_id
                      string

                      The organization to which a dashboard belongs

                      "592f155746a1b867a114e030"
                      • max length: 24
                      • pattern: ^[a-fA-F0-9]{24}$

                      name
                      string

                      "Well Status"

                        slug
                        string

                        A human-readable and URL-friendly name used to retrieve this document's page or resource

                        "well-status"
                        • pattern: ^[a-z0-9-]+$

                        utc_offset
                        integer

                        An offset in seconds between the time zone and UTC

                        -28800

                          sort_value
                          integer

                          A numeric value that controls how the dashboard is ordered in lists

                          10

                            sources
                            array

                            Fetching and publishing configuration for populating dashboard components

                            [ { "after_fetch_hook": "seriesAsc", "assign_hook": "result", "before_fetch_hook": "seriesAsc", "clear_hook": "channel", "fetch_hook": "result", "find_actions": [ { "options": {}, "path": "/datapoints/lookup", "query": { "_id": [ "592f155746a1b867a114e020" ] } } ], "guard_hook": "seriesAsc", "key": "soilTemps", "options": { "cursorDate": [ { "m": "add", "p": [ 4, "d" ] } ], "endDate": [ { "m": "startOf", "p": "d" }, { "m": "add", "p": [ 1, "d" ] } ], "startDate": [ { "m": "startOf", "p": "d" }, { "m": "subtract", "p": [ 13, "d" ] } ], "useWallTime": true }, "query_builder": "seriesAsc", "template": "seriesAsc", "topic": "soilTemps" } ]
                            • min length: 1

                            content
                            object

                            Layout and component configuration used for rendering the dashboard

                            { "rows": [ { "classes": [ "first-class", "second-class" ], "columns": [ { "classes": [ "first-class", "second-class" ], "component": { "classes": [ "first-class", "second-class" ], "id": "soilTempsChart", "name": "Highchart", "options": { "chart": { "title": { "text": "Air Temperature" } }, "colors": [ "#dcac5c", "#615c42" ] }, "style": { "backgroundColor": "white" }, "topic": "soilTemps" }, "style": { "backgroundColor": "white" }, "title": "Col title" } ], "style": { "backgroundColor": "white" }, "title": "Row title" } ] }

                              cURL

                              curl -X POST "http://api.dendra.science/v1/dashboards" \
                                   -H "Content-Type: application/json" \
                                   --data '{"content":{"rows":[{"classes":["first-class","second-class"],"columns":[{"classes":["first-class","second-class"],"component":{"classes":["first-class","second-class"],"id":"soilTempsChart","name":"Highchart","options":{"chart":{"title":{"text":"Air Temperature"}},"colors":["#dcac5c","#615c42"]},"style":{"backgroundColor":"white"},"topic":"soilTemps"},"style":{"backgroundColor":"white"},"title":"Col title"}],"style":{"backgroundColor":"white"},"title":"Row title"}]},"enabled":true,"name":"Well Status","organization_id":"592f155746a1b867a114e030","slug":"well-status","sort_value":10,"sources":[{"after_fetch_hook":"seriesAsc","assign_hook":"result","before_fetch_hook":"seriesAsc","clear_hook":"channel","fetch_hook":"result","find_actions":[{"options":{},"path":"/datapoints/lookup","query":{"_id":["592f155746a1b867a114e020"]}}],"guard_hook":"seriesAsc","key":"soilTemps","options":{"cursorDate":[{"m":"add","p":[4,"d"]}],"endDate":[{"m":"startOf","p":"d"},{"m":"add","p":[1,"d"]}],"startDate":[{"m":"startOf","p":"d"},{"m":"subtract","p":[13,"d"]}],"useWallTime":true},"query_builder":"seriesAsc","template":"seriesAsc","topic":"soilTemps"}],"station_id":"592f155746a1b867a114e060","utc_offset":-28800}'

                              Response

                              {}

                              PUT
                              Update dashboard

                              Update an existing dashboard.

                              PUT dashboards/:_id

                              Optional parameters

                              Name /type

                              Description /example

                              Constraints

                              enabled
                              boolean

                              Whether this dashboard is enabled (shown) in any user interface

                              true
                              • valid values: (true,false)

                              station_id
                              string

                              The station to which a dashboard belongs

                              "592f155746a1b867a114e060"
                              • max length: 24
                              • pattern: ^[a-fA-F0-9]{24}$

                              organization_id
                              string

                              The organization to which a dashboard belongs

                              "592f155746a1b867a114e030"
                              • max length: 24
                              • pattern: ^[a-fA-F0-9]{24}$

                              name
                              string

                              "Well Status"

                                slug
                                string

                                A human-readable and URL-friendly name used to retrieve this document's page or resource

                                "well-status"
                                • pattern: ^[a-z0-9-]+$

                                utc_offset
                                integer

                                An offset in seconds between the time zone and UTC

                                -28800

                                  sort_value
                                  integer

                                  A numeric value that controls how the dashboard is ordered in lists

                                  10

                                    sources
                                    array

                                    Fetching and publishing configuration for populating dashboard components

                                    [ { "after_fetch_hook": "seriesAsc", "assign_hook": "result", "before_fetch_hook": "seriesAsc", "clear_hook": "channel", "fetch_hook": "result", "find_actions": [ { "options": {}, "path": "/datapoints/lookup", "query": { "_id": [ "592f155746a1b867a114e020" ] } } ], "guard_hook": "seriesAsc", "key": "soilTemps", "options": { "cursorDate": [ { "m": "add", "p": [ 4, "d" ] } ], "endDate": [ { "m": "startOf", "p": "d" }, { "m": "add", "p": [ 1, "d" ] } ], "startDate": [ { "m": "startOf", "p": "d" }, { "m": "subtract", "p": [ 13, "d" ] } ], "useWallTime": true }, "query_builder": "seriesAsc", "template": "seriesAsc", "topic": "soilTemps" } ]
                                    • min length: 1

                                    content
                                    object

                                    Layout and component configuration used for rendering the dashboard

                                    { "rows": [ { "classes": [ "first-class", "second-class" ], "columns": [ { "classes": [ "first-class", "second-class" ], "component": { "classes": [ "first-class", "second-class" ], "id": "soilTempsChart", "name": "Highchart", "options": { "chart": { "title": { "text": "Air Temperature" } }, "colors": [ "#dcac5c", "#615c42" ] }, "style": { "backgroundColor": "white" }, "topic": "soilTemps" }, "style": { "backgroundColor": "white" }, "title": "Col title" } ], "style": { "backgroundColor": "white" }, "title": "Row title" } ] }

                                      cURL

                                      curl -X PUT "http://api.dendra.science/v1/dashboards/592f155746a1b867a114e090" \
                                           -H "Content-Type: application/json" \
                                           --data '{"content":{"rows":[{"classes":["first-class","second-class"],"columns":[{"classes":["first-class","second-class"],"component":{"classes":["first-class","second-class"],"id":"soilTempsChart","name":"Highchart","options":{"chart":{"title":{"text":"Air Temperature"}},"colors":["#dcac5c","#615c42"]},"style":{"backgroundColor":"white"},"topic":"soilTemps"},"style":{"backgroundColor":"white"},"title":"Col title"}],"style":{"backgroundColor":"white"},"title":"Row title"}]},"enabled":true,"name":"Well Status","organization_id":"592f155746a1b867a114e030","slug":"well-status","sort_value":10,"sources":[{"after_fetch_hook":"seriesAsc","assign_hook":"result","before_fetch_hook":"seriesAsc","clear_hook":"channel","fetch_hook":"result","find_actions":[{"options":{},"path":"/datapoints/lookup","query":{"_id":["592f155746a1b867a114e020"]}}],"guard_hook":"seriesAsc","key":"soilTemps","options":{"cursorDate":[{"m":"add","p":[4,"d"]}],"endDate":[{"m":"startOf","p":"d"},{"m":"add","p":[1,"d"]}],"startDate":[{"m":"startOf","p":"d"},{"m":"subtract","p":[13,"d"]}],"useWallTime":true},"query_builder":"seriesAsc","template":"seriesAsc","topic":"soilTemps"}],"station_id":"592f155746a1b867a114e060","utc_offset":-28800}'

                                      Response

                                      {}

                                      DELETE
                                      Remove dashboard

                                      Remove an existing dashboard.

                                      DELETE dashboards/:_id

                                      cURL

                                      curl -X DELETE "http://api.dendra.science/v1/dashboards/592f155746a1b867a114e090" \
                                           -H "Content-Type: application/json"

                                      Response

                                      {}

                                      GET
                                      Dashboard info

                                      Return a specific dashboard.

                                      GET dashboards/:_id

                                      cURL

                                      curl -X GET "http://api.dendra.science/v1/dashboards/592f155746a1b867a114e090" \
                                           -H "Content-Type: application/json"

                                      Response

                                      {}

                                      GET
                                      List dashboards

                                      Find one or more dashboards based on the query parameters.

                                      GET dashboards

                                      Optional parameters

                                      Name /type

                                      Description /example

                                      Constraints

                                      field_name

                                      Filter where a field is equal to the supplied value

                                      "field_value"

                                        field_name[$op]

                                        Filter using advanced query operators: $in, $nin, $lt, $lte, $gt, $gte, $ne, and $or

                                        "field_value"

                                          $limit
                                          integer

                                          Specify the maximum number of items to return

                                          10
                                          • default value: 20
                                          • max value:2000

                                          $skip
                                          integer

                                          Specify the number of items to skip over (offset)

                                          2
                                          • default value: 0

                                          $sort[field_name]

                                          Specify the fields to sort by and the respective sort order

                                          1
                                          • valid values: -1, 1

                                          $select[field_name]

                                          Pick which fields to include in the results

                                          1
                                          • valid values: 1

                                          cURL

                                          curl -X GET "http://api.dendra.science/v1/dashboards?field_name=field_value&field_name[$op]=field_value&$limit=10&$skip=2&$sort[field_name]=1&$select[field_name]=1" \
                                               -H "Content-Type: application/json"

                                          Response

                                          {
                                            "total": 1,
                                            "limit": 10,
                                            "skip": 2,
                                            "data": [
                                              {}
                                            ]
                                          }

                                          Datapoint

                                          An individual time series observation in a datastream.

                                          Show properties and constraints defined on the object

                                          GET
                                          List datapoints

                                          Find one or more datapoints based on the query parameters.

                                          GET datapoints

                                          Required parameters

                                          Name /type

                                          Description /example

                                          Constraints

                                          datastream_id
                                          string

                                          A datastream identifier

                                          "592f155746a1b867a114e020"
                                          • max length: 24
                                          • pattern: ^[a-fA-F0-9]{24}$

                                          Optional parameters

                                          Name /type

                                          Description /example

                                          Constraints

                                          time[$op]
                                          string

                                          Filter on time using query operators: $lt, $lte, $gt, $gte

                                          "2017-05-11T00:00:00Z"
                                          • pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}[T][0-9]{2}:[0-9]{2}:[0-9]{2}|.|[0-9]{0,3}Z$

                                          uom_id
                                          string

                                          Attempt to convert the datapoint values to this unit of measurement

                                          "degree-fahrenheit"
                                          • max length: 50

                                          som_id
                                          string

                                          Attempt to convert the datapoint values to this system of measurement

                                          "imp"
                                          • max length: 50

                                          lon
                                          number

                                          Return datapoints for the given longitude (alias 'lng')

                                          -121.8863286

                                            $sort[time]

                                            Specify the sort order

                                            1
                                            • default value: -1
                                            • valid values: -1, 1

                                            $limit
                                            integer

                                            Specify the maximum number of items to return

                                            10
                                            • default value: 20
                                            • max value:2000

                                            time_local
                                            boolean

                                            Whether the time parameter is in local time

                                            true
                                            • default value: false
                                            • valid values: (true,false)

                                            lat
                                            number

                                            Return datapoints for the given latitude

                                            37.3382082

                                              cURL

                                              curl -X GET "http://api.dendra.science/v1/datapoints?datastream_id=592f155746a1b867a114e020&som_id=imp&uom_id=degree-fahrenheit&lat=37.3382082&lon=-121.8863286&time[$op]=2017-05-11T00:00:00Z&time_local=true&$limit=10&$sort[time]=1" \
                                                   -H "Content-Type: application/json"

                                              Response

                                              {
                                                "limit": 10,
                                                "data": [
                                                  {}
                                                ]
                                              }

                                              GET
                                              Lookup datapoints

                                              Find datapoints for up to 100 datastreams based on the query parameters. This endpoint is analogous to datastreams/lookups with the added ability to return datapoints.

                                              GET datapoints/lookup

                                              Optional parameters

                                              Name /type

                                              Description /example

                                              Constraints

                                              attributes_exists
                                              boolean

                                              Whether the datastreams have attributes or not

                                              false
                                              • valid values: (true,false)

                                              station_id
                                              array

                                              A comma separated list of station identifiers (can be combined with attributes_exist and tags)

                                              [ "592f155746a1b867a114e060", "592f155746a1b867a114e061" ]

                                                time[$op]
                                                string

                                                Filter on time using query operators: $lt, $lte, $gt, $gte

                                                "2017-05-11T00:00:00Z"
                                                • pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}[T][0-9]{2}:[0-9]{2}:[0-9]{2}|.|[0-9]{0,3}Z$

                                                uom_id
                                                string

                                                Attempt to convert the datapoint values to this unit of measurement

                                                "degree-fahrenheit"
                                                • max length: 50

                                                som_id
                                                string

                                                Do a fuzzy match on datastreams, then attempt to convert the datapoint values to this system of measurement

                                                "imp"
                                                • max length: 50

                                                lon
                                                number

                                                Return datapoints for the given longitude (alias 'lng')

                                                -121.8863286

                                                  $sort[time]

                                                  Specify the sort order

                                                  1
                                                  • default value: -1
                                                  • valid values: -1, 1

                                                  $limit
                                                  integer

                                                  Specify the maximum number of items to return

                                                  10
                                                  • default value: 20
                                                  • max value:2000

                                                  tags
                                                  string

                                                  A dot separated list of vocabulary tags

                                                  "ds_Aggregate_Average.ds_Medium_Air.ds_Variable_Temperature"

                                                    tags_exact
                                                    boolean

                                                    Perform an EXACT match on the given vocabulary tags

                                                    true
                                                    • default value: false
                                                    • valid values: (true,false)

                                                    time_local
                                                    boolean

                                                    Whether the time parameter is in local time

                                                    true
                                                    • default value: false
                                                    • valid values: (true,false)

                                                    _id
                                                    array

                                                    A comma separated list of datastream identifiers

                                                    [ "592f155746a1b867a114e020", "592f155746a1b867a114e021" ]

                                                      source
                                                      array

                                                      A comma separated list of datastream sources (can be combined with attributes_exist and tags)

                                                      [ "edu.berkeley.sensor.ucnrs.legacy.odm", "gov.noaa.nws.ndfd.rest.xml" ]

                                                        lat
                                                        number

                                                        Return datapoints for the given latitude

                                                        37.3382082

                                                          cURL

                                                          curl -X GET "http://api.dendra.science/v1/datapoints/lookup?som_id=imp&uom_id=degree-fahrenheit&_id=592f155746a1b867a114e020,592f155746a1b867a114e021&attributes_exists=false&source=edu.berkeley.sensor.ucnrs.legacy.odm,gov.noaa.nws.ndfd.rest.xml&station_id=592f155746a1b867a114e060,592f155746a1b867a114e061&tags=ds_Aggregate_Average.ds_Medium_Air.ds_Variable_Temperature&tags_exact=true&lat=37.3382082&lon=-121.8863286&time[$op]=2017-05-11T00:00:00Z&time_local=true&$limit=10&$sort[time]=1" \
                                                               -H "Content-Type: application/json"

                                                          Response

                                                          [
                                                            {
                                                              "_id": "592f155746a1b867a114e020",
                                                              "attributes": {
                                                                "height": {
                                                                  "unit_tag": "dt_Unit_Meter",
                                                                  "value": 10
                                                                }
                                                              },
                                                              "source": "edu.berkeley.sensor.ucnrs.legacy.odm",
                                                              "station_id": "592f155746a1b867a114e060",
                                                              "tags": [
                                                                "ds_Aggregate_Average",
                                                                "ds_Medium_Air",
                                                                "ds_Variable_Temperature",
                                                                "dt_Unit_DegreeFahrenheit"
                                                              ],
                                                              "datapoints": [
                                                                {}
                                                              ]
                                                            }
                                                          ]

                                                          Datastream

                                                          A continuous series of datapoints indexed in time order.

                                                          Show properties and constraints defined on the object

                                                          POST
                                                          Create datastream

                                                          Create a new datastream.

                                                          POST datastreams

                                                          Required parameters

                                                          Name /type

                                                          Description /example

                                                          Constraints

                                                          enabled
                                                          boolean

                                                          Whether this datastream is enabled (shown) in any user interface

                                                          true
                                                          • valid values: (true,false)

                                                          name
                                                          string

                                                          "Blue Oak Ranch Avg Air Temp F 10 m"

                                                            Optional parameters

                                                            Name /type

                                                            Description /example

                                                            Constraints

                                                            urls
                                                            array

                                                            A list of URLs for the datastream (e.g. specifications)

                                                            [ { "label": "Wiki", "url": "https://en.wikipedia.org/wiki/Conversion_of_units_of_temperature" } ]

                                                              station_id
                                                              string

                                                              A station that is the source of this datastream

                                                              "592f155746a1b867a114e060"
                                                              • max length: 24
                                                              • pattern: ^[a-fA-F0-9]{24}$

                                                              organization_id
                                                              string

                                                              The organization to which this datastream belongs

                                                              "592f155746a1b867a114e030"
                                                              • max length: 24
                                                              • pattern: ^[a-fA-F0-9]{24}$

                                                              thing_id
                                                              string

                                                              A thing that is the source of this datastream

                                                              "592f155746a1b867a114e070"
                                                              • max length: 24
                                                              • pattern: ^[a-fA-F0-9]{24}$

                                                              preferred_uom_ids
                                                              array

                                                              One or more preferred unit of measurements for display

                                                              [ "degree-fahrenheit" ]
                                                              • min length: 1

                                                              state
                                                              string

                                                              The current functional state of this datastream

                                                              "ready"

                                                                geo
                                                                object

                                                                A GeoJSON point having one position (i.e. longitude, latitude, altitude)

                                                                { "type": "Point", "coordinates": [ -121.73638, 37.381666, 574.548 ] }

                                                                  derivation_description
                                                                  string

                                                                  "Calculated server-side based on the Celsius datastream."

                                                                    external_refs
                                                                    array

                                                                    A list of external or foreign keys associated with this document

                                                                    [ { "identifier": "3090", "type": "odm.datastreams.datastreamid" }, { "identifier": "334", "type": "odm.stations.stationid", "url": "http://sensor.berkeley.edu/index_ucnrs.html" } ]
                                                                    • min length: 1

                                                                    datapoints_config
                                                                    array

                                                                    Service configuration used for fetching datapoints

                                                                    [ { "connection": "legacy", "begins_at": "2017-05-28T09:50:23.106Z", "ends_before": "2017-05-28T09:50:23.106Z", "params": { "query": { "datastream_id": 3090, "time_adjust": -28800 } }, "path": "/datavalues-ucnrs" } ]
                                                                    • min length: 1

                                                                    derived_from_datastream_ids
                                                                    array

                                                                    [ "592f155746a1b867a114e021" ]
                                                                    • min length: 1

                                                                    attributes
                                                                    object

                                                                    Any custom attributes for the datastream

                                                                    { "height": { "unit_tag": "dt_Unit_Meter", "value": 10 } }

                                                                      tags
                                                                      array

                                                                      One or more tags in the format: <schemeId>_<vocabularyLabel>_<termLabel>

                                                                      [ "ds_Aggregate_Average", "ds_Medium_Air", "ds_Variable_Temperature", "dt_Unit_DegreeFahrenheit" ]
                                                                      • min length: 1

                                                                      members
                                                                      array

                                                                      Access control and role assignments

                                                                      [ { "organization_id": "592f155746a1b867a114e030", "roles": [ "contact" ] }, { "person_id": "592f155746a1b867a114e040", "roles": [ "admin", "contact" ] } ]

                                                                        source
                                                                        string

                                                                        "edu.berkeley.sensor.ucnrs.legacy.odm"

                                                                          description
                                                                          string

                                                                          Text describing this document

                                                                          "Blue Oak Ranch average air temperature in degree Fahrenheit at 10 meter height."

                                                                            source_type
                                                                            string

                                                                            The specific type of data producing entity

                                                                            "sensor"
                                                                            • valid values: "sensor", "service", "procedure"

                                                                            cURL

                                                                            curl -X POST "http://api.dendra.science/v1/datastreams" \
                                                                                 -H "Content-Type: application/json" \
                                                                                 --data '{"attributes":{"height":{"unit_tag":"dt_Unit_Meter","value":10}},"datapoints_config":[{"connection":"legacy","begins_at":"2017-05-28T09:50:23.106Z","ends_before":"2017-05-28T09:50:23.106Z","params":{"query":{"datastream_id":3090,"time_adjust":-28800}},"path":"/datavalues-ucnrs"}],"derivation_description":"Calculated server-side based on the Celsius datastream.","derived_from_datastream_ids":["592f155746a1b867a114e021"],"description":"Blue Oak Ranch average air temperature in degree Fahrenheit at 10 meter height.","enabled":true,"external_refs":[{"identifier":"3090","type":"odm.datastreams.datastreamid"},{"identifier":"334","type":"odm.stations.stationid","url":"http://sensor.berkeley.edu/index_ucnrs.html"}],"geo":{"type":"Point","coordinates":[-121.73638,37.381666,574.548]},"members":[{"organization_id":"592f155746a1b867a114e030","roles":["contact"]},{"person_id":"592f155746a1b867a114e040","roles":["admin","contact"]}],"name":"Blue Oak Ranch Avg Air Temp F 10 m","organization_id":"592f155746a1b867a114e030","preferred_uom_ids":["degree-fahrenheit"],"source":"edu.berkeley.sensor.ucnrs.legacy.odm","source_type":"sensor","state":"ready","station_id":"592f155746a1b867a114e060","tags":["ds_Aggregate_Average","ds_Medium_Air","ds_Variable_Temperature","dt_Unit_DegreeFahrenheit"],"thing_id":"592f155746a1b867a114e070","urls":[{"label":"Wiki","url":"https://en.wikipedia.org/wiki/Conversion_of_units_of_temperature"}]}'

                                                                            Response

                                                                            {}

                                                                            PUT
                                                                            Update datastream

                                                                            Update an existing datastream.

                                                                            PUT datastreams/:_id

                                                                            Required parameters

                                                                            Name /type

                                                                            Description /example

                                                                            Constraints

                                                                            enabled
                                                                            boolean

                                                                            Whether this datastream is enabled (shown) in any user interface

                                                                            true
                                                                            • valid values: (true,false)

                                                                            name
                                                                            string

                                                                            "Blue Oak Ranch Avg Air Temp F 10 m"

                                                                              Optional parameters

                                                                              Name /type

                                                                              Description /example

                                                                              Constraints

                                                                              urls
                                                                              array

                                                                              A list of URLs for the datastream (e.g. specifications)

                                                                              [ { "label": "Wiki", "url": "https://en.wikipedia.org/wiki/Conversion_of_units_of_temperature" } ]

                                                                                station_id
                                                                                string

                                                                                A station that is the source of this datastream

                                                                                "592f155746a1b867a114e060"
                                                                                • max length: 24
                                                                                • pattern: ^[a-fA-F0-9]{24}$

                                                                                organization_id
                                                                                string

                                                                                The organization to which this datastream belongs

                                                                                "592f155746a1b867a114e030"
                                                                                • max length: 24
                                                                                • pattern: ^[a-fA-F0-9]{24}$

                                                                                thing_id
                                                                                string

                                                                                A thing that is the source of this datastream

                                                                                "592f155746a1b867a114e070"
                                                                                • max length: 24
                                                                                • pattern: ^[a-fA-F0-9]{24}$

                                                                                preferred_uom_ids
                                                                                array

                                                                                One or more preferred unit of measurements for display

                                                                                [ "degree-fahrenheit" ]
                                                                                • min length: 1

                                                                                state
                                                                                string

                                                                                The current functional state of this datastream

                                                                                "ready"

                                                                                  geo
                                                                                  object

                                                                                  A GeoJSON point having one position (i.e. longitude, latitude, altitude)

                                                                                  { "type": "Point", "coordinates": [ -121.73638, 37.381666, 574.548 ] }

                                                                                    derivation_description
                                                                                    string

                                                                                    "Calculated server-side based on the Celsius datastream."

                                                                                      external_refs
                                                                                      array

                                                                                      A list of external or foreign keys associated with this document

                                                                                      [ { "identifier": "3090", "type": "odm.datastreams.datastreamid" }, { "identifier": "334", "type": "odm.stations.stationid", "url": "http://sensor.berkeley.edu/index_ucnrs.html" } ]
                                                                                      • min length: 1

                                                                                      datapoints_config
                                                                                      array

                                                                                      Service configuration used for fetching datapoints

                                                                                      [ { "connection": "legacy", "begins_at": "2017-05-28T09:50:23.106Z", "ends_before": "2017-05-28T09:50:23.106Z", "params": { "query": { "datastream_id": 3090, "time_adjust": -28800 } }, "path": "/datavalues-ucnrs" } ]
                                                                                      • min length: 1

                                                                                      derived_from_datastream_ids
                                                                                      array

                                                                                      [ "592f155746a1b867a114e021" ]
                                                                                      • min length: 1

                                                                                      attributes
                                                                                      object

                                                                                      Any custom attributes for the datastream

                                                                                      { "height": { "unit_tag": "dt_Unit_Meter", "value": 10 } }

                                                                                        tags
                                                                                        array

                                                                                        One or more tags in the format: <schemeId>_<vocabularyLabel>_<termLabel>

                                                                                        [ "ds_Aggregate_Average", "ds_Medium_Air", "ds_Variable_Temperature", "dt_Unit_DegreeFahrenheit" ]
                                                                                        • min length: 1

                                                                                        members
                                                                                        array

                                                                                        Access control and role assignments

                                                                                        [ { "organization_id": "592f155746a1b867a114e030", "roles": [ "contact" ] }, { "person_id": "592f155746a1b867a114e040", "roles": [ "admin", "contact" ] } ]

                                                                                          source
                                                                                          string

                                                                                          "edu.berkeley.sensor.ucnrs.legacy.odm"

                                                                                            description
                                                                                            string

                                                                                            Text describing this document

                                                                                            "Blue Oak Ranch average air temperature in degree Fahrenheit at 10 meter height."

                                                                                              source_type
                                                                                              string

                                                                                              The specific type of data producing entity

                                                                                              "sensor"
                                                                                              • valid values: "sensor", "service", "procedure"

                                                                                              cURL

                                                                                              curl -X PUT "http://api.dendra.science/v1/datastreams/592f155746a1b867a114e020" \
                                                                                                   -H "Content-Type: application/json" \
                                                                                                   --data '{"attributes":{"height":{"unit_tag":"dt_Unit_Meter","value":10}},"datapoints_config":[{"connection":"legacy","begins_at":"2017-05-28T09:50:23.106Z","ends_before":"2017-05-28T09:50:23.106Z","params":{"query":{"datastream_id":3090,"time_adjust":-28800}},"path":"/datavalues-ucnrs"}],"derivation_description":"Calculated server-side based on the Celsius datastream.","derived_from_datastream_ids":["592f155746a1b867a114e021"],"description":"Blue Oak Ranch average air temperature in degree Fahrenheit at 10 meter height.","enabled":true,"external_refs":[{"identifier":"3090","type":"odm.datastreams.datastreamid"},{"identifier":"334","type":"odm.stations.stationid","url":"http://sensor.berkeley.edu/index_ucnrs.html"}],"geo":{"type":"Point","coordinates":[-121.73638,37.381666,574.548]},"members":[{"organization_id":"592f155746a1b867a114e030","roles":["contact"]},{"person_id":"592f155746a1b867a114e040","roles":["admin","contact"]}],"name":"Blue Oak Ranch Avg Air Temp F 10 m","organization_id":"592f155746a1b867a114e030","preferred_uom_ids":["degree-fahrenheit"],"source":"edu.berkeley.sensor.ucnrs.legacy.odm","source_type":"sensor","state":"ready","station_id":"592f155746a1b867a114e060","tags":["ds_Aggregate_Average","ds_Medium_Air","ds_Variable_Temperature","dt_Unit_DegreeFahrenheit"],"thing_id":"592f155746a1b867a114e070","urls":[{"label":"Wiki","url":"https://en.wikipedia.org/wiki/Conversion_of_units_of_temperature"}]}'

                                                                                              Response

                                                                                              {}

                                                                                              DELETE
                                                                                              Remove datastream

                                                                                              Remove an existing datastream.

                                                                                              DELETE datastreams/:_id

                                                                                              cURL

                                                                                              curl -X DELETE "http://api.dendra.science/v1/datastreams/592f155746a1b867a114e020" \
                                                                                                   -H "Content-Type: application/json"

                                                                                              Response

                                                                                              {}

                                                                                              GET
                                                                                              Datastream info

                                                                                              Return a specific datastream.

                                                                                              GET datastreams/:_id

                                                                                              cURL

                                                                                              curl -X GET "http://api.dendra.science/v1/datastreams/592f155746a1b867a114e020" \
                                                                                                   -H "Content-Type: application/json"

                                                                                              Response

                                                                                              {}

                                                                                              GET
                                                                                              List datastreams

                                                                                              Find one or more datastreams based on the query parameters.

                                                                                              GET datastreams

                                                                                              Optional parameters

                                                                                              Name /type

                                                                                              Description /example

                                                                                              Constraints

                                                                                              field_name

                                                                                              Filter where a field is equal to the supplied value

                                                                                              "field_value"

                                                                                                field_name[$op]

                                                                                                Filter using advanced query operators: $in, $nin, $lt, $lte, $gt, $gte, $ne, and $or

                                                                                                "field_value"

                                                                                                  $limit
                                                                                                  integer

                                                                                                  Specify the maximum number of items to return

                                                                                                  10
                                                                                                  • default value: 20
                                                                                                  • max value:2000

                                                                                                  $skip
                                                                                                  integer

                                                                                                  Specify the number of items to skip over (offset)

                                                                                                  2
                                                                                                  • default value: 0

                                                                                                  $sort[field_name]

                                                                                                  Specify the fields to sort by and the respective sort order

                                                                                                  1
                                                                                                  • valid values: -1, 1

                                                                                                  $select[field_name]

                                                                                                  Pick which fields to include in the results

                                                                                                  1
                                                                                                  • valid values: 1

                                                                                                  cURL

                                                                                                  curl -X GET "http://api.dendra.science/v1/datastreams?field_name=field_value&field_name[$op]=field_value&$limit=10&$skip=2&$sort[field_name]=1&$select[field_name]=1" \
                                                                                                       -H "Content-Type: application/json"

                                                                                                  Response

                                                                                                  {
                                                                                                    "total": 1,
                                                                                                    "limit": 10,
                                                                                                    "skip": 2,
                                                                                                    "data": [
                                                                                                      {}
                                                                                                    ]
                                                                                                  }

                                                                                                  GET
                                                                                                  Lookup datastreams

                                                                                                  Find up to 100 datastreams based on the query parameters (ordered by _id). This endpoint evaluates the _id, source, and station_id parameters in a logical disjunction (OR). The attributes_exist and tags parameters can be added to further restrict datastreams selected by the source and station_id parameters.

                                                                                                  GET datastreams/lookup

                                                                                                  Optional parameters

                                                                                                  Name /type

                                                                                                  Description /example

                                                                                                  Constraints

                                                                                                  som_id
                                                                                                  string

                                                                                                  Do a fuzzy match and return a unique set of datastreams that are already in or could be converted to this system of measurement

                                                                                                  "imp"
                                                                                                  • max length: 50

                                                                                                  _id
                                                                                                  array

                                                                                                  A comma separated list of datastream identifiers

                                                                                                  [ "592f155746a1b867a114e020", "592f155746a1b867a114e021" ]

                                                                                                    attributes_exists
                                                                                                    boolean

                                                                                                    Whether the datastreams have attributes or not

                                                                                                    false
                                                                                                    • valid values: (true,false)

                                                                                                    source
                                                                                                    array

                                                                                                    A comma separated list of datastream sources (can be combined with attributes_exist and tags)

                                                                                                    [ "edu.berkeley.sensor.ucnrs.legacy.odm", "gov.noaa.nws.ndfd.rest.xml" ]

                                                                                                      station_id
                                                                                                      array

                                                                                                      A comma separated list of station identifiers (can be combined with attributes_exist and tags)

                                                                                                      [ "592f155746a1b867a114e060", "592f155746a1b867a114e061" ]

                                                                                                        tags
                                                                                                        string

                                                                                                        A dot separated list of vocabulary tags

                                                                                                        "ds_Aggregate_Average.ds_Medium_Air.ds_Variable_Temperature"

                                                                                                          tags_exact
                                                                                                          boolean

                                                                                                          Perform an EXACT match on the given vocabulary tags

                                                                                                          true
                                                                                                          • default value: false
                                                                                                          • valid values: (true,false)

                                                                                                          cURL

                                                                                                          curl -X GET "http://api.dendra.science/v1/datastreams/lookup?som_id=imp&_id=592f155746a1b867a114e020,592f155746a1b867a114e021&attributes_exists=false&source=edu.berkeley.sensor.ucnrs.legacy.odm,gov.noaa.nws.ndfd.rest.xml&station_id=592f155746a1b867a114e060,592f155746a1b867a114e061&tags=ds_Aggregate_Average.ds_Medium_Air.ds_Variable_Temperature&tags_exact=true" \
                                                                                                               -H "Content-Type: application/json"

                                                                                                          Response

                                                                                                          [
                                                                                                            {}
                                                                                                          ]

                                                                                                          Membership

                                                                                                          An affiliation between a person and an organization.

                                                                                                          Show properties and constraints defined on the object

                                                                                                          POST
                                                                                                          Create membership

                                                                                                          Create a new membership.

                                                                                                          POST memberships

                                                                                                          Optional parameters

                                                                                                          Name /type

                                                                                                          Description /example

                                                                                                          Constraints

                                                                                                          organization_id
                                                                                                          string

                                                                                                          The organization to which a person belongs

                                                                                                          "592f155746a1b867a114e030"
                                                                                                          • max length: 24
                                                                                                          • pattern: ^[a-fA-F0-9]{24}$

                                                                                                          person_id
                                                                                                          string

                                                                                                          The person belonging to the organization

                                                                                                          "592f155746a1b867a114e040"
                                                                                                          • max length: 24
                                                                                                          • pattern: ^[a-fA-F0-9]{24}$

                                                                                                          roles
                                                                                                          array

                                                                                                          The person's roles within this organization (e.g. 'admin', 'contact', 'curator', 'manager')

                                                                                                          [ "contact" ]
                                                                                                          • min length: 1

                                                                                                          cURL

                                                                                                          curl -X POST "http://api.dendra.science/v1/memberships" \
                                                                                                               -H "Content-Type: application/json" \
                                                                                                               --data '{"organization_id":"592f155746a1b867a114e030","person_id":"592f155746a1b867a114e040","roles":["contact"]}'

                                                                                                          Response

                                                                                                          {}

                                                                                                          PUT
                                                                                                          Update membership

                                                                                                          Update an existing membership.

                                                                                                          PUT memberships/:_id

                                                                                                          Optional parameters

                                                                                                          Name /type

                                                                                                          Description /example

                                                                                                          Constraints

                                                                                                          roles
                                                                                                          array

                                                                                                          The person's roles within this organization (e.g. 'admin', 'contact', 'curator', 'manager')

                                                                                                          [ "contact" ]
                                                                                                          • min length: 1

                                                                                                          cURL

                                                                                                          curl -X PUT "http://api.dendra.science/v1/memberships/592f155746a1b867a114e080" \
                                                                                                               -H "Content-Type: application/json" \
                                                                                                               --data '{"roles":["contact"]}'

                                                                                                          Response

                                                                                                          {}

                                                                                                          DELETE
                                                                                                          Remove membership

                                                                                                          Remove an existing membership.

                                                                                                          DELETE memberships/:_id

                                                                                                          cURL

                                                                                                          curl -X DELETE "http://api.dendra.science/v1/memberships/592f155746a1b867a114e080" \
                                                                                                               -H "Content-Type: application/json"

                                                                                                          Response

                                                                                                          {}

                                                                                                          GET
                                                                                                          Membership info

                                                                                                          Return a specific membership.

                                                                                                          GET memberships/:_id

                                                                                                          cURL

                                                                                                          curl -X GET "http://api.dendra.science/v1/memberships/592f155746a1b867a114e080" \
                                                                                                               -H "Content-Type: application/json"

                                                                                                          Response

                                                                                                          {}

                                                                                                          GET
                                                                                                          List memberships

                                                                                                          Find one or more memberships based on the query parameters.

                                                                                                          GET memberships

                                                                                                          Optional parameters

                                                                                                          Name /type

                                                                                                          Description /example

                                                                                                          Constraints

                                                                                                          field_name

                                                                                                          Filter where a field is equal to the supplied value

                                                                                                          "field_value"

                                                                                                            field_name[$op]

                                                                                                            Filter using advanced query operators: $in, $nin, $lt, $lte, $gt, $gte, $ne, and $or

                                                                                                            "field_value"

                                                                                                              $limit
                                                                                                              integer

                                                                                                              Specify the maximum number of items to return

                                                                                                              10
                                                                                                              • default value: 20
                                                                                                              • max value:2000

                                                                                                              $skip
                                                                                                              integer

                                                                                                              Specify the number of items to skip over (offset)

                                                                                                              2
                                                                                                              • default value: 0

                                                                                                              $sort[field_name]

                                                                                                              Specify the fields to sort by and the respective sort order

                                                                                                              1
                                                                                                              • valid values: -1, 1

                                                                                                              $select[field_name]

                                                                                                              Pick which fields to include in the results

                                                                                                              1
                                                                                                              • valid values: 1

                                                                                                              cURL

                                                                                                              curl -X GET "http://api.dendra.science/v1/memberships?field_name=field_value&field_name[$op]=field_value&$limit=10&$skip=2&$sort[field_name]=1&$select[field_name]=1" \
                                                                                                                   -H "Content-Type: application/json"

                                                                                                              Response

                                                                                                              {
                                                                                                                "total": 1,
                                                                                                                "limit": 10,
                                                                                                                "skip": 2,
                                                                                                                "data": [
                                                                                                                  {}
                                                                                                                ]
                                                                                                              }

                                                                                                              Organization

                                                                                                              An association, group, or research organization.

                                                                                                              Show properties and constraints defined on the object

                                                                                                              POST
                                                                                                              Create organization

                                                                                                              Create a new organization.

                                                                                                              POST organizations

                                                                                                              Optional parameters

                                                                                                              Name /type

                                                                                                              Description /example

                                                                                                              Constraints

                                                                                                              description
                                                                                                              string

                                                                                                              Text describing this document

                                                                                                              "The UC Natural Reserve System is a network of protected natural areas throughout California used for monitoring, education, and research. As part of a climate change monitoring grant, each reserve has a weather station on site."

                                                                                                                email
                                                                                                                string

                                                                                                                The primary contact email address

                                                                                                                "infomgr@ucnrs.org"

                                                                                                                  full_name
                                                                                                                  string

                                                                                                                  "University of California Natural Reserve System"

                                                                                                                    name
                                                                                                                    string

                                                                                                                    "UC Natural Reserve System"

                                                                                                                      slug
                                                                                                                      string

                                                                                                                      A human-readable and URL-friendly name used to retrieve this document's page or resource

                                                                                                                      "ucnrs"
                                                                                                                      • pattern: ^[a-z0-9-]+$

                                                                                                                      url
                                                                                                                      string (uri)

                                                                                                                      "http://www.ucnrs.org"

                                                                                                                        cURL

                                                                                                                        curl -X POST "http://api.dendra.science/v1/organizations" \
                                                                                                                             -H "Content-Type: application/json" \
                                                                                                                             --data '{"description":"The UC Natural Reserve System is a network of protected natural areas throughout California used for monitoring, education, and research. As part of a climate change monitoring grant, each reserve has a weather station on site.","email":"infomgr@ucnrs.org","full_name":"University of California Natural Reserve System","name":"UC Natural Reserve System","slug":"ucnrs","url":"http://www.ucnrs.org"}'

                                                                                                                        Response

                                                                                                                        {}

                                                                                                                        PUT
                                                                                                                        Update organization

                                                                                                                        Update an existing organization.

                                                                                                                        PUT organizations/:_id

                                                                                                                        Optional parameters

                                                                                                                        Name /type

                                                                                                                        Description /example

                                                                                                                        Constraints

                                                                                                                        description
                                                                                                                        string

                                                                                                                        Text describing this document

                                                                                                                        "The UC Natural Reserve System is a network of protected natural areas throughout California used for monitoring, education, and research. As part of a climate change monitoring grant, each reserve has a weather station on site."

                                                                                                                          email
                                                                                                                          string

                                                                                                                          The primary contact email address

                                                                                                                          "infomgr@ucnrs.org"

                                                                                                                            full_name
                                                                                                                            string

                                                                                                                            "University of California Natural Reserve System"

                                                                                                                              name
                                                                                                                              string

                                                                                                                              "UC Natural Reserve System"

                                                                                                                                slug
                                                                                                                                string

                                                                                                                                A human-readable and URL-friendly name used to retrieve this document's page or resource

                                                                                                                                "ucnrs"
                                                                                                                                • pattern: ^[a-z0-9-]+$

                                                                                                                                url
                                                                                                                                string (uri)

                                                                                                                                "http://www.ucnrs.org"

                                                                                                                                  cURL

                                                                                                                                  curl -X PUT "http://api.dendra.science/v1/organizations/592f155746a1b867a114e030" \
                                                                                                                                       -H "Content-Type: application/json" \
                                                                                                                                       --data '{"description":"The UC Natural Reserve System is a network of protected natural areas throughout California used for monitoring, education, and research. As part of a climate change monitoring grant, each reserve has a weather station on site.","email":"infomgr@ucnrs.org","full_name":"University of California Natural Reserve System","name":"UC Natural Reserve System","slug":"ucnrs","url":"http://www.ucnrs.org"}'

                                                                                                                                  Response

                                                                                                                                  {}

                                                                                                                                  DELETE
                                                                                                                                  Remove organization

                                                                                                                                  Remove an existing organization.

                                                                                                                                  DELETE organizations/:_id

                                                                                                                                  cURL

                                                                                                                                  curl -X DELETE "http://api.dendra.science/v1/organizations/592f155746a1b867a114e030" \
                                                                                                                                       -H "Content-Type: application/json"

                                                                                                                                  Response

                                                                                                                                  {}

                                                                                                                                  GET
                                                                                                                                  Organization info

                                                                                                                                  Return a specific organization.

                                                                                                                                  GET organizations/:_id

                                                                                                                                  cURL

                                                                                                                                  curl -X GET "http://api.dendra.science/v1/organizations/592f155746a1b867a114e030" \
                                                                                                                                       -H "Content-Type: application/json"

                                                                                                                                  Response

                                                                                                                                  {}

                                                                                                                                  GET
                                                                                                                                  List organizations

                                                                                                                                  Find one or more organizations based on the query parameters.

                                                                                                                                  GET organizations

                                                                                                                                  Optional parameters

                                                                                                                                  Name /type

                                                                                                                                  Description /example

                                                                                                                                  Constraints

                                                                                                                                  field_name

                                                                                                                                  Filter where a field is equal to the supplied value

                                                                                                                                  "field_value"

                                                                                                                                    field_name[$op]

                                                                                                                                    Filter using advanced query operators: $in, $nin, $lt, $lte, $gt, $gte, $ne, and $or

                                                                                                                                    "field_value"

                                                                                                                                      $limit
                                                                                                                                      integer

                                                                                                                                      Specify the maximum number of items to return

                                                                                                                                      10
                                                                                                                                      • default value: 20
                                                                                                                                      • max value:2000

                                                                                                                                      $skip
                                                                                                                                      integer

                                                                                                                                      Specify the number of items to skip over (offset)

                                                                                                                                      2
                                                                                                                                      • default value: 0

                                                                                                                                      $sort[field_name]

                                                                                                                                      Specify the fields to sort by and the respective sort order

                                                                                                                                      1
                                                                                                                                      • valid values: -1, 1

                                                                                                                                      $select[field_name]

                                                                                                                                      Pick which fields to include in the results

                                                                                                                                      1
                                                                                                                                      • valid values: 1

                                                                                                                                      cURL

                                                                                                                                      curl -X GET "http://api.dendra.science/v1/organizations?field_name=field_value&field_name[$op]=field_value&$limit=10&$skip=2&$sort[field_name]=1&$select[field_name]=1" \
                                                                                                                                           -H "Content-Type: application/json"

                                                                                                                                      Response

                                                                                                                                      {
                                                                                                                                        "total": 1,
                                                                                                                                        "limit": 10,
                                                                                                                                        "skip": 2,
                                                                                                                                        "data": [
                                                                                                                                          {}
                                                                                                                                        ]
                                                                                                                                      }

                                                                                                                                      Person

                                                                                                                                      A data consumer, responsible party, or user of the system.

                                                                                                                                      Show properties and constraints defined on the object

                                                                                                                                      POST
                                                                                                                                      Create person

                                                                                                                                      Create a new person.

                                                                                                                                      POST persons

                                                                                                                                      Optional parameters

                                                                                                                                      Name /type

                                                                                                                                      Description /example

                                                                                                                                      Constraints

                                                                                                                                      email
                                                                                                                                      string

                                                                                                                                      The primary contact email address

                                                                                                                                      "collin@berkeley.edu"

                                                                                                                                        full_name
                                                                                                                                        string

                                                                                                                                        "Collin Bode"

                                                                                                                                          name
                                                                                                                                          string

                                                                                                                                          "Collin"

                                                                                                                                            cURL

                                                                                                                                            curl -X POST "http://api.dendra.science/v1/persons" \
                                                                                                                                                 -H "Content-Type: application/json" \
                                                                                                                                                 --data '{"email":"collin@berkeley.edu","full_name":"Collin Bode","name":"Collin"}'

                                                                                                                                            Response

                                                                                                                                            {}

                                                                                                                                            PUT
                                                                                                                                            Update person

                                                                                                                                            Update an existing person.

                                                                                                                                            PUT persons/:_id

                                                                                                                                            Optional parameters

                                                                                                                                            Name /type

                                                                                                                                            Description /example

                                                                                                                                            Constraints

                                                                                                                                            email
                                                                                                                                            string

                                                                                                                                            The primary contact email address

                                                                                                                                            "collin@berkeley.edu"

                                                                                                                                              full_name
                                                                                                                                              string

                                                                                                                                              "Collin Bode"

                                                                                                                                                name
                                                                                                                                                string

                                                                                                                                                "Collin"

                                                                                                                                                  cURL

                                                                                                                                                  curl -X PUT "http://api.dendra.science/v1/persons/592f155746a1b867a114e040" \
                                                                                                                                                       -H "Content-Type: application/json" \
                                                                                                                                                       --data '{"email":"collin@berkeley.edu","full_name":"Collin Bode","name":"Collin"}'

                                                                                                                                                  Response

                                                                                                                                                  {}

                                                                                                                                                  DELETE
                                                                                                                                                  Remove person

                                                                                                                                                  Remove an existing person.

                                                                                                                                                  DELETE persons/:_id

                                                                                                                                                  cURL

                                                                                                                                                  curl -X DELETE "http://api.dendra.science/v1/persons/592f155746a1b867a114e040" \
                                                                                                                                                       -H "Content-Type: application/json"

                                                                                                                                                  Response

                                                                                                                                                  {}

                                                                                                                                                  GET
                                                                                                                                                  Person info

                                                                                                                                                  Return a specific person.

                                                                                                                                                  GET persons/:_id

                                                                                                                                                  cURL

                                                                                                                                                  curl -X GET "http://api.dendra.science/v1/persons/592f155746a1b867a114e040" \
                                                                                                                                                       -H "Content-Type: application/json"

                                                                                                                                                  Response

                                                                                                                                                  {}

                                                                                                                                                  GET
                                                                                                                                                  List persons

                                                                                                                                                  Find one or more persons based on the query parameters.

                                                                                                                                                  GET persons

                                                                                                                                                  Optional parameters

                                                                                                                                                  Name /type

                                                                                                                                                  Description /example

                                                                                                                                                  Constraints

                                                                                                                                                  field_name

                                                                                                                                                  Filter where a field is equal to the supplied value

                                                                                                                                                  "field_value"

                                                                                                                                                    field_name[$op]

                                                                                                                                                    Filter using advanced query operators: $in, $nin, $lt, $lte, $gt, $gte, $ne, and $or

                                                                                                                                                    "field_value"

                                                                                                                                                      $limit
                                                                                                                                                      integer

                                                                                                                                                      Specify the maximum number of items to return

                                                                                                                                                      10
                                                                                                                                                      • default value: 20
                                                                                                                                                      • max value:2000

                                                                                                                                                      $skip
                                                                                                                                                      integer

                                                                                                                                                      Specify the number of items to skip over (offset)

                                                                                                                                                      2
                                                                                                                                                      • default value: 0

                                                                                                                                                      $sort[field_name]

                                                                                                                                                      Specify the fields to sort by and the respective sort order

                                                                                                                                                      1
                                                                                                                                                      • valid values: -1, 1

                                                                                                                                                      $select[field_name]

                                                                                                                                                      Pick which fields to include in the results

                                                                                                                                                      1
                                                                                                                                                      • valid values: 1

                                                                                                                                                      cURL

                                                                                                                                                      curl -X GET "http://api.dendra.science/v1/persons?field_name=field_value&field_name[$op]=field_value&$limit=10&$skip=2&$sort[field_name]=1&$select[field_name]=1" \
                                                                                                                                                           -H "Content-Type: application/json"

                                                                                                                                                      Response

                                                                                                                                                      {
                                                                                                                                                        "total": 1,
                                                                                                                                                        "limit": 10,
                                                                                                                                                        "skip": 2,
                                                                                                                                                        "data": [
                                                                                                                                                          {}
                                                                                                                                                        ]
                                                                                                                                                      }

                                                                                                                                                      Place

                                                                                                                                                      A specific, named location with corresponding geo coordinates.

                                                                                                                                                      Show properties and constraints defined on the object

                                                                                                                                                      POST
                                                                                                                                                      Create place

                                                                                                                                                      Create a new place.

                                                                                                                                                      POST places

                                                                                                                                                      Optional parameters

                                                                                                                                                      Name /type

                                                                                                                                                      Description /example

                                                                                                                                                      Constraints

                                                                                                                                                      name
                                                                                                                                                      string

                                                                                                                                                      "San Jose"

                                                                                                                                                        abbreviation
                                                                                                                                                        string

                                                                                                                                                        "SJ"

                                                                                                                                                          url
                                                                                                                                                          string (uri)

                                                                                                                                                          "http://www.sanjoseca.gov"

                                                                                                                                                            geo

                                                                                                                                                            { "type": "Point", "coordinates": [ -121.73638, 37.381666, 574.548 ] }
                                                                                                                                                            One of the following:
                                                                                                                                                            A GeoJSON point having one position (i.e. longitude, latitude, altitude)
                                                                                                                                                            A GeoJSON polygon (i.e. an array of linear rings)
                                                                                                                                                            An GeoJSON multi-polygon (i.e. an array of linear ring arrays)

                                                                                                                                                              place_type
                                                                                                                                                              string

                                                                                                                                                              The specific type of place (e.g. 'city', 'county', 'region')

                                                                                                                                                              "city"

                                                                                                                                                                external_refs
                                                                                                                                                                array

                                                                                                                                                                A list of external or foreign keys associated with this document

                                                                                                                                                                [ { "identifier": "ChIJ9T_5iuTKj4ARe3GfygqMnbk", "type": "com.google.placeid", "url": "https://www.google.com/maps/@37.3382082,-121.8863286,19z" } ]
                                                                                                                                                                • min length: 1

                                                                                                                                                                country_code
                                                                                                                                                                string

                                                                                                                                                                An ISO 3166-1 alpha-3 country code

                                                                                                                                                                "USA"

                                                                                                                                                                  attributes
                                                                                                                                                                  object

                                                                                                                                                                  Any custom attributes for the place

                                                                                                                                                                  { "city": "San Jose", "state": "California", "state_abbreviation": "CA" }

                                                                                                                                                                    full_name
                                                                                                                                                                    string

                                                                                                                                                                    "San Jose, California, USA"

                                                                                                                                                                      cURL

                                                                                                                                                                      curl -X POST "http://api.dendra.science/v1/places" \
                                                                                                                                                                           -H "Content-Type: application/json" \
                                                                                                                                                                           --data '{"abbreviation":"SJ","attributes":{"city":"San Jose","state":"California","state_abbreviation":"CA"},"country_code":"USA","external_refs":[{"identifier":"ChIJ9T_5iuTKj4ARe3GfygqMnbk","type":"com.google.placeid","url":"https://www.google.com/maps/@37.3382082,-121.8863286,19z"}],"full_name":"San Jose, California, USA","geo":{"type":"Point","coordinates":[-121.73638,37.381666,574.548]},"name":"San Jose","place_type":"city","url":"http://www.sanjoseca.gov"}'

                                                                                                                                                                      Response

                                                                                                                                                                      {}

                                                                                                                                                                      PUT
                                                                                                                                                                      Update place

                                                                                                                                                                      Update an existing place.

                                                                                                                                                                      PUT places/:_id

                                                                                                                                                                      Optional parameters

                                                                                                                                                                      Name /type

                                                                                                                                                                      Description /example

                                                                                                                                                                      Constraints

                                                                                                                                                                      name
                                                                                                                                                                      string

                                                                                                                                                                      "San Jose"

                                                                                                                                                                        abbreviation
                                                                                                                                                                        string

                                                                                                                                                                        "SJ"

                                                                                                                                                                          url
                                                                                                                                                                          string (uri)

                                                                                                                                                                          "http://www.sanjoseca.gov"

                                                                                                                                                                            geo

                                                                                                                                                                            { "type": "Point", "coordinates": [ -121.73638, 37.381666, 574.548 ] }
                                                                                                                                                                            One of the following:
                                                                                                                                                                            A GeoJSON point having one position (i.e. longitude, latitude, altitude)
                                                                                                                                                                            A GeoJSON polygon (i.e. an array of linear rings)
                                                                                                                                                                            An GeoJSON multi-polygon (i.e. an array of linear ring arrays)

                                                                                                                                                                              place_type
                                                                                                                                                                              string

                                                                                                                                                                              The specific type of place (e.g. 'city', 'county', 'region')

                                                                                                                                                                              "city"

                                                                                                                                                                                external_refs
                                                                                                                                                                                array

                                                                                                                                                                                A list of external or foreign keys associated with this document

                                                                                                                                                                                [ { "identifier": "ChIJ9T_5iuTKj4ARe3GfygqMnbk", "type": "com.google.placeid", "url": "https://www.google.com/maps/@37.3382082,-121.8863286,19z" } ]
                                                                                                                                                                                • min length: 1

                                                                                                                                                                                country_code
                                                                                                                                                                                string

                                                                                                                                                                                An ISO 3166-1 alpha-3 country code

                                                                                                                                                                                "USA"

                                                                                                                                                                                  attributes
                                                                                                                                                                                  object

                                                                                                                                                                                  Any custom attributes for the place

                                                                                                                                                                                  { "city": "San Jose", "state": "California", "state_abbreviation": "CA" }

                                                                                                                                                                                    full_name
                                                                                                                                                                                    string

                                                                                                                                                                                    "San Jose, California, USA"

                                                                                                                                                                                      cURL

                                                                                                                                                                                      curl -X PUT "http://api.dendra.science/v1/places/592f155746a1b867a114e050" \
                                                                                                                                                                                           -H "Content-Type: application/json" \
                                                                                                                                                                                           --data '{"abbreviation":"SJ","attributes":{"city":"San Jose","state":"California","state_abbreviation":"CA"},"country_code":"USA","external_refs":[{"identifier":"ChIJ9T_5iuTKj4ARe3GfygqMnbk","type":"com.google.placeid","url":"https://www.google.com/maps/@37.3382082,-121.8863286,19z"}],"full_name":"San Jose, California, USA","geo":{"type":"Point","coordinates":[-121.73638,37.381666,574.548]},"name":"San Jose","place_type":"city","url":"http://www.sanjoseca.gov"}'

                                                                                                                                                                                      Response

                                                                                                                                                                                      {}

                                                                                                                                                                                      DELETE
                                                                                                                                                                                      Remove place

                                                                                                                                                                                      Remove an existing place.

                                                                                                                                                                                      DELETE places/:_id

                                                                                                                                                                                      cURL

                                                                                                                                                                                      curl -X DELETE "http://api.dendra.science/v1/places/592f155746a1b867a114e050" \
                                                                                                                                                                                           -H "Content-Type: application/json"

                                                                                                                                                                                      Response

                                                                                                                                                                                      {}

                                                                                                                                                                                      GET
                                                                                                                                                                                      Place info

                                                                                                                                                                                      Return a specific place.

                                                                                                                                                                                      GET places/:_id

                                                                                                                                                                                      cURL

                                                                                                                                                                                      curl -X GET "http://api.dendra.science/v1/places/592f155746a1b867a114e050" \
                                                                                                                                                                                           -H "Content-Type: application/json"

                                                                                                                                                                                      Response

                                                                                                                                                                                      {}

                                                                                                                                                                                      GET
                                                                                                                                                                                      List places

                                                                                                                                                                                      Find one or more places based on the query parameters.

                                                                                                                                                                                      GET places

                                                                                                                                                                                      Optional parameters

                                                                                                                                                                                      Name /type

                                                                                                                                                                                      Description /example

                                                                                                                                                                                      Constraints

                                                                                                                                                                                      field_name

                                                                                                                                                                                      Filter where a field is equal to the supplied value

                                                                                                                                                                                      "field_value"

                                                                                                                                                                                        field_name[$op]

                                                                                                                                                                                        Filter using advanced query operators: $in, $nin, $lt, $lte, $gt, $gte, $ne, and $or

                                                                                                                                                                                        "field_value"

                                                                                                                                                                                          $limit
                                                                                                                                                                                          integer

                                                                                                                                                                                          Specify the maximum number of items to return

                                                                                                                                                                                          10
                                                                                                                                                                                          • default value: 20
                                                                                                                                                                                          • max value:2000

                                                                                                                                                                                          $skip
                                                                                                                                                                                          integer

                                                                                                                                                                                          Specify the number of items to skip over (offset)

                                                                                                                                                                                          2
                                                                                                                                                                                          • default value: 0

                                                                                                                                                                                          $sort[field_name]

                                                                                                                                                                                          Specify the fields to sort by and the respective sort order

                                                                                                                                                                                          1
                                                                                                                                                                                          • valid values: -1, 1

                                                                                                                                                                                          $select[field_name]

                                                                                                                                                                                          Pick which fields to include in the results

                                                                                                                                                                                          1
                                                                                                                                                                                          • valid values: 1

                                                                                                                                                                                          cURL

                                                                                                                                                                                          curl -X GET "http://api.dendra.science/v1/places?field_name=field_value&field_name[$op]=field_value&$limit=10&$skip=2&$sort[field_name]=1&$select[field_name]=1" \
                                                                                                                                                                                               -H "Content-Type: application/json"

                                                                                                                                                                                          Response

                                                                                                                                                                                          {
                                                                                                                                                                                            "total": 1,
                                                                                                                                                                                            "limit": 10,
                                                                                                                                                                                            "skip": 2,
                                                                                                                                                                                            "data": [
                                                                                                                                                                                              {}
                                                                                                                                                                                            ]
                                                                                                                                                                                          }

                                                                                                                                                                                          Scheme

                                                                                                                                                                                          A namespace (scheme) for one or more controlled vocabularies.

                                                                                                                                                                                          Show properties and constraints defined on the object

                                                                                                                                                                                          POST
                                                                                                                                                                                          Create scheme

                                                                                                                                                                                          Create a new scheme.

                                                                                                                                                                                          POST schemes

                                                                                                                                                                                          Optional parameters

                                                                                                                                                                                          Name /type

                                                                                                                                                                                          Description /example

                                                                                                                                                                                          Constraints

                                                                                                                                                                                          _id
                                                                                                                                                                                          string

                                                                                                                                                                                          The unique document identifier

                                                                                                                                                                                          "ds"
                                                                                                                                                                                          • max length: 50

                                                                                                                                                                                          description
                                                                                                                                                                                          string

                                                                                                                                                                                          Text describing this document

                                                                                                                                                                                          "A collection of controlled vocabularies for internal use in the Dendro system."

                                                                                                                                                                                            name
                                                                                                                                                                                            string

                                                                                                                                                                                            "Dendra System Controlled Vocabularies"

                                                                                                                                                                                              priority
                                                                                                                                                                                              integer

                                                                                                                                                                                              The importance level when evaluating tagged entities

                                                                                                                                                                                              1
                                                                                                                                                                                              • min value:1
                                                                                                                                                                                              • max value:10

                                                                                                                                                                                              url
                                                                                                                                                                                              string (uri)

                                                                                                                                                                                              "http://docs.dendra.science"

                                                                                                                                                                                                version
                                                                                                                                                                                                string

                                                                                                                                                                                                "1.0"

                                                                                                                                                                                                  cURL

                                                                                                                                                                                                  curl -X POST "http://api.dendra.science/v1/schemes" \
                                                                                                                                                                                                       -H "Content-Type: application/json" \
                                                                                                                                                                                                       --data '{"_id":"ds","description":"A collection of controlled vocabularies for internal use in the Dendro system.","name":"Dendra System Controlled Vocabularies","priority":1,"url":"http://docs.dendra.science","version":"1.0"}'

                                                                                                                                                                                                  Response

                                                                                                                                                                                                  {}

                                                                                                                                                                                                  PUT
                                                                                                                                                                                                  Update scheme

                                                                                                                                                                                                  Update an existing scheme.

                                                                                                                                                                                                  PUT schemes/:_id

                                                                                                                                                                                                  Optional parameters

                                                                                                                                                                                                  Name /type

                                                                                                                                                                                                  Description /example

                                                                                                                                                                                                  Constraints

                                                                                                                                                                                                  description
                                                                                                                                                                                                  string

                                                                                                                                                                                                  Text describing this document

                                                                                                                                                                                                  "A collection of controlled vocabularies for internal use in the Dendro system."

                                                                                                                                                                                                    name
                                                                                                                                                                                                    string

                                                                                                                                                                                                    "Dendra System Controlled Vocabularies"

                                                                                                                                                                                                      priority
                                                                                                                                                                                                      integer

                                                                                                                                                                                                      The importance level when evaluating tagged entities

                                                                                                                                                                                                      1
                                                                                                                                                                                                      • min value:1
                                                                                                                                                                                                      • max value:10

                                                                                                                                                                                                      url
                                                                                                                                                                                                      string (uri)

                                                                                                                                                                                                      "http://docs.dendra.science"

                                                                                                                                                                                                        version
                                                                                                                                                                                                        string

                                                                                                                                                                                                        "1.0"

                                                                                                                                                                                                          cURL

                                                                                                                                                                                                          curl -X PUT "http://api.dendra.science/v1/schemes/ds" \
                                                                                                                                                                                                               -H "Content-Type: application/json" \
                                                                                                                                                                                                               --data '{"description":"A collection of controlled vocabularies for internal use in the Dendro system.","name":"Dendra System Controlled Vocabularies","priority":1,"url":"http://docs.dendra.science","version":"1.0"}'

                                                                                                                                                                                                          Response

                                                                                                                                                                                                          {}

                                                                                                                                                                                                          DELETE
                                                                                                                                                                                                          Remove scheme

                                                                                                                                                                                                          Remove an existing scheme.

                                                                                                                                                                                                          DELETE schemes/:_id

                                                                                                                                                                                                          cURL

                                                                                                                                                                                                          curl -X DELETE "http://api.dendra.science/v1/schemes/ds" \
                                                                                                                                                                                                               -H "Content-Type: application/json"

                                                                                                                                                                                                          Response

                                                                                                                                                                                                          {}

                                                                                                                                                                                                          GET
                                                                                                                                                                                                          Scheme info

                                                                                                                                                                                                          Return a specific scheme.

                                                                                                                                                                                                          GET schemes/:_id

                                                                                                                                                                                                          cURL

                                                                                                                                                                                                          curl -X GET "http://api.dendra.science/v1/schemes/ds" \
                                                                                                                                                                                                               -H "Content-Type: application/json"

                                                                                                                                                                                                          Response

                                                                                                                                                                                                          {}

                                                                                                                                                                                                          GET
                                                                                                                                                                                                          List schemes

                                                                                                                                                                                                          Find one or more schemes based on the query parameters.

                                                                                                                                                                                                          GET schemes

                                                                                                                                                                                                          Optional parameters

                                                                                                                                                                                                          Name /type

                                                                                                                                                                                                          Description /example

                                                                                                                                                                                                          Constraints

                                                                                                                                                                                                          field_name

                                                                                                                                                                                                          Filter where a field is equal to the supplied value

                                                                                                                                                                                                          "field_value"

                                                                                                                                                                                                            field_name[$op]

                                                                                                                                                                                                            Filter using advanced query operators: $in, $nin, $lt, $lte, $gt, $gte, $ne, and $or

                                                                                                                                                                                                            "field_value"

                                                                                                                                                                                                              $limit
                                                                                                                                                                                                              integer

                                                                                                                                                                                                              Specify the maximum number of items to return

                                                                                                                                                                                                              10
                                                                                                                                                                                                              • default value: 20
                                                                                                                                                                                                              • max value:2000

                                                                                                                                                                                                              $skip
                                                                                                                                                                                                              integer

                                                                                                                                                                                                              Specify the number of items to skip over (offset)

                                                                                                                                                                                                              2
                                                                                                                                                                                                              • default value: 0

                                                                                                                                                                                                              $sort[field_name]

                                                                                                                                                                                                              Specify the fields to sort by and the respective sort order

                                                                                                                                                                                                              1
                                                                                                                                                                                                              • valid values: -1, 1

                                                                                                                                                                                                              $select[field_name]

                                                                                                                                                                                                              Pick which fields to include in the results

                                                                                                                                                                                                              1
                                                                                                                                                                                                              • valid values: 1

                                                                                                                                                                                                              cURL

                                                                                                                                                                                                              curl -X GET "http://api.dendra.science/v1/schemes?field_name=field_value&field_name[$op]=field_value&$limit=10&$skip=2&$sort[field_name]=1&$select[field_name]=1" \
                                                                                                                                                                                                                   -H "Content-Type: application/json"

                                                                                                                                                                                                              Response

                                                                                                                                                                                                              {
                                                                                                                                                                                                                "total": 1,
                                                                                                                                                                                                                "limit": 10,
                                                                                                                                                                                                                "skip": 2,
                                                                                                                                                                                                                "data": [
                                                                                                                                                                                                                  {}
                                                                                                                                                                                                                ]
                                                                                                                                                                                                              }

                                                                                                                                                                                                              System of Measurement

                                                                                                                                                                                                              A collection of units of measurement.

                                                                                                                                                                                                              Show properties and constraints defined on the object

                                                                                                                                                                                                              POST
                                                                                                                                                                                                              Create SOM

                                                                                                                                                                                                              Create a new system of measurement.

                                                                                                                                                                                                              POST soms

                                                                                                                                                                                                              Optional parameters

                                                                                                                                                                                                              Name /type

                                                                                                                                                                                                              Description /example

                                                                                                                                                                                                              Constraints

                                                                                                                                                                                                              _id
                                                                                                                                                                                                              string

                                                                                                                                                                                                              The unique document identifier

                                                                                                                                                                                                              "imp"
                                                                                                                                                                                                              • max length: 50

                                                                                                                                                                                                              fallback_som_ids
                                                                                                                                                                                                              array

                                                                                                                                                                                                              The order of precedence for selecting another system when this SOM is unavailable

                                                                                                                                                                                                              [ "met" ]
                                                                                                                                                                                                              • min length: 1

                                                                                                                                                                                                              name
                                                                                                                                                                                                              string

                                                                                                                                                                                                              "English"

                                                                                                                                                                                                                cURL

                                                                                                                                                                                                                curl -X POST "http://api.dendra.science/v1/soms" \
                                                                                                                                                                                                                     -H "Content-Type: application/json" \
                                                                                                                                                                                                                     --data '{"_id":"imp","fallback_som_ids":["met"],"name":"English"}'

                                                                                                                                                                                                                Response

                                                                                                                                                                                                                {}

                                                                                                                                                                                                                PUT
                                                                                                                                                                                                                Update SOM

                                                                                                                                                                                                                Update an existing system of measurement.

                                                                                                                                                                                                                PUT soms/:_id

                                                                                                                                                                                                                Optional parameters

                                                                                                                                                                                                                Name /type

                                                                                                                                                                                                                Description /example

                                                                                                                                                                                                                Constraints

                                                                                                                                                                                                                name
                                                                                                                                                                                                                string

                                                                                                                                                                                                                "English"

                                                                                                                                                                                                                  fallback_som_ids
                                                                                                                                                                                                                  array

                                                                                                                                                                                                                  The order of precedence for selecting another system when this SOM is unavailable

                                                                                                                                                                                                                  [ "met" ]
                                                                                                                                                                                                                  • min length: 1

                                                                                                                                                                                                                  cURL

                                                                                                                                                                                                                  curl -X PUT "http://api.dendra.science/v1/soms/imp" \
                                                                                                                                                                                                                       -H "Content-Type: application/json" \
                                                                                                                                                                                                                       --data '{"name":"English","fallback_som_ids":["met"]}'

                                                                                                                                                                                                                  Response

                                                                                                                                                                                                                  {}

                                                                                                                                                                                                                  DELETE
                                                                                                                                                                                                                  Remove SOM

                                                                                                                                                                                                                  Remove an existing system of measurement.

                                                                                                                                                                                                                  DELETE soms/:_id

                                                                                                                                                                                                                  cURL

                                                                                                                                                                                                                  curl -X DELETE "http://api.dendra.science/v1/soms/imp" \
                                                                                                                                                                                                                       -H "Content-Type: application/json"

                                                                                                                                                                                                                  Response

                                                                                                                                                                                                                  {}

                                                                                                                                                                                                                  GET
                                                                                                                                                                                                                  SOM info

                                                                                                                                                                                                                  Return a specific system of measurement.

                                                                                                                                                                                                                  GET soms/:_id

                                                                                                                                                                                                                  cURL

                                                                                                                                                                                                                  curl -X GET "http://api.dendra.science/v1/soms/imp" \
                                                                                                                                                                                                                       -H "Content-Type: application/json"

                                                                                                                                                                                                                  Response

                                                                                                                                                                                                                  {}

                                                                                                                                                                                                                  GET
                                                                                                                                                                                                                  List SOMs

                                                                                                                                                                                                                  Find one or more systems of measurement based on the query parameters.

                                                                                                                                                                                                                  GET soms

                                                                                                                                                                                                                  Optional parameters

                                                                                                                                                                                                                  Name /type

                                                                                                                                                                                                                  Description /example

                                                                                                                                                                                                                  Constraints

                                                                                                                                                                                                                  field_name

                                                                                                                                                                                                                  Filter where a field is equal to the supplied value

                                                                                                                                                                                                                  "field_value"

                                                                                                                                                                                                                    field_name[$op]

                                                                                                                                                                                                                    Filter using advanced query operators: $in, $nin, $lt, $lte, $gt, $gte, $ne, and $or

                                                                                                                                                                                                                    "field_value"

                                                                                                                                                                                                                      $limit
                                                                                                                                                                                                                      integer

                                                                                                                                                                                                                      Specify the maximum number of items to return

                                                                                                                                                                                                                      10
                                                                                                                                                                                                                      • default value: 20
                                                                                                                                                                                                                      • max value:2000

                                                                                                                                                                                                                      $skip
                                                                                                                                                                                                                      integer

                                                                                                                                                                                                                      Specify the number of items to skip over (offset)

                                                                                                                                                                                                                      2
                                                                                                                                                                                                                      • default value: 0

                                                                                                                                                                                                                      $sort[field_name]

                                                                                                                                                                                                                      Specify the fields to sort by and the respective sort order

                                                                                                                                                                                                                      1
                                                                                                                                                                                                                      • valid values: -1, 1

                                                                                                                                                                                                                      $select[field_name]

                                                                                                                                                                                                                      Pick which fields to include in the results

                                                                                                                                                                                                                      1
                                                                                                                                                                                                                      • valid values: 1

                                                                                                                                                                                                                      cURL

                                                                                                                                                                                                                      curl -X GET "http://api.dendra.science/v1/soms?field_name=field_value&field_name[$op]=field_value&$limit=10&$skip=2&$sort[field_name]=1&$select[field_name]=1" \
                                                                                                                                                                                                                           -H "Content-Type: application/json"

                                                                                                                                                                                                                      Response

                                                                                                                                                                                                                      {
                                                                                                                                                                                                                        "total": 1,
                                                                                                                                                                                                                        "limit": 10,
                                                                                                                                                                                                                        "skip": 2,
                                                                                                                                                                                                                        "data": [
                                                                                                                                                                                                                          {}
                                                                                                                                                                                                                        ]
                                                                                                                                                                                                                      }

                                                                                                                                                                                                                      Station

                                                                                                                                                                                                                      An observation post where data is measured and collected.

                                                                                                                                                                                                                      Show properties and constraints defined on the object

                                                                                                                                                                                                                      POST
                                                                                                                                                                                                                      Create station

                                                                                                                                                                                                                      Create a new station.

                                                                                                                                                                                                                      POST stations

                                                                                                                                                                                                                      Optional parameters

                                                                                                                                                                                                                      Name /type

                                                                                                                                                                                                                      Description /example

                                                                                                                                                                                                                      Constraints

                                                                                                                                                                                                                      activated_at
                                                                                                                                                                                                                      string

                                                                                                                                                                                                                      When this station was first put into service

                                                                                                                                                                                                                      "2017-05-28T09:50:23.106Z"
                                                                                                                                                                                                                      • pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}[T][0-9]{2}:[0-9]{2}:[0-9]{2}|.|[0-9]{0,3}Z$

                                                                                                                                                                                                                      enabled
                                                                                                                                                                                                                      boolean

                                                                                                                                                                                                                      Whether this station is enabled (shown) in any user interface

                                                                                                                                                                                                                      true
                                                                                                                                                                                                                      • valid values: (true,false)

                                                                                                                                                                                                                      deactivated_at
                                                                                                                                                                                                                      string

                                                                                                                                                                                                                      When this station was taken out of service

                                                                                                                                                                                                                      "2017-05-28T09:50:23.106Z"
                                                                                                                                                                                                                      • pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}[T][0-9]{2}:[0-9]{2}:[0-9]{2}|.|[0-9]{0,3}Z$

                                                                                                                                                                                                                      media
                                                                                                                                                                                                                      array

                                                                                                                                                                                                                      Image and video resources at specific sizes and pixel densities

                                                                                                                                                                                                                      [ { "type": "photo", "sizes": { "thumb": { "h": 60, "w": 60, "url": "http://res.cloudinary.com/dendro/image/upload/c_fill,g_center,h_60,w_60/photo.jpg" }, "thumb_2x": { "h": 120, "w": 120, "url": "http://res.cloudinary.com/dendro/image/upload/c_fill,g_center,h_120,w_120/photo.jpg" }, "small": { "h": 240, "w": 240, "url": "http://res.cloudinary.com/dendro/image/upload/c_fill,g_center,h_240,w_240/photo.jpg" }, "small_2x": { "h": 480, "w": 480, "url": "http://res.cloudinary.com/dendro/image/upload/c_fill,g_center,h_480,w_480/photo.jpg" }, "medium": { "h": 480, "w": 480, "url": "http://res.cloudinary.com/dendro/image/upload/c_fill,g_center,h_480,w_480/photo.jpg" }, "medium_2x": { "h": 960, "w": 960, "url": "http://res.cloudinary.com/dendro/image/upload/c_fill,g_center,h_960,w_960/photo.jpg" }, "large": { "h": 1080, "w": 1080, "url": "http://res.cloudinary.com/dendro/image/upload/c_fill,g_center,h_1080,w_1080/photo.jpg" } } } ]
                                                                                                                                                                                                                      • min length: 1

                                                                                                                                                                                                                      external_links
                                                                                                                                                                                                                      array

                                                                                                                                                                                                                      A list of external site links to display in any user interface

                                                                                                                                                                                                                      [ { "title": "Sensor database", "url": "http://sensor.berkeley.edu/index_ucnrs.html" } ]
                                                                                                                                                                                                                      • min length: 1

                                                                                                                                                                                                                      station_type
                                                                                                                                                                                                                      string

                                                                                                                                                                                                                      The specific type of station (e.g. 'research', 'weather')

                                                                                                                                                                                                                      "weather"

                                                                                                                                                                                                                        organization_id
                                                                                                                                                                                                                        string

                                                                                                                                                                                                                        The organization to which a station belongs

                                                                                                                                                                                                                        "592f155746a1b867a114e030"
                                                                                                                                                                                                                        • max length: 24
                                                                                                                                                                                                                        • pattern: ^[a-fA-F0-9]{24}$

                                                                                                                                                                                                                        thing_ids
                                                                                                                                                                                                                        array

                                                                                                                                                                                                                        One or more things (e.g. instruments or other equipment) associated with this station

                                                                                                                                                                                                                        [ "592f155746a1b867a114e070" ]
                                                                                                                                                                                                                        • min length: 1

                                                                                                                                                                                                                        is_stationary
                                                                                                                                                                                                                        boolean

                                                                                                                                                                                                                        Whether this station has a permanent location or is mobile

                                                                                                                                                                                                                        true
                                                                                                                                                                                                                        • valid values: (true,false)

                                                                                                                                                                                                                        name
                                                                                                                                                                                                                        string

                                                                                                                                                                                                                        "Blue Oak Ranch"

                                                                                                                                                                                                                          slug
                                                                                                                                                                                                                          string

                                                                                                                                                                                                                          A human-readable and URL-friendly name used to retrieve this document's page or resource

                                                                                                                                                                                                                          "blue-oak-ranch"
                                                                                                                                                                                                                          • pattern: ^[a-z0-9-]+$

                                                                                                                                                                                                                          utc_offset
                                                                                                                                                                                                                          integer

                                                                                                                                                                                                                          An offset in seconds between the time zone and UTC

                                                                                                                                                                                                                          -28800

                                                                                                                                                                                                                            geo
                                                                                                                                                                                                                            object

                                                                                                                                                                                                                            A GeoJSON point having one position (i.e. longitude, latitude, altitude)

                                                                                                                                                                                                                            { "type": "Point", "coordinates": [ -121.73638, 37.381666, 574.548 ] }

                                                                                                                                                                                                                              place_id
                                                                                                                                                                                                                              string

                                                                                                                                                                                                                              The place to where a station is generally located

                                                                                                                                                                                                                              "592f155746a1b867a114e050"
                                                                                                                                                                                                                              • max length: 24
                                                                                                                                                                                                                              • pattern: ^[a-fA-F0-9]{24}$

                                                                                                                                                                                                                              external_refs
                                                                                                                                                                                                                              array

                                                                                                                                                                                                                              A list of external or foreign keys associated with this document

                                                                                                                                                                                                                              [ { "identifier": "334", "type": "odm.stations.stationid", "url": "http://sensor.berkeley.edu/index_ucnrs.html" } ]
                                                                                                                                                                                                                              • min length: 1

                                                                                                                                                                                                                              members
                                                                                                                                                                                                                              array

                                                                                                                                                                                                                              Access control and role assignments

                                                                                                                                                                                                                              [ { "organization_id": "592f155746a1b867a114e030", "roles": [ "contact" ] }, { "person_id": "592f155746a1b867a114e040", "roles": [ "admin", "contact" ] } ]

                                                                                                                                                                                                                                full_name
                                                                                                                                                                                                                                string

                                                                                                                                                                                                                                "Blue Oak Ranch Reserve Weather Station"

                                                                                                                                                                                                                                  is_active
                                                                                                                                                                                                                                  boolean

                                                                                                                                                                                                                                  Whether this station is in service or has been taken out of service

                                                                                                                                                                                                                                  true
                                                                                                                                                                                                                                  • valid values: (true,false)

                                                                                                                                                                                                                                  time_zone
                                                                                                                                                                                                                                  string

                                                                                                                                                                                                                                  A time zone abbreviation

                                                                                                                                                                                                                                  "PST"

                                                                                                                                                                                                                                    cURL

                                                                                                                                                                                                                                    curl -X POST "http://api.dendra.science/v1/stations" \
                                                                                                                                                                                                                                         -H "Content-Type: application/json" \
                                                                                                                                                                                                                                         --data '{"activated_at":"2017-05-28T09:50:23.106Z","deactivated_at":"2017-05-28T09:50:23.106Z","enabled":true,"external_links":[{"title":"Sensor database","url":"http://sensor.berkeley.edu/index_ucnrs.html"}],"external_refs":[{"identifier":"334","type":"odm.stations.stationid","url":"http://sensor.berkeley.edu/index_ucnrs.html"}],"full_name":"Blue Oak Ranch Reserve Weather Station","geo":{"type":"Point","coordinates":[-121.73638,37.381666,574.548]},"is_active":true,"is_stationary":true,"media":[{"type":"photo","sizes":{"thumb":{"h":60,"w":60,"url":"http://res.cloudinary.com/dendro/image/upload/c_fill,g_center,h_60,w_60/photo.jpg"},"thumb_2x":{"h":120,"w":120,"url":"http://res.cloudinary.com/dendro/image/upload/c_fill,g_center,h_120,w_120/photo.jpg"},"small":{"h":240,"w":240,"url":"http://res.cloudinary.com/dendro/image/upload/c_fill,g_center,h_240,w_240/photo.jpg"},"small_2x":{"h":480,"w":480,"url":"http://res.cloudinary.com/dendro/image/upload/c_fill,g_center,h_480,w_480/photo.jpg"},"medium":{"h":480,"w":480,"url":"http://res.cloudinary.com/dendro/image/upload/c_fill,g_center,h_480,w_480/photo.jpg"},"medium_2x":{"h":960,"w":960,"url":"http://res.cloudinary.com/dendro/image/upload/c_fill,g_center,h_960,w_960/photo.jpg"},"large":{"h":1080,"w":1080,"url":"http://res.cloudinary.com/dendro/image/upload/c_fill,g_center,h_1080,w_1080/photo.jpg"}}}],"members":[{"organization_id":"592f155746a1b867a114e030","roles":["contact"]},{"person_id":"592f155746a1b867a114e040","roles":["admin","contact"]}],"name":"Blue Oak Ranch","organization_id":"592f155746a1b867a114e030","place_id":"592f155746a1b867a114e050","slug":"blue-oak-ranch","station_type":"weather","thing_ids":["592f155746a1b867a114e070"],"time_zone":"PST","utc_offset":-28800}'

                                                                                                                                                                                                                                    Response

                                                                                                                                                                                                                                    {}

                                                                                                                                                                                                                                    PUT
                                                                                                                                                                                                                                    Update station

                                                                                                                                                                                                                                    Update an existing station.

                                                                                                                                                                                                                                    PUT stations/:_id

                                                                                                                                                                                                                                    Optional parameters

                                                                                                                                                                                                                                    Name /type

                                                                                                                                                                                                                                    Description /example

                                                                                                                                                                                                                                    Constraints

                                                                                                                                                                                                                                    activated_at
                                                                                                                                                                                                                                    string

                                                                                                                                                                                                                                    When this station was first put into service

                                                                                                                                                                                                                                    "2017-05-28T09:50:23.106Z"
                                                                                                                                                                                                                                    • pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}[T][0-9]{2}:[0-9]{2}:[0-9]{2}|.|[0-9]{0,3}Z$

                                                                                                                                                                                                                                    enabled
                                                                                                                                                                                                                                    boolean

                                                                                                                                                                                                                                    Whether this station is enabled (shown) in any user interface

                                                                                                                                                                                                                                    true
                                                                                                                                                                                                                                    • valid values: (true,false)

                                                                                                                                                                                                                                    deactivated_at
                                                                                                                                                                                                                                    string

                                                                                                                                                                                                                                    When this station was taken out of service

                                                                                                                                                                                                                                    "2017-05-28T09:50:23.106Z"
                                                                                                                                                                                                                                    • pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}[T][0-9]{2}:[0-9]{2}:[0-9]{2}|.|[0-9]{0,3}Z$

                                                                                                                                                                                                                                    media
                                                                                                                                                                                                                                    array

                                                                                                                                                                                                                                    Image and video resources at specific sizes and pixel densities

                                                                                                                                                                                                                                    [ { "type": "photo", "sizes": { "thumb": { "h": 60, "w": 60, "url": "http://res.cloudinary.com/dendro/image/upload/c_fill,g_center,h_60,w_60/photo.jpg" }, "thumb_2x": { "h": 120, "w": 120, "url": "http://res.cloudinary.com/dendro/image/upload/c_fill,g_center,h_120,w_120/photo.jpg" }, "small": { "h": 240, "w": 240, "url": "http://res.cloudinary.com/dendro/image/upload/c_fill,g_center,h_240,w_240/photo.jpg" }, "small_2x": { "h": 480, "w": 480, "url": "http://res.cloudinary.com/dendro/image/upload/c_fill,g_center,h_480,w_480/photo.jpg" }, "medium": { "h": 480, "w": 480, "url": "http://res.cloudinary.com/dendro/image/upload/c_fill,g_center,h_480,w_480/photo.jpg" }, "medium_2x": { "h": 960, "w": 960, "url": "http://res.cloudinary.com/dendro/image/upload/c_fill,g_center,h_960,w_960/photo.jpg" }, "large": { "h": 1080, "w": 1080, "url": "http://res.cloudinary.com/dendro/image/upload/c_fill,g_center,h_1080,w_1080/photo.jpg" } } } ]
                                                                                                                                                                                                                                    • min length: 1

                                                                                                                                                                                                                                    external_links
                                                                                                                                                                                                                                    array

                                                                                                                                                                                                                                    A list of external site links to display in any user interface

                                                                                                                                                                                                                                    [ { "title": "Sensor database", "url": "http://sensor.berkeley.edu/index_ucnrs.html" } ]
                                                                                                                                                                                                                                    • min length: 1

                                                                                                                                                                                                                                    station_type
                                                                                                                                                                                                                                    string

                                                                                                                                                                                                                                    The specific type of station (e.g. 'research', 'weather')

                                                                                                                                                                                                                                    "weather"

                                                                                                                                                                                                                                      organization_id
                                                                                                                                                                                                                                      string

                                                                                                                                                                                                                                      The organization to which a station belongs

                                                                                                                                                                                                                                      "592f155746a1b867a114e030"
                                                                                                                                                                                                                                      • max length: 24
                                                                                                                                                                                                                                      • pattern: ^[a-fA-F0-9]{24}$

                                                                                                                                                                                                                                      thing_ids
                                                                                                                                                                                                                                      array

                                                                                                                                                                                                                                      One or more things (e.g. instruments or other equipment) associated with this station

                                                                                                                                                                                                                                      [ "592f155746a1b867a114e070" ]
                                                                                                                                                                                                                                      • min length: 1

                                                                                                                                                                                                                                      is_stationary
                                                                                                                                                                                                                                      boolean

                                                                                                                                                                                                                                      Whether this station has a permanent location or is mobile

                                                                                                                                                                                                                                      true
                                                                                                                                                                                                                                      • valid values: (true,false)

                                                                                                                                                                                                                                      name
                                                                                                                                                                                                                                      string

                                                                                                                                                                                                                                      "Blue Oak Ranch"

                                                                                                                                                                                                                                        slug
                                                                                                                                                                                                                                        string

                                                                                                                                                                                                                                        A human-readable and URL-friendly name used to retrieve this document's page or resource

                                                                                                                                                                                                                                        "blue-oak-ranch"
                                                                                                                                                                                                                                        • pattern: ^[a-z0-9-]+$

                                                                                                                                                                                                                                        utc_offset
                                                                                                                                                                                                                                        integer

                                                                                                                                                                                                                                        An offset in seconds between the time zone and UTC

                                                                                                                                                                                                                                        -28800

                                                                                                                                                                                                                                          geo
                                                                                                                                                                                                                                          object

                                                                                                                                                                                                                                          A GeoJSON point having one position (i.e. longitude, latitude, altitude)

                                                                                                                                                                                                                                          { "type": "Point", "coordinates": [ -121.73638, 37.381666, 574.548 ] }

                                                                                                                                                                                                                                            place_id
                                                                                                                                                                                                                                            string

                                                                                                                                                                                                                                            The place to where a station is generally located

                                                                                                                                                                                                                                            "592f155746a1b867a114e050"
                                                                                                                                                                                                                                            • max length: 24
                                                                                                                                                                                                                                            • pattern: ^[a-fA-F0-9]{24}$

                                                                                                                                                                                                                                            external_refs
                                                                                                                                                                                                                                            array

                                                                                                                                                                                                                                            A list of external or foreign keys associated with this document

                                                                                                                                                                                                                                            [ { "identifier": "334", "type": "odm.stations.stationid", "url": "http://sensor.berkeley.edu/index_ucnrs.html" } ]
                                                                                                                                                                                                                                            • min length: 1

                                                                                                                                                                                                                                            members
                                                                                                                                                                                                                                            array

                                                                                                                                                                                                                                            Access control and role assignments

                                                                                                                                                                                                                                            [ { "organization_id": "592f155746a1b867a114e030", "roles": [ "contact" ] }, { "person_id": "592f155746a1b867a114e040", "roles": [ "admin", "contact" ] } ]

                                                                                                                                                                                                                                              full_name
                                                                                                                                                                                                                                              string

                                                                                                                                                                                                                                              "Blue Oak Ranch Reserve Weather Station"

                                                                                                                                                                                                                                                is_active
                                                                                                                                                                                                                                                boolean

                                                                                                                                                                                                                                                Whether this station is in service or has been taken out of service

                                                                                                                                                                                                                                                true
                                                                                                                                                                                                                                                • valid values: (true,false)

                                                                                                                                                                                                                                                time_zone
                                                                                                                                                                                                                                                string

                                                                                                                                                                                                                                                A time zone abbreviation

                                                                                                                                                                                                                                                "PST"

                                                                                                                                                                                                                                                  cURL

                                                                                                                                                                                                                                                  curl -X PUT "http://api.dendra.science/v1/stations/592f155746a1b867a114e060" \
                                                                                                                                                                                                                                                       -H "Content-Type: application/json" \
                                                                                                                                                                                                                                                       --data '{"activated_at":"2017-05-28T09:50:23.106Z","deactivated_at":"2017-05-28T09:50:23.106Z","enabled":true,"external_links":[{"title":"Sensor database","url":"http://sensor.berkeley.edu/index_ucnrs.html"}],"external_refs":[{"identifier":"334","type":"odm.stations.stationid","url":"http://sensor.berkeley.edu/index_ucnrs.html"}],"full_name":"Blue Oak Ranch Reserve Weather Station","geo":{"type":"Point","coordinates":[-121.73638,37.381666,574.548]},"is_active":true,"is_stationary":true,"media":[{"type":"photo","sizes":{"thumb":{"h":60,"w":60,"url":"http://res.cloudinary.com/dendro/image/upload/c_fill,g_center,h_60,w_60/photo.jpg"},"thumb_2x":{"h":120,"w":120,"url":"http://res.cloudinary.com/dendro/image/upload/c_fill,g_center,h_120,w_120/photo.jpg"},"small":{"h":240,"w":240,"url":"http://res.cloudinary.com/dendro/image/upload/c_fill,g_center,h_240,w_240/photo.jpg"},"small_2x":{"h":480,"w":480,"url":"http://res.cloudinary.com/dendro/image/upload/c_fill,g_center,h_480,w_480/photo.jpg"},"medium":{"h":480,"w":480,"url":"http://res.cloudinary.com/dendro/image/upload/c_fill,g_center,h_480,w_480/photo.jpg"},"medium_2x":{"h":960,"w":960,"url":"http://res.cloudinary.com/dendro/image/upload/c_fill,g_center,h_960,w_960/photo.jpg"},"large":{"h":1080,"w":1080,"url":"http://res.cloudinary.com/dendro/image/upload/c_fill,g_center,h_1080,w_1080/photo.jpg"}}}],"members":[{"organization_id":"592f155746a1b867a114e030","roles":["contact"]},{"person_id":"592f155746a1b867a114e040","roles":["admin","contact"]}],"name":"Blue Oak Ranch","organization_id":"592f155746a1b867a114e030","place_id":"592f155746a1b867a114e050","slug":"blue-oak-ranch","station_type":"weather","thing_ids":["592f155746a1b867a114e070"],"time_zone":"PST","utc_offset":-28800}'

                                                                                                                                                                                                                                                  Response

                                                                                                                                                                                                                                                  {}

                                                                                                                                                                                                                                                  DELETE
                                                                                                                                                                                                                                                  Remove station

                                                                                                                                                                                                                                                  Remove an existing station.

                                                                                                                                                                                                                                                  DELETE stations/:_id

                                                                                                                                                                                                                                                  cURL

                                                                                                                                                                                                                                                  curl -X DELETE "http://api.dendra.science/v1/stations/592f155746a1b867a114e060" \
                                                                                                                                                                                                                                                       -H "Content-Type: application/json"

                                                                                                                                                                                                                                                  Response

                                                                                                                                                                                                                                                  {}

                                                                                                                                                                                                                                                  GET
                                                                                                                                                                                                                                                  Station info

                                                                                                                                                                                                                                                  Return a specific station.

                                                                                                                                                                                                                                                  GET stations/:_id

                                                                                                                                                                                                                                                  cURL

                                                                                                                                                                                                                                                  curl -X GET "http://api.dendra.science/v1/stations/592f155746a1b867a114e060" \
                                                                                                                                                                                                                                                       -H "Content-Type: application/json"

                                                                                                                                                                                                                                                  Response

                                                                                                                                                                                                                                                  {}

                                                                                                                                                                                                                                                  GET
                                                                                                                                                                                                                                                  List stations

                                                                                                                                                                                                                                                  Find one or more stations based on the query parameters.

                                                                                                                                                                                                                                                  GET stations

                                                                                                                                                                                                                                                  Optional parameters

                                                                                                                                                                                                                                                  Name /type

                                                                                                                                                                                                                                                  Description /example

                                                                                                                                                                                                                                                  Constraints

                                                                                                                                                                                                                                                  field_name

                                                                                                                                                                                                                                                  Filter where a field is equal to the supplied value

                                                                                                                                                                                                                                                  "field_value"

                                                                                                                                                                                                                                                    field_name[$op]

                                                                                                                                                                                                                                                    Filter using advanced query operators: $in, $nin, $lt, $lte, $gt, $gte, $ne, and $or

                                                                                                                                                                                                                                                    "field_value"

                                                                                                                                                                                                                                                      $limit
                                                                                                                                                                                                                                                      integer

                                                                                                                                                                                                                                                      Specify the maximum number of items to return

                                                                                                                                                                                                                                                      10
                                                                                                                                                                                                                                                      • default value: 20
                                                                                                                                                                                                                                                      • max value:2000

                                                                                                                                                                                                                                                      $skip
                                                                                                                                                                                                                                                      integer

                                                                                                                                                                                                                                                      Specify the number of items to skip over (offset)

                                                                                                                                                                                                                                                      2
                                                                                                                                                                                                                                                      • default value: 0

                                                                                                                                                                                                                                                      $sort[field_name]

                                                                                                                                                                                                                                                      Specify the fields to sort by and the respective sort order

                                                                                                                                                                                                                                                      1
                                                                                                                                                                                                                                                      • valid values: -1, 1

                                                                                                                                                                                                                                                      $select[field_name]

                                                                                                                                                                                                                                                      Pick which fields to include in the results

                                                                                                                                                                                                                                                      1
                                                                                                                                                                                                                                                      • valid values: 1

                                                                                                                                                                                                                                                      cURL

                                                                                                                                                                                                                                                      curl -X GET "http://api.dendra.science/v1/stations?field_name=field_value&field_name[$op]=field_value&$limit=10&$skip=2&$sort[field_name]=1&$select[field_name]=1" \
                                                                                                                                                                                                                                                           -H "Content-Type: application/json"

                                                                                                                                                                                                                                                      Response

                                                                                                                                                                                                                                                      {
                                                                                                                                                                                                                                                        "total": 1,
                                                                                                                                                                                                                                                        "limit": 10,
                                                                                                                                                                                                                                                        "skip": 2,
                                                                                                                                                                                                                                                        "data": [
                                                                                                                                                                                                                                                          {}
                                                                                                                                                                                                                                                        ]
                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                      Thing

                                                                                                                                                                                                                                                      An abstract type or physical instance of an instrument or other equipment.

                                                                                                                                                                                                                                                      Show properties and constraints defined on the object

                                                                                                                                                                                                                                                      POST
                                                                                                                                                                                                                                                      Create thing

                                                                                                                                                                                                                                                      Create a new thing.

                                                                                                                                                                                                                                                      POST things

                                                                                                                                                                                                                                                      Optional parameters

                                                                                                                                                                                                                                                      Name /type

                                                                                                                                                                                                                                                      Description /example

                                                                                                                                                                                                                                                      Constraints

                                                                                                                                                                                                                                                      urls
                                                                                                                                                                                                                                                      array

                                                                                                                                                                                                                                                      A list of URLs for the thing (e.g. datasheets or manuals)

                                                                                                                                                                                                                                                      [ { "label": "Manual", "url": "https://s.campbellsci.com/documents/us/manuals/107.pdf" } ]

                                                                                                                                                                                                                                                        part_of_thing_id
                                                                                                                                                                                                                                                        string

                                                                                                                                                                                                                                                        A reference to an assembly or larger thing to which this thing belongs

                                                                                                                                                                                                                                                        "592f155746a1b867a114e072"
                                                                                                                                                                                                                                                        • max length: 24
                                                                                                                                                                                                                                                        • pattern: ^[a-fA-F0-9]{24}$

                                                                                                                                                                                                                                                        model
                                                                                                                                                                                                                                                        string

                                                                                                                                                                                                                                                        The manufacturer's model number

                                                                                                                                                                                                                                                        "107-L"

                                                                                                                                                                                                                                                          instance_of_thing_id
                                                                                                                                                                                                                                                          string

                                                                                                                                                                                                                                                          An abstract thing that this physical instance represents

                                                                                                                                                                                                                                                          "592f155746a1b867a114e071"
                                                                                                                                                                                                                                                          • max length: 24
                                                                                                                                                                                                                                                          • pattern: ^[a-fA-F0-9]{24}$

                                                                                                                                                                                                                                                          name
                                                                                                                                                                                                                                                          string

                                                                                                                                                                                                                                                          "Campbell 107-L"

                                                                                                                                                                                                                                                            thing_type
                                                                                                                                                                                                                                                            string

                                                                                                                                                                                                                                                            The specific type of thing (e.g. 'logger', 'probe', 'sensor')

                                                                                                                                                                                                                                                            "probe"

                                                                                                                                                                                                                                                              geo
                                                                                                                                                                                                                                                              object

                                                                                                                                                                                                                                                              A GeoJSON point having one position (i.e. longitude, latitude, altitude)

                                                                                                                                                                                                                                                              { "type": "Point", "coordinates": [ -121.73638, 37.381666, 574.548 ] }

                                                                                                                                                                                                                                                                manufacturer
                                                                                                                                                                                                                                                                object

                                                                                                                                                                                                                                                                { "name": "Campbell Scientific", "url": "https://www.campbellsci.com" }

                                                                                                                                                                                                                                                                  serial_number
                                                                                                                                                                                                                                                                  string

                                                                                                                                                                                                                                                                  A physical thing's serial number

                                                                                                                                                                                                                                                                  "1004039"

                                                                                                                                                                                                                                                                    attributes
                                                                                                                                                                                                                                                                    object

                                                                                                                                                                                                                                                                    Any custom attributes for the thing

                                                                                                                                                                                                                                                                    { "operating_range": [ -35, 50 ] }

                                                                                                                                                                                                                                                                      is_abstract
                                                                                                                                                                                                                                                                      boolean

                                                                                                                                                                                                                                                                      Whether this thing is an abstract type or physical instance

                                                                                                                                                                                                                                                                      false
                                                                                                                                                                                                                                                                      • valid values: (true,false)

                                                                                                                                                                                                                                                                      full_name
                                                                                                                                                                                                                                                                      string

                                                                                                                                                                                                                                                                      "Campbell Scientific 107-L Temperature Probe"

                                                                                                                                                                                                                                                                        description
                                                                                                                                                                                                                                                                        string

                                                                                                                                                                                                                                                                        Text describing this document

                                                                                                                                                                                                                                                                        "The 107 is a rugged, accurate probe that measures temperature of air, soil, or water from -35° to +50°C. It easily interfaces with most Campbell Scientific dataloggers and can be used in a variety of applications."

                                                                                                                                                                                                                                                                          method_description
                                                                                                                                                                                                                                                                          string

                                                                                                                                                                                                                                                                          Describes the method of measurement, including quality control and assurance that it has been subject to

                                                                                                                                                                                                                                                                          "The 107 consists of a thermistor encapsulated in an epoxy-filled aluminum housing. The housing protects the thermistor allowing the probe to be buried in soil or submerged in water."

                                                                                                                                                                                                                                                                            cURL

                                                                                                                                                                                                                                                                            curl -X POST "http://api.dendra.science/v1/things" \
                                                                                                                                                                                                                                                                                 -H "Content-Type: application/json" \
                                                                                                                                                                                                                                                                                 --data '{"attributes":{"operating_range":[-35,50]},"description":"The 107 is a rugged, accurate probe that measures temperature of air, soil, or water from -35° to +50°C. It easily interfaces with most Campbell Scientific dataloggers and can be used in a variety of applications.","full_name":"Campbell Scientific 107-L Temperature Probe","geo":{"type":"Point","coordinates":[-121.73638,37.381666,574.548]},"instance_of_thing_id":"592f155746a1b867a114e071","is_abstract":false,"manufacturer":{"name":"Campbell Scientific","url":"https://www.campbellsci.com"},"method_description":"The 107 consists of a thermistor encapsulated in an epoxy-filled aluminum housing. The housing protects the thermistor allowing the probe to be buried in soil or submerged in water.","model":"107-L","name":"Campbell 107-L","part_of_thing_id":"592f155746a1b867a114e072","serial_number":"1004039","thing_type":"probe","urls":[{"label":"Manual","url":"https://s.campbellsci.com/documents/us/manuals/107.pdf"}]}'

                                                                                                                                                                                                                                                                            Response

                                                                                                                                                                                                                                                                            {}

                                                                                                                                                                                                                                                                            PUT
                                                                                                                                                                                                                                                                            Update thing

                                                                                                                                                                                                                                                                            Update an existing thing.

                                                                                                                                                                                                                                                                            PUT things/:_id

                                                                                                                                                                                                                                                                            Optional parameters

                                                                                                                                                                                                                                                                            Name /type

                                                                                                                                                                                                                                                                            Description /example

                                                                                                                                                                                                                                                                            Constraints

                                                                                                                                                                                                                                                                            urls
                                                                                                                                                                                                                                                                            array

                                                                                                                                                                                                                                                                            A list of URLs for the thing (e.g. datasheets or manuals)

                                                                                                                                                                                                                                                                            [ { "label": "Manual", "url": "https://s.campbellsci.com/documents/us/manuals/107.pdf" } ]

                                                                                                                                                                                                                                                                              part_of_thing_id
                                                                                                                                                                                                                                                                              string

                                                                                                                                                                                                                                                                              A reference to an assembly or larger thing to which this thing belongs

                                                                                                                                                                                                                                                                              "592f155746a1b867a114e072"
                                                                                                                                                                                                                                                                              • max length: 24
                                                                                                                                                                                                                                                                              • pattern: ^[a-fA-F0-9]{24}$

                                                                                                                                                                                                                                                                              model
                                                                                                                                                                                                                                                                              string

                                                                                                                                                                                                                                                                              The manufacturer's model number

                                                                                                                                                                                                                                                                              "107-L"

                                                                                                                                                                                                                                                                                instance_of_thing_id
                                                                                                                                                                                                                                                                                string

                                                                                                                                                                                                                                                                                An abstract thing that this physical instance represents

                                                                                                                                                                                                                                                                                "592f155746a1b867a114e071"
                                                                                                                                                                                                                                                                                • max length: 24
                                                                                                                                                                                                                                                                                • pattern: ^[a-fA-F0-9]{24}$

                                                                                                                                                                                                                                                                                name
                                                                                                                                                                                                                                                                                string

                                                                                                                                                                                                                                                                                "Campbell 107-L"

                                                                                                                                                                                                                                                                                  thing_type
                                                                                                                                                                                                                                                                                  string

                                                                                                                                                                                                                                                                                  The specific type of thing (e.g. 'logger', 'probe', 'sensor')

                                                                                                                                                                                                                                                                                  "probe"

                                                                                                                                                                                                                                                                                    geo
                                                                                                                                                                                                                                                                                    object

                                                                                                                                                                                                                                                                                    A GeoJSON point having one position (i.e. longitude, latitude, altitude)

                                                                                                                                                                                                                                                                                    { "type": "Point", "coordinates": [ -121.73638, 37.381666, 574.548 ] }

                                                                                                                                                                                                                                                                                      manufacturer
                                                                                                                                                                                                                                                                                      object

                                                                                                                                                                                                                                                                                      { "name": "Campbell Scientific", "url": "https://www.campbellsci.com" }

                                                                                                                                                                                                                                                                                        serial_number
                                                                                                                                                                                                                                                                                        string

                                                                                                                                                                                                                                                                                        A physical thing's serial number

                                                                                                                                                                                                                                                                                        "1004039"

                                                                                                                                                                                                                                                                                          attributes
                                                                                                                                                                                                                                                                                          object

                                                                                                                                                                                                                                                                                          Any custom attributes for the thing

                                                                                                                                                                                                                                                                                          { "operating_range": [ -35, 50 ] }

                                                                                                                                                                                                                                                                                            is_abstract
                                                                                                                                                                                                                                                                                            boolean

                                                                                                                                                                                                                                                                                            Whether this thing is an abstract type or physical instance

                                                                                                                                                                                                                                                                                            false
                                                                                                                                                                                                                                                                                            • valid values: (true,false)

                                                                                                                                                                                                                                                                                            full_name
                                                                                                                                                                                                                                                                                            string

                                                                                                                                                                                                                                                                                            "Campbell Scientific 107-L Temperature Probe"

                                                                                                                                                                                                                                                                                              description
                                                                                                                                                                                                                                                                                              string

                                                                                                                                                                                                                                                                                              Text describing this document

                                                                                                                                                                                                                                                                                              "The 107 is a rugged, accurate probe that measures temperature of air, soil, or water from -35° to +50°C. It easily interfaces with most Campbell Scientific dataloggers and can be used in a variety of applications."

                                                                                                                                                                                                                                                                                                method_description
                                                                                                                                                                                                                                                                                                string

                                                                                                                                                                                                                                                                                                Describes the method of measurement, including quality control and assurance that it has been subject to

                                                                                                                                                                                                                                                                                                "The 107 consists of a thermistor encapsulated in an epoxy-filled aluminum housing. The housing protects the thermistor allowing the probe to be buried in soil or submerged in water."

                                                                                                                                                                                                                                                                                                  cURL

                                                                                                                                                                                                                                                                                                  curl -X PUT "http://api.dendra.science/v1/things/592f155746a1b867a114e070" \
                                                                                                                                                                                                                                                                                                       -H "Content-Type: application/json" \
                                                                                                                                                                                                                                                                                                       --data '{"attributes":{"operating_range":[-35,50]},"description":"The 107 is a rugged, accurate probe that measures temperature of air, soil, or water from -35° to +50°C. It easily interfaces with most Campbell Scientific dataloggers and can be used in a variety of applications.","full_name":"Campbell Scientific 107-L Temperature Probe","geo":{"type":"Point","coordinates":[-121.73638,37.381666,574.548]},"instance_of_thing_id":"592f155746a1b867a114e071","is_abstract":false,"manufacturer":{"name":"Campbell Scientific","url":"https://www.campbellsci.com"},"method_description":"The 107 consists of a thermistor encapsulated in an epoxy-filled aluminum housing. The housing protects the thermistor allowing the probe to be buried in soil or submerged in water.","model":"107-L","name":"Campbell 107-L","part_of_thing_id":"592f155746a1b867a114e072","serial_number":"1004039","thing_type":"probe","urls":[{"label":"Manual","url":"https://s.campbellsci.com/documents/us/manuals/107.pdf"}]}'

                                                                                                                                                                                                                                                                                                  Response

                                                                                                                                                                                                                                                                                                  {}

                                                                                                                                                                                                                                                                                                  DELETE
                                                                                                                                                                                                                                                                                                  Remove thing

                                                                                                                                                                                                                                                                                                  Remove an existing thing.

                                                                                                                                                                                                                                                                                                  DELETE things/:_id

                                                                                                                                                                                                                                                                                                  cURL

                                                                                                                                                                                                                                                                                                  curl -X DELETE "http://api.dendra.science/v1/things/592f155746a1b867a114e070" \
                                                                                                                                                                                                                                                                                                       -H "Content-Type: application/json"

                                                                                                                                                                                                                                                                                                  Response

                                                                                                                                                                                                                                                                                                  {}

                                                                                                                                                                                                                                                                                                  GET
                                                                                                                                                                                                                                                                                                  Thing info

                                                                                                                                                                                                                                                                                                  Return a specific thing.

                                                                                                                                                                                                                                                                                                  GET things/:_id

                                                                                                                                                                                                                                                                                                  cURL

                                                                                                                                                                                                                                                                                                  curl -X GET "http://api.dendra.science/v1/things/592f155746a1b867a114e070" \
                                                                                                                                                                                                                                                                                                       -H "Content-Type: application/json"

                                                                                                                                                                                                                                                                                                  Response

                                                                                                                                                                                                                                                                                                  {}

                                                                                                                                                                                                                                                                                                  GET
                                                                                                                                                                                                                                                                                                  List things

                                                                                                                                                                                                                                                                                                  Find one or more things based on the query parameters.

                                                                                                                                                                                                                                                                                                  GET things

                                                                                                                                                                                                                                                                                                  Optional parameters

                                                                                                                                                                                                                                                                                                  Name /type

                                                                                                                                                                                                                                                                                                  Description /example

                                                                                                                                                                                                                                                                                                  Constraints

                                                                                                                                                                                                                                                                                                  field_name

                                                                                                                                                                                                                                                                                                  Filter where a field is equal to the supplied value

                                                                                                                                                                                                                                                                                                  "field_value"

                                                                                                                                                                                                                                                                                                    field_name[$op]

                                                                                                                                                                                                                                                                                                    Filter using advanced query operators: $in, $nin, $lt, $lte, $gt, $gte, $ne, and $or

                                                                                                                                                                                                                                                                                                    "field_value"

                                                                                                                                                                                                                                                                                                      $limit
                                                                                                                                                                                                                                                                                                      integer

                                                                                                                                                                                                                                                                                                      Specify the maximum number of items to return

                                                                                                                                                                                                                                                                                                      10
                                                                                                                                                                                                                                                                                                      • default value: 20
                                                                                                                                                                                                                                                                                                      • max value:2000

                                                                                                                                                                                                                                                                                                      $skip
                                                                                                                                                                                                                                                                                                      integer

                                                                                                                                                                                                                                                                                                      Specify the number of items to skip over (offset)

                                                                                                                                                                                                                                                                                                      2
                                                                                                                                                                                                                                                                                                      • default value: 0

                                                                                                                                                                                                                                                                                                      $sort[field_name]

                                                                                                                                                                                                                                                                                                      Specify the fields to sort by and the respective sort order

                                                                                                                                                                                                                                                                                                      1
                                                                                                                                                                                                                                                                                                      • valid values: -1, 1

                                                                                                                                                                                                                                                                                                      $select[field_name]

                                                                                                                                                                                                                                                                                                      Pick which fields to include in the results

                                                                                                                                                                                                                                                                                                      1
                                                                                                                                                                                                                                                                                                      • valid values: 1

                                                                                                                                                                                                                                                                                                      cURL

                                                                                                                                                                                                                                                                                                      curl -X GET "http://api.dendra.science/v1/things?field_name=field_value&field_name[$op]=field_value&$limit=10&$skip=2&$sort[field_name]=1&$select[field_name]=1" \
                                                                                                                                                                                                                                                                                                           -H "Content-Type: application/json"

                                                                                                                                                                                                                                                                                                      Response

                                                                                                                                                                                                                                                                                                      {
                                                                                                                                                                                                                                                                                                        "total": 1,
                                                                                                                                                                                                                                                                                                        "limit": 10,
                                                                                                                                                                                                                                                                                                        "skip": 2,
                                                                                                                                                                                                                                                                                                        "data": [
                                                                                                                                                                                                                                                                                                          {}
                                                                                                                                                                                                                                                                                                        ]
                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                      Unit of Measurement

                                                                                                                                                                                                                                                                                                      A quantity used as a standard of measurement.

                                                                                                                                                                                                                                                                                                      Show properties and constraints defined on the object

                                                                                                                                                                                                                                                                                                      POST
                                                                                                                                                                                                                                                                                                      Create UOM

                                                                                                                                                                                                                                                                                                      Create a new unit of measurement.

                                                                                                                                                                                                                                                                                                      POST uoms

                                                                                                                                                                                                                                                                                                      Optional parameters

                                                                                                                                                                                                                                                                                                      Name /type

                                                                                                                                                                                                                                                                                                      Description /example

                                                                                                                                                                                                                                                                                                      Constraints

                                                                                                                                                                                                                                                                                                      _id
                                                                                                                                                                                                                                                                                                      string

                                                                                                                                                                                                                                                                                                      The unique document identifier

                                                                                                                                                                                                                                                                                                      "degree-fahrenheit"
                                                                                                                                                                                                                                                                                                      • max length: 50

                                                                                                                                                                                                                                                                                                      convertible_to_uom_ids
                                                                                                                                                                                                                                                                                                      array

                                                                                                                                                                                                                                                                                                      One or more units of measurement that this UOM can be converted to

                                                                                                                                                                                                                                                                                                      [ "degree-celsius", "kelvin" ]
                                                                                                                                                                                                                                                                                                      • min length: 1

                                                                                                                                                                                                                                                                                                      library_config
                                                                                                                                                                                                                                                                                                      object

                                                                                                                                                                                                                                                                                                      Library configurations used in conversion

                                                                                                                                                                                                                                                                                                      { "mathjs": { "round_n": 1, "unit_name": "degF" } }

                                                                                                                                                                                                                                                                                                        som_id
                                                                                                                                                                                                                                                                                                        string

                                                                                                                                                                                                                                                                                                        The system of measurement to which this UOM belongs

                                                                                                                                                                                                                                                                                                        "imp"
                                                                                                                                                                                                                                                                                                        • max length: 50

                                                                                                                                                                                                                                                                                                        unit_tags
                                                                                                                                                                                                                                                                                                        array

                                                                                                                                                                                                                                                                                                        Unit vocabulary tags to which this UOM represents

                                                                                                                                                                                                                                                                                                        [ "dt_Unit_DegreeFahrenheit" ]
                                                                                                                                                                                                                                                                                                        • min length: 1

                                                                                                                                                                                                                                                                                                        cURL

                                                                                                                                                                                                                                                                                                        curl -X POST "http://api.dendra.science/v1/uoms" \
                                                                                                                                                                                                                                                                                                             -H "Content-Type: application/json" \
                                                                                                                                                                                                                                                                                                             --data '{"_id":"degree-fahrenheit","convertible_to_uom_ids":["degree-celsius","kelvin"],"library_config":{"mathjs":{"round_n":1,"unit_name":"degF"}},"som_id":"imp","unit_tags":["dt_Unit_DegreeFahrenheit"]}'

                                                                                                                                                                                                                                                                                                        Response

                                                                                                                                                                                                                                                                                                        {}

                                                                                                                                                                                                                                                                                                        PUT
                                                                                                                                                                                                                                                                                                        Update UOM

                                                                                                                                                                                                                                                                                                        Update an existing unit of measurement.

                                                                                                                                                                                                                                                                                                        PUT uoms/:_id

                                                                                                                                                                                                                                                                                                        Optional parameters

                                                                                                                                                                                                                                                                                                        Name /type

                                                                                                                                                                                                                                                                                                        Description /example

                                                                                                                                                                                                                                                                                                        Constraints

                                                                                                                                                                                                                                                                                                        convertible_to_uom_ids
                                                                                                                                                                                                                                                                                                        array

                                                                                                                                                                                                                                                                                                        One or more units of measurement that this UOM can be converted to

                                                                                                                                                                                                                                                                                                        [ "degree-celsius", "kelvin" ]
                                                                                                                                                                                                                                                                                                        • min length: 1

                                                                                                                                                                                                                                                                                                        library_config
                                                                                                                                                                                                                                                                                                        object

                                                                                                                                                                                                                                                                                                        Library configurations used in conversion

                                                                                                                                                                                                                                                                                                        { "mathjs": { "round_n": 1, "unit_name": "degF" } }

                                                                                                                                                                                                                                                                                                          som_id
                                                                                                                                                                                                                                                                                                          string

                                                                                                                                                                                                                                                                                                          The system of measurement to which this UOM belongs

                                                                                                                                                                                                                                                                                                          "imp"
                                                                                                                                                                                                                                                                                                          • max length: 50

                                                                                                                                                                                                                                                                                                          unit_tags
                                                                                                                                                                                                                                                                                                          array

                                                                                                                                                                                                                                                                                                          Unit vocabulary tags to which this UOM represents

                                                                                                                                                                                                                                                                                                          [ "dt_Unit_DegreeFahrenheit" ]
                                                                                                                                                                                                                                                                                                          • min length: 1

                                                                                                                                                                                                                                                                                                          cURL

                                                                                                                                                                                                                                                                                                          curl -X PUT "http://api.dendra.science/v1/uoms/degree-fahrenheit" \
                                                                                                                                                                                                                                                                                                               -H "Content-Type: application/json" \
                                                                                                                                                                                                                                                                                                               --data '{"convertible_to_uom_ids":["degree-celsius","kelvin"],"library_config":{"mathjs":{"round_n":1,"unit_name":"degF"}},"som_id":"imp","unit_tags":["dt_Unit_DegreeFahrenheit"]}'

                                                                                                                                                                                                                                                                                                          Response

                                                                                                                                                                                                                                                                                                          {}

                                                                                                                                                                                                                                                                                                          DELETE
                                                                                                                                                                                                                                                                                                          Remove UOM

                                                                                                                                                                                                                                                                                                          Remove an existing unit of measurement.

                                                                                                                                                                                                                                                                                                          DELETE uoms/:_id

                                                                                                                                                                                                                                                                                                          cURL

                                                                                                                                                                                                                                                                                                          curl -X DELETE "http://api.dendra.science/v1/uoms/degree-fahrenheit" \
                                                                                                                                                                                                                                                                                                               -H "Content-Type: application/json"

                                                                                                                                                                                                                                                                                                          Response

                                                                                                                                                                                                                                                                                                          {}

                                                                                                                                                                                                                                                                                                          GET
                                                                                                                                                                                                                                                                                                          UOM info

                                                                                                                                                                                                                                                                                                          Return a specific unit of measurement.

                                                                                                                                                                                                                                                                                                          GET uoms/:_id

                                                                                                                                                                                                                                                                                                          cURL

                                                                                                                                                                                                                                                                                                          curl -X GET "http://api.dendra.science/v1/uoms/degree-fahrenheit" \
                                                                                                                                                                                                                                                                                                               -H "Content-Type: application/json"

                                                                                                                                                                                                                                                                                                          Response

                                                                                                                                                                                                                                                                                                          {}

                                                                                                                                                                                                                                                                                                          GET
                                                                                                                                                                                                                                                                                                          List UOMs

                                                                                                                                                                                                                                                                                                          Find one or more units of measurement based on the query parameters.

                                                                                                                                                                                                                                                                                                          GET uoms

                                                                                                                                                                                                                                                                                                          Optional parameters

                                                                                                                                                                                                                                                                                                          Name /type

                                                                                                                                                                                                                                                                                                          Description /example

                                                                                                                                                                                                                                                                                                          Constraints

                                                                                                                                                                                                                                                                                                          field_name

                                                                                                                                                                                                                                                                                                          Filter where a field is equal to the supplied value

                                                                                                                                                                                                                                                                                                          "field_value"

                                                                                                                                                                                                                                                                                                            field_name[$op]

                                                                                                                                                                                                                                                                                                            Filter using advanced query operators: $in, $nin, $lt, $lte, $gt, $gte, $ne, and $or

                                                                                                                                                                                                                                                                                                            "field_value"

                                                                                                                                                                                                                                                                                                              $limit
                                                                                                                                                                                                                                                                                                              integer

                                                                                                                                                                                                                                                                                                              Specify the maximum number of items to return

                                                                                                                                                                                                                                                                                                              10
                                                                                                                                                                                                                                                                                                              • default value: 20
                                                                                                                                                                                                                                                                                                              • max value:2000

                                                                                                                                                                                                                                                                                                              $skip
                                                                                                                                                                                                                                                                                                              integer

                                                                                                                                                                                                                                                                                                              Specify the number of items to skip over (offset)

                                                                                                                                                                                                                                                                                                              2
                                                                                                                                                                                                                                                                                                              • default value: 0

                                                                                                                                                                                                                                                                                                              $sort[field_name]

                                                                                                                                                                                                                                                                                                              Specify the fields to sort by and the respective sort order

                                                                                                                                                                                                                                                                                                              1
                                                                                                                                                                                                                                                                                                              • valid values: -1, 1

                                                                                                                                                                                                                                                                                                              $select[field_name]

                                                                                                                                                                                                                                                                                                              Pick which fields to include in the results

                                                                                                                                                                                                                                                                                                              1
                                                                                                                                                                                                                                                                                                              • valid values: 1

                                                                                                                                                                                                                                                                                                              cURL

                                                                                                                                                                                                                                                                                                              curl -X GET "http://api.dendra.science/v1/uoms?field_name=field_value&field_name[$op]=field_value&$limit=10&$skip=2&$sort[field_name]=1&$select[field_name]=1" \
                                                                                                                                                                                                                                                                                                                   -H "Content-Type: application/json"

                                                                                                                                                                                                                                                                                                              Response

                                                                                                                                                                                                                                                                                                              {
                                                                                                                                                                                                                                                                                                                "total": 1,
                                                                                                                                                                                                                                                                                                                "limit": 10,
                                                                                                                                                                                                                                                                                                                "skip": 2,
                                                                                                                                                                                                                                                                                                                "data": [
                                                                                                                                                                                                                                                                                                                  {}
                                                                                                                                                                                                                                                                                                                ]
                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                              User

                                                                                                                                                                                                                                                                                                              A user account with credentials for authentication.

                                                                                                                                                                                                                                                                                                              Show properties and constraints defined on the object

                                                                                                                                                                                                                                                                                                              POST
                                                                                                                                                                                                                                                                                                              Create user

                                                                                                                                                                                                                                                                                                              Create a new user.

                                                                                                                                                                                                                                                                                                              POST users

                                                                                                                                                                                                                                                                                                              Optional parameters

                                                                                                                                                                                                                                                                                                              Name /type

                                                                                                                                                                                                                                                                                                              Description /example

                                                                                                                                                                                                                                                                                                              Constraints

                                                                                                                                                                                                                                                                                                              email
                                                                                                                                                                                                                                                                                                              string

                                                                                                                                                                                                                                                                                                              The primary contact email address

                                                                                                                                                                                                                                                                                                              "collin@berkeley.edu"

                                                                                                                                                                                                                                                                                                                full_name
                                                                                                                                                                                                                                                                                                                string

                                                                                                                                                                                                                                                                                                                "Collin Bode"

                                                                                                                                                                                                                                                                                                                  password
                                                                                                                                                                                                                                                                                                                  string

                                                                                                                                                                                                                                                                                                                  A password for local authentication

                                                                                                                                                                                                                                                                                                                    name
                                                                                                                                                                                                                                                                                                                    string

                                                                                                                                                                                                                                                                                                                    "Collin"

                                                                                                                                                                                                                                                                                                                      cURL

                                                                                                                                                                                                                                                                                                                      curl -X POST "http://api.dendra.science/v1/users" \
                                                                                                                                                                                                                                                                                                                           -H "Content-Type: application/json" \
                                                                                                                                                                                                                                                                                                                           --data '{"email":"collin@berkeley.edu","full_name":"Collin Bode","name":"Collin"}'

                                                                                                                                                                                                                                                                                                                      Response

                                                                                                                                                                                                                                                                                                                      {}

                                                                                                                                                                                                                                                                                                                      PUT
                                                                                                                                                                                                                                                                                                                      Update user

                                                                                                                                                                                                                                                                                                                      Update an existing user.

                                                                                                                                                                                                                                                                                                                      PUT users/:_id

                                                                                                                                                                                                                                                                                                                      Optional parameters

                                                                                                                                                                                                                                                                                                                      Name /type

                                                                                                                                                                                                                                                                                                                      Description /example

                                                                                                                                                                                                                                                                                                                      Constraints

                                                                                                                                                                                                                                                                                                                      email
                                                                                                                                                                                                                                                                                                                      string

                                                                                                                                                                                                                                                                                                                      The primary contact email address

                                                                                                                                                                                                                                                                                                                      "collin@berkeley.edu"

                                                                                                                                                                                                                                                                                                                        full_name
                                                                                                                                                                                                                                                                                                                        string

                                                                                                                                                                                                                                                                                                                        "Collin Bode"

                                                                                                                                                                                                                                                                                                                          password
                                                                                                                                                                                                                                                                                                                          string

                                                                                                                                                                                                                                                                                                                          A password for local authentication

                                                                                                                                                                                                                                                                                                                            name
                                                                                                                                                                                                                                                                                                                            string

                                                                                                                                                                                                                                                                                                                            "Collin"

                                                                                                                                                                                                                                                                                                                              cURL

                                                                                                                                                                                                                                                                                                                              curl -X PUT "http://api.dendra.science/v1/users/592f155746a1b867a114e040" \
                                                                                                                                                                                                                                                                                                                                   -H "Content-Type: application/json" \
                                                                                                                                                                                                                                                                                                                                   --data '{"email":"collin@berkeley.edu","full_name":"Collin Bode","name":"Collin"}'

                                                                                                                                                                                                                                                                                                                              Response

                                                                                                                                                                                                                                                                                                                              {}

                                                                                                                                                                                                                                                                                                                              DELETE
                                                                                                                                                                                                                                                                                                                              Remove user

                                                                                                                                                                                                                                                                                                                              Remove an existing user.

                                                                                                                                                                                                                                                                                                                              DELETE users/:_id

                                                                                                                                                                                                                                                                                                                              cURL

                                                                                                                                                                                                                                                                                                                              curl -X DELETE "http://api.dendra.science/v1/users/592f155746a1b867a114e040" \
                                                                                                                                                                                                                                                                                                                                   -H "Content-Type: application/json"

                                                                                                                                                                                                                                                                                                                              Response

                                                                                                                                                                                                                                                                                                                              {}

                                                                                                                                                                                                                                                                                                                              GET
                                                                                                                                                                                                                                                                                                                              User info

                                                                                                                                                                                                                                                                                                                              Return a specific user.

                                                                                                                                                                                                                                                                                                                              GET users/:_id

                                                                                                                                                                                                                                                                                                                              cURL

                                                                                                                                                                                                                                                                                                                              curl -X GET "http://api.dendra.science/v1/users/592f155746a1b867a114e040" \
                                                                                                                                                                                                                                                                                                                                   -H "Content-Type: application/json"

                                                                                                                                                                                                                                                                                                                              Response

                                                                                                                                                                                                                                                                                                                              {}

                                                                                                                                                                                                                                                                                                                              GET
                                                                                                                                                                                                                                                                                                                              List users

                                                                                                                                                                                                                                                                                                                              Find one or more users based on the query parameters.

                                                                                                                                                                                                                                                                                                                              GET users

                                                                                                                                                                                                                                                                                                                              Optional parameters

                                                                                                                                                                                                                                                                                                                              Name /type

                                                                                                                                                                                                                                                                                                                              Description /example

                                                                                                                                                                                                                                                                                                                              Constraints

                                                                                                                                                                                                                                                                                                                              field_name

                                                                                                                                                                                                                                                                                                                              Filter where a field is equal to the supplied value

                                                                                                                                                                                                                                                                                                                              "field_value"

                                                                                                                                                                                                                                                                                                                                field_name[$op]

                                                                                                                                                                                                                                                                                                                                Filter using advanced query operators: $in, $nin, $lt, $lte, $gt, $gte, $ne, and $or

                                                                                                                                                                                                                                                                                                                                "field_value"

                                                                                                                                                                                                                                                                                                                                  $limit
                                                                                                                                                                                                                                                                                                                                  integer

                                                                                                                                                                                                                                                                                                                                  Specify the maximum number of items to return

                                                                                                                                                                                                                                                                                                                                  10
                                                                                                                                                                                                                                                                                                                                  • default value: 20
                                                                                                                                                                                                                                                                                                                                  • max value:2000

                                                                                                                                                                                                                                                                                                                                  $skip
                                                                                                                                                                                                                                                                                                                                  integer

                                                                                                                                                                                                                                                                                                                                  Specify the number of items to skip over (offset)

                                                                                                                                                                                                                                                                                                                                  2
                                                                                                                                                                                                                                                                                                                                  • default value: 0

                                                                                                                                                                                                                                                                                                                                  $sort[field_name]

                                                                                                                                                                                                                                                                                                                                  Specify the fields to sort by and the respective sort order

                                                                                                                                                                                                                                                                                                                                  1
                                                                                                                                                                                                                                                                                                                                  • valid values: -1, 1

                                                                                                                                                                                                                                                                                                                                  $select[field_name]

                                                                                                                                                                                                                                                                                                                                  Pick which fields to include in the results

                                                                                                                                                                                                                                                                                                                                  1
                                                                                                                                                                                                                                                                                                                                  • valid values: 1

                                                                                                                                                                                                                                                                                                                                  cURL

                                                                                                                                                                                                                                                                                                                                  curl -X GET "http://api.dendra.science/v1/users?field_name=field_value&field_name[$op]=field_value&$limit=10&$skip=2&$sort[field_name]=1&$select[field_name]=1" \
                                                                                                                                                                                                                                                                                                                                       -H "Content-Type: application/json"

                                                                                                                                                                                                                                                                                                                                  Response

                                                                                                                                                                                                                                                                                                                                  {
                                                                                                                                                                                                                                                                                                                                    "total": 1,
                                                                                                                                                                                                                                                                                                                                    "limit": 10,
                                                                                                                                                                                                                                                                                                                                    "skip": 2,
                                                                                                                                                                                                                                                                                                                                    "data": [
                                                                                                                                                                                                                                                                                                                                      {}
                                                                                                                                                                                                                                                                                                                                    ]
                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                  Vocabulary

                                                                                                                                                                                                                                                                                                                                  A controlled vocabulary used to tag data producing entities.

                                                                                                                                                                                                                                                                                                                                  Show properties and constraints defined on the object

                                                                                                                                                                                                                                                                                                                                  POST
                                                                                                                                                                                                                                                                                                                                  Create vocabulary

                                                                                                                                                                                                                                                                                                                                  Create a new vocabulary.

                                                                                                                                                                                                                                                                                                                                  POST vocabularies

                                                                                                                                                                                                                                                                                                                                  Optional parameters

                                                                                                                                                                                                                                                                                                                                  Name /type

                                                                                                                                                                                                                                                                                                                                  Description /example

                                                                                                                                                                                                                                                                                                                                  Constraints

                                                                                                                                                                                                                                                                                                                                  _id
                                                                                                                                                                                                                                                                                                                                  string

                                                                                                                                                                                                                                                                                                                                  The unique document identifier

                                                                                                                                                                                                                                                                                                                                  "ds-aggregate"
                                                                                                                                                                                                                                                                                                                                  • max length: 50

                                                                                                                                                                                                                                                                                                                                  description
                                                                                                                                                                                                                                                                                                                                  string

                                                                                                                                                                                                                                                                                                                                  Text describing this document

                                                                                                                                                                                                                                                                                                                                  "Terms describing how multiple values are grouped together to form a single value."

                                                                                                                                                                                                                                                                                                                                    label
                                                                                                                                                                                                                                                                                                                                    string

                                                                                                                                                                                                                                                                                                                                    A metadata label assigned to entities and used to construct tags

                                                                                                                                                                                                                                                                                                                                    "Aggregate"
                                                                                                                                                                                                                                                                                                                                    • max length: 50

                                                                                                                                                                                                                                                                                                                                    scheme_id
                                                                                                                                                                                                                                                                                                                                    string

                                                                                                                                                                                                                                                                                                                                    The scheme to which this vocabulary belongs

                                                                                                                                                                                                                                                                                                                                    "ds"
                                                                                                                                                                                                                                                                                                                                    • max length: 50

                                                                                                                                                                                                                                                                                                                                    terms
                                                                                                                                                                                                                                                                                                                                    array

                                                                                                                                                                                                                                                                                                                                    [ { "abbreviation": "avg", "definition": "The sum of a collection of numbers divided by the number of numbers in the collection.", "label": "Average", "name": "Average/Mean" } ]

                                                                                                                                                                                                                                                                                                                                      vocabulary_type
                                                                                                                                                                                                                                                                                                                                      string

                                                                                                                                                                                                                                                                                                                                      Whether the vocabulary is a general purpose classifier or describes a unit of measurement

                                                                                                                                                                                                                                                                                                                                      "class"
                                                                                                                                                                                                                                                                                                                                      • valid values: "class", "unit"

                                                                                                                                                                                                                                                                                                                                      cURL

                                                                                                                                                                                                                                                                                                                                      curl -X POST "http://api.dendra.science/v1/vocabularies" \
                                                                                                                                                                                                                                                                                                                                           -H "Content-Type: application/json" \
                                                                                                                                                                                                                                                                                                                                           --data '{"_id":"ds-aggregate","description":"Terms describing how multiple values are grouped together to form a single value.","label":"Aggregate","scheme_id":"ds","terms":[{"abbreviation":"avg","definition":"The sum of a collection of numbers divided by the number of numbers in the collection.","label":"Average","name":"Average/Mean"}],"vocabulary_type":"class"}'

                                                                                                                                                                                                                                                                                                                                      Response

                                                                                                                                                                                                                                                                                                                                      {}

                                                                                                                                                                                                                                                                                                                                      PUT
                                                                                                                                                                                                                                                                                                                                      Update vocabulary

                                                                                                                                                                                                                                                                                                                                      Update an existing vocabulary.

                                                                                                                                                                                                                                                                                                                                      PUT vocabularies/:_id

                                                                                                                                                                                                                                                                                                                                      Optional parameters

                                                                                                                                                                                                                                                                                                                                      Name /type

                                                                                                                                                                                                                                                                                                                                      Description /example

                                                                                                                                                                                                                                                                                                                                      Constraints

                                                                                                                                                                                                                                                                                                                                      description
                                                                                                                                                                                                                                                                                                                                      string

                                                                                                                                                                                                                                                                                                                                      Text describing this document

                                                                                                                                                                                                                                                                                                                                      "Terms describing how multiple values are grouped together to form a single value."

                                                                                                                                                                                                                                                                                                                                        label
                                                                                                                                                                                                                                                                                                                                        string

                                                                                                                                                                                                                                                                                                                                        A metadata label assigned to entities and used to construct tags

                                                                                                                                                                                                                                                                                                                                        "Aggregate"
                                                                                                                                                                                                                                                                                                                                        • max length: 50

                                                                                                                                                                                                                                                                                                                                        scheme_id
                                                                                                                                                                                                                                                                                                                                        string

                                                                                                                                                                                                                                                                                                                                        The scheme to which this vocabulary belongs

                                                                                                                                                                                                                                                                                                                                        "ds"
                                                                                                                                                                                                                                                                                                                                        • max length: 50

                                                                                                                                                                                                                                                                                                                                        terms
                                                                                                                                                                                                                                                                                                                                        array

                                                                                                                                                                                                                                                                                                                                        [ { "abbreviation": "avg", "definition": "The sum of a collection of numbers divided by the number of numbers in the collection.", "label": "Average", "name": "Average/Mean" } ]

                                                                                                                                                                                                                                                                                                                                          vocabulary_type
                                                                                                                                                                                                                                                                                                                                          string

                                                                                                                                                                                                                                                                                                                                          Whether the vocabulary is a general purpose classifier or describes a unit of measurement

                                                                                                                                                                                                                                                                                                                                          "class"
                                                                                                                                                                                                                                                                                                                                          • valid values: "class", "unit"

                                                                                                                                                                                                                                                                                                                                          cURL

                                                                                                                                                                                                                                                                                                                                          curl -X PUT "http://api.dendra.science/v1/vocabularies/ds-aggregate" \
                                                                                                                                                                                                                                                                                                                                               -H "Content-Type: application/json" \
                                                                                                                                                                                                                                                                                                                                               --data '{"description":"Terms describing how multiple values are grouped together to form a single value.","label":"Aggregate","scheme_id":"ds","terms":[{"abbreviation":"avg","definition":"The sum of a collection of numbers divided by the number of numbers in the collection.","label":"Average","name":"Average/Mean"}],"vocabulary_type":"class"}'

                                                                                                                                                                                                                                                                                                                                          Response

                                                                                                                                                                                                                                                                                                                                          {}

                                                                                                                                                                                                                                                                                                                                          DELETE
                                                                                                                                                                                                                                                                                                                                          Remove vocabulary

                                                                                                                                                                                                                                                                                                                                          Remove an existing vocabulary.

                                                                                                                                                                                                                                                                                                                                          DELETE vocabularies/:_id

                                                                                                                                                                                                                                                                                                                                          cURL

                                                                                                                                                                                                                                                                                                                                          curl -X DELETE "http://api.dendra.science/v1/vocabularies/ds-aggregate" \
                                                                                                                                                                                                                                                                                                                                               -H "Content-Type: application/json"

                                                                                                                                                                                                                                                                                                                                          Response

                                                                                                                                                                                                                                                                                                                                          {}

                                                                                                                                                                                                                                                                                                                                          GET
                                                                                                                                                                                                                                                                                                                                          Vocabulary info

                                                                                                                                                                                                                                                                                                                                          Return a specific vocabulary.

                                                                                                                                                                                                                                                                                                                                          GET vocabularies/:_id

                                                                                                                                                                                                                                                                                                                                          cURL

                                                                                                                                                                                                                                                                                                                                          curl -X GET "http://api.dendra.science/v1/vocabularies/ds-aggregate" \
                                                                                                                                                                                                                                                                                                                                               -H "Content-Type: application/json"

                                                                                                                                                                                                                                                                                                                                          Response

                                                                                                                                                                                                                                                                                                                                          {}

                                                                                                                                                                                                                                                                                                                                          GET
                                                                                                                                                                                                                                                                                                                                          List vocabularies

                                                                                                                                                                                                                                                                                                                                          Find one or more vocabularies based on the query parameters.

                                                                                                                                                                                                                                                                                                                                          GET vocabularies

                                                                                                                                                                                                                                                                                                                                          Optional parameters

                                                                                                                                                                                                                                                                                                                                          Name /type

                                                                                                                                                                                                                                                                                                                                          Description /example

                                                                                                                                                                                                                                                                                                                                          Constraints

                                                                                                                                                                                                                                                                                                                                          field_name

                                                                                                                                                                                                                                                                                                                                          Filter where a field is equal to the supplied value

                                                                                                                                                                                                                                                                                                                                          "field_value"

                                                                                                                                                                                                                                                                                                                                            field_name[$op]

                                                                                                                                                                                                                                                                                                                                            Filter using advanced query operators: $in, $nin, $lt, $lte, $gt, $gte, $ne, and $or

                                                                                                                                                                                                                                                                                                                                            "field_value"

                                                                                                                                                                                                                                                                                                                                              $limit
                                                                                                                                                                                                                                                                                                                                              integer

                                                                                                                                                                                                                                                                                                                                              Specify the maximum number of items to return

                                                                                                                                                                                                                                                                                                                                              10
                                                                                                                                                                                                                                                                                                                                              • default value: 20
                                                                                                                                                                                                                                                                                                                                              • max value:2000

                                                                                                                                                                                                                                                                                                                                              $skip
                                                                                                                                                                                                                                                                                                                                              integer

                                                                                                                                                                                                                                                                                                                                              Specify the number of items to skip over (offset)

                                                                                                                                                                                                                                                                                                                                              2
                                                                                                                                                                                                                                                                                                                                              • default value: 0

                                                                                                                                                                                                                                                                                                                                              $sort[field_name]

                                                                                                                                                                                                                                                                                                                                              Specify the fields to sort by and the respective sort order

                                                                                                                                                                                                                                                                                                                                              1
                                                                                                                                                                                                                                                                                                                                              • valid values: -1, 1

                                                                                                                                                                                                                                                                                                                                              $select[field_name]

                                                                                                                                                                                                                                                                                                                                              Pick which fields to include in the results

                                                                                                                                                                                                                                                                                                                                              1
                                                                                                                                                                                                                                                                                                                                              • valid values: 1

                                                                                                                                                                                                                                                                                                                                              cURL

                                                                                                                                                                                                                                                                                                                                              curl -X GET "http://api.dendra.science/v1/vocabularies?field_name=field_value&field_name[$op]=field_value&$limit=10&$skip=2&$sort[field_name]=1&$select[field_name]=1" \
                                                                                                                                                                                                                                                                                                                                                   -H "Content-Type: application/json"

                                                                                                                                                                                                                                                                                                                                              Response

                                                                                                                                                                                                                                                                                                                                              {
                                                                                                                                                                                                                                                                                                                                                "total": 1,
                                                                                                                                                                                                                                                                                                                                                "limit": 10,
                                                                                                                                                                                                                                                                                                                                                "skip": 2,
                                                                                                                                                                                                                                                                                                                                                "data": [
                                                                                                                                                                                                                                                                                                                                                  {}
                                                                                                                                                                                                                                                                                                                                                ]
                                                                                                                                                                                                                                                                                                                                              }