logo
API docs by Redocly

CHRNS metadata search API (1.0.0)

Download OpenAPI specification:Download

E-mail: ncnrdata@nist.gov License: Public Domain

This API allows you to search for openly-accessible datafile and experiment metadata for neutron measurements done at the NIST Center for Neutron Research.

Support for this portal is provided by the NSF through the Center for High Resolution Neutron Scattering (CHRNS)

Experiment

A single measurement (beamtime)

Find experiments

Note that the result must satisfy all search parameters, so the more you specify, the smaller the result set will be. Examples: \

  • /experiments?id=27585 will return a list of experiments with that id on all instruments, while
  • /experiments?id=nonims2&instrument_id=35 will return only a single result
Authorizations:
None
query Parameters
id
string
Example: id=25847

either an IMS id (numeric) or nonims

instrument_id
integer
Example: instrument_id=35

numeric id of the instrument

participant_name
string
Example: participant_name=Krycka

match name from list of participants (case insensitive)

title
string
Example: title=morphology

match part of experiment title

participant_orcid
string (ORCID) ^https:\/\/orcid.org\/[0-9]{4}-[0-9]{4}-[0-9]...
Example: participant_orcid=https://orcid.org/0000-0002-6105-8789

match ORCID id from list of participants (enter with or without https://orcid.org/ prefix)

after
string
Example: after=November 10 2020

only find experiments active after this date

before
string
Example: before=January 10 2021

only find experiments active before this date

limit
integer [ 1 .. 250 ]
Default: 25

maximum number of returned results (up to 250)

offset
integer

return results starting at offset (defaults to 0)
combine with limit for pagination

Responses

Response samples

Content type
application/json
{
  • "id": "27585",
  • "description": "",
  • "instrument_id": 36,
  • "participant_names": [
    ],
  • "participant_orcid": [
    ],
  • "local_contact": "Brian Maranville",
  • "creation_timestamp": 1578325297.714,
  • "title": "Development of Horizontal-Mode reflectometry with slits at MAGIK"
}

Datafiles

Operations on datafiles

searchDatafiles

get datafile metadata

Authorizations:
None
query Parameters
experiment_id
string
rxcycle_id
integer
instrument
string
Enum: "bt1" "bt2" "bt4" "bt5" "bt7" "bt8" "bt9" "macs" "ng1" "cg1" "hfbs" "vsans" "dcs" "ng5" "ng7" "ng7sans" "nse" "ngb30sans" "ngbsans" "ngd" "cgd" "phades" "candor"
Example: instrument=vsans

string alias for the instrument

instrument_id
integer
Example: instrument_id=36
before
string
Example: before=November 10 2020

only find datafiles started before this date

after
string
Example: after=January 10 2021

only find datafiles started after this date

object (MetadataQueryConstraint)

find by arbitrary metadata

limit
integer [ 1 .. 250 ]
Default: 25

maximum number of returned results (up to 250)

offset
integer

return results starting at offset (defaults to 0)
combine with limit for pagination

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Instrument

instrument details

get instrument info by id or alias

Authorizations:
None
query Parameters
id
integer
Example: id=35

numeric instrument_id

alias
string
Example: alias=ng7sans

short string alias for instrument

Responses

Response samples

Content type
application/json
{
  • "id": 38,
  • "alias": "candor",
  • "fullname": "NG-1 -- CANDOR White-Beam Reflectometer",
  • "hostname": "candor.ncnr.nist.gov"
}