System Configuration

This chapter focuses on the system configuration of of Squash TM.

Get upload extention whitelist

A GET to /configuration/upload-extention-whitelist returns the upload extention whitelist.

HTTP request

GET /api/rest/latest/configuration/upload-extention-whitelist HTTP/1.1
Accept: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 120

{
  "_type" : "upload-extention-whitelist",
  "whitelist" : "txt, doc, xls, ppt, docx, xlsx, pptx, odt, ods, odp, pdf"
}

Response fields

Path Type Description

_type

String

the type of the entity

whitelist

String

upload extention whitelist of Squash TM

Set upload extention whitelist

A POST to /configuration/upload-extention-whitelist set the upload extention whitelist.

HTTP request

POST /api/rest/latest/configuration/upload-extention-whitelist HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 120
Host: localhost:8080

{
  "_type" : "upload-extention-whitelist",
  "whitelist" : "txt, doc, xls, ppt, docx, xlsx, pptx, odt, ods, odp, pdf"
}

Request fields

Path Type Description

_type

String

the type of the entity

whitelist

String

the welcome message of Squash TM

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 120

{
  "_type" : "upload-extention-whitelist",
  "whitelist" : "txt, doc, xls, ppt, docx, xlsx, pptx, odt, ods, odp, pdf"
}

Response fields

Path Type Description

_type

String

the type of the entity

whitelist

String

the welcome message of Squash TM

Get upload size limit

A GET to /configuration/upload-size-limit returns the upload size limit.

HTTP request

GET /api/rest/latest/configuration/upload-size-limit HTTP/1.1
Accept: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 54

{
  "_type" : "upload-size-limit",
  "size" : "5000"
}

Response fields

Path Type Description

_type

String

the type of the entity

size

String

upload size limit of Squash TM

Set upload size limit

A POST to /configuration/upload-size-limit set the upload size limit.

HTTP request

POST /api/rest/latest/configuration/upload-size-limit HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 56
Host: localhost:8080

{
  "_type" : "upload-size-limit",
  "size" : "400000"
}

Request fields

Path Type Description

_type

String

the type of the entity

size

String

the upload size limit of Squash TM

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 56

{
  "_type" : "upload-size-limit",
  "size" : "400000"
}

Response fields

Path Type Description

_type

String

the type of the entity

size

String

the upload size limit of Squash TM

Get import size limit

A GET to /configuration/import-size-limit returns the import size limit.

HTTP request

GET /api/rest/latest/configuration/import-size-limit HTTP/1.1
Accept: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 54

{
  "_type" : "import-size-limit",
  "size" : "5000"
}

Response fields

Path Type Description

_type

String

the type of the entity

size

String

Import size limit of Squash TM

Set import size limit

A POST to /configuration/import-size-limit set the import size limit.

HTTP request

POST /api/rest/latest/configuration/import-size-limit HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 56
Host: localhost:8080

{
  "_type" : "import-size-limit",
  "size" : "400000"
}

Request fields

Path Type Description

_type

String

the type of the entity

size

String

the import size limit of Squash TM

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 56

{
  "_type" : "import-size-limit",
  "size" : "400000"
}

Response fields

Path Type Description

_type

String

the type of the entity

size

String

the import size limit of Squash TM

Get squash callback url

A GET to /configuration/squash-callback-url returns the squash callback url.

HTTP request

GET /api/rest/latest/configuration/squash-callback-url HTTP/1.1
Accept: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 69

{
  "_type" : "squash-callback-url",
  "url" : "http://callback.fr"
}

Response fields

Path Type Description

_type

String

the type of the entity

url

String

callback url of Squash TM

Set squash callback url

A POST to /configuration/squash-callback-url set the squash callback url.

HTTP request

POST /api/rest/latest/configuration/squash-callback-url HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 69
Host: localhost:8080

{
  "_type" : "squash-callback-url",
  "url" : "http://callback.fr"
}

Request fields

Path Type Description

_type

String

the type of the entity

url

String

the callback url of Squash TM

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 69

{
  "_type" : "squash-callback-url",
  "url" : "http://callback.fr"
}

Response fields

Path Type Description

_type

String

the type of the entity

url

String

the callback url of Squash TM

Enable/disable case insensitive login

A POST to /configuration/case-insensitive-login?enabled=true enable case insensitive login.

HTTP request

POST /api/rest/latest/configuration/case-insensitive-login?enabled=true HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: localhost:8080

Request parameters

Parameter Description

enabled

takes the values true/false to activate/deactivate login case insensitivity.

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 28

"case insentive login: true"