NAV Navbar
Shell HTTP JavaScript Node.JS Ruby Python Java
  • Cognite API v0.4
  • Authentication
  • ApiKeys
  • Assets
  • Events
  • Event Transformer
  • Extraction
  • Groups
  • Login
  • Logout
  • Pipelines
  • Projects
  • Raw
  • Security categories
  • Semantic Types
  • Similarity Search
  • Cloud Storage
  • Tag Matching
  • 3D
  • Time series
  • Access Token
  • Users
  • Schemas
  • Cognite API v0.4

    Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

    This is the reference documentation for the Cognite API. Here you can see an overview of all methods available through the API. We also offer an API guide, which is more useful as a first introduction.

    Base URLs:

    Authentication

    ApiKeys

    Manage api keys for a specific project.

    getApiKeys

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/api/0.4/projects/{project}/apikeys \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/api/0.4/projects/{project}/apikeys HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/apikeys',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/apikeys',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.cognitedata.com/api/0.4/projects/{project}/apikeys',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.cognitedata.com/api/0.4/projects/{project}/apikeys', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/apikeys");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /api/0.4/projects/{project}/apikeys

    Get list of api keys.

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    all query boolean false Whether to get api keys for all users, only available to admin users. N/A
    userId query integer(int64) false Get api keys for a specific user, only available to admin users. N/A
    includeDeleted query boolean false Whether to include deleted api keys N/A

    Example responses

    {
      "data": {
        "items": [
          null
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK A list of api keys. ApiKeyResponse

    createApiKeys

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/apikeys \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/apikeys HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/apikeys',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "items": [
        {
          "userId": 0
        }
      ]
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/apikeys',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/apikeys',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/apikeys', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/apikeys");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/apikeys

    Create new api keys.

    Body parameter

    {
      "items": [
        {
          "userId": 0
        }
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    body body DataApiKeyRequest true List of api keys to create. N/A

    Example responses

    {
      "data": {
        "items": [
          null
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK A list of the created api keys. NewApiKeyResponse

    deleteApiKeys

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/apikeys/delete \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/apikeys/delete HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/apikeys/delete',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "items": [
        0
      ]
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/apikeys/delete',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/apikeys/delete',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/apikeys/delete', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/apikeys/delete");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/apikeys/delete

    Delete api keys.

    Body parameter

    {
      "items": [
        0
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    body body DataLong true List of ids of api keys to delete. N/A

    Example responses

    {}
    

    Responses

    Status Meaning Description Schema
    200 OK Empty response. EmptyResponse

    Assets

    Endpoint for managing assets

    getAssets

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/api/0.4/projects/{project}/assets \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/api/0.4/projects/{project}/assets HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/assets',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/assets',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.cognitedata.com/api/0.4/projects/{project}/assets',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.cognitedata.com/api/0.4/projects/{project}/assets', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/assets");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /api/0.4/projects/{project}/assets

    Returns a list of assets in lexicographic order

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    name query string false The name of the asset(s) to get. N/A
    fuzziness query integer(int32) false The degree of fuzziness in the name matching N/A
    path query string false The path of the subtree to search in. N/A
    depth query integer(int32) false Get sub assets up to this many levels below the specified path. N/A
    metadata query string false The metadata values used to filter the results N/A
    description query string false Only return assets that contain this description N/A
    cursor query string false Cursor to use for paging through results N/A
    limit query integer(int32) false The maximum number of assets to be returned. N/A

    Example responses

    {
      "data": {
        "items": [
          {
            "name": "string",
            "parentId": 0,
            "description": "string",
            "metadata": {},
            "id": 0,
            "path": [
              0
            ]
          }
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK A list of assets in lexicographic order. AssetDataWithCursorResponse

    putAssets

    Code samples

    # You can also use wget
    curl -X PUT https://api.cognitedata.com/api/0.4/projects/{project}/assets \
      -H 'Content-Type: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    PUT https://api.cognitedata.com/api/0.4/projects/{project}/assets HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/assets',
      method: 'put',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "items": [
        {
          "name": "string",
          "parentId": 0,
          "description": "string",
          "metadata": {},
          "id": 0,
          "path": [
            0
          ]
        }
      ]
    }';
    const headers = {
      'Content-Type':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/assets',
    {
      method: 'PUT',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json'
    }
    
    
    result = RestClient.put 'https://api.cognitedata.com/api/0.4/projects/{project}/assets',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json'
    }
    
    
    r = requests.put('https://api.cognitedata.com/api/0.4/projects/{project}/assets', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/assets");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("PUT");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    PUT /api/0.4/projects/{project}/assets

    Update a list of assets

    Body parameter

    {
      "items": [
        {
          "name": "string",
          "parentId": 0,
          "description": "string",
          "metadata": {},
          "id": 0,
          "path": [
            0
          ]
        }
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    body body DataGetAssetDTO false List of assets to update N/A

    Responses

    Status Meaning Description Schema
    default Default default response None

    postAssets

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/assets \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/assets HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/assets',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "items": [
        {
          "name": "string",
          "parentId": 0,
          "description": "string",
          "metadata": {},
          "refId": "string",
          "parentName": "string",
          "parentRefId": "string"
        }
      ]
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/assets',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/assets',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/assets', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/assets");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/assets

    Create new assets

    Body parameter

    {
      "items": [
        {
          "name": "string",
          "parentId": 0,
          "description": "string",
          "metadata": {},
          "refId": "string",
          "parentName": "string",
          "parentRefId": "string"
        }
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    body body DataPostAssetDTO false List of assets to create N/A

    Example responses

    {
      "data": {
        "items": [
          {
            "name": "string",
            "parentId": 0,
            "description": "string",
            "metadata": {},
            "id": 0,
            "path": [
              0
            ]
          }
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK A list of the posted assets. AssetDataResponse

    getAssetSubtree

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/api/0.4/projects/{project}/assets/{assetId} \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/api/0.4/projects/{project}/assets/{assetId} HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/assets/{assetId}',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/assets/{assetId}',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.cognitedata.com/api/0.4/projects/{project}/assets/{assetId}',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.cognitedata.com/api/0.4/projects/{project}/assets/{assetId}', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/assets/{assetId}");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /api/0.4/projects/{project}/assets/{assetId}

    Returns a list of assets in breadth first order

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    assetId path integer(int64) true No description N/A
    depth query integer(int32) false Get sub assets up to this many levels below the specified asset. N/A
    cursor query string false Cursor to use for paging through results N/A
    limit query integer(int32) false The maximum number of assets to be returned. N/A

    Example responses

    {
      "data": {
        "items": [
          {
            "name": "string",
            "parentId": 0,
            "description": "string",
            "metadata": {},
            "id": 0,
            "path": [
              0
            ]
          }
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK A list of assets in breadth first order. AssetDataWithCursorResponse

    deleteAssets

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/assets/delete \
      -H 'Content-Type: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/assets/delete HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/assets/delete',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "items": [
        0
      ]
    }';
    const headers = {
      'Content-Type':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/assets/delete',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/assets/delete',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/assets/delete', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/assets/delete");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/assets/delete

    Delete sub-trees of assets identified by root node ID

    Body parameter

    {
      "items": [
        0
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    body body DataLong false List of IDs of assets to delete N/A

    Responses

    Status Meaning Description Schema
    default Default default response None

    Events

    Manage events. An event can contain multiple semantic phrases. The maximum number of phrases supported for each event is 5000.

    getEvent

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/api/0.4/projects/{project}/events/{eventId} \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/api/0.4/projects/{project}/events/{eventId} HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/events/{eventId}',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/events/{eventId}',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.cognitedata.com/api/0.4/projects/{project}/events/{eventId}',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.cognitedata.com/api/0.4/projects/{project}/events/{eventId}', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/events/{eventId}");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /api/0.4/projects/{project}/events/{eventId}

    Get an event by its id.

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    eventId path integer(int64) true The event ID. N/A

    Example responses

    {
      "data": {
        "id": 0,
        "startTime": 0,
        "endTime": 0,
        "description": "string",
        "type": "string",
        "subtype": "string",
        "additionalData": {
          "property1": "string",
          "property2": "string"
        },
        "tagIds": [
          "string"
        ],
        "semanticPhrases": [
          {
            "id": 0,
            "startIndex": 0,
            "endIndex": 0,
            "semanticTypeId": 0,
            "sourceType": "MANUALLY_GENERATED"
          }
        ],
        "eventTransformerId": 0,
        "eventReferenceKey": "string"
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Event matching the id. SingleEventDataResponse

    getEvents

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/api/0.4/projects/{project}/events \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/api/0.4/projects/{project}/events HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/events',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/events',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.cognitedata.com/api/0.4/projects/{project}/events',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.cognitedata.com/api/0.4/projects/{project}/events', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/events");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /api/0.4/projects/{project}/events

    Get list of events matching the query.

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    type query string false Type (class) of event, e.g 'failure'. N/A
    subtype query string false Sub-type of event, e.g 'electrical'. N/A
    tagId query string false Return events associated with this tagId. N/A
    sort query string false Sort descending or ascending. Default 'ASC'. N/A
    cursor query string false Cursor to use for paging through results. N/A
    limit query integer(int32) false Return up to this many results. Maximum is 10000. Default is 25. Max: 10000
    withPhrases query boolean false Also return semantic phrases. Default false. N/A
    withAllPhrases query boolean false Also return semantic phrases, including ones confirmed as false positives. Default false. N/A
    hasDescription query boolean false Return only events that have a textual description. Default null. False gives only those without description. N/A
    minStartTime query string false Only return events from after this time. N/A
    maxStartTime query string false Only return events from before this time. N/A
    transformerId query string false Returns only events generated by this transformerId. N/A

    Example responses

    {
      "data": {
        "items": [
          {
            "id": 0,
            "startTime": 0,
            "endTime": 0,
            "description": "string",
            "type": "string",
            "subtype": "string",
            "additionalData": {
              "property1": "string",
              "property2": "string"
            },
            "tagIds": [
              "string"
            ],
            "semanticPhrases": [
              {}
            ],
            "eventTransformerId": 0,
            "eventReferenceKey": "string"
          }
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Events matching the query. EventDataWithCursorResponse

    postEvents

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/events \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/events HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/events',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "items": [
        {
          "id": 0,
          "startTime": 0,
          "endTime": 0,
          "description": "string",
          "type": "string",
          "subtype": "string",
          "additionalData": {
            "property1": "string",
            "property2": "string"
          },
          "tagIds": [
            "string"
          ],
          "semanticPhrases": [
            {
              "id": 0,
              "startIndex": 0,
              "endIndex": 0,
              "semanticTypeId": 0,
              "sourceType": "MANUALLY_GENERATED"
            }
          ],
          "eventTransformerId": 0,
          "eventReferenceKey": "string"
        }
      ]
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/events',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/events',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/events', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/events");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/events

    Create new events.

    Body parameter

    {
      "items": [
        {
          "id": 0,
          "startTime": 0,
          "endTime": 0,
          "description": "string",
          "type": "string",
          "subtype": "string",
          "additionalData": {
            "property1": "string",
            "property2": "string"
          },
          "tagIds": [
            "string"
          ],
          "semanticPhrases": [
            {
              "id": 0,
              "startIndex": 0,
              "endIndex": 0,
              "semanticTypeId": 0,
              "sourceType": "MANUALLY_GENERATED"
            }
          ],
          "eventTransformerId": 0,
          "eventReferenceKey": "string"
        }
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    body body DataEvent true List of events to be posted. N/A

    Example responses

    {
      "data": {
        "items": [
          {
            "id": 0,
            "startTime": 0,
            "endTime": 0,
            "description": "string",
            "type": "string",
            "subtype": "string",
            "additionalData": {
              "property1": "string",
              "property2": "string"
            },
            "tagIds": [
              "string"
            ],
            "semanticPhrases": [
              {}
            ],
            "eventTransformerId": 0,
            "eventReferenceKey": "string"
          }
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK The events that were created. EventDataResponse

    updateEvents

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/events/update \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/events/update HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/events/update',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "items": [
        {
          "id": 0,
          "startTime": 0,
          "endTime": 0,
          "description": "string",
          "type": "string",
          "subtype": "string",
          "additionalData": {
            "property1": "string",
            "property2": "string"
          },
          "tagIds": [
            "string"
          ],
          "semanticPhrases": [
            {
              "id": 0,
              "startIndex": 0,
              "endIndex": 0,
              "semanticTypeId": 0,
              "sourceType": "MANUALLY_GENERATED"
            }
          ],
          "eventTransformerId": 0,
          "eventReferenceKey": "string"
        }
      ]
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/events/update',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/events/update',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/events/update', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/events/update");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/events/update

    Update events.

    Body parameter

    {
      "items": [
        {
          "id": 0,
          "startTime": 0,
          "endTime": 0,
          "description": "string",
          "type": "string",
          "subtype": "string",
          "additionalData": {
            "property1": "string",
            "property2": "string"
          },
          "tagIds": [
            "string"
          ],
          "semanticPhrases": [
            {
              "id": 0,
              "startIndex": 0,
              "endIndex": 0,
              "semanticTypeId": 0,
              "sourceType": "MANUALLY_GENERATED"
            }
          ],
          "eventTransformerId": 0,
          "eventReferenceKey": "string"
        }
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    body body DataEvent true List of events to be updated. N/A

    Example responses

    {}
    

    Responses

    Status Meaning Description Schema
    200 OK Empty response. EmptyResponse

    deleteEvents

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/events/delete \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/events/delete HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/events/delete',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "items": [
        0
      ]
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/events/delete',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/events/delete',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/events/delete', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/events/delete");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/events/delete

    Deletes a list of events.

    Body parameter

    {
      "items": [
        0
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    body body DataLong true List of event IDs for the events to be deleted. N/A

    Example responses

    {}
    

    Responses

    Status Meaning Description Schema
    200 OK Empty response. EmptyResponse

    byReference

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/events/byreference \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/events/byreference HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/events/byreference',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "transformerId": 0,
      "eventReferenceKeys": [
        "string"
      ]
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/events/byreference',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/events/byreference',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/events/byreference', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/events/byreference");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/events/byreference

    Gets events matching the transformerId and one of the eventReferenceKeys.

    Body parameter

    {
      "transformerId": 0,
      "eventReferenceKeys": [
        "string"
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    body body TransformerIdAndEventReferenceKeys true Object containing the transformer ID and a list of reference keys. N/A

    Example responses

    {
      "data": {
        "items": [
          {
            "id": 0,
            "startTime": 0,
            "endTime": 0,
            "description": "string",
            "type": "string",
            "subtype": "string",
            "additionalData": {
              "property1": "string",
              "property2": "string"
            },
            "tagIds": [
              "string"
            ],
            "semanticPhrases": [
              {}
            ],
            "eventTransformerId": 0,
            "eventReferenceKey": "string"
          }
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Events matching the transformerId and one of the eventReferenceKeys. EventDataResponse

    deleteEventsByTransformer

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/events/deletebytransformer \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/events/deletebytransformer HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/events/deletebytransformer',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "items": [
        0
      ]
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/events/deletebytransformer',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/events/deletebytransformer',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/events/deletebytransformer', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/events/deletebytransformer");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/events/deletebytransformer

    Deletes all events generated by these transformer.

    Body parameter

    {
      "items": [
        0
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    body body DataLong true List of event transformers' IDs to delete on. N/A

    Example responses

    {}
    

    Responses

    Status Meaning Description Schema
    200 OK Empty response. EmptyResponse

    postSemanticPhrases

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/events/semanticphrases \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/events/semanticphrases HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/events/semanticphrases',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "items": [
        {
          "id": 0,
          "startTime": 0,
          "endTime": 0,
          "description": "string",
          "type": "string",
          "subtype": "string",
          "additionalData": {
            "property1": "string",
            "property2": "string"
          },
          "tagIds": [
            "string"
          ],
          "semanticPhrases": [
            {
              "id": 0,
              "startIndex": 0,
              "endIndex": 0,
              "semanticTypeId": 0,
              "sourceType": "MANUALLY_GENERATED"
            }
          ],
          "eventTransformerId": 0,
          "eventReferenceKey": "string"
        }
      ]
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/events/semanticphrases',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/events/semanticphrases',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/events/semanticphrases', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/events/semanticphrases");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/events/semanticphrases

    Create new semantic phrases. Maximum number of phrases allowed per event is 5000.

    Body parameter

    {
      "items": [
        {
          "id": 0,
          "startTime": 0,
          "endTime": 0,
          "description": "string",
          "type": "string",
          "subtype": "string",
          "additionalData": {
            "property1": "string",
            "property2": "string"
          },
          "tagIds": [
            "string"
          ],
          "semanticPhrases": [
            {
              "id": 0,
              "startIndex": 0,
              "endIndex": 0,
              "semanticTypeId": 0,
              "sourceType": "MANUALLY_GENERATED"
            }
          ],
          "eventTransformerId": 0,
          "eventReferenceKey": "string"
        }
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    body body DataEvent true The semantic phrases to be created. N/A

    Example responses

    {
      "data": {
        "items": [
          {
            "id": 0,
            "startTime": 0,
            "endTime": 0,
            "description": "string",
            "type": "string",
            "subtype": "string",
            "additionalData": {
              "property1": "string",
              "property2": "string"
            },
            "tagIds": [
              "string"
            ],
            "semanticPhrases": [
              {}
            ],
            "eventTransformerId": 0,
            "eventReferenceKey": "string"
          }
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK The semantic phrases that were created. EventDataResponse

    putSemanticPhrase

    Code samples

    # You can also use wget
    curl -X PUT https://api.cognitedata.com/api/0.4/projects/{project}/events/{eventId}/semanticphrases/{semanticPhraseId} \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    PUT https://api.cognitedata.com/api/0.4/projects/{project}/events/{eventId}/semanticphrases/{semanticPhraseId} HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/events/{eventId}/semanticphrases/{semanticPhraseId}',
      method: 'put',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "id": 0,
      "startIndex": 0,
      "endIndex": 0,
      "semanticTypeId": 0,
      "sourceType": "MANUALLY_GENERATED"
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/events/{eventId}/semanticphrases/{semanticPhraseId}',
    {
      method: 'PUT',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.put 'https://api.cognitedata.com/api/0.4/projects/{project}/events/{eventId}/semanticphrases/{semanticPhraseId}',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.put('https://api.cognitedata.com/api/0.4/projects/{project}/events/{eventId}/semanticphrases/{semanticPhraseId}', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/events/{eventId}/semanticphrases/{semanticPhraseId}");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("PUT");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    PUT /api/0.4/projects/{project}/events/{eventId}/semanticphrases/{semanticPhraseId}

    Update a semantic phrase.

    Body parameter

    {
      "id": 0,
      "startIndex": 0,
      "endIndex": 0,
      "semanticTypeId": 0,
      "sourceType": "MANUALLY_GENERATED"
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    eventId path integer(int64) true The event ID for the phrase to be updated. N/A
    semanticPhraseId path integer(int64) true The ID of the semantic phrase to be updated. N/A
    body body SemanticPhrase true The semantic phrase to be updated. N/A

    Example responses

    {}
    

    Responses

    Status Meaning Description Schema
    200 OK Empty response. EmptyResponse

    deleteSemanticPhrase

    Code samples

    # You can also use wget
    curl -X DELETE https://api.cognitedata.com/api/0.4/projects/{project}/events/{eventId}/semanticphrases/{semanticPhraseId} \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    DELETE https://api.cognitedata.com/api/0.4/projects/{project}/events/{eventId}/semanticphrases/{semanticPhraseId} HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/events/{eventId}/semanticphrases/{semanticPhraseId}',
      method: 'delete',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/events/{eventId}/semanticphrases/{semanticPhraseId}',
    {
      method: 'DELETE',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.delete 'https://api.cognitedata.com/api/0.4/projects/{project}/events/{eventId}/semanticphrases/{semanticPhraseId}',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.delete('https://api.cognitedata.com/api/0.4/projects/{project}/events/{eventId}/semanticphrases/{semanticPhraseId}', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/events/{eventId}/semanticphrases/{semanticPhraseId}");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("DELETE");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    DELETE /api/0.4/projects/{project}/events/{eventId}/semanticphrases/{semanticPhraseId}

    Delete a semantic phrase.

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    eventId path integer(int64) true The event ID for the phrase to be deleted. N/A
    semanticPhraseId path integer(int64) true The ID of the semantic phrase to be deleted. N/A

    Example responses

    {}
    

    Responses

    Status Meaning Description Schema
    200 OK Empty response. EmptyResponse

    Event Transformer

    Manage event transformers for a specific project. An event transformer is a representative for a process, a pipeline or an entity that generates events from raw data.

    getEventTransformers

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/api/0.4/projects/{project}/eventtransformers \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/api/0.4/projects/{project}/eventtransformers HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/eventtransformers',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/eventtransformers',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.cognitedata.com/api/0.4/projects/{project}/eventtransformers',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.cognitedata.com/api/0.4/projects/{project}/eventtransformers', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/eventtransformers");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /api/0.4/projects/{project}/eventtransformers

    Get list of all the event transformer in current project.

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A

    Example responses

    {
      "data": {
        "items": [
          {
            "id": 0,
            "name": "string",
            "description": "string"
          }
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK A list of all event transformers in the current project. EventTransformerResponse

    postTransformers

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/eventtransformers \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/eventtransformers HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/eventtransformers',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "items": [
        {
          "id": 0,
          "name": "string",
          "description": "string"
        }
      ]
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/eventtransformers',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/eventtransformers',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/eventtransformers', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/eventtransformers");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/eventtransformers

    Create new event transformers.

    Body parameter

    {
      "items": [
        {
          "id": 0,
          "name": "string",
          "description": "string"
        }
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    body body DataEventTransformer true List of the event transformers to create. N/A

    Example responses

    {
      "data": {
        "items": [
          {
            "id": 0,
            "name": "string",
            "description": "string"
          }
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK The event transformers that were created. EventTransformerResponse

    putEventTransformer

    Code samples

    # You can also use wget
    curl -X PUT https://api.cognitedata.com/api/0.4/projects/{project}/eventtransformers/{transformerId} \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    PUT https://api.cognitedata.com/api/0.4/projects/{project}/eventtransformers/{transformerId} HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/eventtransformers/{transformerId}',
      method: 'put',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "id": 0,
      "name": "string",
      "description": "string"
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/eventtransformers/{transformerId}',
    {
      method: 'PUT',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.put 'https://api.cognitedata.com/api/0.4/projects/{project}/eventtransformers/{transformerId}',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.put('https://api.cognitedata.com/api/0.4/projects/{project}/eventtransformers/{transformerId}', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/eventtransformers/{transformerId}");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("PUT");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    PUT /api/0.4/projects/{project}/eventtransformers/{transformerId}

    Update an event transformer.

    Body parameter

    {
      "id": 0,
      "name": "string",
      "description": "string"
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    transformerId path integer(int64) true The ID of the transformer to be updated. N/A
    body body EventTransformer true The updated event transformer. N/A

    Example responses

    {}
    

    Responses

    Status Meaning Description Schema
    200 OK Empty response. EmptyResponse

    deleteEventTransformers

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/eventtransformers/delete \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/eventtransformers/delete HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/eventtransformers/delete',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "items": [
        0
      ]
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/eventtransformers/delete',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/eventtransformers/delete',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/eventtransformers/delete', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/eventtransformers/delete");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/eventtransformers/delete

    Delete event transformers.

    Body parameter

    {
      "items": [
        0
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    body body DataLong true List of IDs of the transformers to delete. N/A

    Example responses

    {}
    

    Responses

    Status Meaning Description Schema
    200 OK Empty response. EmptyResponse

    Extraction

    Endpoint for managing data extraction. NOTE: This API is experimental and NOT intended for use in production!

    getExtractedRanges

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/extraction/ranges/get \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/extraction/ranges/get HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/extraction/ranges/get',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "items": [
        "string"
      ]
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/extraction/ranges/get',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/extraction/ranges/get',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/extraction/ranges/get', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/extraction/ranges/get");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/extraction/ranges/get

    Returns a list of extracted ranges for a list of time series.

    Body parameter

    {
      "items": [
        "string"
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    body body DataString false The list of tags belonging to the extracted ranges. N/A

    Example responses

    {
      "items": [
        {
          "tagId": "string",
          "start": 0,
          "end": 0
        }
      ]
    }
    

    Responses

    Status Meaning Description Schema
    200 OK A list of extracted ranges for the time series. RangeResponse

    updateExtractedRanges

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/extraction/ranges/update \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/extraction/ranges/update HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/extraction/ranges/update',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "items": [
        {
          "tagId": "string",
          "start": 0,
          "end": 0
        }
      ]
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/extraction/ranges/update',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/extraction/ranges/update',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/extraction/ranges/update', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/extraction/ranges/update");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/extraction/ranges/update

    Updates a set of extracted ranges for a list of time series. Throws an exception if there is a gap between the old extracted range for a time series and the range which is added to it.

    Body parameter

    {
      "items": [
        {
          "tagId": "string",
          "start": 0,
          "end": 0
        }
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    body body DataExtractedRange false Extracted ranges to update the stored extracted ranges. N/A

    Example responses

    {}
    

    Responses

    Status Meaning Description Schema
    200 OK Empty response. EmptyResponse

    getTagExtractingRequests

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/api/0.4/projects/{project}/extraction/request \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/api/0.4/projects/{project}/extraction/request HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/extraction/request',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/extraction/request',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.cognitedata.com/api/0.4/projects/{project}/extraction/request',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.cognitedata.com/api/0.4/projects/{project}/extraction/request', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/extraction/request");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /api/0.4/projects/{project}/extraction/request

    Query which tags are requested.

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    status query string false Currently not in use. N/A
    limit query integer(int32) false Limit on the number of requests to be returned. N/A
    before query string false Currently not in use. N/A
    after query string false Currently not in use. N/A

    Example responses

    {
      "tagId": "string",
      "status": "string",
      "lastUpdatedMillis": 0
    }
    

    Responses

    Status Meaning Description Schema
    200 OK The requested tags. ExtractionRequest

    requestExtractingTags

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/extraction/request \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/extraction/request HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/extraction/request',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "items": [
        {
          "tagId": "string",
          "status": "string",
          "lastUpdatedMillis": 0
        }
      ]
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/extraction/request',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/extraction/request',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/extraction/request', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/extraction/request");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/extraction/request

    Request tags to be extracted.

    Body parameter

    {
      "items": [
        {
          "tagId": "string",
          "status": "string",
          "lastUpdatedMillis": 0
        }
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    body body DataExtractionRequest false List of tags to time series to request extraction from. N/A

    Example responses

    {}
    

    Responses

    Status Meaning Description Schema
    200 OK Empty response. EmptyResponse

    Groups

    Manage security groups specific project.

    getGroups

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/api/0.4/projects/{project}/groups \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/api/0.4/projects/{project}/groups HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/groups',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/groups',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.cognitedata.com/api/0.4/projects/{project}/groups',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.cognitedata.com/api/0.4/projects/{project}/groups', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/groups");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /api/0.4/projects/{project}/groups

    Get list of security groups.

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    all query boolean false Whether to get all groups, only available to admin users. N/A

    Example responses

    {
      "data": {
        "items": [
          {
            "name": "string",
            "permissions": {
              "accessTypes": [],
              "assetIds": [],
              "securityCategoryIds": []
            },
            "id": 0
          }
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK A list of security groups. GroupResponse

    createGroups

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/groups \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/groups HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/groups',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "items": [
        {
          "name": "string",
          "permissions": {
            "accessTypes": [
              "READ"
            ],
            "assetIds": [
              0
            ],
            "securityCategoryIds": [
              0
            ]
          }
        }
      ]
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/groups',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/groups',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/groups', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/groups");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/groups

    Create new groups.

    Body parameter

    {
      "items": [
        {
          "name": "string",
          "permissions": {
            "accessTypes": [
              "READ"
            ],
            "assetIds": [
              0
            ],
            "securityCategoryIds": [
              0
            ]
          }
        }
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    body body DataGroupSpec true List of groups to create. N/A

    Example responses

    {
      "data": {
        "items": [
          {
            "name": "string",
            "permissions": {
              "accessTypes": [],
              "assetIds": [],
              "securityCategoryIds": []
            },
            "id": 0
          }
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK A list of the created groups. GroupResponse

    getUsersForGroup

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/api/0.4/projects/{project}/groups/{groupId}/users \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/api/0.4/projects/{project}/groups/{groupId}/users HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/groups/{groupId}/users',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/groups/{groupId}/users',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.cognitedata.com/api/0.4/projects/{project}/groups/{groupId}/users',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.cognitedata.com/api/0.4/projects/{project}/groups/{groupId}/users', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/groups/{groupId}/users");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /api/0.4/projects/{project}/groups/{groupId}/users

    Get list of users for a security group.

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    groupId path integer(int64) true No description N/A

    Example responses

    {
      "data": {
        "items": [
          {
            "uniqueName": "string",
            "groups": [
              0
            ],
            "id": 0,
            "deletedTime": 0,
            "deleted": true
          }
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK A list of users. UserResponse

    addUsersToGroup

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/groups/{groupId}/users \
      -H 'Content-Type: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/groups/{groupId}/users HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/groups/{groupId}/users',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "items": [
        {
          "id": 0
        }
      ]
    }';
    const headers = {
      'Content-Type':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/groups/{groupId}/users',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/groups/{groupId}/users',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/groups/{groupId}/users', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/groups/{groupId}/users");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/groups/{groupId}/users

    Add list of users to a security group.

    Body parameter

    {
      "items": [
        {
          "id": 0
        }
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    groupId path integer(int64) true No description N/A
    body body DataUserId true List of users to add N/A

    Responses

    Status Meaning Description Schema
    default Default default response None

    deleteGroups

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/groups/delete \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/groups/delete HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/groups/delete',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "items": [
        0
      ]
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/groups/delete',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/groups/delete',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/groups/delete', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/groups/delete");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/groups/delete

    Delete groups.

    Body parameter

    {
      "items": [
        0
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    body body DataLong true List of group ids to delete N/A

    Example responses

    {}
    

    Responses

    Status Meaning Description Schema
    200 OK Empty response. EmptyResponse

    removeUsersFromGroup

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/groups/{groupId}/users/remove \
      -H 'Content-Type: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/groups/{groupId}/users/remove HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/groups/{groupId}/users/remove',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "items": [
        0
      ]
    }';
    const headers = {
      'Content-Type':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/groups/{groupId}/users/remove',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/groups/{groupId}/users/remove',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/groups/{groupId}/users/remove', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/groups/{groupId}/users/remove");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/groups/{groupId}/users/remove

    Remove list of users from a security group.

    Body parameter

    {
      "items": [
        0
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    groupId path integer(int64) true No description N/A
    body body DataLong true List of user ids to remove N/A

    Responses

    Status Meaning Description Schema
    200 OK Empty response. None

    Login

    User / client authentication.

    login

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/login \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/login HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/login',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "apiKey": "string"
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/login',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/login',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/login', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/login");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /login

    Post credentials to log in.

    Body parameter

    {
      "apiKey": "string"
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    body body LoginRequest false The login request. N/A

    Example responses

    {
      "data": {
        "user": "string",
        "loggedIn": true
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Login status. LoginStatusResponse

    status

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/login/status \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/login/status HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/login/status',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/login/status',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.cognitedata.com/login/status',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.cognitedata.com/login/status', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/login/status");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /login/status

    Check whether you are logged in.

    Example responses

    {
      "data": {
        "user": "string",
        "loggedIn": true
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Login status. LoginStatusResponse

    url

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/login/url \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/login/url HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/login/url',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/login/url',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.cognitedata.com/login/url',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.cognitedata.com/login/url', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/login/url");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /login/url

    Get login url of given project.

    Parameters

    Parameter In Type Required Description Restrictions
    project query string false The project to login to. N/A
    redirectUrl query string false The url to send the user to after the login is successful. N/A
    errorRedirectUrl query string false The url to send the user to if the login fails or is aborted. N/A

    Example responses

    {
      "data": {
        "url": "string"
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Login URL. LoginUrlResponse

    getTokenStatus

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/login/token \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/login/token HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/login/token',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/login/token',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.cognitedata.com/login/token',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.cognitedata.com/login/token', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/login/token");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /login/token

    Checks whether a JWT is valid.

    Parameters

    Parameter In Type Required Description Restrictions
    token query string false No description N/A

    Example responses

    {
      "data": {
        "token": "string",
        "valid": true,
        "expired": true
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Returns information on whether the token is valid. SingleTokenStatusDTOResponse

    Logout

    User / client session invalidation.

    logout

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/logout \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/logout HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/logout',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/logout',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.cognitedata.com/logout',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.cognitedata.com/logout', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/logout");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /logout

    Invalidates session.

    Example responses

    {
      "data": {
        "user": "string",
        "loggedIn": true
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Session invalidated. LoginStatusResponse

    logoutUrl

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/logout/url \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/logout/url HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/logout/url',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/logout/url',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.cognitedata.com/logout/url',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.cognitedata.com/logout/url', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/logout/url");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /logout/url

    Get logout url of the given project.

    Parameters

    Parameter In Type Required Description Restrictions
    redirectUrl query string false The url to send the user to after the logout is successful. N/A

    Example responses

    {
      "data": {
        "url": "string"
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Logout URL. LoginUrlResponse

    Pipelines

    Manage ingestion pipelines. The pipelines API is currently in experimental alpha

    getPipelines

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/api/0.4/projects/{project}/pipelines \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/api/0.4/projects/{project}/pipelines HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/pipelines',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/pipelines',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.cognitedata.com/api/0.4/projects/{project}/pipelines',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.cognitedata.com/api/0.4/projects/{project}/pipelines', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/pipelines");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /api/0.4/projects/{project}/pipelines

    Get list of pipelines

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    cursor query string false No description N/A
    limit query integer(int32) false Return up to this many results. Maximum is 100. Default is 25. Max: 100

    Example responses

    {
      "data": {
        "items": [
          {
            "name": "string",
            "type": "string",
            "tables": [
              {}
            ],
            "id": 0,
            "status": "PENDING",
            "updatedTime": 0
          }
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK List of Pipeline objects PipelinesResponse

    createPipelines

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/pipelines \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/pipelines HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/pipelines',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "items": [
        {
          "name": "string",
          "type": "string",
          "tables": [
            {
              "dbName": "string",
              "tableName": "string"
            }
          ]
        }
      ]
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/pipelines',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/pipelines',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/pipelines', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/pipelines");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/pipelines

    Create new pipelines

    Body parameter

    {
      "items": [
        {
          "name": "string",
          "type": "string",
          "tables": [
            {
              "dbName": "string",
              "tableName": "string"
            }
          ]
        }
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    body body DataPipeline true List of pipelines to be created. N/A

    Example responses

    {
      "data": {
        "items": [
          {
            "name": "string",
            "type": "string",
            "tables": [
              {}
            ],
            "id": 0,
            "status": "PENDING",
            "updatedTime": 0
          }
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK List of Pipeline objects created PipelinesResponse

    getPipeline

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/api/0.4/projects/{project}/pipelines/{pipelineId} \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/api/0.4/projects/{project}/pipelines/{pipelineId} HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/pipelines/{pipelineId}',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/pipelines/{pipelineId}',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.cognitedata.com/api/0.4/projects/{project}/pipelines/{pipelineId}',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.cognitedata.com/api/0.4/projects/{project}/pipelines/{pipelineId}', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/pipelines/{pipelineId}");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /api/0.4/projects/{project}/pipelines/{pipelineId}

    Get pipeline from id

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    pipelineId path integer(int64) true No description N/A

    Example responses

    {
      "data": {
        "items": [
          {
            "name": "string",
            "type": "string",
            "tables": [
              {}
            ],
            "id": 0,
            "status": "PENDING",
            "updatedTime": 0
          }
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Pipeline object PipelinesResponse

    deletePipelines

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/pipelines/delete \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/pipelines/delete HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/pipelines/delete',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "items": [
        0
      ]
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/pipelines/delete',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/pipelines/delete',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/pipelines/delete', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/pipelines/delete");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/pipelines/delete

    Delete a list of pipelines.

    Body parameter

    {
      "items": [
        0
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    body body DataLong true List of pipeline IDs to be deleted. N/A

    Example responses

    {}
    

    Responses

    Status Meaning Description Schema
    200 OK Empty response. EmptyResponse

    backfillPipeline

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/pipelines/{pipelineId}/backfill \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/pipelines/{pipelineId}/backfill HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/pipelines/{pipelineId}/backfill',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/pipelines/{pipelineId}/backfill',
    {
      method: 'POST',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/pipelines/{pipelineId}/backfill',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/pipelines/{pipelineId}/backfill', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/pipelines/{pipelineId}/backfill");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/pipelines/{pipelineId}/backfill

    Backfill a pipeline.

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    pipelineId path integer(int64) true The id of the pipeline to backfill. N/A

    Example responses

    {}
    

    Responses

    Status Meaning Description Schema
    200 OK Empty response. EmptyResponse

    Projects

    Manage projects. The projects API is currently in experimental alpha; if you have issues, contact Cognite.

    getProject

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/api/0.4/projects/{project} \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/api/0.4/projects/{project} HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.cognitedata.com/api/0.4/projects/{project}',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.cognitedata.com/api/0.4/projects/{project}', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /api/0.4/projects/{project}

    Look up a project by its url name.

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A

    Example responses

    {
      "data": {
        "items": [
          {
            "name": "string",
            "urlName": "string",
            "authentication": {
              "type": "AzureAD",
              "protocol": "oauth2",
              "url": "string",
              "azureADConfiguration": {}
            }
          }
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Information about the project. ProjectsResponse

    putProject

    Code samples

    # You can also use wget
    curl -X PUT https://api.cognitedata.com/api/0.4/projects/{project} \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    PUT https://api.cognitedata.com/api/0.4/projects/{project} HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}',
      method: 'put',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "items": [
        {
          "name": "string",
          "urlName": "string",
          "authentication": {
            "type": "AzureAD",
            "protocol": "oauth2",
            "url": "string",
            "azureADConfiguration": {
              "appId": "string",
              "appSecret": "string",
              "tenantId": "string",
              "appResourceId": "string"
            }
          }
        }
      ]
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}',
    {
      method: 'PUT',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.put 'https://api.cognitedata.com/api/0.4/projects/{project}',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.put('https://api.cognitedata.com/api/0.4/projects/{project}', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("PUT");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    PUT /api/0.4/projects/{project}

    Update a project.

    Body parameter

    {
      "items": [
        {
          "name": "string",
          "urlName": "string",
          "authentication": {
            "type": "AzureAD",
            "protocol": "oauth2",
            "url": "string",
            "azureADConfiguration": {
              "appId": "string",
              "appSecret": "string",
              "tenantId": "string",
              "appResourceId": "string"
            }
          }
        }
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    body body DataProject true List of projects to update, with new values. Currently only supports one project. N/A

    Example responses

    {
      "data": {
        "items": [
          {
            "name": "string",
            "urlName": "string",
            "authentication": {
              "type": "AzureAD",
              "protocol": "oauth2",
              "url": "string",
              "azureADConfiguration": {}
            }
          }
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Project was updated. ProjectsResponse

    Raw

    Manage data in the raw NoSQL database. Each project will have a variable number of raw databases, each of which will have a variable number of tables, each of which will have a variable number of key-value objects. Only queries on key are supported through this API.

    getRowsCSV

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/{tableName} \
      -H 'Accept: text/csv' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/{tableName} HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: text/csv
    
    
    
    var headers = {
      'Accept':'text/csv'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/{tableName}',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'text/csv'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/{tableName}',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'text/csv'
    }
    
    
    result = RestClient.get 'https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/{tableName}',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'text/csv'
    }
    
    
    r = requests.get('https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/{tableName}', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/{tableName}");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /api/0.4/projects/{project}/raw/{dbName}/{tableName}

    Get list of rows in a raw DB table as CSV

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    dbName path string true Name of the database. N/A
    tableName path string true Name of the table. N/A
    limit query integer(int32) false Limit the number of results. N/A
    columns query string false Ordered list of column keys, separated by delimiter. Leave empty for all N/A
    cursor query string false Cursor for paging through time series. N/A

    Example responses

    Responses

    Status Meaning Description Schema
    200 OK Header row, followed by data rows in the same order RawRowCSV

    getTables

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName} \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName} HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /api/0.4/projects/{project}/raw/{dbName}

    Get a list of the tables in a database.

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    dbName path string true The name of a database to retrieve tables from. N/A
    limit query integer(int32) false Limit on the number of tables to be returned. N/A
    cursor query string false Cursor for paging through the results. N/A

    Example responses

    {
      "data": {
        "items": [
          {
            "tableName": "string"
          }
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK A list of tables in the database RawDBTablesWithCursorResponse

    getDBs

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/api/0.4/projects/{project}/raw \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/api/0.4/projects/{project}/raw HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/raw',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/raw',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.cognitedata.com/api/0.4/projects/{project}/raw',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.cognitedata.com/api/0.4/projects/{project}/raw', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/raw");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /api/0.4/projects/{project}/raw

    Get list of databases.

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    limit query integer(int32) false Limit on the number of databases to be returned. N/A
    cursor query string false Cursor for paging through the results. N/A

    Example responses

    {
      "data": {
        "items": [
          {
            "dbName": "string"
          }
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK A list of databases. RawDBsWithCursorResponse

    createDBs

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/raw/create \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/raw/create HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/raw/create',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "items": [
        {
          "dbName": "string"
        }
      ]
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/raw/create',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/raw/create',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/raw/create', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/raw/create");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/raw/create

    Create databases.

    Body parameter

    {
      "items": [
        {
          "dbName": "string"
        }
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    body body DataRawDB true List of names of databases to be created. N/A

    Example responses

    {
      "data": {
        "items": [
          {
            "dbName": "string"
          }
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK The created databases. RawDBsResponse

    deleteDBs

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/raw/delete \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/raw/delete HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/raw/delete',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "items": [
        {
          "dbName": "string"
        }
      ]
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/raw/delete',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/raw/delete',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/raw/delete', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/raw/delete");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/raw/delete

    Delete databases

    Body parameter

    {
      "items": [
        {
          "dbName": "string"
        }
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    recursive query boolean false Whether belonging tables and rows should be deleted recursively N/A
    body body DataRawDB true List of names of the databases to be deleted. N/A

    Example responses

    {}
    

    Responses

    Status Meaning Description Schema
    200 OK Empty response. EmptyResponse

    createTables

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/create \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/create HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/create',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "items": [
        {
          "tableName": "string"
        }
      ]
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/create',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/create',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/create', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/create");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/raw/{dbName}/create

    Create tables.

    Body parameter

    {
      "items": [
        {
          "tableName": "string"
        }
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    dbName path string true Name of the database to create tables in. N/A
    ensureParent query string false Create database if it doesn't exist already N/A
    body body DataRawDBTable true List of tables to create. N/A

    Example responses

    {
      "data": {
        "items": [
          {
            "tableName": "string"
          }
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK The created tables. RawDBTablesResponse

    deleteTables

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/delete \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/delete HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/delete',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "items": [
        {
          "tableName": "string"
        }
      ]
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/delete',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/delete',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/delete', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/delete");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/raw/{dbName}/delete

    Delete tables.

    Body parameter

    {
      "items": [
        {
          "tableName": "string"
        }
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    dbName path string true Name of the database to delete tables in. N/A
    body body DataRawDBTable true List of tables to delete. N/A

    Example responses

    {}
    

    Responses

    Status Meaning Description Schema
    200 OK Empty response. EmptyResponse

    postCsv

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/csv \
      -H 'Content-Type: multipart/form-data' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/csv HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: multipart/form-data
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'multipart/form-data',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/csv',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{}';
    const headers = {
      'Content-Type':'multipart/form-data',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/csv',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'multipart/form-data',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/csv',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'multipart/form-data',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/csv', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/csv");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/raw/{dbName}/csv

    Post a list of rows as CSV to a raw database table.

    Body parameter

    {}
    
    
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    dbName path string true The name of the database to upload the file to. If a raw database with that name doesn't exist, one will be created. N/A
    body body InputStream true The CSV file to be uploaded. The first row must be header values. The size of the file should not exceed 10mb. N/A

    Example responses

    {}
    

    Responses

    Status Meaning Description Schema
    200 OK Empty response. EmptyResponse

    postRows

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/{tableName}/create \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/{tableName}/create HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/{tableName}/create',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "items": [
        {
          "key": "string",
          "columns": {}
        }
      ]
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/{tableName}/create',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/{tableName}/create',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/{tableName}/create', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/{tableName}/create");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/raw/{dbName}/{tableName}/create

    Post a list of rows to a raw DB table.

    Body parameter

    {
      "items": [
        {
          "key": "string",
          "columns": {}
        }
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    dbName path string true Name of the database. N/A
    tableName path string true Name of the table. N/A
    ensureParent query string false Create database/table if it doesn't exist already N/A
    body body DataRawDBRow true List of rows to create. N/A

    Example responses

    {}
    

    Responses

    Status Meaning Description Schema
    200 OK Empty response. EmptyResponse

    deleteRows

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/{tableName}/delete \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/{tableName}/delete HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/{tableName}/delete',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "items": [
        {
          "key": "string",
          "columns": {}
        }
      ]
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/{tableName}/delete',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/{tableName}/delete',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/{tableName}/delete', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/{tableName}/delete");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/raw/{dbName}/{tableName}/delete

    Delete a list of row keys.

    Body parameter

    {
      "items": [
        {
          "key": "string",
          "columns": {}
        }
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    dbName path string true Name of the database containing the rows. N/A
    tableName path string true Name of the table containing the rows. N/A
    body body DataRawDBRow true Keys to the rows to delete. N/A

    Example responses

    {}
    

    Responses

    Status Meaning Description Schema
    200 OK Empty response. EmptyResponse

    getRow

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/{tableName}/{rowKey} \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/{tableName}/{rowKey} HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/{tableName}/{rowKey}',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/{tableName}/{rowKey}',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/{tableName}/{rowKey}',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/{tableName}/{rowKey}', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/raw/{dbName}/{tableName}/{rowKey}");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /api/0.4/projects/{project}/raw/{dbName}/{tableName}/{rowKey}

    Get a specific row.

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    dbName path string true Name of the database to retrieve the row from. N/A
    tableName path string true Name of the table to retrieve the row from. N/A
    rowKey path string true Row key of the row to retrieve. N/A

    Example responses

    {
      "data": {
        "items": [
          {
            "key": "string",
            "columns": {}
          }
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK A list of one row in the raw database table. RawDBRowsResponse

    Security categories

    Manage security categories for a specific project.

    getAllSecurityCategories

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/api/0.4/projects/{project}/securitycategories \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/api/0.4/projects/{project}/securitycategories HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/securitycategories',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/securitycategories',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.cognitedata.com/api/0.4/projects/{project}/securitycategories',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.cognitedata.com/api/0.4/projects/{project}/securitycategories', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/securitycategories");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /api/0.4/projects/{project}/securitycategories

    Get a list of all security categories.

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A

    Example responses

    {
      "data": {
        "items": [
          {
            "name": "string",
            "id": 0
          }
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK A list of security categories. SecurityCategoryResponse

    createSecurityCategories

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/securitycategories \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/securitycategories HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/securitycategories',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "items": [
        {
          "name": "string"
        }
      ]
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/securitycategories',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/securitycategories',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/securitycategories', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/securitycategories");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/securitycategories

    Create security categories

    Body parameter

    {
      "items": [
        {
          "name": "string"
        }
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    body body DataSecurityCategorySpecDTO true List of categories to create N/A

    Example responses

    {
      "data": {
        "items": [
          {
            "name": "string",
            "id": 0
          }
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK A list of security categories. SecurityCategoryResponse

    Semantic Types

    Manage semantic types for a specific project.

    getSemanticTypes

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/api/0.4/projects/{project}/semantictypes \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/api/0.4/projects/{project}/semantictypes HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/semantictypes',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/semantictypes',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.cognitedata.com/api/0.4/projects/{project}/semantictypes',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.cognitedata.com/api/0.4/projects/{project}/semantictypes', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/semantictypes");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /api/0.4/projects/{project}/semantictypes

    Get list of available semantic types.

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A

    Example responses

    {
      "data": {
        "items": [
          {
            "id": 0,
            "name": "string",
            "description": "string"
          }
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK A list of available semantic types. SemanticTypeResponse

    updateSemanticTypes

    Code samples

    # You can also use wget
    curl -X PUT https://api.cognitedata.com/api/0.4/projects/{project}/semantictypes \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    PUT https://api.cognitedata.com/api/0.4/projects/{project}/semantictypes HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/semantictypes',
      method: 'put',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "items": [
        {
          "id": 0,
          "name": "string",
          "description": "string"
        }
      ]
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/semantictypes',
    {
      method: 'PUT',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.put 'https://api.cognitedata.com/api/0.4/projects/{project}/semantictypes',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.put('https://api.cognitedata.com/api/0.4/projects/{project}/semantictypes', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/semantictypes");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("PUT");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    PUT /api/0.4/projects/{project}/semantictypes

    Update semantic types.

    Body parameter

    {
      "items": [
        {
          "id": 0,
          "name": "string",
          "description": "string"
        }
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    body body DataSemanticType true List of semantic types to update. N/A

    Example responses

    {}
    

    Responses

    Status Meaning Description Schema
    200 OK Empty response. EmptyResponse

    postSemanticTypes

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/semantictypes \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/semantictypes HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/semantictypes',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "items": [
        {
          "id": 0,
          "name": "string",
          "description": "string"
        }
      ]
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/semantictypes',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/semantictypes',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/semantictypes', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/semantictypes");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/semantictypes

    Create new semantic types.

    Body parameter

    {
      "items": [
        {
          "id": 0,
          "name": "string",
          "description": "string"
        }
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    body body DataSemanticType true List of semantic types to create. N/A

    Example responses

    {
      "data": {
        "items": [
          {
            "id": 0,
            "name": "string",
            "description": "string"
          }
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK A list of the created semantic types. SemanticTypeResponse

    deleteSemanticType

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/semantictypes/delete \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/semantictypes/delete HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/semantictypes/delete',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "items": [
        0
      ]
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/semantictypes/delete',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/semantictypes/delete',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/semantictypes/delete', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/semantictypes/delete");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/semantictypes/delete

    Delete semantic types by id.

    Body parameter

    {
      "items": [
        0
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    body body DataLong true List of IDs of semantic types to delete. N/A

    Example responses

    {}
    

    Responses

    Status Meaning Description Schema
    200 OK Empty response. EmptyResponse

    Similarity Search

    Endpoint to do similarity search.

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/similaritysearch \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'Api-Key: string' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/similaritysearch HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    Api-Key: string
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json',
      'Api-Key':'string'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/similaritysearch',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "inputTags": [
        "string"
      ],
      "queryTags": [
        "string"
      ],
      "inputInterval": {
        "start": 0,
        "end": 0
      },
      "queryInterval": {
        "start": 0,
        "end": 0
      },
      "modes": [
        "string"
      ],
      "limit": 0
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json',
      'Api-Key':'string'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/similaritysearch',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json',
      'Api-Key' => 'string'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/similaritysearch',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json',
      'Api-Key': 'string'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/similaritysearch', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/similaritysearch");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/similaritysearch

    Do a similarity search.

    Body parameter

    {
      "inputTags": [
        "string"
      ],
      "queryTags": [
        "string"
      ],
      "inputInterval": {
        "start": 0,
        "end": 0
      },
      "queryInterval": {
        "start": 0,
        "end": 0
      },
      "modes": [
        "string"
      ],
      "limit": 0
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    Api-Key header string false Your API key. N/A
    body body SimilaritySearchParams false Input data for similarity search. N/A

    Example responses

    {}
    

    Responses

    Status Meaning Description Schema
    200 OK A list of matching periods. Inline

    Response Schema

    Status Code 200

    Name Type Required Description

    Cloud Storage

    Endpoint for managing files.

    initiateUploadSession

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/storage/metadata \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'X-Upload-Content-Type: string' \
      -H 'Origin: string' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/storage/metadata HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    X-Upload-Content-Type: string
    Origin: string
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json',
      'X-Upload-Content-Type':'string',
      'Origin':'string'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/storage/metadata',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "id": 0,
      "fileName": "string",
      "directory": "string",
      "source": "string",
      "fileType": "string",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "tagIds": [
        "string"
      ],
      "uploaded": true,
      "uploadedAt": 0
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json',
      'X-Upload-Content-Type':'string',
      'Origin':'string'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/storage/metadata',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json',
      'X-Upload-Content-Type' => 'string',
      'Origin' => 'string'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/storage/metadata',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json',
      'X-Upload-Content-Type': 'string',
      'Origin': 'string'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/storage/metadata', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/storage/metadata");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/storage/metadata

    Upload metadata about a file and get an upload link. The link will expire after 30 seconds if not resumable. A resumable upload link is default. Such a link is one-time use and expires after one week. For more information, check this link: https://cloud.google.com/storage/docs/json_api/v1/how-tos/resumable-upload.Use PUT request to upload file with the link returned.

    Body parameter

    {
      "id": 0,
      "fileName": "string",
      "directory": "string",
      "source": "string",
      "fileType": "string",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "tagIds": [
        "string"
      ],
      "uploaded": true,
      "uploadedAt": 0
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    X-Upload-Content-Type header string false The content type of the file to be uploaded. N/A
    Origin header string false Origin for Cross Origin Resource Sharing. This field is required in resumable upload if there is a Cross Origin issue N/A
    resumable query boolean false Whether to generate a resumable URL or not. Default is true. N/A
    overwrite query boolean false Whether to overwrite existing data if duplicate or not. Default is false. If true, metadata will be overwritten; actual file will be overwritten after successfully uploading. If there is no successful upload, current file will not change. File-tag mappings only change if explicitly stated in tagIds field of json body. DO NOT set tagIds if want to keep current file-tag mappings. N/A
    body body FileInfo false Specify the content-type of upload file. In case of non-resumable upload, when setting content-type of file, the client MUST provide HTTP header 'Content-Type' (in upload request) set to the same value. N/A

    Example responses

    {
      "data": {
        "fileId": 0,
        "uploadURL": "string"
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Upload URL and file ID. URLResponse

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/api/0.4/projects/{project}/storage/{id} \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/api/0.4/projects/{project}/storage/{id} HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/storage/{id}',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/storage/{id}',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.cognitedata.com/api/0.4/projects/{project}/storage/{id}',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.cognitedata.com/api/0.4/projects/{project}/storage/{id}', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/storage/{id}");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /api/0.4/projects/{project}/storage/{id}

    Get download link for a file. The link will expire after 30 seconds.

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    id path integer(int64) true Id of the file to download. N/A

    Example responses

    {
      "data": "string"
    }
    
    Status Meaning Description Schema
    200 OK Download link. SingleStringResponse

    getFileInfo

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/api/0.4/projects/{project}/storage/{id}/info \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/api/0.4/projects/{project}/storage/{id}/info HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/storage/{id}/info',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/storage/{id}/info',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.cognitedata.com/api/0.4/projects/{project}/storage/{id}/info',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.cognitedata.com/api/0.4/projects/{project}/storage/{id}/info', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/storage/{id}/info");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /api/0.4/projects/{project}/storage/{id}/info

    Get information of a file.

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    id path integer(int64) true Id of the file. N/A

    Example responses

    {
      "data": {
        "id": 0,
        "fileName": "string",
        "directory": "string",
        "source": "string",
        "fileType": "string",
        "metadata": {
          "property1": "string",
          "property2": "string"
        },
        "tagIds": [
          "string"
        ],
        "uploaded": true,
        "uploadedAt": 0
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Get file information FileInfoResponse

    getFileInfos

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/api/0.4/projects/{project}/storage \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/api/0.4/projects/{project}/storage HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/storage',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/storage',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.cognitedata.com/api/0.4/projects/{project}/storage',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.cognitedata.com/api/0.4/projects/{project}/storage', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/storage");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /api/0.4/projects/{project}/storage

    Get list of files matching query.

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    tagId query string false Returns all files associated with this tagId. N/A
    dir query string false Directory to list files from. N/A
    name query string false List all files with this name. N/A
    type query string false Type of files to list. N/A
    source query string false List files coming from this source. N/A
    isUploaded query boolean false List only uploaded files if true. If false, list only other files. If not set, list all files without considering whether they are uploaded or not. N/A
    limit query integer(int32) false Return up to this many results. Default is 25. N/A
    sort query string false Sort descending or ascending. Default 'DESC' - Show recently uploaded files first. ASC,DESC
    cursor query string false Cursor to use for paging through results. N/A

    Enumerated Values

    Parameter Value
    sort ASC
    sort DESC

    Example responses

    {
      "data": {
        "items": [
          {
            "id": 0,
            "fileName": "string",
            "directory": "string",
            "source": "string",
            "fileType": "string",
            "metadata": {
              "property1": "string",
              "property2": "string"
            },
            "tagIds": [
              "string"
            ],
            "uploaded": true,
            "uploadedAt": 0
          }
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK A list of files with file info and cursors. FileInfoWithCursorResponse

    updateTags

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/storage \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/storage HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/storage',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "items": [
        {
          "id": 0,
          "fileName": "string",
          "directory": "string",
          "source": "string",
          "fileType": "string",
          "metadata": {
            "property1": "string",
            "property2": "string"
          },
          "tagIds": [
            "string"
          ],
          "uploaded": true,
          "uploadedAt": 0
        }
      ]
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/storage',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/storage',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/storage', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/storage");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/storage

    Update tags associated with files.

    Body parameter

    {
      "items": [
        {
          "id": 0,
          "fileName": "string",
          "directory": "string",
          "source": "string",
          "fileType": "string",
          "metadata": {
            "property1": "string",
            "property2": "string"
          },
          "tagIds": [
            "string"
          ],
          "uploaded": true,
          "uploadedAt": 0
        }
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    body body DataFileInfo false List of file IDs and corresponding tags. N/A

    Example responses

    {}
    

    Responses

    Status Meaning Description Schema
    200 OK Empty response. EmptyResponse

    deleteFiles

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/storage/delete \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/storage/delete HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/storage/delete',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "items": [
        0
      ]
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/storage/delete',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/storage/delete',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/storage/delete', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/storage/delete");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/storage/delete

    Delete a list of files by providing file ids.

    Body parameter

    {
      "items": [
        0
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    body body DataLong true List of IDs of files to delete. N/A

    Example responses

    {
      "data": {
        "property1": [
          0
        ],
        "property2": [
          0
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK The name of the deleted files and the files that failed to delete. DeleteFilesResponse

    Tag Matching

    Simple endpoint for finding matching tags.

    tagMatching

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/tagmatching \
      -H 'Content-Type: */*' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/tagmatching HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: */*
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'*/*',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/tagmatching',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "tagIds": [
        "string"
      ],
      "metadata": {}
    }';
    const headers = {
      'Content-Type':'*/*',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/tagmatching',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => '*/*',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/tagmatching',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': '*/*',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/tagmatching', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/tagmatching");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/tagmatching

    Find all matching tags.

    Body parameter

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    body body TagMatchingInput false Input data to match N/A

    Example responses

    {
      "data": {
        "items": [
          {}
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK List of matching tags JsonDataWithCursorResponse

    3D

    Endpoints for our 3d platform to grab model JSON and ctm files. This endpoint is experimental and not indented for production use.

    getModels

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/api/0.4/projects/{project}/3d/models \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/api/0.4/projects/{project}/3d/models HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/3d/models',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/3d/models',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.cognitedata.com/api/0.4/projects/{project}/3d/models',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.cognitedata.com/api/0.4/projects/{project}/3d/models', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/3d/models");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /api/0.4/projects/{project}/3d/models

    Returns all of the model for a project.

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    limit query integer(int32) false Number of models to get. N/A
    cursor query string false Cursor to use for paging through results. N/A
    sortBy query array[string] false The models to sort the order by. Use a - in front of the field to order by descending. N/A

    Enumerated Values

    Parameter Value
    sortBy id
    sortBy createdTime
    sortBy name
    sortBy urlName
    sortBy -id
    sortBy -createdTime
    sortBy -name
    sortBy -urlName

    Example responses

    {
      "data": {
        "items": [
          {
            "id": 0,
            "name": "string",
            "urlName": "string",
            "createdTime": 0
          }
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK A list of models. Default length of 1000. ModelResponse

    postNewModel

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/3d/models \
      -H 'Content-Type: */*' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/3d/models HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: */*
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'*/*',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/3d/models',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "id": 0,
      "name": "string",
      "urlName": "string",
      "createdTime": 0
    }';
    const headers = {
      'Content-Type':'*/*',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/3d/models',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => '*/*',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/3d/models',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': '*/*',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/3d/models', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/3d/models");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/3d/models

    Creates a new model and returns it.

    Body parameter

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    body body ThreeDModel true New model to create. N/A

    Example responses

    {
      "data": {
        "items": [
          {
            "id": 0,
            "name": "string",
            "urlName": "string",
            "createdTime": 0
          }
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK A new mode for the given project. ModelResponse

    getModelById

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId} \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId} HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /api/0.4/projects/{project}/3d/models/{modelId}

    Gets the model based on the id.

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    modelId path string true The model id or urlName. N/A

    Example responses

    {
      "id": 0,
      "name": "string",
      "urlName": "string",
      "createdTime": 0
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Returns the model matching the given id. ThreeDModel

    deleteModel

    Code samples

    # You can also use wget
    curl -X DELETE https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}
      -H 'api-key: YOURAPIKEY'
    
    
    
    DELETE https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId} HTTP/1.1
    Host: api.cognitedata.com
    
    
    
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}',
      method: 'delete',
    
    
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}',
    {
      method: 'DELETE'
    
    
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    result = RestClient.delete 'https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}',
      params: {
      }
    
    
    p JSON.parse(result)
    
    
    
    import requests
    
    
    r = requests.delete('https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}', params={
    
    
    )
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("DELETE");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    DELETE /api/0.4/projects/{project}/3d/models/{modelId}

    Returns all of the model for a project.

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    modelId path string true The model id or urlName to get revisions of. N/A

    Responses

    Status Meaning Description Schema
    200 OK Deleted model. None

    getRevisions

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /api/0.4/projects/{project}/3d/models/{modelId}/revisions

    Returns all of the revisions for a model.

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    modelId path string true The model id or urlName. N/A
    limit query integer(int32) false Number of revisions to get. N/A
    cursor query string false Cursor to use for paging through results. N/A
    sortBy query array[string] false No description N/A

    Enumerated Values

    Parameter Value
    sortBy id
    sortBy createdTime
    sortBy -id
    sortBy -createdTime

    Example responses

    {
      "data": {
        "items": [
          {
            "id": 0,
            "inputSource": {
              "fileId": 0
            },
            "createdTime": 0,
            "metadata": {},
            "extendedMetadata": {
              "numPolygon": 0,
              "numVertices": 0,
              "version": 0
            },
            "statuses": [
              null
            ]
          }
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK List of revisions. Default length of 1000. RevisionResponse

    postNewRevisionJob

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions \
      -H 'Content-Type: */*' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: */*
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'*/*',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "fileId": 0
    }';
    const headers = {
      'Content-Type':'*/*',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => '*/*',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': '*/*',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/3d/models/{modelId}/revisions

    Returns the new revision started for the given fileId (in the body).

    Body parameter

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    modelId path string true The model id or urlName. N/A
    body body ThreeDFileIdBody true File id for source file. N/A

    Example responses

    {
      "data": {
        "items": [
          {
            "id": 0,
            "inputSource": {
              "fileId": 0
            },
            "createdTime": 0,
            "metadata": {},
            "extendedMetadata": {
              "numPolygon": 0,
              "numVertices": 0,
              "version": 0
            },
            "statuses": [
              null
            ]
          }
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK A revision for the given processing job. RevisionResponse

    getRevisionById

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId} \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId} HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}

    Gets a revision from the model based on the id.

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    modelId path string true The model id or urlName. N/A
    revisionId path integer(int64) true The revision id. N/A

    Example responses

    {
      "id": 0,
      "inputSource": {
        "fileId": 0
      },
      "createdTime": 0,
      "metadata": {},
      "extendedMetadata": {
        "numPolygon": 0,
        "numVertices": 0,
        "version": 0
      },
      "statuses": [
        null
      ]
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Returns the revision matching the given id. ThreeDRevision

    deleteRevision

    Code samples

    # You can also use wget
    curl -X DELETE https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}
      -H 'api-key: YOURAPIKEY'
    
    
    
    DELETE https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId} HTTP/1.1
    Host: api.cognitedata.com
    
    
    
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}',
      method: 'delete',
    
    
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}',
    {
      method: 'DELETE'
    
    
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    result = RestClient.delete 'https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}',
      params: {
      }
    
    
    p JSON.parse(result)
    
    
    
    import requests
    
    
    r = requests.delete('https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}', params={
    
    
    )
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("DELETE");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    DELETE /api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}

    Deletes a revision from the model (and all of its nodes and geometries).

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    modelId path string true The model id or urlName. N/A
    revisionId path integer(int64) true The revision id. N/A

    Responses

    Status Meaning Description Schema
    200 OK Indicates that the deletion was successful. None

    getRevisionNodes

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/nodes \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/nodes HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/nodes',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/nodes',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/nodes',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/nodes', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/nodes");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/nodes

    Returns the node of the given revision and sub-nodes of the given id. Note rootId of 0 means root. The endpoint is paginated.

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    modelId path string true The model id or urlName. N/A
    revisionId path integer(int64) true The revision id. N/A
    limit query integer(int32) false Number of nodes to get. N/A
    cursor query string false Cursor to use for paging through results. N/A
    rootId query integer(int64) false The ID of the node and its subtree id to get, by default it is 0. N/A
    assetId query integer(int64) false The asset id of the node, optional query parameter, overrides rootId. N/A

    Example responses

    {
      "data": {
        "items": [
          {
            "id": 0,
            "name": "string",
            "parent": 0,
            "assetId": 0,
            "path": "string",
            "metadata": {},
            "geometry": {
              "id": 0,
              "type": "string",
              "files": {},
              "metadata": {},
              "primitiveInfo": {}
            }
          }
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK A node list for the revision. Default length of 1000. NodeResponse

    getRevisionNodeById

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/nodes/{nodeId} \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/nodes/{nodeId} HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/nodes/{nodeId}',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/nodes/{nodeId}',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/nodes/{nodeId}',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/nodes/{nodeId}', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/nodes/{nodeId}");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/nodes/{nodeId}

    Returns the node of the given revision and sub-nodes of the given id. Note rootId of 0 means root. The endpoint is paginated.

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    modelId path string true The model id or urlName. N/A
    revisionId path integer(int64) true The revision id. N/A
    nodeId path integer(int64) true The node id. N/A
    limit query integer(int32) false Number of nodes to get. N/A
    cursor query string false Cursor to use for paging through results. N/A

    Example responses

    {
      "data": {
        "items": [
          {
            "id": 0,
            "name": "string",
            "parent": 0,
            "assetId": 0,
            "path": "string",
            "metadata": {},
            "geometry": {
              "id": 0,
              "type": "string",
              "files": {},
              "metadata": {},
              "primitiveInfo": {}
            }
          }
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK The specified node and its mapping information. NodeResponse

    getRevisionNodeAssetsInfo

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/nodes/{nodeId}/assets \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/nodes/{nodeId}/assets HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/nodes/{nodeId}/assets',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/nodes/{nodeId}/assets',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/nodes/{nodeId}/assets',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/nodes/{nodeId}/assets', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/nodes/{nodeId}/assets");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/nodes/{nodeId}/assets

    Returns the node of the given revision and sub-nodes of the given id. Note rootId of 0 means root. The endpoint is paginated.

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    modelId path string true The model id or urlName. N/A
    revisionId path integer(int64) true The revision id. N/A
    nodeId path integer(int64) true The node id. N/A

    Example responses

    {
      "data": {
        "items": [
          {
            "id": 0,
            "name": "string",
            "parent": 0,
            "assetId": 0,
            "path": "string",
            "metadata": {},
            "geometry": {
              "id": 0,
              "type": "string",
              "files": {},
              "metadata": {},
              "primitiveInfo": {}
            }
          }
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK The specified node and its mapping information. NodeResponse

    getGeometryFile

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/files/{fileId}
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/files/{fileId} HTTP/1.1
    Host: api.cognitedata.com
    
    
    
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/files/{fileId}',
      method: 'get',
    
    
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/files/{fileId}',
    {
      method: 'GET'
    
    
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    result = RestClient.get 'https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/files/{fileId}',
      params: {
      }
    
    
    p JSON.parse(result)
    
    
    
    import requests
    
    
    r = requests.get('https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/files/{fileId}', params={
    
    
    )
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/files/{fileId}");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /api/0.4/projects/{project}/3d/models/{modelId}/revisions/{revisionId}/files/{fileId}

    Returns the raw file of the geometry.

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    modelId path string true The model id or urlName . N/A
    revisionId path integer(int64) true The revision id. N/A
    fileId path integer(int64) true The file to get. N/A

    Responses

    Status Meaning Description Schema
    default Default default response None

    Time series

    Endpoint for managing time series, and also for listing and posting data in a single time series. Each time series is linked, one to one, to a tag with a unique tagId.

    getDatapoints

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/api/0.4/projects/{project}/timeseries/data/{tagId} \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/api/0.4/projects/{project}/timeseries/data/{tagId} HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/timeseries/data/{tagId}',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/timeseries/data/{tagId}',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.cognitedata.com/api/0.4/projects/{project}/timeseries/data/{tagId}',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.cognitedata.com/api/0.4/projects/{project}/timeseries/data/{tagId}', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/timeseries/data/{tagId}");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /api/0.4/projects/{project}/timeseries/data/{tagId}

    Returns a list of datapoints for the given query

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    tagId path string true The tag ID to get datapoints from. N/A
    start query string false Get datapoints after this time. Format is N[timeunit]-ago where timeunit is w,d,h,m,s. Example: '2d-ago' will get everything that is up to 2 days old. Can also send time in ms since epoch. N/A
    end query string false Get datapoints up to this time. Same format as for start. N/A
    aggregates query string false Get aggregate values for this interval. The format is 'f1,f2,f3' where each entry is an aggregate function. Valid aggregate functions: 'average/avg, max, min, count, sum, interpolation/int, stepinterpolation/step, continuousvariance/cv, discretevariance/dv, totalvariation/tv'. The query parameter 'granularity' must also be specified. Max limit for aggregates is 10000. N/A
    granularity query string false The granularity of the aggregate values. Valid entries are: 'day/d, hour/h, minute/m, second/s', or a multiple of these indicated by a number as a prefix. Example: 12hour. N/A
    limit query integer(int32) false Return up to this number of datapoints. Min/Max: 1/100000

    Example responses

    {
      "data": {
        "items": [
          {
            "timestamp": 0,
            "value": "string"
          }
        ]
      }
    }
    

    Responses

    Status Meaning Description Schema
    200 OK A list of datapoints for the given query. DatapointsResponse

    postDatapoints

    Code samples

    # You can also use wget
    curl -X POST https://api.cognitedata.com/api/0.4/projects/{project}/timeseries/data/{tagId} \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    POST https://api.cognitedata.com/api/0.4/projects/{project}/timeseries/data/{tagId} HTTP/1.1
    Host: api.cognitedata.com
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/timeseries/data/{tagId}',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "items": [
        {
          "timestamp": 0,
          "value": "string"
        }
      ]
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.cognitedata.com/api/0.4/projects/{project}/timeseries/data/{tagId}',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.cognitedata.com/api/0.4/projects/{project}/timeseries/data/{tagId}',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.cognitedata.com/api/0.4/projects/{project}/timeseries/data/{tagId}', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.cognitedata.com/api/0.4/projects/{project}/timeseries/data/{tagId}");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /api/0.4/projects/{project}/timeseries/data/{tagId}

    Insert a list of datapoints.

    Body parameter

    {
      "items": [
        {
          "timestamp": 0,
          "value": "string"
        }
      ]
    }
    

    Parameters

    Parameter In Type Required Description Restrictions
    project path string true Project name. N/A
    tagId path string true ID of time series to insert to N/A
    body body DataDatapoint true The list of datapoints to insert. N/A

    Example responses

    {}
    

    Responses

    Status Meaning Description Schema
    200 OK Empty response. EmptyResponse

    getTimeSeries

    Code samples

    # You can also use wget
    curl -X GET https://api.cognitedata.com/api/0.4/projects/{project}/timeseries \
      -H 'Accept: application/json' \
      -H 'api-key: YOURAPIKEY'
    
    
    
    GET https://api.cognitedata.com/api/0.4/projects/{project}/timeseries HTTP/1.1
    Host: api.cognitedata.com
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.cognitedata.com/api/0.4/projects/{project}/timeseries',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };