Find a guide, feature, or API endpoint. Try “FTP”, “alerts”, or “instruments”.

Browse documentation

Docs/API reference / Ingested variables

Restore ingested variables

Requires `developer_api.ingested_variables.restore` on the project-scoped Developer API connection. Use the API origin supplied for your deployment. Unknown query parameters and unexpected request bodies are rejected.

POST/dev-api/v1/p/{project_id}/instruments/{instrument_id}/ingested-variables/{variable_id}/restoreAll endpoints ↗

The request panel saves credentials and API settings in this browser. Privacy details

POST
/dev-api/v1/p/{project_id}/instruments/{instrument_id}/ingested-variables/{variable_id}/restore

Authorization

developerApiKey
AuthorizationBearer <token>

Project-scoped Developer API connection key. Grant only the required operation permissions.

In: header

Path Parameters

project_id*string
Match.*\S.*
Length1 <= length <= 128
instrument_id*string
Match.*\S.*
Length1 <= length <= 128
variable_id*string
Match.*\S.*
Length1 <= length <= 128

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

bash
curl -X POST "https://example.com/dev-api/v1/p/string/instruments/string/ingested-variables/string/restore"
json
{
  "request_id": "string",
  "data": {
    "lifecycle_state": "active",
    "archived_at": "2019-08-24T14:15:22Z",
    "archived_by": {
      "type": "user",
      "id": "string"
    },
    "id": "string",
    "instrument_id": "string",
    "name": "string",
    "alias": "string",
    "variable_type": "ingested",
    "unit": "cm",
    "expected_cadence_s": 1,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "value_type": "string",
    "view_options": {
      "hide": true,
      "graph": {
        "scale": {
          "min": 0,
          "max": 0,
          "interval": 1,
          "custom": false
        }
      }
    }
  }
}