---     
tags: 
  - Satbots
description: Returns Satbots and their status that were created in the last week.
  <br/><br/>User must be an admin.
parameters:
  - in: header
    name: Authorization
    type: string
    required: true
produces: 
  - 'application/json'
responses:
  200:
    schema:
      type: object
      example: {
            "satbots": [
                {
                    "created_at": "2024-02-28 13:07:28",
                    "created_by": {
                        "id": 3,
                        "name": "Adam Gleeson"
                    },
                    "finished_at": "",
                    "id": 364,
                    "parameters": {
                        "--database": "uk",
                        "--frame-id": "000A_blah",
                        "--hr-file": "/nas1/frames/000A_blah/000A_blah.h5",
                        "--rural-file": "/nas1/frames/000A_blah/000A_blah-rural.h5",
                        "-y": true,
                        "command": "sync-dates"
                    },
                    "pid": null,
                    "priority": {
                        "icon_class": "chevron-down",
                        "name": "MEDIUM",
                        "options": [
                            [
                                1,
                                "LOW"
                            ],
                            [
                                2,
                                "MEDIUM"
                            ],
                            [
                                3,
                                "HIGH"
                            ],
                            [
                                99,
                                "URGENT"
                            ]
                        ],
                        "title": "MEDIUM",
                        "value": 2
                    },
                    "progress": null,
                    "started_at": "",
                    "state": {
                        "bootstrap_css_class": "primary",
                        "colour": "#333",
                        "emoji": "📋 ",
                        "explanation": "Satbots not yet run.  When there is next availability, the Satbot at the top of this list will be run first.",
                        "name": "INITIAL",
                        "progress_bar_colour": "#c3e6cb",
                        "title": "Queued",
                        "value": 1
                    },
                    "time_taken": "",
                    "type": {
                        "description": "Copies all displacements and dates from the HDF5 file for all points in the frame.",
                        "dynamic_fields": {
                            "--database": {
                                "choices": "databases",
                                "hint": "If not set, value will default to <strong>UK</strong>",
                                "label": "Database",
                                "optional": true,
                                "type": "select"
                            },
                            "--frame-id": {
                                "choices": "frames",
                                "hint": "Unless running initial insert, an error will occur if the frame does not exist in the chosen database.",
                                "label": "Frame ID",
                                "type": "select"
                            },
                            "--hr-file": {
                                "hint": "The full file path of high resolution velocity HDF5 that contains the data you'd like to update in the database.",
                                "label": "HR File",
                                "placeholder": "/path/to/frames/{{frame_id}}/{{frame_id}}-vel.h5",
                                "type": "text"
                            },
                            "--rural-file": {
                                "hint": "The full file path of rural velocity HDF5 that contains the data you'd like to update in the database.",
                                "label": "Rural File",
                                "placeholder": "/path/to/frames/{{frame_id}}/{{frame_id}}-rural-vel.h5",
                                "type": "text"
                            }
                        },
                        "file_name": "ingester",
                        "legacy": false,
                        "name": "INGESTER_SYNC_DATES",
                        "run_exclusively": false,
                        "title": "Ingester: Sync Dates",
                        "value": 60
                    }
                },
                {
                    "created_at": "2024-02-28 13:03:55",
                    "created_by": {
                        "id": 3,
                        "name": "Adam Gleeson"
                    },
                    "finished_at": "",
                    "id": 362,
                    "parameters": {
                        "--database": "uk",
                        "--frame-id": "000A_blah",
                        "--hr-file": "/nas1/frames/000A_blah/000A_blah.h5",
                        "--rural-file": "/nas1/frames/000A_blah/000A_blah-rural.h5",
                        "-y": true,
                        "command": "sync-dates"
                    },
                    "pid": null,
                    "priority": {
                        "icon_class": "chevron-double-down",
                        "name": "LOW",
                        "options": [
                            [
                                1,
                                "LOW"
                            ],
                            [
                                2,
                                "MEDIUM"
                            ],
                            [
                                3,
                                "HIGH"
                            ],
                            [
                                99,
                                "URGENT"
                            ]
                        ],
                        "title": "LOW",
                        "value": 1
                    },
                    "progress": null,
                    "started_at": "",
                    "state": {
                        "bootstrap_css_class": "primary",
                        "colour": "#333",
                        "emoji": "📋 ",
                        "explanation": "Satbots not yet run.  When there is next availability, the Satbot at the top of this list will be run first.",
                        "name": "INITIAL",
                        "progress_bar_colour": "#c3e6cb",
                        "title": "Queued",
                        "value": 1
                    },
                    "time_taken": "",
                    "type": {
                        "description": "Copies all displacements and dates from the HDF5 file for all points in the frame.",
                        "dynamic_fields": {
                            "--database": {
                                "choices": "databases",
                                "hint": "If not set, value will default to <strong>UK</strong>",
                                "label": "Database",
                                "optional": true,
                                "type": "select"
                            },
                            "--frame-id": {
                                "choices": "frames",
                                "hint": "Unless running initial insert, an error will occur if the frame does not exist in the chosen database.",
                                "label": "Frame ID",
                                "type": "select"
                            },
                            "--hr-file": {
                                "hint": "The full file path of high resolution velocity HDF5 that contains the data you'd like to update in the database.",
                                "label": "HR File",
                                "placeholder": "/path/to/frames/{{frame_id}}/{{frame_id}}-vel.h5",
                                "type": "text"
                            },
                            "--rural-file": {
                                "hint": "The full file path of rural velocity HDF5 that contains the data you'd like to update in the database.",
                                "label": "Rural File",
                                "placeholder": "/path/to/frames/{{frame_id}}/{{frame_id}}-rural-vel.h5",
                                "type": "text"
                            }
                        },
                        "file_name": "ingester",
                        "legacy": false,
                        "name": "INGESTER_SYNC_DATES",
                        "run_exclusively": false,
                        "title": "Ingester: Sync Dates",
                        "value": 60
                    }
                },
                {
                    "created_at": "2024-02-22 11:01:15",
                    "created_by": {
                        "id": 3,
                        "name": "Adam Gleeson"
                    },
                    "finished_at": "2024-02-22 11:24:44",
                    "id": 361,
                    "parameters": {
                        "--help": true
                    },
                    "pid": 1456450,
                    "priority": {
                        "icon_class": "chevron-double-down",
                        "name": "LOW",
                        "options": [
                            [
                                1,
                                "LOW"
                            ],
                            [
                                2,
                                "MEDIUM"
                            ],
                            [
                                3,
                                "HIGH"
                            ],
                            [
                                99,
                                "URGENT"
                            ]
                        ],
                        "title": "LOW",
                        "value": 1
                    },
                    "progress": 100,
                    "started_at": "2024-02-22 11:24:42",
                    "state": {
                        "bootstrap_css_class": "success",
                        "colour": "#00FF00",
                        "emoji": "🏁 ",
                        "explanation": "Satbots that have finished within the last 7 days.",
                        "name": "FINISHED",
                        "progress_bar_colour": "#c3e6cb",
                        "title": "Finished",
                        "value": 10
                    },
                    "time_taken": "0 days, 0 hours, 0 minutes, 1 seconds",
                    "type": {
                        "description": "Displays the ingester help message.  Useful for debugging app setup without changing anything.",
                        "dynamic_fields": {},
                        "file_name": "ingester",
                        "legacy": false,
                        "name": "INGESTER_HELP",
                        "run_exclusively": false,
                        "title": "Ingester: Help",
                        "value": 59
                    }
                },
                {
                    "created_at": "2024-02-22 10:26:48",
                    "created_by": {
                        "id": 3,
                        "name": "Adam Gleeson"
                    },
                    "finished_at": "2024-02-22 10:26:52",
                    "id": 360,
                    "parameters": {
                        "--database": "",
                        "--frame-id": "000A_test_frame",
                        "--hr-file": "/rust2/workspace/frames/000A_test_frame/000A_test_frame-vel.h5",
                        "--rural-file": "/rust2/workspace/frames/000A_test_frame/000A_test_frame-rural-vel.h5",
                        "-y": true,
                        "command": "insert-dates"
                    },
                    "pid": 1355465,
                    "priority": {
                        "icon_class": "chevron-double-down",
                        "name": "LOW",
                        "options": [
                            [
                                1,
                                "LOW"
                            ],
                            [
                                2,
                                "MEDIUM"
                            ],
                            [
                                3,
                                "HIGH"
                            ],
                            [
                                99,
                                "URGENT"
                            ]
                        ],
                        "title": "LOW",
                        "value": 1
                    },
                    "progress": null,
                    "started_at": "2024-02-22 10:26:52",
                    "state": {
                        "bootstrap_css_class": "danger",
                        "colour": "#FF0000",
                        "emoji": "🚨 ",
                        "explanation": "Satbots that finished more than 7 days ago.",
                        "name": "ERROR",
                        "progress_bar_colour": "#f5c6cb",
                        "title": "Error",
                        "value": 99
                    },
                    "time_taken": "0 days, 0 hours, 0 minutes, 0 seconds",
                    "type": {
                        "description": "Update points with dates that aren't in the database already.",
                        "dynamic_fields": {
                            "--database": {
                                "choices": "databases",
                                "hint": "If not set, value will default to <strong>UK</strong>",
                                "label": "Database",
                                "optional": true,
                                "type": "select"
                            },
                            "--frame-id": {
                                "choices": "frames",
                                "hint": "Unless running initial insert, an error will occur if the frame does not exist in the chosen database.",
                                "label": "Frame ID",
                                "type": "select"
                            },
                            "--hr-file": {
                                "hint": "The full file path of high resolution velocity HDF5 that contains the data you'd like to update in the database.",
                                "label": "HR File",
                                "placeholder": "/path/to/frames/{{frame_id}}/{{frame_id}}-vel.h5",
                                "type": "text"
                            },
                            "--rural-file": {
                                "hint": "The full file path of rural velocity HDF5 that contains the data you'd like to update in the database.",
                                "label": "Rural File",
                                "placeholder": "/path/to/frames/{{frame_id}}/{{frame_id}}-rural-vel.h5",
                                "type": "text"
                            }
                        },
                        "file_name": "ingester",
                        "legacy": false,
                        "name": "INGESTER_INSERT_DATES",
                        "run_exclusively": false,
                        "title": "Ingester: Insert Dates",
                        "value": 53
                    }
                },
                {
                    "created_at": "2024-02-22 10:26:12",
                    "created_by": {
                        "id": 3,
                        "name": "Adam Gleeson"
                    },
                    "finished_at": "2024-02-22 10:26:21",
                    "id": 359,
                    "parameters": {
                        "--help": true
                    },
                    "pid": 1354548,
                    "priority": {
                        "icon_class": "chevron-double-down",
                        "name": "LOW",
                        "options": [
                            [
                                1,
                                "LOW"
                            ],
                            [
                                2,
                                "MEDIUM"
                            ],
                            [
                                3,
                                "HIGH"
                            ],
                            [
                                99,
                                "URGENT"
                            ]
                        ],
                        "title": "LOW",
                        "value": 1
                    },
                    "progress": 100,
                    "started_at": "2024-02-22 10:26:20",
                    "state": {
                        "bootstrap_css_class": "success",
                        "colour": "#00FF00",
                        "emoji": "🏁 ",
                        "explanation": "Satbots that have finished within the last 7 days.",
                        "name": "FINISHED",
                        "progress_bar_colour": "#c3e6cb",
                        "title": "Finished",
                        "value": 10
                    },
                    "time_taken": "0 days, 0 hours, 0 minutes, 0 seconds",
                    "type": {
                        "description": "Displays the ingester help message.  Useful for debugging app setup without changing anything.",
                        "dynamic_fields": {},
                        "file_name": "ingester",
                        "legacy": false,
                        "name": "INGESTER_HELP",
                        "run_exclusively": false,
                        "title": "Ingester: Help",
                        "value": 59
                    }
                },
                {
                    "created_at": "2024-02-22 09:11:04",
                    "created_by": {
                        "id": 3,
                        "name": "Adam Gleeson"
                    },
                    "finished_at": "2024-02-22 09:11:07",
                    "id": 358,
                    "parameters": {
                        "--database": "uk",
                        "--frame-id": "000A_test_frame",
                        "--hr-file": "/rust2/workspace/frames/000A_test_frame/000A_test_frame-vel.h5",
                        "--rural-file": "/rust2/workspace/frames/000A_test_frame/000A_test_frame-rural-vel.h5",
                        "-y": true,
                        "command": "insert-dates"
                    },
                    "pid": 1226585,
                    "priority": {
                        "icon_class": "chevron-double-down",
                        "name": "LOW",
                        "options": [
                            [
                                1,
                                "LOW"
                            ],
                            [
                                2,
                                "MEDIUM"
                            ],
                            [
                                3,
                                "HIGH"
                            ],
                            [
                                99,
                                "URGENT"
                            ]
                        ],
                        "title": "LOW",
                        "value": 1
                    },
                    "progress": null,
                    "started_at": "2024-02-22 09:11:06",
                    "state": {
                        "bootstrap_css_class": "danger",
                        "colour": "#FF0000",
                        "emoji": "🚨 ",
                        "explanation": "Satbots that finished more than 7 days ago.",
                        "name": "ERROR",
                        "progress_bar_colour": "#f5c6cb",
                        "title": "Error",
                        "value": 99
                    },
                    "time_taken": "0 days, 0 hours, 0 minutes, 0 seconds",
                    "type": {
                        "description": "Update points with dates that aren't in the database already.",
                        "dynamic_fields": {
                            "--database": {
                                "choices": "databases",
                                "hint": "If not set, value will default to <strong>UK</strong>",
                                "label": "Database",
                                "optional": true,
                                "type": "select"
                            },
                            "--frame-id": {
                                "choices": "frames",
                                "hint": "Unless running initial insert, an error will occur if the frame does not exist in the chosen database.",
                                "label": "Frame ID",
                                "type": "select"
                            },
                            "--hr-file": {
                                "hint": "The full file path of high resolution velocity HDF5 that contains the data you'd like to update in the database.",
                                "label": "HR File",
                                "placeholder": "/path/to/frames/{{frame_id}}/{{frame_id}}-vel.h5",
                                "type": "text"
                            },
                            "--rural-file": {
                                "hint": "The full file path of rural velocity HDF5 that contains the data you'd like to update in the database.",
                                "label": "Rural File",
                                "placeholder": "/path/to/frames/{{frame_id}}/{{frame_id}}-rural-vel.h5",
                                "type": "text"
                            }
                        },
                        "file_name": "ingester",
                        "legacy": false,
                        "name": "INGESTER_INSERT_DATES",
                        "run_exclusively": false,
                        "title": "Ingester: Insert Dates",
                        "value": 53
                    }
                },
                {
                    "created_at": "2024-02-22 09:09:48",
                    "created_by": {
                        "id": 3,
                        "name": "Adam Gleeson"
                    },
                    "finished_at": "2024-02-22 09:10:39",
                    "id": 357,
                    "parameters": {
                        "--help": true
                    },
                    "pid": 1225761,
                    "priority": {
                        "icon_class": "chevron-double-down",
                        "name": "LOW",
                        "options": [
                            [
                                1,
                                "LOW"
                            ],
                            [
                                2,
                                "MEDIUM"
                            ],
                            [
                                3,
                                "HIGH"
                            ],
                            [
                                99,
                                "URGENT"
                            ]
                        ],
                        "title": "LOW",
                        "value": 1
                    },
                    "progress": 100,
                    "started_at": "2024-02-22 09:10:38",
                    "state": {
                        "bootstrap_css_class": "success",
                        "colour": "#00FF00",
                        "emoji": "🏁 ",
                        "explanation": "Satbots that have finished within the last 7 days.",
                        "name": "FINISHED",
                        "progress_bar_colour": "#c3e6cb",
                        "title": "Finished",
                        "value": 10
                    },
                    "time_taken": "0 days, 0 hours, 0 minutes, 1 seconds",
                    "type": {
                        "description": "Displays the ingester help message.  Useful for debugging app setup without changing anything.",
                        "dynamic_fields": {},
                        "file_name": "ingester",
                        "legacy": false,
                        "name": "INGESTER_HELP",
                        "run_exclusively": false,
                        "title": "Ingester: Help",
                        "value": 59
                    }
                }
            ]
        }
  401:
    schema:
      type: object
      properties:
        error:
          type: string
          example: 'Unauthorised'

