Neat Pulse API

Endpoints

endpointsApplyConfig

Apply settings and config to an endpoint.

Creates and applies a new config to an endpoint.

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

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://pulse.neat.no/api/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

endpointsBasicList

List all endpoints in organisation.

Get basic endpoint details for all endpoints in an organisation.

/api/v1/orgs/{orgid}/endpoints

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://pulse.neat.no/api/v1/orgs/{orgid}/endpoints"

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 | 

        try {
            webpageListBasicEndpointsResponse result = apiInstance.endpointsBasicList(orgid);
            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 | 

        try {
            webpageListBasicEndpointsResponse result = apiInstance.endpointsBasicList(orgid);
            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)

// List all endpoints in organisation.
[apiInstance endpointsBasicListWith:orgid
              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 callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.endpointsBasicList(orgid, 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)

            try {
                // List all endpoints in organisation.
                webpageListBasicEndpointsResponse result = apiInstance.endpointsBasicList(orgid);
                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 | 

try {
    $result = $api_instance->endpointsBasicList($orgid);
    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 | 

eval {
    my $result = $api_instance->endpointsBasicList(orgid => $orgid);
    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)

try:
    # List all endpoints in organisation.
    api_response = api_instance.endpoints_basic_list(orgid)
    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 mut context = EndpointsApi::Context::default();
    let result = client.endpointsBasicList(orgid, &context).wait();

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

Scopes
Read	Read permissions

Parameters

Path parameters

Name	Description
orgid *	String Required

Responses

endpointsDelete

Delete an endpoint.

Unenrolls the endpoint.

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

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://pulse.neat.no/api/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

endpointsGet

Get an endpoint.

Gets an endpoint's details and status information.

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

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://pulse.neat.no/api/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

endpointsReboot

Reboot an Endpoint.

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

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://pulse.neat.no/api/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.
[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.
                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.
    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.

/api/v1/orgs/{orgid}/endpoints/{id}/sensor

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://pulse.neat.no/api/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.

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

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://pulse.neat.no/api/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

Locations

locationsCreate

Create a new location.

Adds a new location and optionally assigns it to an existing region.

/api/v1/orgs/{orgid}/locations

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://pulse.neat.no/api/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.

/api/v1/orgs/{orgid}/locations/{id}

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://pulse.neat.no/api/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.

/api/v1/orgs/{orgid}/locations

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://pulse.neat.no/api/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.

/api/v1/orgs/{orgid}/locations/{id}

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://pulse.neat.no/api/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

Regions

regionsCreate

Create a region.

/api/v1/orgs/{orgid}/regions

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://pulse.neat.no/api/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.

/api/v1/orgs/{orgid}/regions/{id}

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://pulse.neat.no/api/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.

/api/v1/orgs/{orgid}/regions

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://pulse.neat.no/api/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.

/api/v1/orgs/{orgid}/regions/{id}

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://pulse.neat.no/api/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

roomsCreate

Create a room.

Adds a new room, optionally assigning it to an existing location.

/api/v1/orgs/{orgid}/rooms

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://pulse.neat.no/api/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.

/api/v1/orgs/{orgid}/rooms/{id}

Usage and SDK Samples

curl -X DELETE \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://pulse.neat.no/api/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.

/api/v1/orgs/{orgid}/rooms/{id}

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://pulse.neat.no/api/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.

/api/v1/orgs/{orgid}/rooms/{id}/sensor

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://pulse.neat.no/api/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.

/api/v1/orgs/{orgid}/rooms

Usage and SDK Samples

curl -X GET \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://pulse.neat.no/api/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.

/api/v1/orgs/{orgid}/rooms/{id}/regenerate_dec

Usage and SDK Samples

curl -X POST \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 "https://pulse.neat.no/api/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

roomsUpdate

Update a room.

Changes a room's name or location.

/api/v1/orgs/{orgid}/rooms/{id}

Usage and SDK Samples

curl -X PUT \
 -H "Authorization: Bearer [[accessToken]]" \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://pulse.neat.no/api/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 *