Usage notes

Handles

For each Globus service listed on this page, the name of the route is listed next to the handle URN that can be used in a flow.

The handles can be used in a flow state like this:

{
  "ExampleState": {
    "Type": "Action",
    "Handler": "urn:globus:flows:handle:globus:<SERVICE_NAME>.<API_ROUTE_NAME>",
    "Parameters": {},
    "ResultPath": "$.<RESULT_PATH>",
    "Next": "<NEXT_STATE>"
  }
}

(Note that the JSON above is a fragment that would appear in the States object.)

Parameters

Some APIs require input parameters. By default, registered APIs nest input parameters under top-level names that indicate where in the request the parameter should be placed.

For example, the Globus Groups "Get Group" API route listed below requires a mandatory group_id path parameter and accepts an optional include query parameter. This would typically be passed in the flow’s state’s Parameters like this:

{
  "Parameters": {
    "path": {
      "group_id": "YOUR_GROUP_ID"
    },
    "query": {
      "include": [
        "my_memberships"
      ]
    }
  }
}

However, all the registered APIs listed below have had their input parameters flattened. In effect, all the parameters have been mingled together. they do not require parameters to be nested under top-level keys like path or query as shown above. This means that the "Get Group" API example shown above must actually look like this:

{
  "group_id": "YOUR_GROUP_ID",
  "include": [
    "my_memberships"
  ]
}