Dicoogle v3.0.0

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

Specification of the Dicoogle's PACS archive public API. This page describes all services available by default to the common user of the Dicoogle open-source PACS archive. In the given examples, the Demo website is used to try out the services. They may also be tried in your local deploy of Dicoogle through the base path http://localhost:8080, or another base path previously set. More information about Dicoogle configuration available in Dicoogle Learning Pack.

Finally, the Dicoogle Team encourage you to try out the official Javascript client API, dicoogle-client-js, available in GitHub and documented in detail in GitHub Pages.

Useful external links:

- Dicoogle Website

- Dicoogle GitHub

- Dicoogle Learning Pack

- Dicoogle Javadoc

- Dicoogle Javascript Client

Base URLs:

• http://demo.dicoogle.com/

• http://localhost:8080/

• http://yourdicooglehost/

Web: Support License: GNU General Public License v3.0

Authentication

• oAuth2 authentication.

  • Flow: implicit
  • Authorization URL = yourdicoogledomain/login

Scope	Scope Description
user	perform operations as a regular user
admin	perform administration operations

Authentication

Authentication related services

login

Code samples

# You can also use wget
curl -X POST http://demo.dicoogle.com/login?username=string&password=string \
  -H 'Accept: application/json'

POST http://demo.dicoogle.com/login?username=string&password=string HTTP/1.1
Host: demo.dicoogle.com
Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'http://demo.dicoogle.com/login',
  method: 'post',
  data: '?username=string&password=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'

};

fetch('http://demo.dicoogle.com/login?username=string&password=string',
{
  method: 'POST',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://demo.dicoogle.com/login',
  params: {
  'username' => 'string',
'password' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://demo.dicoogle.com/login', params={
  'username': 'string',  'password': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/login?username=string&password=string");
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{
        "Accept": []string{"application/json"},
        
    }

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

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

 'application/json',
    
    );

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('POST','http://demo.dicoogle.com/login', 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());
 }

 // ...

POST /login

Log in to Dicoogle using the given credentials

Parameters

Name	In	Type	Required	Description
username	query	string	true	The unique user name for the client
password	query	string	true	The user's password for authentication

Example responses

200 Response

{
  "success": true
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	Success
401	Unauthorized	Wrong login credentials	None

status

Code samples

# You can also use wget
curl -X GET http://demo.dicoogle.com/login \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET http://demo.dicoogle.com/login HTTP/1.1
Host: demo.dicoogle.com
Accept: application/json

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'http://demo.dicoogle.com/login',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('http://demo.dicoogle.com/login',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'http://demo.dicoogle.com/login',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('http://demo.dicoogle.com/login', params={

}, headers = headers)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/login");
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() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

 'application/json',
    'Authorization' => 'Bearer {access-token}',
    
    );

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','http://demo.dicoogle.com/login', 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());
 }

 // ...

GET /login

Check if logged in

Example responses

200 Response

{
  "user": "string",
  "admin": true,
  "roles": [
    "string"
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	FullUser

logout

Code samples

# You can also use wget
curl -X POST http://demo.dicoogle.com/logout \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST http://demo.dicoogle.com/logout HTTP/1.1
Host: demo.dicoogle.com
Accept: application/json

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'http://demo.dicoogle.com/logout',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('http://demo.dicoogle.com/logout',
{
  method: 'POST',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'http://demo.dicoogle.com/logout',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('http://demo.dicoogle.com/logout', params={

}, headers = headers)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/logout");
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{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

 'application/json',
    'Authorization' => 'Bearer {access-token}',
    
    );

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('POST','http://demo.dicoogle.com/logout', 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());
 }

 // ...

POST /logout

Log out from the server

Example responses

200 Response

{
  "success": true
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	Success

User

User related services

createUser

Code samples

# You can also use wget
curl -X POST http://demo.dicoogle.com/user?username=string&password=string&admin=string \
  -H 'Accept: application/json'

POST http://demo.dicoogle.com/user?username=string&password=string&admin=string HTTP/1.1
Host: demo.dicoogle.com
Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'http://demo.dicoogle.com/user',
  method: 'post',
  data: '?username=string&password=string&admin=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'

};

fetch('http://demo.dicoogle.com/user?username=string&password=string&admin=string',
{
  method: 'POST',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://demo.dicoogle.com/user',
  params: {
  'username' => 'string',
'password' => 'string',
'admin' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://demo.dicoogle.com/user', params={
  'username': 'string',  'password': 'string',  'admin': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/user?username=string&password=string&admin=string");
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{
        "Accept": []string{"application/json"},
        
    }

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

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

 'application/json',
    
    );

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('POST','http://demo.dicoogle.com/user', 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());
 }

 // ...

POST /user

Create a user in the system

Parameters

Name	In	Type	Required	Description
username	query	string	true	The unique user name for the client
password	query	string	true	The user's password for authentication
admin	query	string	true	Whether the user has administrator privileges or not

Example responses

200 Response

{
  "success": true
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	Success

getUsers

Code samples

# You can also use wget
curl -X GET http://demo.dicoogle.com/user \
  -H 'Accept: application/json'

GET http://demo.dicoogle.com/user HTTP/1.1
Host: demo.dicoogle.com
Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'http://demo.dicoogle.com/user',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'

};

fetch('http://demo.dicoogle.com/user',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://demo.dicoogle.com/user',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://demo.dicoogle.com/user', params={

}, headers = headers)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/user");
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() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        
    }

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

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

 'application/json',
    
    );

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','http://demo.dicoogle.com/user', 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());
 }

 // ...

GET /user

Get all the users in the system

Example responses

200 Response

[
  {
    "username": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	Users

deleteUser

Code samples

# You can also use wget
curl -X DELETE http://demo.dicoogle.com/user/{usename} \
  -H 'Accept: application/json'

DELETE http://demo.dicoogle.com/user/{usename} HTTP/1.1
Host: demo.dicoogle.com
Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'http://demo.dicoogle.com/user/{usename}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'

};

fetch('http://demo.dicoogle.com/user/{usename}',
{
  method: 'DELETE',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.delete 'http://demo.dicoogle.com/user/{usename}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('http://demo.dicoogle.com/user/{usename}', params={

}, headers = headers)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/user/{usename}");
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() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://demo.dicoogle.com/user/{usename}", data)
    req.Header = headers

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

 'application/json',
    
    );

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('DELETE','http://demo.dicoogle.com/user/{usename}', 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());
 }

 // ...

DELETE /user/{usename}

Remove a user from the system

Parameters

Name	In	Type	Required	Description
username	path	string	true	The unique username

Example responses

200 Response

{
  "success": true
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	Success

Search

Search related services

search

Code samples

# You can also use wget
curl -X GET http://demo.dicoogle.com/search?query=string \
  -H 'Accept: application/json'

GET http://demo.dicoogle.com/search?query=string HTTP/1.1
Host: demo.dicoogle.com
Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'http://demo.dicoogle.com/search',
  method: 'get',
  data: '?query=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'

};

fetch('http://demo.dicoogle.com/search?query=string',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://demo.dicoogle.com/search',
  params: {
  'query' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://demo.dicoogle.com/search', params={
  'query': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/search?query=string");
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() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        
    }

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

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

 'application/json',
    
    );

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','http://demo.dicoogle.com/search', 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());
 }

 // ...

GET /search

Perform a text query

Parameters

Name	In	Type	Required	Description
query	query	string	true	the text query
provider	query	string	false	a list of provider plugins
field	query	string	false	none

Example responses

200 Response

{
  "results": [
    {
      "uri": "file:/1bf65303-88a6-4c7e-bbd3-95cd3d2901a7",
      "fields": {
        "PatientID": "9850721e-27bf-4e8c-a9cd-00680c3c83d7",
        "SeriesDate": "20150120",
        "StudyDate": "20150120",
        "PatientName": "e8344a6c-3385-497f-bf47-01a89914d572",
        "StudyInstanceUID": "0c69d902-6cb1-4df5-8d1b-c17051d96c9a",
        "SOPInstanceUID": "bd6ac908-a061-4ed4-9083-5a5dfb12e7f4",
        "Modality": "CT",
        "SeriesInstanceUID": "fd76f30b-2ee2-46ad-ac40-856266e6a396"
      }
    }
  ],
  "elapsedTime": 559,
  "numResults": 5
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	Results
400	Bad Request	Invalid supplied parameters	None

searchDIM

Code samples

# You can also use wget
curl -X GET http://demo.dicoogle.com/searchDIM?query=string \
  -H 'Accept: application/json'

GET http://demo.dicoogle.com/searchDIM?query=string HTTP/1.1
Host: demo.dicoogle.com
Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'http://demo.dicoogle.com/searchDIM',
  method: 'get',
  data: '?query=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'

};

fetch('http://demo.dicoogle.com/searchDIM?query=string',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://demo.dicoogle.com/searchDIM',
  params: {
  'query' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://demo.dicoogle.com/searchDIM', params={
  'query': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/searchDIM?query=string");
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() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        
    }

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

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

 'application/json',
    
    );

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','http://demo.dicoogle.com/searchDIM', 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());
 }

 // ...

GET /searchDIM

Perform a text query with DIM-formatted outcome

Parameters

Name	In	Type	Required	Description
query	query	string	true	the text query
provider	query	string	false	a list of provider plugins
field	query	string	false	none

Example responses

200 Response

{
  "results": [
    {}
  ],
  "elapsedTime": 5,
  "numResults": 5
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	DIMResults
400	Bad Request	Invalid supplied parameters	None

Index

Index related services

getIndexPlugins

Code samples

# You can also use wget
curl -X GET http://demo.dicoogle.com/providers \
  -H 'Accept: application/json'

GET http://demo.dicoogle.com/providers HTTP/1.1
Host: demo.dicoogle.com
Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'http://demo.dicoogle.com/providers',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'

};

fetch('http://demo.dicoogle.com/providers',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://demo.dicoogle.com/providers',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://demo.dicoogle.com/providers', params={

}, headers = headers)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/providers");
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() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        
    }

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

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

 'application/json',
    
    );

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','http://demo.dicoogle.com/providers', 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());
 }

 // ...

GET /providers

Retrieve a list of index provider plugins

Example responses

200 Response

[
  "string"
]

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	ListOfStrings

addIndexTaskURI

Code samples

# You can also use wget
curl -X POST http://demo.dicoogle.com/management/tasks/index?uri=string \
  -H 'Accept: application/json'

POST http://demo.dicoogle.com/management/tasks/index?uri=string HTTP/1.1
Host: demo.dicoogle.com
Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'http://demo.dicoogle.com/management/tasks/index',
  method: 'post',
  data: '?uri=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'

};

fetch('http://demo.dicoogle.com/management/tasks/index?uri=string',
{
  method: 'POST',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://demo.dicoogle.com/management/tasks/index',
  params: {
  'uri' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://demo.dicoogle.com/management/tasks/index', params={
  'uri': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/management/tasks/index?uri=string");
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{
        "Accept": []string{"application/json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://demo.dicoogle.com/management/tasks/index", data)
    req.Header = headers

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

 'application/json',
    
    );

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('POST','http://demo.dicoogle.com/management/tasks/index', 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());
 }

 // ...

POST /management/tasks/index

Request a new indexing task over a given URI (recursively)

Parameters

Name	In	Type	Required	Description
uri	query	string	true	a URI or array of URIs representing the root resource of the files to be indexed
plugin	query	string	false	a list of provider plugins

Example responses

200 Response

{
  "tasks": [
    {
      "canceled": false,
      "done": false,
      "name": "[lucene]index storage/",
      "progress": 0,
      "uid": "5c5f36ec-a946-49db-b903-e815e2f08dee"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	Inline
400	Bad Request	Invalid supplied parameters	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» tasks	[Task]	false	none	none
»» canceled	boolean	false	none	none
»» done	boolean	false	none	none
»» name	string	false	none	none
»» progress	integer	false	none	none
»» uid	string	false	none	none

addUnindexTaskList

Code samples

# You can also use wget
curl -X POST http://demo.dicoogle.com/management/tasks/unindex

POST http://demo.dicoogle.com/management/tasks/unindex HTTP/1.1
Host: demo.dicoogle.com

$.ajax({
  url: 'http://demo.dicoogle.com/management/tasks/unindex',
  method: 'post',

  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

fetch('http://demo.dicoogle.com/management/tasks/unindex',
{
  method: 'POST'

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

require 'rest-client'
require 'json'

result = RestClient.post 'http://demo.dicoogle.com/management/tasks/unindex',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.post('http://demo.dicoogle.com/management/tasks/unindex', params={

)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/management/tasks/unindex");
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", "http://demo.dicoogle.com/management/tasks/unindex", data)
    req.Header = headers

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

request('POST','http://demo.dicoogle.com/management/tasks/unindex', 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());
 }

 // ...

POST /management/tasks/unindex

Request that a list of entries is unindexed in the specified indexers, or all of them if left unspecified. Exactly one of the fields uri, SOPInstanceUID and SeriesInstanceUID must be given.

Parameters

Name	In	Type	Required	Description
uri	query	string	false	a URI or array of URIs representing the root resource of the files to be unindexed
SOPInstanceUID	query	string	false	a UID or list of UIDs representing the DICOM instances to be unindexed
SeriesInstanceUID	query	string	false	a UID or list of UIDs representing the DICOM series to be unindexed
StudyInstanceUID	query	string	false	a UID or list of UIDs representing the DICOM studies to be unindexed
provider	query	string	false	a list of provider plugins

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	None
400	Bad Request	Invalid supplied parameters	None

addUnindexTaskURI

Code samples

# You can also use wget
curl -X POST http://demo.dicoogle.com/management/tasks/remove?uri=string

POST http://demo.dicoogle.com/management/tasks/remove?uri=string HTTP/1.1
Host: demo.dicoogle.com

$.ajax({
  url: 'http://demo.dicoogle.com/management/tasks/remove',
  method: 'post',
  data: '?uri=string',

  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

fetch('http://demo.dicoogle.com/management/tasks/remove?uri=string',
{
  method: 'POST'

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

require 'rest-client'
require 'json'

result = RestClient.post 'http://demo.dicoogle.com/management/tasks/remove',
  params: {
  'uri' => 'string'
}

p JSON.parse(result)

import requests

r = requests.post('http://demo.dicoogle.com/management/tasks/remove', params={
  'uri': 'string'
)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/management/tasks/remove?uri=string");
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", "http://demo.dicoogle.com/management/tasks/remove", data)
    req.Header = headers

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

request('POST','http://demo.dicoogle.com/management/tasks/remove', 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());
 }

 // ...

POST /management/tasks/remove

Request that the file at the given URI is permanently removed

Parameters

Name	In	Type	Required	Description
uri	query	string	true	a URI or array of URIs representing the root resource of the files to be indexed

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	None
400	Bad Request	Invalid supplied parameters	None

getIndexTasks

Code samples

# You can also use wget
curl -X GET http://demo.dicoogle.com/index/task \
  -H 'Accept: application/json'

GET http://demo.dicoogle.com/index/task HTTP/1.1
Host: demo.dicoogle.com
Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'http://demo.dicoogle.com/index/task',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'

};

fetch('http://demo.dicoogle.com/index/task',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://demo.dicoogle.com/index/task',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://demo.dicoogle.com/index/task', params={

}, headers = headers)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/index/task");
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() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://demo.dicoogle.com/index/task", data)
    req.Header = headers

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

 'application/json',
    
    );

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','http://demo.dicoogle.com/index/task', 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());
 }

 // ...

GET /index/task

Get indexing tasks

Example responses

200 Response

{
  "results": [
    {
      "uid": "92b099fe-eea1-49bd-9a84-b3d0d6135c37",
      "taskName": "[lucene]index",
      "taskProgress": 0.1,
      "complete": false,
      "elapsedTime": 9,
      "nIndexed": 3,
      "nErrors": 0
    }
  ],
  "count": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	TaskResults
400	Bad Request	Invalid supplied parameters	None

setIndexTask

Code samples

# You can also use wget
curl -X POST http://demo.dicoogle.com/index/task?type=string&uid=string

POST http://demo.dicoogle.com/index/task?type=string&uid=string HTTP/1.1
Host: demo.dicoogle.com

$.ajax({
  url: 'http://demo.dicoogle.com/index/task',
  method: 'post',
  data: '?type=string&uid=string',

  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

fetch('http://demo.dicoogle.com/index/task?type=string&uid=string',
{
  method: 'POST'

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

require 'rest-client'
require 'json'

result = RestClient.post 'http://demo.dicoogle.com/index/task',
  params: {
  'type' => 'string',
'uid' => 'string'
}

p JSON.parse(result)

import requests

r = requests.post('http://demo.dicoogle.com/index/task', params={
  'type': 'string',  'uid': 'string'
)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/index/task?type=string&uid=string");
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", "http://demo.dicoogle.com/index/task", data)
    req.Header = headers

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

request('POST','http://demo.dicoogle.com/index/task', 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());
 }

 // ...

POST /index/task

Change an indexing task

Parameters

Name	In	Type	Required	Description
type	query	string	true	the type of action to change the task
uid	query	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	None
400	Bad Request	Invalid supplied parameters	None

Management

Management related services

getWatchingDir

Code samples

# You can also use wget
curl -X GET http://demo.dicoogle.com/management/settings/index/path \
  -H 'Accept: text/plain'

GET http://demo.dicoogle.com/management/settings/index/path HTTP/1.1
Host: demo.dicoogle.com
Accept: text/plain

var headers = {
  'Accept':'text/plain'

};

$.ajax({
  url: 'http://demo.dicoogle.com/management/settings/index/path',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'text/plain'

};

fetch('http://demo.dicoogle.com/management/settings/index/path',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/plain'
}

result = RestClient.get 'http://demo.dicoogle.com/management/settings/index/path',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'text/plain'
}

r = requests.get('http://demo.dicoogle.com/management/settings/index/path', params={

}, headers = headers)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/management/settings/index/path");
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() {

    headers := map[string][]string{
        "Accept": []string{"text/plain"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://demo.dicoogle.com/management/settings/index/path", data)
    req.Header = headers

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

 'text/plain',
    
    );

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','http://demo.dicoogle.com/management/settings/index/path', 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());
 }

 // ...

GET /management/settings/index/path

Get the current Dicoogle watcher directory

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	string

setWatchDir

Code samples

# You can also use wget
curl -X POST http://demo.dicoogle.com/management/settings/index/path?path=string

POST http://demo.dicoogle.com/management/settings/index/path?path=string HTTP/1.1
Host: demo.dicoogle.com

$.ajax({
  url: 'http://demo.dicoogle.com/management/settings/index/path',
  method: 'post',
  data: '?path=string',

  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

fetch('http://demo.dicoogle.com/management/settings/index/path?path=string',
{
  method: 'POST'

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

require 'rest-client'
require 'json'

result = RestClient.post 'http://demo.dicoogle.com/management/settings/index/path',
  params: {
  'path' => 'string'
}

p JSON.parse(result)

import requests

r = requests.post('http://demo.dicoogle.com/management/settings/index/path', params={
  'path': 'string'
)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/management/settings/index/path?path=string");
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", "http://demo.dicoogle.com/management/settings/index/path", data)
    req.Header = headers

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

request('POST','http://demo.dicoogle.com/management/settings/index/path', 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());
 }

 // ...

POST /management/settings/index/path

Set the current Dicoogle watcher directory

Parameters

Name	In	Type	Required	Description
path	query	string	true	the Dicoogle watcher directory

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	None
400	Bad Request	Invalid supplied parameters	None

getIndexEffort

Code samples

# You can also use wget
curl -X GET http://demo.dicoogle.com/management/settings/index/effort \
  -H 'Accept: text/plain'

GET http://demo.dicoogle.com/management/settings/index/effort HTTP/1.1
Host: demo.dicoogle.com
Accept: text/plain

var headers = {
  'Accept':'text/plain'

};

$.ajax({
  url: 'http://demo.dicoogle.com/management/settings/index/effort',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'text/plain'

};

fetch('http://demo.dicoogle.com/management/settings/index/effort',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/plain'
}

result = RestClient.get 'http://demo.dicoogle.com/management/settings/index/effort',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'text/plain'
}

r = requests.get('http://demo.dicoogle.com/management/settings/index/effort', params={

}, headers = headers)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/management/settings/index/effort");
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() {

    headers := map[string][]string{
        "Accept": []string{"text/plain"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://demo.dicoogle.com/management/settings/index/effort", data)
    req.Header = headers

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

 'text/plain',
    
    );

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','http://demo.dicoogle.com/management/settings/index/effort', 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());
 }

 // ...

GET /management/settings/index/effort

Get the indexation effort

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	string

setIndexEffort

Code samples

# You can also use wget
curl -X POST http://demo.dicoogle.com/management/settings/index/effort?effort=0

POST http://demo.dicoogle.com/management/settings/index/effort?effort=0 HTTP/1.1
Host: demo.dicoogle.com

$.ajax({
  url: 'http://demo.dicoogle.com/management/settings/index/effort',
  method: 'post',
  data: '?effort=0',

  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

fetch('http://demo.dicoogle.com/management/settings/index/effort?effort=0',
{
  method: 'POST'

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

require 'rest-client'
require 'json'

result = RestClient.post 'http://demo.dicoogle.com/management/settings/index/effort',
  params: {
  'effort' => 'integer'
}

p JSON.parse(result)

import requests

r = requests.post('http://demo.dicoogle.com/management/settings/index/effort', params={
  'effort': '0'
)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/management/settings/index/effort?effort=0");
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", "http://demo.dicoogle.com/management/settings/index/effort", data)
    req.Header = headers

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

request('POST','http://demo.dicoogle.com/management/settings/index/effort', 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());
 }

 // ...

POST /management/settings/index/effort

Set the indexation effort

Parameters

Name	In	Type	Required	Description
effort	query	integer	true	the indexation effort

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	None
400	Bad Request	Invalid supplied parameters	None

getThumbnailIndex

Code samples

# You can also use wget
curl -X GET http://demo.dicoogle.com/management/settings/index/thumbnail \
  -H 'Accept: text/plain'

GET http://demo.dicoogle.com/management/settings/index/thumbnail HTTP/1.1
Host: demo.dicoogle.com
Accept: text/plain

var headers = {
  'Accept':'text/plain'

};

$.ajax({
  url: 'http://demo.dicoogle.com/management/settings/index/thumbnail',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'text/plain'

};

fetch('http://demo.dicoogle.com/management/settings/index/thumbnail',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/plain'
}

result = RestClient.get 'http://demo.dicoogle.com/management/settings/index/thumbnail',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'text/plain'
}

r = requests.get('http://demo.dicoogle.com/management/settings/index/thumbnail', params={

}, headers = headers)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/management/settings/index/thumbnail");
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() {

    headers := map[string][]string{
        "Accept": []string{"text/plain"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://demo.dicoogle.com/management/settings/index/thumbnail", data)
    req.Header = headers

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

 'text/plain',
    
    );

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','http://demo.dicoogle.com/management/settings/index/thumbnail', 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());
 }

 // ...

GET /management/settings/index/thumbnail

Check thumbnail indexation

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	string

setThumbnailIndex

Code samples

# You can also use wget
curl -X POST http://demo.dicoogle.com/management/settings/index/thumbnail?saveThumbnail=true

POST http://demo.dicoogle.com/management/settings/index/thumbnail?saveThumbnail=true HTTP/1.1
Host: demo.dicoogle.com

$.ajax({
  url: 'http://demo.dicoogle.com/management/settings/index/thumbnail',
  method: 'post',
  data: '?saveThumbnail=true',

  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

fetch('http://demo.dicoogle.com/management/settings/index/thumbnail?saveThumbnail=true',
{
  method: 'POST'

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

require 'rest-client'
require 'json'

result = RestClient.post 'http://demo.dicoogle.com/management/settings/index/thumbnail',
  params: {
  'saveThumbnail' => 'boolean'
}

p JSON.parse(result)

import requests

r = requests.post('http://demo.dicoogle.com/management/settings/index/thumbnail', params={
  'saveThumbnail': 'true'
)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/management/settings/index/thumbnail?saveThumbnail=true");
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", "http://demo.dicoogle.com/management/settings/index/thumbnail", data)
    req.Header = headers

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

request('POST','http://demo.dicoogle.com/management/settings/index/thumbnail', 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());
 }

 // ...

POST /management/settings/index/thumbnail

Set thumbnail indexation

Parameters

Name	In	Type	Required	Description
saveThumbnail	query	boolean	true	save thumbnail

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	None
400	Bad Request	Invalid supplied parameters	None

getWatchDirEnabled

Code samples

# You can also use wget
curl -X GET http://demo.dicoogle.com/management/settings/index/watcher \
  -H 'Accept: text/plain'

GET http://demo.dicoogle.com/management/settings/index/watcher HTTP/1.1
Host: demo.dicoogle.com
Accept: text/plain

var headers = {
  'Accept':'text/plain'

};

$.ajax({
  url: 'http://demo.dicoogle.com/management/settings/index/watcher',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'text/plain'

};

fetch('http://demo.dicoogle.com/management/settings/index/watcher',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/plain'
}

result = RestClient.get 'http://demo.dicoogle.com/management/settings/index/watcher',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'text/plain'
}

r = requests.get('http://demo.dicoogle.com/management/settings/index/watcher', params={

}, headers = headers)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/management/settings/index/watcher");
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() {

    headers := map[string][]string{
        "Accept": []string{"text/plain"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://demo.dicoogle.com/management/settings/index/watcher", data)
    req.Header = headers

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

 'text/plain',
    
    );

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','http://demo.dicoogle.com/management/settings/index/watcher', 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());
 }

 // ...

GET /management/settings/index/watcher

Check if Dicoogle watcher directory is enabled

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	string

setWatchDirEnabled

Code samples

# You can also use wget
curl -X POST http://demo.dicoogle.com/management/settings/index/watcher?watcher=true

POST http://demo.dicoogle.com/management/settings/index/watcher?watcher=true HTTP/1.1
Host: demo.dicoogle.com

$.ajax({
  url: 'http://demo.dicoogle.com/management/settings/index/watcher',
  method: 'post',
  data: '?watcher=true',

  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

fetch('http://demo.dicoogle.com/management/settings/index/watcher?watcher=true',
{
  method: 'POST'

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

require 'rest-client'
require 'json'

result = RestClient.post 'http://demo.dicoogle.com/management/settings/index/watcher',
  params: {
  'watcher' => 'boolean'
}

p JSON.parse(result)

import requests

r = requests.post('http://demo.dicoogle.com/management/settings/index/watcher', params={
  'watcher': 'true'
)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/management/settings/index/watcher?watcher=true");
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", "http://demo.dicoogle.com/management/settings/index/watcher", data)
    req.Header = headers

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

request('POST','http://demo.dicoogle.com/management/settings/index/watcher', 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());
 }

 // ...

POST /management/settings/index/watcher

Set if the watcher directory is enabled

Parameters

Name	In	Type	Required	Description
watcher	query	boolean	true	enable the Dicoogle watcher directory

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	None
400	Bad Request	Invalid supplied parameters	None

getThumbnailSize

Code samples

# You can also use wget
curl -X GET http://demo.dicoogle.com/management/settings/index/thumbnail/size \
  -H 'Accept: text/plain'

GET http://demo.dicoogle.com/management/settings/index/thumbnail/size HTTP/1.1
Host: demo.dicoogle.com
Accept: text/plain

var headers = {
  'Accept':'text/plain'

};

$.ajax({
  url: 'http://demo.dicoogle.com/management/settings/index/thumbnail/size',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'text/plain'

};

fetch('http://demo.dicoogle.com/management/settings/index/thumbnail/size',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/plain'
}

result = RestClient.get 'http://demo.dicoogle.com/management/settings/index/thumbnail/size',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'text/plain'
}

r = requests.get('http://demo.dicoogle.com/management/settings/index/thumbnail/size', params={

}, headers = headers)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/management/settings/index/thumbnail/size");
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() {

    headers := map[string][]string{
        "Accept": []string{"text/plain"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://demo.dicoogle.com/management/settings/index/thumbnail/size", data)
    req.Header = headers

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

 'text/plain',
    
    );

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','http://demo.dicoogle.com/management/settings/index/thumbnail/size', 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());
 }

 // ...

GET /management/settings/index/thumbnail/size

Get the thumbnail size

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	string

setThumbnailSize

Code samples

# You can also use wget
curl -X POST http://demo.dicoogle.com/management/settings/index/thumbnail/size?thumbnailSize=0

POST http://demo.dicoogle.com/management/settings/index/thumbnail/size?thumbnailSize=0 HTTP/1.1
Host: demo.dicoogle.com

$.ajax({
  url: 'http://demo.dicoogle.com/management/settings/index/thumbnail/size',
  method: 'post',
  data: '?thumbnailSize=0',

  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

fetch('http://demo.dicoogle.com/management/settings/index/thumbnail/size?thumbnailSize=0',
{
  method: 'POST'

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

require 'rest-client'
require 'json'

result = RestClient.post 'http://demo.dicoogle.com/management/settings/index/thumbnail/size',
  params: {
  'thumbnailSize' => 'integer'
}

p JSON.parse(result)

import requests

r = requests.post('http://demo.dicoogle.com/management/settings/index/thumbnail/size', params={
  'thumbnailSize': '0'
)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/management/settings/index/thumbnail/size?thumbnailSize=0");
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", "http://demo.dicoogle.com/management/settings/index/thumbnail/size", data)
    req.Header = headers

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

request('POST','http://demo.dicoogle.com/management/settings/index/thumbnail/size', 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());
 }

 // ...

POST /management/settings/index/thumbnail/size

Set the thumbnail size

Parameters

Name	In	Type	Required	Description
thumbnailSize	query	integer	true	the thumbnail size

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	None
400	Bad Request	Invalid supplied parameters	None

getIndexSettings

Code samples

# You can also use wget
curl -X GET http://demo.dicoogle.com/management/settings/index \
  -H 'Accept: application/json'

GET http://demo.dicoogle.com/management/settings/index HTTP/1.1
Host: demo.dicoogle.com
Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'http://demo.dicoogle.com/management/settings/index',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'

};

fetch('http://demo.dicoogle.com/management/settings/index',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://demo.dicoogle.com/management/settings/index',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://demo.dicoogle.com/management/settings/index', params={

}, headers = headers)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/management/settings/index");
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() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://demo.dicoogle.com/management/settings/index", data)
    req.Header = headers

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

 'application/json',
    
    );

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','http://demo.dicoogle.com/management/settings/index', 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());
 }

 // ...

GET /management/settings/index

Get all of the current Indexer settings

Example responses

200 Response

{
  "path": "/tmp",
  "zip": false,
  "effort": false,
  "thumbnail": true,
  "thumbnailSize": 64,
  "watcher": false
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	IndexSettings

setIndexSettings

Code samples

# You can also use wget
curl -X POST http://demo.dicoogle.com/management/settings/index?path=string&watcher=true&zip=true&saveThumbnail=true&effort=0&thumbnailSize=0

POST http://demo.dicoogle.com/management/settings/index?path=string&watcher=true&zip=true&saveThumbnail=true&effort=0&thumbnailSize=0 HTTP/1.1
Host: demo.dicoogle.com

$.ajax({
  url: 'http://demo.dicoogle.com/management/settings/index',
  method: 'post',
  data: '?path=string&watcher=true&zip=true&saveThumbnail=true&effort=0&thumbnailSize=0',

  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

fetch('http://demo.dicoogle.com/management/settings/index?path=string&watcher=true&zip=true&saveThumbnail=true&effort=0&thumbnailSize=0',
{
  method: 'POST'

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

require 'rest-client'
require 'json'

result = RestClient.post 'http://demo.dicoogle.com/management/settings/index',
  params: {
  'path' => 'string',
'watcher' => 'boolean',
'zip' => 'boolean',
'saveThumbnail' => 'boolean',
'effort' => 'integer',
'thumbnailSize' => 'integer'
}

p JSON.parse(result)

import requests

r = requests.post('http://demo.dicoogle.com/management/settings/index', params={
  'path': 'string',  'watcher': 'true',  'zip': 'true',  'saveThumbnail': 'true',  'effort': '0',  'thumbnailSize': '0'
)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/management/settings/index?path=string&watcher=true&zip=true&saveThumbnail=true&effort=0&thumbnailSize=0");
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", "http://demo.dicoogle.com/management/settings/index", data)
    req.Header = headers

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

request('POST','http://demo.dicoogle.com/management/settings/index', 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());
 }

 // ...

POST /management/settings/index

Set all the Indexer settings

Parameters

Name	In	Type	Required	Description
path	query	string	true	the Dicoogle watcher directory
watcher	query	boolean	true	enable the Dicoogle watcher directory
zip	query	boolean	true	index zip files
saveThumbnail	query	boolean	true	save thumbnail
effort	query	integer	true	the indexation effort
thumbnailSize	query	integer	true	the thumbnail size

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	None
400	Bad Request	Invalid supplied parameters	None

getAvailableTS

Code samples

# You can also use wget
curl -X GET http://demo.dicoogle.com/management/settings/transfer \
  -H 'Accept: application/json'

GET http://demo.dicoogle.com/management/settings/transfer HTTP/1.1
Host: demo.dicoogle.com
Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'http://demo.dicoogle.com/management/settings/transfer',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'

};

fetch('http://demo.dicoogle.com/management/settings/transfer',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://demo.dicoogle.com/management/settings/transfer',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://demo.dicoogle.com/management/settings/transfer', params={

}, headers = headers)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/management/settings/transfer");
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() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://demo.dicoogle.com/management/settings/transfer", data)
    req.Header = headers

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

 'application/json',
    
    );

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','http://demo.dicoogle.com/management/settings/transfer', 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());
 }

 // ...

GET /management/settings/transfer

Get the list of current transfer syntax settings available

Example responses

200 Response

[
  {
    "uid": "string",
    "sop_name": "string",
    "options": [
      {
        "name": "string",
        "value": true
      }
    ]
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	TransferSyntaxSettingsList

setOptionTS

Code samples

# You can also use wget
curl -X POST http://demo.dicoogle.com/management/settings/transfer?uid=string&option=string&value=true \
  -H 'Accept: application/json'

POST http://demo.dicoogle.com/management/settings/transfer?uid=string&option=string&value=true HTTP/1.1
Host: demo.dicoogle.com
Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'http://demo.dicoogle.com/management/settings/transfer',
  method: 'post',
  data: '?uid=string&option=string&value=true',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'

};

fetch('http://demo.dicoogle.com/management/settings/transfer?uid=string&option=string&value=true',
{
  method: 'POST',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://demo.dicoogle.com/management/settings/transfer',
  params: {
  'uid' => 'string',
'option' => 'string',
'value' => 'boolean'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://demo.dicoogle.com/management/settings/transfer', params={
  'uid': 'string',  'option': 'string',  'value': 'true'
}, headers = headers)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/management/settings/transfer?uid=string&option=string&value=true");
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{
        "Accept": []string{"application/json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://demo.dicoogle.com/management/settings/transfer", data)
    req.Header = headers

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

 'application/json',
    
    );

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('POST','http://demo.dicoogle.com/management/settings/transfer', 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());
 }

 // ...

POST /management/settings/transfer

Set (or reset) an option of a particular transfer syntax

Parameters

Name	In	Type	Required	Description
uid	query	string	true	the unique identifier of the transfer syntax
option	query	string	true	the name of the option to modify
value	query	boolean	true	whether to set (true) or reset (false) the option

Example responses

200 Response

{
  "success": true
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	Success

getQueryRetrieveSettings

Code samples

# You can also use wget
curl -X GET http://demo.dicoogle.com/management/settings/dicom/query \
  -H 'Accept: application/json'

GET http://demo.dicoogle.com/management/settings/dicom/query HTTP/1.1
Host: demo.dicoogle.com
Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'http://demo.dicoogle.com/management/settings/dicom/query',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'

};

fetch('http://demo.dicoogle.com/management/settings/dicom/query',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://demo.dicoogle.com/management/settings/dicom/query',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://demo.dicoogle.com/management/settings/dicom/query', params={

}, headers = headers)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/management/settings/dicom/query");
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() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://demo.dicoogle.com/management/settings/dicom/query", data)
    req.Header = headers

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

 'application/json',
    
    );

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','http://demo.dicoogle.com/management/settings/dicom/query', 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());
 }

 // ...

GET /management/settings/dicom/query

Get all of the current DICOM Query-Retrieve settings

Example responses

200 Response

{
  "acceptTimeout": 60,
  "connectionTimeout": 60,
  "idleTimeout": 60,
  "maxAssociations": 20,
  "maxPduReceive": 16364,
  "maxPduSend": 6364,
  "responseTimeout": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	QuerySettings

setQueryRetrieveSettings

Code samples

# You can also use wget
curl -X POST http://demo.dicoogle.com/management/settings/dicom/query

POST http://demo.dicoogle.com/management/settings/dicom/query HTTP/1.1
Host: demo.dicoogle.com

$.ajax({
  url: 'http://demo.dicoogle.com/management/settings/dicom/query',
  method: 'post',

  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

fetch('http://demo.dicoogle.com/management/settings/dicom/query',
{
  method: 'POST'

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

require 'rest-client'
require 'json'

result = RestClient.post 'http://demo.dicoogle.com/management/settings/dicom/query',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.post('http://demo.dicoogle.com/management/settings/dicom/query', params={

)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/management/settings/dicom/query");
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", "http://demo.dicoogle.com/management/settings/dicom/query", data)
    req.Header = headers

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

request('POST','http://demo.dicoogle.com/management/settings/dicom/query', 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());
 }

 // ...

POST /management/settings/dicom/query

Set a group of DICOM Query/Retrieve settings

Parameters

Name	In	Type	Required	Description
acceptTimeout	query	integer	false	none
connectionTimeout	query	integer	false	none
idleTimeout	query	integer	false	none
maxAssociations	query	integer	false	none
maxPduReceive	query	integer	false	none
maxPduSend	query	integer	false	none
responseTimeout	query	integer	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	None

getStorageStatus

Code samples

# You can also use wget
curl -X GET http://demo.dicoogle.com/management/dicom/storage \
  -H 'Accept: application/json'

GET http://demo.dicoogle.com/management/dicom/storage HTTP/1.1
Host: demo.dicoogle.com
Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'http://demo.dicoogle.com/management/dicom/storage',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'

};

fetch('http://demo.dicoogle.com/management/dicom/storage',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://demo.dicoogle.com/management/dicom/storage',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://demo.dicoogle.com/management/dicom/storage', params={

}, headers = headers)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/management/dicom/storage");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://demo.dicoogle.com/management/dicom/storage", data)
    req.Header = headers

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

 'application/json',
    
    );

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','http://demo.dicoogle.com/management/dicom/storage', 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());
 }

 // ...

GET /management/dicom/storage

Check the storage's service status

Example responses

200 Response

{
  "tasks": {
    "isRunning": true,
    "port": 6666,
    "autostart": true
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» tasks	ServiceStatus	false	none	none
»» isRunning	boolean	false	none	none
»» port	integer	false	none	none
»» autostart	boolean	false	none	none

setStorageStatus

Code samples

# You can also use wget
curl -X POST http://demo.dicoogle.com/management/dicom/storage \
  -H 'Accept: application/json'

POST http://demo.dicoogle.com/management/dicom/storage HTTP/1.1
Host: demo.dicoogle.com
Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'http://demo.dicoogle.com/management/dicom/storage',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'

};

fetch('http://demo.dicoogle.com/management/dicom/storage',
{
  method: 'POST',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://demo.dicoogle.com/management/dicom/storage',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://demo.dicoogle.com/management/dicom/storage', params={

}, headers = headers)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/management/dicom/storage");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://demo.dicoogle.com/management/dicom/storage", data)
    req.Header = headers

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

 'application/json',
    
    );

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('POST','http://demo.dicoogle.com/management/dicom/storage', 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());
 }

 // ...

POST /management/dicom/storage

Change the storage's service status

Parameters

Name	In	Type	Required	Description
isRunning	query	boolean	false	whether the service runs or not
port	query	integer	false	the port where the service is running
autostart	query	boolean	false	whether the service autostarts or not

Example responses

200 Response

{
  "success": true
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	Success

getQueryStatus

Code samples

# You can also use wget
curl -X GET http://demo.dicoogle.com/management/dicom/query \
  -H 'Accept: application/json'

GET http://demo.dicoogle.com/management/dicom/query HTTP/1.1
Host: demo.dicoogle.com
Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'http://demo.dicoogle.com/management/dicom/query',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'

};

fetch('http://demo.dicoogle.com/management/dicom/query',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://demo.dicoogle.com/management/dicom/query',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://demo.dicoogle.com/management/dicom/query', params={

}, headers = headers)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/management/dicom/query");
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() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://demo.dicoogle.com/management/dicom/query", data)
    req.Header = headers

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

 'application/json',
    
    );

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','http://demo.dicoogle.com/management/dicom/query', 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());
 }

 // ...

GET /management/dicom/query

Check the query's service status

Example responses

200 Response

{
  "tasks": {
    "isRunning": true,
    "port": 6666,
    "autostart": true
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» tasks	ServiceStatus	false	none	none
»» isRunning	boolean	false	none	none
»» port	integer	false	none	none
»» autostart	boolean	false	none	none

setQueryStatus

Code samples

# You can also use wget
curl -X POST http://demo.dicoogle.com/management/dicom/query \
  -H 'Accept: application/json'

POST http://demo.dicoogle.com/management/dicom/query HTTP/1.1
Host: demo.dicoogle.com
Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'http://demo.dicoogle.com/management/dicom/query',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'

};

fetch('http://demo.dicoogle.com/management/dicom/query',
{
  method: 'POST',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://demo.dicoogle.com/management/dicom/query',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://demo.dicoogle.com/management/dicom/query', params={

}, headers = headers)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/management/dicom/query");
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{
        "Accept": []string{"application/json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://demo.dicoogle.com/management/dicom/query", data)
    req.Header = headers

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

 'application/json',
    
    );

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('POST','http://demo.dicoogle.com/management/dicom/query', 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());
 }

 // ...

POST /management/dicom/query

Change the query's service status

Parameters

Name	In	Type	Required	Description
isRunning	query	boolean	false	whether the service runs or not
port	query	integer	false	the port where the service is running
autostart	query	boolean	false	whether the service autostarts or not

Example responses

200 Response

{
  "success": true
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	Success

getAETitle

Code samples

# You can also use wget
curl -X GET http://demo.dicoogle.com/management/settings/dicom \
  -H 'Accept: application/json'

GET http://demo.dicoogle.com/management/settings/dicom HTTP/1.1
Host: demo.dicoogle.com
Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'http://demo.dicoogle.com/management/settings/dicom',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'

};

fetch('http://demo.dicoogle.com/management/settings/dicom',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://demo.dicoogle.com/management/settings/dicom',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://demo.dicoogle.com/management/settings/dicom', params={

}, headers = headers)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/management/settings/dicom");
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() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://demo.dicoogle.com/management/settings/dicom", data)
    req.Header = headers

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

 'application/json',
    
    );

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','http://demo.dicoogle.com/management/settings/dicom', 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());
 }

 // ...

GET /management/settings/dicom

Retrieve the AE title of the Dicoogle archive

Example responses

200 Response

{
  "tasks": {
    "aetitle": "string"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» tasks	AETitle	false	none	none
»» aetitle	string	false	none	none

setAETitle

Code samples

# You can also use wget
curl -X PUT http://demo.dicoogle.com/management/settings/dicom?aetitle=true \
  -H 'Accept: application/json'

PUT http://demo.dicoogle.com/management/settings/dicom?aetitle=true HTTP/1.1
Host: demo.dicoogle.com
Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'http://demo.dicoogle.com/management/settings/dicom',
  method: 'put',
  data: '?aetitle=true',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'

};

fetch('http://demo.dicoogle.com/management/settings/dicom?aetitle=true',
{
  method: 'PUT',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.put 'http://demo.dicoogle.com/management/settings/dicom',
  params: {
  'aetitle' => 'boolean'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.put('http://demo.dicoogle.com/management/settings/dicom', params={
  'aetitle': 'true'
}, headers = headers)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/management/settings/dicom?aetitle=true");
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{
        "Accept": []string{"application/json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://demo.dicoogle.com/management/settings/dicom", data)
    req.Header = headers

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

 'application/json',
    
    );

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('PUT','http://demo.dicoogle.com/management/settings/dicom', 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());
 }

 // ...

PUT /management/settings/dicom

Redefine the AE title of the Dicoogle archive

Parameters

Name	In	Type	Required	Description
aetitle	query	boolean	true	a valid AE title for the PACS archive

Example responses

200 Response

{
  "success": true
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	Success
400	Bad Request	Invalid supplied parameter	None

getPluginList

Code samples

# You can also use wget
curl -X GET http://demo.dicoogle.com/plugins \
  -H 'Accept: application/json'

GET http://demo.dicoogle.com/plugins HTTP/1.1
Host: demo.dicoogle.com
Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'http://demo.dicoogle.com/plugins',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'

};

fetch('http://demo.dicoogle.com/plugins',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://demo.dicoogle.com/plugins',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://demo.dicoogle.com/plugins', params={

}, headers = headers)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/plugins");
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() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        
    }

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

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

 'application/json',
    
    );

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','http://demo.dicoogle.com/plugins', 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());
 }

 // ...

GET /plugins

Retrieve the list of existing plugins

Example responses

200 Response

{
  "plugins": [
    {
      "name": "lucene",
      "type": "query",
      "enabled": true
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» plugins	[Plugin]	false	none	none
»» name	string	false	none	none
»» type	string	false	none	none
»» enabled	boolean	false	none	none

getAssociatedServers

Code samples

# You can also use wget
curl -X GET http://demo.dicoogle.com/management/settings/storage/dicom \
  -H 'Accept: application/json'

GET http://demo.dicoogle.com/management/settings/storage/dicom HTTP/1.1
Host: demo.dicoogle.com
Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'http://demo.dicoogle.com/management/settings/storage/dicom',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'

};

fetch('http://demo.dicoogle.com/management/settings/storage/dicom',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://demo.dicoogle.com/management/settings/storage/dicom',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://demo.dicoogle.com/management/settings/storage/dicom', params={

}, headers = headers)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/management/settings/storage/dicom");
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() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://demo.dicoogle.com/management/settings/storage/dicom", data)
    req.Header = headers

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

 'application/json',
    
    );

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','http://demo.dicoogle.com/management/settings/storage/dicom', 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());
 }

 // ...

GET /management/settings/storage/dicom

Get the currently associated remote servers

Example responses

200 Response

[
  {
    "AETitle": "string",
    "description": "string",
    "ipAddrs": "string",
    "isPublic": true,
    "port": 0,
    "public": true
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	RemoteServers
400	Bad Request	Invalid supplied parameters	None

setAssociatedServer

Code samples

# You can also use wget
curl -X POST http://demo.dicoogle.com/management/settings/storage/dicom?type=true&ip=string&aetitle=string&port=0 \
  -H 'Accept: application/json'

POST http://demo.dicoogle.com/management/settings/storage/dicom?type=true&ip=string&aetitle=string&port=0 HTTP/1.1
Host: demo.dicoogle.com
Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'http://demo.dicoogle.com/management/settings/storage/dicom',
  method: 'post',
  data: '?type=true&ip=string&aetitle=string&port=0',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'

};

fetch('http://demo.dicoogle.com/management/settings/storage/dicom?type=true&ip=string&aetitle=string&port=0',
{
  method: 'POST',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://demo.dicoogle.com/management/settings/storage/dicom',
  params: {
  'type' => 'boolean',
'ip' => 'string',
'aetitle' => 'string',
'port' => 'integer'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://demo.dicoogle.com/management/settings/storage/dicom', params={
  'type': 'true',  'ip': 'string',  'aetitle': 'string',  'port': '0'
}, headers = headers)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/management/settings/storage/dicom?type=true&ip=string&aetitle=string&port=0");
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{
        "Accept": []string{"application/json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://demo.dicoogle.com/management/settings/storage/dicom", data)
    req.Header = headers

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

 'application/json',
    
    );

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('POST','http://demo.dicoogle.com/management/settings/storage/dicom', 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());
 }

 // ...

POST /management/settings/storage/dicom

Associate or remove a remote server

Parameters

Name	In	Type	Required	Description
type	query	boolean	true	whether the server is being associated or removed
ip	query	string	true	none
aetitle	query	string	true	none
port	query	integer	true	none

Example responses

200 Response

{
  "tasks": [
    {
      "canceled": false,
      "done": false,
      "name": "[lucene]index storage/",
      "progress": 0,
      "uid": "5c5f36ec-a946-49db-b903-e815e2f08dee"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	Inline
400	Bad Request	Invalid supplied parameters	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» tasks	[Task]	false	none	none
»» canceled	boolean	false	none	none
»» done	boolean	false	none	none
»» name	string	false	none	none
»» progress	integer	false	none	none
»» uid	string	false	none	none

Misc

Misc related services

dumpMetadata

Code samples

# You can also use wget
curl -X GET http://demo.dicoogle.com/dump?uid=string \
  -H 'Accept: application/json'

GET http://demo.dicoogle.com/dump?uid=string HTTP/1.1
Host: demo.dicoogle.com
Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'http://demo.dicoogle.com/dump',
  method: 'get',
  data: '?uid=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'

};

fetch('http://demo.dicoogle.com/dump?uid=string',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://demo.dicoogle.com/dump',
  params: {
  'uid' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://demo.dicoogle.com/dump', params={
  'uid': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/dump?uid=string");
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() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        
    }

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

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

 'application/json',
    
    );

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','http://demo.dicoogle.com/dump', 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());
 }

 // ...

GET /dump

Retrieve an image's meta-data (perform an information dump)

Parameters

Name	In	Type	Required	Description
uid	query	string	true	the SOP instance UID
provider	query	string	false	a list of provider plugins

Example responses

200 Response

{
  "uri": "file:/1bf65303-88a6-4c7e-bbd3-95cd3d2901a7",
  "fields": {
    "PatientID": "9850721e-27bf-4e8c-a9cd-00680c3c83d7",
    "SeriesDate": "20150120",
    "StudyDate": "20150120",
    "PatientName": "e8344a6c-3385-497f-bf47-01a89914d572",
    "StudyInstanceUID": "0c69d902-6cb1-4df5-8d1b-c17051d96c9a",
    "SOPInstanceUID": "bd6ac908-a061-4ed4-9083-5a5dfb12e7f4",
    "Modality": "CT",
    "SeriesInstanceUID": "fd76f30b-2ee2-46ad-ac40-856266e6a396"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	Result
400	Bad Request	Invalid supplied parameters	None

wado

Code samples

# You can also use wget
curl -X GET http://demo.dicoogle.com/wado \
  -H 'Accept: text/plain'

GET http://demo.dicoogle.com/wado HTTP/1.1
Host: demo.dicoogle.com
Accept: text/plain

var headers = {
  'Accept':'text/plain'

};

$.ajax({
  url: 'http://demo.dicoogle.com/wado',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'text/plain'

};

fetch('http://demo.dicoogle.com/wado',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/plain'
}

result = RestClient.get 'http://demo.dicoogle.com/wado',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'text/plain'
}

r = requests.get('http://demo.dicoogle.com/wado', params={

}, headers = headers)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/wado");
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() {

    headers := map[string][]string{
        "Accept": []string{"text/plain"},
        
    }

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

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

 'text/plain',
    
    );

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','http://demo.dicoogle.com/wado', 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());
 }

 // ...

GET /wado

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	string

getLogText

Code samples

# You can also use wget
curl -X GET http://demo.dicoogle.com/logger \
  -H 'Accept: text/plain'

GET http://demo.dicoogle.com/logger HTTP/1.1
Host: demo.dicoogle.com
Accept: text/plain

var headers = {
  'Accept':'text/plain'

};

$.ajax({
  url: 'http://demo.dicoogle.com/logger',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'text/plain'

};

fetch('http://demo.dicoogle.com/logger',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/plain'
}

result = RestClient.get 'http://demo.dicoogle.com/logger',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'text/plain'
}

r = requests.get('http://demo.dicoogle.com/logger', params={

}, headers = headers)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/logger");
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() {

    headers := map[string][]string{
        "Accept": []string{"text/plain"},
        
    }

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

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

 'text/plain',
    
    );

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','http://demo.dicoogle.com/logger', 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());
 }

 // ...

GET /logger

Retrieve the Dicoogle server's log text

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	string
400	Bad Request	Invalid supplied parameters	None

exportCSV

Code samples

# You can also use wget
curl -X GET http://demo.dicoogle.com/export/cvs?query=string&fields=string

GET http://demo.dicoogle.com/export/cvs?query=string&fields=string HTTP/1.1
Host: demo.dicoogle.com

$.ajax({
  url: 'http://demo.dicoogle.com/export/cvs',
  method: 'get',
  data: '?query=string&fields=string',

  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

fetch('http://demo.dicoogle.com/export/cvs?query=string&fields=string',
{
  method: 'GET'

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

require 'rest-client'
require 'json'

result = RestClient.get 'http://demo.dicoogle.com/export/cvs',
  params: {
  'query' => 'string',
'fields' => 'string'
}

p JSON.parse(result)

import requests

r = requests.get('http://demo.dicoogle.com/export/cvs', params={
  'query': 'string',  'fields': 'string'
)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/export/cvs?query=string&fields=string");
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", "http://demo.dicoogle.com/export/cvs", data)
    req.Header = headers

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

request('GET','http://demo.dicoogle.com/export/cvs', 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());
 }

 // ...

GET /export/cvs

Request a CSV file export of the results

Parameters

Name	In	Type	Required	Description
query	query	string	true	the query to perform
fields	query	string	true	a set of field names to be passed to the query providers when requesting the query
providers	query	string	false	a set of query provider names
keyword	query	boolean	false	force whether the query is keyword-based

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	None
400	Bad Request	Invalid supplied parameter	None

getValidDicomFields

Code samples

# You can also use wget
curl -X GET http://demo.dicoogle.com/export/list \
  -H 'Accept: application/json'

GET http://demo.dicoogle.com/export/list HTTP/1.1
Host: demo.dicoogle.com
Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'http://demo.dicoogle.com/export/list',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'

};

fetch('http://demo.dicoogle.com/export/list',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://demo.dicoogle.com/export/list',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://demo.dicoogle.com/export/list', params={

}, headers = headers)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/export/list");
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() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://demo.dicoogle.com/export/list", data)
    req.Header = headers

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

 'application/json',
    
    );

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','http://demo.dicoogle.com/export/list', 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());
 }

 // ...

GET /export/list

Get a list of known valid DICOM fields

Example responses

200 Response

[
  "string"
]

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	Inline

Response Schema

getVersion

Code samples

# You can also use wget
curl -X GET http://demo.dicoogle.com/ext/version \
  -H 'Accept: application/json'

GET http://demo.dicoogle.com/ext/version HTTP/1.1
Host: demo.dicoogle.com
Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'http://demo.dicoogle.com/ext/version',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'

};

fetch('http://demo.dicoogle.com/ext/version',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://demo.dicoogle.com/ext/version',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://demo.dicoogle.com/ext/version', params={

}, headers = headers)

print r.json()

URL obj = new URL("http://demo.dicoogle.com/ext/version");
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() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://demo.dicoogle.com/ext/version", data)
    req.Header = headers

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

 'application/json',
    
    );

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','http://demo.dicoogle.com/ext/version', 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());
 }

 // ...

GET /ext/version

Retrieve the running Dicoogle version

Example responses

200 Response

{
  "version": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful operation	Version
400	Bad Request	Invalid supplied parameters	None

Schemas

Success

{
  "success": true
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none

User

{
  "username": "string"
}

Properties

Name	Type	Required	Restrictions	Description
username	string	false	none	none

Users

[
  {
    "username": "string"
  }
]

Properties

Name	Type	Required	Restrictions	Description
anonymous	[User]	false	none	none

FullUser

{
  "user": "string",
  "admin": true,
  "roles": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
user	string	false	none	none
admin	boolean	false	none	none
roles	ListOfStrings	false	none	none

Result

{
  "uri": "file:/1bf65303-88a6-4c7e-bbd3-95cd3d2901a7",
  "fields": {
    "PatientID": "9850721e-27bf-4e8c-a9cd-00680c3c83d7",
    "SeriesDate": "20150120",
    "StudyDate": "20150120",
    "PatientName": "e8344a6c-3385-497f-bf47-01a89914d572",
    "StudyInstanceUID": "0c69d902-6cb1-4df5-8d1b-c17051d96c9a",
    "SOPInstanceUID": "bd6ac908-a061-4ed4-9083-5a5dfb12e7f4",
    "Modality": "CT",
    "SeriesInstanceUID": "fd76f30b-2ee2-46ad-ac40-856266e6a396"
  }
}

Properties

Name	Type	Required	Restrictions	Description
uri	string(uri)	false	none	none
fields	object	false	none	none
» PatientID	string	false	none	none
» SeriesDate	string	false	none	none
» StudyDate	string	false	none	none
» PatientName	string	false	none	none
» StudyInstanceUID	string	false	none	none
» SOPInstanceUID	string	false	none	none
» Modality	string	false	none	none
» SeriesInstanceUID	string	false	none	none

Results

{
  "results": [
    {
      "uri": "file:/1bf65303-88a6-4c7e-bbd3-95cd3d2901a7",
      "fields": {
        "PatientID": "9850721e-27bf-4e8c-a9cd-00680c3c83d7",
        "SeriesDate": "20150120",
        "StudyDate": "20150120",
        "PatientName": "e8344a6c-3385-497f-bf47-01a89914d572",
        "StudyInstanceUID": "0c69d902-6cb1-4df5-8d1b-c17051d96c9a",
        "SOPInstanceUID": "bd6ac908-a061-4ed4-9083-5a5dfb12e7f4",
        "Modality": "CT",
        "SeriesInstanceUID": "fd76f30b-2ee2-46ad-ac40-856266e6a396"
      }
    }
  ],
  "elapsedTime": 559,
  "numResults": 5
}

Properties

Name	Type	Required	Restrictions	Description
results	[Result]	false	none	none
elapsedTime	integer	false	none	none
numResults	integer	false	none	none

DIMResult

{}

Properties

None

DIMResults

{
  "results": [
    {}
  ],
  "elapsedTime": 5,
  "numResults": 5
}

Properties

Name	Type	Required	Restrictions	Description
results	[DIMResult]	false	none	none
elapsedTime	integer	false	none	none
numResults	integer	false	none	none

IndexSettings

{
  "path": "/tmp",
  "zip": false,
  "effort": false,
  "thumbnail": true,
  "thumbnailSize": 64,
  "watcher": false
}

Properties

Name	Type	Required	Restrictions	Description
path	string	false	none	none
zip	boolean	false	none	none
effort	integer	false	none	none
thumbnail	boolean	false	none	none
thumbnailSize	integer	false	none	none
watcher	boolean	false	none	none

QuerySettings

{
  "acceptTimeout": 60,
  "connectionTimeout": 60,
  "idleTimeout": 60,
  "maxAssociations": 20,
  "maxPduReceive": 16364,
  "maxPduSend": 6364,
  "responseTimeout": 0
}

Properties

Name	Type	Required	Restrictions	Description
acceptTimeout	integer	false	none	none
connectionTimeout	integer	false	none	none
idleTimeout	integer	false	none	none
maxAssociations	integer	false	none	none
maxPduReceive	integer	false	none	none
maxPduSend	integer	false	none	none
responseTimeout	integer	false	none	none

Task

{
  "canceled": false,
  "done": false,
  "name": "[lucene]index storage/",
  "progress": 0,
  "uid": "5c5f36ec-a946-49db-b903-e815e2f08dee"
}

Properties

Name	Type	Required	Restrictions	Description
canceled	boolean	false	none	none
done	boolean	false	none	none
name	string	false	none	none
progress	integer	false	none	none
uid	string	false	none	none

Tasks

[
  {
    "canceled": false,
    "done": false,
    "name": "[lucene]index storage/",
    "progress": 0,
    "uid": "5c5f36ec-a946-49db-b903-e815e2f08dee"
  }
]

Properties

Name	Type	Required	Restrictions	Description
anonymous	[Task]	false	none	none

ServiceStatus

{
  "isRunning": true,
  "port": 6666,
  "autostart": true
}

Properties

Name	Type	Required	Restrictions	Description
isRunning	boolean	false	none	none
port	integer	false	none	none
autostart	boolean	false	none	none

AETitle

{
  "aetitle": "string"
}

Properties

Name	Type	Required	Restrictions	Description
aetitle	string	false	none	none

Plugin

{
  "name": "lucene",
  "type": "query",
  "enabled": true
}

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	none
type	string	false	none	none
enabled	boolean	false	none	none

Plugins

[
  {
    "name": "lucene",
    "type": "query",
    "enabled": true
  }
]

Properties

Name	Type	Required	Restrictions	Description
anonymous	[Plugin]	false	none	none

TaskResult

{
  "uid": "92b099fe-eea1-49bd-9a84-b3d0d6135c37",
  "taskName": "[lucene]index",
  "taskProgress": 0.1,
  "complete": false,
  "elapsedTime": 9,
  "nIndexed": 3,
  "nErrors": 0
}

Properties

Name	Type	Required	Restrictions	Description
uid	string	false	none	none
taskName	string	false	none	none
taskProgress	number	false	none	none
complete	boolean	false	none	none
elapsedTime	integer	false	none	none
nIndexed	integer	false	none	none
nErrors	integer	false	none	none

TaskResults

{
  "results": [
    {
      "uid": "92b099fe-eea1-49bd-9a84-b3d0d6135c37",
      "taskName": "[lucene]index",
      "taskProgress": 0.1,
      "complete": false,
      "elapsedTime": 9,
      "nIndexed": 3,
      "nErrors": 0
    }
  ],
  "count": 0
}

Properties

Name	Type	Required	Restrictions	Description
results	[TaskResult]	false	none	none
count	integer	false	none	none

RemoteServer

{
  "AETitle": "string",
  "description": "string",
  "ipAddrs": "string",
  "isPublic": true,
  "port": 0,
  "public": true
}

Properties

Name	Type	Required	Restrictions	Description
AETitle	string	false	none	none
description	string	false	none	none
ipAddrs	string	false	none	none
isPublic	boolean	false	none	none
port	integer	false	none	none
public	boolean	false	none	none

RemoteServers

[
  {
    "AETitle": "string",
    "description": "string",
    "ipAddrs": "string",
    "isPublic": true,
    "port": 0,
    "public": true
  }
]

Properties

Name	Type	Required	Restrictions	Description
anonymous	[RemoteServer]	false	none	none

TransferSyntaxSettingsOption

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

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	none
value	boolean	false	none	none

TransferSyntaxSettings

{
  "uid": "string",
  "sop_name": "string",
  "options": [
    {
      "name": "string",
      "value": true
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
uid	string	false	none	none
sop_name	string	false	none	none
options	[TransferSyntaxSettingsOption]	false	none	none

TransferSyntaxSettingsList

[
  {
    "uid": "string",
    "sop_name": "string",
    "options": [
      {
        "name": "string",
        "value": true
      }
    ]
  }
]

Properties

Name	Type	Required	Restrictions	Description
anonymous	[TransferSyntaxSettings]	false	none	none

Version

{
  "version": "string"
}

Properties

Name	Type	Required	Restrictions	Description
version	string	false	none	none

ListOfStrings

[
  "string"
]

Properties

None