documenter.getpostman.com Open in urlscan Pro
2606:4700:4400::ac40:9a6a  Public Scan

Form analysis
0 forms found in the DOM

Text Content

 * Body
 * Headers (8)

 * Body
 * Headers (8)

 * Body
 * Headers (8)




Public


Documentation Settings

ENVIRONMENT
No Environment

LAYOUT
Double Column

LANGUAGE
cURL - cURL



paperless-be collections
Introduction
header
database
action/query
menu
app/page
auth
files
workflow
trigger
addon
print (NEW)
barcode
extract PDF
frontend functions


PAPERLESS-BE COLLECTIONS


HEADER

Content-Type(application/json)

details of JSON are in each request's description


EXAMPLE STEP-BY-STEP SAVEQUERY

View More

1 saveQuery { "actionId": 1,⋅ "actionSlug": null, "actionDbId": 1,⋅
"actionPageId": null, "actionName": "Koneksi sdm_db", "actionSQLQuery": "SELECT
* FROM d_karyawan WHERE karId = ? AND karNoPegawai = ? ", "actionFormat":
"{\"karNoPegawai\":\"No Pegawai\", \"karNama\":\"Nama\", \"karNoTelp\":\"No
Telp\", \"karJK\":\"Jenis Kelamin\"}" } saved Query
SELECT * FROM d_karyawan WHERE karId = ? AND karNoPegawai = ? 2 run query with
getData { "actionId": "1", "params": [ ["2","963265485"], ["1","1100212343"] ] }
executed query becomes:
SELECT * FROM d_karyawan WHERE karId = "2" AND karNoPegawai = "963265485"
SELECT * FROM d_karyawan WHERE karId = "1" AND karNoPegawai = "1100212343"



DATABASE




GETGETDBDETAILS


https://tool.stechoq.com/get/getDbDetails/:dbId


GET DETAILS OF DATABASE

params desc type example if null od undefined dbId db id, see getDbConf integer
1 null , undefined : error

AUTHORIZATIONBearer Token
Token

<token>

PATH VARIABLES
dbId

1

Example Request
getDbConf

curl


curl --location 'tool.stechoq.com/get/getDbConf' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'appId=1'

200 OK
Example Response
 * Body
 * Headers (8)

json


{
  "dbAppId": 1,
  "dbType": "mysql",
  "dbHost": "localhost",
  "dbPort": "3306",
  "dbUser": "sample_tester",
  "dbPassword": "ini password, ra percaya!",
  "dbDatabase": "sdm_db"
}

Server

nginx

Date

Mon, 21 Jan 2019 12:42:24 GMT

Content-Type

application/json; charset=utf-8

Content-Length

155

Connection

keep-alive

Keep-Alive

timeout=60

X-Powered-By

Express

ETag

W/"9b-v7uknnpYeRVqTcXTJy4mnlwl9R4"


GETGETDBCONF


https://tool.stechoq.com/get/getDbConf/:appId


GET DBCONF BY APP ID - THIS IS INTEDED FOR DEBUGGING ONLY

params desc type example if null od undefined appId app id of db connection,
each connection must have app id where it's listed on integer 1 null , undefined
: error

AUTHORIZATIONBearer Token
Token

<token>

PATH VARIABLES
appId

1

Example Request
getDbConf

curl


curl --location 'tool.stechoq.com/get/getDbConf' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'appId=1'

200 OK
Example Response
 * Body
 * Headers (8)

json


{
  "dbAppId": 1,
  "dbType": "mysql",
  "dbHost": "localhost",
  "dbPort": "3306",
  "dbUser": "sample_tester",
  "dbPassword": "ini password, ra percaya!",
  "dbDatabase": "sdm_db"
}

Server

nginx

Date

Mon, 21 Jan 2019 12:42:24 GMT

Content-Type

application/json; charset=utf-8

Content-Length

155

Connection

keep-alive

Keep-Alive

timeout=60

X-Powered-By

Express

ETag

W/"9b-v7uknnpYeRVqTcXTJy4mnlwl9R4"


POSTSAVEDBCONFIG


https://tool.stechoq.com/save/saveDbConfig


DATA ARE SENT IN JSON FORMAT LIKE IN FUNCTION GETAPP CON

View More

params desc type example if null or undefined dbId db connection id integer 1
null , undefined : create new dbAppId app id of db connection, each connection
must have app id where it's listed on integer 1 null , undefined : error dbType
db connection type string mysql null : update , undefined : not updating value
dbHost host name or ip string localhost null : update , undefined : not updating
value dbPort port number string 3306 null : update , undefined : not updating
value dbUser db's username string root null : update , undefined : not updating
value dbPassword db's Password string iki password null : update , undefined :
not updating value dbDatabase db's name string sdm_db null : update , undefined
: not updating value

AUTHORIZATIONBearer Token
Token

<token>

HEADERS
Content-Type

application/json

Bodyraw

{
    "dbId": 1,
    "dbAppId": 1,
    "dbType": "mysql",
    "dbHost": "localhost",
    "dbPort": "3306",
    "dbUser": "sample_tester",
    "dbPassword": "ini password, ra percaya!",
    "dbDatabase": "sdm_db"
}

Example Request
saveDbConf - JSON

View More
curl


curl --location 'tool.stechoq.com/save/saveDbConfig' \
--header 'Content-Type: application/json' \
--data '{
  "dbId"	: "1",
  "dbAppId"	: "1",
  "dbType"	: "mysql",
  "dbHost"    	: "localhost",
  "dbPort"    	: "3306",
  "dbUser"    	: "sample_tester",
  "dbPassword"	: "ini password, ra percaya!",
  "dbDatabase"	: "sdm_db"
}'

200 OK
Example Response
 * Body
 * Headers (8)

json


"db 1 SUCCESS"

Server

nginx

Date

Mon, 21 Jan 2019 12:41:16 GMT

Content-Type

application/json; charset=utf-8

Content-Length

14

Connection

keep-alive

Keep-Alive

timeout=60

X-Powered-By

Express

ETag

W/"e-R2FdY2nZNz0vTnepPzfhHZTYNig"