Version: 0.1.1

Neat Pulse API

API Documentation

The Pulse API enables direct management of your Pulse devices and organisation. Update device settings, create new rooms and locations, access device sensor data and more.

Audit

auditLogs

List all audit log entries.

/v1/orgs/{orgid}/audit/logs

Usage and Examples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/audit/logs?pageToken=pageToken_example&pageSize=56&from=2024-01-01T10:00:00Z&to=2024-01-02T10:00:00Z"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuditApi;

import java.io.File;
import java.util.*;

public class AuditApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        AuditApi apiInstance = new AuditApi();
        Date from = 2024-01-01T10:00:00Z; // Date | 
        Date to = 2024-01-02T10:00:00Z; // Date | 
        String orgid = orgid_example; // String | 
        String pageToken = pageToken_example; // String | 
        Integer pageSize = 56; // Integer | 

        try {
            v1AuditLogsResponse result = apiInstance.auditLogs(from, to, orgid, pageToken, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuditApi#auditLogs");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AuditApi;

public class AuditApiExample {
    public static void main(String[] args) {
        AuditApi apiInstance = new AuditApi();
        Date from = 2024-01-01T10:00:00Z; // Date | 
        Date to = 2024-01-02T10:00:00Z; // Date | 
        String orgid = orgid_example; // String | 
        String pageToken = pageToken_example; // String | 
        Integer pageSize = 56; // Integer | 

        try {
            v1AuditLogsResponse result = apiInstance.auditLogs(from, to, orgid, pageToken, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuditApi#auditLogs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AuditApi *apiInstance = [[AuditApi alloc] init];
Date *from = 2024-01-01T10:00:00Z; //  (default to null)
Date *to = 2024-01-02T10:00:00Z; //  (default to null)
String *orgid = orgid_example; //  (default to null)
String *pageToken = pageToken_example; //  (optional) (default to null)
Integer *pageSize = 56; //  (optional) (default to null)

// List all audit log entries.
[apiInstance auditLogsWith:from
    to:to
    orgid:orgid
    pageToken:pageToken
    pageSize:pageSize
              completionHandler: ^(v1AuditLogsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.AuditApi()
var from = 2024-01-01T10:00:00Z; // {Date} 
var to = 2024-01-02T10:00:00Z; // {Date} 
var orgid = orgid_example; // {String} 
var opts = {
  'pageToken': pageToken_example, // {String} 
  'pageSize': 56 // {Integer} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.auditLogs(from, to, orgid, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class auditLogsExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new AuditApi();
            var from = 2024-01-01T10:00:00Z;  // Date |  (default to null)
            var to = 2024-01-02T10:00:00Z;  // Date |  (default to null)
            var orgid = orgid_example;  // String |  (default to null)
            var pageToken = pageToken_example;  // String |  (optional)  (default to null)
            var pageSize = 56;  // Integer |  (optional)  (default to null)

            try {
                // List all audit log entries.
                v1AuditLogsResponse result = apiInstance.auditLogs(from, to, orgid, pageToken, pageSize);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuditApi.auditLogs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuditApi();
$from = 2024-01-01T10:00:00Z; // Date | 
$to = 2024-01-02T10:00:00Z; // Date | 
$orgid = orgid_example; // String | 
$pageToken = pageToken_example; // String | 
$pageSize = 56; // Integer | 

try {
    $result = $api_instance->auditLogs($from, $to, $orgid, $pageToken, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuditApi->auditLogs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AuditApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuditApi->new();
my $from = 2024-01-01T10:00:00Z; # Date | 
my $to = 2024-01-02T10:00:00Z; # Date | 
my $orgid = orgid_example; # String | 
my $pageToken = pageToken_example; # String | 
my $pageSize = 56; # Integer | 

eval {
    my $result = $api_instance->auditLogs(from => $from, to => $to, orgid => $orgid, pageToken => $pageToken, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuditApi->auditLogs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.AuditApi()
from = 2024-01-01T10:00:00Z # Date |  (default to null)
to = 2024-01-02T10:00:00Z # Date |  (default to null)
orgid = orgid_example # String |  (default to null)
pageToken = pageToken_example # String |  (optional) (default to null)
pageSize = 56 # Integer |  (optional) (default to null)

try:
    # List all audit log entries.
    api_response = api_instance.audit_logs(from, to, orgid, pageToken=pageToken, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuditApi->auditLogs: %s\n" % e)
extern crate AuditApi;

pub fn main() {
    let from = 2024-01-01T10:00:00Z; // Date
    let to = 2024-01-02T10:00:00Z; // Date
    let orgid = orgid_example; // String
    let pageToken = pageToken_example; // String
    let pageSize = 56; // Integer

    let mut context = AuditApi::Context::default();
    let result = client.auditLogs(from, to, orgid, pageToken, pageSize, &context).wait();

    println!("{:?}", result);
}
Scopes
Read Read permissions

Parameters

Path parameters

Name Description
orgid *
String
Required

Query parameters

Name Description
pageToken
String
pageSize
Integer (int32)
from *
Date (date-time)
Required
to *
Date (date-time)
Required

Responses

Endpoints

endpointsApplyConfig

Apply settings and config to an endpoint.

Creates and applies a new config to an endpoint.
/v1/orgs/{orgid}/endpoints/{id}/config

Usage and Examples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/endpoints/{id}/config" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EndpointsApi;

import java.io.File;
import java.util.*;

public class EndpointsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        EndpointsApi apiInstance = new EndpointsApi();
        String id = id_example; // String | 
        String orgid = orgid_example; // String | 
        DeviceConfig deviceConfig = ; // DeviceConfig | 

        try {
            webpageEndpointApplyConfigResponse result = apiInstance.endpointsApplyConfig(id, orgid, deviceConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointsApi#endpointsApplyConfig");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EndpointsApi;

public class EndpointsApiExample {
    public static void main(String[] args) {
        EndpointsApi apiInstance = new EndpointsApi();
        String id = id_example; // String | 
        String orgid = orgid_example; // String | 
        DeviceConfig deviceConfig = ; // DeviceConfig | 

        try {
            webpageEndpointApplyConfigResponse result = apiInstance.endpointsApplyConfig(id, orgid, deviceConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointsApi#endpointsApplyConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
EndpointsApi *apiInstance = [[EndpointsApi alloc] init];
String *id = id_example; //  (default to null)
String *orgid = orgid_example; //  (default to null)
DeviceConfig *deviceConfig = ; // 

// Apply settings and config to an endpoint.
[apiInstance endpointsApplyConfigWith:id
    orgid:orgid
    deviceConfig:deviceConfig
              completionHandler: ^(webpageEndpointApplyConfigResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.EndpointsApi()
var id = id_example; // {String} 
var orgid = orgid_example; // {String} 
var deviceConfig = ; // {DeviceConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.endpointsApplyConfig(id, orgid, deviceConfig, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class endpointsApplyConfigExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new EndpointsApi();
            var id = id_example;  // String |  (default to null)
            var orgid = orgid_example;  // String |  (default to null)
            var deviceConfig = new DeviceConfig(); // DeviceConfig | 

            try {
                // Apply settings and config to an endpoint.
                webpageEndpointApplyConfigResponse result = apiInstance.endpointsApplyConfig(id, orgid, deviceConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EndpointsApi.endpointsApplyConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EndpointsApi();
$id = id_example; // String | 
$orgid = orgid_example; // String | 
$deviceConfig = ; // DeviceConfig | 

try {
    $result = $api_instance->endpointsApplyConfig($id, $orgid, $deviceConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EndpointsApi->endpointsApplyConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EndpointsApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EndpointsApi->new();
my $id = id_example; # String | 
my $orgid = orgid_example; # String | 
my $deviceConfig = WWW::OPenAPIClient::Object::DeviceConfig->new(); # DeviceConfig | 

eval {
    my $result = $api_instance->endpointsApplyConfig(id => $id, orgid => $orgid, deviceConfig => $deviceConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EndpointsApi->endpointsApplyConfig: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.EndpointsApi()
id = id_example # String |  (default to null)
orgid = orgid_example # String |  (default to null)
deviceConfig =  # DeviceConfig | 

try:
    # Apply settings and config to an endpoint.
    api_response = api_instance.endpoints_apply_config(id, orgid, deviceConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndpointsApi->endpointsApplyConfig: %s\n" % e)
extern crate EndpointsApi;

pub fn main() {
    let id = id_example; // String
    let orgid = orgid_example; // String
    let deviceConfig = ; // DeviceConfig

    let mut context = EndpointsApi::Context::default();
    let result = client.endpointsApplyConfig(id, orgid, deviceConfig, &context).wait();

    println!("{:?}", result);
}
Scopes
Write Write permissions

Parameters

Path parameters

Name Description
id *
String
Required
orgid *
String
Required

Body parameters

Name Description
deviceConfig *

Responses

endpointsApplyLockedSettingsConfig

Apply locked settings config to a device, configuring the on-device settings password.

Updates and applies the settings password configuration to a device. Disabling locked admin settings is only supported on Zoom and Teams devices. When enabled, a password of at least 8 characters must be provided; this password will be required to access admin settings locally on the device.
/v1/orgs/{orgid}/endpoints/{id}/config/admin_settings

Usage and Examples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/endpoints/{id}/config/admin_settings" \
 -d '{ }'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EndpointsApi;

import java.io.File;
import java.util.*;

public class EndpointsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        EndpointsApi apiInstance = new EndpointsApi();
        String id = id_example; // String | 
        String orgid = orgid_example; // String | 
        DevicesDeviceApplyLockedSettingsConfigBody devicesDeviceApplyLockedSettingsConfigBody = ; // DevicesDeviceApplyLockedSettingsConfigBody | 

        try {
            v1DeviceApplyLockedSettingsConfigResponse result = apiInstance.endpointsApplyLockedSettingsConfig(id, orgid, devicesDeviceApplyLockedSettingsConfigBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointsApi#endpointsApplyLockedSettingsConfig");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EndpointsApi;

public class EndpointsApiExample {
    public static void main(String[] args) {
        EndpointsApi apiInstance = new EndpointsApi();
        String id = id_example; // String | 
        String orgid = orgid_example; // String | 
        DevicesDeviceApplyLockedSettingsConfigBody devicesDeviceApplyLockedSettingsConfigBody = ; // DevicesDeviceApplyLockedSettingsConfigBody | 

        try {
            v1DeviceApplyLockedSettingsConfigResponse result = apiInstance.endpointsApplyLockedSettingsConfig(id, orgid, devicesDeviceApplyLockedSettingsConfigBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointsApi#endpointsApplyLockedSettingsConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
EndpointsApi *apiInstance = [[EndpointsApi alloc] init];
String *id = id_example; //  (default to null)
String *orgid = orgid_example; //  (default to null)
DevicesDeviceApplyLockedSettingsConfigBody *devicesDeviceApplyLockedSettingsConfigBody = ; // 

// Apply locked settings config to a device, configuring the on-device settings password.
[apiInstance endpointsApplyLockedSettingsConfigWith:id
    orgid:orgid
    devicesDeviceApplyLockedSettingsConfigBody:devicesDeviceApplyLockedSettingsConfigBody
              completionHandler: ^(v1DeviceApplyLockedSettingsConfigResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.EndpointsApi()
var id = id_example; // {String} 
var orgid = orgid_example; // {String} 
var devicesDeviceApplyLockedSettingsConfigBody = ; // {DevicesDeviceApplyLockedSettingsConfigBody} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.endpointsApplyLockedSettingsConfig(id, orgid, devicesDeviceApplyLockedSettingsConfigBody, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class endpointsApplyLockedSettingsConfigExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new EndpointsApi();
            var id = id_example;  // String |  (default to null)
            var orgid = orgid_example;  // String |  (default to null)
            var devicesDeviceApplyLockedSettingsConfigBody = new DevicesDeviceApplyLockedSettingsConfigBody(); // DevicesDeviceApplyLockedSettingsConfigBody | 

            try {
                // Apply locked settings config to a device, configuring the on-device settings password.
                v1DeviceApplyLockedSettingsConfigResponse result = apiInstance.endpointsApplyLockedSettingsConfig(id, orgid, devicesDeviceApplyLockedSettingsConfigBody);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EndpointsApi.endpointsApplyLockedSettingsConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EndpointsApi();
$id = id_example; // String | 
$orgid = orgid_example; // String | 
$devicesDeviceApplyLockedSettingsConfigBody = ; // DevicesDeviceApplyLockedSettingsConfigBody | 

try {
    $result = $api_instance->endpointsApplyLockedSettingsConfig($id, $orgid, $devicesDeviceApplyLockedSettingsConfigBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EndpointsApi->endpointsApplyLockedSettingsConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EndpointsApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EndpointsApi->new();
my $id = id_example; # String | 
my $orgid = orgid_example; # String | 
my $devicesDeviceApplyLockedSettingsConfigBody = WWW::OPenAPIClient::Object::DevicesDeviceApplyLockedSettingsConfigBody->new(); # DevicesDeviceApplyLockedSettingsConfigBody | 

eval {
    my $result = $api_instance->endpointsApplyLockedSettingsConfig(id => $id, orgid => $orgid, devicesDeviceApplyLockedSettingsConfigBody => $devicesDeviceApplyLockedSettingsConfigBody);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EndpointsApi->endpointsApplyLockedSettingsConfig: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.EndpointsApi()
id = id_example # String |  (default to null)
orgid = orgid_example # String |  (default to null)
devicesDeviceApplyLockedSettingsConfigBody =  # DevicesDeviceApplyLockedSettingsConfigBody | 

try:
    # Apply locked settings config to a device, configuring the on-device settings password.
    api_response = api_instance.endpoints_apply_locked_settings_config(id, orgid, devicesDeviceApplyLockedSettingsConfigBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndpointsApi->endpointsApplyLockedSettingsConfig: %s\n" % e)
extern crate EndpointsApi;

pub fn main() {
    let id = id_example; // String
    let orgid = orgid_example; // String
    let devicesDeviceApplyLockedSettingsConfigBody = ; // DevicesDeviceApplyLockedSettingsConfigBody

    let mut context = EndpointsApi::Context::default();
    let result = client.endpointsApplyLockedSettingsConfig(id, orgid, devicesDeviceApplyLockedSettingsConfigBody, &context).wait();

    println!("{:?}", result);
}
Scopes
Write Write permissions

Parameters

Path parameters

Name Description
id *
String
Required
orgid *
String
Required

Body parameters

Name Description
devicesDeviceApplyLockedSettingsConfigBody *

Responses

endpointsApplyRemoteAccessConfig

Apply Remote Access configuration to an endpoint, configuring local network web access. Not to be confused with Remote Control via Pulse.

Updates and applies remote access configuration to an endpoint. The configured password will apply to username 'admin'. The password is hashed securely and is not logged or stored in plaintext.
/v1/orgs/{orgid}/endpoints/{id}/config/remote_access

Usage and Examples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/endpoints/{id}/config/remote_access" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EndpointsApi;

import java.io.File;
import java.util.*;

public class EndpointsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        EndpointsApi apiInstance = new EndpointsApi();
        String id = id_example; // String | 
        String orgid = orgid_example; // String | 
        V1DeviceRemoteAccessConfig v1DeviceRemoteAccessConfig = ; // V1DeviceRemoteAccessConfig | 

        try {
            v1DeviceApplyRemoteAccessConfigResponse result = apiInstance.endpointsApplyRemoteAccessConfig(id, orgid, v1DeviceRemoteAccessConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointsApi#endpointsApplyRemoteAccessConfig");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EndpointsApi;

public class EndpointsApiExample {
    public static void main(String[] args) {
        EndpointsApi apiInstance = new EndpointsApi();
        String id = id_example; // String | 
        String orgid = orgid_example; // String | 
        V1DeviceRemoteAccessConfig v1DeviceRemoteAccessConfig = ; // V1DeviceRemoteAccessConfig | 

        try {
            v1DeviceApplyRemoteAccessConfigResponse result = apiInstance.endpointsApplyRemoteAccessConfig(id, orgid, v1DeviceRemoteAccessConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointsApi#endpointsApplyRemoteAccessConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
EndpointsApi *apiInstance = [[EndpointsApi alloc] init];
String *id = id_example; //  (default to null)
String *orgid = orgid_example; //  (default to null)
V1DeviceRemoteAccessConfig *v1DeviceRemoteAccessConfig = ; // 

// Apply Remote Access configuration to an endpoint, configuring local network web access. Not to be confused with Remote Control via Pulse.
[apiInstance endpointsApplyRemoteAccessConfigWith:id
    orgid:orgid
    v1DeviceRemoteAccessConfig:v1DeviceRemoteAccessConfig
              completionHandler: ^(v1DeviceApplyRemoteAccessConfigResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.EndpointsApi()
var id = id_example; // {String} 
var orgid = orgid_example; // {String} 
var v1DeviceRemoteAccessConfig = ; // {V1DeviceRemoteAccessConfig} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.endpointsApplyRemoteAccessConfig(id, orgid, v1DeviceRemoteAccessConfig, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class endpointsApplyRemoteAccessConfigExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new EndpointsApi();
            var id = id_example;  // String |  (default to null)
            var orgid = orgid_example;  // String |  (default to null)
            var v1DeviceRemoteAccessConfig = new V1DeviceRemoteAccessConfig(); // V1DeviceRemoteAccessConfig | 

            try {
                // Apply Remote Access configuration to an endpoint, configuring local network web access. Not to be confused with Remote Control via Pulse.
                v1DeviceApplyRemoteAccessConfigResponse result = apiInstance.endpointsApplyRemoteAccessConfig(id, orgid, v1DeviceRemoteAccessConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EndpointsApi.endpointsApplyRemoteAccessConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EndpointsApi();
$id = id_example; // String | 
$orgid = orgid_example; // String | 
$v1DeviceRemoteAccessConfig = ; // V1DeviceRemoteAccessConfig | 

try {
    $result = $api_instance->endpointsApplyRemoteAccessConfig($id, $orgid, $v1DeviceRemoteAccessConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EndpointsApi->endpointsApplyRemoteAccessConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EndpointsApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EndpointsApi->new();
my $id = id_example; # String | 
my $orgid = orgid_example; # String | 
my $v1DeviceRemoteAccessConfig = WWW::OPenAPIClient::Object::V1DeviceRemoteAccessConfig->new(); # V1DeviceRemoteAccessConfig | 

eval {
    my $result = $api_instance->endpointsApplyRemoteAccessConfig(id => $id, orgid => $orgid, v1DeviceRemoteAccessConfig => $v1DeviceRemoteAccessConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EndpointsApi->endpointsApplyRemoteAccessConfig: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.EndpointsApi()
id = id_example # String |  (default to null)
orgid = orgid_example # String |  (default to null)
v1DeviceRemoteAccessConfig =  # V1DeviceRemoteAccessConfig | 

try:
    # Apply Remote Access configuration to an endpoint, configuring local network web access. Not to be confused with Remote Control via Pulse.
    api_response = api_instance.endpoints_apply_remote_access_config(id, orgid, v1DeviceRemoteAccessConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndpointsApi->endpointsApplyRemoteAccessConfig: %s\n" % e)
extern crate EndpointsApi;

pub fn main() {
    let id = id_example; // String
    let orgid = orgid_example; // String
    let v1DeviceRemoteAccessConfig = ; // V1DeviceRemoteAccessConfig

    let mut context = EndpointsApi::Context::default();
    let result = client.endpointsApplyRemoteAccessConfig(id, orgid, v1DeviceRemoteAccessConfig, &context).wait();

    println!("{:?}", result);
}
Scopes
Write Write permissions

Parameters

Path parameters

Name Description
id *
String
Required
orgid *
String
Required

Body parameters

Name Description
v1DeviceRemoteAccessConfig *

Responses

endpointsAssignProfile

Assign a profile to a device.

Assigns a profile to a device. The profile configuration is pushed to the device. If offline, the device picks up the configuration on the next connection.
/v1/orgs/{orgid}/endpoints/{endpointId}/profile/{profileId}

Usage and Examples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/endpoints/{endpointId}/profile/{profileId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EndpointsApi;

import java.io.File;
import java.util.*;

public class EndpointsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        EndpointsApi apiInstance = new EndpointsApi();
        String endpointId = endpointId_example; // String | 
        Integer profileId = 56; // Integer | 
        String orgid = orgid_example; // String | 

        try {
            Object result = apiInstance.endpointsAssignProfile(endpointId, profileId, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointsApi#endpointsAssignProfile");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EndpointsApi;

public class EndpointsApiExample {
    public static void main(String[] args) {
        EndpointsApi apiInstance = new EndpointsApi();
        String endpointId = endpointId_example; // String | 
        Integer profileId = 56; // Integer | 
        String orgid = orgid_example; // String | 

        try {
            Object result = apiInstance.endpointsAssignProfile(endpointId, profileId, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointsApi#endpointsAssignProfile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
EndpointsApi *apiInstance = [[EndpointsApi alloc] init];
String *endpointId = endpointId_example; //  (default to null)
Integer *profileId = 56; //  (default to null)
String *orgid = orgid_example; //  (default to null)

// Assign a profile to a device.
[apiInstance endpointsAssignProfileWith:endpointId
    profileId:profileId
    orgid:orgid
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.EndpointsApi()
var endpointId = endpointId_example; // {String} 
var profileId = 56; // {Integer} 
var orgid = orgid_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.endpointsAssignProfile(endpointId, profileId, orgid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class endpointsAssignProfileExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new EndpointsApi();
            var endpointId = endpointId_example;  // String |  (default to null)
            var profileId = 56;  // Integer |  (default to null)
            var orgid = orgid_example;  // String |  (default to null)

            try {
                // Assign a profile to a device.
                Object result = apiInstance.endpointsAssignProfile(endpointId, profileId, orgid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EndpointsApi.endpointsAssignProfile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EndpointsApi();
$endpointId = endpointId_example; // String | 
$profileId = 56; // Integer | 
$orgid = orgid_example; // String | 

try {
    $result = $api_instance->endpointsAssignProfile($endpointId, $profileId, $orgid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EndpointsApi->endpointsAssignProfile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EndpointsApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EndpointsApi->new();
my $endpointId = endpointId_example; # String | 
my $profileId = 56; # Integer | 
my $orgid = orgid_example; # String | 

eval {
    my $result = $api_instance->endpointsAssignProfile(endpointId => $endpointId, profileId => $profileId, orgid => $orgid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EndpointsApi->endpointsAssignProfile: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.EndpointsApi()
endpointId = endpointId_example # String |  (default to null)
profileId = 56 # Integer |  (default to null)
orgid = orgid_example # String |  (default to null)

try:
    # Assign a profile to a device.
    api_response = api_instance.endpoints_assign_profile(endpointId, profileId, orgid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndpointsApi->endpointsAssignProfile: %s\n" % e)
extern crate EndpointsApi;

pub fn main() {
    let endpointId = endpointId_example; // String
    let profileId = 56; // Integer
    let orgid = orgid_example; // String

    let mut context = EndpointsApi::Context::default();
    let result = client.endpointsAssignProfile(endpointId, profileId, orgid, &context).wait();

    println!("{:?}", result);
}
Scopes
Write Write permissions

Parameters

Path parameters

Name Description
endpointId *
String
Required
profileId *
Integer (int32)
Required
orgid *
String
Required

Responses

endpointsBasicList

List all endpoints in organisation.

Get basic endpoint details for all endpoints in an organisation, optionally filtered by region and/or location.
/v1/orgs/{orgid}/endpoints

Usage and Examples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/endpoints?regionId=56&locationId=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EndpointsApi;

import java.io.File;
import java.util.*;

public class EndpointsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        EndpointsApi apiInstance = new EndpointsApi();
        String orgid = orgid_example; // String | 
        Integer regionId = 56; // Integer | 
        Integer locationId = 56; // Integer | 

        try {
            webpageListBasicEndpointsResponse result = apiInstance.endpointsBasicList(orgid, regionId, locationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointsApi#endpointsBasicList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EndpointsApi;

public class EndpointsApiExample {
    public static void main(String[] args) {
        EndpointsApi apiInstance = new EndpointsApi();
        String orgid = orgid_example; // String | 
        Integer regionId = 56; // Integer | 
        Integer locationId = 56; // Integer | 

        try {
            webpageListBasicEndpointsResponse result = apiInstance.endpointsBasicList(orgid, regionId, locationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointsApi#endpointsBasicList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
EndpointsApi *apiInstance = [[EndpointsApi alloc] init];
String *orgid = orgid_example; //  (default to null)
Integer *regionId = 56; //  (optional) (default to null)
Integer *locationId = 56; //  (optional) (default to null)

// List all endpoints in organisation.
[apiInstance endpointsBasicListWith:orgid
    regionId:regionId
    locationId:locationId
              completionHandler: ^(webpageListBasicEndpointsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.EndpointsApi()
var orgid = orgid_example; // {String} 
var opts = {
  'regionId': 56, // {Integer} 
  'locationId': 56 // {Integer} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.endpointsBasicList(orgid, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class endpointsBasicListExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new EndpointsApi();
            var orgid = orgid_example;  // String |  (default to null)
            var regionId = 56;  // Integer |  (optional)  (default to null)
            var locationId = 56;  // Integer |  (optional)  (default to null)

            try {
                // List all endpoints in organisation.
                webpageListBasicEndpointsResponse result = apiInstance.endpointsBasicList(orgid, regionId, locationId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EndpointsApi.endpointsBasicList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EndpointsApi();
$orgid = orgid_example; // String | 
$regionId = 56; // Integer | 
$locationId = 56; // Integer | 

try {
    $result = $api_instance->endpointsBasicList($orgid, $regionId, $locationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EndpointsApi->endpointsBasicList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EndpointsApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EndpointsApi->new();
my $orgid = orgid_example; # String | 
my $regionId = 56; # Integer | 
my $locationId = 56; # Integer | 

eval {
    my $result = $api_instance->endpointsBasicList(orgid => $orgid, regionId => $regionId, locationId => $locationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EndpointsApi->endpointsBasicList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.EndpointsApi()
orgid = orgid_example # String |  (default to null)
regionId = 56 # Integer |  (optional) (default to null)
locationId = 56 # Integer |  (optional) (default to null)

try:
    # List all endpoints in organisation.
    api_response = api_instance.endpoints_basic_list(orgid, regionId=regionId, locationId=locationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndpointsApi->endpointsBasicList: %s\n" % e)
extern crate EndpointsApi;

pub fn main() {
    let orgid = orgid_example; // String
    let regionId = 56; // Integer
    let locationId = 56; // Integer

    let mut context = EndpointsApi::Context::default();
    let result = client.endpointsBasicList(orgid, regionId, locationId, &context).wait();

    println!("{:?}", result);
}
Scopes
Read Read permissions

Parameters

Path parameters

Name Description
orgid *
String
Required

Query parameters

Name Description
regionId
Integer (int32)
locationId
Integer (int32)

Responses

endpointsBulkSensorData

Get sensor data for all endpoints in an organisation.

Returns the most recent sensor data samples for all endpoints in an organisation. If the sensor data sample is missing for an endpoint then null is returned.
/v1/orgs/{orgid}/endpoints/sensor

Usage and Examples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/endpoints/sensor?regionId=56&locationId=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EndpointsApi;

import java.io.File;
import java.util.*;

public class EndpointsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        EndpointsApi apiInstance = new EndpointsApi();
        String orgid = orgid_example; // String | 
        Integer regionId = 56; // Integer | 
        Integer locationId = 56; // Integer | 

        try {
            webpageGetOrgSensorDataResponse result = apiInstance.endpointsBulkSensorData(orgid, regionId, locationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointsApi#endpointsBulkSensorData");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EndpointsApi;

public class EndpointsApiExample {
    public static void main(String[] args) {
        EndpointsApi apiInstance = new EndpointsApi();
        String orgid = orgid_example; // String | 
        Integer regionId = 56; // Integer | 
        Integer locationId = 56; // Integer | 

        try {
            webpageGetOrgSensorDataResponse result = apiInstance.endpointsBulkSensorData(orgid, regionId, locationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointsApi#endpointsBulkSensorData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
EndpointsApi *apiInstance = [[EndpointsApi alloc] init];
String *orgid = orgid_example; //  (default to null)
Integer *regionId = 56; //  (optional) (default to null)
Integer *locationId = 56; //  (optional) (default to null)

// Get sensor data for all endpoints in an organisation.
[apiInstance endpointsBulkSensorDataWith:orgid
    regionId:regionId
    locationId:locationId
              completionHandler: ^(webpageGetOrgSensorDataResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.EndpointsApi()
var orgid = orgid_example; // {String} 
var opts = {
  'regionId': 56, // {Integer} 
  'locationId': 56 // {Integer} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.endpointsBulkSensorData(orgid, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class endpointsBulkSensorDataExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new EndpointsApi();
            var orgid = orgid_example;  // String |  (default to null)
            var regionId = 56;  // Integer |  (optional)  (default to null)
            var locationId = 56;  // Integer |  (optional)  (default to null)

            try {
                // Get sensor data for all endpoints in an organisation.
                webpageGetOrgSensorDataResponse result = apiInstance.endpointsBulkSensorData(orgid, regionId, locationId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EndpointsApi.endpointsBulkSensorData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EndpointsApi();
$orgid = orgid_example; // String | 
$regionId = 56; // Integer | 
$locationId = 56; // Integer | 

try {
    $result = $api_instance->endpointsBulkSensorData($orgid, $regionId, $locationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EndpointsApi->endpointsBulkSensorData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EndpointsApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EndpointsApi->new();
my $orgid = orgid_example; # String | 
my $regionId = 56; # Integer | 
my $locationId = 56; # Integer | 

eval {
    my $result = $api_instance->endpointsBulkSensorData(orgid => $orgid, regionId => $regionId, locationId => $locationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EndpointsApi->endpointsBulkSensorData: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.EndpointsApi()
orgid = orgid_example # String |  (default to null)
regionId = 56 # Integer |  (optional) (default to null)
locationId = 56 # Integer |  (optional) (default to null)

try:
    # Get sensor data for all endpoints in an organisation.
    api_response = api_instance.endpoints_bulk_sensor_data(orgid, regionId=regionId, locationId=locationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndpointsApi->endpointsBulkSensorData: %s\n" % e)
extern crate EndpointsApi;

pub fn main() {
    let orgid = orgid_example; // String
    let regionId = 56; // Integer
    let locationId = 56; // Integer

    let mut context = EndpointsApi::Context::default();
    let result = client.endpointsBulkSensorData(orgid, regionId, locationId, &context).wait();

    println!("{:?}", result);
}
Scopes
Read Read permissions

Parameters

Path parameters

Name Description
orgid *
String
Required

Query parameters

Name Description
regionId
Integer (int32)
locationId
Integer (int32)

Responses

endpointsDelete

Delete an endpoint.

Unenrolls the endpoint.
/v1/orgs/{orgid}/endpoints/{id}

Usage and Examples

curl -X DELETE \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/endpoints/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EndpointsApi;

import java.io.File;
import java.util.*;

public class EndpointsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        EndpointsApi apiInstance = new EndpointsApi();
        String id = id_example; // String | 
        String orgid = orgid_example; // String | 

        try {
            Object result = apiInstance.endpointsDelete(id, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointsApi#endpointsDelete");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EndpointsApi;

public class EndpointsApiExample {
    public static void main(String[] args) {
        EndpointsApi apiInstance = new EndpointsApi();
        String id = id_example; // String | 
        String orgid = orgid_example; // String | 

        try {
            Object result = apiInstance.endpointsDelete(id, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointsApi#endpointsDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
EndpointsApi *apiInstance = [[EndpointsApi alloc] init];
String *id = id_example; //  (default to null)
String *orgid = orgid_example; //  (default to null)

// Delete an endpoint.
[apiInstance endpointsDeleteWith:id
    orgid:orgid
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.EndpointsApi()
var id = id_example; // {String} 
var orgid = orgid_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.endpointsDelete(id, orgid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class endpointsDeleteExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new EndpointsApi();
            var id = id_example;  // String |  (default to null)
            var orgid = orgid_example;  // String |  (default to null)

            try {
                // Delete an endpoint.
                Object result = apiInstance.endpointsDelete(id, orgid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EndpointsApi.endpointsDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EndpointsApi();
$id = id_example; // String | 
$orgid = orgid_example; // String | 

try {
    $result = $api_instance->endpointsDelete($id, $orgid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EndpointsApi->endpointsDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EndpointsApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EndpointsApi->new();
my $id = id_example; # String | 
my $orgid = orgid_example; # String | 

eval {
    my $result = $api_instance->endpointsDelete(id => $id, orgid => $orgid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EndpointsApi->endpointsDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.EndpointsApi()
id = id_example # String |  (default to null)
orgid = orgid_example # String |  (default to null)

try:
    # Delete an endpoint.
    api_response = api_instance.endpoints_delete(id, orgid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndpointsApi->endpointsDelete: %s\n" % e)
extern crate EndpointsApi;

pub fn main() {
    let id = id_example; // String
    let orgid = orgid_example; // String

    let mut context = EndpointsApi::Context::default();
    let result = client.endpointsDelete(id, orgid, &context).wait();

    println!("{:?}", result);
}
Scopes
Write Write permissions

Parameters

Path parameters

Name Description
id *
String
Required
orgid *
String
Required

Responses

endpointsFactoryReset

Factory reset a device, restoring it to its default settings.

Sends a factory reset command to the specified device. This will restore the device to its out-of-box state, clearing all user data and configuration. A successful response indicates the command has been accepted, not that the reset is complete.
/v1/orgs/{orgid}/endpoints/{id}/reset

Usage and Examples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/endpoints/{id}/reset" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EndpointsApi;

import java.io.File;
import java.util.*;

public class EndpointsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        EndpointsApi apiInstance = new EndpointsApi();
        String id = id_example; // String | 
        String orgid = orgid_example; // String | 
        Object body = Object; // Object | 

        try {
            Object result = apiInstance.endpointsFactoryReset(id, orgid, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointsApi#endpointsFactoryReset");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EndpointsApi;

public class EndpointsApiExample {
    public static void main(String[] args) {
        EndpointsApi apiInstance = new EndpointsApi();
        String id = id_example; // String | 
        String orgid = orgid_example; // String | 
        Object body = Object; // Object | 

        try {
            Object result = apiInstance.endpointsFactoryReset(id, orgid, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointsApi#endpointsFactoryReset");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
EndpointsApi *apiInstance = [[EndpointsApi alloc] init];
String *id = id_example; //  (default to null)
String *orgid = orgid_example; //  (default to null)
Object *body = Object; // 

// Factory reset a device, restoring it to its default settings.
[apiInstance endpointsFactoryResetWith:id
    orgid:orgid
    body:body
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.EndpointsApi()
var id = id_example; // {String} 
var orgid = orgid_example; // {String} 
var body = Object; // {Object} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.endpointsFactoryReset(id, orgid, body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class endpointsFactoryResetExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new EndpointsApi();
            var id = id_example;  // String |  (default to null)
            var orgid = orgid_example;  // String |  (default to null)
            var body = Object;  // Object | 

            try {
                // Factory reset a device, restoring it to its default settings.
                Object result = apiInstance.endpointsFactoryReset(id, orgid, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EndpointsApi.endpointsFactoryReset: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EndpointsApi();
$id = id_example; // String | 
$orgid = orgid_example; // String | 
$body = Object; // Object | 

try {
    $result = $api_instance->endpointsFactoryReset($id, $orgid, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EndpointsApi->endpointsFactoryReset: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EndpointsApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EndpointsApi->new();
my $id = id_example; # String | 
my $orgid = orgid_example; # String | 
my $body = WWW::OPenAPIClient::Object::Object->new(); # Object | 

eval {
    my $result = $api_instance->endpointsFactoryReset(id => $id, orgid => $orgid, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EndpointsApi->endpointsFactoryReset: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.EndpointsApi()
id = id_example # String |  (default to null)
orgid = orgid_example # String |  (default to null)
body = Object # Object | 

try:
    # Factory reset a device, restoring it to its default settings.
    api_response = api_instance.endpoints_factory_reset(id, orgid, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndpointsApi->endpointsFactoryReset: %s\n" % e)
extern crate EndpointsApi;

pub fn main() {
    let id = id_example; // String
    let orgid = orgid_example; // String
    let body = Object; // Object

    let mut context = EndpointsApi::Context::default();
    let result = client.endpointsFactoryReset(id, orgid, body, &context).wait();

    println!("{:?}", result);
}
Scopes
Write Write permissions

Parameters

Path parameters

Name Description
id *
String
Required
orgid *
String
Required

Body parameters

Name Description
body *

Responses

endpointsGenerateBugReport

Generate a bug report for the given endpoint/s, returning a support ID that can be given to Neat Support agents to retieve endpoint logs.

/v1/orgs/{orgid}/endpoints/generate_bug_report

Usage and Examples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/endpoints/generate_bug_report?uploadInCallLogs=true" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EndpointsApi;

import java.io.File;
import java.util.*;

public class EndpointsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        EndpointsApi apiInstance = new EndpointsApi();
        String orgid = orgid_example; // String | 
        array[String] string = ; // array[String] | 
        Boolean uploadInCallLogs = true; // Boolean | 

        try {
            webpageEndpointsGenerateBugReportResponse result = apiInstance.endpointsGenerateBugReport(orgid, string, uploadInCallLogs);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointsApi#endpointsGenerateBugReport");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EndpointsApi;

public class EndpointsApiExample {
    public static void main(String[] args) {
        EndpointsApi apiInstance = new EndpointsApi();
        String orgid = orgid_example; // String | 
        array[String] string = ; // array[String] | 
        Boolean uploadInCallLogs = true; // Boolean | 

        try {
            webpageEndpointsGenerateBugReportResponse result = apiInstance.endpointsGenerateBugReport(orgid, string, uploadInCallLogs);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointsApi#endpointsGenerateBugReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
EndpointsApi *apiInstance = [[EndpointsApi alloc] init];
String *orgid = orgid_example; //  (default to null)
array[String] *string = ; // 
Boolean *uploadInCallLogs = true; //  (optional) (default to null)

// Generate a bug report for the given endpoint/s, returning a support ID that can be given to Neat Support agents to retieve endpoint logs.
[apiInstance endpointsGenerateBugReportWith:orgid
    string:string
    uploadInCallLogs:uploadInCallLogs
              completionHandler: ^(webpageEndpointsGenerateBugReportResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.EndpointsApi()
var orgid = orgid_example; // {String} 
var string = ; // {array[String]} 
var opts = {
  'uploadInCallLogs': true // {Boolean} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.endpointsGenerateBugReport(orgid, string, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class endpointsGenerateBugReportExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new EndpointsApi();
            var orgid = orgid_example;  // String |  (default to null)
            var string = new array[String](); // array[String] | 
            var uploadInCallLogs = true;  // Boolean |  (optional)  (default to null)

            try {
                // Generate a bug report for the given endpoint/s, returning a support ID that can be given to Neat Support agents to retieve endpoint logs.
                webpageEndpointsGenerateBugReportResponse result = apiInstance.endpointsGenerateBugReport(orgid, string, uploadInCallLogs);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EndpointsApi.endpointsGenerateBugReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EndpointsApi();
$orgid = orgid_example; // String | 
$string = ; // array[String] | 
$uploadInCallLogs = true; // Boolean | 

try {
    $result = $api_instance->endpointsGenerateBugReport($orgid, $string, $uploadInCallLogs);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EndpointsApi->endpointsGenerateBugReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EndpointsApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EndpointsApi->new();
my $orgid = orgid_example; # String | 
my $string = [WWW::OPenAPIClient::Object::array[String]->new()]; # array[String] | 
my $uploadInCallLogs = true; # Boolean | 

eval {
    my $result = $api_instance->endpointsGenerateBugReport(orgid => $orgid, string => $string, uploadInCallLogs => $uploadInCallLogs);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EndpointsApi->endpointsGenerateBugReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.EndpointsApi()
orgid = orgid_example # String |  (default to null)
string =  # array[String] | 
uploadInCallLogs = true # Boolean |  (optional) (default to null)

try:
    # Generate a bug report for the given endpoint/s, returning a support ID that can be given to Neat Support agents to retieve endpoint logs.
    api_response = api_instance.endpoints_generate_bug_report(orgid, string, uploadInCallLogs=uploadInCallLogs)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndpointsApi->endpointsGenerateBugReport: %s\n" % e)
extern crate EndpointsApi;

pub fn main() {
    let orgid = orgid_example; // String
    let string = ; // array[String]
    let uploadInCallLogs = true; // Boolean

    let mut context = EndpointsApi::Context::default();
    let result = client.endpointsGenerateBugReport(orgid, string, uploadInCallLogs, &context).wait();

    println!("{:?}", result);
}
Scopes
Write Write permissions

Parameters

Path parameters

Name Description
orgid *
String
Required

Body parameters

Name Description
string *

Query parameters

Name Description
uploadInCallLogs
Boolean

Responses

endpointsGet

Get an endpoint.

Gets an endpoint's details and status information.
/v1/orgs/{orgid}/endpoints/{id}

Usage and Examples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/endpoints/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EndpointsApi;

import java.io.File;
import java.util.*;

public class EndpointsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        EndpointsApi apiInstance = new EndpointsApi();
        String id = id_example; // String | 
        String orgid = orgid_example; // String | 

        try {
            webpageEndpoint result = apiInstance.endpointsGet(id, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointsApi#endpointsGet");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EndpointsApi;

public class EndpointsApiExample {
    public static void main(String[] args) {
        EndpointsApi apiInstance = new EndpointsApi();
        String id = id_example; // String | 
        String orgid = orgid_example; // String | 

        try {
            webpageEndpoint result = apiInstance.endpointsGet(id, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointsApi#endpointsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
EndpointsApi *apiInstance = [[EndpointsApi alloc] init];
String *id = id_example; //  (default to null)
String *orgid = orgid_example; //  (default to null)

// Get an endpoint.
[apiInstance endpointsGetWith:id
    orgid:orgid
              completionHandler: ^(webpageEndpoint output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.EndpointsApi()
var id = id_example; // {String} 
var orgid = orgid_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.endpointsGet(id, orgid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class endpointsGetExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new EndpointsApi();
            var id = id_example;  // String |  (default to null)
            var orgid = orgid_example;  // String |  (default to null)

            try {
                // Get an endpoint.
                webpageEndpoint result = apiInstance.endpointsGet(id, orgid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EndpointsApi.endpointsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EndpointsApi();
$id = id_example; // String | 
$orgid = orgid_example; // String | 

try {
    $result = $api_instance->endpointsGet($id, $orgid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EndpointsApi->endpointsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EndpointsApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EndpointsApi->new();
my $id = id_example; # String | 
my $orgid = orgid_example; # String | 

eval {
    my $result = $api_instance->endpointsGet(id => $id, orgid => $orgid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EndpointsApi->endpointsGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.EndpointsApi()
id = id_example # String |  (default to null)
orgid = orgid_example # String |  (default to null)

try:
    # Get an endpoint.
    api_response = api_instance.endpoints_get(id, orgid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndpointsApi->endpointsGet: %s\n" % e)
extern crate EndpointsApi;

pub fn main() {
    let id = id_example; // String
    let orgid = orgid_example; // String

    let mut context = EndpointsApi::Context::default();
    let result = client.endpointsGet(id, orgid, &context).wait();

    println!("{:?}", result);
}
Scopes
Read Read permissions

Parameters

Path parameters

Name Description
id *
String
Required
orgid *
String
Required

Responses

endpointsMoveRoom

Move paired endpoints to a room.

Moves all endpoints in the request as well as all endpoints paired to the request endpoints to a room. Returns the list of all moved endpoint IDs.
/v1/orgs/{orgid}/endpoints/move_paired

Usage and Examples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/endpoints/move_paired" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EndpointsApi;

import java.io.File;
import java.util.*;

public class EndpointsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        EndpointsApi apiInstance = new EndpointsApi();
        String orgid = orgid_example; // String | 
        WebpageMovePairedEndpointsRequest webpageMovePairedEndpointsRequest = ; // WebpageMovePairedEndpointsRequest | 

        try {
            webpageMovePairedEndpointsResponse result = apiInstance.endpointsMoveRoom(orgid, webpageMovePairedEndpointsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointsApi#endpointsMoveRoom");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EndpointsApi;

public class EndpointsApiExample {
    public static void main(String[] args) {
        EndpointsApi apiInstance = new EndpointsApi();
        String orgid = orgid_example; // String | 
        WebpageMovePairedEndpointsRequest webpageMovePairedEndpointsRequest = ; // WebpageMovePairedEndpointsRequest | 

        try {
            webpageMovePairedEndpointsResponse result = apiInstance.endpointsMoveRoom(orgid, webpageMovePairedEndpointsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointsApi#endpointsMoveRoom");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
EndpointsApi *apiInstance = [[EndpointsApi alloc] init];
String *orgid = orgid_example; //  (default to null)
WebpageMovePairedEndpointsRequest *webpageMovePairedEndpointsRequest = ; // 

// Move paired endpoints to a room.
[apiInstance endpointsMoveRoomWith:orgid
    webpageMovePairedEndpointsRequest:webpageMovePairedEndpointsRequest
              completionHandler: ^(webpageMovePairedEndpointsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.EndpointsApi()
var orgid = orgid_example; // {String} 
var webpageMovePairedEndpointsRequest = ; // {WebpageMovePairedEndpointsRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.endpointsMoveRoom(orgid, webpageMovePairedEndpointsRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class endpointsMoveRoomExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new EndpointsApi();
            var orgid = orgid_example;  // String |  (default to null)
            var webpageMovePairedEndpointsRequest = new WebpageMovePairedEndpointsRequest(); // WebpageMovePairedEndpointsRequest | 

            try {
                // Move paired endpoints to a room.
                webpageMovePairedEndpointsResponse result = apiInstance.endpointsMoveRoom(orgid, webpageMovePairedEndpointsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EndpointsApi.endpointsMoveRoom: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EndpointsApi();
$orgid = orgid_example; // String | 
$webpageMovePairedEndpointsRequest = ; // WebpageMovePairedEndpointsRequest | 

try {
    $result = $api_instance->endpointsMoveRoom($orgid, $webpageMovePairedEndpointsRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EndpointsApi->endpointsMoveRoom: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EndpointsApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EndpointsApi->new();
my $orgid = orgid_example; # String | 
my $webpageMovePairedEndpointsRequest = WWW::OPenAPIClient::Object::WebpageMovePairedEndpointsRequest->new(); # WebpageMovePairedEndpointsRequest | 

eval {
    my $result = $api_instance->endpointsMoveRoom(orgid => $orgid, webpageMovePairedEndpointsRequest => $webpageMovePairedEndpointsRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EndpointsApi->endpointsMoveRoom: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.EndpointsApi()
orgid = orgid_example # String |  (default to null)
webpageMovePairedEndpointsRequest =  # WebpageMovePairedEndpointsRequest | 

try:
    # Move paired endpoints to a room.
    api_response = api_instance.endpoints_move_room(orgid, webpageMovePairedEndpointsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndpointsApi->endpointsMoveRoom: %s\n" % e)
extern crate EndpointsApi;

pub fn main() {
    let orgid = orgid_example; // String
    let webpageMovePairedEndpointsRequest = ; // WebpageMovePairedEndpointsRequest

    let mut context = EndpointsApi::Context::default();
    let result = client.endpointsMoveRoom(orgid, webpageMovePairedEndpointsRequest, &context).wait();

    println!("{:?}", result);
}
Scopes
Write Write permissions

Parameters

Path parameters

Name Description
orgid *
String
Required

Body parameters

Name Description
webpageMovePairedEndpointsRequest *

Responses

endpointsReboot

Reboot an endpoint and any endpoints that are paired with it.

/v1/orgs/{orgid}/endpoints/{id}/reboot

Usage and Examples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/endpoints/{id}/reboot"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EndpointsApi;

import java.io.File;
import java.util.*;

public class EndpointsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        EndpointsApi apiInstance = new EndpointsApi();
        String id = id_example; // String | 
        String orgid = orgid_example; // String | 

        try {
            Object result = apiInstance.endpointsReboot(id, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointsApi#endpointsReboot");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EndpointsApi;

public class EndpointsApiExample {
    public static void main(String[] args) {
        EndpointsApi apiInstance = new EndpointsApi();
        String id = id_example; // String | 
        String orgid = orgid_example; // String | 

        try {
            Object result = apiInstance.endpointsReboot(id, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointsApi#endpointsReboot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
EndpointsApi *apiInstance = [[EndpointsApi alloc] init];
String *id = id_example; //  (default to null)
String *orgid = orgid_example; //  (default to null)

// Reboot an endpoint and any endpoints that are paired with it.
[apiInstance endpointsRebootWith:id
    orgid:orgid
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.EndpointsApi()
var id = id_example; // {String} 
var orgid = orgid_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.endpointsReboot(id, orgid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class endpointsRebootExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new EndpointsApi();
            var id = id_example;  // String |  (default to null)
            var orgid = orgid_example;  // String |  (default to null)

            try {
                // Reboot an endpoint and any endpoints that are paired with it.
                Object result = apiInstance.endpointsReboot(id, orgid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EndpointsApi.endpointsReboot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EndpointsApi();
$id = id_example; // String | 
$orgid = orgid_example; // String | 

try {
    $result = $api_instance->endpointsReboot($id, $orgid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EndpointsApi->endpointsReboot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EndpointsApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EndpointsApi->new();
my $id = id_example; # String | 
my $orgid = orgid_example; # String | 

eval {
    my $result = $api_instance->endpointsReboot(id => $id, orgid => $orgid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EndpointsApi->endpointsReboot: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.EndpointsApi()
id = id_example # String |  (default to null)
orgid = orgid_example # String |  (default to null)

try:
    # Reboot an endpoint and any endpoints that are paired with it.
    api_response = api_instance.endpoints_reboot(id, orgid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndpointsApi->endpointsReboot: %s\n" % e)
extern crate EndpointsApi;

pub fn main() {
    let id = id_example; // String
    let orgid = orgid_example; // String

    let mut context = EndpointsApi::Context::default();
    let result = client.endpointsReboot(id, orgid, &context).wait();

    println!("{:?}", result);
}
Scopes
Write Write permissions

Parameters

Path parameters

Name Description
id *
String
Required
orgid *
String
Required

Responses

endpointsSensorData

Get an endpoint's sensor data.

Gets an endpoint's most recent sample of sensor data. Note that this is currently a single sample, returned in a list of length one. The `ShutterClosed` field applies only to frames, for which it will be true if the privacy shutter is blocking the camera, and false otherwise. For all other devices, this field will be false.
/v1/orgs/{orgid}/endpoints/{id}/sensor

Usage and Examples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/endpoints/{id}/sensor"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EndpointsApi;

import java.io.File;
import java.util.*;

public class EndpointsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        EndpointsApi apiInstance = new EndpointsApi();
        String id = id_example; // String | 
        String orgid = orgid_example; // String | 

        try {
            webpageGetEndpointSensorDataResponse result = apiInstance.endpointsSensorData(id, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointsApi#endpointsSensorData");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EndpointsApi;

public class EndpointsApiExample {
    public static void main(String[] args) {
        EndpointsApi apiInstance = new EndpointsApi();
        String id = id_example; // String | 
        String orgid = orgid_example; // String | 

        try {
            webpageGetEndpointSensorDataResponse result = apiInstance.endpointsSensorData(id, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointsApi#endpointsSensorData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
EndpointsApi *apiInstance = [[EndpointsApi alloc] init];
String *id = id_example; //  (default to null)
String *orgid = orgid_example; //  (default to null)

// Get an endpoint's sensor data.
[apiInstance endpointsSensorDataWith:id
    orgid:orgid
              completionHandler: ^(webpageGetEndpointSensorDataResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.EndpointsApi()
var id = id_example; // {String} 
var orgid = orgid_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.endpointsSensorData(id, orgid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class endpointsSensorDataExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new EndpointsApi();
            var id = id_example;  // String |  (default to null)
            var orgid = orgid_example;  // String |  (default to null)

            try {
                // Get an endpoint's sensor data.
                webpageGetEndpointSensorDataResponse result = apiInstance.endpointsSensorData(id, orgid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EndpointsApi.endpointsSensorData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EndpointsApi();
$id = id_example; // String | 
$orgid = orgid_example; // String | 

try {
    $result = $api_instance->endpointsSensorData($id, $orgid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EndpointsApi->endpointsSensorData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EndpointsApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EndpointsApi->new();
my $id = id_example; # String | 
my $orgid = orgid_example; # String | 

eval {
    my $result = $api_instance->endpointsSensorData(id => $id, orgid => $orgid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EndpointsApi->endpointsSensorData: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.EndpointsApi()
id = id_example # String |  (default to null)
orgid = orgid_example # String |  (default to null)

try:
    # Get an endpoint's sensor data.
    api_response = api_instance.endpoints_sensor_data(id, orgid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndpointsApi->endpointsSensorData: %s\n" % e)
extern crate EndpointsApi;

pub fn main() {
    let id = id_example; // String
    let orgid = orgid_example; // String

    let mut context = EndpointsApi::Context::default();
    let result = client.endpointsSensorData(id, orgid, &context).wait();

    println!("{:?}", result);
}
Scopes
Read Read permissions

Parameters

Path parameters

Name Description
id *
String
Required
orgid *
String
Required

Responses

endpointsSettings

Get an endpoint's settings and config.

/v1/orgs/{orgid}/endpoints/{id}/config

Usage and Examples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/endpoints/{id}/config"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EndpointsApi;

import java.io.File;
import java.util.*;

public class EndpointsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        EndpointsApi apiInstance = new EndpointsApi();
        String id = id_example; // String | 
        String orgid = orgid_example; // String | 

        try {
            ionaDeviceConfig result = apiInstance.endpointsSettings(id, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointsApi#endpointsSettings");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EndpointsApi;

public class EndpointsApiExample {
    public static void main(String[] args) {
        EndpointsApi apiInstance = new EndpointsApi();
        String id = id_example; // String | 
        String orgid = orgid_example; // String | 

        try {
            ionaDeviceConfig result = apiInstance.endpointsSettings(id, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointsApi#endpointsSettings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
EndpointsApi *apiInstance = [[EndpointsApi alloc] init];
String *id = id_example; //  (default to null)
String *orgid = orgid_example; //  (default to null)

// Get an endpoint's settings and config.
[apiInstance endpointsSettingsWith:id
    orgid:orgid
              completionHandler: ^(ionaDeviceConfig output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.EndpointsApi()
var id = id_example; // {String} 
var orgid = orgid_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.endpointsSettings(id, orgid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class endpointsSettingsExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new EndpointsApi();
            var id = id_example;  // String |  (default to null)
            var orgid = orgid_example;  // String |  (default to null)

            try {
                // Get an endpoint's settings and config.
                ionaDeviceConfig result = apiInstance.endpointsSettings(id, orgid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EndpointsApi.endpointsSettings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EndpointsApi();
$id = id_example; // String | 
$orgid = orgid_example; // String | 

try {
    $result = $api_instance->endpointsSettings($id, $orgid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EndpointsApi->endpointsSettings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EndpointsApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EndpointsApi->new();
my $id = id_example; # String | 
my $orgid = orgid_example; # String | 

eval {
    my $result = $api_instance->endpointsSettings(id => $id, orgid => $orgid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EndpointsApi->endpointsSettings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.EndpointsApi()
id = id_example # String |  (default to null)
orgid = orgid_example # String |  (default to null)

try:
    # Get an endpoint's settings and config.
    api_response = api_instance.endpoints_settings(id, orgid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndpointsApi->endpointsSettings: %s\n" % e)
extern crate EndpointsApi;

pub fn main() {
    let id = id_example; // String
    let orgid = orgid_example; // String

    let mut context = EndpointsApi::Context::default();
    let result = client.endpointsSettings(id, orgid, &context).wait();

    println!("{:?}", result);
}
Scopes
Read Read permissions

Parameters

Path parameters

Name Description
id *
String
Required
orgid *
String
Required

Responses

endpointsUnassignProfile

Unassign a profile from a device.

Unassign a profile from a device. The configuration of the device is unchanged.
/v1/orgs/{orgid}/endpoints/{endpointId}/profile

Usage and Examples

curl -X DELETE \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/endpoints/{endpointId}/profile"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EndpointsApi;

import java.io.File;
import java.util.*;

public class EndpointsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        EndpointsApi apiInstance = new EndpointsApi();
        String endpointId = endpointId_example; // String | 
        String orgid = orgid_example; // String | 

        try {
            Object result = apiInstance.endpointsUnassignProfile(endpointId, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointsApi#endpointsUnassignProfile");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EndpointsApi;

public class EndpointsApiExample {
    public static void main(String[] args) {
        EndpointsApi apiInstance = new EndpointsApi();
        String endpointId = endpointId_example; // String | 
        String orgid = orgid_example; // String | 

        try {
            Object result = apiInstance.endpointsUnassignProfile(endpointId, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointsApi#endpointsUnassignProfile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
EndpointsApi *apiInstance = [[EndpointsApi alloc] init];
String *endpointId = endpointId_example; //  (default to null)
String *orgid = orgid_example; //  (default to null)

// Unassign a profile from a device.
[apiInstance endpointsUnassignProfileWith:endpointId
    orgid:orgid
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.EndpointsApi()
var endpointId = endpointId_example; // {String} 
var orgid = orgid_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.endpointsUnassignProfile(endpointId, orgid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class endpointsUnassignProfileExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new EndpointsApi();
            var endpointId = endpointId_example;  // String |  (default to null)
            var orgid = orgid_example;  // String |  (default to null)

            try {
                // Unassign a profile from a device.
                Object result = apiInstance.endpointsUnassignProfile(endpointId, orgid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EndpointsApi.endpointsUnassignProfile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EndpointsApi();
$endpointId = endpointId_example; // String | 
$orgid = orgid_example; // String | 

try {
    $result = $api_instance->endpointsUnassignProfile($endpointId, $orgid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EndpointsApi->endpointsUnassignProfile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EndpointsApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EndpointsApi->new();
my $endpointId = endpointId_example; # String | 
my $orgid = orgid_example; # String | 

eval {
    my $result = $api_instance->endpointsUnassignProfile(endpointId => $endpointId, orgid => $orgid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EndpointsApi->endpointsUnassignProfile: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.EndpointsApi()
endpointId = endpointId_example # String |  (default to null)
orgid = orgid_example # String |  (default to null)

try:
    # Unassign a profile from a device.
    api_response = api_instance.endpoints_unassign_profile(endpointId, orgid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndpointsApi->endpointsUnassignProfile: %s\n" % e)
extern crate EndpointsApi;

pub fn main() {
    let endpointId = endpointId_example; // String
    let orgid = orgid_example; // String

    let mut context = EndpointsApi::Context::default();
    let result = client.endpointsUnassignProfile(endpointId, orgid, &context).wait();

    println!("{:?}", result);
}
Scopes
Write Write permissions

Parameters

Path parameters

Name Description
endpointId *
String
Required
orgid *
String
Required

Responses

FirmwareUpdates

firmwareUpdatesGetDeviceFirmwareUpdate

Get firmware update information for a specific device.

Returns information about any available firmware updates for the specified device.
/v1/orgs/{orgid}/endpoints/{id}/firmware

Usage and Examples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/endpoints/{id}/firmware"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FirmwareUpdatesApi;

import java.io.File;
import java.util.*;

public class FirmwareUpdatesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        FirmwareUpdatesApi apiInstance = new FirmwareUpdatesApi();
        String id = id_example; // String | 
        String orgid = orgid_example; // String | 

        try {
            GetDeviceFirmwareUpdateResponse result = apiInstance.firmwareUpdatesGetDeviceFirmwareUpdate(id, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FirmwareUpdatesApi#firmwareUpdatesGetDeviceFirmwareUpdate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.FirmwareUpdatesApi;

public class FirmwareUpdatesApiExample {
    public static void main(String[] args) {
        FirmwareUpdatesApi apiInstance = new FirmwareUpdatesApi();
        String id = id_example; // String | 
        String orgid = orgid_example; // String | 

        try {
            GetDeviceFirmwareUpdateResponse result = apiInstance.firmwareUpdatesGetDeviceFirmwareUpdate(id, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FirmwareUpdatesApi#firmwareUpdatesGetDeviceFirmwareUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
FirmwareUpdatesApi *apiInstance = [[FirmwareUpdatesApi alloc] init];
String *id = id_example; //  (default to null)
String *orgid = orgid_example; //  (default to null)

// Get firmware update information for a specific device.
[apiInstance firmwareUpdatesGetDeviceFirmwareUpdateWith:id
    orgid:orgid
              completionHandler: ^(GetDeviceFirmwareUpdateResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.FirmwareUpdatesApi()
var id = id_example; // {String} 
var orgid = orgid_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.firmwareUpdatesGetDeviceFirmwareUpdate(id, orgid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class firmwareUpdatesGetDeviceFirmwareUpdateExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new FirmwareUpdatesApi();
            var id = id_example;  // String |  (default to null)
            var orgid = orgid_example;  // String |  (default to null)

            try {
                // Get firmware update information for a specific device.
                GetDeviceFirmwareUpdateResponse result = apiInstance.firmwareUpdatesGetDeviceFirmwareUpdate(id, orgid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FirmwareUpdatesApi.firmwareUpdatesGetDeviceFirmwareUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FirmwareUpdatesApi();
$id = id_example; // String | 
$orgid = orgid_example; // String | 

try {
    $result = $api_instance->firmwareUpdatesGetDeviceFirmwareUpdate($id, $orgid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FirmwareUpdatesApi->firmwareUpdatesGetDeviceFirmwareUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FirmwareUpdatesApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FirmwareUpdatesApi->new();
my $id = id_example; # String | 
my $orgid = orgid_example; # String | 

eval {
    my $result = $api_instance->firmwareUpdatesGetDeviceFirmwareUpdate(id => $id, orgid => $orgid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FirmwareUpdatesApi->firmwareUpdatesGetDeviceFirmwareUpdate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.FirmwareUpdatesApi()
id = id_example # String |  (default to null)
orgid = orgid_example # String |  (default to null)

try:
    # Get firmware update information for a specific device.
    api_response = api_instance.firmware_updates_get_device_firmware_update(id, orgid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FirmwareUpdatesApi->firmwareUpdatesGetDeviceFirmwareUpdate: %s\n" % e)
extern crate FirmwareUpdatesApi;

pub fn main() {
    let id = id_example; // String
    let orgid = orgid_example; // String

    let mut context = FirmwareUpdatesApi::Context::default();
    let result = client.firmwareUpdatesGetDeviceFirmwareUpdate(id, orgid, &context).wait();

    println!("{:?}", result);
}
Scopes
Read Read permissions

Parameters

Path parameters

Name Description
id *
String
Required
orgid *
String
Required

Responses

firmwareUpdatesListDeviceFirmwareUpdates

List devices with available firmware update information.

Returns devices across the organisation along with information about any available firmware updates for those devices. Use the `updatable_only` query parameter to filter for devices with available updates.
/v1/orgs/{orgid}/endpoints/firmware

Usage and Examples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/endpoints/firmware?updatableOnly=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FirmwareUpdatesApi;

import java.io.File;
import java.util.*;

public class FirmwareUpdatesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        FirmwareUpdatesApi apiInstance = new FirmwareUpdatesApi();
        String orgid = orgid_example; // String | 
        Boolean updatableOnly = true; // Boolean | 

        try {
            ListDeviceFirmwareUpdatesResponse result = apiInstance.firmwareUpdatesListDeviceFirmwareUpdates(orgid, updatableOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FirmwareUpdatesApi#firmwareUpdatesListDeviceFirmwareUpdates");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.FirmwareUpdatesApi;

public class FirmwareUpdatesApiExample {
    public static void main(String[] args) {
        FirmwareUpdatesApi apiInstance = new FirmwareUpdatesApi();
        String orgid = orgid_example; // String | 
        Boolean updatableOnly = true; // Boolean | 

        try {
            ListDeviceFirmwareUpdatesResponse result = apiInstance.firmwareUpdatesListDeviceFirmwareUpdates(orgid, updatableOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FirmwareUpdatesApi#firmwareUpdatesListDeviceFirmwareUpdates");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
FirmwareUpdatesApi *apiInstance = [[FirmwareUpdatesApi alloc] init];
String *orgid = orgid_example; //  (default to null)
Boolean *updatableOnly = true; //  (optional) (default to null)

// List devices with available firmware update information.
[apiInstance firmwareUpdatesListDeviceFirmwareUpdatesWith:orgid
    updatableOnly:updatableOnly
              completionHandler: ^(ListDeviceFirmwareUpdatesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.FirmwareUpdatesApi()
var orgid = orgid_example; // {String} 
var opts = {
  'updatableOnly': true // {Boolean} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.firmwareUpdatesListDeviceFirmwareUpdates(orgid, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class firmwareUpdatesListDeviceFirmwareUpdatesExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new FirmwareUpdatesApi();
            var orgid = orgid_example;  // String |  (default to null)
            var updatableOnly = true;  // Boolean |  (optional)  (default to null)

            try {
                // List devices with available firmware update information.
                ListDeviceFirmwareUpdatesResponse result = apiInstance.firmwareUpdatesListDeviceFirmwareUpdates(orgid, updatableOnly);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FirmwareUpdatesApi.firmwareUpdatesListDeviceFirmwareUpdates: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FirmwareUpdatesApi();
$orgid = orgid_example; // String | 
$updatableOnly = true; // Boolean | 

try {
    $result = $api_instance->firmwareUpdatesListDeviceFirmwareUpdates($orgid, $updatableOnly);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FirmwareUpdatesApi->firmwareUpdatesListDeviceFirmwareUpdates: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FirmwareUpdatesApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FirmwareUpdatesApi->new();
my $orgid = orgid_example; # String | 
my $updatableOnly = true; # Boolean | 

eval {
    my $result = $api_instance->firmwareUpdatesListDeviceFirmwareUpdates(orgid => $orgid, updatableOnly => $updatableOnly);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FirmwareUpdatesApi->firmwareUpdatesListDeviceFirmwareUpdates: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.FirmwareUpdatesApi()
orgid = orgid_example # String |  (default to null)
updatableOnly = true # Boolean |  (optional) (default to null)

try:
    # List devices with available firmware update information.
    api_response = api_instance.firmware_updates_list_device_firmware_updates(orgid, updatableOnly=updatableOnly)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FirmwareUpdatesApi->firmwareUpdatesListDeviceFirmwareUpdates: %s\n" % e)
extern crate FirmwareUpdatesApi;

pub fn main() {
    let orgid = orgid_example; // String
    let updatableOnly = true; // Boolean

    let mut context = FirmwareUpdatesApi::Context::default();
    let result = client.firmwareUpdatesListDeviceFirmwareUpdates(orgid, updatableOnly, &context).wait();

    println!("{:?}", result);
}
Scopes
Read Read permissions

Parameters

Path parameters

Name Description
orgid *
String
Required

Query parameters

Name Description
updatableOnly
Boolean

Responses

firmwareUpdatesUpdateDeviceFirmware

Update a device to the latest firmware.

Immediately queue a firmware update for the specified device to the latest version available.
/v1/orgs/{orgid}/endpoints/{endpointId}/firmware

Usage and Examples

curl -X PUT \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/endpoints/{endpointId}/firmware" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FirmwareUpdatesApi;

import java.io.File;
import java.util.*;

public class FirmwareUpdatesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        FirmwareUpdatesApi apiInstance = new FirmwareUpdatesApi();
        String endpointId = endpointId_example; // String | 
        String orgid = orgid_example; // String | 
        Object body = Object; // Object | 

        try {
            UpdateDeviceFirmwareResponse result = apiInstance.firmwareUpdatesUpdateDeviceFirmware(endpointId, orgid, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FirmwareUpdatesApi#firmwareUpdatesUpdateDeviceFirmware");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.FirmwareUpdatesApi;

public class FirmwareUpdatesApiExample {
    public static void main(String[] args) {
        FirmwareUpdatesApi apiInstance = new FirmwareUpdatesApi();
        String endpointId = endpointId_example; // String | 
        String orgid = orgid_example; // String | 
        Object body = Object; // Object | 

        try {
            UpdateDeviceFirmwareResponse result = apiInstance.firmwareUpdatesUpdateDeviceFirmware(endpointId, orgid, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FirmwareUpdatesApi#firmwareUpdatesUpdateDeviceFirmware");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
FirmwareUpdatesApi *apiInstance = [[FirmwareUpdatesApi alloc] init];
String *endpointId = endpointId_example; //  (default to null)
String *orgid = orgid_example; //  (default to null)
Object *body = Object; // 

// Update a device to the latest firmware.
[apiInstance firmwareUpdatesUpdateDeviceFirmwareWith:endpointId
    orgid:orgid
    body:body
              completionHandler: ^(UpdateDeviceFirmwareResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.FirmwareUpdatesApi()
var endpointId = endpointId_example; // {String} 
var orgid = orgid_example; // {String} 
var body = Object; // {Object} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.firmwareUpdatesUpdateDeviceFirmware(endpointId, orgid, body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class firmwareUpdatesUpdateDeviceFirmwareExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new FirmwareUpdatesApi();
            var endpointId = endpointId_example;  // String |  (default to null)
            var orgid = orgid_example;  // String |  (default to null)
            var body = Object;  // Object | 

            try {
                // Update a device to the latest firmware.
                UpdateDeviceFirmwareResponse result = apiInstance.firmwareUpdatesUpdateDeviceFirmware(endpointId, orgid, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FirmwareUpdatesApi.firmwareUpdatesUpdateDeviceFirmware: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FirmwareUpdatesApi();
$endpointId = endpointId_example; // String | 
$orgid = orgid_example; // String | 
$body = Object; // Object | 

try {
    $result = $api_instance->firmwareUpdatesUpdateDeviceFirmware($endpointId, $orgid, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FirmwareUpdatesApi->firmwareUpdatesUpdateDeviceFirmware: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FirmwareUpdatesApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FirmwareUpdatesApi->new();
my $endpointId = endpointId_example; # String | 
my $orgid = orgid_example; # String | 
my $body = WWW::OPenAPIClient::Object::Object->new(); # Object | 

eval {
    my $result = $api_instance->firmwareUpdatesUpdateDeviceFirmware(endpointId => $endpointId, orgid => $orgid, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FirmwareUpdatesApi->firmwareUpdatesUpdateDeviceFirmware: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.FirmwareUpdatesApi()
endpointId = endpointId_example # String |  (default to null)
orgid = orgid_example # String |  (default to null)
body = Object # Object | 

try:
    # Update a device to the latest firmware.
    api_response = api_instance.firmware_updates_update_device_firmware(endpointId, orgid, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FirmwareUpdatesApi->firmwareUpdatesUpdateDeviceFirmware: %s\n" % e)
extern crate FirmwareUpdatesApi;

pub fn main() {
    let endpointId = endpointId_example; // String
    let orgid = orgid_example; // String
    let body = Object; // Object

    let mut context = FirmwareUpdatesApi::Context::default();
    let result = client.firmwareUpdatesUpdateDeviceFirmware(endpointId, orgid, body, &context).wait();

    println!("{:?}", result);
}
Scopes
Write Write permissions

Parameters

Path parameters

Name Description
endpointId *
String
Required
orgid *
String
Required

Body parameters

Name Description
body *

Responses

Locations

locationsCreate

Create a new location.

Adds a new location and optionally assigns it to an existing region.
/v1/orgs/{orgid}/locations

Usage and Examples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/locations" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LocationsApi;

import java.io.File;
import java.util.*;

public class LocationsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        LocationsApi apiInstance = new LocationsApi();
        String orgid = orgid_example; // String | 
        LocationsCreateRequest locationsCreateRequest = ; // LocationsCreateRequest | 

        try {
            webpageLocation result = apiInstance.locationsCreate(orgid, locationsCreateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LocationsApi#locationsCreate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LocationsApi;

public class LocationsApiExample {
    public static void main(String[] args) {
        LocationsApi apiInstance = new LocationsApi();
        String orgid = orgid_example; // String | 
        LocationsCreateRequest locationsCreateRequest = ; // LocationsCreateRequest | 

        try {
            webpageLocation result = apiInstance.locationsCreate(orgid, locationsCreateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LocationsApi#locationsCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
LocationsApi *apiInstance = [[LocationsApi alloc] init];
String *orgid = orgid_example; //  (default to null)
LocationsCreateRequest *locationsCreateRequest = ; // 

// Create a new location.
[apiInstance locationsCreateWith:orgid
    locationsCreateRequest:locationsCreateRequest
              completionHandler: ^(webpageLocation output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.LocationsApi()
var orgid = orgid_example; // {String} 
var locationsCreateRequest = ; // {LocationsCreateRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.locationsCreate(orgid, locationsCreateRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class locationsCreateExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new LocationsApi();
            var orgid = orgid_example;  // String |  (default to null)
            var locationsCreateRequest = new LocationsCreateRequest(); // LocationsCreateRequest | 

            try {
                // Create a new location.
                webpageLocation result = apiInstance.locationsCreate(orgid, locationsCreateRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LocationsApi.locationsCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LocationsApi();
$orgid = orgid_example; // String | 
$locationsCreateRequest = ; // LocationsCreateRequest | 

try {
    $result = $api_instance->locationsCreate($orgid, $locationsCreateRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LocationsApi->locationsCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::LocationsApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LocationsApi->new();
my $orgid = orgid_example; # String | 
my $locationsCreateRequest = WWW::OPenAPIClient::Object::LocationsCreateRequest->new(); # LocationsCreateRequest | 

eval {
    my $result = $api_instance->locationsCreate(orgid => $orgid, locationsCreateRequest => $locationsCreateRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LocationsApi->locationsCreate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.LocationsApi()
orgid = orgid_example # String |  (default to null)
locationsCreateRequest =  # LocationsCreateRequest | 

try:
    # Create a new location.
    api_response = api_instance.locations_create(orgid, locationsCreateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LocationsApi->locationsCreate: %s\n" % e)
extern crate LocationsApi;

pub fn main() {
    let orgid = orgid_example; // String
    let locationsCreateRequest = ; // LocationsCreateRequest

    let mut context = LocationsApi::Context::default();
    let result = client.locationsCreate(orgid, locationsCreateRequest, &context).wait();

    println!("{:?}", result);
}
Scopes
Write Write permissions

Parameters

Path parameters

Name Description
orgid *
String
Required

Body parameters

Name Description
locationsCreateRequest *

Responses

locationsDelete

Delete a location.

Deletes a location. If there are rooms assigned to this location, the operation will succeed and the location assignment will be removed from those rooms.
/v1/orgs/{orgid}/locations/{id}

Usage and Examples

curl -X DELETE \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/locations/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LocationsApi;

import java.io.File;
import java.util.*;

public class LocationsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        LocationsApi apiInstance = new LocationsApi();
        Integer id = 56; // Integer | 
        String orgid = orgid_example; // String | 

        try {
            Object result = apiInstance.locationsDelete(id, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LocationsApi#locationsDelete");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LocationsApi;

public class LocationsApiExample {
    public static void main(String[] args) {
        LocationsApi apiInstance = new LocationsApi();
        Integer id = 56; // Integer | 
        String orgid = orgid_example; // String | 

        try {
            Object result = apiInstance.locationsDelete(id, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LocationsApi#locationsDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
LocationsApi *apiInstance = [[LocationsApi alloc] init];
Integer *id = 56; //  (default to null)
String *orgid = orgid_example; //  (default to null)

// Delete a location.
[apiInstance locationsDeleteWith:id
    orgid:orgid
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.LocationsApi()
var id = 56; // {Integer} 
var orgid = orgid_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.locationsDelete(id, orgid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class locationsDeleteExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new LocationsApi();
            var id = 56;  // Integer |  (default to null)
            var orgid = orgid_example;  // String |  (default to null)

            try {
                // Delete a location.
                Object result = apiInstance.locationsDelete(id, orgid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LocationsApi.locationsDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LocationsApi();
$id = 56; // Integer | 
$orgid = orgid_example; // String | 

try {
    $result = $api_instance->locationsDelete($id, $orgid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LocationsApi->locationsDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::LocationsApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LocationsApi->new();
my $id = 56; # Integer | 
my $orgid = orgid_example; # String | 

eval {
    my $result = $api_instance->locationsDelete(id => $id, orgid => $orgid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LocationsApi->locationsDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.LocationsApi()
id = 56 # Integer |  (default to null)
orgid = orgid_example # String |  (default to null)

try:
    # Delete a location.
    api_response = api_instance.locations_delete(id, orgid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LocationsApi->locationsDelete: %s\n" % e)
extern crate LocationsApi;

pub fn main() {
    let id = 56; // Integer
    let orgid = orgid_example; // String

    let mut context = LocationsApi::Context::default();
    let result = client.locationsDelete(id, orgid, &context).wait();

    println!("{:?}", result);
}
Scopes
Write Write permissions

Parameters

Path parameters

Name Description
id *
Integer (int32)
Required
orgid *
String
Required

Responses

locationsList

List all locations.

Lists the locations in your organisation, including which region they are a part of.
/v1/orgs/{orgid}/locations

Usage and Examples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/locations"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LocationsApi;

import java.io.File;
import java.util.*;

public class LocationsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        LocationsApi apiInstance = new LocationsApi();
        String orgid = orgid_example; // String | 

        try {
            webpageLocationList result = apiInstance.locationsList(orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LocationsApi#locationsList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LocationsApi;

public class LocationsApiExample {
    public static void main(String[] args) {
        LocationsApi apiInstance = new LocationsApi();
        String orgid = orgid_example; // String | 

        try {
            webpageLocationList result = apiInstance.locationsList(orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LocationsApi#locationsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
LocationsApi *apiInstance = [[LocationsApi alloc] init];
String *orgid = orgid_example; //  (default to null)

// List all locations.
[apiInstance locationsListWith:orgid
              completionHandler: ^(webpageLocationList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.LocationsApi()
var orgid = orgid_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.locationsList(orgid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class locationsListExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new LocationsApi();
            var orgid = orgid_example;  // String |  (default to null)

            try {
                // List all locations.
                webpageLocationList result = apiInstance.locationsList(orgid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LocationsApi.locationsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LocationsApi();
$orgid = orgid_example; // String | 

try {
    $result = $api_instance->locationsList($orgid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LocationsApi->locationsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::LocationsApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LocationsApi->new();
my $orgid = orgid_example; # String | 

eval {
    my $result = $api_instance->locationsList(orgid => $orgid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LocationsApi->locationsList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.LocationsApi()
orgid = orgid_example # String |  (default to null)

try:
    # List all locations.
    api_response = api_instance.locations_list(orgid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LocationsApi->locationsList: %s\n" % e)
extern crate LocationsApi;

pub fn main() {
    let orgid = orgid_example; // String

    let mut context = LocationsApi::Context::default();
    let result = client.locationsList(orgid, &context).wait();

    println!("{:?}", result);
}
Scopes
Read Read permissions

Parameters

Path parameters

Name Description
orgid *
String
Required

Responses

locationsUpdate

Update a location.

Changes a location's name or region.
/v1/orgs/{orgid}/locations/{id}

Usage and Examples

curl -X PUT \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/locations/{id}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LocationsApi;

import java.io.File;
import java.util.*;

public class LocationsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        LocationsApi apiInstance = new LocationsApi();
        Integer id = 56; // Integer | 
        String orgid = orgid_example; // String | 
        WebpageLocationsUpdateBody webpageLocationsUpdateBody = ; // WebpageLocationsUpdateBody | 

        try {
            webpageUpdateLocationResponse result = apiInstance.locationsUpdate(id, orgid, webpageLocationsUpdateBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LocationsApi#locationsUpdate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LocationsApi;

public class LocationsApiExample {
    public static void main(String[] args) {
        LocationsApi apiInstance = new LocationsApi();
        Integer id = 56; // Integer | 
        String orgid = orgid_example; // String | 
        WebpageLocationsUpdateBody webpageLocationsUpdateBody = ; // WebpageLocationsUpdateBody | 

        try {
            webpageUpdateLocationResponse result = apiInstance.locationsUpdate(id, orgid, webpageLocationsUpdateBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LocationsApi#locationsUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
LocationsApi *apiInstance = [[LocationsApi alloc] init];
Integer *id = 56; //  (default to null)
String *orgid = orgid_example; //  (default to null)
WebpageLocationsUpdateBody *webpageLocationsUpdateBody = ; // 

// Update a location.
[apiInstance locationsUpdateWith:id
    orgid:orgid
    webpageLocationsUpdateBody:webpageLocationsUpdateBody
              completionHandler: ^(webpageUpdateLocationResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.LocationsApi()
var id = 56; // {Integer} 
var orgid = orgid_example; // {String} 
var webpageLocationsUpdateBody = ; // {WebpageLocationsUpdateBody} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.locationsUpdate(id, orgid, webpageLocationsUpdateBody, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class locationsUpdateExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new LocationsApi();
            var id = 56;  // Integer |  (default to null)
            var orgid = orgid_example;  // String |  (default to null)
            var webpageLocationsUpdateBody = new WebpageLocationsUpdateBody(); // WebpageLocationsUpdateBody | 

            try {
                // Update a location.
                webpageUpdateLocationResponse result = apiInstance.locationsUpdate(id, orgid, webpageLocationsUpdateBody);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LocationsApi.locationsUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LocationsApi();
$id = 56; // Integer | 
$orgid = orgid_example; // String | 
$webpageLocationsUpdateBody = ; // WebpageLocationsUpdateBody | 

try {
    $result = $api_instance->locationsUpdate($id, $orgid, $webpageLocationsUpdateBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LocationsApi->locationsUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::LocationsApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LocationsApi->new();
my $id = 56; # Integer | 
my $orgid = orgid_example; # String | 
my $webpageLocationsUpdateBody = WWW::OPenAPIClient::Object::WebpageLocationsUpdateBody->new(); # WebpageLocationsUpdateBody | 

eval {
    my $result = $api_instance->locationsUpdate(id => $id, orgid => $orgid, webpageLocationsUpdateBody => $webpageLocationsUpdateBody);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LocationsApi->locationsUpdate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.LocationsApi()
id = 56 # Integer |  (default to null)
orgid = orgid_example # String |  (default to null)
webpageLocationsUpdateBody =  # WebpageLocationsUpdateBody | 

try:
    # Update a location.
    api_response = api_instance.locations_update(id, orgid, webpageLocationsUpdateBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LocationsApi->locationsUpdate: %s\n" % e)
extern crate LocationsApi;

pub fn main() {
    let id = 56; // Integer
    let orgid = orgid_example; // String
    let webpageLocationsUpdateBody = ; // WebpageLocationsUpdateBody

    let mut context = LocationsApi::Context::default();
    let result = client.locationsUpdate(id, orgid, webpageLocationsUpdateBody, &context).wait();

    println!("{:?}", result);
}
Scopes
Write Write permissions

Parameters

Path parameters

Name Description
id *
Integer (int32)
Required
orgid *
String
Required

Body parameters

Name Description
webpageLocationsUpdateBody *

Responses

Notes

roomNotesCreate

Create a room note.

Adds a new room note.
/v1/orgs/{orgid}/rooms/{roomId}/notes

Usage and Examples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/rooms/{roomId}/notes" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NotesApi;

import java.io.File;
import java.util.*;

public class NotesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        NotesApi apiInstance = new NotesApi();
        Integer roomId = 56; // Integer | 
        String orgid = orgid_example; // String | 
        WebpageRoomNotesCreateBody webpageRoomNotesCreateBody = ; // WebpageRoomNotesCreateBody | 

        try {
            webpageCreateRoomNoteResponse result = apiInstance.roomNotesCreate(roomId, orgid, webpageRoomNotesCreateBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotesApi#roomNotesCreate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.NotesApi;

public class NotesApiExample {
    public static void main(String[] args) {
        NotesApi apiInstance = new NotesApi();
        Integer roomId = 56; // Integer | 
        String orgid = orgid_example; // String | 
        WebpageRoomNotesCreateBody webpageRoomNotesCreateBody = ; // WebpageRoomNotesCreateBody | 

        try {
            webpageCreateRoomNoteResponse result = apiInstance.roomNotesCreate(roomId, orgid, webpageRoomNotesCreateBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotesApi#roomNotesCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
NotesApi *apiInstance = [[NotesApi alloc] init];
Integer *roomId = 56; //  (default to null)
String *orgid = orgid_example; //  (default to null)
WebpageRoomNotesCreateBody *webpageRoomNotesCreateBody = ; // 

// Create a room note.
[apiInstance roomNotesCreateWith:roomId
    orgid:orgid
    webpageRoomNotesCreateBody:webpageRoomNotesCreateBody
              completionHandler: ^(webpageCreateRoomNoteResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.NotesApi()
var roomId = 56; // {Integer} 
var orgid = orgid_example; // {String} 
var webpageRoomNotesCreateBody = ; // {WebpageRoomNotesCreateBody} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.roomNotesCreate(roomId, orgid, webpageRoomNotesCreateBody, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class roomNotesCreateExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new NotesApi();
            var roomId = 56;  // Integer |  (default to null)
            var orgid = orgid_example;  // String |  (default to null)
            var webpageRoomNotesCreateBody = new WebpageRoomNotesCreateBody(); // WebpageRoomNotesCreateBody | 

            try {
                // Create a room note.
                webpageCreateRoomNoteResponse result = apiInstance.roomNotesCreate(roomId, orgid, webpageRoomNotesCreateBody);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NotesApi.roomNotesCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NotesApi();
$roomId = 56; // Integer | 
$orgid = orgid_example; // String | 
$webpageRoomNotesCreateBody = ; // WebpageRoomNotesCreateBody | 

try {
    $result = $api_instance->roomNotesCreate($roomId, $orgid, $webpageRoomNotesCreateBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NotesApi->roomNotesCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NotesApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NotesApi->new();
my $roomId = 56; # Integer | 
my $orgid = orgid_example; # String | 
my $webpageRoomNotesCreateBody = WWW::OPenAPIClient::Object::WebpageRoomNotesCreateBody->new(); # WebpageRoomNotesCreateBody | 

eval {
    my $result = $api_instance->roomNotesCreate(roomId => $roomId, orgid => $orgid, webpageRoomNotesCreateBody => $webpageRoomNotesCreateBody);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NotesApi->roomNotesCreate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.NotesApi()
roomId = 56 # Integer |  (default to null)
orgid = orgid_example # String |  (default to null)
webpageRoomNotesCreateBody =  # WebpageRoomNotesCreateBody | 

try:
    # Create a room note.
    api_response = api_instance.room_notes_create(roomId, orgid, webpageRoomNotesCreateBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotesApi->roomNotesCreate: %s\n" % e)
extern crate NotesApi;

pub fn main() {
    let roomId = 56; // Integer
    let orgid = orgid_example; // String
    let webpageRoomNotesCreateBody = ; // WebpageRoomNotesCreateBody

    let mut context = NotesApi::Context::default();
    let result = client.roomNotesCreate(roomId, orgid, webpageRoomNotesCreateBody, &context).wait();

    println!("{:?}", result);
}
Scopes
Write Write permissions

Parameters

Path parameters

Name Description
roomId *
Integer (int32)
Required
orgid *
String
Required

Body parameters

Name Description
webpageRoomNotesCreateBody *

Responses

roomNotesDelete

Delete a room note.

Deletes a room note.
/v1/orgs/{orgid}/rooms/{roomId}/notes/{noteId}

Usage and Examples

curl -X DELETE \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/rooms/{roomId}/notes/{noteId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NotesApi;

import java.io.File;
import java.util.*;

public class NotesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        NotesApi apiInstance = new NotesApi();
        Integer roomId = 56; // Integer | 
        Integer noteId = 56; // Integer | 
        String orgid = orgid_example; // String | 

        try {
            Object result = apiInstance.roomNotesDelete(roomId, noteId, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotesApi#roomNotesDelete");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.NotesApi;

public class NotesApiExample {
    public static void main(String[] args) {
        NotesApi apiInstance = new NotesApi();
        Integer roomId = 56; // Integer | 
        Integer noteId = 56; // Integer | 
        String orgid = orgid_example; // String | 

        try {
            Object result = apiInstance.roomNotesDelete(roomId, noteId, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotesApi#roomNotesDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
NotesApi *apiInstance = [[NotesApi alloc] init];
Integer *roomId = 56; //  (default to null)
Integer *noteId = 56; //  (default to null)
String *orgid = orgid_example; //  (default to null)

// Delete a room note.
[apiInstance roomNotesDeleteWith:roomId
    noteId:noteId
    orgid:orgid
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.NotesApi()
var roomId = 56; // {Integer} 
var noteId = 56; // {Integer} 
var orgid = orgid_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.roomNotesDelete(roomId, noteId, orgid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class roomNotesDeleteExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new NotesApi();
            var roomId = 56;  // Integer |  (default to null)
            var noteId = 56;  // Integer |  (default to null)
            var orgid = orgid_example;  // String |  (default to null)

            try {
                // Delete a room note.
                Object result = apiInstance.roomNotesDelete(roomId, noteId, orgid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NotesApi.roomNotesDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NotesApi();
$roomId = 56; // Integer | 
$noteId = 56; // Integer | 
$orgid = orgid_example; // String | 

try {
    $result = $api_instance->roomNotesDelete($roomId, $noteId, $orgid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NotesApi->roomNotesDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NotesApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NotesApi->new();
my $roomId = 56; # Integer | 
my $noteId = 56; # Integer | 
my $orgid = orgid_example; # String | 

eval {
    my $result = $api_instance->roomNotesDelete(roomId => $roomId, noteId => $noteId, orgid => $orgid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NotesApi->roomNotesDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.NotesApi()
roomId = 56 # Integer |  (default to null)
noteId = 56 # Integer |  (default to null)
orgid = orgid_example # String |  (default to null)

try:
    # Delete a room note.
    api_response = api_instance.room_notes_delete(roomId, noteId, orgid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotesApi->roomNotesDelete: %s\n" % e)
extern crate NotesApi;

pub fn main() {
    let roomId = 56; // Integer
    let noteId = 56; // Integer
    let orgid = orgid_example; // String

    let mut context = NotesApi::Context::default();
    let result = client.roomNotesDelete(roomId, noteId, orgid, &context).wait();

    println!("{:?}", result);
}
Scopes
Write Write permissions

Parameters

Path parameters

Name Description
roomId *
Integer (int32)
Required
noteId *
Integer (int32)
Required
orgid *
String
Required

Responses

roomNotesGet

Get note in room.

Get a single note in room.
/v1/orgs/{orgid}/rooms/{roomId}/notes/{noteId}

Usage and Examples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/rooms/{roomId}/notes/{noteId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NotesApi;

import java.io.File;
import java.util.*;

public class NotesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        NotesApi apiInstance = new NotesApi();
        Integer roomId = 56; // Integer | 
        Integer noteId = 56; // Integer | 
        String orgid = orgid_example; // String | 

        try {
            webpageGetRoomNoteResponse result = apiInstance.roomNotesGet(roomId, noteId, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotesApi#roomNotesGet");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.NotesApi;

public class NotesApiExample {
    public static void main(String[] args) {
        NotesApi apiInstance = new NotesApi();
        Integer roomId = 56; // Integer | 
        Integer noteId = 56; // Integer | 
        String orgid = orgid_example; // String | 

        try {
            webpageGetRoomNoteResponse result = apiInstance.roomNotesGet(roomId, noteId, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotesApi#roomNotesGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
NotesApi *apiInstance = [[NotesApi alloc] init];
Integer *roomId = 56; //  (default to null)
Integer *noteId = 56; //  (default to null)
String *orgid = orgid_example; //  (default to null)

// Get note in room.
[apiInstance roomNotesGetWith:roomId
    noteId:noteId
    orgid:orgid
              completionHandler: ^(webpageGetRoomNoteResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.NotesApi()
var roomId = 56; // {Integer} 
var noteId = 56; // {Integer} 
var orgid = orgid_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.roomNotesGet(roomId, noteId, orgid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class roomNotesGetExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new NotesApi();
            var roomId = 56;  // Integer |  (default to null)
            var noteId = 56;  // Integer |  (default to null)
            var orgid = orgid_example;  // String |  (default to null)

            try {
                // Get note in room.
                webpageGetRoomNoteResponse result = apiInstance.roomNotesGet(roomId, noteId, orgid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NotesApi.roomNotesGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NotesApi();
$roomId = 56; // Integer | 
$noteId = 56; // Integer | 
$orgid = orgid_example; // String | 

try {
    $result = $api_instance->roomNotesGet($roomId, $noteId, $orgid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NotesApi->roomNotesGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NotesApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NotesApi->new();
my $roomId = 56; # Integer | 
my $noteId = 56; # Integer | 
my $orgid = orgid_example; # String | 

eval {
    my $result = $api_instance->roomNotesGet(roomId => $roomId, noteId => $noteId, orgid => $orgid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NotesApi->roomNotesGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.NotesApi()
roomId = 56 # Integer |  (default to null)
noteId = 56 # Integer |  (default to null)
orgid = orgid_example # String |  (default to null)

try:
    # Get note in room.
    api_response = api_instance.room_notes_get(roomId, noteId, orgid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotesApi->roomNotesGet: %s\n" % e)
extern crate NotesApi;

pub fn main() {
    let roomId = 56; // Integer
    let noteId = 56; // Integer
    let orgid = orgid_example; // String

    let mut context = NotesApi::Context::default();
    let result = client.roomNotesGet(roomId, noteId, orgid, &context).wait();

    println!("{:?}", result);
}
Scopes
Read Read permissions

Parameters

Path parameters

Name Description
roomId *
Integer (int32)
Required
noteId *
Integer (int32)
Required
orgid *
String
Required

Responses

roomNotesList

List all notes in room.

Lists notes in room.
/v1/orgs/{orgid}/rooms/{roomId}/notes

Usage and Examples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/rooms/{roomId}/notes"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NotesApi;

import java.io.File;
import java.util.*;

public class NotesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        NotesApi apiInstance = new NotesApi();
        Integer roomId = 56; // Integer | 
        String orgid = orgid_example; // String | 

        try {
            webpageListRoomNotesResponse result = apiInstance.roomNotesList(roomId, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotesApi#roomNotesList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.NotesApi;

public class NotesApiExample {
    public static void main(String[] args) {
        NotesApi apiInstance = new NotesApi();
        Integer roomId = 56; // Integer | 
        String orgid = orgid_example; // String | 

        try {
            webpageListRoomNotesResponse result = apiInstance.roomNotesList(roomId, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotesApi#roomNotesList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
NotesApi *apiInstance = [[NotesApi alloc] init];
Integer *roomId = 56; //  (default to null)
String *orgid = orgid_example; //  (default to null)

// List all notes in room.
[apiInstance roomNotesListWith:roomId
    orgid:orgid
              completionHandler: ^(webpageListRoomNotesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.NotesApi()
var roomId = 56; // {Integer} 
var orgid = orgid_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.roomNotesList(roomId, orgid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class roomNotesListExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new NotesApi();
            var roomId = 56;  // Integer |  (default to null)
            var orgid = orgid_example;  // String |  (default to null)

            try {
                // List all notes in room.
                webpageListRoomNotesResponse result = apiInstance.roomNotesList(roomId, orgid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NotesApi.roomNotesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NotesApi();
$roomId = 56; // Integer | 
$orgid = orgid_example; // String | 

try {
    $result = $api_instance->roomNotesList($roomId, $orgid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NotesApi->roomNotesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NotesApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NotesApi->new();
my $roomId = 56; # Integer | 
my $orgid = orgid_example; # String | 

eval {
    my $result = $api_instance->roomNotesList(roomId => $roomId, orgid => $orgid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NotesApi->roomNotesList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.NotesApi()
roomId = 56 # Integer |  (default to null)
orgid = orgid_example # String |  (default to null)

try:
    # List all notes in room.
    api_response = api_instance.room_notes_list(roomId, orgid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotesApi->roomNotesList: %s\n" % e)
extern crate NotesApi;

pub fn main() {
    let roomId = 56; // Integer
    let orgid = orgid_example; // String

    let mut context = NotesApi::Context::default();
    let result = client.roomNotesList(roomId, orgid, &context).wait();

    println!("{:?}", result);
}
Scopes
Read Read permissions

Parameters

Path parameters

Name Description
roomId *
Integer (int32)
Required
orgid *
String
Required

Responses

roomNotesListAll

List all notes in an organization.

Lists notes in organization.
/v1/orgs/{orgid}/rooms/notes

Usage and Examples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/rooms/notes"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NotesApi;

import java.io.File;
import java.util.*;

public class NotesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        NotesApi apiInstance = new NotesApi();
        String orgid = orgid_example; // String | 

        try {
            webpageListAllRoomNotesResponse result = apiInstance.roomNotesListAll(orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotesApi#roomNotesListAll");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.NotesApi;

public class NotesApiExample {
    public static void main(String[] args) {
        NotesApi apiInstance = new NotesApi();
        String orgid = orgid_example; // String | 

        try {
            webpageListAllRoomNotesResponse result = apiInstance.roomNotesListAll(orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotesApi#roomNotesListAll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
NotesApi *apiInstance = [[NotesApi alloc] init];
String *orgid = orgid_example; //  (default to null)

// List all notes in an organization.
[apiInstance roomNotesListAllWith:orgid
              completionHandler: ^(webpageListAllRoomNotesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.NotesApi()
var orgid = orgid_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.roomNotesListAll(orgid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class roomNotesListAllExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new NotesApi();
            var orgid = orgid_example;  // String |  (default to null)

            try {
                // List all notes in an organization.
                webpageListAllRoomNotesResponse result = apiInstance.roomNotesListAll(orgid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NotesApi.roomNotesListAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NotesApi();
$orgid = orgid_example; // String | 

try {
    $result = $api_instance->roomNotesListAll($orgid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NotesApi->roomNotesListAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NotesApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NotesApi->new();
my $orgid = orgid_example; # String | 

eval {
    my $result = $api_instance->roomNotesListAll(orgid => $orgid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NotesApi->roomNotesListAll: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.NotesApi()
orgid = orgid_example # String |  (default to null)

try:
    # List all notes in an organization.
    api_response = api_instance.room_notes_list_all(orgid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotesApi->roomNotesListAll: %s\n" % e)
extern crate NotesApi;

pub fn main() {
    let orgid = orgid_example; // String

    let mut context = NotesApi::Context::default();
    let result = client.roomNotesListAll(orgid, &context).wait();

    println!("{:?}", result);
}
Scopes
Read Read permissions

Parameters

Path parameters

Name Description
orgid *
String
Required

Responses

Profiles

profilesCreate

Create a new profile.

/v1/orgs/{orgid}/profiles

Usage and Examples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/profiles" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProfilesApi;

import java.io.File;
import java.util.*;

public class ProfilesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        ProfilesApi apiInstance = new ProfilesApi();
        String orgid = orgid_example; // String | 
        V1ProfilesCreateRequest v1ProfilesCreateRequest = ; // V1ProfilesCreateRequest | 

        try {
            v1ProfilesCreateResponse result = apiInstance.profilesCreate(orgid, v1ProfilesCreateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfilesApi#profilesCreate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ProfilesApi;

public class ProfilesApiExample {
    public static void main(String[] args) {
        ProfilesApi apiInstance = new ProfilesApi();
        String orgid = orgid_example; // String | 
        V1ProfilesCreateRequest v1ProfilesCreateRequest = ; // V1ProfilesCreateRequest | 

        try {
            v1ProfilesCreateResponse result = apiInstance.profilesCreate(orgid, v1ProfilesCreateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfilesApi#profilesCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ProfilesApi *apiInstance = [[ProfilesApi alloc] init];
String *orgid = orgid_example; //  (default to null)
V1ProfilesCreateRequest *v1ProfilesCreateRequest = ; // 

// Create a new profile.
[apiInstance profilesCreateWith:orgid
    v1ProfilesCreateRequest:v1ProfilesCreateRequest
              completionHandler: ^(v1ProfilesCreateResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.ProfilesApi()
var orgid = orgid_example; // {String} 
var v1ProfilesCreateRequest = ; // {V1ProfilesCreateRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.profilesCreate(orgid, v1ProfilesCreateRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class profilesCreateExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new ProfilesApi();
            var orgid = orgid_example;  // String |  (default to null)
            var v1ProfilesCreateRequest = new V1ProfilesCreateRequest(); // V1ProfilesCreateRequest | 

            try {
                // Create a new profile.
                v1ProfilesCreateResponse result = apiInstance.profilesCreate(orgid, v1ProfilesCreateRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProfilesApi.profilesCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProfilesApi();
$orgid = orgid_example; // String | 
$v1ProfilesCreateRequest = ; // V1ProfilesCreateRequest | 

try {
    $result = $api_instance->profilesCreate($orgid, $v1ProfilesCreateRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProfilesApi->profilesCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProfilesApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProfilesApi->new();
my $orgid = orgid_example; # String | 
my $v1ProfilesCreateRequest = WWW::OPenAPIClient::Object::V1ProfilesCreateRequest->new(); # V1ProfilesCreateRequest | 

eval {
    my $result = $api_instance->profilesCreate(orgid => $orgid, v1ProfilesCreateRequest => $v1ProfilesCreateRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProfilesApi->profilesCreate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.ProfilesApi()
orgid = orgid_example # String |  (default to null)
v1ProfilesCreateRequest =  # V1ProfilesCreateRequest | 

try:
    # Create a new profile.
    api_response = api_instance.profiles_create(orgid, v1ProfilesCreateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProfilesApi->profilesCreate: %s\n" % e)
extern crate ProfilesApi;

pub fn main() {
    let orgid = orgid_example; // String
    let v1ProfilesCreateRequest = ; // V1ProfilesCreateRequest

    let mut context = ProfilesApi::Context::default();
    let result = client.profilesCreate(orgid, v1ProfilesCreateRequest, &context).wait();

    println!("{:?}", result);
}
Scopes
Write Write permissions

Parameters

Path parameters

Name Description
orgid *
String
Required

Body parameters

Name Description
v1ProfilesCreateRequest *

Responses

profilesDelete

Delete a profile. Any devices using this profile will have their profile unassigned. The configurations of these devices are unchanged.

/v1/orgs/{orgid}/profiles/{id}

Usage and Examples

curl -X DELETE \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/profiles/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProfilesApi;

import java.io.File;
import java.util.*;

public class ProfilesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        ProfilesApi apiInstance = new ProfilesApi();
        Integer id = 56; // Integer | 
        String orgid = orgid_example; // String | 

        try {
            Object result = apiInstance.profilesDelete(id, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfilesApi#profilesDelete");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ProfilesApi;

public class ProfilesApiExample {
    public static void main(String[] args) {
        ProfilesApi apiInstance = new ProfilesApi();
        Integer id = 56; // Integer | 
        String orgid = orgid_example; // String | 

        try {
            Object result = apiInstance.profilesDelete(id, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfilesApi#profilesDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ProfilesApi *apiInstance = [[ProfilesApi alloc] init];
Integer *id = 56; //  (default to null)
String *orgid = orgid_example; //  (default to null)

// Delete a profile. Any devices using this profile will have their profile unassigned. The configurations of these devices are unchanged.
[apiInstance profilesDeleteWith:id
    orgid:orgid
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.ProfilesApi()
var id = 56; // {Integer} 
var orgid = orgid_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.profilesDelete(id, orgid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class profilesDeleteExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new ProfilesApi();
            var id = 56;  // Integer |  (default to null)
            var orgid = orgid_example;  // String |  (default to null)

            try {
                // Delete a profile. Any devices using this profile will have their profile unassigned. The configurations of these devices are unchanged.
                Object result = apiInstance.profilesDelete(id, orgid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProfilesApi.profilesDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProfilesApi();
$id = 56; // Integer | 
$orgid = orgid_example; // String | 

try {
    $result = $api_instance->profilesDelete($id, $orgid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProfilesApi->profilesDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProfilesApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProfilesApi->new();
my $id = 56; # Integer | 
my $orgid = orgid_example; # String | 

eval {
    my $result = $api_instance->profilesDelete(id => $id, orgid => $orgid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProfilesApi->profilesDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.ProfilesApi()
id = 56 # Integer |  (default to null)
orgid = orgid_example # String |  (default to null)

try:
    # Delete a profile. Any devices using this profile will have their profile unassigned. The configurations of these devices are unchanged.
    api_response = api_instance.profiles_delete(id, orgid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProfilesApi->profilesDelete: %s\n" % e)
extern crate ProfilesApi;

pub fn main() {
    let id = 56; // Integer
    let orgid = orgid_example; // String

    let mut context = ProfilesApi::Context::default();
    let result = client.profilesDelete(id, orgid, &context).wait();

    println!("{:?}", result);
}
Scopes
Write Write permissions

Parameters

Path parameters

Name Description
id *
Integer (int32)
Required
orgid *
String
Required

Responses

profilesGet

Get a specific profile.

/v1/orgs/{orgid}/profiles/{id}

Usage and Examples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/profiles/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProfilesApi;

import java.io.File;
import java.util.*;

public class ProfilesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        ProfilesApi apiInstance = new ProfilesApi();
        Integer id = 56; // Integer | 
        String orgid = orgid_example; // String | 

        try {
            v1ProfilesGetResponse result = apiInstance.profilesGet(id, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfilesApi#profilesGet");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ProfilesApi;

public class ProfilesApiExample {
    public static void main(String[] args) {
        ProfilesApi apiInstance = new ProfilesApi();
        Integer id = 56; // Integer | 
        String orgid = orgid_example; // String | 

        try {
            v1ProfilesGetResponse result = apiInstance.profilesGet(id, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfilesApi#profilesGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ProfilesApi *apiInstance = [[ProfilesApi alloc] init];
Integer *id = 56; //  (default to null)
String *orgid = orgid_example; //  (default to null)

// Get a specific profile.
[apiInstance profilesGetWith:id
    orgid:orgid
              completionHandler: ^(v1ProfilesGetResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.ProfilesApi()
var id = 56; // {Integer} 
var orgid = orgid_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.profilesGet(id, orgid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class profilesGetExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new ProfilesApi();
            var id = 56;  // Integer |  (default to null)
            var orgid = orgid_example;  // String |  (default to null)

            try {
                // Get a specific profile.
                v1ProfilesGetResponse result = apiInstance.profilesGet(id, orgid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProfilesApi.profilesGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProfilesApi();
$id = 56; // Integer | 
$orgid = orgid_example; // String | 

try {
    $result = $api_instance->profilesGet($id, $orgid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProfilesApi->profilesGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProfilesApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProfilesApi->new();
my $id = 56; # Integer | 
my $orgid = orgid_example; # String | 

eval {
    my $result = $api_instance->profilesGet(id => $id, orgid => $orgid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProfilesApi->profilesGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.ProfilesApi()
id = 56 # Integer |  (default to null)
orgid = orgid_example # String |  (default to null)

try:
    # Get a specific profile.
    api_response = api_instance.profiles_get(id, orgid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProfilesApi->profilesGet: %s\n" % e)
extern crate ProfilesApi;

pub fn main() {
    let id = 56; // Integer
    let orgid = orgid_example; // String

    let mut context = ProfilesApi::Context::default();
    let result = client.profilesGet(id, orgid, &context).wait();

    println!("{:?}", result);
}
Scopes
Read Read permissions

Parameters

Path parameters

Name Description
id *
Integer (int32)
Required
orgid *
String
Required

Responses

profilesList

List all profiles.

/v1/orgs/{orgid}/profiles

Usage and Examples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/profiles"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProfilesApi;

import java.io.File;
import java.util.*;

public class ProfilesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        ProfilesApi apiInstance = new ProfilesApi();
        String orgid = orgid_example; // String | 

        try {
            v1ProfilesListResponse result = apiInstance.profilesList(orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfilesApi#profilesList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ProfilesApi;

public class ProfilesApiExample {
    public static void main(String[] args) {
        ProfilesApi apiInstance = new ProfilesApi();
        String orgid = orgid_example; // String | 

        try {
            v1ProfilesListResponse result = apiInstance.profilesList(orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfilesApi#profilesList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ProfilesApi *apiInstance = [[ProfilesApi alloc] init];
String *orgid = orgid_example; //  (default to null)

// List all profiles.
[apiInstance profilesListWith:orgid
              completionHandler: ^(v1ProfilesListResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.ProfilesApi()
var orgid = orgid_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.profilesList(orgid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class profilesListExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new ProfilesApi();
            var orgid = orgid_example;  // String |  (default to null)

            try {
                // List all profiles.
                v1ProfilesListResponse result = apiInstance.profilesList(orgid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProfilesApi.profilesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProfilesApi();
$orgid = orgid_example; // String | 

try {
    $result = $api_instance->profilesList($orgid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProfilesApi->profilesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProfilesApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProfilesApi->new();
my $orgid = orgid_example; # String | 

eval {
    my $result = $api_instance->profilesList(orgid => $orgid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProfilesApi->profilesList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.ProfilesApi()
orgid = orgid_example # String |  (default to null)

try:
    # List all profiles.
    api_response = api_instance.profiles_list(orgid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProfilesApi->profilesList: %s\n" % e)
extern crate ProfilesApi;

pub fn main() {
    let orgid = orgid_example; // String

    let mut context = ProfilesApi::Context::default();
    let result = client.profilesList(orgid, &context).wait();

    println!("{:?}", result);
}
Scopes
Read Read permissions

Parameters

Path parameters

Name Description
orgid *
String
Required

Responses

profilesUpdate

Update an existing profile.

Update an existing profile. New configuration is pushed to any devices that have the profile assigned to them. If offline, devices pick up the configuration on the next connection.
/v1/orgs/{orgid}/profiles/{id}

Usage and Examples

curl -X PUT \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/profiles/{id}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProfilesApi;

import java.io.File;
import java.util.*;

public class ProfilesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        ProfilesApi apiInstance = new ProfilesApi();
        Integer id = 56; // Integer | 
        String orgid = orgid_example; // String | 
        Apiv1ProfilesUpdateBody apiv1ProfilesUpdateBody = ; // Apiv1ProfilesUpdateBody | 

        try {
            v1ProfilesUpdateResponse result = apiInstance.profilesUpdate(id, orgid, apiv1ProfilesUpdateBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfilesApi#profilesUpdate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ProfilesApi;

public class ProfilesApiExample {
    public static void main(String[] args) {
        ProfilesApi apiInstance = new ProfilesApi();
        Integer id = 56; // Integer | 
        String orgid = orgid_example; // String | 
        Apiv1ProfilesUpdateBody apiv1ProfilesUpdateBody = ; // Apiv1ProfilesUpdateBody | 

        try {
            v1ProfilesUpdateResponse result = apiInstance.profilesUpdate(id, orgid, apiv1ProfilesUpdateBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfilesApi#profilesUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ProfilesApi *apiInstance = [[ProfilesApi alloc] init];
Integer *id = 56; //  (default to null)
String *orgid = orgid_example; //  (default to null)
Apiv1ProfilesUpdateBody *apiv1ProfilesUpdateBody = ; // 

// Update an existing profile.
[apiInstance profilesUpdateWith:id
    orgid:orgid
    apiv1ProfilesUpdateBody:apiv1ProfilesUpdateBody
              completionHandler: ^(v1ProfilesUpdateResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.ProfilesApi()
var id = 56; // {Integer} 
var orgid = orgid_example; // {String} 
var apiv1ProfilesUpdateBody = ; // {Apiv1ProfilesUpdateBody} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.profilesUpdate(id, orgid, apiv1ProfilesUpdateBody, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class profilesUpdateExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new ProfilesApi();
            var id = 56;  // Integer |  (default to null)
            var orgid = orgid_example;  // String |  (default to null)
            var apiv1ProfilesUpdateBody = new Apiv1ProfilesUpdateBody(); // Apiv1ProfilesUpdateBody | 

            try {
                // Update an existing profile.
                v1ProfilesUpdateResponse result = apiInstance.profilesUpdate(id, orgid, apiv1ProfilesUpdateBody);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProfilesApi.profilesUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProfilesApi();
$id = 56; // Integer | 
$orgid = orgid_example; // String | 
$apiv1ProfilesUpdateBody = ; // Apiv1ProfilesUpdateBody | 

try {
    $result = $api_instance->profilesUpdate($id, $orgid, $apiv1ProfilesUpdateBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProfilesApi->profilesUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProfilesApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProfilesApi->new();
my $id = 56; # Integer | 
my $orgid = orgid_example; # String | 
my $apiv1ProfilesUpdateBody = WWW::OPenAPIClient::Object::Apiv1ProfilesUpdateBody->new(); # Apiv1ProfilesUpdateBody | 

eval {
    my $result = $api_instance->profilesUpdate(id => $id, orgid => $orgid, apiv1ProfilesUpdateBody => $apiv1ProfilesUpdateBody);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProfilesApi->profilesUpdate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.ProfilesApi()
id = 56 # Integer |  (default to null)
orgid = orgid_example # String |  (default to null)
apiv1ProfilesUpdateBody =  # Apiv1ProfilesUpdateBody | 

try:
    # Update an existing profile.
    api_response = api_instance.profiles_update(id, orgid, apiv1ProfilesUpdateBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProfilesApi->profilesUpdate: %s\n" % e)
extern crate ProfilesApi;

pub fn main() {
    let id = 56; // Integer
    let orgid = orgid_example; // String
    let apiv1ProfilesUpdateBody = ; // Apiv1ProfilesUpdateBody

    let mut context = ProfilesApi::Context::default();
    let result = client.profilesUpdate(id, orgid, apiv1ProfilesUpdateBody, &context).wait();

    println!("{:?}", result);
}
Scopes
Write Write permissions

Parameters

Path parameters

Name Description
id *
Integer (int32)
Required
orgid *
String
Required

Body parameters

Name Description
apiv1ProfilesUpdateBody *

Responses

Regions

regionsCreate

Create a region.

/v1/orgs/{orgid}/regions

Usage and Examples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/regions" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RegionsApi;

import java.io.File;
import java.util.*;

public class RegionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        RegionsApi apiInstance = new RegionsApi();
        String orgid = orgid_example; // String | 
        RegionsCreateRequest regionsCreateRequest = ; // RegionsCreateRequest | 

        try {
            webpageRegion result = apiInstance.regionsCreate(orgid, regionsCreateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionsApi#regionsCreate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RegionsApi;

public class RegionsApiExample {
    public static void main(String[] args) {
        RegionsApi apiInstance = new RegionsApi();
        String orgid = orgid_example; // String | 
        RegionsCreateRequest regionsCreateRequest = ; // RegionsCreateRequest | 

        try {
            webpageRegion result = apiInstance.regionsCreate(orgid, regionsCreateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionsApi#regionsCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RegionsApi *apiInstance = [[RegionsApi alloc] init];
String *orgid = orgid_example; //  (default to null)
RegionsCreateRequest *regionsCreateRequest = ; // 

// Create a region.
[apiInstance regionsCreateWith:orgid
    regionsCreateRequest:regionsCreateRequest
              completionHandler: ^(webpageRegion output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.RegionsApi()
var orgid = orgid_example; // {String} 
var regionsCreateRequest = ; // {RegionsCreateRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.regionsCreate(orgid, regionsCreateRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class regionsCreateExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new RegionsApi();
            var orgid = orgid_example;  // String |  (default to null)
            var regionsCreateRequest = new RegionsCreateRequest(); // RegionsCreateRequest | 

            try {
                // Create a region.
                webpageRegion result = apiInstance.regionsCreate(orgid, regionsCreateRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RegionsApi.regionsCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RegionsApi();
$orgid = orgid_example; // String | 
$regionsCreateRequest = ; // RegionsCreateRequest | 

try {
    $result = $api_instance->regionsCreate($orgid, $regionsCreateRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RegionsApi->regionsCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RegionsApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RegionsApi->new();
my $orgid = orgid_example; # String | 
my $regionsCreateRequest = WWW::OPenAPIClient::Object::RegionsCreateRequest->new(); # RegionsCreateRequest | 

eval {
    my $result = $api_instance->regionsCreate(orgid => $orgid, regionsCreateRequest => $regionsCreateRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RegionsApi->regionsCreate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.RegionsApi()
orgid = orgid_example # String |  (default to null)
regionsCreateRequest =  # RegionsCreateRequest | 

try:
    # Create a region.
    api_response = api_instance.regions_create(orgid, regionsCreateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionsApi->regionsCreate: %s\n" % e)
extern crate RegionsApi;

pub fn main() {
    let orgid = orgid_example; // String
    let regionsCreateRequest = ; // RegionsCreateRequest

    let mut context = RegionsApi::Context::default();
    let result = client.regionsCreate(orgid, regionsCreateRequest, &context).wait();

    println!("{:?}", result);
}
Scopes
Write Write permissions

Parameters

Path parameters

Name Description
orgid *
String
Required

Body parameters

Name Description
regionsCreateRequest *

Responses

regionsDelete

Delete a region.

Deletes a region. This operation will fail if the region has any locations assigned to it.
/v1/orgs/{orgid}/regions/{id}

Usage and Examples

curl -X DELETE \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/regions/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RegionsApi;

import java.io.File;
import java.util.*;

public class RegionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        RegionsApi apiInstance = new RegionsApi();
        Integer id = 56; // Integer | 
        String orgid = orgid_example; // String | 

        try {
            Object result = apiInstance.regionsDelete(id, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionsApi#regionsDelete");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RegionsApi;

public class RegionsApiExample {
    public static void main(String[] args) {
        RegionsApi apiInstance = new RegionsApi();
        Integer id = 56; // Integer | 
        String orgid = orgid_example; // String | 

        try {
            Object result = apiInstance.regionsDelete(id, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionsApi#regionsDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RegionsApi *apiInstance = [[RegionsApi alloc] init];
Integer *id = 56; //  (default to null)
String *orgid = orgid_example; //  (default to null)

// Delete a region.
[apiInstance regionsDeleteWith:id
    orgid:orgid
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.RegionsApi()
var id = 56; // {Integer} 
var orgid = orgid_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.regionsDelete(id, orgid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class regionsDeleteExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new RegionsApi();
            var id = 56;  // Integer |  (default to null)
            var orgid = orgid_example;  // String |  (default to null)

            try {
                // Delete a region.
                Object result = apiInstance.regionsDelete(id, orgid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RegionsApi.regionsDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RegionsApi();
$id = 56; // Integer | 
$orgid = orgid_example; // String | 

try {
    $result = $api_instance->regionsDelete($id, $orgid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RegionsApi->regionsDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RegionsApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RegionsApi->new();
my $id = 56; # Integer | 
my $orgid = orgid_example; # String | 

eval {
    my $result = $api_instance->regionsDelete(id => $id, orgid => $orgid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RegionsApi->regionsDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.RegionsApi()
id = 56 # Integer |  (default to null)
orgid = orgid_example # String |  (default to null)

try:
    # Delete a region.
    api_response = api_instance.regions_delete(id, orgid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionsApi->regionsDelete: %s\n" % e)
extern crate RegionsApi;

pub fn main() {
    let id = 56; // Integer
    let orgid = orgid_example; // String

    let mut context = RegionsApi::Context::default();
    let result = client.regionsDelete(id, orgid, &context).wait();

    println!("{:?}", result);
}
Scopes
Write Write permissions

Parameters

Path parameters

Name Description
id *
Integer (int32)
Required
orgid *
String
Required

Responses

regionsList

List all regions.

Lists all regions and the locations assigned to them.
/v1/orgs/{orgid}/regions

Usage and Examples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/regions"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RegionsApi;

import java.io.File;
import java.util.*;

public class RegionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        RegionsApi apiInstance = new RegionsApi();
        String orgid = orgid_example; // String | 

        try {
            webpageRegionList result = apiInstance.regionsList(orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionsApi#regionsList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RegionsApi;

public class RegionsApiExample {
    public static void main(String[] args) {
        RegionsApi apiInstance = new RegionsApi();
        String orgid = orgid_example; // String | 

        try {
            webpageRegionList result = apiInstance.regionsList(orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionsApi#regionsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RegionsApi *apiInstance = [[RegionsApi alloc] init];
String *orgid = orgid_example; //  (default to null)

// List all regions.
[apiInstance regionsListWith:orgid
              completionHandler: ^(webpageRegionList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.RegionsApi()
var orgid = orgid_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.regionsList(orgid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class regionsListExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new RegionsApi();
            var orgid = orgid_example;  // String |  (default to null)

            try {
                // List all regions.
                webpageRegionList result = apiInstance.regionsList(orgid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RegionsApi.regionsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RegionsApi();
$orgid = orgid_example; // String | 

try {
    $result = $api_instance->regionsList($orgid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RegionsApi->regionsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RegionsApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RegionsApi->new();
my $orgid = orgid_example; # String | 

eval {
    my $result = $api_instance->regionsList(orgid => $orgid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RegionsApi->regionsList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.RegionsApi()
orgid = orgid_example # String |  (default to null)

try:
    # List all regions.
    api_response = api_instance.regions_list(orgid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionsApi->regionsList: %s\n" % e)
extern crate RegionsApi;

pub fn main() {
    let orgid = orgid_example; // String

    let mut context = RegionsApi::Context::default();
    let result = client.regionsList(orgid, &context).wait();

    println!("{:?}", result);
}
Scopes
Read Read permissions

Parameters

Path parameters

Name Description
orgid *
String
Required

Responses

regionsUpdate

Update a region.

Changes the name of a region.
/v1/orgs/{orgid}/regions/{id}

Usage and Examples

curl -X PUT \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/regions/{id}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RegionsApi;

import java.io.File;
import java.util.*;

public class RegionsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        RegionsApi apiInstance = new RegionsApi();
        Integer id = 56; // Integer | 
        String orgid = orgid_example; // String | 
        WebpageRegionsUpdateBody webpageRegionsUpdateBody = ; // WebpageRegionsUpdateBody | 

        try {
            webpageUpdateRegionResponse result = apiInstance.regionsUpdate(id, orgid, webpageRegionsUpdateBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionsApi#regionsUpdate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RegionsApi;

public class RegionsApiExample {
    public static void main(String[] args) {
        RegionsApi apiInstance = new RegionsApi();
        Integer id = 56; // Integer | 
        String orgid = orgid_example; // String | 
        WebpageRegionsUpdateBody webpageRegionsUpdateBody = ; // WebpageRegionsUpdateBody | 

        try {
            webpageUpdateRegionResponse result = apiInstance.regionsUpdate(id, orgid, webpageRegionsUpdateBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionsApi#regionsUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RegionsApi *apiInstance = [[RegionsApi alloc] init];
Integer *id = 56; //  (default to null)
String *orgid = orgid_example; //  (default to null)
WebpageRegionsUpdateBody *webpageRegionsUpdateBody = ; // 

// Update a region.
[apiInstance regionsUpdateWith:id
    orgid:orgid
    webpageRegionsUpdateBody:webpageRegionsUpdateBody
              completionHandler: ^(webpageUpdateRegionResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.RegionsApi()
var id = 56; // {Integer} 
var orgid = orgid_example; // {String} 
var webpageRegionsUpdateBody = ; // {WebpageRegionsUpdateBody} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.regionsUpdate(id, orgid, webpageRegionsUpdateBody, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class regionsUpdateExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new RegionsApi();
            var id = 56;  // Integer |  (default to null)
            var orgid = orgid_example;  // String |  (default to null)
            var webpageRegionsUpdateBody = new WebpageRegionsUpdateBody(); // WebpageRegionsUpdateBody | 

            try {
                // Update a region.
                webpageUpdateRegionResponse result = apiInstance.regionsUpdate(id, orgid, webpageRegionsUpdateBody);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RegionsApi.regionsUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RegionsApi();
$id = 56; // Integer | 
$orgid = orgid_example; // String | 
$webpageRegionsUpdateBody = ; // WebpageRegionsUpdateBody | 

try {
    $result = $api_instance->regionsUpdate($id, $orgid, $webpageRegionsUpdateBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RegionsApi->regionsUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RegionsApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RegionsApi->new();
my $id = 56; # Integer | 
my $orgid = orgid_example; # String | 
my $webpageRegionsUpdateBody = WWW::OPenAPIClient::Object::WebpageRegionsUpdateBody->new(); # WebpageRegionsUpdateBody | 

eval {
    my $result = $api_instance->regionsUpdate(id => $id, orgid => $orgid, webpageRegionsUpdateBody => $webpageRegionsUpdateBody);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RegionsApi->regionsUpdate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.RegionsApi()
id = 56 # Integer |  (default to null)
orgid = orgid_example # String |  (default to null)
webpageRegionsUpdateBody =  # WebpageRegionsUpdateBody | 

try:
    # Update a region.
    api_response = api_instance.regions_update(id, orgid, webpageRegionsUpdateBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionsApi->regionsUpdate: %s\n" % e)
extern crate RegionsApi;

pub fn main() {
    let id = 56; // Integer
    let orgid = orgid_example; // String
    let webpageRegionsUpdateBody = ; // WebpageRegionsUpdateBody

    let mut context = RegionsApi::Context::default();
    let result = client.regionsUpdate(id, orgid, webpageRegionsUpdateBody, &context).wait();

    println!("{:?}", result);
}
Scopes
Write Write permissions

Parameters

Path parameters

Name Description
id *
Integer (int32)
Required
orgid *
String
Required

Body parameters

Name Description
webpageRegionsUpdateBody *

Responses

Rooms

roomsAssignProfile

Assign a profile to a room and all the devices in that room.

Assigns a profile to a room. The new configuration is pushed to all devices in the room. Any devices newly enrolled in the room will pick up the configuration.
/v1/orgs/{orgid}/rooms/{roomId}/profile/{profileId}

Usage and Examples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/rooms/{roomId}/profile/{profileId}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoomsApi;

import java.io.File;
import java.util.*;

public class RoomsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        RoomsApi apiInstance = new RoomsApi();
        Integer roomId = 56; // Integer | 
        Integer profileId = 56; // Integer | 
        String orgid = orgid_example; // String | 
        Object body = Object; // Object | 

        try {
            Object result = apiInstance.roomsAssignProfile(roomId, profileId, orgid, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoomsApi#roomsAssignProfile");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoomsApi;

public class RoomsApiExample {
    public static void main(String[] args) {
        RoomsApi apiInstance = new RoomsApi();
        Integer roomId = 56; // Integer | 
        Integer profileId = 56; // Integer | 
        String orgid = orgid_example; // String | 
        Object body = Object; // Object | 

        try {
            Object result = apiInstance.roomsAssignProfile(roomId, profileId, orgid, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoomsApi#roomsAssignProfile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RoomsApi *apiInstance = [[RoomsApi alloc] init];
Integer *roomId = 56; //  (default to null)
Integer *profileId = 56; //  (default to null)
String *orgid = orgid_example; //  (default to null)
Object *body = Object; // 

// Assign a profile to a room and all the devices in that room.
[apiInstance roomsAssignProfileWith:roomId
    profileId:profileId
    orgid:orgid
    body:body
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.RoomsApi()
var roomId = 56; // {Integer} 
var profileId = 56; // {Integer} 
var orgid = orgid_example; // {String} 
var body = Object; // {Object} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.roomsAssignProfile(roomId, profileId, orgid, body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class roomsAssignProfileExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new RoomsApi();
            var roomId = 56;  // Integer |  (default to null)
            var profileId = 56;  // Integer |  (default to null)
            var orgid = orgid_example;  // String |  (default to null)
            var body = Object;  // Object | 

            try {
                // Assign a profile to a room and all the devices in that room.
                Object result = apiInstance.roomsAssignProfile(roomId, profileId, orgid, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoomsApi.roomsAssignProfile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoomsApi();
$roomId = 56; // Integer | 
$profileId = 56; // Integer | 
$orgid = orgid_example; // String | 
$body = Object; // Object | 

try {
    $result = $api_instance->roomsAssignProfile($roomId, $profileId, $orgid, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoomsApi->roomsAssignProfile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RoomsApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoomsApi->new();
my $roomId = 56; # Integer | 
my $profileId = 56; # Integer | 
my $orgid = orgid_example; # String | 
my $body = WWW::OPenAPIClient::Object::Object->new(); # Object | 

eval {
    my $result = $api_instance->roomsAssignProfile(roomId => $roomId, profileId => $profileId, orgid => $orgid, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoomsApi->roomsAssignProfile: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.RoomsApi()
roomId = 56 # Integer |  (default to null)
profileId = 56 # Integer |  (default to null)
orgid = orgid_example # String |  (default to null)
body = Object # Object | 

try:
    # Assign a profile to a room and all the devices in that room.
    api_response = api_instance.rooms_assign_profile(roomId, profileId, orgid, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoomsApi->roomsAssignProfile: %s\n" % e)
extern crate RoomsApi;

pub fn main() {
    let roomId = 56; // Integer
    let profileId = 56; // Integer
    let orgid = orgid_example; // String
    let body = Object; // Object

    let mut context = RoomsApi::Context::default();
    let result = client.roomsAssignProfile(roomId, profileId, orgid, body, &context).wait();

    println!("{:?}", result);
}
Scopes
Write Write permissions

Parameters

Path parameters

Name Description
roomId *
Integer (int32)
Required
profileId *
Integer (int32)
Required
orgid *
String
Required

Body parameters

Name Description
body *

Responses

roomsBulkSensorData

Get sensor data for all rooms in an organisation.

Returns the aggregated sensor data sample per room for an organisation. If no sensor data sample is available for a room then null is returned. If the organisation has no endpoints then an error is returned.
/v1/orgs/{orgid}/rooms/sensor

Usage and Examples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/rooms/sensor?regionId=56&locationId=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoomsApi;

import java.io.File;
import java.util.*;

public class RoomsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        RoomsApi apiInstance = new RoomsApi();
        String orgid = orgid_example; // String | 
        Integer regionId = 56; // Integer | 
        Integer locationId = 56; // Integer | 

        try {
            webpageGetRoomsSensorDataResponse result = apiInstance.roomsBulkSensorData(orgid, regionId, locationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoomsApi#roomsBulkSensorData");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoomsApi;

public class RoomsApiExample {
    public static void main(String[] args) {
        RoomsApi apiInstance = new RoomsApi();
        String orgid = orgid_example; // String | 
        Integer regionId = 56; // Integer | 
        Integer locationId = 56; // Integer | 

        try {
            webpageGetRoomsSensorDataResponse result = apiInstance.roomsBulkSensorData(orgid, regionId, locationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoomsApi#roomsBulkSensorData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RoomsApi *apiInstance = [[RoomsApi alloc] init];
String *orgid = orgid_example; //  (default to null)
Integer *regionId = 56; //  (optional) (default to null)
Integer *locationId = 56; //  (optional) (default to null)

// Get sensor data for all rooms in an organisation.
[apiInstance roomsBulkSensorDataWith:orgid
    regionId:regionId
    locationId:locationId
              completionHandler: ^(webpageGetRoomsSensorDataResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.RoomsApi()
var orgid = orgid_example; // {String} 
var opts = {
  'regionId': 56, // {Integer} 
  'locationId': 56 // {Integer} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.roomsBulkSensorData(orgid, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class roomsBulkSensorDataExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new RoomsApi();
            var orgid = orgid_example;  // String |  (default to null)
            var regionId = 56;  // Integer |  (optional)  (default to null)
            var locationId = 56;  // Integer |  (optional)  (default to null)

            try {
                // Get sensor data for all rooms in an organisation.
                webpageGetRoomsSensorDataResponse result = apiInstance.roomsBulkSensorData(orgid, regionId, locationId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoomsApi.roomsBulkSensorData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoomsApi();
$orgid = orgid_example; // String | 
$regionId = 56; // Integer | 
$locationId = 56; // Integer | 

try {
    $result = $api_instance->roomsBulkSensorData($orgid, $regionId, $locationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoomsApi->roomsBulkSensorData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RoomsApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoomsApi->new();
my $orgid = orgid_example; # String | 
my $regionId = 56; # Integer | 
my $locationId = 56; # Integer | 

eval {
    my $result = $api_instance->roomsBulkSensorData(orgid => $orgid, regionId => $regionId, locationId => $locationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoomsApi->roomsBulkSensorData: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.RoomsApi()
orgid = orgid_example # String |  (default to null)
regionId = 56 # Integer |  (optional) (default to null)
locationId = 56 # Integer |  (optional) (default to null)

try:
    # Get sensor data for all rooms in an organisation.
    api_response = api_instance.rooms_bulk_sensor_data(orgid, regionId=regionId, locationId=locationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoomsApi->roomsBulkSensorData: %s\n" % e)
extern crate RoomsApi;

pub fn main() {
    let orgid = orgid_example; // String
    let regionId = 56; // Integer
    let locationId = 56; // Integer

    let mut context = RoomsApi::Context::default();
    let result = client.roomsBulkSensorData(orgid, regionId, locationId, &context).wait();

    println!("{:?}", result);
}
Scopes
Read Read permissions

Parameters

Path parameters

Name Description
orgid *
String
Required

Query parameters

Name Description
regionId
Integer (int32)
locationId
Integer (int32)

Responses

roomsCreate

Create a room.

Adds a new room, optionally assigning it to an existing location.
/v1/orgs/{orgid}/rooms

Usage and Examples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/rooms" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoomsApi;

import java.io.File;
import java.util.*;

public class RoomsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        RoomsApi apiInstance = new RoomsApi();
        String orgid = orgid_example; // String | 
        RoomsCreateRequest roomsCreateRequest = ; // RoomsCreateRequest | 

        try {
            webpageCreateRoomResponse result = apiInstance.roomsCreate(orgid, roomsCreateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoomsApi#roomsCreate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoomsApi;

public class RoomsApiExample {
    public static void main(String[] args) {
        RoomsApi apiInstance = new RoomsApi();
        String orgid = orgid_example; // String | 
        RoomsCreateRequest roomsCreateRequest = ; // RoomsCreateRequest | 

        try {
            webpageCreateRoomResponse result = apiInstance.roomsCreate(orgid, roomsCreateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoomsApi#roomsCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RoomsApi *apiInstance = [[RoomsApi alloc] init];
String *orgid = orgid_example; //  (default to null)
RoomsCreateRequest *roomsCreateRequest = ; // 

// Create a room.
[apiInstance roomsCreateWith:orgid
    roomsCreateRequest:roomsCreateRequest
              completionHandler: ^(webpageCreateRoomResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.RoomsApi()
var orgid = orgid_example; // {String} 
var roomsCreateRequest = ; // {RoomsCreateRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.roomsCreate(orgid, roomsCreateRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class roomsCreateExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new RoomsApi();
            var orgid = orgid_example;  // String |  (default to null)
            var roomsCreateRequest = new RoomsCreateRequest(); // RoomsCreateRequest | 

            try {
                // Create a room.
                webpageCreateRoomResponse result = apiInstance.roomsCreate(orgid, roomsCreateRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoomsApi.roomsCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoomsApi();
$orgid = orgid_example; // String | 
$roomsCreateRequest = ; // RoomsCreateRequest | 

try {
    $result = $api_instance->roomsCreate($orgid, $roomsCreateRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoomsApi->roomsCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RoomsApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoomsApi->new();
my $orgid = orgid_example; # String | 
my $roomsCreateRequest = WWW::OPenAPIClient::Object::RoomsCreateRequest->new(); # RoomsCreateRequest | 

eval {
    my $result = $api_instance->roomsCreate(orgid => $orgid, roomsCreateRequest => $roomsCreateRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoomsApi->roomsCreate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.RoomsApi()
orgid = orgid_example # String |  (default to null)
roomsCreateRequest =  # RoomsCreateRequest | 

try:
    # Create a room.
    api_response = api_instance.rooms_create(orgid, roomsCreateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoomsApi->roomsCreate: %s\n" % e)
extern crate RoomsApi;

pub fn main() {
    let orgid = orgid_example; // String
    let roomsCreateRequest = ; // RoomsCreateRequest

    let mut context = RoomsApi::Context::default();
    let result = client.roomsCreate(orgid, roomsCreateRequest, &context).wait();

    println!("{:?}", result);
}
Scopes
Write Write permissions

Parameters

Path parameters

Name Description
orgid *
String
Required

Body parameters

Name Description
roomsCreateRequest *

Responses

roomsDelete

Delete a room.

Deletes a room. If there are endpoints enrolled to this room, they will be unenrolled.
/v1/orgs/{orgid}/rooms/{id}

Usage and Examples

curl -X DELETE \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/rooms/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoomsApi;

import java.io.File;
import java.util.*;

public class RoomsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        RoomsApi apiInstance = new RoomsApi();
        Integer id = 56; // Integer | 
        String orgid = orgid_example; // String | 

        try {
            Object result = apiInstance.roomsDelete(id, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoomsApi#roomsDelete");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoomsApi;

public class RoomsApiExample {
    public static void main(String[] args) {
        RoomsApi apiInstance = new RoomsApi();
        Integer id = 56; // Integer | 
        String orgid = orgid_example; // String | 

        try {
            Object result = apiInstance.roomsDelete(id, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoomsApi#roomsDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RoomsApi *apiInstance = [[RoomsApi alloc] init];
Integer *id = 56; //  (default to null)
String *orgid = orgid_example; //  (default to null)

// Delete a room.
[apiInstance roomsDeleteWith:id
    orgid:orgid
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.RoomsApi()
var id = 56; // {Integer} 
var orgid = orgid_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.roomsDelete(id, orgid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class roomsDeleteExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new RoomsApi();
            var id = 56;  // Integer |  (default to null)
            var orgid = orgid_example;  // String |  (default to null)

            try {
                // Delete a room.
                Object result = apiInstance.roomsDelete(id, orgid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoomsApi.roomsDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoomsApi();
$id = 56; // Integer | 
$orgid = orgid_example; // String | 

try {
    $result = $api_instance->roomsDelete($id, $orgid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoomsApi->roomsDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RoomsApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoomsApi->new();
my $id = 56; # Integer | 
my $orgid = orgid_example; # String | 

eval {
    my $result = $api_instance->roomsDelete(id => $id, orgid => $orgid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoomsApi->roomsDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.RoomsApi()
id = 56 # Integer |  (default to null)
orgid = orgid_example # String |  (default to null)

try:
    # Delete a room.
    api_response = api_instance.rooms_delete(id, orgid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoomsApi->roomsDelete: %s\n" % e)
extern crate RoomsApi;

pub fn main() {
    let id = 56; // Integer
    let orgid = orgid_example; // String

    let mut context = RoomsApi::Context::default();
    let result = client.roomsDelete(id, orgid, &context).wait();

    println!("{:?}", result);
}
Scopes
Write Write permissions

Parameters

Path parameters

Name Description
id *
Integer (int32)
Required
orgid *
String
Required

Responses

roomsGet

Get a room.

Gets a room's details, including the endpoints enrolled to it.
/v1/orgs/{orgid}/rooms/{id}

Usage and Examples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/rooms/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoomsApi;

import java.io.File;
import java.util.*;

public class RoomsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        RoomsApi apiInstance = new RoomsApi();
        Integer id = 56; // Integer | 
        String orgid = orgid_example; // String | 

        try {
            webpageRoom result = apiInstance.roomsGet(id, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoomsApi#roomsGet");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoomsApi;

public class RoomsApiExample {
    public static void main(String[] args) {
        RoomsApi apiInstance = new RoomsApi();
        Integer id = 56; // Integer | 
        String orgid = orgid_example; // String | 

        try {
            webpageRoom result = apiInstance.roomsGet(id, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoomsApi#roomsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RoomsApi *apiInstance = [[RoomsApi alloc] init];
Integer *id = 56; //  (default to null)
String *orgid = orgid_example; //  (default to null)

// Get a room.
[apiInstance roomsGetWith:id
    orgid:orgid
              completionHandler: ^(webpageRoom output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.RoomsApi()
var id = 56; // {Integer} 
var orgid = orgid_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.roomsGet(id, orgid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class roomsGetExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new RoomsApi();
            var id = 56;  // Integer |  (default to null)
            var orgid = orgid_example;  // String |  (default to null)

            try {
                // Get a room.
                webpageRoom result = apiInstance.roomsGet(id, orgid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoomsApi.roomsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoomsApi();
$id = 56; // Integer | 
$orgid = orgid_example; // String | 

try {
    $result = $api_instance->roomsGet($id, $orgid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoomsApi->roomsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RoomsApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoomsApi->new();
my $id = 56; # Integer | 
my $orgid = orgid_example; # String | 

eval {
    my $result = $api_instance->roomsGet(id => $id, orgid => $orgid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoomsApi->roomsGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.RoomsApi()
id = 56 # Integer |  (default to null)
orgid = orgid_example # String |  (default to null)

try:
    # Get a room.
    api_response = api_instance.rooms_get(id, orgid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoomsApi->roomsGet: %s\n" % e)
extern crate RoomsApi;

pub fn main() {
    let id = 56; // Integer
    let orgid = orgid_example; // String

    let mut context = RoomsApi::Context::default();
    let result = client.roomsGet(id, orgid, &context).wait();

    println!("{:?}", result);
}
Scopes
Read Read permissions

Parameters

Path parameters

Name Description
id *
Integer (int32)
Required
orgid *
String
Required

Responses

roomsGetSensorData

Get a room's sensor data.

Get an aggregated sensor data sample for the room.
/v1/orgs/{orgid}/rooms/{id}/sensor

Usage and Examples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/rooms/{id}/sensor"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoomsApi;

import java.io.File;
import java.util.*;

public class RoomsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        RoomsApi apiInstance = new RoomsApi();
        Integer id = 56; // Integer | 
        String orgid = orgid_example; // String | 

        try {
            webpageGetRoomSensorDataResponse result = apiInstance.roomsGetSensorData(id, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoomsApi#roomsGetSensorData");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoomsApi;

public class RoomsApiExample {
    public static void main(String[] args) {
        RoomsApi apiInstance = new RoomsApi();
        Integer id = 56; // Integer | 
        String orgid = orgid_example; // String | 

        try {
            webpageGetRoomSensorDataResponse result = apiInstance.roomsGetSensorData(id, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoomsApi#roomsGetSensorData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RoomsApi *apiInstance = [[RoomsApi alloc] init];
Integer *id = 56; //  (default to null)
String *orgid = orgid_example; //  (default to null)

// Get a room's sensor data.
[apiInstance roomsGetSensorDataWith:id
    orgid:orgid
              completionHandler: ^(webpageGetRoomSensorDataResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.RoomsApi()
var id = 56; // {Integer} 
var orgid = orgid_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.roomsGetSensorData(id, orgid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class roomsGetSensorDataExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new RoomsApi();
            var id = 56;  // Integer |  (default to null)
            var orgid = orgid_example;  // String |  (default to null)

            try {
                // Get a room's sensor data.
                webpageGetRoomSensorDataResponse result = apiInstance.roomsGetSensorData(id, orgid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoomsApi.roomsGetSensorData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoomsApi();
$id = 56; // Integer | 
$orgid = orgid_example; // String | 

try {
    $result = $api_instance->roomsGetSensorData($id, $orgid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoomsApi->roomsGetSensorData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RoomsApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoomsApi->new();
my $id = 56; # Integer | 
my $orgid = orgid_example; # String | 

eval {
    my $result = $api_instance->roomsGetSensorData(id => $id, orgid => $orgid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoomsApi->roomsGetSensorData: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.RoomsApi()
id = 56 # Integer |  (default to null)
orgid = orgid_example # String |  (default to null)

try:
    # Get a room's sensor data.
    api_response = api_instance.rooms_get_sensor_data(id, orgid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoomsApi->roomsGetSensorData: %s\n" % e)
extern crate RoomsApi;

pub fn main() {
    let id = 56; // Integer
    let orgid = orgid_example; // String

    let mut context = RoomsApi::Context::default();
    let result = client.roomsGetSensorData(id, orgid, &context).wait();

    println!("{:?}", result);
}
Scopes
Read Read permissions

Parameters

Path parameters

Name Description
id *
Integer (int32)
Required
orgid *
String
Required

Responses

roomsList

List all rooms.

/v1/orgs/{orgid}/rooms

Usage and Examples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/rooms"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoomsApi;

import java.io.File;
import java.util.*;

public class RoomsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        RoomsApi apiInstance = new RoomsApi();
        String orgid = orgid_example; // String | 

        try {
            webpageBasicRoomList result = apiInstance.roomsList(orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoomsApi#roomsList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoomsApi;

public class RoomsApiExample {
    public static void main(String[] args) {
        RoomsApi apiInstance = new RoomsApi();
        String orgid = orgid_example; // String | 

        try {
            webpageBasicRoomList result = apiInstance.roomsList(orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoomsApi#roomsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RoomsApi *apiInstance = [[RoomsApi alloc] init];
String *orgid = orgid_example; //  (default to null)

// List all rooms.
[apiInstance roomsListWith:orgid
              completionHandler: ^(webpageBasicRoomList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.RoomsApi()
var orgid = orgid_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.roomsList(orgid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class roomsListExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new RoomsApi();
            var orgid = orgid_example;  // String |  (default to null)

            try {
                // List all rooms.
                webpageBasicRoomList result = apiInstance.roomsList(orgid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoomsApi.roomsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoomsApi();
$orgid = orgid_example; // String | 

try {
    $result = $api_instance->roomsList($orgid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoomsApi->roomsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RoomsApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoomsApi->new();
my $orgid = orgid_example; # String | 

eval {
    my $result = $api_instance->roomsList(orgid => $orgid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoomsApi->roomsList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.RoomsApi()
orgid = orgid_example # String |  (default to null)

try:
    # List all rooms.
    api_response = api_instance.rooms_list(orgid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoomsApi->roomsList: %s\n" % e)
extern crate RoomsApi;

pub fn main() {
    let orgid = orgid_example; // String

    let mut context = RoomsApi::Context::default();
    let result = client.roomsList(orgid, &context).wait();

    println!("{:?}", result);
}
Scopes
Read Read permissions

Parameters

Path parameters

Name Description
orgid *
String
Required

Responses

roomsRegenerateDec

Regenerate device enrolment code.

Adds a new device enrolment code, overriding a possible previous one.
/v1/orgs/{orgid}/rooms/{id}/regenerate_dec

Usage and Examples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/rooms/{id}/regenerate_dec"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoomsApi;

import java.io.File;
import java.util.*;

public class RoomsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        RoomsApi apiInstance = new RoomsApi();
        Integer id = 56; // Integer | 
        String orgid = orgid_example; // String | 

        try {
            webpageAddDeviceRoomResponse result = apiInstance.roomsRegenerateDec(id, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoomsApi#roomsRegenerateDec");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoomsApi;

public class RoomsApiExample {
    public static void main(String[] args) {
        RoomsApi apiInstance = new RoomsApi();
        Integer id = 56; // Integer | 
        String orgid = orgid_example; // String | 

        try {
            webpageAddDeviceRoomResponse result = apiInstance.roomsRegenerateDec(id, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoomsApi#roomsRegenerateDec");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RoomsApi *apiInstance = [[RoomsApi alloc] init];
Integer *id = 56; //  (default to null)
String *orgid = orgid_example; //  (default to null)

// Regenerate device enrolment code.
[apiInstance roomsRegenerateDecWith:id
    orgid:orgid
              completionHandler: ^(webpageAddDeviceRoomResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.RoomsApi()
var id = 56; // {Integer} 
var orgid = orgid_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.roomsRegenerateDec(id, orgid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class roomsRegenerateDecExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new RoomsApi();
            var id = 56;  // Integer |  (default to null)
            var orgid = orgid_example;  // String |  (default to null)

            try {
                // Regenerate device enrolment code.
                webpageAddDeviceRoomResponse result = apiInstance.roomsRegenerateDec(id, orgid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoomsApi.roomsRegenerateDec: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoomsApi();
$id = 56; // Integer | 
$orgid = orgid_example; // String | 

try {
    $result = $api_instance->roomsRegenerateDec($id, $orgid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoomsApi->roomsRegenerateDec: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RoomsApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoomsApi->new();
my $id = 56; # Integer | 
my $orgid = orgid_example; # String | 

eval {
    my $result = $api_instance->roomsRegenerateDec(id => $id, orgid => $orgid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoomsApi->roomsRegenerateDec: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.RoomsApi()
id = 56 # Integer |  (default to null)
orgid = orgid_example # String |  (default to null)

try:
    # Regenerate device enrolment code.
    api_response = api_instance.rooms_regenerate_dec(id, orgid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoomsApi->roomsRegenerateDec: %s\n" % e)
extern crate RoomsApi;

pub fn main() {
    let id = 56; // Integer
    let orgid = orgid_example; // String

    let mut context = RoomsApi::Context::default();
    let result = client.roomsRegenerateDec(id, orgid, &context).wait();

    println!("{:?}", result);
}
Scopes
Write Write permissions

Parameters

Path parameters

Name Description
id *
Integer (int32)
Required
orgid *
String
Required

Responses

roomsUnassignProfile

Unassign a profile from a room and all the devices in that room.

Unassigns the current profile from a room and all devices in it.The configurations of these devices are unchanged.
/v1/orgs/{orgid}/rooms/{roomId}/profile

Usage and Examples

curl -X DELETE \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/rooms/{roomId}/profile"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoomsApi;

import java.io.File;
import java.util.*;

public class RoomsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        RoomsApi apiInstance = new RoomsApi();
        Integer roomId = 56; // Integer | 
        String orgid = orgid_example; // String | 

        try {
            Object result = apiInstance.roomsUnassignProfile(roomId, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoomsApi#roomsUnassignProfile");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoomsApi;

public class RoomsApiExample {
    public static void main(String[] args) {
        RoomsApi apiInstance = new RoomsApi();
        Integer roomId = 56; // Integer | 
        String orgid = orgid_example; // String | 

        try {
            Object result = apiInstance.roomsUnassignProfile(roomId, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoomsApi#roomsUnassignProfile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RoomsApi *apiInstance = [[RoomsApi alloc] init];
Integer *roomId = 56; //  (default to null)
String *orgid = orgid_example; //  (default to null)

// Unassign a profile from a room and all the devices in that room.
[apiInstance roomsUnassignProfileWith:roomId
    orgid:orgid
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.RoomsApi()
var roomId = 56; // {Integer} 
var orgid = orgid_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.roomsUnassignProfile(roomId, orgid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class roomsUnassignProfileExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new RoomsApi();
            var roomId = 56;  // Integer |  (default to null)
            var orgid = orgid_example;  // String |  (default to null)

            try {
                // Unassign a profile from a room and all the devices in that room.
                Object result = apiInstance.roomsUnassignProfile(roomId, orgid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoomsApi.roomsUnassignProfile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoomsApi();
$roomId = 56; // Integer | 
$orgid = orgid_example; // String | 

try {
    $result = $api_instance->roomsUnassignProfile($roomId, $orgid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoomsApi->roomsUnassignProfile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RoomsApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoomsApi->new();
my $roomId = 56; # Integer | 
my $orgid = orgid_example; # String | 

eval {
    my $result = $api_instance->roomsUnassignProfile(roomId => $roomId, orgid => $orgid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoomsApi->roomsUnassignProfile: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.RoomsApi()
roomId = 56 # Integer |  (default to null)
orgid = orgid_example # String |  (default to null)

try:
    # Unassign a profile from a room and all the devices in that room.
    api_response = api_instance.rooms_unassign_profile(roomId, orgid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoomsApi->roomsUnassignProfile: %s\n" % e)
extern crate RoomsApi;

pub fn main() {
    let roomId = 56; // Integer
    let orgid = orgid_example; // String

    let mut context = RoomsApi::Context::default();
    let result = client.roomsUnassignProfile(roomId, orgid, &context).wait();

    println!("{:?}", result);
}
Scopes
Write Write permissions

Parameters

Path parameters

Name Description
roomId *
Integer (int32)
Required
orgid *
String
Required

Responses

roomsUpdate

Update a room.

Changes a room's name or location.
/v1/orgs/{orgid}/rooms/{id}

Usage and Examples

curl -X PUT \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/rooms/{id}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoomsApi;

import java.io.File;
import java.util.*;

public class RoomsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        RoomsApi apiInstance = new RoomsApi();
        Integer id = 56; // Integer | 
        String orgid = orgid_example; // String | 
        WebpageRoomsUpdateBody webpageRoomsUpdateBody = ; // WebpageRoomsUpdateBody | 

        try {
            webpageUpdateRoomResponse result = apiInstance.roomsUpdate(id, orgid, webpageRoomsUpdateBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoomsApi#roomsUpdate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoomsApi;

public class RoomsApiExample {
    public static void main(String[] args) {
        RoomsApi apiInstance = new RoomsApi();
        Integer id = 56; // Integer | 
        String orgid = orgid_example; // String | 
        WebpageRoomsUpdateBody webpageRoomsUpdateBody = ; // WebpageRoomsUpdateBody | 

        try {
            webpageUpdateRoomResponse result = apiInstance.roomsUpdate(id, orgid, webpageRoomsUpdateBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoomsApi#roomsUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RoomsApi *apiInstance = [[RoomsApi alloc] init];
Integer *id = 56; //  (default to null)
String *orgid = orgid_example; //  (default to null)
WebpageRoomsUpdateBody *webpageRoomsUpdateBody = ; // 

// Update a room.
[apiInstance roomsUpdateWith:id
    orgid:orgid
    webpageRoomsUpdateBody:webpageRoomsUpdateBody
              completionHandler: ^(webpageUpdateRoomResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.RoomsApi()
var id = 56; // {Integer} 
var orgid = orgid_example; // {String} 
var webpageRoomsUpdateBody = ; // {WebpageRoomsUpdateBody} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.roomsUpdate(id, orgid, webpageRoomsUpdateBody, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class roomsUpdateExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new RoomsApi();
            var id = 56;  // Integer |  (default to null)
            var orgid = orgid_example;  // String |  (default to null)
            var webpageRoomsUpdateBody = new WebpageRoomsUpdateBody(); // WebpageRoomsUpdateBody | 

            try {
                // Update a room.
                webpageUpdateRoomResponse result = apiInstance.roomsUpdate(id, orgid, webpageRoomsUpdateBody);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoomsApi.roomsUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoomsApi();
$id = 56; // Integer | 
$orgid = orgid_example; // String | 
$webpageRoomsUpdateBody = ; // WebpageRoomsUpdateBody | 

try {
    $result = $api_instance->roomsUpdate($id, $orgid, $webpageRoomsUpdateBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoomsApi->roomsUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RoomsApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoomsApi->new();
my $id = 56; # Integer | 
my $orgid = orgid_example; # String | 
my $webpageRoomsUpdateBody = WWW::OPenAPIClient::Object::WebpageRoomsUpdateBody->new(); # WebpageRoomsUpdateBody | 

eval {
    my $result = $api_instance->roomsUpdate(id => $id, orgid => $orgid, webpageRoomsUpdateBody => $webpageRoomsUpdateBody);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoomsApi->roomsUpdate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.RoomsApi()
id = 56 # Integer |  (default to null)
orgid = orgid_example # String |  (default to null)
webpageRoomsUpdateBody =  # WebpageRoomsUpdateBody | 

try:
    # Update a room.
    api_response = api_instance.rooms_update(id, orgid, webpageRoomsUpdateBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoomsApi->roomsUpdate: %s\n" % e)
extern crate RoomsApi;

pub fn main() {
    let id = 56; // Integer
    let orgid = orgid_example; // String
    let webpageRoomsUpdateBody = ; // WebpageRoomsUpdateBody

    let mut context = RoomsApi::Context::default();
    let result = client.roomsUpdate(id, orgid, webpageRoomsUpdateBody, &context).wait();

    println!("{:?}", result);
}
Scopes
Write Write permissions

Parameters

Path parameters

Name Description
id *
Integer (int32)
Required
orgid *
String
Required

Body parameters

Name Description
webpageRoomsUpdateBody *

Responses

Users

usersCreate

Create a user.

Creates a user with the specified properties, generating an email invitation.
/v1/orgs/{orgid}/users

Usage and Examples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/users" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UsersApi;

import java.io.File;
import java.util.*;

public class UsersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        UsersApi apiInstance = new UsersApi();
        String orgid = orgid_example; // String | 
        WebpageUserCreateRequest webpageUserCreateRequest = ; // WebpageUserCreateRequest | 

        try {
            webpageUserCreateResponse result = apiInstance.usersCreate(orgid, webpageUserCreateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#usersCreate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UsersApi;

public class UsersApiExample {
    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String orgid = orgid_example; // String | 
        WebpageUserCreateRequest webpageUserCreateRequest = ; // WebpageUserCreateRequest | 

        try {
            webpageUserCreateResponse result = apiInstance.usersCreate(orgid, webpageUserCreateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#usersCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UsersApi *apiInstance = [[UsersApi alloc] init];
String *orgid = orgid_example; //  (default to null)
WebpageUserCreateRequest *webpageUserCreateRequest = ; // 

// Create a user.
[apiInstance usersCreateWith:orgid
    webpageUserCreateRequest:webpageUserCreateRequest
              completionHandler: ^(webpageUserCreateResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.UsersApi()
var orgid = orgid_example; // {String} 
var webpageUserCreateRequest = ; // {WebpageUserCreateRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.usersCreate(orgid, webpageUserCreateRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class usersCreateExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new UsersApi();
            var orgid = orgid_example;  // String |  (default to null)
            var webpageUserCreateRequest = new WebpageUserCreateRequest(); // WebpageUserCreateRequest | 

            try {
                // Create a user.
                webpageUserCreateResponse result = apiInstance.usersCreate(orgid, webpageUserCreateRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UsersApi.usersCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UsersApi();
$orgid = orgid_example; // String | 
$webpageUserCreateRequest = ; // WebpageUserCreateRequest | 

try {
    $result = $api_instance->usersCreate($orgid, $webpageUserCreateRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->usersCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UsersApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UsersApi->new();
my $orgid = orgid_example; # String | 
my $webpageUserCreateRequest = WWW::OPenAPIClient::Object::WebpageUserCreateRequest->new(); # WebpageUserCreateRequest | 

eval {
    my $result = $api_instance->usersCreate(orgid => $orgid, webpageUserCreateRequest => $webpageUserCreateRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->usersCreate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.UsersApi()
orgid = orgid_example # String |  (default to null)
webpageUserCreateRequest =  # WebpageUserCreateRequest | 

try:
    # Create a user.
    api_response = api_instance.users_create(orgid, webpageUserCreateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->usersCreate: %s\n" % e)
extern crate UsersApi;

pub fn main() {
    let orgid = orgid_example; // String
    let webpageUserCreateRequest = ; // WebpageUserCreateRequest

    let mut context = UsersApi::Context::default();
    let result = client.usersCreate(orgid, webpageUserCreateRequest, &context).wait();

    println!("{:?}", result);
}
Scopes
Write Write permissions

Parameters

Path parameters

Name Description
orgid *
String
Required

Body parameters

Name Description
webpageUserCreateRequest *

Responses

usersDelete

Delete user.

Deletes the user, invalidating any logged-in session.
/v1/orgs/{orgid}/users/{id}

Usage and Examples

curl -X DELETE \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/users/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UsersApi;

import java.io.File;
import java.util.*;

public class UsersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        UsersApi apiInstance = new UsersApi();
        String id = id_example; // String | 
        String orgid = orgid_example; // String | 

        try {
            Object result = apiInstance.usersDelete(id, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#usersDelete");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UsersApi;

public class UsersApiExample {
    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String id = id_example; // String | 
        String orgid = orgid_example; // String | 

        try {
            Object result = apiInstance.usersDelete(id, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#usersDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UsersApi *apiInstance = [[UsersApi alloc] init];
String *id = id_example; //  (default to null)
String *orgid = orgid_example; //  (default to null)

// Delete user.
[apiInstance usersDeleteWith:id
    orgid:orgid
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.UsersApi()
var id = id_example; // {String} 
var orgid = orgid_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.usersDelete(id, orgid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class usersDeleteExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new UsersApi();
            var id = id_example;  // String |  (default to null)
            var orgid = orgid_example;  // String |  (default to null)

            try {
                // Delete user.
                Object result = apiInstance.usersDelete(id, orgid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UsersApi.usersDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UsersApi();
$id = id_example; // String | 
$orgid = orgid_example; // String | 

try {
    $result = $api_instance->usersDelete($id, $orgid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->usersDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UsersApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UsersApi->new();
my $id = id_example; # String | 
my $orgid = orgid_example; # String | 

eval {
    my $result = $api_instance->usersDelete(id => $id, orgid => $orgid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->usersDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.UsersApi()
id = id_example # String |  (default to null)
orgid = orgid_example # String |  (default to null)

try:
    # Delete user.
    api_response = api_instance.users_delete(id, orgid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->usersDelete: %s\n" % e)
extern crate UsersApi;

pub fn main() {
    let id = id_example; // String
    let orgid = orgid_example; // String

    let mut context = UsersApi::Context::default();
    let result = client.usersDelete(id, orgid, &context).wait();

    println!("{:?}", result);
}
Scopes
Write Write permissions

Parameters

Path parameters

Name Description
id *
String
Required
orgid *
String
Required

Responses

usersGet

Get user.

Get user by ID.
/v1/orgs/{orgid}/users/{id}

Usage and Examples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/users/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UsersApi;

import java.io.File;
import java.util.*;

public class UsersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        UsersApi apiInstance = new UsersApi();
        String id = id_example; // String | 
        String orgid = orgid_example; // String | 

        try {
            webpageUserGetResponse result = apiInstance.usersGet(id, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#usersGet");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UsersApi;

public class UsersApiExample {
    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String id = id_example; // String | 
        String orgid = orgid_example; // String | 

        try {
            webpageUserGetResponse result = apiInstance.usersGet(id, orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#usersGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UsersApi *apiInstance = [[UsersApi alloc] init];
String *id = id_example; //  (default to null)
String *orgid = orgid_example; //  (default to null)

// Get user.
[apiInstance usersGetWith:id
    orgid:orgid
              completionHandler: ^(webpageUserGetResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.UsersApi()
var id = id_example; // {String} 
var orgid = orgid_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.usersGet(id, orgid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class usersGetExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new UsersApi();
            var id = id_example;  // String |  (default to null)
            var orgid = orgid_example;  // String |  (default to null)

            try {
                // Get user.
                webpageUserGetResponse result = apiInstance.usersGet(id, orgid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UsersApi.usersGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UsersApi();
$id = id_example; // String | 
$orgid = orgid_example; // String | 

try {
    $result = $api_instance->usersGet($id, $orgid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->usersGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UsersApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UsersApi->new();
my $id = id_example; # String | 
my $orgid = orgid_example; # String | 

eval {
    my $result = $api_instance->usersGet(id => $id, orgid => $orgid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->usersGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.UsersApi()
id = id_example # String |  (default to null)
orgid = orgid_example # String |  (default to null)

try:
    # Get user.
    api_response = api_instance.users_get(id, orgid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->usersGet: %s\n" % e)
extern crate UsersApi;

pub fn main() {
    let id = id_example; // String
    let orgid = orgid_example; // String

    let mut context = UsersApi::Context::default();
    let result = client.usersGet(id, orgid, &context).wait();

    println!("{:?}", result);
}
Scopes
Read Read permissions

Parameters

Path parameters

Name Description
id *
String
Required
orgid *
String
Required

Responses

usersList

List all users.

Get details for all users in an organisation.
/v1/orgs/{orgid}/users

Usage and Examples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/users"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UsersApi;

import java.io.File;
import java.util.*;

public class UsersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        UsersApi apiInstance = new UsersApi();
        String orgid = orgid_example; // String | 

        try {
            webpageUserListResponse result = apiInstance.usersList(orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#usersList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UsersApi;

public class UsersApiExample {
    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String orgid = orgid_example; // String | 

        try {
            webpageUserListResponse result = apiInstance.usersList(orgid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#usersList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UsersApi *apiInstance = [[UsersApi alloc] init];
String *orgid = orgid_example; //  (default to null)

// List all users.
[apiInstance usersListWith:orgid
              completionHandler: ^(webpageUserListResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.UsersApi()
var orgid = orgid_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.usersList(orgid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class usersListExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new UsersApi();
            var orgid = orgid_example;  // String |  (default to null)

            try {
                // List all users.
                webpageUserListResponse result = apiInstance.usersList(orgid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UsersApi.usersList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UsersApi();
$orgid = orgid_example; // String | 

try {
    $result = $api_instance->usersList($orgid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->usersList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UsersApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UsersApi->new();
my $orgid = orgid_example; # String | 

eval {
    my $result = $api_instance->usersList(orgid => $orgid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->usersList: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.UsersApi()
orgid = orgid_example # String |  (default to null)

try:
    # List all users.
    api_response = api_instance.users_list(orgid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->usersList: %s\n" % e)
extern crate UsersApi;

pub fn main() {
    let orgid = orgid_example; // String

    let mut context = UsersApi::Context::default();
    let result = client.usersList(orgid, &context).wait();

    println!("{:?}", result);
}
Scopes
Read Read permissions

Parameters

Path parameters

Name Description
orgid *
String
Required

Responses

usersUpdate

Update a user.

Updates user properties. Currently only role is supported.
/v1/orgs/{orgid}/users/{id}

Usage and Examples

curl -X PUT \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.pulse.neat.no/v1/orgs/{orgid}/users/{id}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UsersApi;

import java.io.File;
import java.util.*;

public class UsersApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer access token for authorization: bearerToken
        HttpBearerAuth bearerToken = (HttpBearerAuth) defaultClient.getAuthentication("bearerToken");
        bearerToken.setBearerToken("BEARER TOKEN");
        

        // Create an instance of the API class
        UsersApi apiInstance = new UsersApi();
        String id = id_example; // String | 
        String orgid = orgid_example; // String | 
        WebpageUsersUpdateBody webpageUsersUpdateBody = ; // WebpageUsersUpdateBody | 

        try {
            webpageUserUpdateResponse result = apiInstance.usersUpdate(id, orgid, webpageUsersUpdateBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#usersUpdate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UsersApi;

public class UsersApiExample {
    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String id = id_example; // String | 
        String orgid = orgid_example; // String | 
        WebpageUsersUpdateBody webpageUsersUpdateBody = ; // WebpageUsersUpdateBody | 

        try {
            webpageUserUpdateResponse result = apiInstance.usersUpdate(id, orgid, webpageUsersUpdateBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#usersUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer access token for authorization: bearerToken
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UsersApi *apiInstance = [[UsersApi alloc] init];
String *id = id_example; //  (default to null)
String *orgid = orgid_example; //  (default to null)
WebpageUsersUpdateBody *webpageUsersUpdateBody = ; // 

// Update a user.
[apiInstance usersUpdateWith:id
    orgid:orgid
    webpageUsersUpdateBody:webpageUsersUpdateBody
              completionHandler: ^(webpageUserUpdateResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var NeatPulseApi = require('neat_pulse_api');
var defaultClient = NeatPulseApi.ApiClient.instance;

// Configure Bearer access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";


// Create an instance of the API class
var api = new NeatPulseApi.UsersApi()
var id = id_example; // {String} 
var orgid = orgid_example; // {String} 
var webpageUsersUpdateBody = ; // {WebpageUsersUpdateBody} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.usersUpdate(id, orgid, webpageUsersUpdateBody, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class usersUpdateExample
    {
        public void main()
        {
            // Configure Bearer access token for authorization: bearerToken
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            

            // Create an instance of the API class
            var apiInstance = new UsersApi();
            var id = id_example;  // String |  (default to null)
            var orgid = orgid_example;  // String |  (default to null)
            var webpageUsersUpdateBody = new WebpageUsersUpdateBody(); // WebpageUsersUpdateBody | 

            try {
                // Update a user.
                webpageUserUpdateResponse result = apiInstance.usersUpdate(id, orgid, webpageUsersUpdateBody);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UsersApi.usersUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer access token for authorization: bearerToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');


// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UsersApi();
$id = id_example; // String | 
$orgid = orgid_example; // String | 
$webpageUsersUpdateBody = ; // WebpageUsersUpdateBody | 

try {
    $result = $api_instance->usersUpdate($id, $orgid, $webpageUsersUpdateBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->usersUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UsersApi;

# Configure Bearer access token for authorization: bearerToken
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';


# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UsersApi->new();
my $id = id_example; # String | 
my $orgid = orgid_example; # String | 
my $webpageUsersUpdateBody = WWW::OPenAPIClient::Object::WebpageUsersUpdateBody->new(); # WebpageUsersUpdateBody | 

eval {
    my $result = $api_instance->usersUpdate(id => $id, orgid => $orgid, webpageUsersUpdateBody => $webpageUsersUpdateBody);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->usersUpdate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer access token for authorization: bearerToken
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Create an instance of the API class
api_instance = openapi_client.UsersApi()
id = id_example # String |  (default to null)
orgid = orgid_example # String |  (default to null)
webpageUsersUpdateBody =  # WebpageUsersUpdateBody | 

try:
    # Update a user.
    api_response = api_instance.users_update(id, orgid, webpageUsersUpdateBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->usersUpdate: %s\n" % e)
extern crate UsersApi;

pub fn main() {
    let id = id_example; // String
    let orgid = orgid_example; // String
    let webpageUsersUpdateBody = ; // WebpageUsersUpdateBody

    let mut context = UsersApi::Context::default();
    let result = client.usersUpdate(id, orgid, webpageUsersUpdateBody, &context).wait();

    println!("{:?}", result);
}
Scopes
Write Write permissions

Parameters

Path parameters

Name Description
id *
String
Required
orgid *
String
Required

Body parameters

Name Description
webpageUsersUpdateBody *

Responses