docs/source/schema/begin_run_event.json at 4dc6cb4c08794f4d8f992fe9d01bdd4ba5451db8 · NSLS-II/docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "properties": {
        "beamline_config": {
            "type": ["object", "string"],
            "description": "Meta-data regrading how the beamline is configured.  Maybe UID into another collection"
        },
        "project": {
            "type": "string",
            "description": "Name of project that this run is part of"
        },
        "sample": {
            "type": ["object", "string"],
            "description": "Information about the sample, may be a UID to another collection"
        },
        "beamline_id": {
            "type": "string",
            "description": "The beamline ID"
        },
        "scan_id": {
            "type": "integer",
            "description": "Scan ID number, not globally unique"
        },
        "time": {
            "type": "number",
            "description": "Time the run started.  Unix epoch time"
        },
        "uid": {
            "type": "string",
            "description": "Globally unique ID for tihs run"
        },
        "group": {
            "type": ["string", "integer"],
            "description": "Unix group to associate this data with"
        },
        "owner": {
            "type": ["string", "integer"],
            "description": "Unix owner to associate this data with"
        }
    },
    "required": [
        "uid",
        "time",
        "group",
        "owner",
        "beamline_config",
        "beamline_id"
     ],
    "type": "object",
    "description": "Document created at the start of run.  Provides a seach target and later documents link to it"
}