Skip to main content
PUT
/
process
cURL
curl --request PUT \
  --url http://sandbox.batuenergy.com/api/v1/process \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "prc_<uuid>",
  "integration": "int_<uuid>",
  "metric": "mtc_<uuid>",
  "formula": "[NODE 1] * 1000",
  "keys": [
    "NODE 1"
  ],
  "metadata": "<string>"
}
'
{
  "status": "success",
  "data": {
    "execution": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "process": {
      "id": "<uuid>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "integration": "int_<uuid>",
      "metric": "mtc_<uuid>",
      "formula": "[NODE 1] * 1000",
      "keys": [
        "NODE 1"
      ],
      "metadata": "<string>"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
id
string<uuid>
required

The id of the process

Example:

"prc_<uuid>"

​
integration
string<uuid>

The id of the integration associated with the process

Example:

"int_<uuid>"

​
metric
string<uuid>

The id of the metric associated with the process

Example:

"mtc_<uuid>"

​
formula
string

The string representation of the formula used to generate the data by the process

Example:

"[NODE 1] * 1000"

​
keys
string[]

Array of keys used in the formula, as represented in the datasource to be processed.

​
metadata
string | null

The metadata associated with the process

Response

Process response

​
status
string
required

Indicates the request was successful

Example:

"success"

​
data
object
required

The data associated with the response