Procedures

Note

To get the status of the server at the specified port, you can use the curl or Postman to test your calls.

getProcedures GET

curl localhost:5003/procedures/get/:catalog/:module/:token

Note

Where token is a uniquely generated token on accessing the app. Default development is always generated

Returns

Array - List of all procedures that belong to a specific version of a module in the catalog

Example

{
  "status": {
    "error": null,
    "stream": null,
    "running": false,
    "fully_installed": true,
    "partial_install": true
  },
  "dependencies": [
    {
      "target": "jhuaplbio/basestack_mytax",
      "type": "docker",
      "version": "latest",
      "format": "docker",
      "status": {
        "downloading": false,
        "decompressing": false,
        "exists": {
          "version": "sha256:4762c42837c0fcffcb36a08398d7aafff57de72584804e797a63bc28ddd9c9b1"
        },
        "error": null,
        "stream": null,
        "fully_installed": false,
        "partial_install": false,
        "version": "sha256:4762c42837c0fcffcb36a08398d7aafff57de72584804e797a63bc28ddd9c9b1"
      }
    },

---

runProcedure POST

localhost:5003/procedure/run

Note

Where token is a uniquely generated token on accessing the app. Default development is always generated

Parameters

1. module Int - Index of the version of the module

2. catalog String - Name of the specific Catalog

3. variables Object - Object of all unique variable names to assign to 1 or more services

4. token String - Autogenerated token on startup of Basestack

5. procedure - Int - Index of the procedure for the module. Comprises 1 or more services

Returns

Status - Success or Error on procedure (1 or more service ) completion

---

cancelProcedure POST

localhost:5003/procedure/cancel

Note

Where token is a uniquely generated token on accessing the app. Default development is always generated

Parameters

1. module Int - Index of the version of the module

2. catalog String - Name of the specific Catalog

3. token String - Autogenerated token on startup of Basestack

4. procedure - Int - Index of the procedure for the module. Comprises 1 or more services

Returns

Status - Success or Error on cancelation of the procedure (1 or more service )

---