Zum Inhalt

addons#

Hier werden bekannte Methoden zu Add-ons aufgelistet.

analysis#

analysis.dataquality.read#

Request parameters#

Key JSON data typ Required Description
profileId Integer Yes Profile identifier, for example: 1

WIP

Response parameters#

JSON key result contains an array of JSON objects. Each object contains a search result.

Key JSON data type Description
Placeholder Placeholder Placeholder
Placeholder Placeholder Placeholder

Example#

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "version": "2.0",
  "method": "analysis.dataquality.read",
  "params": {
    "profileId": 1,
    "apikey": "h3md6u3y",
    "language": "en"
  },
  "id": 1
}

1
2
3
4
5
6
7
8
{
  "id": 1,
  "jsonrpc": "2.0",
  "result": {
    "objects": [],
    "averagePercent": 0
  }
}

Documents#

document.documents.read#

Request parameters#

Key JSON data typ Required Description
docID Integer Yes or objID Document identifier, for example: 1
objID Integer Yes or docID Object identifier, for example: 1

WIP

Response parameters#

JSON key result contains an array of JSON objects. Each object contains a search result.

Key JSON data type Description
Placeholder Placeholder Placeholder
Placeholder Placeholder Placeholder

Example#

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
"version": "2.0",
"method": "document.documents.read",
"params": {
    "apikey": "h3md6u3y",
    "language": "en",
    "docID": 1337
},
"id": 1
}

```json { "id": 1, "jsonrpc": "2.0", "result": {

1
2
3
  }
}
```

document.documents.delete#

Key JSON data typ Required Description
delete Integer Yes Document identifier, for example: 1

WIP

Response parameters#

JSON key result contains an array of JSON objects. Each object contains a search result.

Key JSON data type Description
Placeholder Placeholder Placeholder
Placeholder Placeholder Placeholder

Example#

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
    "version": "2.0",
    "method": "document.documents.read",
    "params": {
        "apikey": "h3md6u3y",
        "language": "en",
        "docID": 1337
    },
    "id": 1
}

1
2
3
4
5
6
7
8
{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "message": "Document successfully deleted.",
        "success": true
    }
}