Supplato V1

Email: Matteo Alvazzi

Authentication

API Key (Bearer)
- Parameter Name: Authorization, in: header. Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Approver

get__api_approver

# You can also use wget
curl -X GET /api/approver

GET /api/approver HTTP/1.1


fetch('/api/approver',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/approver',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/approver')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/approver', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/approver");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/approver", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/approver

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_approver

# You can also use wget
curl -X POST /api/approver \
  -H 'Content-Type: application/json-patch+json'

POST /api/approver HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "type": 0,
  "userIds": [
    {}
  ],
  "vendorIds": [
    {}
  ],
  "companyIds": [
    {}
  ],
  "start": "2019-08-24T14:15:22Z",
  "finish": "2019-08-24T14:15:22Z"
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/approver',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/approver',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/approver', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/approver', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/approver");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/approver", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/approver

{
  "type": 0,
  "userIds": [
    {}
  ],
  "vendorIds": [
    {}
  ],
  "companyIds": [
    {}
  ],
  "start": "2019-08-24T14:15:22Z",
  "finish": "2019-08-24T14:15:22Z"
}

Parameters

Name	In	Type	Required	Description
body	body	ApproverInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_approver{id}

# You can also use wget
curl -X GET /api/approver/{id}

GET /api/approver/{id} HTTP/1.1


fetch('/api/approver/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/approver/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/approver/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/approver/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/approver/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/approver/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/approver/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_approver{id}

# You can also use wget
curl -X PUT /api/approver/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/approver/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "type": 0,
  "userIds": [
    {}
  ],
  "vendorIds": [
    {}
  ],
  "companyIds": [
    {}
  ],
  "start": "2019-08-24T14:15:22Z",
  "finish": "2019-08-24T14:15:22Z"
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/approver/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/approver/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/approver/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/approver/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/approver/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/approver/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/approver/{id}

{
  "type": 0,
  "userIds": [
    {}
  ],
  "vendorIds": [
    {}
  ],
  "companyIds": [
    {}
  ],
  "start": "2019-08-24T14:15:22Z",
  "finish": "2019-08-24T14:15:22Z"
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	ApproverUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_approver{id}

# You can also use wget
curl -X DELETE /api/approver/{id}

DELETE /api/approver/{id} HTTP/1.1


fetch('/api/approver/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/approver/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/approver/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/approver/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/approver/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/approver/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/approver/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Assessment

get__api_assessment

# You can also use wget
curl -X GET /api/assessment

GET /api/assessment HTTP/1.1


fetch('/api/assessment',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/assessment',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/assessment')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/assessment', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/assessment");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/assessment", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/assessment

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_assessment

# You can also use wget
curl -X POST /api/assessment \
  -H 'Content-Type: application/json-patch+json'

POST /api/assessment HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "ownerId": {},
  "ownerType": 0,
  "questionnaireId": {},
  "dueDate": "2019-08-24T14:15:22Z",
  "sendInvitation": "2019-08-24T14:15:22Z"
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/assessment',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/assessment',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/assessment', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/assessment', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/assessment");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/assessment", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/assessment

{
  "name": "string",
  "ownerId": {},
  "ownerType": 0,
  "questionnaireId": {},
  "dueDate": "2019-08-24T14:15:22Z",
  "sendInvitation": "2019-08-24T14:15:22Z"
}

Parameters

Name	In	Type	Required	Description
body	body	AssessmentInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_assessment_type{ownerType}history{history}

# You can also use wget
curl -X GET /api/assessment/type/{ownerType}/history/{history}

GET /api/assessment/type/{ownerType}/history/{history} HTTP/1.1


fetch('/api/assessment/type/{ownerType}/history/{history}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/assessment/type/{ownerType}/history/{history}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/assessment/type/{ownerType}/history/{history}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/assessment/type/{ownerType}/history/{history}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/assessment/type/{ownerType}/history/{history}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/assessment/type/{ownerType}/history/{history}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/assessment/type/{ownerType}/history/{history}

Parameters

Name	In	Type	Required	Description
ownerType	path	OwnerType	true	none
history	path	boolean	true	none

Enumerated Values

Parameter	Value
ownerType	0
ownerType	1
ownerType	2
ownerType	3
ownerType	4
ownerType	5

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_assessment_owner{ownerId}type{ownerType}

# You can also use wget
curl -X GET /api/assessment/owner/{ownerId}/type/{ownerType}

GET /api/assessment/owner/{ownerId}/type/{ownerType} HTTP/1.1


fetch('/api/assessment/owner/{ownerId}/type/{ownerType}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/assessment/owner/{ownerId}/type/{ownerType}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/assessment/owner/{ownerId}/type/{ownerType}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/assessment/owner/{ownerId}/type/{ownerType}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/assessment/owner/{ownerId}/type/{ownerType}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/assessment/owner/{ownerId}/type/{ownerType}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/assessment/owner/{ownerId}/type/{ownerType}

Parameters

Name	In	Type	Required	Description
ownerId	path	ObjectId	true	none
ownerType	path	OwnerType	true	none

Enumerated Values

Parameter	Value
ownerType	0
ownerType	1
ownerType	2
ownerType	3
ownerType	4
ownerType	5

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_assessment{id}

# You can also use wget
curl -X GET /api/assessment/{id}

GET /api/assessment/{id} HTTP/1.1


fetch('/api/assessment/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/assessment/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/assessment/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/assessment/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/assessment/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/assessment/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/assessment/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_assessment{id}

# You can also use wget
curl -X DELETE /api/assessment/{id}

DELETE /api/assessment/{id} HTTP/1.1


fetch('/api/assessment/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/assessment/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/assessment/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/assessment/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/assessment/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/assessment/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/assessment/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_assessment{id}s{secret}i{instance}

# You can also use wget
curl -X GET /api/assessment/{id}/s/{secret}/i/{instance}

GET /api/assessment/{id}/s/{secret}/i/{instance} HTTP/1.1


fetch('/api/assessment/{id}/s/{secret}/i/{instance}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/assessment/{id}/s/{secret}/i/{instance}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/assessment/{id}/s/{secret}/i/{instance}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/assessment/{id}/s/{secret}/i/{instance}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/assessment/{id}/s/{secret}/i/{instance}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/assessment/{id}/s/{secret}/i/{instance}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/assessment/{id}/s/{secret}/i/{instance}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
secret	path	string	true	none
instance	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post_api_assessment_upload{id}

# You can also use wget
curl -X POST /api/assessment/upload/{id} \
  -H 'Content-Type: multipart/form-data'

POST /api/assessment/upload/{id} HTTP/1.1

Content-Type: multipart/form-data

const inputBody = '{
  "file": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data'
};

fetch('/api/assessment/upload/{id}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'multipart/form-data'
}

result = RestClient.post '/api/assessment/upload/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'multipart/form-data'
}

r = requests.post('/api/assessment/upload/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/assessment/upload/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/assessment/upload/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"multipart/form-data"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/assessment/upload/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/assessment/upload/{id}

file: string

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	object	false	none
» file	body	string(binary)	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post_api_assessment_upload{id}s{secret}i{instance}

# You can also use wget
curl -X POST /api/assessment/upload/{id}/s/{secret}/i/{instance} \
  -H 'Content-Type: multipart/form-data'

POST /api/assessment/upload/{id}/s/{secret}/i/{instance} HTTP/1.1

Content-Type: multipart/form-data

const inputBody = '{
  "file": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data'
};

fetch('/api/assessment/upload/{id}/s/{secret}/i/{instance}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'multipart/form-data'
}

result = RestClient.post '/api/assessment/upload/{id}/s/{secret}/i/{instance}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'multipart/form-data'
}

r = requests.post('/api/assessment/upload/{id}/s/{secret}/i/{instance}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/assessment/upload/{id}/s/{secret}/i/{instance}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/assessment/upload/{id}/s/{secret}/i/{instance}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"multipart/form-data"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/assessment/upload/{id}/s/{secret}/i/{instance}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/assessment/upload/{id}/s/{secret}/i/{instance}

file: string

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
secret	path	string	true	none
instance	path	ObjectId	true	none
body	body	object	false	none
» file	body	string(binary)	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post_api_assessment{id}_complete

# You can also use wget
curl -X POST /api/assessment/{id}/complete

POST /api/assessment/{id}/complete HTTP/1.1


fetch('/api/assessment/{id}/complete',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.post '/api/assessment/{id}/complete',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.post('/api/assessment/{id}/complete')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/assessment/{id}/complete', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/assessment/{id}/complete");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/assessment/{id}/complete", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/assessment/{id}/complete

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_assessment_item{id}

# You can also use wget
curl -X PUT /api/assessment/item/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/assessment/item/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "answer": "string",
  "fileName": "string",
  "fileUrl": "string",
  "notes": "string",
  "documentId": {},
  "documentAssociationId": {},
  "emissionDate": "2019-08-24T14:15:22Z"
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/assessment/item/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/assessment/item/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/assessment/item/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/assessment/item/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/assessment/item/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/assessment/item/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/assessment/item/{id}

{
  "answer": "string",
  "fileName": "string",
  "fileUrl": "string",
  "notes": "string",
  "documentId": {},
  "documentAssociationId": {},
  "emissionDate": "2019-08-24T14:15:22Z"
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	AssessmentItemUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_assessment_item{id}s{secret}i{instance}

# You can also use wget
curl -X PUT /api/assessment/item/{id}/s/{secret}/i/{instance} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/assessment/item/{id}/s/{secret}/i/{instance} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "answer": "string",
  "fileName": "string",
  "fileUrl": "string",
  "notes": "string",
  "documentId": {},
  "documentAssociationId": {},
  "emissionDate": "2019-08-24T14:15:22Z"
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/assessment/item/{id}/s/{secret}/i/{instance}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/assessment/item/{id}/s/{secret}/i/{instance}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/assessment/item/{id}/s/{secret}/i/{instance}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/assessment/item/{id}/s/{secret}/i/{instance}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/assessment/item/{id}/s/{secret}/i/{instance}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/assessment/item/{id}/s/{secret}/i/{instance}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/assessment/item/{id}/s/{secret}/i/{instance}

{
  "answer": "string",
  "fileName": "string",
  "fileUrl": "string",
  "notes": "string",
  "documentId": {},
  "documentAssociationId": {},
  "emissionDate": "2019-08-24T14:15:22Z"
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
secret	path	string	true	none
instance	path	ObjectId	true	none
body	body	AssessmentItemUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

AuditLog

get_api_auditlog{entityId}

# You can also use wget
curl -X GET /api/auditlog/{entityId}

GET /api/auditlog/{entityId} HTTP/1.1


fetch('/api/auditlog/{entityId}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/auditlog/{entityId}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/auditlog/{entityId}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/auditlog/{entityId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/auditlog/{entityId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/auditlog/{entityId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/auditlog/{entityId}

Parameters

Name	In	Type	Required	Description
entityId	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Authentication

post__api_token

# You can also use wget
curl -X POST /api/token \
  -H 'Content-Type: application/json-patch+json'

POST /api/token HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "email": "string",
  "password": "string",
  "instanceId": {}
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/token',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/token',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/token', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/token', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/token");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/token", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/token

{
  "email": "string",
  "password": "string",
  "instanceId": {}
}

Parameters

Name	In	Type	Required	Description
body	body	TokenModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_refreshtoken

# You can also use wget
curl -X POST /api/refreshtoken \
  -H 'Content-Type: application/json-patch+json'

POST /api/refreshtoken HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "token": "string",
  "instanceId": {}
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/refreshtoken',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/refreshtoken',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/refreshtoken', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/refreshtoken', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/refreshtoken");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/refreshtoken", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/refreshtoken

{
  "token": "string",
  "instanceId": {}
}

Parameters

Name	In	Type	Required	Description
body	body	RefreshTokenModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_office365token

# You can also use wget
curl -X POST /api/office365token \
  -H 'Content-Type: application/json-patch+json'

POST /api/office365token HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "token": "string",
  "instanceId": {}
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/office365token',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/office365token',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/office365token', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/office365token', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/office365token");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/office365token", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/office365token

{
  "token": "string",
  "instanceId": {}
}

Parameters

Name	In	Type	Required	Description
body	body	Office365TokenModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_reset

# You can also use wget
curl -X POST /api/reset \
  -H 'Content-Type: application/json-patch+json'

POST /api/reset HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "email": "user@example.com"
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/reset',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/reset',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/reset', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/reset', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/reset");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/reset", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/reset

{
  "email": "user@example.com"
}

Parameters

Name	In	Type	Required	Description
body	body	ResetPasswordModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Name	In	Type	Required	Description
body	body	CategoryInsertModel	false	none

Company

get__api_company

# You can also use wget
curl -X GET /api/company

GET /api/company HTTP/1.1


fetch('/api/company',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/company',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/company')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/company', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/company");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/company", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/company

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_company

# You can also use wget
curl -X POST /api/company \
  -H 'Content-Type: application/json-patch+json'

POST /api/company HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "industry": 0,
  "revenue": 0,
  "companySize": 0,
  "email": "string",
  "websites": [
    "string"
  ],
  "managerId": {},
  "city": "string",
  "countryOrRegion": "string",
  "postalCode": "string",
  "state": "string",
  "street": "string",
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ],
  "criticalityWeight": 0.1,
  "scoreCategoryWeights": [
    {
      "scoreCategoryId": {},
      "weight": 0.1
    }
  ],
  "parentId": {},
  "organizationCategory": {}
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/company',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/company',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/company', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/company', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/company");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/company", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/company

{
  "name": "string",
  "industry": 0,
  "revenue": 0,
  "companySize": 0,
  "email": "string",
  "websites": [
    "string"
  ],
  "managerId": {},
  "city": "string",
  "countryOrRegion": "string",
  "postalCode": "string",
  "state": "string",
  "street": "string",
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ],
  "criticalityWeight": 0.1,
  "scoreCategoryWeights": [
    {
      "scoreCategoryId": {},
      "weight": 0.1
    }
  ],
  "parentId": {},
  "organizationCategory": {}
}

Parameters

Name	In	Type	Required	Description
body	body	CompanyInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_company{id}

# You can also use wget
curl -X GET /api/company/{id}

GET /api/company/{id} HTTP/1.1


fetch('/api/company/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/company/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/company/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/company/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/company/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/company/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/company/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_company{id}

# You can also use wget
curl -X PUT /api/company/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/company/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "industry": 0,
  "revenue": 0,
  "companySize": 0,
  "email": "string",
  "websites": [
    "string"
  ],
  "managerId": {},
  "city": "string",
  "countryOrRegion": "string",
  "postalCode": "string",
  "state": "string",
  "street": "string",
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ],
  "criticalityWeight": 0.1,
  "scoreCategoryWeights": [
    {
      "scoreCategoryId": {},
      "weight": 0.1
    }
  ],
  "parentId": {},
  "organizationCategory": {}
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/company/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/company/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/company/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/company/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/company/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/company/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/company/{id}

{
  "name": "string",
  "industry": 0,
  "revenue": 0,
  "companySize": 0,
  "email": "string",
  "websites": [
    "string"
  ],
  "managerId": {},
  "city": "string",
  "countryOrRegion": "string",
  "postalCode": "string",
  "state": "string",
  "street": "string",
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ],
  "criticalityWeight": 0.1,
  "scoreCategoryWeights": [
    {
      "scoreCategoryId": {},
      "weight": 0.1
    }
  ],
  "parentId": {},
  "organizationCategory": {}
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	CompanyUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_company{id}

# You can also use wget
curl -X DELETE /api/company/{id}

DELETE /api/company/{id} HTTP/1.1


fetch('/api/company/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/company/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/company/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/company/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/company/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/company/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/company/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Contract

get__api_contract

# You can also use wget
curl -X GET /api/contract

GET /api/contract HTTP/1.1


fetch('/api/contract',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/contract',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/contract')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/contract', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/contract");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/contract", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/contract

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_contract

# You can also use wget
curl -X POST /api/contract \
  -H 'Content-Type: application/json-patch+json'

POST /api/contract HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "description": "string",
  "start": "2019-08-24T14:15:22Z",
  "finish": "2019-08-24T14:15:22Z",
  "vendorId": {},
  "companyId": {},
  "labelIds": [
    {}
  ],
  "contractType": 0,
  "contractTypeDetail": 0,
  "termsAndConditions": "string"
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/contract',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/contract',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/contract', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/contract', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/contract");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/contract", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/contract

{
  "name": "string",
  "description": "string",
  "start": "2019-08-24T14:15:22Z",
  "finish": "2019-08-24T14:15:22Z",
  "vendorId": {},
  "companyId": {},
  "labelIds": [
    {}
  ],
  "contractType": 0,
  "contractTypeDetail": 0,
  "termsAndConditions": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	ContractInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_contract_company{companyId}

# You can also use wget
curl -X GET /api/contract/company/{companyId}

GET /api/contract/company/{companyId} HTTP/1.1


fetch('/api/contract/company/{companyId}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/contract/company/{companyId}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/contract/company/{companyId}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/contract/company/{companyId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/contract/company/{companyId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/contract/company/{companyId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/contract/company/{companyId}

Parameters

Name	In	Type	Required	Description
companyId	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_contract_vendor{vendorId}

# You can also use wget
curl -X GET /api/contract/vendor/{vendorId}

GET /api/contract/vendor/{vendorId} HTTP/1.1


fetch('/api/contract/vendor/{vendorId}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/contract/vendor/{vendorId}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/contract/vendor/{vendorId}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/contract/vendor/{vendorId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/contract/vendor/{vendorId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/contract/vendor/{vendorId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/contract/vendor/{vendorId}

Parameters

Name	In	Type	Required	Description
vendorId	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_contract{id}

# You can also use wget
curl -X GET /api/contract/{id}

GET /api/contract/{id} HTTP/1.1


fetch('/api/contract/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/contract/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/contract/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/contract/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/contract/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/contract/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/contract/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_contract{id}

# You can also use wget
curl -X PUT /api/contract/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/contract/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "description": "string",
  "start": "2019-08-24T14:15:22Z",
  "finish": "2019-08-24T14:15:22Z",
  "vendorId": {},
  "companyId": {},
  "labelIds": [
    {}
  ],
  "contractType": 0,
  "contractTypeDetail": 0,
  "termsAndConditions": "string"
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/contract/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/contract/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/contract/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/contract/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/contract/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/contract/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/contract/{id}

{
  "name": "string",
  "description": "string",
  "start": "2019-08-24T14:15:22Z",
  "finish": "2019-08-24T14:15:22Z",
  "vendorId": {},
  "companyId": {},
  "labelIds": [
    {}
  ],
  "contractType": 0,
  "contractTypeDetail": 0,
  "termsAndConditions": "string"
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	ContractUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_contract{id}

# You can also use wget
curl -X DELETE /api/contract/{id}

DELETE /api/contract/{id} HTTP/1.1


fetch('/api/contract/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/contract/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/contract/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/contract/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/contract/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/contract/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/contract/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Conversation

get__api_conversation

# You can also use wget
curl -X GET /api/conversation

GET /api/conversation HTTP/1.1


fetch('/api/conversation',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/conversation',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/conversation')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/conversation', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/conversation");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/conversation", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/conversation

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_conversation

# You can also use wget
curl -X POST /api/conversation \
  -H 'Content-Type: application/json-patch+json'

POST /api/conversation HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "message": "string",
  "threadId": {},
  "fromAgent": true,
  "fromSender": true
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/conversation',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/conversation',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/conversation', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/conversation', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/conversation");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/conversation", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/conversation

{
  "message": "string",
  "threadId": {},
  "fromAgent": true,
  "fromSender": true
}

Parameters

Name	In	Type	Required	Description
body	body	ConversationInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_conversation{id}

# You can also use wget
curl -X GET /api/conversation/{id}

GET /api/conversation/{id} HTTP/1.1


fetch('/api/conversation/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/conversation/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/conversation/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/conversation/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/conversation/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/conversation/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/conversation/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_conversation{id}

# You can also use wget
curl -X DELETE /api/conversation/{id}

DELETE /api/conversation/{id} HTTP/1.1


fetch('/api/conversation/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/conversation/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/conversation/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/conversation/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/conversation/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/conversation/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/conversation/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_conversation_message

# You can also use wget
curl -X POST /api/conversation/message \
  -H 'Content-Type: application/json-patch+json'

POST /api/conversation/message HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "message": "string"
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/conversation/message',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/conversation/message',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/conversation/message', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/conversation/message', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/conversation/message");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/conversation/message", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/conversation/message

{
  "message": "string"
}

Parameters

Name	In	Type	Required	Description
threadId	query	string	false	none
body	body	ConversationMessageModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Criticality

get__api_criticality

# You can also use wget
curl -X GET /api/criticality

GET /api/criticality HTTP/1.1


fetch('/api/criticality',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/criticality',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/criticality')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/criticality', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/criticality");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/criticality", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/criticality

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_criticality

# You can also use wget
curl -X POST /api/criticality \
  -H 'Content-Type: application/json-patch+json'

POST /api/criticality HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "value": 0.1,
  "disabled": true
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/criticality',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/criticality',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/criticality', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/criticality', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/criticality");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/criticality", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/criticality

{
  "name": "string",
  "value": 0.1,
  "disabled": true
}

Parameters

Name	In	Type	Required	Description
body	body	CriticalityInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_criticality{id}

# You can also use wget
curl -X GET /api/criticality/{id}

GET /api/criticality/{id} HTTP/1.1


fetch('/api/criticality/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/criticality/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/criticality/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/criticality/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/criticality/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/criticality/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/criticality/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_criticality{id}

# You can also use wget
curl -X PUT /api/criticality/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/criticality/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "value": 0.1,
  "disabled": true
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/criticality/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/criticality/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/criticality/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/criticality/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/criticality/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/criticality/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/criticality/{id}

{
  "name": "string",
  "value": 0.1,
  "disabled": true
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	CriticalityUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_criticality{id}

# You can also use wget
curl -X DELETE /api/criticality/{id}

DELETE /api/criticality/{id} HTTP/1.1


fetch('/api/criticality/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/criticality/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/criticality/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/criticality/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/criticality/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/criticality/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/criticality/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Customfield

get__api_customfield

# You can also use wget
curl -X GET /api/customfield

GET /api/customfield HTTP/1.1


fetch('/api/customfield',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/customfield',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/customfield')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/customfield', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/customfield");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/customfield", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/customfield

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_customfield

# You can also use wget
curl -X POST /api/customfield \
  -H 'Content-Type: application/json-patch+json'

POST /api/customfield HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "type": 0,
  "owners": [
    0
  ],
  "workflowRule": true
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/customfield',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/customfield',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/customfield', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/customfield', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/customfield");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/customfield", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/customfield

{
  "name": "string",
  "type": 0,
  "owners": [
    0
  ],
  "workflowRule": true
}

Parameters

Name	In	Type	Required	Description
body	body	CustomfieldInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_customfield_owner{owner}

# You can also use wget
curl -X GET /api/customfield/owner/{owner}

GET /api/customfield/owner/{owner} HTTP/1.1


fetch('/api/customfield/owner/{owner}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/customfield/owner/{owner}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/customfield/owner/{owner}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/customfield/owner/{owner}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/customfield/owner/{owner}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/customfield/owner/{owner}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/customfield/owner/{owner}

Parameters

Name	In	Type	Required	Description
owner	path	CustomfieldOwner	true	none

Enumerated Values

Parameter	Value
owner	0
owner	1
owner	2
owner	3
owner	4
owner	5
owner	6
owner	7
owner	8

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_customfield{id}

# You can also use wget
curl -X GET /api/customfield/{id}

GET /api/customfield/{id} HTTP/1.1


fetch('/api/customfield/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/customfield/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/customfield/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/customfield/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/customfield/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/customfield/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/customfield/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_customfield{id}

# You can also use wget
curl -X PUT /api/customfield/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/customfield/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "type": 0,
  "owners": [
    0
  ],
  "workflowRule": true
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/customfield/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/customfield/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/customfield/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/customfield/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/customfield/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/customfield/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/customfield/{id}

{
  "name": "string",
  "type": 0,
  "owners": [
    0
  ],
  "workflowRule": true
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	CustomfieldUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_customfield{id}

# You can also use wget
curl -X DELETE /api/customfield/{id}

DELETE /api/customfield/{id} HTTP/1.1


fetch('/api/customfield/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/customfield/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/customfield/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/customfield/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/customfield/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/customfield/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/customfield/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_customfield_lookup{id}

# You can also use wget
curl -X GET /api/customfield/lookup/{id}

GET /api/customfield/lookup/{id} HTTP/1.1


fetch('/api/customfield/lookup/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/customfield/lookup/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/customfield/lookup/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/customfield/lookup/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/customfield/lookup/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/customfield/lookup/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/customfield/lookup/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_customfield_lookup{id}

# You can also use wget
curl -X PUT /api/customfield/lookup/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/customfield/lookup/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "value": "string",
  "order": 0
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/customfield/lookup/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/customfield/lookup/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/customfield/lookup/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/customfield/lookup/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/customfield/lookup/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/customfield/lookup/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/customfield/lookup/{id}

{
  "value": "string",
  "order": 0
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	CustomfieldLookupUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_customfield_lookup{id}

# You can also use wget
curl -X DELETE /api/customfield/lookup/{id}

DELETE /api/customfield/lookup/{id} HTTP/1.1


fetch('/api/customfield/lookup/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/customfield/lookup/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/customfield/lookup/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/customfield/lookup/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/customfield/lookup/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/customfield/lookup/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/customfield/lookup/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post_api_customfield{customfieldId}_lookup

# You can also use wget
curl -X POST /api/customfield/{customfieldId}/lookup \
  -H 'Content-Type: application/json-patch+json'

POST /api/customfield/{customfieldId}/lookup HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "value": "string",
  "order": 0
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/customfield/{customfieldId}/lookup',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/customfield/{customfieldId}/lookup',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/customfield/{customfieldId}/lookup', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/customfield/{customfieldId}/lookup', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/customfield/{customfieldId}/lookup");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/customfield/{customfieldId}/lookup", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/customfield/{customfieldId}/lookup

{
  "value": "string",
  "order": 0
}

Parameters

Name	In	Type	Required	Description
customfieldId	path	ObjectId	true	none
body	body	CustomfieldLookupInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Dashboard

get__api_dashboard

# You can also use wget
curl -X GET /api/dashboard

GET /api/dashboard HTTP/1.1


fetch('/api/dashboard',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/dashboard',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/dashboard')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/dashboard', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/dashboard");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/dashboard", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/dashboard

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_dashboard

# You can also use wget
curl -X POST /api/dashboard \
  -H 'Content-Type: application/json-patch+json'

POST /api/dashboard HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "type": 0,
  "default": true,
  "dashboard": 0,
  "userId": {},
  "widgets": [
    {
      "name": "string",
      "x": 0.1,
      "y": 0.1,
      "w": 0.1,
      "h": 0.1
    }
  ]
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/dashboard',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/dashboard',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/dashboard', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/dashboard', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/dashboard");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/dashboard", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/dashboard

{
  "type": 0,
  "default": true,
  "dashboard": 0,
  "userId": {},
  "widgets": [
    {
      "name": "string",
      "x": 0.1,
      "y": 0.1,
      "w": 0.1,
      "h": 0.1
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	DashboardInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_dashboard{id}

# You can also use wget
curl -X GET /api/dashboard/{id}

GET /api/dashboard/{id} HTTP/1.1


fetch('/api/dashboard/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/dashboard/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/dashboard/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/dashboard/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/dashboard/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/dashboard/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/dashboard/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_dashboard{id}

# You can also use wget
curl -X DELETE /api/dashboard/{id}

DELETE /api/dashboard/{id} HTTP/1.1


fetch('/api/dashboard/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/dashboard/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/dashboard/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/dashboard/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/dashboard/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/dashboard/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/dashboard/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Document

get__api_document

# You can also use wget
curl -X GET /api/document

GET /api/document HTTP/1.1


fetch('/api/document',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/document',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/document')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/document', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/document");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/document", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/document

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_document

# You can also use wget
curl -X POST /api/document \
  -H 'Content-Type: application/json-patch+json'

POST /api/document HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "description": "string",
  "validityId": {},
  "categoryId": {},
  "subCategoryId": {},
  "disabled": true,
  "mandatory": true,
  "scoreCategoryId": {},
  "weight": 0,
  "frameworkItemIds": [
    {}
  ],
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ],
  "levelId": {},
  "companyIds": [
    {}
  ],
  "programIds": [
    {}
  ],
  "documentValue": 0.1,
  "tierChecks": [
    {
      "tierId": {},
      "checkDescriptions": [
        "string"
      ]
    }
  ]
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/document',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/document',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/document', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/document', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/document");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/document", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/document

{
  "name": "string",
  "description": "string",
  "validityId": {},
  "categoryId": {},
  "subCategoryId": {},
  "disabled": true,
  "mandatory": true,
  "scoreCategoryId": {},
  "weight": 0,
  "frameworkItemIds": [
    {}
  ],
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ],
  "levelId": {},
  "companyIds": [
    {}
  ],
  "programIds": [
    {}
  ],
  "documentValue": 0.1,
  "tierChecks": [
    {
      "tierId": {},
      "checkDescriptions": [
        "string"
      ]
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	DocumentInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_document{id}

# You can also use wget
curl -X GET /api/document/{id}

GET /api/document/{id} HTTP/1.1


fetch('/api/document/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/document/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/document/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/document/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/document/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/document/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/document/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_document{id}

# You can also use wget
curl -X PUT /api/document/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/document/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "description": "string",
  "validityId": {},
  "categoryId": {},
  "subCategoryId": {},
  "disabled": true,
  "mandatory": true,
  "scoreCategoryId": {},
  "weight": 0,
  "frameworkItemIds": [
    {}
  ],
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ],
  "levelId": {},
  "companyIds": [
    {}
  ],
  "programIds": [
    {}
  ],
  "documentValue": 0.1,
  "tierChecks": [
    {
      "tierId": {},
      "checkDescriptions": [
        "string"
      ]
    }
  ]
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/document/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/document/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/document/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/document/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/document/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/document/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/document/{id}

{
  "name": "string",
  "description": "string",
  "validityId": {},
  "categoryId": {},
  "subCategoryId": {},
  "disabled": true,
  "mandatory": true,
  "scoreCategoryId": {},
  "weight": 0,
  "frameworkItemIds": [
    {}
  ],
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ],
  "levelId": {},
  "companyIds": [
    {}
  ],
  "programIds": [
    {}
  ],
  "documentValue": 0.1,
  "tierChecks": [
    {
      "tierId": {},
      "checkDescriptions": [
        "string"
      ]
    }
  ]
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	DocumentUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_document{id}

# You can also use wget
curl -X DELETE /api/document/{id}

DELETE /api/document/{id} HTTP/1.1


fetch('/api/document/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/document/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/document/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/document/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/document/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/document/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/document/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_document_upload

# You can also use wget
curl -X POST /api/document/upload \
  -H 'Content-Type: multipart/form-data'

POST /api/document/upload HTTP/1.1

Content-Type: multipart/form-data

const inputBody = '{
  "file": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data'
};

fetch('/api/document/upload',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'multipart/form-data'
}

result = RestClient.post '/api/document/upload',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'multipart/form-data'
}

r = requests.post('/api/document/upload', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/document/upload', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/document/upload");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"multipart/form-data"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/document/upload", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/document/upload

file: string

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» file	body	string(binary)	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

DocumentAssociation

get__api_documentassociation

# You can also use wget
curl -X GET /api/documentassociation

GET /api/documentassociation HTTP/1.1


fetch('/api/documentassociation',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/documentassociation',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/documentassociation')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/documentassociation', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/documentassociation");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/documentassociation", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/documentassociation

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_documentassociation

# You can also use wget
curl -X POST /api/documentassociation \
  -H 'Content-Type: application/json-patch+json'

POST /api/documentassociation HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "description": "string",
  "documentId": {},
  "ownerId": {},
  "ownerType": 0,
  "emissionDate": "2019-08-24T14:15:22Z",
  "questionnaireId": {},
  "tierId": {}
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/documentassociation',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/documentassociation',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/documentassociation', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/documentassociation', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/documentassociation");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/documentassociation", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/documentassociation

{
  "name": "string",
  "description": "string",
  "documentId": {},
  "ownerId": {},
  "ownerType": 0,
  "emissionDate": "2019-08-24T14:15:22Z",
  "questionnaireId": {},
  "tierId": {}
}

Parameters

Name	In	Type	Required	Description
body	body	DocumentAssociationInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_documentassociation_type{ownerType}

# You can also use wget
curl -X GET /api/documentassociation/type/{ownerType}

GET /api/documentassociation/type/{ownerType} HTTP/1.1


fetch('/api/documentassociation/type/{ownerType}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/documentassociation/type/{ownerType}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/documentassociation/type/{ownerType}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/documentassociation/type/{ownerType}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/documentassociation/type/{ownerType}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/documentassociation/type/{ownerType}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/documentassociation/type/{ownerType}

Parameters

Name	In	Type	Required	Description
ownerId	query	ObjectId	false	none
ownerType	path	OwnerType	true	none

Enumerated Values

Parameter	Value
ownerType	0
ownerType	1
ownerType	2
ownerType	3
ownerType	4
ownerType	5

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_documentassociation_owner{ownerId}type{ownerType}

# You can also use wget
curl -X GET /api/documentassociation/owner/{ownerId}/type/{ownerType}

GET /api/documentassociation/owner/{ownerId}/type/{ownerType} HTTP/1.1


fetch('/api/documentassociation/owner/{ownerId}/type/{ownerType}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/documentassociation/owner/{ownerId}/type/{ownerType}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/documentassociation/owner/{ownerId}/type/{ownerType}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/documentassociation/owner/{ownerId}/type/{ownerType}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/documentassociation/owner/{ownerId}/type/{ownerType}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/documentassociation/owner/{ownerId}/type/{ownerType}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/documentassociation/owner/{ownerId}/type/{ownerType}

Parameters

Name	In	Type	Required	Description
ownerId	path	ObjectId	true	none
ownerType	path	OwnerType	true	none

Enumerated Values

Parameter	Value
ownerType	0
ownerType	1
ownerType	2
ownerType	3
ownerType	4
ownerType	5

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_documentassociation_tier{tier}type{ownerType}

# You can also use wget
curl -X GET /api/documentassociation/tier/{tier}/type/{ownerType}

GET /api/documentassociation/tier/{tier}/type/{ownerType} HTTP/1.1


fetch('/api/documentassociation/tier/{tier}/type/{ownerType}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/documentassociation/tier/{tier}/type/{ownerType}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/documentassociation/tier/{tier}/type/{ownerType}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/documentassociation/tier/{tier}/type/{ownerType}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/documentassociation/tier/{tier}/type/{ownerType}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/documentassociation/tier/{tier}/type/{ownerType}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/documentassociation/tier/{tier}/type/{ownerType}

Parameters

Name	In	Type	Required	Description
tier	query	ObjectId	false	none
ownerType	path	OwnerType	true	none

Enumerated Values

Parameter	Value
ownerType	0
ownerType	1
ownerType	2
ownerType	3
ownerType	4
ownerType	5

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_documentassociation{id}

# You can also use wget
curl -X GET /api/documentassociation/{id}

GET /api/documentassociation/{id} HTTP/1.1


fetch('/api/documentassociation/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/documentassociation/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/documentassociation/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/documentassociation/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/documentassociation/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/documentassociation/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/documentassociation/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_documentassociation{id}

# You can also use wget
curl -X PUT /api/documentassociation/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/documentassociation/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "description": "string",
  "fileName": "string",
  "storageUrl": "string",
  "emissionDate": "2019-08-24T14:15:22Z",
  "tierId": {}
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/documentassociation/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/documentassociation/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/documentassociation/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/documentassociation/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/documentassociation/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/documentassociation/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/documentassociation/{id}

{
  "name": "string",
  "description": "string",
  "fileName": "string",
  "storageUrl": "string",
  "emissionDate": "2019-08-24T14:15:22Z",
  "tierId": {}
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	DocumentAssociationUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_documentassociation{id}

# You can also use wget
curl -X DELETE /api/documentassociation/{id}

DELETE /api/documentassociation/{id} HTTP/1.1


fetch('/api/documentassociation/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/documentassociation/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/documentassociation/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/documentassociation/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/documentassociation/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/documentassociation/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/documentassociation/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

DocumentTier

get__api_documenttier

# You can also use wget
curl -X GET /api/documenttier

GET /api/documenttier HTTP/1.1


fetch('/api/documenttier',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/documenttier',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/documenttier')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/documenttier', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/documenttier");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/documenttier", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/documenttier

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_documenttier

# You can also use wget
curl -X POST /api/documenttier \
  -H 'Content-Type: application/json-patch+json'

POST /api/documenttier HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "description": "string",
  "color": "string",
  "weight": 0.1
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/documenttier',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/documenttier',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/documenttier', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/documenttier', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/documenttier");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/documenttier", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/documenttier

{
  "name": "string",
  "description": "string",
  "color": "string",
  "weight": 0.1
}

Parameters

Name	In	Type	Required	Description
body	body	DocumentTierInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_documenttier{id}

# You can also use wget
curl -X GET /api/documenttier/{id}

GET /api/documenttier/{id} HTTP/1.1


fetch('/api/documenttier/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/documenttier/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/documenttier/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/documenttier/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/documenttier/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/documenttier/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/documenttier/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_documenttier{id}

# You can also use wget
curl -X PUT /api/documenttier/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/documenttier/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "description": "string",
  "color": "string",
  "weight": 0.1
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/documenttier/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/documenttier/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/documenttier/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/documenttier/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/documenttier/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/documenttier/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/documenttier/{id}

{
  "name": "string",
  "description": "string",
  "color": "string",
  "weight": 0.1
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	DocumentTierUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_documenttier{id}

# You can also use wget
curl -X DELETE /api/documenttier/{id}

DELETE /api/documenttier/{id} HTTP/1.1


fetch('/api/documenttier/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/documenttier/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/documenttier/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/documenttier/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/documenttier/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/documenttier/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/documenttier/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Framework

get__api_framework_control

# You can also use wget
curl -X GET /api/framework/control

GET /api/framework/control HTTP/1.1


fetch('/api/framework/control',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/framework/control',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/framework/control')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/framework/control', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/framework/control");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/framework/control", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/framework/control

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_framework_control

# You can also use wget
curl -X POST /api/framework/control \
  -H 'Content-Type: application/json-patch+json'

POST /api/framework/control HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "description": "string",
  "frameworkId": {},
  "target": 0.1,
  "disabled": true
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/framework/control',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/framework/control',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/framework/control', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/framework/control', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/framework/control");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/framework/control", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/framework/control

{
  "name": "string",
  "description": "string",
  "frameworkId": {},
  "target": 0.1,
  "disabled": true
}

Parameters

Name	In	Type	Required	Description
body	body	ControlInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_framework_control{id}

# You can also use wget
curl -X GET /api/framework/control/{id}

GET /api/framework/control/{id} HTTP/1.1


fetch('/api/framework/control/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/framework/control/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/framework/control/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/framework/control/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/framework/control/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/framework/control/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/framework/control/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_framework_control{id}

# You can also use wget
curl -X PUT /api/framework/control/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/framework/control/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "description": "string",
  "frameworkId": {},
  "target": 0.1,
  "disabled": true
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/framework/control/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/framework/control/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/framework/control/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/framework/control/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/framework/control/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/framework/control/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/framework/control/{id}

{
  "name": "string",
  "description": "string",
  "frameworkId": {},
  "target": 0.1,
  "disabled": true
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	ControlUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_framework_control{id}

# You can also use wget
curl -X DELETE /api/framework/control/{id}

DELETE /api/framework/control/{id} HTTP/1.1


fetch('/api/framework/control/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/framework/control/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/framework/control/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/framework/control/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/framework/control/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/framework/control/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/framework/control/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get__api_framework

# You can also use wget
curl -X GET /api/framework

GET /api/framework HTTP/1.1


fetch('/api/framework',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/framework',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/framework')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/framework', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/framework");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/framework", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/framework

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_framework

# You can also use wget
curl -X POST /api/framework \
  -H 'Content-Type: application/json-patch+json'

POST /api/framework HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "description": "string",
  "disabled": true,
  "color": "string"
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/framework',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/framework',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/framework', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/framework', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/framework");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/framework", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/framework

{
  "name": "string",
  "description": "string",
  "disabled": true,
  "color": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	FrameworkInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_framework{id}

# You can also use wget
curl -X GET /api/framework/{id}

GET /api/framework/{id} HTTP/1.1


fetch('/api/framework/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/framework/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/framework/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/framework/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/framework/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/framework/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/framework/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_framework{id}

# You can also use wget
curl -X PUT /api/framework/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/framework/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "description": "string",
  "disabled": true,
  "color": "string"
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/framework/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/framework/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/framework/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/framework/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/framework/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/framework/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/framework/{id}

{
  "name": "string",
  "description": "string",
  "disabled": true,
  "color": "string"
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	FrameworkUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_framework{id}

# You can also use wget
curl -X DELETE /api/framework/{id}

DELETE /api/framework/{id} HTTP/1.1


fetch('/api/framework/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/framework/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/framework/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/framework/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/framework/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/framework/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/framework/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get__api_framework_item

# You can also use wget
curl -X GET /api/framework/item

GET /api/framework/item HTTP/1.1


fetch('/api/framework/item',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/framework/item',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/framework/item')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/framework/item', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/framework/item");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/framework/item", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/framework/item

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_framework_item

# You can also use wget
curl -X POST /api/framework/item \
  -H 'Content-Type: application/json-patch+json'

POST /api/framework/item HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "description": "string",
  "controlId": {},
  "frameworkId": {}
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/framework/item',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/framework/item',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/framework/item', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/framework/item', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/framework/item");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/framework/item", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/framework/item

{
  "name": "string",
  "description": "string",
  "controlId": {},
  "frameworkId": {}
}

Parameters

Name	In	Type	Required	Description
body	body	FrameworkItemInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_framework_item{id}

# You can also use wget
curl -X GET /api/framework/item/{id}

GET /api/framework/item/{id} HTTP/1.1


fetch('/api/framework/item/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/framework/item/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/framework/item/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/framework/item/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/framework/item/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/framework/item/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/framework/item/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_framework_item{id}

# You can also use wget
curl -X PUT /api/framework/item/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/framework/item/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "description": "string",
  "controlId": {},
  "frameworkId": {}
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/framework/item/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/framework/item/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/framework/item/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/framework/item/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/framework/item/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/framework/item/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/framework/item/{id}

{
  "name": "string",
  "description": "string",
  "controlId": {},
  "frameworkId": {}
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	FrameworkItemUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_framework_item{id}

# You can also use wget
curl -X DELETE /api/framework/item/{id}

DELETE /api/framework/item/{id} HTTP/1.1


fetch('/api/framework/item/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/framework/item/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/framework/item/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/framework/item/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/framework/item/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/framework/item/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/framework/item/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

GaspodeV2

get_api_scanner_type{ownerType}

# You can also use wget
curl -X GET /api/scanner/type/{ownerType}

GET /api/scanner/type/{ownerType} HTTP/1.1


fetch('/api/scanner/type/{ownerType}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/scanner/type/{ownerType}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/scanner/type/{ownerType}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/scanner/type/{ownerType}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/scanner/type/{ownerType}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/scanner/type/{ownerType}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/scanner/type/{ownerType}

Parameters

Name	In	Type	Required	Description
ownerType	path	OwnerType	true	none

Enumerated Values

Parameter	Value
ownerType	0
ownerType	1
ownerType	2
ownerType	3
ownerType	4
ownerType	5

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_scanner_owner{ownerId}type{ownerType}

# You can also use wget
curl -X GET /api/scanner/owner/{ownerId}/type/{ownerType}

GET /api/scanner/owner/{ownerId}/type/{ownerType} HTTP/1.1


fetch('/api/scanner/owner/{ownerId}/type/{ownerType}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/scanner/owner/{ownerId}/type/{ownerType}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/scanner/owner/{ownerId}/type/{ownerType}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/scanner/owner/{ownerId}/type/{ownerType}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/scanner/owner/{ownerId}/type/{ownerType}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/scanner/owner/{ownerId}/type/{ownerType}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/scanner/owner/{ownerId}/type/{ownerType}

Parameters

Name	In	Type	Required	Description
ownerId	path	ObjectId	true	none
ownerType	path	OwnerType	true	none

Enumerated Values

Parameter	Value
ownerType	0
ownerType	1
ownerType	2
ownerType	3
ownerType	4
ownerType	5

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_scanner{id}

# You can also use wget
curl -X GET /api/scanner/{id}

GET /api/scanner/{id} HTTP/1.1


fetch('/api/scanner/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/scanner/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/scanner/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/scanner/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/scanner/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/scanner/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/scanner/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_scanner{id}

# You can also use wget
curl -X PUT /api/scanner/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/scanner/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "target": "string",
  "ownerId": {},
  "ownerType": 0,
  "industry": 0,
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ]
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/scanner/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/scanner/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/scanner/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/scanner/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/scanner/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/scanner/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/scanner/{id}

{
  "target": "string",
  "ownerId": {},
  "ownerType": 0,
  "industry": 0,
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ]
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	ScanConfigurationInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_scanner{id}

# You can also use wget
curl -X DELETE /api/scanner/{id}

DELETE /api/scanner/{id} HTTP/1.1


fetch('/api/scanner/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/scanner/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/scanner/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/scanner/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/scanner/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/scanner/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/scanner/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_scanner

# You can also use wget
curl -X POST /api/scanner \
  -H 'Content-Type: application/json-patch+json'

POST /api/scanner HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "target": "string",
  "ownerId": {},
  "ownerType": 0,
  "industry": 0,
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ]
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/scanner',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/scanner',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/scanner', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/scanner', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/scanner");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/scanner", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/scanner

{
  "target": "string",
  "ownerId": {},
  "ownerType": 0,
  "industry": 0,
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	ScanConfigurationInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_scanner_force

# You can also use wget
curl -X POST /api/scanner/force \
  -H 'Content-Type: application/json-patch+json'

POST /api/scanner/force HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "target": "string",
  "ownerId": {},
  "ownerType": 0,
  "industry": 0,
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ]
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/scanner/force',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/scanner/force',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/scanner/force', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/scanner/force', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/scanner/force");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/scanner/force", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/scanner/force

{
  "target": "string",
  "ownerId": {},
  "ownerType": 0,
  "industry": 0,
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	ScanConfigurationInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_scanner_callback

# You can also use wget
curl -X POST /api/scanner/callback \
  -H 'Content-Type: application/json-patch+json'

POST /api/scanner/callback HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "id": {},
  "target": "string",
  "crc": "string",
  "discovery": [
    "string"
  ],
  "domain": {
    "property1": [
      []
    ],
    "property2": [
      []
    ]
  },
  "start": "2019-08-24T14:15:22Z",
  "finish": "2019-08-24T14:15:22Z",
  "progress": 0,
  "status": "string"
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/scanner/callback',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/scanner/callback',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/scanner/callback', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/scanner/callback', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/scanner/callback");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/scanner/callback", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/scanner/callback

{
  "id": {},
  "target": "string",
  "crc": "string",
  "discovery": [
    "string"
  ],
  "domain": {
    "property1": [
      []
    ],
    "property2": [
      []
    ]
  },
  "start": "2019-08-24T14:15:22Z",
  "finish": "2019-08-24T14:15:22Z",
  "progress": 0,
  "status": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	ResultModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Group

get__api_group

# You can also use wget
curl -X GET /api/group

GET /api/group HTTP/1.1


fetch('/api/group',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/group',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/group')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/group', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/group");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/group", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/group

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_group

# You can also use wget
curl -X POST /api/group \
  -H 'Content-Type: application/json-patch+json'

POST /api/group HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "description": "string",
  "permissions": {
    "property1": true,
    "property2": true
  },
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ]
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/group',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/group',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/group', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/group', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/group");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/group", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/group

{
  "name": "string",
  "description": "string",
  "permissions": {
    "property1": true,
    "property2": true
  },
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	GroupInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_group{id}

# You can also use wget
curl -X GET /api/group/{id}

GET /api/group/{id} HTTP/1.1


fetch('/api/group/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/group/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/group/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/group/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/group/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/group/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/group/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_group{id}

# You can also use wget
curl -X PUT /api/group/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/group/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "description": "string",
  "permissions": {
    "property1": true,
    "property2": true
  },
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ],
  "deleted": true
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/group/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/group/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/group/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/group/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/group/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/group/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/group/{id}

{
  "name": "string",
  "description": "string",
  "permissions": {
    "property1": true,
    "property2": true
  },
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ],
  "deleted": true
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	GroupUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_group{id}

# You can also use wget
curl -X DELETE /api/group/{id}

DELETE /api/group/{id} HTTP/1.1


fetch('/api/group/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/group/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/group/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/group/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/group/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/group/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/group/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Health

get__api_health

# You can also use wget
curl -X GET /api/health

GET /api/health HTTP/1.1


fetch('/api/health',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/health',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/health')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/health', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/health");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/health", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/health

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Incident

get__api_incident

# You can also use wget
curl -X GET /api/incident

GET /api/incident HTTP/1.1


fetch('/api/incident',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/incident',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/incident')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/incident', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/incident");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/incident", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/incident

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_incident

# You can also use wget
curl -X POST /api/incident \
  -H 'Content-Type: application/json-patch+json'

POST /api/incident HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "description": "string",
  "ownerId": {},
  "ownerType": 0,
  "status": 0,
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ],
  "type": "string",
  "discovered": "2019-08-24T14:15:22Z",
  "startedOn": "2019-08-24T14:15:22Z",
  "systemsInvolved": "string",
  "impacts": "string",
  "measures": "string",
  "risk": "string",
  "responsibles": "string",
  "visibleToVendor": true
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/incident',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/incident',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/incident', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/incident', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/incident");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/incident", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/incident

{
  "name": "string",
  "description": "string",
  "ownerId": {},
  "ownerType": 0,
  "status": 0,
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ],
  "type": "string",
  "discovered": "2019-08-24T14:15:22Z",
  "startedOn": "2019-08-24T14:15:22Z",
  "systemsInvolved": "string",
  "impacts": "string",
  "measures": "string",
  "risk": "string",
  "responsibles": "string",
  "visibleToVendor": true
}

Parameters

Name	In	Type	Required	Description
body	body	IncidentInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_incident_type{ownerType}

# You can also use wget
curl -X GET /api/incident/type/{ownerType}

GET /api/incident/type/{ownerType} HTTP/1.1


fetch('/api/incident/type/{ownerType}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/incident/type/{ownerType}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/incident/type/{ownerType}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/incident/type/{ownerType}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/incident/type/{ownerType}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/incident/type/{ownerType}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/incident/type/{ownerType}

Parameters

Name	In	Type	Required	Description
ownerType	path	OwnerType	true	none

Enumerated Values

Parameter	Value
ownerType	0
ownerType	1
ownerType	2
ownerType	3
ownerType	4
ownerType	5

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_incident_owner{ownerId}type{ownerType}

# You can also use wget
curl -X GET /api/incident/owner/{ownerId}/type/{ownerType}

GET /api/incident/owner/{ownerId}/type/{ownerType} HTTP/1.1


fetch('/api/incident/owner/{ownerId}/type/{ownerType}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/incident/owner/{ownerId}/type/{ownerType}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/incident/owner/{ownerId}/type/{ownerType}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/incident/owner/{ownerId}/type/{ownerType}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/incident/owner/{ownerId}/type/{ownerType}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/incident/owner/{ownerId}/type/{ownerType}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/incident/owner/{ownerId}/type/{ownerType}

Parameters

Name	In	Type	Required	Description
ownerId	path	ObjectId	true	none
ownerType	path	OwnerType	true	none

Enumerated Values

Parameter	Value
ownerType	0
ownerType	1
ownerType	2
ownerType	3
ownerType	4
ownerType	5

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_incident{id}

# You can also use wget
curl -X GET /api/incident/{id}

GET /api/incident/{id} HTTP/1.1


fetch('/api/incident/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/incident/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/incident/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/incident/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/incident/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/incident/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/incident/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_incident{id}

# You can also use wget
curl -X PUT /api/incident/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/incident/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "description": "string",
  "ownerId": {},
  "ownerType": 0,
  "status": 0,
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ],
  "type": "string",
  "discovered": "2019-08-24T14:15:22Z",
  "startedOn": "2019-08-24T14:15:22Z",
  "systemsInvolved": "string",
  "impacts": "string",
  "measures": "string",
  "risk": "string",
  "responsibles": "string",
  "visibleToVendor": true
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/incident/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/incident/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/incident/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/incident/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/incident/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/incident/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/incident/{id}

{
  "name": "string",
  "description": "string",
  "ownerId": {},
  "ownerType": 0,
  "status": 0,
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ],
  "type": "string",
  "discovered": "2019-08-24T14:15:22Z",
  "startedOn": "2019-08-24T14:15:22Z",
  "systemsInvolved": "string",
  "impacts": "string",
  "measures": "string",
  "risk": "string",
  "responsibles": "string",
  "visibleToVendor": true
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	IncidentUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_incident{id}

# You can also use wget
curl -X DELETE /api/incident/{id}

DELETE /api/incident/{id} HTTP/1.1


fetch('/api/incident/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/incident/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/incident/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/incident/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/incident/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/incident/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/incident/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Instance

get__api_instance

# You can also use wget
curl -X GET /api/instance

GET /api/instance HTTP/1.1


fetch('/api/instance',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/instance',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/instance')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/instance', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/instance");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/instance", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/instance

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_instance

# You can also use wget
curl -X POST /api/instance \
  -H 'Content-Type: application/json-patch+json'

POST /api/instance HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "email": "string",
  "templateId": {},
  "licenceId": {},
  "demo": true,
  "logoUrl": "string",
  "stripeEnabled": true
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/instance',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/instance',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/instance', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/instance', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/instance");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/instance", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/instance

{
  "name": "string",
  "email": "string",
  "templateId": {},
  "licenceId": {},
  "demo": true,
  "logoUrl": "string",
  "stripeEnabled": true
}

Parameters

Name	In	Type	Required	Description
body	body	InstanceInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get__api_instance_templates

# You can also use wget
curl -X GET /api/instance/templates

GET /api/instance/templates HTTP/1.1


fetch('/api/instance/templates',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/instance/templates',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/instance/templates')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/instance/templates', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/instance/templates");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/instance/templates", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/instance/templates

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_instance{id}

# You can also use wget
curl -X GET /api/instance/{id}

GET /api/instance/{id} HTTP/1.1


fetch('/api/instance/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/instance/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/instance/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/instance/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/instance/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/instance/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/instance/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_instance{id}

# You can also use wget
curl -X PUT /api/instance/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/instance/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "email": "string",
  "templateId": {},
  "licenceId": {},
  "demo": true,
  "logoUrl": "string",
  "stripeEnabled": true,
  "isTemplate": true,
  "hasValidPayment": true,
  "instanceAdmins": [
    {}
  ]
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/instance/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/instance/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/instance/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/instance/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/instance/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/instance/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/instance/{id}

{
  "name": "string",
  "email": "string",
  "templateId": {},
  "licenceId": {},
  "demo": true,
  "logoUrl": "string",
  "stripeEnabled": true,
  "isTemplate": true,
  "hasValidPayment": true,
  "instanceAdmins": [
    {}
  ]
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	InstanceUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_instance{id}

# You can also use wget
curl -X DELETE /api/instance/{id}

DELETE /api/instance/{id} HTTP/1.1


fetch('/api/instance/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/instance/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/instance/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/instance/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/instance/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/instance/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/instance/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Label

get__api_label

# You can also use wget
curl -X GET /api/label

GET /api/label HTTP/1.1


fetch('/api/label',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/label',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/label')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/label', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/label");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/label", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/label

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_label

# You can also use wget
curl -X POST /api/label \
  -H 'Content-Type: application/json-patch+json'

POST /api/label HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "textColor": "string",
  "backgroundColor": "string"
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/label',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/label',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/label', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/label', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/label");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/label", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/label

{
  "name": "string",
  "textColor": "string",
  "backgroundColor": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	LabelInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_label{id}

# You can also use wget
curl -X GET /api/label/{id}

GET /api/label/{id} HTTP/1.1


fetch('/api/label/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/label/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/label/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/label/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/label/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/label/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/label/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_label{id}

# You can also use wget
curl -X PUT /api/label/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/label/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "textColor": "string",
  "backgroundColor": "string"
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/label/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/label/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/label/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/label/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/label/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/label/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/label/{id}

{
  "name": "string",
  "textColor": "string",
  "backgroundColor": "string"
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	LabelUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_label{id}

# You can also use wget
curl -X DELETE /api/label/{id}

DELETE /api/label/{id} HTTP/1.1


fetch('/api/label/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/label/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/label/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/label/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/label/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/label/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/label/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Level

get__api_level

# You can also use wget
curl -X GET /api/level

GET /api/level HTTP/1.1


fetch('/api/level',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/level',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/level')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/level', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/level");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/level", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/level

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_level

# You can also use wget
curl -X POST /api/level \
  -H 'Content-Type: application/json-patch+json'

POST /api/level HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "description": "string",
  "level": 0
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/level',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/level',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/level', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/level', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/level");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/level", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/level

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

Parameters

Name	In	Type	Required	Description
body	body	LevelInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_level{id}

# You can also use wget
curl -X GET /api/level/{id}

GET /api/level/{id} HTTP/1.1


fetch('/api/level/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/level/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/level/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/level/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/level/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/level/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/level/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_level{id}

# You can also use wget
curl -X PUT /api/level/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/level/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "description": "string",
  "level": 0
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/level/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/level/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/level/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/level/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/level/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/level/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/level/{id}

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

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	LevelUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_level{id}

# You can also use wget
curl -X DELETE /api/level/{id}

DELETE /api/level/{id} HTTP/1.1


fetch('/api/level/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/level/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/level/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/level/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/level/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/level/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/level/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Licence

get__api_licence

# You can also use wget
curl -X GET /api/licence

GET /api/licence HTTP/1.1


fetch('/api/licence',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/licence',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/licence')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/licence', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/licence");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/licence", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/licence

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_licence

# You can also use wget
curl -X POST /api/licence \
  -H 'Content-Type: application/json-patch+json'

POST /api/licence HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "description": "string",
  "features": {
    "property1": true,
    "property2": true
  },
  "stripeId": "string",
  "maxVendors": 0,
  "maxEditUsers": 0
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/licence',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/licence',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/licence', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/licence', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/licence");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/licence", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/licence

{
  "name": "string",
  "description": "string",
  "features": {
    "property1": true,
    "property2": true
  },
  "stripeId": "string",
  "maxVendors": 0,
  "maxEditUsers": 0
}

Parameters

Name	In	Type	Required	Description
body	body	LicenceInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_licence{id}

# You can also use wget
curl -X GET /api/licence/{id}

GET /api/licence/{id} HTTP/1.1


fetch('/api/licence/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/licence/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/licence/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/licence/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/licence/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/licence/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/licence/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_licence{id}

# You can also use wget
curl -X PUT /api/licence/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/licence/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "description": "string",
  "features": {
    "property1": true,
    "property2": true
  },
  "stripeId": "string",
  "maxVendors": 0,
  "maxEditUsers": 0
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/licence/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/licence/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/licence/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/licence/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/licence/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/licence/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/licence/{id}

{
  "name": "string",
  "description": "string",
  "features": {
    "property1": true,
    "property2": true
  },
  "stripeId": "string",
  "maxVendors": 0,
  "maxEditUsers": 0
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	LicenceUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_licence{id}

# You can also use wget
curl -X DELETE /api/licence/{id}

DELETE /api/licence/{id} HTTP/1.1


fetch('/api/licence/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/licence/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/licence/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/licence/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/licence/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/licence/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/licence/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Mission

get__api_mission

# You can also use wget
curl -X GET /api/mission

GET /api/mission HTTP/1.1


fetch('/api/mission',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/mission',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/mission')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/mission', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/mission");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/mission", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/mission

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_mission

# You can also use wget
curl -X POST /api/mission \
  -H 'Content-Type: application/json-patch+json'

POST /api/mission HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "description": "string",
  "disabled": true,
  "labelIds": [
    {}
  ]
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/mission',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/mission',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/mission', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/mission', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/mission");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/mission", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/mission

{
  "name": "string",
  "description": "string",
  "disabled": true,
  "labelIds": [
    {}
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	MissionInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_mission{id}

# You can also use wget
curl -X GET /api/mission/{id}

GET /api/mission/{id} HTTP/1.1


fetch('/api/mission/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/mission/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/mission/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/mission/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/mission/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/mission/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/mission/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_mission{id}

# You can also use wget
curl -X PUT /api/mission/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/mission/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "description": "string",
  "disabled": true,
  "labelIds": [
    {}
  ]
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/mission/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/mission/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/mission/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/mission/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/mission/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/mission/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/mission/{id}

{
  "name": "string",
  "description": "string",
  "disabled": true,
  "labelIds": [
    {}
  ]
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	MissionUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_mission{id}

# You can also use wget
curl -X DELETE /api/mission/{id}

DELETE /api/mission/{id} HTTP/1.1


fetch('/api/mission/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/mission/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/mission/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/mission/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/mission/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/mission/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/mission/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

MissionAssociation

get__api_missionassociation

# You can also use wget
curl -X GET /api/missionassociation

GET /api/missionassociation HTTP/1.1


fetch('/api/missionassociation',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/missionassociation',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/missionassociation')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/missionassociation', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/missionassociation");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/missionassociation", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/missionassociation

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_missionassociation_owner{ownerId}type{ownerType}

# You can also use wget
curl -X GET /api/missionassociation/owner/{ownerId}/type/{ownerType}

GET /api/missionassociation/owner/{ownerId}/type/{ownerType} HTTP/1.1


fetch('/api/missionassociation/owner/{ownerId}/type/{ownerType}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/missionassociation/owner/{ownerId}/type/{ownerType}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/missionassociation/owner/{ownerId}/type/{ownerType}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/missionassociation/owner/{ownerId}/type/{ownerType}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/missionassociation/owner/{ownerId}/type/{ownerType}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/missionassociation/owner/{ownerId}/type/{ownerType}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/missionassociation/owner/{ownerId}/type/{ownerType}

Parameters

Name	In	Type	Required	Description
ownerId	path	ObjectId	true	none
ownerType	path	OwnerType	true	none

Enumerated Values

Parameter	Value
ownerType	0
ownerType	1
ownerType	2
ownerType	3
ownerType	4
ownerType	5

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_missionassociation{id}

# You can also use wget
curl -X GET /api/missionassociation/{id}

GET /api/missionassociation/{id} HTTP/1.1


fetch('/api/missionassociation/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/missionassociation/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/missionassociation/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/missionassociation/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/missionassociation/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/missionassociation/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/missionassociation/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Notification

get__api_notification

# You can also use wget
curl -X GET /api/notification

GET /api/notification HTTP/1.1


fetch('/api/notification',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/notification',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/notification')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/notification', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/notification");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/notification", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/notification

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_notification

# You can also use wget
curl -X POST /api/notification

POST /api/notification HTTP/1.1


fetch('/api/notification',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.post '/api/notification',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.post('/api/notification')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/notification', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/notification");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/notification", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/notification

Parameters

Name	In	Type	Required	Description
id	query	ObjectId	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_notification{id}

# You can also use wget
curl -X GET /api/notification/{id}

GET /api/notification/{id} HTTP/1.1


fetch('/api/notification/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/notification/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/notification/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/notification/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/notification/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/notification/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/notification/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post_api_notification{id}

# You can also use wget
curl -X POST /api/notification/{id}

POST /api/notification/{id} HTTP/1.1


fetch('/api/notification/{id}',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.post '/api/notification/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.post('/api/notification/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/notification/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/notification/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/notification/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/notification/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

NotificationRule

get__api_notificationrule

# You can also use wget
curl -X GET /api/notificationrule

GET /api/notificationrule HTTP/1.1


fetch('/api/notificationrule',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/notificationrule',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/notificationrule')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/notificationrule', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/notificationrule");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/notificationrule", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/notificationrule

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_notificationrule

# You can also use wget
curl -X POST /api/notificationrule \
  -H 'Content-Type: application/json-patch+json'

POST /api/notificationrule HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "title": "string",
  "message": "string",
  "type": 0,
  "deliverInApplication": true,
  "deliverByEmail": true
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/notificationrule',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/notificationrule',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/notificationrule', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/notificationrule', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/notificationrule");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/notificationrule", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/notificationrule

{
  "title": "string",
  "message": "string",
  "type": 0,
  "deliverInApplication": true,
  "deliverByEmail": true
}

Parameters

Name	In	Type	Required	Description
body	body	NotificationRuleInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_notificationrule{id}

# You can also use wget
curl -X GET /api/notificationrule/{id}

GET /api/notificationrule/{id} HTTP/1.1


fetch('/api/notificationrule/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/notificationrule/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/notificationrule/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/notificationrule/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/notificationrule/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/notificationrule/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/notificationrule/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_notificationrule{id}

# You can also use wget
curl -X PUT /api/notificationrule/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/notificationrule/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "title": "string",
  "message": "string",
  "type": 0,
  "deliverInApplication": true,
  "deliverByEmail": true
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/notificationrule/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/notificationrule/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/notificationrule/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/notificationrule/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/notificationrule/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/notificationrule/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/notificationrule/{id}

{
  "title": "string",
  "message": "string",
  "type": 0,
  "deliverInApplication": true,
  "deliverByEmail": true
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	NotificationRuleUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_notificationrule{id}

# You can also use wget
curl -X DELETE /api/notificationrule/{id}

DELETE /api/notificationrule/{id} HTTP/1.1


fetch('/api/notificationrule/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/notificationrule/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/notificationrule/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/notificationrule/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/notificationrule/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/notificationrule/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/notificationrule/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

OrganizationCategory

get__api_organizationCategory

# You can also use wget
curl -X GET /api/organizationCategory

GET /api/organizationCategory HTTP/1.1


fetch('/api/organizationCategory',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/organizationCategory',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/organizationCategory')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/organizationCategory', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/organizationCategory");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/organizationCategory", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/organizationCategory

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_organizationCategory

# You can also use wget
curl -X POST /api/organizationCategory \
  -H 'Content-Type: application/json-patch+json'

POST /api/organizationCategory HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "legalEntity": true
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/organizationCategory',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/organizationCategory',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/organizationCategory', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/organizationCategory', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/organizationCategory");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/organizationCategory", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/organizationCategory

{
  "name": "string",
  "legalEntity": true
}

Parameters

Name	In	Type	Required	Description
body	body	OrganizationCategoryInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_organizationCategory{id}

# You can also use wget
curl -X GET /api/organizationCategory/{id}

GET /api/organizationCategory/{id} HTTP/1.1


fetch('/api/organizationCategory/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/organizationCategory/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/organizationCategory/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/organizationCategory/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/organizationCategory/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/organizationCategory/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/organizationCategory/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_organizationCategory{id}

# You can also use wget
curl -X PUT /api/organizationCategory/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/organizationCategory/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "legalEntity": true
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/organizationCategory/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/organizationCategory/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/organizationCategory/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/organizationCategory/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/organizationCategory/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/organizationCategory/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/organizationCategory/{id}

{
  "name": "string",
  "legalEntity": true
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	OrganizationCategoryUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_organizationCategory{id}

# You can also use wget
curl -X DELETE /api/organizationCategory/{id}

DELETE /api/organizationCategory/{id} HTTP/1.1


fetch('/api/organizationCategory/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/organizationCategory/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/organizationCategory/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/organizationCategory/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/organizationCategory/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/organizationCategory/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/organizationCategory/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Payment

post__api_payments_session

# You can also use wget
curl -X POST /api/payments/session

POST /api/payments/session HTTP/1.1


fetch('/api/payments/session',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.post '/api/payments/session',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.post('/api/payments/session')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/payments/session', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/payments/session");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/payments/session", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/payments/session

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_payments_hook

# You can also use wget
curl -X POST /api/payments/hook \
  -H 'Content-Type: application/json-patch+json'

POST /api/payments/hook HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "stripeResponse": {
    "statusCode": 100,
    "headers": [
      {
        "key": "string",
        "value": [
          "string"
        ]
      }
    ],
    "content": "string"
  },
  "id": "string",
  "object": "string",
  "account": "string",
  "apiVersion": "string",
  "created": "2019-08-24T14:15:22Z",
  "data": {
    "stripeResponse": {
      "statusCode": 100,
      "headers": [
        {
          "key": "string",
          "value": [
            "string"
          ]
        }
      ],
      "content": "string"
    },
    "object": {
      "object": "string"
    },
    "previousAttributes": null,
    "rawObject": null
  },
  "livemode": true,
  "pendingWebhooks": 0,
  "request": {
    "stripeResponse": {
      "statusCode": 100,
      "headers": [
        {
          "key": "string",
          "value": [
            "string"
          ]
        }
      ],
      "content": "string"
    },
    "id": "string",
    "idempotencyKey": "string"
  },
  "type": "string"
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/payments/hook',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/payments/hook',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/payments/hook', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/payments/hook', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/payments/hook");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/payments/hook", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/payments/hook

{
  "stripeResponse": {
    "statusCode": 100,
    "headers": [
      {
        "key": "string",
        "value": [
          "string"
        ]
      }
    ],
    "content": "string"
  },
  "id": "string",
  "object": "string",
  "account": "string",
  "apiVersion": "string",
  "created": "2019-08-24T14:15:22Z",
  "data": {
    "stripeResponse": {
      "statusCode": 100,
      "headers": [
        {
          "key": "string",
          "value": [
            "string"
          ]
        }
      ],
      "content": "string"
    },
    "object": {
      "object": "string"
    },
    "previousAttributes": null,
    "rawObject": null
  },
  "livemode": true,
  "pendingWebhooks": 0,
  "request": {
    "stripeResponse": {
      "statusCode": 100,
      "headers": [
        {
          "key": "string",
          "value": [
            "string"
          ]
        }
      ],
      "content": "string"
    },
    "id": "string",
    "idempotencyKey": "string"
  },
  "type": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	Event	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

PdfGenerator

get__api_pdf_report

# You can also use wget
curl -X GET /api/pdf/report

GET /api/pdf/report HTTP/1.1


fetch('/api/pdf/report',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/pdf/report',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/pdf/report')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/pdf/report', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/pdf/report");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/pdf/report", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/pdf/report

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Program

get__api_program

# You can also use wget
curl -X GET /api/program

GET /api/program HTTP/1.1


fetch('/api/program',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/program',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/program')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/program', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/program");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/program", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/program

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_program

# You can also use wget
curl -X POST /api/program \
  -H 'Content-Type: application/json-patch+json'

POST /api/program HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "description": "string",
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ],
  "criticalityWeight": 0.1,
  "scoreCategoryWeights": [
    {
      "scoreCategoryId": {},
      "weight": 0.1
    }
  ]
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/program',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/program',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/program', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/program', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/program");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/program", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/program

{
  "name": "string",
  "description": "string",
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ],
  "criticalityWeight": 0.1,
  "scoreCategoryWeights": [
    {
      "scoreCategoryId": {},
      "weight": 0.1
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	ProgramInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_program{id}

# You can also use wget
curl -X GET /api/program/{id}

GET /api/program/{id} HTTP/1.1


fetch('/api/program/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/program/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/program/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/program/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/program/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/program/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/program/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_program{id}

# You can also use wget
curl -X PUT /api/program/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/program/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "description": "string",
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ],
  "criticalityWeight": 0.1,
  "scoreCategoryWeights": [
    {
      "scoreCategoryId": {},
      "weight": 0.1
    }
  ]
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/program/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/program/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/program/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/program/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/program/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/program/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/program/{id}

{
  "name": "string",
  "description": "string",
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ],
  "criticalityWeight": 0.1,
  "scoreCategoryWeights": [
    {
      "scoreCategoryId": {},
      "weight": 0.1
    }
  ]
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	ProgramUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_program{id}

# You can also use wget
curl -X DELETE /api/program/{id}

DELETE /api/program/{id} HTTP/1.1


fetch('/api/program/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/program/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/program/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/program/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/program/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/program/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/program/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Question

get__api_question

# You can also use wget
curl -X GET /api/question

GET /api/question HTTP/1.1


fetch('/api/question',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/question',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/question')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/question', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/question");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/question", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/question

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_question

# You can also use wget
curl -X POST /api/question \
  -H 'Content-Type: application/json-patch+json'

POST /api/question HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "question": "string",
  "questionnaireId": {},
  "answers": [
    {
      "answer": "string",
      "requiresDocument": true,
      "requiresNotes": true,
      "remediations": [
        {}
      ],
      "documentId": {}
    }
  ],
  "disabled": true,
  "answerType": 0,
  "parents": [
    {
      "uniqueId": {},
      "answers": [
        "string"
      ]
    }
  ]
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/question',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/question',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/question', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/question', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/question");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/question", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/question

{
  "name": "string",
  "question": "string",
  "questionnaireId": {},
  "answers": [
    {
      "answer": "string",
      "requiresDocument": true,
      "requiresNotes": true,
      "remediations": [
        {}
      ],
      "documentId": {}
    }
  ],
  "disabled": true,
  "answerType": 0,
  "parents": [
    {
      "uniqueId": {},
      "answers": [
        "string"
      ]
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	QuestionInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_question_questionnaire{id}

# You can also use wget
curl -X GET /api/question/questionnaire/{id}

GET /api/question/questionnaire/{id} HTTP/1.1


fetch('/api/question/questionnaire/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/question/questionnaire/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/question/questionnaire/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/question/questionnaire/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/question/questionnaire/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/question/questionnaire/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/question/questionnaire/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_question{id}

# You can also use wget
curl -X GET /api/question/{id}

GET /api/question/{id} HTTP/1.1


fetch('/api/question/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/question/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/question/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/question/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/question/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/question/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/question/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_question{id}

# You can also use wget
curl -X PUT /api/question/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/question/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "question": "string",
  "questionnaireId": {},
  "answers": [
    {
      "answer": "string",
      "requiresDocument": true,
      "requiresNotes": true,
      "remediations": [
        {}
      ],
      "documentId": {}
    }
  ],
  "disabled": true,
  "answerType": 0,
  "parents": [
    {
      "uniqueId": {},
      "answers": [
        "string"
      ]
    }
  ],
  "deleted": true
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/question/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/question/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/question/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/question/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/question/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/question/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/question/{id}

{
  "name": "string",
  "question": "string",
  "questionnaireId": {},
  "answers": [
    {
      "answer": "string",
      "requiresDocument": true,
      "requiresNotes": true,
      "remediations": [
        {}
      ],
      "documentId": {}
    }
  ],
  "disabled": true,
  "answerType": 0,
  "parents": [
    {
      "uniqueId": {},
      "answers": [
        "string"
      ]
    }
  ],
  "deleted": true
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	QuestionUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_question{id}

# You can also use wget
curl -X DELETE /api/question/{id}

DELETE /api/question/{id} HTTP/1.1


fetch('/api/question/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/question/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/question/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/question/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/question/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/question/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/question/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Questionnaire

get__api_questionnaire

# You can also use wget
curl -X GET /api/questionnaire

GET /api/questionnaire HTTP/1.1


fetch('/api/questionnaire',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/questionnaire',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/questionnaire')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/questionnaire', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/questionnaire");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/questionnaire", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/questionnaire

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_questionnaire

# You can also use wget
curl -X POST /api/questionnaire \
  -H 'Content-Type: application/json-patch+json'

POST /api/questionnaire HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "mandatory": true,
  "disabled": true,
  "isDraft": true,
  "isRecurrent": true,
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ],
  "validityId": {},
  "companyIds": [
    {}
  ],
  "programIds": [
    {}
  ]
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/questionnaire',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/questionnaire',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/questionnaire', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/questionnaire', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/questionnaire");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/questionnaire", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/questionnaire

{
  "name": "string",
  "mandatory": true,
  "disabled": true,
  "isDraft": true,
  "isRecurrent": true,
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ],
  "validityId": {},
  "companyIds": [
    {}
  ],
  "programIds": [
    {}
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	QuestionnaireInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_questionnaire{id}

# You can also use wget
curl -X GET /api/questionnaire/{id}

GET /api/questionnaire/{id} HTTP/1.1


fetch('/api/questionnaire/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/questionnaire/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/questionnaire/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/questionnaire/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/questionnaire/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/questionnaire/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/questionnaire/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_questionnaire{id}

# You can also use wget
curl -X PUT /api/questionnaire/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/questionnaire/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "mandatory": true,
  "disabled": true,
  "isDraft": true,
  "isRecurrent": true,
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ],
  "validityId": {},
  "companyIds": [
    {}
  ],
  "programIds": [
    {}
  ],
  "deleted": true
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/questionnaire/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/questionnaire/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/questionnaire/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/questionnaire/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/questionnaire/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/questionnaire/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/questionnaire/{id}

{
  "name": "string",
  "mandatory": true,
  "disabled": true,
  "isDraft": true,
  "isRecurrent": true,
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ],
  "validityId": {},
  "companyIds": [
    {}
  ],
  "programIds": [
    {}
  ],
  "deleted": true
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	QuestionnaireUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_questionnaire{id}

# You can also use wget
curl -X DELETE /api/questionnaire/{id}

DELETE /api/questionnaire/{id} HTTP/1.1


fetch('/api/questionnaire/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/questionnaire/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/questionnaire/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/questionnaire/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/questionnaire/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/questionnaire/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/questionnaire/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post_api_questionnaire{id}_publish

# You can also use wget
curl -X POST /api/questionnaire/{id}/publish

POST /api/questionnaire/{id}/publish HTTP/1.1


fetch('/api/questionnaire/{id}/publish',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.post '/api/questionnaire/{id}/publish',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.post('/api/questionnaire/{id}/publish')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/questionnaire/{id}/publish', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/questionnaire/{id}/publish");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/questionnaire/{id}/publish", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/questionnaire/{id}/publish

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post_api_questionnaire{id}_draft

# You can also use wget
curl -X POST /api/questionnaire/{id}/draft

POST /api/questionnaire/{id}/draft HTTP/1.1


fetch('/api/questionnaire/{id}/draft',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.post '/api/questionnaire/{id}/draft',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.post('/api/questionnaire/{id}/draft')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/questionnaire/{id}/draft', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/questionnaire/{id}/draft");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/questionnaire/{id}/draft", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/questionnaire/{id}/draft

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_questionnaire{id}_draft

# You can also use wget
curl -X DELETE /api/questionnaire/{id}/draft

DELETE /api/questionnaire/{id}/draft HTTP/1.1


fetch('/api/questionnaire/{id}/draft',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/questionnaire/{id}/draft',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/questionnaire/{id}/draft')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/questionnaire/{id}/draft', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/questionnaire/{id}/draft");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/questionnaire/{id}/draft", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/questionnaire/{id}/draft

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Registration

post__api_register

# You can also use wget
curl -X POST /api/register \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain'

POST /api/register HTTP/1.1

Content-Type: application/json-patch+json
Accept: text/plain

const inputBody = '{
  "email": "string",
  "name": "string"
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain'
};

fetch('/api/register',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json',
  'Accept' => 'text/plain'
}

result = RestClient.post '/api/register',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json',
  'Accept': 'text/plain'
}

r = requests.post('/api/register', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
    'Accept' => 'text/plain',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/register', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/register");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
        "Accept": []string{"text/plain"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/register", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/register

{
  "email": "string",
  "name": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	UserRegisterModel	false	none

{"success":true,"error_code":1000,"message":"string","data":null,"errors":null,"remainingCallsInThisHour":0}

{
  "success": true,
  "error_code": 1000,
  "message": "string",
  "data": null,
  "errors": null,
  "remainingCallsInThisHour": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	ApiResponse

post_api_activate{userSecret}

# You can also use wget
curl -X POST /api/activate/{userSecret} \
  -H 'Content-Type: application/json-patch+json'

POST /api/activate/{userSecret} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "password": "string"
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/activate/{userSecret}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/activate/{userSecret}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/activate/{userSecret}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/activate/{userSecret}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/activate/{userSecret}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/activate/{userSecret}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/activate/{userSecret}

{
  "name": "string",
  "password": "string"
}

Parameters

Name	In	Type	Required	Description
userSecret	path	string	true	none
body	body	UserActivateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Remediation

get__api_remediation

# You can also use wget
curl -X GET /api/remediation

GET /api/remediation HTTP/1.1


fetch('/api/remediation',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/remediation',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/remediation')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/remediation', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/remediation");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/remediation", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/remediation

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_remediation

# You can also use wget
curl -X POST /api/remediation \
  -H 'Content-Type: application/json-patch+json'

POST /api/remediation HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "description": "string",
  "missionId": {},
  "remediationType": 0,
  "pattern": "string",
  "frameworkItemIds": [
    {}
  ],
  "disabled": true,
  "unsolvable": true,
  "labelIds": [
    {}
  ],
  "scoreCategoryId": {},
  "weight": 0,
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ],
  "levelId": {},
  "requiresProof": true,
  "requiresNotes": true,
  "proofDescription": "string"
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/remediation',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/remediation',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/remediation', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/remediation', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/remediation");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/remediation", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/remediation

{
  "name": "string",
  "description": "string",
  "missionId": {},
  "remediationType": 0,
  "pattern": "string",
  "frameworkItemIds": [
    {}
  ],
  "disabled": true,
  "unsolvable": true,
  "labelIds": [
    {}
  ],
  "scoreCategoryId": {},
  "weight": 0,
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ],
  "levelId": {},
  "requiresProof": true,
  "requiresNotes": true,
  "proofDescription": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	RemediationInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_remediation{id}

# You can also use wget
curl -X GET /api/remediation/{id}

GET /api/remediation/{id} HTTP/1.1


fetch('/api/remediation/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/remediation/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/remediation/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/remediation/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/remediation/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/remediation/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/remediation/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_remediation{id}

# You can also use wget
curl -X PUT /api/remediation/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/remediation/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "description": "string",
  "missionId": {},
  "remediationType": 0,
  "pattern": "string",
  "frameworkItemIds": [
    {}
  ],
  "disabled": true,
  "unsolvable": true,
  "labelIds": [
    {}
  ],
  "scoreCategoryId": {},
  "weight": 0,
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ],
  "levelId": {},
  "requiresProof": true,
  "requiresNotes": true,
  "proofDescription": "string"
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/remediation/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/remediation/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/remediation/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/remediation/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/remediation/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/remediation/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/remediation/{id}

{
  "name": "string",
  "description": "string",
  "missionId": {},
  "remediationType": 0,
  "pattern": "string",
  "frameworkItemIds": [
    {}
  ],
  "disabled": true,
  "unsolvable": true,
  "labelIds": [
    {}
  ],
  "scoreCategoryId": {},
  "weight": 0,
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ],
  "levelId": {},
  "requiresProof": true,
  "requiresNotes": true,
  "proofDescription": "string"
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	RemediationUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_remediation{id}

# You can also use wget
curl -X DELETE /api/remediation/{id}

DELETE /api/remediation/{id} HTTP/1.1


fetch('/api/remediation/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/remediation/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/remediation/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/remediation/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/remediation/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/remediation/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/remediation/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

RemediationAssociationController

get__api_remediationassociation

# You can also use wget
curl -X GET /api/remediationassociation

GET /api/remediationassociation HTTP/1.1


fetch('/api/remediationassociation',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/remediationassociation',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/remediationassociation')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/remediationassociation', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/remediationassociation");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/remediationassociation", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/remediationassociation

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_remediationassociation_type{ownerType}

# You can also use wget
curl -X GET /api/remediationassociation/type/{ownerType}

GET /api/remediationassociation/type/{ownerType} HTTP/1.1


fetch('/api/remediationassociation/type/{ownerType}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/remediationassociation/type/{ownerType}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/remediationassociation/type/{ownerType}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/remediationassociation/type/{ownerType}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/remediationassociation/type/{ownerType}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/remediationassociation/type/{ownerType}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/remediationassociation/type/{ownerType}

Parameters

Name	In	Type	Required	Description
ownerType	path	OwnerType	true	none

Enumerated Values

Parameter	Value
ownerType	0
ownerType	1
ownerType	2
ownerType	3
ownerType	4
ownerType	5

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_remediationassociation_owner{ownerId}type{ownerType}

# You can also use wget
curl -X GET /api/remediationassociation/owner/{ownerId}/type/{ownerType}

GET /api/remediationassociation/owner/{ownerId}/type/{ownerType} HTTP/1.1


fetch('/api/remediationassociation/owner/{ownerId}/type/{ownerType}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/remediationassociation/owner/{ownerId}/type/{ownerType}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/remediationassociation/owner/{ownerId}/type/{ownerType}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/remediationassociation/owner/{ownerId}/type/{ownerType}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/remediationassociation/owner/{ownerId}/type/{ownerType}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/remediationassociation/owner/{ownerId}/type/{ownerType}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/remediationassociation/owner/{ownerId}/type/{ownerType}

Parameters

Name	In	Type	Required	Description
ownerId	path	ObjectId	true	none
ownerType	path	OwnerType	true	none

Enumerated Values

Parameter	Value
ownerType	0
ownerType	1
ownerType	2
ownerType	3
ownerType	4
ownerType	5

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_remediationassociation_approval{approval}type{ownerType}

# You can also use wget
curl -X GET /api/remediationassociation/approval/{approval}/type/{ownerType}

GET /api/remediationassociation/approval/{approval}/type/{ownerType} HTTP/1.1


fetch('/api/remediationassociation/approval/{approval}/type/{ownerType}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/remediationassociation/approval/{approval}/type/{ownerType}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/remediationassociation/approval/{approval}/type/{ownerType}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/remediationassociation/approval/{approval}/type/{ownerType}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/remediationassociation/approval/{approval}/type/{ownerType}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/remediationassociation/approval/{approval}/type/{ownerType}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/remediationassociation/approval/{approval}/type/{ownerType}

Parameters

Name	In	Type	Required	Description
approval	path	ApprovalStatus	true	none
ownerType	path	OwnerType	true	none

Enumerated Values

Parameter	Value
approval	0
approval	1
approval	2
approval	3
ownerType	0
ownerType	1
ownerType	2
ownerType	3
ownerType	4
ownerType	5

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_remediationassociation{id}

# You can also use wget
curl -X GET /api/remediationassociation/{id}

GET /api/remediationassociation/{id} HTTP/1.1


fetch('/api/remediationassociation/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/remediationassociation/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/remediationassociation/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/remediationassociation/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/remediationassociation/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/remediationassociation/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/remediationassociation/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_remediationassociation_done{id}

# You can also use wget
curl -X PUT /api/remediationassociation/done/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/remediationassociation/done/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "done": 0,
  "waiveNotes": "string",
  "fileName": "string",
  "storageUrl": "string",
  "emissionDate": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "proofName": "string",
  "proofUrl": "string",
  "notes": "string",
  "approval": 0,
  "approvalNotes": "string"
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/remediationassociation/done/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/remediationassociation/done/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/remediationassociation/done/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/remediationassociation/done/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/remediationassociation/done/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/remediationassociation/done/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/remediationassociation/done/{id}

{
  "done": 0,
  "waiveNotes": "string",
  "fileName": "string",
  "storageUrl": "string",
  "emissionDate": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "proofName": "string",
  "proofUrl": "string",
  "notes": "string",
  "approval": 0,
  "approvalNotes": "string"
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	RemediationAssociationUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

RiskAssessment

get_api_riskassessment_owner{ownerId}type{ownerType}

# You can also use wget
curl -X GET /api/riskassessment/owner/{ownerId}/type/{ownerType}

GET /api/riskassessment/owner/{ownerId}/type/{ownerType} HTTP/1.1


fetch('/api/riskassessment/owner/{ownerId}/type/{ownerType}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/riskassessment/owner/{ownerId}/type/{ownerType}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/riskassessment/owner/{ownerId}/type/{ownerType}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/riskassessment/owner/{ownerId}/type/{ownerType}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/riskassessment/owner/{ownerId}/type/{ownerType}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/riskassessment/owner/{ownerId}/type/{ownerType}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/riskassessment/owner/{ownerId}/type/{ownerType}

Parameters

Name	In	Type	Required	Description
ownerId	path	ObjectId	true	none
ownerType	path	OwnerType	true	none

Enumerated Values

Parameter	Value
ownerType	0
ownerType	1
ownerType	2
ownerType	3
ownerType	4
ownerType	5

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_riskassessment{id}

# You can also use wget
curl -X GET /api/riskassessment/{id}

GET /api/riskassessment/{id} HTTP/1.1


fetch('/api/riskassessment/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/riskassessment/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/riskassessment/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/riskassessment/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/riskassessment/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/riskassessment/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/riskassessment/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_riskassessment{id}

# You can also use wget
curl -X PUT /api/riskassessment/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/riskassessment/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "ownerId": {},
  "ownerType": 0
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/riskassessment/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/riskassessment/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/riskassessment/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/riskassessment/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/riskassessment/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/riskassessment/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/riskassessment/{id}

{
  "name": "string",
  "ownerId": {},
  "ownerType": 0
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	RiskAssessmentUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_riskassessment{id}

# You can also use wget
curl -X DELETE /api/riskassessment/{id}

DELETE /api/riskassessment/{id} HTTP/1.1


fetch('/api/riskassessment/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/riskassessment/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/riskassessment/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/riskassessment/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/riskassessment/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/riskassessment/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/riskassessment/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_riskassessment

# You can also use wget
curl -X POST /api/riskassessment \
  -H 'Content-Type: application/json-patch+json'

POST /api/riskassessment HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "ownerId": {},
  "ownerType": 0
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/riskassessment',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/riskassessment',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/riskassessment', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/riskassessment', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/riskassessment");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/riskassessment", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/riskassessment

{
  "name": "string",
  "ownerId": {},
  "ownerType": 0
}

Parameters

Name	In	Type	Required	Description
body	body	RiskAssessmentInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Score

get__api_score

# You can also use wget
curl -X GET /api/score

GET /api/score HTTP/1.1


fetch('/api/score',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/score',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/score')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/score', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/score");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/score", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/score

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_score{id}

# You can also use wget
curl -X GET /api/score/{id}

GET /api/score/{id} HTTP/1.1


fetch('/api/score/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/score/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/score/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/score/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/score/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/score/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/score/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_score{id}

# You can also use wget
curl -X PUT /api/score/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/score/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "weightWebsiteSecurity": 0.1,
  "weightNetworkSecurity": 0.1,
  "weightBrandReputationRisk": 0.1,
  "weightPhishingMalwareRisk": 0.1,
  "weightEmailSecurity": 0.1,
  "weightTR": 0.1,
  "weightTC": 0.1,
  "weightCR": 0.1,
  "templateId": {}
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/score/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/score/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/score/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/score/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/score/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/score/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/score/{id}

{
  "weightWebsiteSecurity": 0.1,
  "weightNetworkSecurity": 0.1,
  "weightBrandReputationRisk": 0.1,
  "weightPhishingMalwareRisk": 0.1,
  "weightEmailSecurity": 0.1,
  "weightTR": 0.1,
  "weightTC": 0.1,
  "weightCR": 0.1,
  "templateId": {}
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	ScoreUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_score{id}

# You can also use wget
curl -X DELETE /api/score/{id}

DELETE /api/score/{id} HTTP/1.1


fetch('/api/score/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/score/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/score/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/score/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/score/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/score/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/score/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get__api_score_instance

# You can also use wget
curl -X GET /api/score/instance

GET /api/score/instance HTTP/1.1


fetch('/api/score/instance',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/score/instance',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/score/instance')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/score/instance', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/score/instance");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/score/instance", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/score/instance

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

ScoreAssociation

get__api_scoreassociation

# You can also use wget
curl -X GET /api/scoreassociation

GET /api/scoreassociation HTTP/1.1


fetch('/api/scoreassociation',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/scoreassociation',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/scoreassociation')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/scoreassociation', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/scoreassociation");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/scoreassociation", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/scoreassociation

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_scoreassociation_owner{ownerId}type{ownerType}

# You can also use wget
curl -X GET /api/scoreassociation/owner/{ownerId}/type/{ownerType}

GET /api/scoreassociation/owner/{ownerId}/type/{ownerType} HTTP/1.1


fetch('/api/scoreassociation/owner/{ownerId}/type/{ownerType}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/scoreassociation/owner/{ownerId}/type/{ownerType}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/scoreassociation/owner/{ownerId}/type/{ownerType}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/scoreassociation/owner/{ownerId}/type/{ownerType}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/scoreassociation/owner/{ownerId}/type/{ownerType}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/scoreassociation/owner/{ownerId}/type/{ownerType}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/scoreassociation/owner/{ownerId}/type/{ownerType}

Parameters

Name	In	Type	Required	Description
ownerId	path	ObjectId	true	none
ownerType	path	OwnerType	true	none

Enumerated Values

Parameter	Value
ownerType	0
ownerType	1
ownerType	2
ownerType	3
ownerType	4
ownerType	5

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_scoreassociation{id}

# You can also use wget
curl -X GET /api/scoreassociation/{id}

GET /api/scoreassociation/{id} HTTP/1.1


fetch('/api/scoreassociation/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/scoreassociation/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/scoreassociation/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/scoreassociation/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/scoreassociation/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/scoreassociation/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/scoreassociation/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get__api_scoreassociation_gettopscores

# You can also use wget
curl -X GET /api/scoreassociation/gettopscores

GET /api/scoreassociation/gettopscores HTTP/1.1


fetch('/api/scoreassociation/gettopscores',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/scoreassociation/gettopscores',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/scoreassociation/gettopscores')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/scoreassociation/gettopscores', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/scoreassociation/gettopscores");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/scoreassociation/gettopscores", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/scoreassociation/gettopscores

Parameters

Name	In	Type	Required	Description
n	query	integer(int32)	false	none
ownerType	query	OwnerType	false	none
instanceId	query	ObjectId	false	none

Enumerated Values

Parameter	Value
ownerType	0
ownerType	1
ownerType	2
ownerType	3
ownerType	4
ownerType	5

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

ScoreCategory

get__api_scorecategory

# You can also use wget
curl -X GET /api/scorecategory

GET /api/scorecategory HTTP/1.1


fetch('/api/scorecategory',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/scorecategory',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/scorecategory')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/scorecategory', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/scorecategory");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/scorecategory", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/scorecategory

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_scorecategory

# You can also use wget
curl -X POST /api/scorecategory \
  -H 'Content-Type: application/json-patch+json'

POST /api/scorecategory HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "description": "string",
  "weight": 0.1
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/scorecategory',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/scorecategory',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/scorecategory', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/scorecategory', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/scorecategory");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/scorecategory", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/scorecategory

{
  "name": "string",
  "description": "string",
  "weight": 0.1
}

Parameters

Name	In	Type	Required	Description
body	body	ScoreCategoryInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_scorecategory{id}

# You can also use wget
curl -X GET /api/scorecategory/{id}

GET /api/scorecategory/{id} HTTP/1.1


fetch('/api/scorecategory/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/scorecategory/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/scorecategory/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/scorecategory/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/scorecategory/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/scorecategory/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/scorecategory/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_scorecategory{id}

# You can also use wget
curl -X PUT /api/scorecategory/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/scorecategory/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "description": "string",
  "weight": 0.1
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/scorecategory/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/scorecategory/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/scorecategory/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/scorecategory/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/scorecategory/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/scorecategory/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/scorecategory/{id}

{
  "name": "string",
  "description": "string",
  "weight": 0.1
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	ScoreCategoryUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_scorecategory{id}

# You can also use wget
curl -X DELETE /api/scorecategory/{id}

DELETE /api/scorecategory/{id} HTTP/1.1


fetch('/api/scorecategory/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/scorecategory/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/scorecategory/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/scorecategory/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/scorecategory/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/scorecategory/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/scorecategory/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

SubCategory

get__api_subcategory

# You can also use wget
curl -X GET /api/subcategory

GET /api/subcategory HTTP/1.1


fetch('/api/subcategory',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/subcategory',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/subcategory')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/subcategory', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/subcategory");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/subcategory", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/subcategory

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_subcategory

# You can also use wget
curl -X POST /api/subcategory \
  -H 'Content-Type: application/json-patch+json'

POST /api/subcategory HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "description": "string",
  "categoryId": {}
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/subcategory',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/subcategory',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/subcategory', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/subcategory', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/subcategory");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/subcategory", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/subcategory

{
  "name": "string",
  "description": "string",
  "categoryId": {}
}

Parameters

Name	In	Type	Required	Description
body	body	SubCategoryInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_subcategory{id}

# You can also use wget
curl -X GET /api/subcategory/{id}

GET /api/subcategory/{id} HTTP/1.1


fetch('/api/subcategory/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/subcategory/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/subcategory/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/subcategory/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/subcategory/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/subcategory/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/subcategory/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_subcategory{id}

# You can also use wget
curl -X PUT /api/subcategory/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/subcategory/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "description": "string",
  "categoryId": {}
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/subcategory/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/subcategory/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/subcategory/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/subcategory/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/subcategory/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/subcategory/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/subcategory/{id}

{
  "name": "string",
  "description": "string",
  "categoryId": {}
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	SubCategoryUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_subcategory{id}

# You can also use wget
curl -X DELETE /api/subcategory/{id}

DELETE /api/subcategory/{id} HTTP/1.1


fetch('/api/subcategory/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/subcategory/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/subcategory/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/subcategory/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/subcategory/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/subcategory/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/subcategory/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Thread

get__api_thread

# You can also use wget
curl -X GET /api/thread

GET /api/thread HTTP/1.1


fetch('/api/thread',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/thread',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/thread')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/thread', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/thread");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/thread", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/thread

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_thread

# You can also use wget
curl -X POST /api/thread \
  -H 'Content-Type: application/json-patch+json'

POST /api/thread HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "threadId": "string",
  "paused": true,
  "userId": {}
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/thread',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/thread',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/thread', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/thread', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/thread");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/thread", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/thread

{
  "threadId": "string",
  "paused": true,
  "userId": {}
}

Parameters

Name	In	Type	Required	Description
body	body	ThreadInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_thread{id}

# You can also use wget
curl -X GET /api/thread/{id}

GET /api/thread/{id} HTTP/1.1


fetch('/api/thread/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/thread/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/thread/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/thread/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/thread/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/thread/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/thread/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_thread{id}

# You can also use wget
curl -X PUT /api/thread/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/thread/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "threadId": "string",
  "paused": true,
  "userId": {}
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/thread/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/thread/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/thread/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/thread/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/thread/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/thread/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/thread/{id}

{
  "threadId": "string",
  "paused": true,
  "userId": {}
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	ThreadUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_thread{id}

# You can also use wget
curl -X DELETE /api/thread/{id}

DELETE /api/thread/{id} HTTP/1.1


fetch('/api/thread/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/thread/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/thread/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/thread/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/thread/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/thread/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/thread/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post_api_thread{id}_play

# You can also use wget
curl -X POST /api/thread/{id}/play

POST /api/thread/{id}/play HTTP/1.1


fetch('/api/thread/{id}/play',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.post '/api/thread/{id}/play',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.post('/api/thread/{id}/play')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/thread/{id}/play', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/thread/{id}/play");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/thread/{id}/play", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/thread/{id}/play

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post_api_thread{id}_pause

# You can also use wget
curl -X POST /api/thread/{id}/pause

POST /api/thread/{id}/pause HTTP/1.1


fetch('/api/thread/{id}/pause',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.post '/api/thread/{id}/pause',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.post('/api/thread/{id}/pause')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/thread/{id}/pause', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/thread/{id}/pause");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/thread/{id}/pause", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/thread/{id}/pause

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Threshold

get__api_threshold

# You can also use wget
curl -X GET /api/threshold

GET /api/threshold HTTP/1.1


fetch('/api/threshold',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/threshold',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/threshold')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/threshold', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/threshold");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/threshold", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/threshold

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_threshold

# You can also use wget
curl -X POST /api/threshold \
  -H 'Content-Type: application/json-patch+json'

POST /api/threshold HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "color": "string",
  "min": 0,
  "max": 0
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/threshold',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/threshold',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/threshold', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/threshold', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/threshold");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/threshold", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/threshold

{
  "name": "string",
  "color": "string",
  "min": 0,
  "max": 0
}

Parameters

Name	In	Type	Required	Description
body	body	ThresholdInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_threshold{id}

# You can also use wget
curl -X GET /api/threshold/{id}

GET /api/threshold/{id} HTTP/1.1


fetch('/api/threshold/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/threshold/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/threshold/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/threshold/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/threshold/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/threshold/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/threshold/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_threshold{id}

# You can also use wget
curl -X PUT /api/threshold/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/threshold/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "color": "string",
  "min": 0,
  "max": 0
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/threshold/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/threshold/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/threshold/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/threshold/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/threshold/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/threshold/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/threshold/{id}

{
  "name": "string",
  "color": "string",
  "min": 0,
  "max": 0
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	ThresholdUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_threshold{id}

# You can also use wget
curl -X DELETE /api/threshold/{id}

DELETE /api/threshold/{id} HTTP/1.1


fetch('/api/threshold/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/threshold/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/threshold/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/threshold/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/threshold/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/threshold/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/threshold/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Users

get__api_users_permissions

# You can also use wget
curl -X GET /api/users/permissions

GET /api/users/permissions HTTP/1.1


fetch('/api/users/permissions',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/users/permissions',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/users/permissions')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/users/permissions', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/users/permissions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/users/permissions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/users/permissions

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_users

# You can also use wget
curl -X POST /api/users \
  -H 'Content-Type: application/json-patch+json'

POST /api/users HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "email": "user@example.com",
  "password": "string",
  "firstName": "string",
  "lastName": "string",
  "title": "string",
  "platformAdmin": true,
  "systemUser": true,
  "groupIds": [
    {}
  ],
  "companyIds": [
    {}
  ],
  "isOffice365": true,
  "language": "string",
  "vendorAssignedId": {},
  "darkMode": true
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/users',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/users',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/users', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/users', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/users", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/users

{
  "email": "user@example.com",
  "password": "string",
  "firstName": "string",
  "lastName": "string",
  "title": "string",
  "platformAdmin": true,
  "systemUser": true,
  "groupIds": [
    {}
  ],
  "companyIds": [
    {}
  ],
  "isOffice365": true,
  "language": "string",
  "vendorAssignedId": {},
  "darkMode": true
}

Parameters

Name	In	Type	Required	Description
body	body	UserInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post_api_users_language{language}

# You can also use wget
curl -X POST /api/users/language/{language}

POST /api/users/language/{language} HTTP/1.1


fetch('/api/users/language/{language}',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.post '/api/users/language/{language}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.post('/api/users/language/{language}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/users/language/{language}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/users/language/{language}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/users/language/{language}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/users/language/{language}

Parameters

Name	In	Type	Required	Description
language	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_users{id}

# You can also use wget
curl -X PUT /api/users/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/users/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "email": "user@example.com",
  "password": "string",
  "firstName": "string",
  "lastName": "string",
  "title": "string",
  "platformAdmin": true,
  "systemUser": true,
  "groupIds": [
    {}
  ],
  "companyIds": [
    {}
  ],
  "isOffice365": true,
  "language": "string",
  "vendorAssignedId": {},
  "darkMode": true,
  "active": true,
  "lastLogin": "2019-08-24T14:15:22Z",
  "lastActive": "2019-08-24T14:15:22Z",
  "loggedMinutes": 0
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/users/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/users/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/users/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/users/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/users/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/users/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/users/{id}

{
  "email": "user@example.com",
  "password": "string",
  "firstName": "string",
  "lastName": "string",
  "title": "string",
  "platformAdmin": true,
  "systemUser": true,
  "groupIds": [
    {}
  ],
  "companyIds": [
    {}
  ],
  "isOffice365": true,
  "language": "string",
  "vendorAssignedId": {},
  "darkMode": true,
  "active": true,
  "lastLogin": "2019-08-24T14:15:22Z",
  "lastActive": "2019-08-24T14:15:22Z",
  "loggedMinutes": 0
}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none
body	body	UserUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_users_password_change

# You can also use wget
curl -X POST /api/users/password/change \
  -H 'Content-Type: application/json-patch+json'

POST /api/users/password/change HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "password": "string"
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/users/password/change',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/users/password/change',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/users/password/change', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/users/password/change', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/users/password/change");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/users/password/change", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/users/password/change

{
  "password": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	ChangePasswordModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Validity

get__api_validity

# You can also use wget
curl -X GET /api/validity

GET /api/validity HTTP/1.1


fetch('/api/validity',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/validity',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/validity')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/validity', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/validity");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/validity", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/validity

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_validity

# You can also use wget
curl -X POST /api/validity \
  -H 'Content-Type: application/json-patch+json'

POST /api/validity HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "days": 0
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/validity',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/validity',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/validity', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/validity', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/validity");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/validity", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/validity

{
  "name": "string",
  "days": 0
}

Parameters

Name	In	Type	Required	Description
body	body	ValidityInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_validity{id}

# You can also use wget
curl -X GET /api/validity/{id}

GET /api/validity/{id} HTTP/1.1


fetch('/api/validity/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/validity/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/validity/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/validity/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/validity/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/validity/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/validity/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_validity{id}

# You can also use wget
curl -X PUT /api/validity/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/validity/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "days": 0
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/validity/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/validity/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/validity/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/validity/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/validity/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/validity/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/validity/{id}

{
  "name": "string",
  "days": 0
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	ValidityUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_validity{id}

# You can also use wget
curl -X DELETE /api/validity/{id}

DELETE /api/validity/{id} HTTP/1.1


fetch('/api/validity/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/validity/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/validity/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/validity/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/validity/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/validity/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/validity/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Vendor

get__api_vendor

# You can also use wget
curl -X GET /api/vendor

GET /api/vendor HTTP/1.1


fetch('/api/vendor',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/vendor',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/vendor')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/vendor', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/vendor");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/vendor", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/vendor

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_vendor

# You can also use wget
curl -X POST /api/vendor \
  -H 'Content-Type: application/json-patch+json'

POST /api/vendor HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ],
  "companyIds": [
    {}
  ],
  "programIds": [
    {}
  ],
  "criticalities": [
    {
      "criticalityId": {},
      "ownerId": {},
      "ownerType": 0
    }
  ],
  "industry": 0,
  "revenue": 0,
  "companySize": 0,
  "email": "string",
  "city": "string",
  "countryOrRegion": "string",
  "postalCode": "string",
  "state": "string",
  "street": "string",
  "labelIds": [
    {}
  ],
  "active": true
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/vendor',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/vendor',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/vendor', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/vendor', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/vendor");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/vendor", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/vendor

{
  "name": "string",
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ],
  "companyIds": [
    {}
  ],
  "programIds": [
    {}
  ],
  "criticalities": [
    {
      "criticalityId": {},
      "ownerId": {},
      "ownerType": 0
    }
  ],
  "industry": 0,
  "revenue": 0,
  "companySize": 0,
  "email": "string",
  "city": "string",
  "countryOrRegion": "string",
  "postalCode": "string",
  "state": "string",
  "street": "string",
  "labelIds": [
    {}
  ],
  "active": true
}

Parameters

Name	In	Type	Required	Description
body	body	VendorInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_vendor_company{id}

# You can also use wget
curl -X GET /api/vendor/company/{id}

GET /api/vendor/company/{id} HTTP/1.1


fetch('/api/vendor/company/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/vendor/company/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/vendor/company/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/vendor/company/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/vendor/company/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/vendor/company/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/vendor/company/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_vendor_program{id}

# You can also use wget
curl -X GET /api/vendor/program/{id}

GET /api/vendor/program/{id} HTTP/1.1


fetch('/api/vendor/program/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/vendor/program/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/vendor/program/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/vendor/program/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/vendor/program/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/vendor/program/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/vendor/program/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_vendor{id}

# You can also use wget
curl -X GET /api/vendor/{id}

GET /api/vendor/{id} HTTP/1.1


fetch('/api/vendor/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/vendor/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/vendor/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/vendor/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/vendor/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/vendor/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/vendor/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_vendor{id}

# You can also use wget
curl -X PUT /api/vendor/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/vendor/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ],
  "companyIds": [
    {}
  ],
  "programIds": [
    {}
  ],
  "criticalities": [
    {
      "criticalityId": {},
      "ownerId": {},
      "ownerType": 0
    }
  ],
  "industry": 0,
  "revenue": 0,
  "companySize": 0,
  "email": "string",
  "city": "string",
  "countryOrRegion": "string",
  "postalCode": "string",
  "state": "string",
  "street": "string",
  "labelIds": [
    {}
  ],
  "active": true
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/vendor/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/vendor/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/vendor/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/vendor/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/vendor/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/vendor/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/vendor/{id}

{
  "name": "string",
  "customFields": [
    {
      "customFieldId": {},
      "value": "string",
      "lookupId": {}
    }
  ],
  "companyIds": [
    {}
  ],
  "programIds": [
    {}
  ],
  "criticalities": [
    {
      "criticalityId": {},
      "ownerId": {},
      "ownerType": 0
    }
  ],
  "industry": 0,
  "revenue": 0,
  "companySize": 0,
  "email": "string",
  "city": "string",
  "countryOrRegion": "string",
  "postalCode": "string",
  "state": "string",
  "street": "string",
  "labelIds": [
    {}
  ],
  "active": true
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	VendorUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_vendor{id}

# You can also use wget
curl -X DELETE /api/vendor/{id}

DELETE /api/vendor/{id} HTTP/1.1


fetch('/api/vendor/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/vendor/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/vendor/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/vendor/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/vendor/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/vendor/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/vendor/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get__api_vendor_customfield

# You can also use wget
curl -X GET /api/vendor/customfield

GET /api/vendor/customfield HTTP/1.1


fetch('/api/vendor/customfield',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/vendor/customfield',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/vendor/customfield')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/vendor/customfield', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/vendor/customfield");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/vendor/customfield", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/vendor/customfield

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post__api_vendor_customfield

# You can also use wget
curl -X POST /api/vendor/customfield \
  -H 'Content-Type: application/json-patch+json'

POST /api/vendor/customfield HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "type": 0,
  "workflowRule": true
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/vendor/customfield',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/vendor/customfield',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/vendor/customfield', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/vendor/customfield', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/vendor/customfield");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/vendor/customfield", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/vendor/customfield

{
  "name": "string",
  "type": 0,
  "workflowRule": true
}

Parameters

Name	In	Type	Required	Description
body	body	VendorCustomfieldInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_vendor_customfield{id}

# You can also use wget
curl -X GET /api/vendor/customfield/{id}

GET /api/vendor/customfield/{id} HTTP/1.1


fetch('/api/vendor/customfield/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/vendor/customfield/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/vendor/customfield/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/vendor/customfield/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/vendor/customfield/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/vendor/customfield/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/vendor/customfield/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_vendor_customfield{id}

# You can also use wget
curl -X PUT /api/vendor/customfield/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/vendor/customfield/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "name": "string",
  "type": 0,
  "workflowRule": true
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/vendor/customfield/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/vendor/customfield/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/vendor/customfield/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/vendor/customfield/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/vendor/customfield/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/vendor/customfield/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/vendor/customfield/{id}

{
  "name": "string",
  "type": 0,
  "workflowRule": true
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	VendorCustomfieldUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_vendor_customfield{id}

# You can also use wget
curl -X DELETE /api/vendor/customfield/{id}

DELETE /api/vendor/customfield/{id} HTTP/1.1


fetch('/api/vendor/customfield/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/vendor/customfield/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/vendor/customfield/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/vendor/customfield/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/vendor/customfield/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/vendor/customfield/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/vendor/customfield/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

get_api_vendor_customfield_lookup{id}

# You can also use wget
curl -X GET /api/vendor/customfield/lookup/{id}

GET /api/vendor/customfield/lookup/{id} HTTP/1.1


fetch('/api/vendor/customfield/lookup/{id}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.get '/api/vendor/customfield/lookup/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.get('/api/vendor/customfield/lookup/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/vendor/customfield/lookup/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/vendor/customfield/lookup/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/vendor/customfield/lookup/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/vendor/customfield/lookup/{id}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

put_api_vendor_customfield_lookup{id}

# You can also use wget
curl -X PUT /api/vendor/customfield/lookup/{id} \
  -H 'Content-Type: application/json-patch+json'

PUT /api/vendor/customfield/lookup/{id} HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "value": "string"
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/vendor/customfield/lookup/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.put '/api/vendor/customfield/lookup/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.put('/api/vendor/customfield/lookup/{id}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/vendor/customfield/lookup/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/vendor/customfield/lookup/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/vendor/customfield/lookup/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/vendor/customfield/lookup/{id}

{
  "value": "string"
}

Parameters

Name	In	Type	Required	Description
id	path	ObjectId	true	none
body	body	VendorCustomfieldLookupUpdateModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

delete_api_vendor_customfield_lookup{id}

# You can also use wget
curl -X DELETE /api/vendor/customfield/lookup/{id}

DELETE /api/vendor/customfield/lookup/{id} HTTP/1.1


fetch('/api/vendor/customfield/lookup/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/vendor/customfield/lookup/{id}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/vendor/customfield/lookup/{id}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/vendor/customfield/lookup/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/vendor/customfield/lookup/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/vendor/customfield/lookup/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/vendor/customfield/lookup/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

post_api_vendor_customfield{customfieldId}_lookup

# You can also use wget
curl -X POST /api/vendor/customfield/{customfieldId}/lookup \
  -H 'Content-Type: application/json-patch+json'

POST /api/vendor/customfield/{customfieldId}/lookup HTTP/1.1

Content-Type: application/json-patch+json

const inputBody = '{
  "value": "string"
}';
const headers = {
  'Content-Type':'application/json-patch+json'
};

fetch('/api/vendor/customfield/{customfieldId}/lookup',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json-patch+json'
}

result = RestClient.post '/api/vendor/customfield/{customfieldId}/lookup',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json-patch+json'
}

r = requests.post('/api/vendor/customfield/{customfieldId}/lookup', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json-patch+json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/vendor/customfield/{customfieldId}/lookup', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/vendor/customfield/{customfieldId}/lookup");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json-patch+json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/vendor/customfield/{customfieldId}/lookup", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/vendor/customfield/{customfieldId}/lookup

{
  "value": "string"
}

Parameters

Name	In	Type	Required	Description
customfieldId	path	ObjectId	true	none
body	body	VendorCustomfieldLookupInsertModel	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Schemas

AnswerInsertModel

{
  "answer": "string",
  "requiresDocument": true,
  "requiresNotes": true,
  "remediations": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ],
  "documentId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  }
}

Properties

Name	Type	Required	Restrictions	Description
answer	string¦null	false	none	none
requiresDocument	boolean	false	none	none
requiresNotes	boolean	false	none	none
remediations	[ObjectId]¦null	false	none	none
documentId	ObjectId	false	none	none

AnswerType

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	0
anonymous	1

ApiResponse

{
  "success": true,
  "error_code": 1000,
  "message": "string",
  "data": null,
  "errors": null,
  "remainingCallsInThisHour": 0
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
error_code	ErrorType	false	none	none
message	string¦null	false	none	none
data	any	false	none	none
errors	any	false	none	none
remainingCallsInThisHour	integer(int32)¦null	false	none	none

ApprovalStatus

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	0
anonymous	1
anonymous	2
anonymous	3

ApproverInsertModel

{
  "type": 0,
  "userIds": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ],
  "vendorIds": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ],
  "companyIds": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ],
  "start": "2019-08-24T14:15:22Z",
  "finish": "2019-08-24T14:15:22Z"
}

Properties

Name	Type	Required	Restrictions	Description
type	ProcessType	false	none	none
userIds	[ObjectId]¦null	false	none	none
vendorIds	[ObjectId]¦null	false	none	none
companyIds	[ObjectId]¦null	false	none	none
start	string(date-time)	false	none	none
finish	string(date-time)	false	none	none

ApproverUpdateModel

{
  "type": 0,
  "userIds": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ],
  "vendorIds": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ],
  "companyIds": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ],
  "start": "2019-08-24T14:15:22Z",
  "finish": "2019-08-24T14:15:22Z"
}

Properties

Name	Type	Required	Restrictions	Description
type	ProcessType	false	none	none
userIds	[ObjectId]¦null	false	none	none
vendorIds	[ObjectId]¦null	false	none	none
companyIds	[ObjectId]¦null	false	none	none
start	string(date-time)	false	none	none
finish	string(date-time)	false	none	none

AssessmentInsertModel

{
  "name": "string",
  "ownerId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "ownerType": 0,
  "questionnaireId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "dueDate": "2019-08-24T14:15:22Z",
  "sendInvitation": "2019-08-24T14:15:22Z"
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
ownerId	ObjectId	false	none	none
ownerType	OwnerType	false	none	none
questionnaireId	ObjectId	false	none	none
dueDate	string(date-time)¦null	false	none	none
sendInvitation	string(date-time)¦null	false	none	none

AssessmentItemUpdateModel

{
  "answer": "string",
  "fileName": "string",
  "fileUrl": "string",
  "notes": "string",
  "documentId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "documentAssociationId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "emissionDate": "2019-08-24T14:15:22Z"
}

Properties

Name	Type	Required	Restrictions	Description
answer	string¦null	false	none	none
fileName	string¦null	false	none	none
fileUrl	string¦null	false	none	none
notes	string¦null	false	none	none
documentId	ObjectId	false	none	none
documentAssociationId	ObjectId	false	none	none
emissionDate	string(date-time)¦null	false	none	none

CategoryInsertModel

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

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none

CategoryUpdateModel

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

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none

ChangePasswordModel

{
  "password": "string"
}

Properties

Name	Type	Required	Restrictions	Description
password	string	true	none	none

CompanyInsertModel

{
  "name": "string",
  "industry": 0,
  "revenue": 0,
  "companySize": 0,
  "email": "string",
  "websites": [
    "string"
  ],
  "managerId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "city": "string",
  "countryOrRegion": "string",
  "postalCode": "string",
  "state": "string",
  "street": "string",
  "fullAddress": "string",
  "customFields": [
    {
      "customFieldId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      },
      "value": "string",
      "lookupId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      }
    }
  ],
  "criticalityWeight": 0.1,
  "scoreCategoryWeights": [
    {
      "scoreCategoryId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      },
      "weight": 0.1
    }
  ],
  "parentId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "organizationCategory": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  }
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
industry	IndustryEnum	false	none	none
revenue	RevenueEnum	false	none	none
companySize	CompanySizeEnum	false	none	none
email	string¦null	false	none	none
websites	[string]¦null	false	none	none
managerId	ObjectId	false	none	none
city	string¦null	false	none	none
countryOrRegion	string¦null	false	none	none
postalCode	string¦null	false	none	none
state	string¦null	false	none	none
street	string¦null	false	none	none
fullAddress	string¦null	false	read-only	none
customFields	[CustomFieldInsertModel]¦null	false	none	none
criticalityWeight	number(double)	false	none	none
scoreCategoryWeights	[ScoreWeightModel]¦null	false	none	none
parentId	ObjectId	false	none	none
organizationCategory	ObjectId	false	none	none

CompanySizeEnum

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	0
anonymous	1
anonymous	2
anonymous	3
anonymous	4
anonymous	5
anonymous	6

CompanyUpdateModel

{
  "name": "string",
  "industry": 0,
  "revenue": 0,
  "companySize": 0,
  "email": "string",
  "websites": [
    "string"
  ],
  "managerId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "city": "string",
  "countryOrRegion": "string",
  "postalCode": "string",
  "state": "string",
  "street": "string",
  "fullAddress": "string",
  "customFields": [
    {
      "customFieldId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      },
      "value": "string",
      "lookupId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      }
    }
  ],
  "criticalityWeight": 0.1,
  "scoreCategoryWeights": [
    {
      "scoreCategoryId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      },
      "weight": 0.1
    }
  ],
  "parentId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "organizationCategory": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  }
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
industry	IndustryEnum	false	none	none
revenue	RevenueEnum	false	none	none
companySize	CompanySizeEnum	false	none	none
email	string¦null	false	none	none
websites	[string]¦null	false	none	none
managerId	ObjectId	false	none	none
city	string¦null	false	none	none
countryOrRegion	string¦null	false	none	none
postalCode	string¦null	false	none	none
state	string¦null	false	none	none
street	string¦null	false	none	none
fullAddress	string¦null	false	read-only	none
customFields	[CustomFieldInsertModel]¦null	false	none	none
criticalityWeight	number(double)	false	none	none
scoreCategoryWeights	[ScoreWeightModel]¦null	false	none	none
parentId	ObjectId	false	none	none
organizationCategory	ObjectId	false	none	none

ContractInsertModel

{
  "name": "string",
  "description": "string",
  "start": "2019-08-24T14:15:22Z",
  "finish": "2019-08-24T14:15:22Z",
  "vendorId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "companyId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "labelIds": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ],
  "contractType": 0,
  "contractTypeDetail": 0,
  "termsAndConditions": "string"
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none
start	string(date-time)	false	none	none
finish	string(date-time)	false	none	none
vendorId	ObjectId	false	none	none
companyId	ObjectId	false	none	none
labelIds	[ObjectId]¦null	false	none	none
contractType	ContractType	false	none	none
contractTypeDetail	ContractTypeDetail	false	none	none
termsAndConditions	string¦null	false	none	none

ContractType

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	0
anonymous	1

ContractTypeDetail

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	0
anonymous	1
anonymous	2
anonymous	3
anonymous	4
anonymous	5
anonymous	6
anonymous	7
anonymous	8
anonymous	9

ContractUpdateModel

{
  "name": "string",
  "description": "string",
  "start": "2019-08-24T14:15:22Z",
  "finish": "2019-08-24T14:15:22Z",
  "vendorId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "companyId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "labelIds": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ],
  "contractType": 0,
  "contractTypeDetail": 0,
  "termsAndConditions": "string"
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none
start	string(date-time)	false	none	none
finish	string(date-time)	false	none	none
vendorId	ObjectId	false	none	none
companyId	ObjectId	false	none	none
labelIds	[ObjectId]¦null	false	none	none
contractType	ContractType	false	none	none
contractTypeDetail	ContractTypeDetail	false	none	none
termsAndConditions	string¦null	false	none	none

ControlInsertModel

{
  "name": "string",
  "description": "string",
  "frameworkId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "target": 0.1,
  "disabled": true
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none
frameworkId	ObjectId	false	none	none
target	number(double)	false	none	none
disabled	boolean	false	none	none

ControlUpdateModel

{
  "name": "string",
  "description": "string",
  "frameworkId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "target": 0.1,
  "disabled": true
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none
frameworkId	ObjectId	false	none	none
target	number(double)	false	none	none
disabled	boolean	false	none	none

ConversationInsertModel

{
  "message": "string",
  "threadId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "fromAgent": true,
  "fromSender": true
}

Properties

Name	Type	Required	Restrictions	Description
message	string¦null	false	none	none
threadId	ObjectId	false	none	none
fromAgent	boolean	false	none	none
fromSender	boolean	false	none	none

ConversationMessageModel

{
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
message	string¦null	false	none	none

CriticalityInsertModel

{
  "name": "string",
  "value": 0.1,
  "disabled": true
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
value	number(double)	false	none	none
disabled	boolean	false	none	none

CriticalityUpdateModel

{
  "name": "string",
  "value": 0.1,
  "disabled": true
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
value	number(double)	false	none	none
disabled	boolean	false	none	none

CustomFieldInsertModel

{
  "customFieldId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "value": "string",
  "lookupId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  }
}

Properties

Name	Type	Required	Restrictions	Description
customFieldId	ObjectId	false	none	none
value	string¦null	false	none	none
lookupId	ObjectId	false	none	none

CustomfieldInsertModel

{
  "name": "string",
  "type": 0,
  "owners": [
    0
  ],
  "workflowRule": true
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
type	CustomfieldType	false	none	none
owners	[CustomfieldOwner]¦null	false	none	none
workflowRule	boolean	false	none	none

CustomfieldLookupInsertModel

{
  "value": "string",
  "order": 0
}

Properties

Name	Type	Required	Restrictions	Description
value	string¦null	false	none	none
order	integer(int32)	false	none	none

CustomfieldLookupUpdateModel

{
  "value": "string",
  "order": 0
}

Properties

Name	Type	Required	Restrictions	Description
value	string¦null	false	none	none
order	integer(int32)	false	none	none

CustomfieldOwner

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	0
anonymous	1
anonymous	2
anonymous	3
anonymous	4
anonymous	5
anonymous	6
anonymous	7
anonymous	8

CustomfieldType

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	0
anonymous	1

CustomfieldUpdateModel

{
  "name": "string",
  "type": 0,
  "owners": [
    0
  ],
  "workflowRule": true
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
type	CustomfieldType	false	none	none
owners	[CustomfieldOwner]¦null	false	none	none
workflowRule	boolean	false	none	none

DashboardInsertModel

{
  "type": 0,
  "default": true,
  "dashboard": 0,
  "userId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "widgets": [
    {
      "name": "string",
      "x": 0.1,
      "y": 0.1,
      "w": 0.1,
      "h": 0.1
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
type	DashboardType	false	none	none
default	boolean	false	none	none
dashboard	integer(int32)	false	none	none
userId	ObjectId	false	none	none
widgets	[DashboardWidgetInsertModel]¦null	false	none	none

DashboardType

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	0
anonymous	1

DashboardWidgetInsertModel

{
  "name": "string",
  "x": 0.1,
  "y": 0.1,
  "w": 0.1,
  "h": 0.1
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
x	number(double)	false	none	none
y	number(double)	false	none	none
w	number(double)	false	none	none
h	number(double)	false	none	none

DocumentAssociationInsertModel

{
  "name": "string",
  "description": "string",
  "documentId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "ownerId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "ownerType": 0,
  "emissionDate": "2019-08-24T14:15:22Z",
  "questionnaireId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "tierId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  }
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none
documentId	ObjectId	false	none	none
ownerId	ObjectId	false	none	none
ownerType	OwnerType	false	none	none
emissionDate	string(date-time)¦null	false	none	none
questionnaireId	ObjectId	false	none	none
tierId	ObjectId	false	none	none

DocumentAssociationUpdateModel

{
  "name": "string",
  "description": "string",
  "fileName": "string",
  "storageUrl": "string",
  "emissionDate": "2019-08-24T14:15:22Z",
  "tierId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  }
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none
fileName	string¦null	false	none	none
storageUrl	string¦null	false	none	none
emissionDate	string(date-time)¦null	false	none	none
tierId	ObjectId	false	none	none

DocumentInsertModel

{
  "name": "string",
  "description": "string",
  "validityId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "categoryId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "subCategoryId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "disabled": true,
  "mandatory": true,
  "scoreCategoryId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "weight": 0,
  "frameworkItemIds": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ],
  "customFields": [
    {
      "customFieldId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      },
      "value": "string",
      "lookupId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      }
    }
  ],
  "levelId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "companyIds": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ],
  "programIds": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ],
  "documentValue": 0.1,
  "tierChecks": [
    {
      "tierId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      },
      "checkDescriptions": [
        "string"
      ]
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none
validityId	ObjectId	false	none	none
categoryId	ObjectId	false	none	none
subCategoryId	ObjectId	false	none	none
disabled	boolean	false	none	none
mandatory	boolean	false	none	none
scoreCategoryId	ObjectId	false	none	none
weight	integer(int32)	false	none	none
frameworkItemIds	[ObjectId]¦null	false	none	none
customFields	[CustomFieldInsertModel]¦null	false	none	none
levelId	ObjectId	false	none	none
companyIds	[ObjectId]¦null	false	none	none
programIds	[ObjectId]¦null	false	none	none
documentValue	number(double)	false	none	none
tierChecks	[DocumentTierChecks]¦null	false	none	none

DocumentTierChecks

{
  "tierId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "checkDescriptions": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
tierId	ObjectId	false	none	none
checkDescriptions	[string]¦null	false	none	none

DocumentTierInsertModel

{
  "name": "string",
  "description": "string",
  "color": "string",
  "weight": 0.1
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none
color	string¦null	false	none	none
weight	number(double)	false	none	none

DocumentTierUpdateModel

{
  "name": "string",
  "description": "string",
  "color": "string",
  "weight": 0.1
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none
color	string¦null	false	none	none
weight	number(double)	false	none	none

DocumentUpdateModel

{
  "name": "string",
  "description": "string",
  "validityId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "categoryId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "subCategoryId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "disabled": true,
  "mandatory": true,
  "scoreCategoryId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "weight": 0,
  "frameworkItemIds": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ],
  "customFields": [
    {
      "customFieldId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      },
      "value": "string",
      "lookupId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      }
    }
  ],
  "levelId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "companyIds": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ],
  "programIds": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ],
  "documentValue": 0.1,
  "tierChecks": [
    {
      "tierId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      },
      "checkDescriptions": [
        "string"
      ]
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none
validityId	ObjectId	false	none	none
categoryId	ObjectId	false	none	none
subCategoryId	ObjectId	false	none	none
disabled	boolean	false	none	none
mandatory	boolean	false	none	none
scoreCategoryId	ObjectId	false	none	none
weight	integer(int32)	false	none	none
frameworkItemIds	[ObjectId]¦null	false	none	none
customFields	[CustomFieldInsertModel]¦null	false	none	none
levelId	ObjectId	false	none	none
companyIds	[ObjectId]¦null	false	none	none
programIds	[ObjectId]¦null	false	none	none
documentValue	number(double)	false	none	none
tierChecks	[DocumentTierChecks]¦null	false	none	none

DoneEnum

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	0
anonymous	1
anonymous	2
anonymous	3
anonymous	4
anonymous	5

ErrorType

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	1000
anonymous	1001
anonymous	1002
anonymous	1003
anonymous	1004
anonymous	1005
anonymous	1006
anonymous	1007
anonymous	1008
anonymous	1009
anonymous	1010
anonymous	1011
anonymous	1012
anonymous	1013
anonymous	1014
anonymous	1015
anonymous	1016
anonymous	1017
anonymous	1018

Event

{
  "rawJObject": {
    "property1": [
      []
    ],
    "property2": [
      []
    ]
  },
  "stripeResponse": {
    "statusCode": 100,
    "headers": [
      {
        "key": "string",
        "value": [
          "string"
        ]
      }
    ],
    "date": "2019-08-24T14:15:22Z",
    "idempotencyKey": "string",
    "requestId": "string",
    "content": "string"
  },
  "id": "string",
  "object": "string",
  "account": "string",
  "apiVersion": "string",
  "created": "2019-08-24T14:15:22Z",
  "data": {
    "rawJObject": {
      "property1": [
        []
      ],
      "property2": [
        []
      ]
    },
    "stripeResponse": {
      "statusCode": 100,
      "headers": [
        {
          "key": "string",
          "value": [
            "string"
          ]
        }
      ],
      "date": "2019-08-24T14:15:22Z",
      "idempotencyKey": "string",
      "requestId": "string",
      "content": "string"
    },
    "object": {
      "object": "string"
    },
    "previousAttributes": null,
    "rawObject": null
  },
  "livemode": true,
  "pendingWebhooks": 0,
  "request": {
    "rawJObject": {
      "property1": [
        []
      ],
      "property2": [
        []
      ]
    },
    "stripeResponse": {
      "statusCode": 100,
      "headers": [
        {
          "key": "string",
          "value": [
            "string"
          ]
        }
      ],
      "date": "2019-08-24T14:15:22Z",
      "idempotencyKey": "string",
      "requestId": "string",
      "content": "string"
    },
    "id": "string",
    "idempotencyKey": "string"
  },
  "type": "string"
}

Properties

Name	Type	Required	Restrictions	Description
rawJObject	object¦null	false	read-only	none
» additionalProperties	JToken	false	none	none
stripeResponse	StripeResponse	false	none	none
id	string¦null	false	none	none
object	string¦null	false	none	none
account	string¦null	false	none	none
apiVersion	string¦null	false	none	none
created	string(date-time)	false	none	none
data	EventData	false	none	none
livemode	boolean	false	none	none
pendingWebhooks	integer(int64)	false	none	none
request	EventRequest	false	none	none
type	string¦null	false	none	none

EventData

{
  "rawJObject": {
    "property1": [
      []
    ],
    "property2": [
      []
    ]
  },
  "stripeResponse": {
    "statusCode": 100,
    "headers": [
      {
        "key": "string",
        "value": [
          "string"
        ]
      }
    ],
    "date": "2019-08-24T14:15:22Z",
    "idempotencyKey": "string",
    "requestId": "string",
    "content": "string"
  },
  "object": {
    "object": "string"
  },
  "previousAttributes": null,
  "rawObject": null
}

Properties

Name	Type	Required	Restrictions	Description
rawJObject	object¦null	false	read-only	none
» additionalProperties	JToken	false	none	none
stripeResponse	StripeResponse	false	none	none
object	IHasObject	false	none	none
previousAttributes	any	false	none	none
rawObject	any	false	none	none

EventRequest

{
  "rawJObject": {
    "property1": [
      []
    ],
    "property2": [
      []
    ]
  },
  "stripeResponse": {
    "statusCode": 100,
    "headers": [
      {
        "key": "string",
        "value": [
          "string"
        ]
      }
    ],
    "date": "2019-08-24T14:15:22Z",
    "idempotencyKey": "string",
    "requestId": "string",
    "content": "string"
  },
  "id": "string",
  "idempotencyKey": "string"
}

Properties

Name	Type	Required	Restrictions	Description
rawJObject	object¦null	false	read-only	none
» additionalProperties	JToken	false	none	none
stripeResponse	StripeResponse	false	none	none
id	string¦null	false	none	none
idempotencyKey	string¦null	false	none	none

FrameworkInsertModel

{
  "name": "string",
  "description": "string",
  "disabled": true,
  "color": "string"
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none
disabled	boolean	false	none	none
color	string¦null	false	none	none

FrameworkItemInsertModel

{
  "name": "string",
  "description": "string",
  "controlId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "frameworkId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  }
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none
controlId	ObjectId	false	none	none
frameworkId	ObjectId	false	none	none

FrameworkItemUpdateModel

{
  "name": "string",
  "description": "string",
  "controlId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "frameworkId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  }
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none
controlId	ObjectId	false	none	none
frameworkId	ObjectId	false	none	none

FrameworkUpdateModel

{
  "name": "string",
  "description": "string",
  "disabled": true,
  "color": "string"
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none
disabled	boolean	false	none	none
color	string¦null	false	none	none

GroupInsertModel

{
  "name": "string",
  "description": "string",
  "permissions": {
    "property1": true,
    "property2": true
  },
  "customFields": [
    {
      "customFieldId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      },
      "value": "string",
      "lookupId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      }
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none
permissions	object¦null	false	none	none
» additionalProperties	boolean	false	none	none
customFields	[CustomFieldInsertModel]¦null	false	none	none

GroupUpdateModel

{
  "name": "string",
  "description": "string",
  "permissions": {
    "property1": true,
    "property2": true
  },
  "customFields": [
    {
      "customFieldId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      },
      "value": "string",
      "lookupId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      }
    }
  ],
  "deleted": true
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none
permissions	object¦null	false	none	none
» additionalProperties	boolean	false	none	none
customFields	[CustomFieldInsertModel]¦null	false	none	none
deleted	boolean	false	none	none

HttpStatusCode

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	100
anonymous	101
anonymous	102
anonymous	103
anonymous	200
anonymous	201
anonymous	202
anonymous	203
anonymous	204
anonymous	205
anonymous	206
anonymous	207
anonymous	208
anonymous	226
anonymous	300
anonymous	301
anonymous	302
anonymous	303
anonymous	304
anonymous	305
anonymous	306
anonymous	307
anonymous	308
anonymous	400
anonymous	401
anonymous	402
anonymous	403
anonymous	404
anonymous	405
anonymous	406
anonymous	407
anonymous	408
anonymous	409
anonymous	410
anonymous	411
anonymous	412
anonymous	413
anonymous	414
anonymous	415
anonymous	416
anonymous	417
anonymous	421
anonymous	422
anonymous	423
anonymous	424
anonymous	426
anonymous	428
anonymous	429
anonymous	431
anonymous	451
anonymous	500
anonymous	501
anonymous	502
anonymous	503
anonymous	504
anonymous	505
anonymous	506
anonymous	507
anonymous	508
anonymous	510
anonymous	511

IHasObject

{
  "object": "string"
}

Properties

Name	Type	Required	Restrictions	Description
object	string¦null	false	none	none

IncidentInsertModel

{
  "name": "string",
  "description": "string",
  "ownerId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "ownerType": 0,
  "status": 0,
  "customFields": [
    {
      "customFieldId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      },
      "value": "string",
      "lookupId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      }
    }
  ],
  "type": "string",
  "discovered": "2019-08-24T14:15:22Z",
  "startedOn": "2019-08-24T14:15:22Z",
  "systemsInvolved": "string",
  "impacts": "string",
  "measures": "string",
  "risk": "string",
  "responsibles": "string",
  "visibleToVendor": true
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none
ownerId	ObjectId	false	none	none
ownerType	OwnerType	false	none	none
status	IncidentStatus	false	none	none
customFields	[CustomFieldInsertModel]¦null	false	none	none
type	string¦null	false	none	none
discovered	string(date-time)¦null	false	none	none
startedOn	string(date-time)¦null	false	none	none
systemsInvolved	string¦null	false	none	none
impacts	string¦null	false	none	none
measures	string¦null	false	none	none
risk	string¦null	false	none	none
responsibles	string¦null	false	none	none
visibleToVendor	boolean	false	none	none

IncidentStatus

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	0
anonymous	1
anonymous	2
anonymous	3
anonymous	4
anonymous	5
anonymous	6
anonymous	7
anonymous	8
anonymous	9
anonymous	10
anonymous	11
anonymous	12
anonymous	13
anonymous	14
anonymous	15
anonymous	16

IncidentUpdateModel

{
  "name": "string",
  "description": "string",
  "ownerId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "ownerType": 0,
  "status": 0,
  "customFields": [
    {
      "customFieldId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      },
      "value": "string",
      "lookupId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      }
    }
  ],
  "type": "string",
  "discovered": "2019-08-24T14:15:22Z",
  "startedOn": "2019-08-24T14:15:22Z",
  "systemsInvolved": "string",
  "impacts": "string",
  "measures": "string",
  "risk": "string",
  "responsibles": "string",
  "visibleToVendor": true
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none
ownerId	ObjectId	false	none	none
ownerType	OwnerType	false	none	none
status	IncidentStatus	false	none	none
customFields	[CustomFieldInsertModel]¦null	false	none	none
type	string¦null	false	none	none
discovered	string(date-time)¦null	false	none	none
startedOn	string(date-time)¦null	false	none	none
systemsInvolved	string¦null	false	none	none
impacts	string¦null	false	none	none
measures	string¦null	false	none	none
risk	string¦null	false	none	none
responsibles	string¦null	false	none	none
visibleToVendor	boolean	false	none	none

IndustryEnum

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	0
anonymous	1
anonymous	2
anonymous	3
anonymous	4
anonymous	5
anonymous	6
anonymous	7
anonymous	8
anonymous	9
anonymous	10
anonymous	11
anonymous	12
anonymous	13
anonymous	14
anonymous	15
anonymous	16
anonymous	17
anonymous	18
anonymous	19
anonymous	20
anonymous	21
anonymous	22
anonymous	23

InstanceInsertModel

{
  "name": "string",
  "email": "string",
  "templateId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "licenceId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "demo": true,
  "logoUrl": "string",
  "stripeEnabled": true
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
email	string¦null	false	none	none
templateId	ObjectId	false	none	none
licenceId	ObjectId	false	none	none
demo	boolean	false	none	none
logoUrl	string¦null	false	none	none
stripeEnabled	boolean	false	none	none

InstanceUpdateModel

{
  "name": "string",
  "email": "string",
  "templateId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "licenceId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "demo": true,
  "logoUrl": "string",
  "stripeEnabled": true,
  "isTemplate": true,
  "hasValidPayment": true,
  "instanceAdmins": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
email	string¦null	false	none	none
templateId	ObjectId	false	none	none
licenceId	ObjectId	false	none	none
demo	boolean	false	none	none
logoUrl	string¦null	false	none	none
stripeEnabled	boolean	false	none	none
isTemplate	boolean	false	none	none
hasValidPayment	boolean	false	none	none
instanceAdmins	[ObjectId]¦null	false	none	none

JToken

[
  [
    []
  ]
]

Properties

Name	Type	Required	Restrictions	Description
anonymous	[JToken]	false	none	none

LabelInsertModel

{
  "name": "string",
  "textColor": "string",
  "backgroundColor": "string"
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
textColor	string¦null	false	none	none
backgroundColor	string¦null	false	none	none

LabelUpdateModel

{
  "name": "string",
  "textColor": "string",
  "backgroundColor": "string"
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
textColor	string¦null	false	none	none
backgroundColor	string¦null	false	none	none

LevelInsertModel

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

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none
level	integer(int32)	false	none	none

LevelUpdateModel

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

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none
level	integer(int32)	false	none	none

LicenceInsertModel

{
  "name": "string",
  "description": "string",
  "features": {
    "property1": true,
    "property2": true
  },
  "stripeId": "string",
  "maxVendors": 0,
  "maxEditUsers": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none
features	object¦null	false	none	none
» additionalProperties	boolean	false	none	none
stripeId	string¦null	false	none	none
maxVendors	integer(int32)	false	none	none
maxEditUsers	integer(int32)	false	none	none

LicenceUpdateModel

{
  "name": "string",
  "description": "string",
  "features": {
    "property1": true,
    "property2": true
  },
  "stripeId": "string",
  "maxVendors": 0,
  "maxEditUsers": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none
features	object¦null	false	none	none
» additionalProperties	boolean	false	none	none
stripeId	string¦null	false	none	none
maxVendors	integer(int32)	false	none	none
maxEditUsers	integer(int32)	false	none	none

MissionInsertModel

{
  "name": "string",
  "description": "string",
  "disabled": true,
  "labelIds": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none
disabled	boolean	false	none	none
labelIds	[ObjectId]¦null	false	none	none

MissionUpdateModel

{
  "name": "string",
  "description": "string",
  "disabled": true,
  "labelIds": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none
disabled	boolean	false	none	none
labelIds	[ObjectId]¦null	false	none	none

NotificationRuleInsertModel

{
  "title": "string",
  "message": "string",
  "type": 0,
  "deliverInApplication": true,
  "deliverByEmail": true
}

Properties

Name	Type	Required	Restrictions	Description
title	string¦null	false	none	none
message	string¦null	false	none	none
type	NotificationType	false	none	none
deliverInApplication	boolean	false	none	none
deliverByEmail	boolean	false	none	none

NotificationRuleUpdateModel

{
  "title": "string",
  "message": "string",
  "type": 0,
  "deliverInApplication": true,
  "deliverByEmail": true
}

Properties

Name	Type	Required	Restrictions	Description
title	string¦null	false	none	none
message	string¦null	false	none	none
type	NotificationType	false	none	none
deliverInApplication	boolean	false	none	none
deliverByEmail	boolean	false	none	none

NotificationType

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	0
anonymous	1
anonymous	2
anonymous	3
anonymous	4
anonymous	5

ObjectId

{
  "timestamp": 0,
  "machine": 0,
  "pid": 0,
  "increment": 0,
  "creationTime": "2019-08-24T14:15:22Z"
}

Properties

Name	Type	Required	Restrictions	Description
timestamp	integer(int32)	false	read-only	none
machine	integer(int32)	false	read-only	none
pid	integer(int32)	false	read-only	none
increment	integer(int32)	false	read-only	none
creationTime	string(date-time)	false	read-only	none

Office365TokenModel

{
  "token": "string",
  "instanceId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  }
}

Properties

Name	Type	Required	Restrictions	Description
token	string¦null	false	none	none
instanceId	ObjectId	false	none	none

OrganizationCategoryInsertModel

{
  "name": "string",
  "legalEntity": true
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
legalEntity	boolean	false	none	none

OrganizationCategoryUpdateModel

{
  "name": "string",
  "legalEntity": true
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
legalEntity	boolean	false	none	none

OwnerType

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	0
anonymous	1
anonymous	2
anonymous	3
anonymous	4
anonymous	5

ProcessType

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	0
anonymous	1

ProgramInsertModel

{
  "name": "string",
  "description": "string",
  "customFields": [
    {
      "customFieldId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      },
      "value": "string",
      "lookupId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      }
    }
  ],
  "criticalityWeight": 0.1,
  "scoreCategoryWeights": [
    {
      "scoreCategoryId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      },
      "weight": 0.1
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none
customFields	[CustomFieldInsertModel]¦null	false	none	none
criticalityWeight	number(double)	true	none	none
scoreCategoryWeights	[ScoreWeightModel]	true	none	none

ProgramUpdateModel

{
  "name": "string",
  "description": "string",
  "customFields": [
    {
      "customFieldId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      },
      "value": "string",
      "lookupId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      }
    }
  ],
  "criticalityWeight": 0.1,
  "scoreCategoryWeights": [
    {
      "scoreCategoryId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      },
      "weight": 0.1
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none
customFields	[CustomFieldInsertModel]¦null	false	none	none
criticalityWeight	number(double)	true	none	none
scoreCategoryWeights	[ScoreWeightModel]	true	none	none

QuestionInsertModel

{
  "name": "string",
  "question": "string",
  "questionnaireId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "answers": [
    {
      "answer": "string",
      "requiresDocument": true,
      "requiresNotes": true,
      "remediations": [
        {
          "timestamp": 0,
          "machine": 0,
          "pid": 0,
          "increment": 0,
          "creationTime": "2019-08-24T14:15:22Z"
        }
      ],
      "documentId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      }
    }
  ],
  "disabled": true,
  "answerType": 0,
  "parents": [
    {
      "uniqueId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      },
      "answers": [
        "string"
      ]
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
question	string¦null	false	none	none
questionnaireId	ObjectId	false	none	none
answers	[AnswerInsertModel]¦null	false	none	none
disabled	boolean	false	none	none
answerType	AnswerType	false	none	none
parents	[QuestionParentInsertModel]¦null	false	none	none

QuestionParentInsertModel

{
  "uniqueId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "answers": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
uniqueId	ObjectId	false	none	none
answers	[string]¦null	false	none	none

QuestionUpdateModel

{
  "name": "string",
  "question": "string",
  "questionnaireId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "answers": [
    {
      "answer": "string",
      "requiresDocument": true,
      "requiresNotes": true,
      "remediations": [
        {
          "timestamp": 0,
          "machine": 0,
          "pid": 0,
          "increment": 0,
          "creationTime": "2019-08-24T14:15:22Z"
        }
      ],
      "documentId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      }
    }
  ],
  "disabled": true,
  "answerType": 0,
  "parents": [
    {
      "uniqueId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      },
      "answers": [
        "string"
      ]
    }
  ],
  "deleted": true
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
question	string¦null	false	none	none
questionnaireId	ObjectId	false	none	none
answers	[AnswerInsertModel]¦null	false	none	none
disabled	boolean	false	none	none
answerType	AnswerType	false	none	none
parents	[QuestionParentInsertModel]¦null	false	none	none
deleted	boolean	false	none	none

QuestionnaireInsertModel

{
  "name": "string",
  "mandatory": true,
  "disabled": true,
  "isDraft": true,
  "isRecurrent": true,
  "customFields": [
    {
      "customFieldId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      },
      "value": "string",
      "lookupId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      }
    }
  ],
  "validityId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "companyIds": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ],
  "programIds": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
mandatory	boolean	false	none	none
disabled	boolean	false	none	none
isDraft	boolean	false	none	none
isRecurrent	boolean	false	none	none
customFields	[CustomFieldInsertModel]¦null	false	none	none
validityId	ObjectId	false	none	none
companyIds	[ObjectId]¦null	false	none	none
programIds	[ObjectId]¦null	false	none	none

QuestionnaireUpdateModel

{
  "name": "string",
  "mandatory": true,
  "disabled": true,
  "isDraft": true,
  "isRecurrent": true,
  "customFields": [
    {
      "customFieldId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      },
      "value": "string",
      "lookupId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      }
    }
  ],
  "validityId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "companyIds": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ],
  "programIds": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ],
  "deleted": true
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
mandatory	boolean	false	none	none
disabled	boolean	false	none	none
isDraft	boolean	false	none	none
isRecurrent	boolean	false	none	none
customFields	[CustomFieldInsertModel]¦null	false	none	none
validityId	ObjectId	false	none	none
companyIds	[ObjectId]¦null	false	none	none
programIds	[ObjectId]¦null	false	none	none
deleted	boolean	false	none	none

RefreshTokenModel

{
  "token": "string",
  "instanceId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  }
}

Properties

Name	Type	Required	Restrictions	Description
token	string	true	none	none
instanceId	ObjectId	false	none	none

RemediationAssociationUpdateModel

{
  "done": 0,
  "waiveNotes": "string",
  "fileName": "string",
  "storageUrl": "string",
  "emissionDate": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "proofName": "string",
  "proofUrl": "string",
  "notes": "string",
  "approval": 0,
  "approvalNotes": "string"
}

Properties

Name	Type	Required	Restrictions	Description
done	DoneEnum	false	none	none
waiveNotes	string¦null	false	none	none
fileName	string¦null	false	none	none
storageUrl	string¦null	false	none	none
emissionDate	string(date-time)¦null	false	none	none
dueDate	string(date-time)¦null	false	none	none
proofName	string¦null	false	none	none
proofUrl	string¦null	false	none	none
notes	string¦null	false	none	none
approval	ApprovalStatus	false	none	none
approvalNotes	string¦null	false	none	none

RemediationInsertModel

{
  "name": "string",
  "description": "string",
  "missionId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "remediationType": 0,
  "pattern": "string",
  "frameworkItemIds": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ],
  "disabled": true,
  "unsolvable": true,
  "labelIds": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ],
  "scoreCategoryId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "weight": 0,
  "customFields": [
    {
      "customFieldId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      },
      "value": "string",
      "lookupId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      }
    }
  ],
  "levelId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "requiresProof": true,
  "requiresNotes": true,
  "proofDescription": "string"
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none
missionId	ObjectId	false	none	none
remediationType	RemediationType	false	none	none
pattern	string¦null	false	none	none
frameworkItemIds	[ObjectId]¦null	false	none	none
disabled	boolean	false	none	none
unsolvable	boolean	false	none	none
labelIds	[ObjectId]¦null	false	none	none
scoreCategoryId	ObjectId	false	none	none
weight	integer(int32)	false	none	none
customFields	[CustomFieldInsertModel]¦null	false	none	none
levelId	ObjectId	false	none	none
requiresProof	boolean	false	none	none
requiresNotes	boolean	false	none	none
proofDescription	string¦null	false	none	none

RemediationType

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	0
anonymous	1
anonymous	2
anonymous	3

RemediationUpdateModel

{
  "name": "string",
  "description": "string",
  "missionId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "remediationType": 0,
  "pattern": "string",
  "frameworkItemIds": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ],
  "disabled": true,
  "unsolvable": true,
  "labelIds": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ],
  "scoreCategoryId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "weight": 0,
  "customFields": [
    {
      "customFieldId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      },
      "value": "string",
      "lookupId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      }
    }
  ],
  "levelId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "requiresProof": true,
  "requiresNotes": true,
  "proofDescription": "string"
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none
missionId	ObjectId	false	none	none
remediationType	RemediationType	false	none	none
pattern	string¦null	false	none	none
frameworkItemIds	[ObjectId]¦null	false	none	none
disabled	boolean	false	none	none
unsolvable	boolean	false	none	none
labelIds	[ObjectId]¦null	false	none	none
scoreCategoryId	ObjectId	false	none	none
weight	integer(int32)	false	none	none
customFields	[CustomFieldInsertModel]¦null	false	none	none
levelId	ObjectId	false	none	none
requiresProof	boolean	false	none	none
requiresNotes	boolean	false	none	none
proofDescription	string¦null	false	none	none

ResetPasswordModel

{
  "email": "user@example.com"
}

Properties

Name	Type	Required	Restrictions	Description
email	string(email)	true	none	none

ResultModel

{
  "id": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "target": "string",
  "crc": "string",
  "discovery": [
    "string"
  ],
  "domain": {
    "property1": [
      []
    ],
    "property2": [
      []
    ]
  },
  "start": "2019-08-24T14:15:22Z",
  "finish": "2019-08-24T14:15:22Z",
  "progress": 0,
  "status": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	ObjectId	false	none	none
target	string¦null	false	none	none
crc	string¦null	false	none	none
discovery	[string]¦null	false	none	none
domain	object¦null	false	none	none
» additionalProperties	JToken	false	none	none
start	string(date-time)	false	none	none
finish	string(date-time)¦null	false	none	none
progress	integer(int32)	false	none	none
status	string¦null	false	none	none

RevenueEnum

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	0
anonymous	1
anonymous	2
anonymous	3
anonymous	4
anonymous	5
anonymous	6
anonymous	7
anonymous	8
anonymous	9
anonymous	10

RiskAssessmentInsertModel

{
  "name": "string",
  "ownerId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "ownerType": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
ownerId	ObjectId	false	none	none
ownerType	OwnerType	false	none	none

RiskAssessmentUpdateModel

{
  "name": "string",
  "ownerId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "ownerType": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
ownerId	ObjectId	false	none	none
ownerType	OwnerType	false	none	none

ScanConfigurationInsertModel

{
  "target": "string",
  "ownerId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "ownerType": 0,
  "industry": 0,
  "customFields": [
    {
      "customFieldId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      },
      "value": "string",
      "lookupId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      }
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
target	string¦null	false	none	none
ownerId	ObjectId	false	none	none
ownerType	OwnerType	false	none	none
industry	IndustryEnum	false	none	none
customFields	[CustomFieldInsertModel]¦null	false	none	none

ScoreCategoryInsertModel

{
  "name": "string",
  "description": "string",
  "weight": 0.1
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none
weight	number(double)	false	none	none

ScoreCategoryUpdateModel

{
  "name": "string",
  "description": "string",
  "weight": 0.1
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none
weight	number(double)	false	none	none

ScoreUpdateModel

{
  "weightWebsiteSecurity": 0.1,
  "weightNetworkSecurity": 0.1,
  "weightBrandReputationRisk": 0.1,
  "weightPhishingMalwareRisk": 0.1,
  "weightEmailSecurity": 0.1,
  "weightTR": 0.1,
  "weightTC": 0.1,
  "weightCR": 0.1,
  "templateId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  }
}

Properties

Name	Type	Required	Restrictions	Description
weightWebsiteSecurity	number(double)	false	none	none
weightNetworkSecurity	number(double)	false	none	none
weightBrandReputationRisk	number(double)	false	none	none
weightPhishingMalwareRisk	number(double)	false	none	none
weightEmailSecurity	number(double)	false	none	none
weightTR	number(double)	false	none	none
weightTC	number(double)	false	none	none
weightCR	number(double)	false	none	none
templateId	ObjectId	false	none	none

ScoreWeightModel

{
  "scoreCategoryId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "weight": 0.1
}

Properties

Name	Type	Required	Restrictions	Description
scoreCategoryId	ObjectId	false	none	none
weight	number(double)	true	none	none

StringStringIEnumerableKeyValuePair

{
  "key": "string",
  "value": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
key	string¦null	false	none	none
value	[string]¦null	false	none	none

StripeResponse

{
  "statusCode": 100,
  "headers": [
    {
      "key": "string",
      "value": [
        "string"
      ]
    }
  ],
  "date": "2019-08-24T14:15:22Z",
  "idempotencyKey": "string",
  "requestId": "string",
  "content": "string"
}

Properties

Name	Type	Required	Restrictions	Description
statusCode	HttpStatusCode	false	none	none
headers	[StringStringIEnumerableKeyValuePair]¦null	false	none	none
date	string(date-time)¦null	false	read-only	none
idempotencyKey	string¦null	false	read-only	none
requestId	string¦null	false	read-only	none
content	string¦null	false	none	none

SubCategoryInsertModel

{
  "name": "string",
  "description": "string",
  "categoryId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  }
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none
categoryId	ObjectId	false	none	none

SubCategoryUpdateModel

{
  "name": "string",
  "description": "string",
  "categoryId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  }
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none
categoryId	ObjectId	false	none	none

ThreadInsertModel

{
  "threadId": "string",
  "paused": true,
  "userId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  }
}

Properties

Name	Type	Required	Restrictions	Description
threadId	string¦null	false	none	none
paused	boolean	false	none	none
userId	ObjectId	false	none	none

ThreadUpdateModel

{
  "threadId": "string",
  "paused": true,
  "userId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  }
}

Properties

Name	Type	Required	Restrictions	Description
threadId	string¦null	false	none	none
paused	boolean	false	none	none
userId	ObjectId	false	none	none

ThresholdInsertModel

{
  "name": "string",
  "color": "string",
  "min": 0,
  "max": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
color	string¦null	false	none	none
min	integer(int32)	false	none	none
max	integer(int32)	false	none	none

ThresholdUpdateModel

{
  "name": "string",
  "color": "string",
  "min": 0,
  "max": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
color	string¦null	false	none	none
min	integer(int32)	false	none	none
max	integer(int32)	false	none	none

TokenModel

{
  "email": "string",
  "password": "string",
  "instanceId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  }
}

Properties

Name	Type	Required	Restrictions	Description
email	string¦null	false	none	none
password	string	true	none	none
instanceId	ObjectId	false	none	none

UserActivateModel

{
  "name": "string",
  "password": "string"
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
password	string	true	none	none

UserInsertModel

{
  "email": "user@example.com",
  "password": "string",
  "firstName": "string",
  "lastName": "string",
  "title": "string",
  "platformAdmin": true,
  "systemUser": true,
  "groupIds": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ],
  "companyIds": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ],
  "isOffice365": true,
  "language": "string",
  "vendorAssignedId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "darkMode": true
}

Properties

Name	Type	Required	Restrictions	Description
email	string(email)	true	none	none
password	string¦null	false	none	none
firstName	string	true	none	none
lastName	string¦null	false	none	none
title	string¦null	false	none	none
platformAdmin	boolean	false	none	none
systemUser	boolean	false	none	none
groupIds	[ObjectId]¦null	false	none	none
companyIds	[ObjectId]¦null	false	none	none
isOffice365	boolean	false	none	none
language	string¦null	false	none	none
vendorAssignedId	ObjectId	false	none	none
darkMode	boolean	false	none	none

UserRegisterModel

{
  "email": "string",
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
email	string	true	none	none
name	string	true	none	none

UserUpdateModel

{
  "email": "user@example.com",
  "password": "string",
  "firstName": "string",
  "lastName": "string",
  "title": "string",
  "platformAdmin": true,
  "systemUser": true,
  "groupIds": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ],
  "companyIds": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ],
  "isOffice365": true,
  "language": "string",
  "vendorAssignedId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "darkMode": true,
  "active": true,
  "lastLogin": "2019-08-24T14:15:22Z",
  "lastActive": "2019-08-24T14:15:22Z",
  "loggedMinutes": 0
}

Properties

Name	Type	Required	Restrictions	Description
email	string(email)	true	none	none
password	string¦null	false	none	none
firstName	string	true	none	none
lastName	string¦null	false	none	none
title	string¦null	false	none	none
platformAdmin	boolean	false	none	none
systemUser	boolean	false	none	none
groupIds	[ObjectId]¦null	false	none	none
companyIds	[ObjectId]¦null	false	none	none
isOffice365	boolean	false	none	none
language	string¦null	false	none	none
vendorAssignedId	ObjectId	false	none	none
darkMode	boolean	false	none	none
active	boolean¦null	false	none	none
lastLogin	string(date-time)	false	none	none
lastActive	string(date-time)	false	none	none
loggedMinutes	integer(int32)	false	none	none

ValidityInsertModel

{
  "name": "string",
  "days": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
days	integer(int32)	false	none	none

ValidityUpdateModel

{
  "name": "string",
  "days": 0
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
days	integer(int32)	false	none	none

VendorCriticalityModel

{
  "criticalityId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "ownerId": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "2019-08-24T14:15:22Z"
  },
  "ownerType": 0
}

Properties

Name	Type	Required	Restrictions	Description
criticalityId	ObjectId	false	none	none
ownerId	ObjectId	false	none	none
ownerType	OwnerType	false	none	none

VendorCustomfieldInsertModel

{
  "name": "string",
  "type": 0,
  "workflowRule": true
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
type	CustomfieldType	false	none	none
workflowRule	boolean	false	none	none

VendorCustomfieldLookupInsertModel

{
  "value": "string"
}

Properties

Name	Type	Required	Restrictions	Description
value	string¦null	false	none	none

VendorCustomfieldLookupUpdateModel

{
  "value": "string"
}

Properties

Name	Type	Required	Restrictions	Description
value	string¦null	false	none	none

VendorCustomfieldUpdateModel

{
  "name": "string",
  "type": 0,
  "workflowRule": true
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
type	CustomfieldType	false	none	none
workflowRule	boolean	false	none	none

VendorInsertModel

{
  "name": "string",
  "customFields": [
    {
      "customFieldId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      },
      "value": "string",
      "lookupId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      }
    }
  ],
  "companyIds": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ],
  "programIds": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ],
  "criticalities": [
    {
      "criticalityId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      },
      "ownerId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      },
      "ownerType": 0
    }
  ],
  "industry": 0,
  "revenue": 0,
  "companySize": 0,
  "email": "string",
  "city": "string",
  "countryOrRegion": "string",
  "postalCode": "string",
  "state": "string",
  "street": "string",
  "labelIds": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ],
  "fullAddress": "string",
  "active": true
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
customFields	[CustomFieldInsertModel]¦null	false	none	none
companyIds	[ObjectId]¦null	false	none	none
programIds	[ObjectId]¦null	false	none	none
criticalities	[VendorCriticalityModel]¦null	false	none	none
industry	IndustryEnum	false	none	none
revenue	RevenueEnum	false	none	none
companySize	CompanySizeEnum	false	none	none
email	string¦null	false	none	none
city	string¦null	false	none	none
countryOrRegion	string¦null	false	none	none
postalCode	string¦null	false	none	none
state	string¦null	false	none	none
street	string¦null	false	none	none
labelIds	[ObjectId]¦null	false	none	none
fullAddress	string¦null	false	read-only	none
active	boolean	false	none	none

VendorUpdateModel

{
  "name": "string",
  "customFields": [
    {
      "customFieldId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      },
      "value": "string",
      "lookupId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      }
    }
  ],
  "companyIds": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ],
  "programIds": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ],
  "criticalities": [
    {
      "criticalityId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      },
      "ownerId": {
        "timestamp": 0,
        "machine": 0,
        "pid": 0,
        "increment": 0,
        "creationTime": "2019-08-24T14:15:22Z"
      },
      "ownerType": 0
    }
  ],
  "industry": 0,
  "revenue": 0,
  "companySize": 0,
  "email": "string",
  "city": "string",
  "countryOrRegion": "string",
  "postalCode": "string",
  "state": "string",
  "street": "string",
  "labelIds": [
    {
      "timestamp": 0,
      "machine": 0,
      "pid": 0,
      "increment": 0,
      "creationTime": "2019-08-24T14:15:22Z"
    }
  ],
  "fullAddress": "string",
  "active": true
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
customFields	[CustomFieldInsertModel]¦null	false	none	none
companyIds	[ObjectId]¦null	false	none	none
programIds	[ObjectId]¦null	false	none	none
criticalities	[VendorCriticalityModel]¦null	false	none	none
industry	IndustryEnum	false	none	none
revenue	RevenueEnum	false	none	none
companySize	CompanySizeEnum	false	none	none
email	string¦null	false	none	none
city	string¦null	false	none	none
countryOrRegion	string¦null	false	none	none
postalCode	string¦null	false	none	none
state	string¦null	false	none	none
street	string¦null	false	none	none
labelIds	[ObjectId]¦null	false	none	none
fullAddress	string¦null	false	read-only	none
active	boolean	false	none	none

Supplato V1

Authentication

Approver

get__api_approver

Responses

post__api_approver

Parameters

Responses

get_api_approver{id}

Parameters

Responses

put_api_approver{id}

Parameters

Responses

delete_api_approver{id}

Parameters

Responses

Assessment

get__api_assessment

Responses

post__api_assessment

Parameters

Responses

get_api_assessment_type{ownerType}history{history}

Parameters

Enumerated Values

Responses

get_api_assessment_owner{ownerId}type{ownerType}

Parameters

Enumerated Values

Responses

get_api_assessment{id}

Parameters

Responses

delete_api_assessment{id}

Parameters

Responses

get_api_assessment{id}s{secret}i{instance}

Parameters

Responses

post_api_assessment_upload{id}

Parameters

Responses

post_api_assessment_upload{id}s{secret}i{instance}

Parameters

Responses

post_api_assessment{id}_complete

Parameters

Responses

put_api_assessment_item{id}

Parameters

Responses

put_api_assessment_item{id}s{secret}i{instance}

Parameters

Responses

AuditLog

get_api_auditlog{entityId}

Parameters

Responses

Authentication

post__api_token

Parameters

Responses

post__api_refreshtoken

Parameters

Responses

post__api_office365token

Parameters

Responses

post__api_reset

Parameters

Responses

Category

get__api_category

Responses

post__api_category

Parameters

Responses

get_api_category{id}

Parameters