Document API
JSON API esetén minden kérésnél igazak a következők:
- Az authToken URL paraméterben megadható a felhasználó authentikációs tokenje.
- Az userName URL paraméterben megadható a felhasználó neve.
- Az X-Auth-Token fejlécben is megadható a felhasználó authentikációs tokenje.
- Az X-User-Name fejlécben is megadható a felhasználó neve.
createDocumentType
Dokumentum típus létrehozása.
Típusok
Kérés
WS, RS:
XML típus név: createDocumentTypeRequest
| Mező | Típus | Leírás |
|---|---|---|
| authenticationInfo | AuthenticationInfo_V1 | Authentikációs információ. |
| documentType | DocumentType_V1 | Dokumentum típus adatok. |
JSON API:
Válasz
WS, RS:
XML típus név: createDocumentTypeResult
| Mező | Típus | Leírás |
|---|---|---|
| status | ResponseStatus | Kérés eredménye. |
| params | ParamsType | Válasz paraméterek. |
| documentMetaData | DocumentMetaData_V1 | Dokumentum metaadatok. |
| documentVersionMetaData | DocumentVersionMetaData_V1 | Dokumentum verzió metaadatok. |
JSON API:
WS API minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.doky.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ser:createDocumentType>
<arg0>
<authenticationInfo>
<effectiveUser>user</effectiveUser>
<token>HAMMY_AUTH_TOKEN</token>
</authenticationInfo>
<documentType >
<description>Document Type 2</description>
<type>DT2</type>
</documentType>
</arg0>
</ser:createDocumentType>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://service.doky.dbx.hu/">
<ns2:createDocumentTypeResponse>
<return>
<documentType id="6">
<description>Document Type 2</description>
<type>DT2</type>
</documentType>
<status>
<code>0</code>
<messages/>
</status>
</return>
</ns2:createDocumentTypeResponse>
</S:Body>
</S:Envelope>
JSON API minta
POST /doky/json/document/v1/documentTypes?authToken={{authToken}}&userName={{userName}}
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
{
"data" : {
"type" : "documentTypes",
"id" : "DT2",
"attributes" : {
"description" : "Document Type 1"
}
}
}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "documentTypes",
"id": "DT2",
"attributes": {
"description": "Document Type 1"
}
},
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
updateDocumentType
Dokumentum típus módosítása.
Típusok
Kérés
WS, RS:
XML típus név: updateDocumentRequest
| Mező | Típus | Leírás |
|---|---|---|
| authenticationInfo | AuthenticationInfo_V1 | Authentikációs információ. |
| documentType | DocumentType_V1 |
JSON API:
Válasz
WS, RS:
XML típus név: updateDocumentResult
| Mező | Típus | Leírás |
|---|---|---|
| status | ResponseStatus | Kérés eredménye. |
| params | ParamsType | Válasz paraméterek. |
| documentMetaData | DocumentMetaData_V1 |
JSON API:
WS API minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.doky.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ser:updateDocumentType>
<!--Optional:-->
<arg0>
<authenticationInfo>
<effectiveUser>user</effectiveUser>
<token>HAMMY_AUTH_TOKEN</token>
</authenticationInfo>
<documentType id="6">
<description>Modosított description 2</description>
<!--Optional:-->
<type>DT2</type>
</documentType>
</arg0>
</ser:updateDocumentType>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://service.doky.dbx.hu/">
<ns2:updateDocumentTypeResponse>
<return>
<documentType id="6">
<description>Modosított description 2</description>
<type>DT2</type>
</documentType>
<status>
<code>0</code>
<messages/>
</status>
</return>
</ns2:updateDocumentTypeResponse>
</S:Body>
</S:Envelope>
JSON API minta
PUT /doky/json/document/v1/documentTypes?authToken={{authToken}}&userName={{userName}}
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
{
"data" : {
"type" : "documentTypes",
"id" : "DT2",
"attributes" : {
"description" : "Document Type 2"
}
}
}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "documentTypes",
"id": "DT2",
"attributes": {
"description": "Document Type 2"
}
},
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
getDocumentTypes
Dokumentum típusok lekérdezése.
Típusok
Kérés
WS, RS:
XML típus név: getDocumentTypesRequest
| Mező | Típus | Leírás |
|---|---|---|
| authenticationInfo | AuthenticationInfo_V1 | Authentikációs információ. |
JSON API:
Nincs a kérésnek törzse.
Válasz
WS, RS:
XML típus név: getDocumentTypesResult
| Mező | Típus | Leírás |
|---|---|---|
| status | ResponseStatus | Kérés eredménye. |
| params | ParamsType | Válasz paraméterek. |
| documentTypes | Array of DocumentType_V1 | Dokumentum típusok listája. |
JSON API:
Array of DocumentType_V1
WS API minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.doky.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ser:getDocumentTypes>
<arg0>
<authenticationInfo>
<effectiveUser>user</effectiveUser>
<token>HAMMY_AUTH_TOKEN</token>
</authenticationInfo>
</arg0>
</ser:getDocumentTypes>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://service.doky.dbx.hu/">
<ns2:getDocumentTypesResponse>
<return>
<documentTypeList>
<documentType id="3">
<description>Document Type 1</description>
<type>DT1</type>
</documentType>
<documentType id="6">
<description>Modosított description 2</description>
<type>DT2</type>
</documentType>
</documentTypeList>
<status>
<code>0</code>
<messages/>
</status>
</return>
</ns2:getDocumentTypesResponse>
</S:Body>
</S:Envelope>
JSON API minta
GET /doky/json/document/v1/documentTypes?authToken={{authToken}}&userName={{userName}}
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": [
{
"type": "documentTypes",
"id": "DT1",
"attributes": {
"description": "Document Type 1"
}
},
{
"type": "documentTypes",
"id": "DT2",
"attributes": {
"description": "Document Type 2"
}
}
],
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
deleteDocumentType
Dokumentum típus törlése.
A törléshez az azonosító XML-ek esetén id -val vagy type -pal is megadható.
Típusok
Kérés
WS, RS:
XML típus név: deleteDocumentTypeRequest
| Mező | Típus | Leírás |
|---|---|---|
| authenticationInfo | AuthenticationInfo_V1 | Authentikációs információ. |
| documentType | DocumentType_V1 |
JSON API:
Nincs a kérésnek törzse. Az URL path végén szerepel a törlendő dokumentum típus kódja.
Válasz
WS, RS:
XML típus név: deleteDocumentTypeResult
| Mező | Típus | Leírás |
|---|---|---|
| status | ResponseStatus | Kérés eredménye. |
| params | ParamsType | Válasz paraméterek. |
JSON API:
WS API minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.doky.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ser:deleteDocumentType>
<arg0>
<authenticationInfo>
<effectiveUser>user</effectiveUser>
<token>HAMMY_AUTH_TOKEN</token>
</authenticationInfo>
<documentType id="6">
<type>DT2</type>
</documentType>
</arg0>
</ser:deleteDocumentType>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://service.doky.dbx.hu/">
<ns2:deleteDocumentTypeResponse>
<return>
<status>
<code>0</code>
<messages/>
</status>
</return>
</ns2:deleteDocumentTypeResponse>
</S:Body>
</S:Envelope>
JSON API minta
DELETE /doky/json/document/v1/documentTypes/{{documentType}}?authToken={{authToken}}&userName={{userName}}
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "emptyResponse",
"id": "85898ecc-dd50-481a-9e83-bbf842256f1c",
"attributes": {}
},
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
getDocumentTypes
Dokumentum típusok lekérdezése.
Típusok
Kérés
WS, RS:
XML típus név: getDocumentTypesRequest
| Mező | Típus | Leírás |
|---|---|---|
| authenticationInfo | AuthenticationInfo_V1 | Authentikációs információ. |
JSON API:
Nincs a kérésnek törzse.
Válasz
WS, RS:
XML típus név: getDocumentTypesResult
| Mező | Típus | Leírás |
|---|---|---|
| status | ResponseStatus | Kérés eredménye. |
| params | ParamsType | Válasz paraméterek. |
| documentTypes | Array of DocumentType_V1 | Dokumentum típusok listája. |
JSON API:
Array of DocumentType_V1
WS API minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.doky.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ser:getDocumentTypes>
<arg0>
<authenticationInfo>
<effectiveUser>user</effectiveUser>
<token>HAMMY_AUTH_TOKEN</token>
</authenticationInfo>
</arg0>
</ser:getDocumentTypes>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://service.doky.dbx.hu/">
<ns2:getDocumentTypesResponse>
<return>
<documentTypeList>
<documentType id="3">
<description>Document Type 1</description>
<type>DT1</type>
</documentType>
<documentType id="6">
<description>Modosított description 2</description>
<type>DT2</type>
</documentType>
</documentTypeList>
<status>
<code>0</code>
<messages/>
</status>
</return>
</ns2:getDocumentTypesResponse>
</S:Body>
</S:Envelope>
JSON API minta
GET /doky/json/document/v1/documentTypes?authToken={{authToken}}&userName={{userName}}
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": [
{
"type": "documentTypes",
"id": "DT1",
"attributes": {
"description": "Document Type 1"
}
},
{
"type": "documentTypes",
"id": "DT2",
"attributes": {
"description": "Document Type 2"
}
}
],
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
exportDocumentTypes
Dokumentum típusok exportálása.
A WS szolgáltatás csak a Document V2-n érhető el! A szolgáltatás RPC jellegű, ezért JSON API típusok nem használhatóak hozzá! A JSON API is hagyományos JSON-öket használ.
Típusok
Kérés
WS, RS, JSON API:
XML típus név: exportDocumentTypesRequest
| Mező | Típus | Leírás |
|---|---|---|
| authenticationInfo | AuthenticationInfo_V1 | Authentikációs információ. |
| documentTypes | Array of [String] | Exportálandó dokumentum típus kódok. |
| exportProperties | Boolean | Kapcsolódó dokumnentum jellemzők exportálása? |
| exportPropertyGroups | Boolean | Kapcsolódó dokumnentum csoportok exportálása? |
Válasz
WS, RS, JSON API:
XML típus név: exportDocumentTypesResult
| Mező | Típus | Leírás |
|---|---|---|
| status | ResponseStatus | Kérés eredménye. |
| params | ParamsType | Válasz paraméterek. |
| documentTypes | DocumentTypeExportData_V1](#documenttypeexportdata_v1) | Exportált adatok. |
RS, JSON API minta
Rest kérés során az url-ben rest szerepel, és nincs verzió. JSON API esetén az url-ben json és v1 verzió szerepel.
GET /doky/[rest|json]/document[/v1]/exportDocumentTypes?documentTypes%5B%5D=MINTA&exportProperties=true&exportPropertyGroups=true&authToken={{authToken}}&userName={{userName}}
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
HTTP/1.1 200 OK
Content-Type: application/json
{
"version": "V1",
"documentTypes": [
{
"type": "MINTA",
"description": "Minta dokumentum típus"
}
],
"propertyTypes": [
{
"code": "AJANLATSZAM",
"type": "STRING",
"description": "Ajánlat azonosítója",
"searchable": true,
"constraintList": []
}
],
"propertyGroups": [
{
"name": "Nyomtatvany",
"description": "Szerződés tulajdonságok"
}
],
"documentTypePropertyTypes": [
{
"documentType": "MINTA",
"propertyType": "AJANLATSZAM",
"compulsory": true
}
],
"propertyGroupPropertyTypes": [
{
"defaultCompulsory": true,
"propertyGroupName": "Nyomtatvany",
"propertyTypeCode": "AJANLATSZAM"
}
]
}
importDocumentTypes
Dokumentum típusok importálása. Azokat az importálandó adatokat, amelyek már szerepelnek az adatbázisban átugorja, és erről figyelmeztetést ad.
A szolgáltatás RPC jellegű, ezért JSON API típusok nem használhatóak hozzá! A JSON API is hagyományos JSON-öket használ.
Típusok
Kérés
WS, RS, JSON API:
XML típus név: importDocumentTypesRequest
| Mező | Típus | Leírás |
|---|---|---|
| authenticationInfo | AuthenticationInfo_V1 | Authentikációs információ. |
| documentTypeExportData | DocumentTypeExportData_V1](#documenttypeexportdata_v1) | Exportált adatok. |
DocumentTypeExportData_V1 documentTypeExportData;
Válasz
WS, RS, JSON API:
XML típus név: importDocumentTypesResult
| Mező | Típus | Leírás |
|---|---|---|
| status | ResponseStatus | Kérés eredménye. |
| params | ParamsType | Válasz paraméterek. |
RS, JSON API minta
Rest kérés során az url-ben rest szerepel, és nincs verzió. JSON API esetén az url-ben json és v1 verzió szerepel. Mindkét esetben multipart/form-data hívást kell küldeni, ahol a data nevű partban szerepel az exportált adathalmaz.
POST /doky/[rest|json]/document[/v1]/importDocumentTypes?authToken={{authToken}}&userName={{userName}}
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
Content-Type: multipart/form-data
{
"version": "V1",
"documentTypes": [
{
"type": "MINTA",
"description": "Minta dokumentum típus"
}
],
"propertyTypes": [
{
"code": "AJANLATSZAM",
"type": "STRING",
"description": "Ajánlat azonosítója",
"searchable": true,
"constraintList": []
}
],
"propertyGroups": [
{
"name": "Nyomtatvany",
"description": "Szerződés tulajdonságok"
}
],
"documentTypePropertyTypes": [
{
"uuid": "adcdefgh",
"documentType": "MINTA",
"propertyType": "AJANLATSZAM",
"compulsory": true
}
],
"propertyGroupPropertyTypes": [
{
"defaultCompulsory": true,
"propertyGroupName": "Nyomtatvany",
"propertyTypeCode": "AJANLATSZAM"
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": {
"code": 0,
"messages": {
"message": [
{
"severity": "WARNING",
"code": "PROPERTY_TYPE_IMPORT_SKIPPED",
"description": "A %s tulajdonság típus már létezik, ezért nem került importálásra!",
"refValue": "AJANLATSZAM"
},
{
"severity": "WARNING",
"code": "PROPERTY_GROUP_IMPORT_NOT_SUPPORTED",
"description": "A tulajdonság csoportok importálása nem támogatott, ezért a %s tulajdonság csoport sem került importálásra!",
"refValue": "Nyomtatvany"
},
{
"severity": "WARNING",
"code": "PROPERTY_GROUP_PROPERTY_TYPE_IMPORT_NOT_SUPPORTED",
"description": "A tulajdonság csoport - tulajdonság típus kapcsolatok importálása nem támogatott, ezért a %s kapcsolat sem került importálásra!",
"refValue": "(Nyomtatvany - AJANLATSZAM)"
}
]
}
}
}
createDocumentTypeHierarchyNode
Dokumentum típus hierarchia csomópont létrehozása
Típusok
Kérés
WS, RS:
XML típus név: createDocumentTypeHierarchyNodeRequest
| Mező | Típus | Leírás |
|---|---|---|
| authenticationInfo | AuthenticationInfo_V1 | Authentikációs információ. |
| documentTypeHierarchyNode | DocumentTypeHierarchyNode_V1 | Dokumentum hierarchia csomópont. |
JSON API:
Válasz
WS, RS:
XML típus név: createDocumentTypeHierarchyNodeResult
| Mező | Típus | Leírás |
|---|---|---|
| status | ResponseStatus | Kérés eredménye. |
| params | ParamsType | Válasz paraméterek. |
| documentTypeHierarchyNode | DocumentTypeHierarchyNode_V1 | Dokumentum hierarchia csomópont. |
JSON API:
WS API minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.doky.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ser:createDocumentTypeHierarchyNode>
<arg0>
<authenticationInfo>
<effectiveUser>user</effectiveUser>
<token>HAMMY_AUTH_TOKEN</token>
</authenticationInfo>
<documentTypeHierarchyNode parentId="2">
<title>Minta kapcsolat</title>
</documentTypeHierarchyNode>
</arg0>
</ser:createDocumentTypeHierarchyNode>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://service.doky.dbx.hu/">
<ns2:createDocumentTypeHierarchyNodeResponse>
<return>
<status>
<code>0</code>
<messages/>
</status>
</return>
</ns2:createDocumentTypeHierarchyNodeResponse>
</S:Body>
</S:Envelope>
JSON API minta
POST /doky/json/document/v1/documentTypeHierarchyNodes?authToken={{authToken}}&userName={{userName}}
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
{
"data" : {
"type" : "documentTypeHierarchyNodes",
"id" : "a9effcb2-25b9-40cc-8124-18acf5b1ea72",
"attributes" : {
"title" : "A node"
}
}
}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "documentTypeHierarchyNodes",
"id": "a9effcb2-25b9-40cc-8124-18acf5b1ea72",
"attributes": {
"childUuids": [],
"title": "A node",
"children": []
},
"relationships": {
"documentTypeHierarchyAssociations": {
"data": []
}
}
},
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
updateDocumentTypeHierarchyNode
Dokumentum típus hierarchia csomópont módosítása.
Nem módosítja, de visszaadja az asszociációt! Azok létrehozására és törlésére külön szolgáltatások vannak!
Típusok
Kérés
WS, RS:
XML típus név: updateDocumentTypeHierarchyNodeRequest
| Mező | Típus | Leírás |
|---|---|---|
| authenticationInfo | AuthenticationInfo_V1 | Authentikációs információ. |
| documentTypeHierarchyNode | DocumentTypeHierarchyNode_V1 | Dokumentum hierarchia csomópont. |
JSON API:
Válasz
WS, RS:
XML típus név: updateDocumentTypeHierarchyNodeResult
| Mező | Típus | Leírás |
|---|---|---|
| status | ResponseStatus | Kérés eredménye. |
| params | ParamsType | Válasz paraméterek. |
| documentTypeHierarchyNode | DocumentTypeHierarchyNode_V1 | Dokumentum hierarchia csomópont. |
JSON API:
WS API minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.doky.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ser:updateDocumentTypeHierarchyNode>
<arg0>
<authenticationInfo>
<effectiveUser>user</effectiveUser>
<token>HAMMY_AUTH_TOKEN</token>
</authenticationInfo>
<documentTypeHierarchyNode id="5" parentId="2">
<title>Modosított node cím</title>
</documentTypeHierarchyNode>
</arg0>
</ser:updateDocumentTypeHierarchyNode>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://service.doky.dbx.hu/">
<ns2:updateDocumentTypeHierarchyNodeResponse>
<return>
<status>
<code>0</code>
<messages/>
</status>
</return>
</ns2:updateDocumentTypeHierarchyNodeResponse>
</S:Body>
</S:Envelope>
JSON API minta
PUT /doky/json/document/v1/documentTypeHierarchyNodes?authToken={{authToken}}&userName={{userName}}
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
{
"data" : {
"type" : "documentTypeHierarchyNodes",
"id" : "a9effcb2-25b9-40cc-8124-18acf5b1ea72",
"attributes" : {
"title" : "AP node"
}
}
}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "documentTypeHierarchyNodes",
"id": "a9effcb2-25b9-40cc-8124-18acf5b1ea72",
"attributes": {
"childUuids": [],
"title": "AP node",
"children": []
},
"relationships": {
"documentTypeHierarchyAssociations": {
"data": [
{
"type": "documentTypeHierarchyAssociations",
"id": "13847b2c-34e4-4ae7-a0b1-6ef12e9c1fcc"
}
]
}
}
},
"included": [
{
"type": "documentTypeHierarchyAssociations",
"id": "13847b2c-34e4-4ae7-a0b1-6ef12e9c1fcc",
"attributes": {
"hierarchyNodeUuid": "a9effcb2-25b9-40cc-8124-18acf5b1ea72",
"documentTypeCode": "DT1"
}
}
],
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
getDocumentTypeHierarchyNode
Dokumentum típus hierarchia csomópontok lekérdezése
Típusok
Kérés
WS, RS:
XML típus név: getDocumentTypeHierarchyRequest
| Mező | Típus | Leírás |
|---|---|---|
| authenticationInfo | AuthenticationInfo_V1 | Authentikációs információ. |
JSON API:
Nincs a kérésnek törzse.
Válasz
WS, RS:
XML típus név: getDocumentTypeHierarchyResult
| Mező | Típus | Leírás |
|---|---|---|
| status | ResponseStatus | Kérés eredménye. |
| params | ParamsType | Válasz paraméterek. |
| documentTypeHierarchyNodes | Array of DocumentTypeHierarchyNode_V1 | Dokumentum hierarchia csomópont. |
JSON API:
Array of DocumentTypeHierarchyNode_V1
WS API minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.doky.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ser:getDocumentTypeHierarchies>
<arg0>
<authenticationInfo>
<effectiveUser>user</effectiveUser>
<token>HAMMY_AUTH_TOKEN</token>
</authenticationInfo>
</arg0>
</ser:getDocumentTypeHierarchies>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://service.doky.dbx.hu/">
<ns2:getDocumentTypeHierarchiesResponse>
<return>
<documentTypeHierarchyNodes>
<documentTypeHierarchyNode id="2">
<associations/>
<children>
<child>5</child>
</children>
<title>AP node</title>
</documentTypeHierarchyNode>
<documentTypeHierarchyNode id="7" parentId="5">
<associations/>
<children/>
<title>Levél</title>
</documentTypeHierarchyNode>
<documentTypeHierarchyNode id="5" parentId="2">
<associations>
<association id="9">
<documentTypeCode>DT3</documentTypeCode>
<hierarchyNodeId>5</hierarchyNodeId>
</association>
</associations>
<children>
<child>7</child>
</children>
<title>Modosított node cím</title>
</documentTypeHierarchyNode>
</documentTypeHierarchyNodes>
<status>
<code>0</code>
<messages/>
</status>
</return>
</ns2:getDocumentTypeHierarchiesResponse>
</S:Body>
</S:Envelope>
JSON API minta
GET /doky/json/document/v1/documentTypeHierarchyNodes?authToken={{authToken}}&userName={{userName}}
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": [
{
"type": "documentTypeHierarchyNodes",
"id": "a9effcb2-25b9-40cc-8124-18acf5b1ea72",
"attributes": {
"childUuids": [],
"title": "A node",
"children": []
},
"relationships": {
"documentTypeHierarchyAssociations": {
"data": [
{
"type": "documentTypeHierarchyAssociations",
"id": "13847b2c-34e4-4ae7-a0b1-6ef12e9c1fcc"
}
]
}
}
}
],
"included": [
{
"type": "documentTypeHierarchyAssociations",
"id": "13847b2c-34e4-4ae7-a0b1-6ef12e9c1fcc",
"attributes": {
"hierarchyNodeUuid": "a9effcb2-25b9-40cc-8124-18acf5b1ea72",
"documentTypeCode": "DT1"
}
}
],
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
deleteDocumentTypeHierarchyNode
Dokumentum típus hierarchia csomópont törlése
Típusok
Kérés
WS, RS:
XML típus név: deleteDocumentTypeHierarchyNodeRequest
| Mező | Típus | Leírás |
|---|---|---|
| authenticationInfo | AuthenticationInfo_V1 | Authentikációs információ. |
| documentTypeHierarchyNode | DocumentTypeHierarchyNode_V1 | Dokumentum hierarchia csomópont. |
JSON API:
Nincs a kérésnek törzse. Az URL path végén szerepel a törlendő dokumentum hierarchia csomópont UUID.
Válasz
WS, RS:
XML típus név: deleteDocumentTypeHierarchyNodeResult
| Mező | Típus | Leírás |
|---|---|---|
| status | ResponseStatus | Kérés eredménye. |
| params | ParamsType | Válasz paraméterek. |
JSON API:
WS API minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.doky.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ser:deleteDocumentTypeHierarchyNode>
<!--Optional:-->
<arg0>
<authenticationInfo>
<effectiveUser>user</effectiveUser>
<token>HAMMY_AUTH_TOKEN</token>
</authenticationInfo>
<documentTypeHierarchyNode id="6">
</documentTypeHierarchyNode>
</arg0>
</ser:deleteDocumentTypeHierarchyNode>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://service.doky.dbx.hu/">
<ns2:deleteDocumentTypeHierarchyNodeResponse>
<return>
<status>
<code>0</code>
<messages/>
</status>
</return>
</ns2:deleteDocumentTypeHierarchyNodeResponse>
</S:Body>
</S:Envelope>
JSON API minta
DELETE /doky/json/document/v1/documentTypeHierarchyNodes/{{documentTypeHierarchyNodeUuid}}?authToken={{authToken}}&userName={{userName}}
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "emptyResponse",
"id": "85898ecc-dd50-481a-9e83-bbf842256f1c",
"attributes": {}
},
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
createDocumentTypeHierarchyAssociation
Dokumentum típus hierarchia asszociáció létrehozása
Típusok
Kérés
WS, RS:
XML típus név: createDocumentTypeHierarchyAssociationRequest
| Mező | Típus | Leírás |
|---|---|---|
| authenticationInfo | AuthenticationInfo_V1 | Authentikációs információ. |
| documentTypeHierarchyAssociation | DocumentTypeHierarchyAssociation_V1 | Dokumentum típus hierarchia asszociáció. |
JSON API:
DocumentTypeHierarchyAssociation_V1
Válasz
WS, RS:
XML típus név: createDocumentTypeHierarchyAssociationResult
| Mező | Típus | Leírás |
|---|---|---|
| status | ResponseStatus | Kérés eredménye. |
| params | ParamsType | Válasz paraméterek. |
| documentTypeHierarchyAssociation | DocumentTypeHierarchyAssociation_V1 | Dokumentum típus hierarchia asszociáció. |
JSON API:
DocumentTypeHierarchyAssociation_V1
WS API minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.doky.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ser:createDocumentTypeHierarchyAssociation>
<arg0>
<authenticationInfo>
<effectiveUser>user</effectiveUser>
<token>HAMMY_AUTH_TOKEN</token>
</authenticationInfo>
<documentTypeHierarchyAssociation>
<documentTypeCode>DT3</documentTypeCode>
<hierarchyNodeId>5</hierarchyNodeId>
</documentTypeHierarchyAssociation>
</arg0>
</ser:createDocumentTypeHierarchyAssociation>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://service.doky.dbx.hu/">
<ns2:createDocumentTypeHierarchyAssociationResponse>
<return>
<documentTypeHierarchyAssociation id="9">
<documentTypeCode>DT3</documentTypeCode>
<hierarchyNodeId>5</hierarchyNodeId>
</documentTypeHierarchyAssociation>
<status>
<code>0</code>
<messages/>
</status>
</return>
</ns2:createDocumentTypeHierarchyAssociationResponse>
</S:Body>
</S:Envelope>
JSON API minta
POST /doky/json/document/v1/documentTypeHierarchyAssociations?authToken={{authToken}}&userName={{userName}}
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
{
"data" : {
"type" : "documentTypeHierarchyAssociations",
"id" : "03b722d0-73cf-4777-bac6-2857b72e5719",
"attributes" : {
"documentTypeCode" : "DT1",
"hierarchyNodeUuid" : "a9effcb2-25b9-40cc-8124-18acf5b1ea72"
}
}
}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "documentTypeHierarchyAssociations",
"id": "03b722d0-73cf-4777-bac6-2857b72e5719",
"attributes": {
"hierarchyNodeUuid": "a9effcb2-25b9-40cc-8124-18acf5b1ea72",
"documentTypeCode": "DT1"
}
},
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
deleteDocumentTypeHierarchyAssociation
Dokumentum típus hierarchia asszociáció törlése
Típusok
Kérés
WS, RS:
XML típus név: deleteDocumentTypeHierarchyAssociationRequest
| Mező | Típus | Leírás |
|---|---|---|
| authenticationInfo | AuthenticationInfo_V1 | Authentikációs információ. |
| documentTypeHierarchyAssociation | DocumentTypeHierarchyAssociation_V1 | Dokumentum típus hierarchia asszociáció. |
JSON API:
Nincs a kérésnek törzse. Az URL path végén szerepel a törlendő dokumentum hierarchia asszociáció UUID-ja.
Válasz
WS, RS:
XML típus név: deleteDocumentTypeHierarchyAssociationResult
| Mező | Típus | Leírás |
|---|---|---|
| status | ResponseStatus | Kérés eredménye. |
| params | ParamsType | Válasz paraméterek. |
JSON API:
WS API minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.doky.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ser:deleteDocumentTypeHierarchyAssociation>
<arg0>
<authenticationInfo>
<effectiveUser>user</effectiveUser>
<token>HAMMY_AUTH_TOKEN</token>
</authenticationInfo>
<documentTypeHierarchyAssociation id="9">
</documentTypeHierarchyAssociation>
</arg0>
</ser:deleteDocumentTypeHierarchyAssociation>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://service.doky.dbx.hu/">
<ns2:deleteDocumentTypeHierarchyAssociationResponse>
<return>
<status>
<code>0</code>
<messages/>
</status>
</return>
</ns2:deleteDocumentTypeHierarchyAssociationResponse>
</S:Body>
</S:Envelope>
JSON API minta
DELETE /doky/json/document/v1/documentTypeHierarchyAssociations/{{documentTypeHierarchyAssociationUuid}}?authToken={{authToken}}&userName={{userName}}
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "emptyResponse",
"id": "e407c601-6593-42e2-b9fa-1a96d3ba04d5",
"attributes": {}
},
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
createPropertyType
Dokumentum tulajdonság típus létrehozása.
Típusok
Kérés
WS, RS:
XML típus név: createPropertyTypeRequest
| Mező | Típus | Leírás |
|---|---|---|
| authenticationInfo | AuthenticationInfo_V1 | Authentikációs információ. |
| propertyType | PropertyType_V1 | Tulajdonság típus adatai. |
JSON API:
Válasz
WS, RS:
XML típus név: createPropertyTypeResult
| Mező | Típus | Leírás |
|---|---|---|
| status | ResponseStatus | Kérés eredménye. |
| params | ParamsType | Válasz paraméterek. |
| propertyType | PropertyType_V1 | Tulajdonság típus adatai. |
JSON API:
WS API minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.doky.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ser:createPropertyType>
<arg0>
<authenticationInfo>
<effectiveUser>user</effectiveUser>
<token>HAMMY_AUTH_TOKEN</token>
</authenticationInfo>
<propertyType>
<code>PT10</code>
<compulsory>false</compulsory>
<description>Property Type 1</description>
<searchable>true</searchable>
<type>INTEGER</type>
</propertyType>
</arg0>
</ser:createPropertyType>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://service.doky.dbx.hu/">
<ns2:createPropertyTypeResponse>
<return>
<propertyType id="12">
<code>PT10</code>
<constraintList/>
<description>Property Type 1</description>
<searchable>true</searchable>
<type>INTEGER</type>
</propertyType>
<status>
<code>0</code>
<messages/>
</status>
</return>
</ns2:createPropertyTypeResponse>
</S:Body>
</S:Envelope>
JSON API minta
POST /doky/json/document/v1/documentPropertyTypes?authToken={{authToken}}&userName={{userName}}
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
{
"data" : {
"type" : "documentPropertyTypes",
"id" : "PT1",
"attributes" : {
"type" : "INTEGER",
"description" : "Property Type 1",
"searchable" : true,
"compulsory" : false
}
}
}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "documentPropertyTypes",
"id": "PT1",
"attributes": {
"type": "INTEGER",
"description": "Property Type 1",
"searchable": true,
"constraintList": []
}
},
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
updatePropertyType
Dokumentum tulajdonság típus módosítása.
Típusok
Kérés
WS, RS:
XML típus név: updatePropertyTypeRequest
| Mező | Típus | Leírás |
|---|---|---|
| authenticationInfo | AuthenticationInfo_V1 | Authentikációs információ. |
| propertyType | PropertyType_V1 | Tulajdonság típus adatai. |
JSON API:
Válasz
WS, RS:
XML típus név: updatePropertyTypeResult
| Mező | Típus | Leírás |
|---|---|---|
| status | ResponseStatus | Kérés eredménye. |
| params | ParamsType | Válasz paraméterek. |
| propertyType | PropertyType_V1 | Tulajdonság típus adatai. |
JSON API:
WS API minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.doky.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ser:updatePropertyType>
<arg0>
<authenticationInfo>
<effectiveUser>user</effectiveUser>
<token>HAMMY_AUTH_TOKEN</token>
</authenticationInfo>
<propertyType id="12">
<code>PT10</code>
<constraintList/>
<description>Property Type 10</description>
<searchable>true</searchable>
<type>INTEGER</type>
</propertyType>
</arg0>
</ser:updatePropertyType>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://service.doky.dbx.hu/">
<ns2:updatePropertyTypeResponse>
<return>
<propertyType id="12">
<code>PT10</code>
<constraintList/>
<description>Property Type 10</description>
<searchable>true</searchable>
<type>INTEGER</type>
</propertyType>
<status>
<code>0</code>
<messages/>
</status>
</return>
</ns2:updatePropertyTypeResponse>
</S:Body>
</S:Envelope>
JSON API minta
PUT /doky/json/document/v1/documentPropertyTypes?authToken={{authToken}}&userName={{userName}}
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
{
"data": {
"type": "documentPropertyTypes",
"id": "PT1",
"attributes": {
"type": "INTEGER",
"description": "Property Type 1",
"searchable": false,
"constraintList": []
}
},
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "documentPropertyTypes",
"id": "PT1",
"attributes": {
"type": "INTEGER",
"description": "Property Type 1",
"searchable": false,
"constraintList": []
}
},
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
getPropertyTypes
Dokumentum tulajdonság típusok lekérdezése. A JSON API esetén a keresési paraméterek jQuery url paraméter szerializációval adhatóak meg. A kérésnek nincs törzse.
Típusok
Kérés
WS, RS, JSON API:
XML típus név: getPropertyTypesRequest
| Mező | Típus | Leírás | Média típus |
|---|---|---|---|
| authenticationInfo | AuthenticationInfo_V1 | Authentikációs információ. | xml, json |
| propertyGroup | String | Szűrés tulajdonság csoportra. | |
| documentType | String | Szűrés dokumentum típusra. |
Válasz
WS, RS:
XML típus név: getPropertyTypesResult
| Mező | Típus | Leírás |
|---|---|---|
| status | ResponseStatus | Kérés eredménye. |
| params | ParamsType | Válasz paraméterek. |
| propertyTypes | Array of PropertyType_V1 | Tulajdonság típusok listája. |
JSON API:
Array of PropertyType_V1
WS API minta
A kérésben a documentType és a propertyGroup paraméterek ugyan együtt szerepelnek, de valójában nem adhatóak meg egyszerre.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.doky.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ser:getPropertyTypes>
<arg0>
<authenticationInfo>
<effectiveUser>user</effectiveUser>
<token>HAMMY_AUTH_TOKEN</token>
</authenticationInfo>
<documentType>DT1</documentType>
<propertyGroup>PG1</propertyGroup>
</arg0>
</ser:getPropertyTypes>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://service.doky.dbx.hu/">
<ns2:getPropertyTypesResponse>
<return>
<propertyTypeList>
<propertyType id="5">
<code>EMAIL_CIM</code>
<constraintList>
<constraint id="6">
<errorMsg>Nem szabványos email cím</errorMsg>
<type>REGEXP</type>
<value>^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,4}$</value>
</constraint>
</constraintList>
<description>Email cím</description>
<searchable>true</searchable>
<type>STRING</type>
</propertyType>
<propertyType id="13">
<code>PT1</code>
<constraintList/>
<description>Property Type 1</description>
<searchable>false</searchable>
<type>INTEGER</type>
</propertyType>
<propertyType id="12">
<code>PT10</code>
<constraintList/>
<description>Property Type 10</description>
<searchable>true</searchable>
<type>INTEGER</type>
</propertyType>
</propertyTypeList>
<status>
<code>0</code>
<messages/>
</status>
</return>
</ns2:getPropertyTypesResponse>
</S:Body>
</S:Envelope>
JSON API minta
A kérésben a documentType és a propertyGroup paraméterek ugyan együtt szerepelnek, de valójában nem adhatóak meg egyszerre.
GET /doky/json/document/v1/documentPropertyTypes?propertyGroup=PG1&documentType=DT1&authToken=alma&userName=korte
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": [
{
"type": "documentPropertyTypes",
"id": "EMAIL_CIM",
"attributes": {
"type": "STRING",
"description": "Email c\ufffdm",
"searchable": true,
"constraintList": [
{
"type": "REGEXP",
"value": "^[A-Z0-9._%+-]+@[A-Z0-9.-]+\\.[A-Z]{2,4}$",
"errorMsg": "Nem szabv\ufffdnyos email c\ufffdm"
}
]
}
},
{
"type": "documentPropertyTypes",
"id": "PT1",
"attributes": {
"type": "INTEGER",
"description": "Property Type 1",
"searchable": false,
"constraintList": []
}
},
{
"type": "documentPropertyTypes",
"id": "PT10",
"attributes": {
"type": "INTEGER",
"description": "Property Type 10",
"searchable": true,
"constraintList": []
}
}
],
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
deletePropertyType
Dokumentum tulajdonság típus törlése.
Típusok
Kérés
WS, RS:
A propertyType mezőben csak az id-t kell kitölteni.
XML típus név: deletePropertyTypeRequest
| Mező | Típus | Leírás |
|---|---|---|
| authenticationInfo | AuthenticationInfo_V1 | Authentikációs információ. |
| propertyType | PropertyType_V1 | Tulajdonság típus adatai. |
JSON API:
Nincs a kérésnek törzse. Az URL path végén szerepel a törlendő dokumentum tulajdonság típus kódja.
Válasz
WS, RS:
XML típus név: deletePropertyTypeResult
| Mező | Típus | Leírás |
|---|---|---|
| status | ResponseStatus | Kérés eredménye. |
| params | ParamsType | Válasz paraméterek. |
JSON API:
WS API minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.doky.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ser:deletePropertyType>
<arg0>
<authenticationInfo>
<effectiveUser>user</effectiveUser>
<token>HAMMY_AUTH_TOKEN</token>
</authenticationInfo>
<propertyType id="12"/>
</arg0>
</ser:deletePropertyType>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://service.doky.dbx.hu/">
<ns2:deletePropertyTypeResponse>
<return>
<status>
<code>0</code>
<messages/>
</status>
</return>
</ns2:deletePropertyTypeResponse>
</S:Body>
</S:Envelope>
JSON API minta
DELETE doky/json/document/v1/documentPropertyTypes/PT1?authToken={{authToken}}&userName={{userName}}
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "emptyResponse",
"id": "5265f8e4-f171-4d21-b9fe-bf8910a89d26",
"attributes": {}
},
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
getDocumentPropertyGroups
Dokumentum tulajdonság csoportok lekérdezése
Típusok
Kérés
WS, RS:
XML típus név: getPropertyGroupsRequest
| Mező | Típus | Leírás |
|---|---|---|
| authenticationInfo | AuthenticationInfo_V1 | Authentikációs információ. |
JSON API:
Nincs a kérésnek törzse.
Válasz
WS, RS:
XML típus név: getPropertyGroupsResult
| Mező | Típus | Leírás |
|---|---|---|
| status | ResponseStatus | Kérés eredménye. |
| params | ParamsType | Válasz paraméterek. |
| propertyGroups | Array of PropertyGroup_V1 | Dokumentum tulajdonság csoportoklistája. |
JSON API:
Array of PropertyGroup_V1
WS API minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.doky.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ser:getPropertyGroups>
<arg0>
<authenticationInfo>
<effectiveUser>user</effectiveUser>
<token>HAMMY_AUTH_TOKEN</token>
</authenticationInfo>
</arg0>
</ser:getPropertyGroups>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://service.doky.dbx.hu/">
<ns2:getPropertyGroupsResponse>
<return>
<propertyGroupList>
<propertyGroup id="1">
<description>Nyomtatvánnyal kapcsolatos tulajdonságok</description>
<name>Nyomtatvany</name>
</propertyGroup>
<propertyGroup id="2">
<description>Kommunikációval kapcsolatos tulajdonságok</description>
<name>Kommunikacio</name>
</propertyGroup>
<propertyGroup id="3">
<description>Hammy-vel kapcsolatos tulajdonságok</description>
<name>Hammy</name>
</propertyGroup>
</propertyGroupList>
<status>
<code>0</code>
<messages/>
</status>
</return>
</ns2:getPropertyGroupsResponse>
</S:Body>
</S:Envelope>
JSON API minta
GET /doky/json/document/v1/documentPropertyGroups?authToken={{authToken}}&userName={{userName}}
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": [
{
"type": "documentPropertyGroups",
"id": "Nyomtatvany",
"attributes": {
"description": "Nyomtatv\ufffdnnyal kapcsolatos tulajdonságok"
}
},
{
"type": "documentPropertyGroups",
"id": "Kommunikacio",
"attributes": {
"description": "Kommunik\ufffdci\ufffdval kapcsolatos tulajdonságok"
}
},
{
"type": "documentPropertyGroups",
"id": "Hammy",
"attributes": {
"description": "Hammy-vel kapcsolatos tulajdonságok"
}
}
],
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
createDocumentTypePropertyType
Dokumentum típus - Dokumentum tulajdonság típus kapcsolat léterhozása
Típusok
Kérés
WS, RS:
XML típus név: createDocumentTypePropertyTypeRequest
| Mező | Típus | Leírás |
|---|---|---|
| authenticationInfo | AuthenticationInfo_V1 | Authentikációs információ. |
| documentTypePropertyType | DocumentTypePropertyType_V1 | Kapcsolat adatok. |
JSON API:
Válasz
WS, RS:
XML típus név:
| Mező | Típus | Leírás |
|---|---|---|
| status | ResponseStatus | Kérés eredménye. |
| params | ParamsType | Válasz paraméterek. |
| documentTypePropertyType | DocumentTypePropertyType_V1 | Kapcsolat adatok. |
JSON API:
WS API minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.doky.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ser:createDocumentTypePropertyType>
<arg0>
<authenticationInfo>
<effectiveUser>user</effectiveUser>
<token>HAMMY_AUTH_TOKEN</token>
</authenticationInfo>
<documentTypePropertyType>
<compulsory>false</compulsory>
<documentType>DT1</documentType>
<propertyType>EMAIL_CIM</propertyType>
</documentTypePropertyType>
</arg0>
</ser:createDocumentTypePropertyType>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://service.doky.dbx.hu/">
<ns2:createDocumentTypePropertyTypeResponse>
<return>
<documentTypePropertyType id="2">
<compulsory>false</compulsory>
<documentType>DT1</documentType>
<propertyType>EMAIL_CIM</propertyType>
</documentTypePropertyType>
<status>
<code>0</code>
<messages/>
</status>
</return>
</ns2:createDocumentTypePropertyTypeResponse>
</S:Body>
</S:Envelope>
JSON API minta
POST /doky/json/document/v1/documentTypePropertyTypes/documentTypePropertyTypes?authToken={{authToken}}&userName={{userName}}
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
{
"data" : {
"type" : "documentTypePropertyTypes",
"id" : "b988a044-96c8-4f83-acec-84d2880b7c97",
"attributes" : {
"documentType" : "DT1",
"propertyType" : "EMAIL_CIM",
"compulsory" : false
}
}
}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "documentTypePropertyTypes",
"id": "d2427d11-3453-4e02-9a32-7c4b2a90f626",
"attributes": {
"documentType": "DT1",
"propertyType": "EMAIL_CIM",
"compulsory": false
}
},
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
getDocumentTypePropertyTypes
Dokumentum típus - Dokumentum tulajdonság típus kapcsolatok lekérdezése
A JSON API esetén a keresési paraméterek jQuery url paramaéter szerializációval adhatóak meg. A kérésnek nincs törzse.
Típusok
Kérés
WS, RS, JSON API:
XML típus név: getDocumentTypePropertyTypesRequest
| Mező | Típus | Leírás | Média típus |
|---|---|---|---|
| authenticationInfo | AuthenticationInfo_V1 | Authentikációs információ. | xml, json |
Válasz
WS, RS:
XML típus név: getDocumentTypePropertyTypesResult
| Mező | Típus | Leírás |
|---|---|---|
| status | ResponseStatus | Kérés eredménye. |
| params | ParamsType | Válasz paraméterek. |
| documentTypePropertyTypeList | Array of DocumentTypePropertyType_V1 | Kapcsolati adatok listája. |
JSON API:
Array of DocumentTypePropertyType_V1
WS API minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.doky.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ser:getDocumentTypePropertyTypes>
<arg0>
<authenticationInfo>
<effectiveUser>user</effectiveUser>
<token>HAMMY_AUTH_TOKEN</token>
</authenticationInfo>
</arg0>
</ser:getDocumentTypePropertyTypes>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://service.doky.dbx.hu/">
<ns2:getDocumentTypePropertyTypesResponse>
<return>
<documentTypePropertyTypeList>
<documentTypePropertyType id="2">
<compulsory>false</compulsory>
<documentType>DT1</documentType>
<propertyType>EMAIL_CIM</propertyType>
</documentTypePropertyType>
</documentTypePropertyTypeList>
<status>
<code>0</code>
<messages/>
</status>
</return>
</ns2:getDocumentTypePropertyTypesResponse>
</S:Body>
</S:Envelope>
JSON API minta
GET /doky/json/document/v1/documentTypePropertyTypes?authToken={{authToken}}&userName={{userName}}
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": [
{
"type": "documentTypePropertyTypes",
"id": "d2427d11-3453-4e02-9a32-7c4b2a90f626",
"attributes": {
"documentType": "DT1",
"propertyType": "EMAIL_CIM",
"compulsory": false
}
}
],
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
deleteDocumentTypePropertyType
Dokumentum típus - Dokumentum tulajdonság típus kapcsolat törlése
Típusok
Kérés
WS, RS:
A documentTypePropertyType mezőben csak az id-t kell kitölteni.
XML típus név:
| Mező | Típus | Leírás |
|---|---|---|
| authenticationInfo | AuthenticationInfo_V1 | Authentikációs információ. |
| documentTypePropertyType | DocumentTypePropertyType_V1 | Kapcsolat adatok. |
JSON API:
Nincs a kérésnek törzse. Az URL path végén szerepel a kapcsolat UUID-ja.
Válasz
WS, RS:
XML típus név:
| Mező | Típus | Leírás |
|---|---|---|
| status | ResponseStatus | Kérés eredménye. |
| params | ParamsType | Válasz paraméterek. |
| documentMetaData | DocumentMetaData_V1 |
JSON API:
WS API minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.doky.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ser:deleteDocumentTypePropertyType>
<arg0>
<authenticationInfo>
<effectiveUser>user</effectiveUser>
<token>HAMMY_AUTH_TOKEN</token>
</authenticationInfo>
<documentTypePropertyType id="2"/>
</arg0>
</ser:deleteDocumentTypePropertyType>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://service.doky.dbx.hu/">
<ns2:deleteDocumentTypePropertyTypeResponse>
<return>
<status>
<code>0</code>
<messages/>
</status>
</return>
</ns2:deleteDocumentTypePropertyTypeResponse>
</S:Body>
</S:Envelope>
JSON API minta
POST /doky/json/document/v1/documentTypePropertyTypes/d2427d11-3453-4e02-9a32-7c4b2a90f626?authToken={{authToken}}&userName={{userName}}
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
{
"data": {
"type": "emptyResponse",
"id": "cfb7277c-8077-4335-aeb9-106b2fdac547",
"attributes": {}
},
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{}
createDocument
Dokumentum létrehozása.
WS és RS esetén lehetőség van dokumentum dokuemntum verzió azonnali létrehozására is. Ilyenkor vagy a content -et kell megadni, vagy a másik dokumentum(ok)ból kivágandó oldal tartományokat. (Ld. köv. bekezdés.) Ez JSON API esetén nem támogatott funkcionalitás.
WS és RS esetén lehetőség van dokumentum létrehozására másik dokumentum alapján. Ilyenkor meg kell adni a másik dokumentumból kivágandó oldal tartományokat. Ez JSON API esetén nem támogatott funkcionalitás.
Típusok
Kérés
WS, RS:
XML típus név: createDocumentRequest
| Mező | Típus | Leírás |
|---|---|---|
| authenticationInfo | AuthenticationInfo_V1 | Authentikációs információ. |
| documentMetaData | DocumentMetaData_V1 | Dokumentum metaadatok. |
| documentPageRanges | Array of DocumentPageRange_V1 | Más dokumentumból kivágandó oldalak. |
| content | Array of byte | Dokumentum tartalma. |
JSON API:
Válasz
WS, RS:
XML típus név: createDocumentResult
| Mező | Típus | Leírás |
|---|---|---|
| status | ResponseStatus | Kérés eredménye. |
| params | ParamsType | Válasz paraméterek. |
| documentMetaData | DocumentMetaData_V1 | Dokumentum (meta) adatok. |
| documentVersionMetaData | DocumentVersionMetaData_V1 | Dokumentum verzió (meta) adatok. |
JSON API:
WS API minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.doky.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ser:createDocument>
<arg0>
<authenticationInfo>
<effectiveUser>user</effectiveUser>
<token>HAMMY_AUTH_TOKEN</token>
</authenticationInfo>
<content>cid:269501879661</content>
<documentMetaData>
<companyId>ACME</companyId>
<description>DT 3 document</description>
<documentType>DT3</documentType>
<fileName>teszt.pdf</fileName>
<mimeType>application/pdf</mimeType>
<owner>Owner</owner>
<propertyList>
<property>
<propCode>EMAIL_CIM</propCode>
<value>VALAKI@VALAHOL.HU</value>
</property>
</propertyList>
<refDocumentUUIDList>
<refDocumentUUID>
<description>Relation Description 1</description>
<documentUUID>3f15c705-eb4e-49a7-8de0-75a2dd504d17</documentUUID>
<relation>REL1</relation>
</refDocumentUUID>
</refDocumentUUIDList>
</documentMetaData>
<!--<documentPageRangeList>
<documentPageRange>
<documentVersionUUID>5a7148c7-d6a1-4da6-9266-d0aa80cdf7bb</documentVersionUUID>
<fromPage>1</fromPage>
<toPage>1</toPage>
</documentPageRange>
</documentPageRangeList>-->
</arg0>
</ser:createDocument>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://service.doky.dbx.hu/">
<ns2:createDocumentResponse>
<return>
<documentMetaData>
<companyId>ACME</companyId>
<createdAt>2018-11-16T18:55:46.178+01:00</createdAt>
<createdBy>doky</createdBy>
<description>DT 3 document</description>
<documentType>DT3</documentType>
<uuid>edda69a3-b20f-450f-a608-ef0faa923a5d</uuid>
<fileName>teszt.pdf</fileName>
<mimeType>application/pdf</mimeType>
<owner>Owner</owner>
<propertyList>
<property>
<propCode>EMAIL_CIM</propCode>
<value>VALAKI@VALAHOL.HU</value>
</property>
<property>
<propCode>@READ_ONLY</propCode>
<value>N</value>
</property>
<property>
<propCode>@ASSEMBLED</propCode>
<value>N</value>
</property>
</propertyList>
<refDocumentUUIDList>
<refDocumentUUID>
<description>Relation Description 1</description>
<documentUUID>3f15c705-eb4e-49a7-8de0-75a2dd504d17</documentUUID>
<relation>REL1</relation>
</refDocumentUUID>
</refDocumentUUIDList>
</documentMetaData>
<documentVersionMetaData>
<createdAt>2018-11-16T18:55:46.204+01:00</createdAt>
<createdBy>doky</createdBy>
<documentUUID>edda69a3-b20f-450f-a608-ef0faa923a5d</documentUUID>
<documentVersionUUID>49b774ba-3539-4656-8cd5-751ffb950c59</documentVersionUUID>
<fileName>teszt.pdf</fileName>
<fileSize>5903</fileSize>
<status>ACTIVE</status>
<version>1</version>
<accessAt>2018-11-16T18:55:46.204+01:00</accessAt>
<volume>xxxx</volume>
</documentVersionMetaData>
<status>
<code>0</code>
<messages/>
</status>
</return>
</ns2:createDocumentResponse>
</S:Body>
</S:Envelope>
JSON API minta
POST /doky/json/document/v1/document?authToken={{authToken}}&userName={{userName}}
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
{
"data" : {
"type" : "documents",
"id" : "5cd82c3d-321f-46d5-ae97-ca10ac72a20f",
"attributes" : {
"companyId" : "ACME",
"createdAt" : "2018-11-12T09:26:51.098+01:00",
"createdBy" : "CreatedBy",
"description" : "Szamla Description",
"documentType" : "SZAMLA",
"fileName" : "szamla.pdf",
"mimeType" : "application/pdf",
"owner" : "Owner",
"propertyList" : [ {
"propCode" : "NYOMT_IRANY",
"value" : "EMAIL"
}, {
"propCode" : "EMAIL_CIM",
"value" : "ALMA@BARACK.HU"
} ],
"refDocumentUUIDList" : [ {
"documentUUID" : "4893ea2e-3153-4785-abef-f32ef6b9f1de",
"relation" : "REL1",
"description" : "Relation Description 1"
}, {
"documentUUID" : "dddb80dd-3afc-4978-812f-c5383e939213",
"relation" : "REL2",
"description" : "Relation Description 2"
}]
}
}
}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "documents",
"id": "5cd82c3d-321f-46d5-ae97-ca10ac72a20f",
"attributes": {
"companyId": "ACME",
"createdAt": "2018-11-12T09:26:51.098+01:00",
"createdBy": "CreatedBy",
"description": "Szamla Description",
"documentType": "SZAMLA",
"uuid": "5cd82c3d-321f-46d5-ae97-ca10ac72a20f",
"fileName": "szamla.pdf",
"mimeType": "application/pdf",
"owner": "Owner",
"propertyList": [
{
"propCode": "EMAIL_CIM",
"value": "ALMA@BARACK.HU"
},
{
"propCode": "NYOMT_IRANY",
"value": "EMAIL"
},
{
"propCode": "@READ_ONLY",
"value": "N"
},
{
"propCode": "@ASSEMBLED",
"value": "N"
}
],
"refDocumentUUIDList": [
{
"documentUUID": "4893ea2e-3153-4785-abef-f32ef6b9f1de",
"relation": "REL1",
"description": "Relation Description 1"
},
{
"documentUUID": "dddb80dd-3afc-4978-812f-c5383e939213",
"relation": "REL2",
"description": "Relation Description 2"
}
]
}
},
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
updateDocument
Dokumentum módosítása.
Típusok
Kérés
WS, RS:
XML típus név: updateDocumentRequest
| Mező | Típus | Leírás |
|---|---|---|
| authenticationInfo | AuthenticationInfo_V1 | Authentikációs információ. |
| documentMetaData | DocumentMetaData_V1 | Dokumentum metaadatok. |
JSON API:
Válasz
WS, RS:
XML típus név: updateDocumentResult
| Mező | Típus | Leírás |
|---|---|---|
| status | ResponseStatus | Kérés eredménye. |
| params | ParamsType | Válasz paraméterek. |
| documentMetaData | DocumentMetaData_V1 | Dokumentum (meta) adatok. |
JSON API:
WS API minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.doky.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ser:updateDocument>
<!--Optional:-->
<arg0>
<authenticationInfo>
<effectiveUser>user</effectiveUser>
<token>HAMMY_AUTH_TOKEN</token>
</authenticationInfo>
<documentMetaData>
<companyId>ACME</companyId>
<createdAt>2018-11-16T18:55:46.178+01:00</createdAt>
<createdBy>doky</createdBy>
<description>DT 3 document - modified</description>
<documentType>DT3</documentType>
<uuid>edda69a3-b20f-450f-a608-ef0faa923a5d</uuid>
<fileName>teszt.pdf</fileName>
<mimeType>application/pdf</mimeType>
<owner>ModifiedOwner</owner>
<propertyList>
<property>
<propCode>EMAIL_CIM</propCode>
<value>VALAKI@VALAHOL.HU</value>
</property>
<property>
<propCode>@READ_ONLY</propCode>
<value>N</value>
</property>
<property>
<propCode>@ASSEMBLED</propCode>
<value>N</value>
</property>
</propertyList>
<refDocumentUUIDList>
<refDocumentUUID>
<description>Relation Description 1</description>
<documentUUID>3f15c705-eb4e-49a7-8de0-75a2dd504d17</documentUUID>
<relation>REL1</relation>
</refDocumentUUID>
</refDocumentUUIDList>
</documentMetaData>
<documentVersionMetaData>
<createdAt>2018-11-16T18:55:46.204+01:00</createdAt>
<createdBy>doky</createdBy>
<documentUUID>edda69a3-b20f-450f-a608-ef0faa923a5d</documentUUID>
<documentVersionUUID>49b774ba-3539-4656-8cd5-751ffb950c59</documentVersionUUID>
<fileName>teszt.pdf</fileName>
<fileSize>5903</fileSize>
<status>ACTIVE</status>
<version>1</version>
<accessAt>2018-11-16T18:55:46.204+01:00</accessAt>
<volume>xxxx</volume>
</documentVersionMetaData>
</arg0>
</ser:updateDocument>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://service.doky.dbx.hu/">
<ns2:updateDocumentResponse>
<return>
<documentMetaData>
<companyId>ACME</companyId>
<createdAt>2018-11-16T18:55:46.178+01:00</createdAt>
<createdBy>doky</createdBy>
<description>DT 3 document - modified</description>
<documentType>DT3</documentType>
<uuid>edda69a3-b20f-450f-a608-ef0faa923a5d</uuid>
<fileName>teszt.pdf</fileName>
<mimeType>application/pdf</mimeType>
<owner>ModifiedOwner</owner>
<propertyList>
<property>
<propCode>EMAIL_CIM</propCode>
<value>VALAKI@VALAHOL.HU</value>
</property>
<property>
<propCode>@READ_ONLY</propCode>
<value>N</value>
</property>
<property>
<propCode>@ASSEMBLED</propCode>
<value>N</value>
</property>
</propertyList>
<refDocumentUUIDList>
<refDocumentUUID>
<description>Relation Description 1</description>
<documentUUID>3f15c705-eb4e-49a7-8de0-75a2dd504d17</documentUUID>
<relation>REL1</relation>
</refDocumentUUID>
</refDocumentUUIDList>
</documentMetaData>
<status>
<code>0</code>
<messages/>
</status>
</return>
</ns2:updateDocumentResponse>
</S:Body>
</S:Envelope>
JSON API minta
PUT /doky/json/document/v1/document?authToken={{authToken}}&userName={{userName}}
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
{
"data" : {
"type" : "documents",
"id" : "5cd82c3d-321f-46d5-ae97-ca10ac72a20f",
"attributes" : {
"companyId" : "ACME",
"createdAt" : "2018-11-12T09:26:51.098+01:00",
"createdBy" : "CreatedBy",
"description" : "Modosultt Szamla Description",
"documentType" : "SZAMLA",
"fileName" : "szamla.pdf",
"mimeType" : "application/vnd.api+json",
"owner" : "Owner2",
"propertyList" : [ {
"propCode" : "NYOMT_IRANY",
"value" : "EMAIL"
}, {
"propCode" : "EMAIL_CIM",
"value" : "ALMA@BARACK.HU"
} ],
"refDocumentUUIDList" : [ {
"documentUUID" : "4893ea2e-3153-4785-abef-f32ef6b9f1de",
"relation" : "REL1",
"description" : "Relation Description 2"
}, {
"documentUUID" : "dddb80dd-3afc-4978-812f-c5383e939213",
"relation" : "REL2",
"description" : "Relation Description 2"
}]
}
}
}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "documents",
"id": "5cd82c3d-321f-46d5-ae97-ca10ac72a20f",
"attributes": {
"companyId": "ACME",
"createdAt": "2018-11-12T09:26:51.098+01:00",
"createdBy": "CreatedBy",
"description": "Modosultt Szamla Description",
"documentType": "SZAMLA",
"uuid": "5cd82c3d-321f-46d5-ae97-ca10ac72a20f",
"fileName": "szamla.pdf",
"mimeType": "application/vnd.api+json",
"owner": "Owner2",
"propertyList": [
{
"propCode": "EMAIL_CIM",
"value": "ALMA@BARACK.HU"
},
{
"propCode": "NYOMT_IRANY",
"value": "EMAIL"
},
{
"propCode": "@READ_ONLY",
"value": "N"
},
{
"propCode": "@ASSEMBLED",
"value": "N"
}
],
"refDocumentUUIDList": [
{
"documentUUID": "dddb80dd-3afc-4978-812f-c5383e939213",
"relation": "REL2",
"description": "Relation Description 2"
},
{
"documentUUID": "4893ea2e-3153-4785-abef-f32ef6b9f1de",
"relation": "REL1",
"description": "Relation Description 2"
}
]
}
},
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
addRelation
Dokumentum kapcsolat hozzáadása.
A szolgáltatás JSON API-on nem érhető el.
Típusok
Kérés
WS, RS:
XML típus név: addRelationRequest
| Mező | Típus | Leírás |
|---|---|---|
| authenticationInfo | AuthenticationInfo_V1 | Authentikációs információ. |
| uuid | String | Dokumentum UUID. |
| refDocumentUUIDs | RefDocumentUUID_V1 | Kapcsolat adatok. |
Válasz
WS, RS:
XML típus név: addRelationResult
| Mező | Típus | Leírás |
|---|---|---|
| status | ResponseStatus | Kérés eredménye. |
| params | ParamsType | Válasz paraméterek. |
| documentMetaData | DocumentMetaData_V1 | Dokumentum (meta) adatok. |
WS API minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.doky.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ser:addRelation>
<arg0>
<authenticationInfo>
<effectiveUser>user</effectiveUser>
<token>HAMMY_AUTH_TOKEN</token>
</authenticationInfo>
<uuid>e5570a8f-872c-4d9f-98ca-a3af41251964</uuid>
<refDocumentUUIDList>
<refDocumentUUID>
<description>Másolat</description>
<documentUUID>74c0ed18-90c4-4b25-8fba-fe9bd87fe8b9</documentUUID>
<relation>COPY</relation>
</refDocumentUUID>
</refDocumentUUIDList>
</arg0>
</ser:addRelation>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://service.doky.dbx.hu/">
<ns2:addRelationResponse>
<return>
<documentMetaData>
<companyId>ACME</companyId>
<createdAt>2018-11-16T18:51:36.447+01:00</createdAt>
<createdBy>doky</createdBy>
<description>DT 3 document</description>
<documentType>DT3</documentType>
<uuid>e5570a8f-872c-4d9f-98ca-a3af41251964</uuid>
<fileName>teszt.pdf</fileName>
<mimeType>application/pdf</mimeType>
<owner>Owner</owner>
<propertyList>
<property>
<propCode>EMAIL_CIM</propCode>
<value>VALAKI@VALAHOL.HU</value>
</property>
</propertyList>
<refDocumentUUIDList>
<refDocumentUUID>
<description>Másolat</description>
<documentUUID>74c0ed18-90c4-4b25-8fba-fe9bd87fe8b9</documentUUID>
<relation>COPY</relation>
</refDocumentUUID>
<refDocumentUUID>
<description>Relation Description 1</description>
<documentUUID>3f15c705-eb4e-49a7-8de0-75a2dd504d17</documentUUID>
<relation>REL1</relation>
</refDocumentUUID>
</refDocumentUUIDList>
</documentMetaData>
<status>
<code>0</code>
<messages/>
</status>
</return>
</ns2:addRelationResponse>
</S:Body>
</S:Envelope>
getDocument
Dokumentum lekérdezése.
Web Service és Rest Service hívás esetén lehetőség van a tartalom letöltése helyett csak egy arra vonatkozó url lekérdezésére. Ilyenkor a válaszba nem kerül bele a content , csak egy arra mutató url és annak az érvényességi ideje (expiration). Ez JSON API esetén nem támogatott funkcionalitás.
JSON API esetén ez egy keresés, ami lista helyett objektumot ad vissza, ha van tálálat. A keresési paraméterek jQuery url paramaéter szerializációval adhatóak meg. A kérésnek nincs törzse.
Típusok
Kérés
WS, RS, JSON API:
XML típus név: getDocumentRequest
| Mező | Típus | Leírás | Média típus |
|---|---|---|---|
| authenticationInfo | AuthenticationInfo_V1 | Authentikációs információ. | xml, json |
| documentUUID | String | Dokumentum UUID. | |
| documentVersionUUID | String | Dokumentum verzió UUID. | |
| version | Integer | Dokumentum verzió száma. | |
| inline | Boolean | A válaszban szerepljen-e a tartalom is? | |
| preview | Boolean | PDF előnézet szerepeljen-e a válaszban? |
Válasz
WS, RS:
XML típus név: getDocumentResult
| Mező | Típus | Leírás |
|---|---|---|
| status | ResponseStatus | Kérés eredménye. |
| params | ParamsType | Válasz paraméterek. |
| documentMetaData | DocumentMetaData_V1 | Dokumentum meta adatok. |
| documentVersionMetaData | DocumentVersionMetaData_V1 | Dokumentum verzió meta adatok. |
| url | String | Letöltési url. |
| expiration | Date | Letöltési url lejárati időpontja. |
| content | Array of byte | Dokumentum tartalma. |
JSON API:
DocumentMetaData_V1](#documentmetadata_v1)
WS API minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.doky.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ser:getDocument>
<arg0>
<authenticationInfo>
<effectiveUser>user</effectiveUser>
<token>HAMMY_AUTH_TOKEN</token>
</authenticationInfo>
<documentUUID>edda69a3-b20f-450f-a608-ef0faa923a5d</documentUUID>
<inline>true</inline>
<preview>false</preview>
<version>1</version>
</arg0>
</ser:getDocument>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://service.doky.dbx.hu/">
<ns2:getDocumentResponse>
<return>
<content>JVBERi0xLjcNJeLjz9MNCjE5IDAgb2JqDTw8L0xpbmVhcml6ZWQgMS9MIDU5MDMvTyAyMS9FIDEwNTMvTiAxL1QgNTU5MS9IIFsgNDQyIDE2MF0+Pg1lbmRvYmoNICAgICAgICAgICAgICAgICAgICAgDQoyNCAwIG9iag08PC9EZWNvZGVQYXJtczw8L0NvbHVtbnMgMy9QcmVkaWN0b3IgMTI+Pi9GaWx0ZXIvRmxhdGVEZWNvZGUvSURbPEE1Q0I4RjYwQkI5QTg1NDg5NjRDQzY1MTAzNTFFQzg5PjwxNDkzREY3NUEzMjc2QTQ2OUI1RTI4NjI4RjgxREE3Nj5dL0luZGV4WzE5IDhdL0luZm8gMTggMCBSL0xlbmd0aCA0MS9QcmV2IDU1OTIvUm9vdCAyMCAwIFIvU2l6ZSAyNy9UeXBlL1hSZWYvV1sxIDIgMF0+PnN0cmVhbQ0KaN5iYmQQYGJg8mJiYGhiYmDsB9KGTAx/bzAxMixm+s+4GCDAADmnBc0NCmVuZHN0cmVhbQ1lbmRvYmoNc3RhcnR4cmVmDQowDQolJUVPRg0KICAgICAgICANCjI2IDAgb2JqDTw8L0MgODAvRmlsdGVyL0ZsYXRlRGVjb2RlL0kgMTAyL0xlbmd0aCA3MC9PIDY0L1MgMzY+PnN0cmVhbQ0KaN5iYGBgZmBgsmEAAkZHBkzAwsCBxGOGYgYGQwb2PUwNYG0MDOxZEJrhNhAzMTBwuEL5z+A6WRkYJAyhol8AAgwA6m4F0w0KZW5kc3RyZWFtDWVuZG9iag0yMCAwIG9iag08PC9NZXRhZGF0YSAzIDAgUi9OYW1lcyAyNSAwIFIvT3V0bGluZXMgNyAwIFIvUGFnZXMgMTQgMCBSL1NwaWRlckluZm8gMTcgMCBSL1N0cnVjdFRyZWVSb290IDEwIDAgUi9UeXBlL0NhdGFsb2c+Pg1lbmRvYmoNMjEgMCBvYmoNPDwvQ29udGVudHMgMjIgMCBSL0Nyb3BCb3hbMC4wIDAuMCA2MTIuMCA3OTIuMF0vTWVkaWFCb3hbMC4wIDAuMCA2MTIuMCA3OTIuMF0vUGFyZW50IDE0IDAgUi9SZXNvdXJjZXM8PD4+L1JvdGF0ZSAwL1R5cGUvUGFnZT4+DWVuZG9iag0yMiAwIG9iag08PC9MZW5ndGggMD4+c3RyZWFtDQoNCmVuZHN0cmVhbQ1lbmRvYmoNMjMgMCBvYmoNPDwvRmlsdGVyL0ZsYXRlRGVjb2RlL0ZpcnN0IDUvTGVuZ3RoIDM2L04gMS9UeXBlL09ialN0bT4+c3RyZWFtDQpo3jIyVTBQsLHR93QJVjAEsYP0Q4N8gGwzENvODiDAAG50BuENCmVuZHN0cmVhbQ1lbmRvYmoNMSAwIG9iag08PC9GaWx0ZXIvRmxhdGVEZWNvZGUvRmlyc3QgMTQvTGVuZ3RoIDEyNS9OIDMvVHlwZS9PYmpTdG0+PnN0cmVhbQ0KaN4yVzBQsFAwsVQAQiMFGxt95/zSvBIFQ323zKLiEqCUgUKQvk8inBlSWZCq719akpOZl1psZwfU4AjUCpIJSCxKBeo0hyjLLMlJ1XDKSczLVghITE/VBCt1iTYyBEtHREYBaXOgjXmlOTmx+sH67vkh+XZ2AAEGAKmBJzwNCmVuZHN0cmVhbQ1lbmRvYmoNMiAwIG9iag08PC9GaWx0ZXIvRmxhdGVEZWNvZGUvRmlyc3QgMjQvTGVuZ3RoIDEzNi9OIDQvVHlwZS9PYmpTdG0+PnN0cmVhbQ0KaN40jMEKwjAQRH9l/yDZKqhQAhJvRSpNwXOMexBqE9LNoX9vtupthnlvUIMGRNifABs4HAF3tSK0rbKTX5arTzJrGFQnhIRxTaQc5xJ4zERDjGxMFVx65nPmmnp1p4f1iUsmY7axk2exb4B6C05dYihvmr+2/ftCND+i1leY6sdHgAEAnSkuhw0KZW5kc3RyZWFtDWVuZG9iag0zIDAgb2JqDTw8L0xlbmd0aCAzNTk3L1N1YnR5cGUvWE1ML1R5cGUvTWV0YWRhdGE+PnN0cmVhbQ0KPD94cGFja2V0IGJlZ2luPSLvu78iIGlkPSJXNU0wTXBDZWhpSHpyZVN6TlRjemtjOWQiPz4KPHg6eG1wbWV0YSB4bWxuczp4PSJhZG9iZTpuczptZXRhLyIgeDp4bXB0az0iQWRvYmUgWE1QIENvcmUgNS4yLWMwMDEgNjMuMTM5NDM5LCAyMDEwLzA5LzI3LTEzOjM3OjI2ICAgICAgICAiPgogICA8cmRmOlJERiB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiPgogICAgICA8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIgogICAgICAgICAgICB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iPgogICAgICAgICA8eG1wOk1vZGlmeURhdGU+MjAxNC0wMy0wNFQyMjoxMjowNiswMTowMDwveG1wOk1vZGlmeURhdGU+CiAgICAgICAgIDx4bXA6Q3JlYXRlRGF0ZT4yMDE0LTAzLTA0VDIxOjU2OjQ1KzAxOjAwPC94bXA6Q3JlYXRlRGF0ZT4KICAgICAgICAgPHhtcDpNZXRhZGF0YURhdGU+MjAxNC0wMy0wNFQyMjoxMjowNiswMTowMDwveG1wOk1ldGFkYXRhRGF0ZT4KICAgICAgICAgPHhtcDpDcmVhdG9yVG9vbD5BZG9iZSBBY3JvYmF0IDEwLjA8L3htcDpDcmVhdG9yVG9vbD4KICAgICAgPC9yZGY6RGVzY3JpcHRpb24+CiAgICAgIDxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSIiCiAgICAgICAgICAgIHhtbG5zOmRjPSJodHRwOi8vcHVybC5vcmcvZGMvZWxlbWVudHMvMS4xLyI+CiAgICAgICAgIDxkYzpmb3JtYXQ+YXBwbGljYXRpb24vcGRmPC9kYzpmb3JtYXQ+CiAgICAgICAgIDxkYzp0aXRsZT4KICAgICAgICAgICAgPHJkZjpBbHQ+CiAgICAgICAgICAgICAgIDxyZGY6bGkgeG1sOmxhbmc9IngtZGVmYXVsdCI+U2FtcGxlIEFjcm9iYXQgOC54IChQREYgVmVyc2lvbiAxLjcpPC9yZGY6bGk+CiAgICAgICAgICAgIDwvcmRmOkFsdD4KICAgICAgICAgPC9kYzp0aXRsZT4KICAgICAgICAgPGRjOmNyZWF0b3I+CiAgICAgICAgICAgIDxyZGY6QmFnLz4KICAgICAgICAgPC9kYzpjcmVhdG9yPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6eG1wTU09Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9tbS8iPgogICAgICAgICA8eG1wTU06RG9jdW1lbnRJRD51dWlkOmNjY2VlMWZjLTUxYjMtNGI1Mi1hYzg2LTY3MmFmMzk3NGQyNTwveG1wTU06RG9jdW1lbnRJRD4KICAgICAgICAgPHhtcE1NOkluc3RhbmNlSUQ+dXVpZDo3ZDE1ZDU2OS1mMjU3LTQzYmEtYmU2YS01YzJmMzY2YTUzNTY8L3htcE1NOkluc3RhbmNlSUQ+CiAgICAgIDwvcmRmOkRlc2NyaXB0aW9uPgogICAgICA8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIgogICAgICAgICAgICB4bWxuczpwZGY9Imh0dHA6Ly9ucy5hZG9iZS5jb20vcGRmLzEuMy8iPgogICAgICAgICA8cGRmOlByb2R1Y2VyPkFjcm9iYXQgV2ViIENhcHR1cmUgMTAuMDwvcGRmOlByb2R1Y2VyPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgIAo8P3hwYWNrZXQgZW5kPSJ3Ij8+DQplbmRzdHJlYW0NZW5kb2JqDTQgMCBvYmoNPDwvRmlsdGVyL0ZsYXRlRGVjb2RlL0ZpcnN0IDIzL0xlbmd0aCA3OS9OIDQvVHlwZS9PYmpTdG0+PnN0cmVhbQ0KaN4yNFEwUDA0VTA2UzA0UzABss0VTEwUbGz0nfNL80oUDPW9M1OKo40MgcqCYvVDKgtS9QMS01OL7exsbGBYP0zBUM/I1M4OIMAAz94TSw0KZW5kc3RyZWFtDWVuZG9iag01IDAgb2JqDTw8L0ZpbHRlci9GbGF0ZURlY29kZS9GaXJzdCA1L0xlbmd0aCAxNTEvTiAxL1R5cGUvT2JqU3RtPj5zdHJlYW0NCmjeXM7BCoJAFIXhV7k7Zwj03klNRARR2gVCURs3M3oXgjUyjdDjJyQF7c/3cygDhKKIasfaj/bRaM+iyRVSjHuMFSVpnOyQAsRAflbWiWqwhqHqnTXaA2GIMjrZ4R8rUph+cevssPS86s3d2ECtZ7843hqX0U8szvo+T798Fr6gE21zhCu75/oRKDx0UpblW4ABAGvwNgMNCmVuZHN0cmVhbQ1lbmRvYmoNNiAwIG9iag08PC9EZWNvZGVQYXJtczw8L0NvbHVtbnMgNC9QcmVkaWN0b3IgMTI+Pi9GaWx0ZXIvRmxhdGVEZWNvZGUvSURbPEE1Q0I4RjYwQkI5QTg1NDg5NjRDQzY1MTAzNTFFQzg5PjwxNDkzREY3NUEzMjc2QTQ2OUI1RTI4NjI4RjgxREE3Nj5dL0luZm8gMTggMCBSL0xlbmd0aCA1Ny9Sb290IDIwIDAgUi9TaXplIDE5L1R5cGUvWFJlZi9XWzEgMiAxXT4+c3RyZWFtDQpo3mJiAAImRhZZBiYGhttAgvEZkOCPAnHXgLhfgLKvNUFcBkYYwfgPhQsmmP5iijH+BQgwAKM/CC4NCmVuZHN0cmVhbQ1lbmRvYmoNc3RhcnR4cmVmDQoxMTYNCiUlRU9GDQo=</content>
<documentMetaData>
<companyId>ACME</companyId>
<createdAt>2018-11-16T18:55:46.178+01:00</createdAt>
<createdBy>doky</createdBy>
<description>DT 3 document</description>
<documentType>DT3</documentType>
<uuid>edda69a3-b20f-450f-a608-ef0faa923a5d</uuid>
<fileName>teszt.pdf</fileName>
<mimeType>application/pdf</mimeType>
<owner>Owner</owner>
<propertyList>
<property>
<propCode>EMAIL_CIM</propCode>
<value>VALAKI@VALAHOL.HU</value>
</property>
<property>
<propCode>@READ_ONLY</propCode>
<value>N</value>
</property>
<property>
<propCode>@ASSEMBLED</propCode>
<value>N</value>
</property>
</propertyList>
<refDocumentUUIDList>
<refDocumentUUID>
<description>Relation Description 1</description>
<documentUUID>3f15c705-eb4e-49a7-8de0-75a2dd504d17</documentUUID>
<relation>REL1</relation>
</refDocumentUUID>
</refDocumentUUIDList>
</documentMetaData>
<documentVersionMetaData>
<createdAt>2018-11-16T18:55:46.204+01:00</createdAt>
<createdBy>doky</createdBy>
<documentUUID>edda69a3-b20f-450f-a608-ef0faa923a5d</documentUUID>
<documentVersionUUID>49b774ba-3539-4656-8cd5-751ffb950c59</documentVersionUUID>
<fileName>teszt.pdf</fileName>
<fileSize>5903</fileSize>
<status>ACTIVE</status>
<version>1</version>
<accessAt>2018-11-16T18:55:46.204+01:00</accessAt>
<volume>xxxx</volume>
</documentVersionMetaData>
<status>
<code>0</code>
<messages/>
</status>
</return>
</ns2:getDocumentResponse>
</S:Body>
</S:Envelope>
JSON API minta
GET /doky/json/document/v1/documents/unique?documentUUID=5cd82c3d-321f-46d5-ae97-ca10ac72a20f&inline=true&preview=false&authToken={{authToken}}&userName={{userName}}
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "documents",
"id": "5cd82c3d-321f-46d5-ae97-ca10ac72a20f",
"attributes": {
"companyId": "ACME",
"createdAt": "2018-11-12T09:26:51.098+01:00",
"createdBy": "CreatedBy",
"description": "Modosultt Szamla Description",
"documentType": "SZAMLA",
"uuid": "5cd82c3d-321f-46d5-ae97-ca10ac72a20f",
"fileName": "szamla.pdf",
"mimeType": "application/vnd.api+json",
"owner": "Owner2",
"propertyList": [
{
"propCode": "EMAIL_CIM",
"value": "ALMA@BARACK.HU"
},
{
"propCode": "NYOMT_IRANY",
"value": "EMAIL"
}
],
"refDocumentUUIDList": [
{
"documentUUID": "dddb80dd-3afc-4978-812f-c5383e939213",
"relation": "REL2",
"description": "Relation Description 2"
},
{
"documentUUID": "4893ea2e-3153-4785-abef-f32ef6b9f1de",
"relation": "REL1",
"description": "Relation Description 2"
}
]
}
},
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
searchDocuments
Dokumentumok keresése.
JSON API esetén mind GET-el és POST-al is lehet hívni.
GET esetén a kereső objektumot jQuery-vel URL paraméterekké kell alakítani, ilyenkor értelemszerűen a kérésnek nincs törzse.
POST esetén a kereső objektum a kérés törzsébe kerül (lsd. a példát lentebb).
Továbbá JSON API esetén lehetőség van rendezésre, ehhez meg kell adni egy sort mezőt, melynek értéke a rendezés alapjául szolgáló mező neve (fordított rendezéshez egy - jel szükséges), több mező esetén vesszővel szükséges azokat elválasztani.
Típusok
Kérés
WS, RS, JSON API:
XML típus név: searchDocumentRequest
| Mező | Típus | Leírás | Média típus |
|---|---|---|---|
| authenticationInfo | AuthenticationInfo_V1 | Authentikációs információ. | xml, json |
| limit | Integer | Válaszban visszadott tételek száma. | |
| offset | Integer | Valaszban szereplő első elem indexe a találati listában. | |
| documentSearchFilters | Array of DocumentSearchFilter_V1 | Dokumentum kereséséi szűrők listája. |
Válasz
WS, RS:
XML típus név: searchDocumentResult
| Mező | Típus | Leírás |
|---|---|---|
| status | ResponseStatus | Kérés eredménye. |
| params | ParamsType | Válasz paraméterek. |
| resultCount | Integer | Keresési paramétereknek megfelelő tételek száma. |
| limit | Integer | Válaszban visszadott tételek száma. |
| offset | Integer | Valaszban szereplő első elem indexe a találati listánan. |
| documentMetaData | Array of DocumentMetaData_V1 | Dokumentum meta adatok. |
JSON API:
Array of DocumentMetaData_V1](#documentmetadata_v1)
WS API minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.doky.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ser:searchDocument>
<arg0>
<authenticationInfo>
<effectiveUser>user</effectiveUser>
<token>HAMMY_AUTH_TOKEN</token>
</authenticationInfo>
<documentSearchFilterList>
<documentSearchFilter>
<searchTermList>
<searchTerm>
<propertyCode>EMAIL_CIM</propertyCode>
<operator>EQUALS</operator>
<parameter>VALAKI@VALAHOL.HU</parameter>
</searchTerm>
</searchTermList>
</documentSearchFilter>
</documentSearchFilterList>
<limit>1</limit>
<offset>0</offset>
</arg0>
</ser:searchDocument>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://service.doky.dbx.hu/">
<ns2:searchDocumentResponse>
<return>
<documentMetaDataList>
<documentMetaData>
<companyId>ACME</companyId>
<createdAt>2018-11-16T18:55:46.178+01:00</createdAt>
<createdBy>doky</createdBy>
<description>DT 3 document modified</description>
<documentType>DT3</documentType>
<uuid>74c0ed18-90c4-4b25-8fba-fe9bd87fe8b9</uuid>
<fileName>teszt.pdf</fileName>
<mimeType>application/pdf</mimeType>
<owner>Owner2</owner>
<propertyList>
<property>
<propCode>EMAIL_CIM</propCode>
<value>VALAKI@VALAHOL.HU</value>
</property>
<property>
<propCode>@READ_ONLY</propCode>
<value>N</value>
</property>
<property>
<propCode>@ASSEMBLED</propCode>
<value>N</value>
</property>
</propertyList>
<refDocumentUUIDList>
<refDocumentUUID>
<description>Relation Description 1</description>
<documentUUID>3f15c705-eb4e-49a7-8de0-75a2dd504d17</documentUUID>
<relation>REL1</relation>
</refDocumentUUID>
</refDocumentUUIDList>
</documentMetaData>
</documentMetaDataList>
<limit>1</limit>
<offset>0</offset>
<resultCount>4</resultCount>
<status>
<code>0</code>
<messages/>
</status>
</return>
</ns2:searchDocumentResponse>
</S:Body>
</S:Envelope>
JSON API minta
/doky/json/document/v1/documents?documentSearchFilters[0][searchTermList][0][propertyCode]=EMAIL_CIM&documentSearchFilters[0][searchTermList][0][operator]=EQUALS&documentSearchFilters[0][searchTermList][0][parameters][]=ALMA@BARACK.HU&limit=10&offset=0&authToken={{authToken}}&userName={{userName}}
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
/doky/json/document/v1/documents
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
{
"data" : {
"id" : 123456,
"type" : "searchDocumentRequests",
"attributes" : {
"documentSearchFilters" : [ {
"searchTermList" : [ {
"propertyCode" : "@DOC_TYPE",
"operator" : "EQUALS",
"parameter" : [ "0127INDEXER" ]
} ]
},
{
"searchTermList" : [ {
"propertyCode" : "@OWNER",
"operator" : "EQUALS",
"parameter" : [ "Admin" ]
} ]
}
],
"limit": 1,
"offset": 0,
"sort": "-fileName"
}
}
}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": [
{
"type": "documents",
"id": "5cd82c3d-321f-46d5-ae97-ca10ac72a20f",
"attributes": {
"companyId": "ACME",
"createdAt": "2018-11-12T09:26:51.098+01:00",
"createdBy": "CreatedBy",
"description": "Szamla Description",
"documentType": "SZAMLA",
"uuid": "dddb80dd-3afc-4978-812f-c5383e939213",
"fileName": "szamla.pdf",
"mimeType": "application/vnd.api+json",
"owner": "Owner",
"propertyList": [
{
"propCode": "EMAIL_CIM",
"value": "ALMA@BARACK.HU"
},
{
"propCode": "NYOMT_IRANY",
"value": "EMAIL"
}
],
"refDocumentUUIDList": [
{
"documentUUID": "6859195c-8dd4-4ea7-baee-2c56d81c5f7b",
"relation": "REL1",
"description": "Relation Description 1"
}
]
}
},
...
],
"meta": {
"total": 5,
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
createDocumentVersion
Dokumentum verzió létrehozása
Típusok
Kérés
WS, RS:
XML típus név: createDocumentVersionRequest
| Mező | Típus | Leírás |
|---|---|---|
| authenticationInfo | AuthenticationInfo_V1 | Authentikációs információ. |
| documentUUId | String | Dokumentum verzió UUID. |
| comment | String | Megjegyzés. |
| createdBy | String | Dokumentum verziót létrehoz felhasználó. |
| content | Array of byte | Dokumentum verzió tartalma. |
JSON API:
Válasz
WS, RS:
XML típus név: createDocumentVersionResult
| Mező | Típus | Leírás |
|---|---|---|
| status | ResponseStatus | Kérés eredménye. |
| params | ParamsType | Válasz paraméterek. |
| documentVersionMetaData | DocumentVersionMetaData_V1 | Dokumentum verzió meta adatok. |
JSON API:
WS API minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.doky.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ser:createDocumentVersion>
<arg0>
<authenticationInfo>
<effectiveUser>user</effectiveUser>
<token>HAMMY_AUTH_TOKEN</token>
</authenticationInfo>
<comment>Új verzió</comment>
<content>cid:337719692979</content>
<documentUUId>74c0ed18-90c4-4b25-8fba-fe9bd87fe8b9</documentUUId>
</arg0>
</ser:createDocumentVersion>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://service.doky.dbx.hu/">
<ns2:createDocumentVersionResponse>
<return>
<documentVersionMetaData>
<comment>Új verzió</comment>
<createdAt>2018-11-16T19:29:41.436+01:00</createdAt>
<createdBy>doky</createdBy>
<documentUUID>74c0ed18-90c4-4b25-8fba-fe9bd87fe8b9</documentUUID>
<documentVersionUUID>bff8edf9-1c69-4761-bb8c-8a646e363114</documentVersionUUID>
<fileName>teszt.pdf</fileName>
<fileSize>5903</fileSize>
<status>ACTIVE</status>
<version>2</version>
<accessAt>2018-11-16T19:29:41.437+01:00</accessAt>
<volume>xxxx</volume>
</documentVersionMetaData>
<status>
<code>0</code>
<messages/>
</status>
</return>
</ns2:createDocumentVersionResponse>
</S:Body>
</S:Envelope>
JSON API minta
POST /doky/json/document/v1/documentVersions?authToken={{authToken}}&userName={{userName}}
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
{
"data" : {
"type" : "documentVersions",
"id" : "eed77b3c-83f4-4962-a5a6-3e6c4ed9ec9d",
"attributes" : {
"comment" : "Ez egy példa",
"documentUUID" : "5cd82c3d-321f-46d5-ae97-ca10ac72a20f",
"content" : "TWkgZXosIGhhZ3ltw6FzIGJhYj8="
}
}
}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "documentVersions",
"id": "bc02abfc-5dda-4c26-b73c-4659e8995839",
"attributes": {
"comment": "Ez egy példa",
"createdAt": "2018-11-13T09:31:39.066+01:00",
"createdBy": "doky",
"documentUUID": "5cd82c3d-321f-46d5-ae97-ca10ac72a20f",
"fileName": "szamla.pdf",
"fileSize": 20,
"status": "ACTIVE",
"version": 1,
"accessAt": "2018-11-13T09:31:39.069+01:00",
"volume": "vol1"
}
},
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
getDocumentVersions
Dokumentum verziók lekérdezése.
A lekérdezés a dokumentumUuid alapján történik (documentUuid).
JSON API esetén a documentUuid -t query paraméterben kell megadni.
Típusok
Kérés
WS, RS:
XML típus név: getDocumentVersionsRequest
| Mező | Típus | Leírás |
|---|---|---|
| authenticationInfo | AuthenticationInfo_V1 | Authentikációs információ. |
| documentUUID | String | Dokumentum UUID. |
JSON API:
Nincs a kérésnek törzse.
Válasz
WS, RS:
XML típus név: getDocumentVersionsResult
| Mező | Típus | Leírás |
|---|---|---|
| status | ResponseStatus | Kérés eredménye. |
| params | ParamsType | Válasz paraméterek. |
| documentMetaData | DocumentMetaData_V1 | Dokumentum meta adatok. |
| documentVersionMetaDataList | Array of DocumentVersionMetaData_V1 | Dokumentum verzió meta adatok listája. |
JSON API:
Array of DocumentVersionMetaData_V1
WS API minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.doky.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ser:getDocumentVersions>
<arg0>
<authenticationInfo>
<effectiveUser>user</effectiveUser>
<token>HAMMY_AUTH_TOKEN</token>
</authenticationInfo>
<documentUUID>74c0ed18-90c4-4b25-8fba-fe9bd87fe8b9</documentUUID>
</arg0>
</ser:getDocumentVersions>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://service.doky.dbx.hu/">
<ns2:getDocumentVersionsResponse>
<return>
<documentMetaData>
<companyId>ACME</companyId>
<createdAt>2018-11-16T18:55:46.178+01:00</createdAt>
<createdBy>doky</createdBy>
<description>DT 3 document modified</description>
<documentType>DT3</documentType>
<uuid>74c0ed18-90c4-4b25-8fba-fe9bd87fe8b9</uuid>
<fileName>teszt.pdf</fileName>
<mimeType>application/pdf</mimeType>
<owner>Owner2</owner>
<propertyList>
<property>
<propCode>EMAIL_CIM</propCode>
<value>VALAKI@VALAHOL.HU</value>
</property>
<property>
<propCode>@READ_ONLY</propCode>
<value>N</value>
</property>
<property>
<propCode>@ASSEMBLED</propCode>
<value>N</value>
</property>
</propertyList>
<refDocumentUUIDList>
<refDocumentUUID>
<description>Relation Description 1</description>
<documentUUID>3f15c705-eb4e-49a7-8de0-75a2dd504d17</documentUUID>
<relation>REL1</relation>
</refDocumentUUID>
</refDocumentUUIDList>
</documentMetaData>
<documentVersionMetaDataList>
<documentVersionMetaData>
<createdAt>2018-11-16T19:02:49.929+01:00</createdAt>
<createdBy>doky</createdBy>
<documentUUID>74c0ed18-90c4-4b25-8fba-fe9bd87fe8b9</documentUUID>
<documentVersionUUID>1dafcb98-fc44-453d-b35d-6bc86e3f500a</documentVersionUUID>
<fileName>teszt.pdf</fileName>
<fileSize>5903</fileSize>
<status>ACTIVE</status>
<version>1</version>
<accessAt>2018-11-16T19:02:49.929+01:00</accessAt>
<volume>xxxx</volume>
</documentVersionMetaData>
<documentVersionMetaData>
<comment>Új verzió</comment>
<createdAt>2018-11-16T19:29:41.436+01:00</createdAt>
<createdBy>doky</createdBy>
<documentUUID>74c0ed18-90c4-4b25-8fba-fe9bd87fe8b9</documentUUID>
<documentVersionUUID>bff8edf9-1c69-4761-bb8c-8a646e363114</documentVersionUUID>
<fileName>teszt.pdf</fileName>
<fileSize>5903</fileSize>
<status>ACTIVE</status>
<version>2</version>
<accessAt>2018-11-16T19:29:41.437+01:00</accessAt>
<volume>xxxx</volume>
</documentVersionMetaData>
</documentVersionMetaDataList>
<status>
<code>0</code>
<messages/>
</status>
</return>
</ns2:getDocumentVersionsResponse>
</S:Body>
</S:Envelope>
JSON API minta
GET /doky/json/document/v1/documentVersions?documentUuid={{documentVersionUuid}}&authToken={{authToken}}&userName={{userName}}
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": [
{
"type": "documentVersions",
"id": "2e8e4f95-ef3e-4406-8760-f13ed19d9dd8",
"attributes": {
"comment": "Ez egy másik példa",
"createdAt": "2018-11-13T09:49:07.547+01:00",
"createdBy": "doky",
"documentUUID": "5cd82c3d-321f-46d5-ae97-ca10ac72a20f",
"fileName": "szamla.pdf",
"fileSize": 20,
"status": "ACTIVE",
"version": 2,
"accessAt": "2018-11-13T09:49:07.547+01:00",
"volume": "xxxx"
}
},
{
"type": "documentVersions",
"id": "bc02abfc-5dda-4c26-b73c-4659e8995839",
"attributes": {
"comment": "Ez egy példa",
"createdAt": "2018-11-13T09:31:39.066+01:00",
"createdBy": "doky",
"documentUUID": "5cd82c3d-321f-46d5-ae97-ca10ac72a20f",
"fileName": "szamla.pdf",
"fileSize": 20,
"status": "ACTIVE",
"version": 1,
"accessAt": "2018-11-13T09:31:39.069+01:00",
"volume": "xxxx"
}
}
],
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
authenticate
Doky authentikáció.
A szolgáltatás JSON API-on nem érhető el.
Típusok
Kérés
WS, RS:
XML típus név: authenticationRequest
| Mező | Típus | Leírás |
|---|---|---|
| authenticationInfo | AuthenticationInfo_V1 | Authentikációs információ. |
| user | String | Felhasználónév. |
| password | String | Jelszó. |
Válasz
WS, RS:
XML típus név: authenticationResult
| Mező | Típus | Leírás |
|---|---|---|
| status | ResponseStatus | Kérés eredménye. |
| params | ParamsType | Válasz paraméterek. |
| user | User_V1 | Felhasználói adatok. |
WS API minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://service.doky.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ser:authenticate>
<arg0>
<authenticationInfo>
<effectiveUser>user</effectiveUser>
<token>HAMMY_AUTH_TOKEN</token>
</authenticationInfo>
<password>user</password>
<user>MySecretPW123</user>
</arg0>
</ser:authenticate>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://service.doky.dbx.hu/">
<ns2:authenticateResponse>
<return>
<user isAdmin="false">
<documentPermissionList>
<permission>
<permissionCode>MANAGE</permissionCode>
<documentTypes>
<documentType>DT1</documentType>
<documentType>DT2</documentType>
</documentTypes>
</permission>
</documentPermissionList>
<name>user</name>
<roles>
<role>ROLE1</role>
</roles>
</user>
</return>
</ns2:authenticateResponse>
</S:Body>
</S:Envelope>
getAuthorizationRules
Az autorizációs szabályokat listázza (mindet ami az adott context-hez tartozik).
Típusok
Kérés
WS-en nem elérhető a szolgáltatás.
RS:
Típus név: getAuthorizationRulesRequest
| Mező | Típus | Leírás |
|---|---|---|
| authenticationInfo | AuthenticationInfo_V1 | Authentikációs információ. |
JSON API:
Nincs a kérésnek törzse.
Válasz
RS:
Típus név: getAuthorizationRulesResult
| Mező | Típus | Leírás |
|---|---|---|
| status | ResponseStatus | Kérés eredménye. |
| params | ParamsType | Válasz paraméterek. |
| authorizationRules | Array of AuthroizationRule_V1 | Authorizációs szabályok. |
JSON API:
Array of AuthorizationRule_V1
RS API minta
POST /doky/rest/document/getAuthorizationRules
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
Content-Type: application/json
{
"authenticationInfo":{
"token":"{{authToken}}",
"effectiveUser":"{{userName}}"
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": {
"code": 0,
"messages": {
"message": []
}
},
"authorizationRuleList": [
{
"id": ID,
"description": "PULIKA can MANAGE",
"type": "ALLOW",
"permission": "MANAGE",
"terms": [
{
"id": ID,
"authorizationRuleId": ID,
"term": "FROM",
"parameter": "PULIKA"
}
]
},
{
"id": ID,
"description": "rule for test 3",
"type": "ALLOW",
"permission": "MANAGE",
"terms": [
{
"id": ID,
"authorizationRuleId": ID,
"term": "FROM",
"parameter": "PULIKA"
}
]
},
{
"id": ID,
"description": "hammy_adapter can MANAGE",
"type": "ALLOW",
"permission": "MANAGE",
"terms": [
{
"id": ID,
"authorizationRuleId": ID,
"term": "FROM",
"parameter": "hammy_adapter"
}
]
},
{
"id": ID,
"description": "PORTFOLIO SZERVER can MANAGE",
"type": "ALLOW",
"permission": "MANAGE",
"terms": [
{
"id": ID,
"authorizationRuleId": ID,
"term": "FROM",
"parameter": "PORTFOLIO SZERVER"
}
]
},
{
"id": ID,
"description": "PORTAL can MANAGE",
"type": "ALLOW",
"permission": "MANAGE",
"terms": [
{
"id": ID,
"authorizationRuleId": ID,
"term": "FROM",
"parameter": "PORTAL"
}
]
}
]
}
JSON API minta
GET /doky/json/document/v1/authorizationRules
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": [
{
"type": "authorizationRules",
"id": "ID",
"attributes": {
"description": "PULIKA can MANAGE",
"type": "ALLOW",
"permission": "MANAGE",
"terms": [
{
"authorizationRuleId": ID,
"term": "FROM",
"parameter": "PULIKA"
}
]
}
},
{
"type": "authorizationRules",
"id": "ID",
"attributes": {
"description": "rule for test 3",
"type": "ALLOW",
"permission": "MANAGE",
"terms": [
{
"authorizationRuleId": ID,
"term": "FROM",
"parameter": "PULIKA"
}
]
}
},
{
"type": "authorizationRules",
"id": "ID",
"attributes": {
"description": "hammy_adapter can MANAGE",
"type": "ALLOW",
"permission": "MANAGE",
"terms": [
{
"authorizationRuleId": ID,
"term": "FROM",
"parameter": "hammy_adapter"
}
]
}
},
{
"type": "authorizationRules",
"id": "ID",
"attributes": {
"description": "PORTFOLIO SZERVER can MANAGE",
"type": "ALLOW",
"permission": "MANAGE",
"terms": [
{
"authorizationRuleId": ID,
"term": "FROM",
"parameter": "PORTFOLIO SZERVER"
}
]
}
},
{
"type": "authorizationRules",
"id": "ID",
"attributes": {
"description": "PORTAL can MANAGE",
"type": "ALLOW",
"permission": "MANAGE",
"terms": [
{
"authorizationRuleId": ID,
"term": "FROM",
"parameter": "PORTAL"
}
]
}
}
],
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
createAuthorizationRule
Authorizációs szabály létrehozására szolgál. Szükséges megadni a hozzátartozó authorizációs szabály term-eket is.
Típusok
Kérés
WS-en keresztül nem érhető el a szolgáltatás.
RS:
Típus név: createAuthorizationRuleRequest
| Mező | Típus or | Leírás |
|---|---|---|
| authenticationInfo | AuthenticationInfo_V1 | Authentikációs információ. |
| authorizationRule | AuthorizationRule_V1 | Authorizációs szabály. |
JSON API:
A létrehozandó AuthorizationRule_V1
Válasz
RS:
Típus név: createAuthorizationRuleResult
| Mező | Típus | Leírás |
|---|---|---|
| status | ResponseStatus | Kérés eredménye. |
| params | ParamsType | Válasz paraméterek. |
| authorizationRule | AuthorizationRule_V1 | Authorizációs szabály. |
JSON API:
RS API minta
POST /doky/rest/document/createAuthorizationRule
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
Content-Type: application/json
{
"authenticationInfo":{
"token":"{{authToken}}",
"effectiveUser":"{{userName}}"
},
"authorizationRule": {
"description":"rule for test RS",
"type":"ALLOW",
"permission":"MANAGE",
"terms":[
{
"term": "FROM",
"parameter": "PULIKA"
}
]
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"authorizationRule": {
"id": 287,
"description": "rule for test RS",
"type": "ALLOW",
"permission": "MANAGE",
"terms": [
{
"id": 313,
"authorizationRuleId": 287,
"term": "FROM",
"parameter": "PULIKA"
}
]
},
"status": {
"code": 0,
"messages": {
"message": []
}
}
}
JSON API minta
POST /doky/json/document/v1/authorizationRules
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
{
"data":{
"type":"authorizationRules",
"id":"ID",
"attributes":{
"description":"rule for test",
"type":"ALLOW",
"permission":"MANAGE",
"terms":[
{
"term": "FROM",
"parameter": "PULIKA"
}
]
}
}
}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "authorizationRules",
"id": "ID",
"attributes": {
"description": "rule for test",
"type": "ALLOW",
"permission": "MANAGE",
"terms": [
{
"authorizationRuleId": ID,
"term": "FROM",
"parameter": "PULIKA"
}
]
}
},
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
updateAuthorizationRule
Authorizációs szabály módosítására szolgál. A szabály ID-val adandó meg.
Típusok
Kérés
WS-en nem érhető el a szolgáltatás
RS:
Típus név: updateAuthorizationRuleRequest
| Mező | Típus | Leírás |
|---|---|---|
| authenticationInfo | AuthenticationInfo_V1 | Authentikációs információ. |
| authorizationRule | AuthorizationRule_V1 | Authorizációs szabály. |
JSON API:
A módosítandó AuthorizationRule_V1
Válasz
RS:
Típus név: updateAuthorizationRuleResult
| Mező | Típus | Leírás |
|---|---|---|
| status | ResponseStatus | Kérés eredménye. |
| params | ParamsType | Válasz paraméterek. |
| authorizationRule | AuthorizationRule_V1 | Authorizációs szabály. |
JSON API:
The modified AuthorizationRule_V1
RS API minta
POST /doky/rest/document/updateAuthorizationRule
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
Content-Type: application/json
{
"authenticationInfo":{
"token":"{{authToken}}",
"effectiveUser":"{{userName}}"
},
"authorizationRule": {
"id": ID,
"description":"rule for test RS (edited)",
"type":"DENY",
"permission":"MANAGE",
"terms":[
{
"term": "FROM",
"parameter": "PULIKA"
}
]
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"authorizationRule": {
"id": ID,
"description": "rule for test RS (edited)",
"type": "DENY",
"permission": "MANAGE",
"terms": [
{
"authorizationRuleId": ID,
"term": "FROM",
"parameter": "PULIKA"
}
]
},
"status": {
"code": 0,
"messages": {
"message": []
}
}
}
JSON API minta
PUT /doky/json/document/v1/authorizationRules/{{id}}
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
{
"data":{
"type":"authorizationRules",
"id":"{{id}}",
"attributes":{
"description":"rule for test (edited)",
"type":"DENY",
"permission":"MANAGE",
"terms":[
{
"term": "FROM",
"parameter": "PULIKA"
}
]
}
}
}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "authorizationRules",
"id": "{{id}}",
"attributes": {
"description": "rule for test (edited)",
"type": "DENY",
"permission": "MANAGE",
"terms": [
{
"authorizationRuleId": {{id}},
"term": "FROM",
"parameter": "PULIKA"
}
]
}
},
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
deleteAuthorizationRule
Authorizációs szabály törlésére szolgál. A szabály ID-val adandó meg.
Típusok
Kérés
WS-en nem érhető el a szolgáltatás
RS:
Típus név: deleteAuthorizationRuleRequest
| Mező | Típus | Leírás |
|---|---|---|
| authenticationInfo | AuthenticationInfo_V1 | Authentikációs információ. |
| authorizationRule | AuthorizationRule_V1 | Authorizációs szabály. |
JSON API:
Nincs a kérésnek törzse.
Válasz
RS:
Típus név: deleteAuthorizationRuleResult
| Mező | Típus | Leírás |
|---|---|---|
| status | ResponseStatus | Kérés eredménye. |
| params | ParamsType | Válasz paraméterek. |
JSON API:
RS API minta
POST /doky/rest/document/updateAuthorizationRule
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
Content-Type: application/json
{
"authenticationInfo":{
"token":"{{authToken}}",
"effectiveUser":"{{userName}}"
},
"authorizationRule": {
"id": ID
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": {
"code": 0,
"messages": {
"message": []
}
}
}
JSON API minta
DELETE /doky/json/document/v1/authorizationRules/{{id}}
X-Auth-Token: {{authToken}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "emptyResponse",
"id": "UUID",
"attributes": {}
},
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
Közös típusok
AuthenticationInfo_V1
Authentikációs rekord bejelentkezett felhasználóhoz.
XML típus név: authenticationInfo
JSON API típus név: -
JSON API ID mező: -
| Mező | Típus | Leírás |
|---|---|---|
| token | String | Authentikációs token. |
| effectiveUser | String | Felhasználónév. |
AuthorizationGroup_V1
Autorizációs csoport adatai.
XML típus név: authorizationGroup
JSON API típus név: -
JSON API ID mező: -
| Mező | Típus | Leírás |
|---|---|---|
| code | String | Csoport kódja. |
| description | String | Csoport leírása. |
AuthorizationRuleTerm_V1
Autorizációs szabály term
XML típus név: authorizationRuleTerm
JSON API típus név: -
JSON API ID mező: -
| Mező | Típus | Leírás |
|---|---|---|
| id | Integer | Term ID. |
| authorizationRuleId | Integer | Tartalmazó szabály ID. |
| term | String | Term kód. |
| parameter | String | Szabály paraméterek. |
AuthorizationRule_V1
Autorizációs szabály.
XML típus név: authorizationRule
JSON API típus név: authorizationRules
JSON API ID mező: id
| Mező | Típus | Leírás |
|---|---|---|
| id | Integer | Szabály ID. |
| description | String | Szabály leírás. |
| type | String | Term kód. |
| permission | String | Engedély kód. |
| terms | Array of AuthorizationRuleTerm_V1 | Tartalmazott term-ek. |
Constraint_V1
Tulajdonság megszorítás szabály.
XML típus név: constraint
JSON API típus név: -
JSON API ID mező: -
| Mező | Típus | Leírás |
|---|---|---|
| id | Integer | Tulajdonság megszorítás ID. |
| type | String | Megszorítás típus kód. |
| value | String | Megszorítás értéke. |
| errorMsg | String | Hibaüzenet. |
DocumentMetaData_V1
Dokumentum (meta) adatok.
XML típus név: documentMetaData
JSON API típus név: documents
JSON API ID mező: documentUUID
| Mező | Típus | Leírás |
|---|---|---|
| documentUUID | String | Dokumentum UUID. |
| owner | String | Tulajdonos felhasználó kódja. |
| createdBy | String | Létrehozó felhasználó kódja. |
| createdAt | Date | Létrehozás időpontja. |
| mimeType | String | Dokumentum média (mime) típusa. |
| fileName | String | Fájlnév. |
| companyId | String | Tulajdonos vállalat ID. |
| description | String | Leírás. |
| documentType | String | Dokumentum típus kód. |
| properties | Array of Property_V1 | Tulajdonságok. |
| refDocumentUUIDs | Array of RefDocumentUUID_V1 | Kapcsolódó dokumentumok. |
DocumentPageRange_V1
Dokumentum hivatkozási tartomány.
XML típus név: documentMetaData
JSON API típus név: -
JSON API ID mező: -
| Mező | Típus | Leírás |
|---|---|---|
| dodocumentVersionUUID | String | Hivatkozott dokumentum UUID. |
| fromPage | Integer | Első hivatkozott oldal. |
| toPage | Integer | Utolsó hivatkozott oldal. |
DocumentSearchFilter_V1
Dokumentum keresési termek listája. A termek AND művelettel kapcsolódnak.
XML típus név: documentSearchFilter
JSON API típus név: -
JSON API ID mező: -
| Mező | Típus | Leírás |
|---|---|---|
| searchTermList | Array of SearchTerm_V1 | Dokumentum keresési term. |
DocumentTypeHierarchyAssociation_V1
Dokumentum típus hierarchia asszociáció. Egy adott dokumentum típust a dokumentum hierarchia egy csomópontjához kapcsolja.
XML típus név: documentTypeHierarchyAssociation
JSON API típus név: documentTypeHierarchyAssociations
JSON API ID mező: uuid
| Mező | Típus | Leírás | Média típus |
|---|---|---|---|
| id | Integer | Dok. típus hierarchia asszoc. ID. | xml, json |
| uuid | String | Dok. típus hierarchia asszoc. UUID. | vnd.api+json |
| documentTypeCode | String | Dokumentum típus kód. | |
| hierarchyNodeId | Integer | Kapcsolódó dok. hirear. csomópont ID. | xml, json |
| hierarchyNodeUuid | String | Kapcsolódó dok. hirear. csomópont UUID. | vnd.api+json |
DocumentTypeHierarchyNode_V1
Dokumentum típus hierarchia csomópont. Fa struktúra alkotható ezekből a csomópontokból, és ezekhez asszociációkkal dokumentum típusok kapcsolhatóak.
XML típus név: documentTypeHierarchyNode
JSON API típus név: documentTypeHierarchyNodes
JSON API ID mező: uuid
| Mező | Típus | Leírás | Média típus |
|---|---|---|---|
| id | Integer | Dok. hierarchia csomópont ID. | xml, json |
| uuid | String | Dok. hierarchia csomópont UUID. | vnd.api+json |
| parentId | Integer | Szülő dok. hierarchia csomópont ID. | xml, json |
| parentUuid | String | Dok. hierarchia csomópont UUID. | vnd.api+json |
| title | String | Csomópont neve. | |
| children | Array of [Integer] | Gyerek dok. hierarchia csomópont ID-k. | xml, json |
| childUuids | Array of [String] | Gyerek dok. hierarchia csomópont UUID-ok. | vnd.api+json |
| associations | Array of DocumentTypeHierarchyAssociation_V1 | Dok. hierarchia csomópont asszociációk. |
DocumentTypePermission_V1
Dokumentum típus engedély.
XML típus név: documentTypePermission
JSON API típus név: -
JSON API ID mező: -
| Mező | Típus | Leírás |
|---|---|---|
| permissionCode | String | Engedély kód. |
| documentTypes | Array of [String] | Kapcsolódó dokumentum típusok. |
DocumentTypePropertyType_V1
Dokumentum típus - Tulajdonság típus kapcsolat.
XML típus név: documentTypePropertyType
JSON API típus név: documentTypePropertyTypes
JSON API ID mező: uuid
| Mező | Típus | Leírás | Média típus |
|---|---|---|---|
| id | Integer | Dok. típus - Tulajdonság típus kapcsolat ID. | xml, json |
| uuid | String | Dok. típus - Tulajdonság típus kapcsolat UUID. | vnd.api+json |
| documentType | String | Dokumentum típus kód. | |
| propertyType | String | Jellemző kód. | |
| compulsory | Boolean | Kötelező? |
DocumentType_V1
Dokumentum típus adatok.
XML típus név: documentType
JSON API típus név: documentTypes
JSON API ID mező: documentType
| Mező | Típus | Leírás | Média típus |
|---|---|---|---|
| id | Integer | Dokumentum típus ID. | xml, json |
| documentType | String | Dokumentum típus kód. | |
| description | String | Leírás. |
DocumentTypeExportData_V1
Exportált dokumentum típupusok és az azoknál használható további meta adatok.
XML típus név: documentTypeExportData
JSON API típusa nincs.
| Mező | Típus | Leírás |
|---|---|---|
| version | String | Típus verzió. |
| documentTypes | Array of DocumentType_V1 | Dokumentum típusok. |
| propertyTypes | Array of PropertyType_V1 | Tulajdonság típusok. |
| propertyGroups | Array of PropertyGroup_V1 | Tulajdonság csoportok. |
| documentTypePropertyTypes | Array of DocumentTypePropertyType_V1 | Dokumentum típus - Tulajdonság típus összerendelések. |
| propertyGroupPropertyTypes | Array of PropertyGroupPropertyType_V1 | Tulajdonság csoport - Tulajdonság típus összerendelések. |
DocumentVersionMetaData_V1
Dokumentum verzió (meta) adatok. vnd.api+json média típus esetén a meta adatok mellett a dokumentum-ot is tartalmazhatja BASE64 kódolással.
XML típus név: documentVersionMetaData
JSON API típus név: documentVersionUUID
JSON API ID mező: documentVersions
| Mező | Típus | Leírás | Média típus |
|---|---|---|---|
| documentVersionUUID | String | Dokumnetum verzió UUID. | |
| documentUUID | String | Dokumnetum UUID. | |
| fileName | String | Fájlnév. | |
| volume | String | Kötet azonosító. | |
| createdBy | String | Létrehozó felhasználó kódja. | |
| createdAt | Date | Létrehozás időpontja. | |
| accessAt | Date | Utolsó hozzáférés időpontja. | |
| version | Integer | Verziószám. | |
| fileSize | Integer | Fájlméret. | |
| status | String | Dokumentum állapot kód. | |
| archiveLocation | String | Arhiválás helye. (URI?) | |
| comment | String | Megjegyzés. | |
| content | String | BASE64 kódolt tartalom. | vnd.api+json |
ExternalApplication_V1
Külső alkalmazás adatok.
XML típus név: externalApplication
JSON API típus név: -
JSON API ID mező: -
| Mező | Típus | Leírás |
|---|---|---|
| code | String | Alkalmazás kódja. |
| description | String | Leírás. |
PropertyGroup_V1
Tulajdonság csoport adatok.
XML típus név: propertyGroup
JSON API típus név: documentPropertyGroups
JSON API ID mező: name
| Mező | Típus | Leírás | Média típus |
|---|---|---|---|
| id | Integer | Tulajdonság csoport ID. | xml, json |
| name | String | Tulajdonság csoport név. | |
| description | String | Leírás. |
PropertyGroupPropertyType_V1
Tulajdonság csoport - Tulajdonság típus összerendelés.
XML típus név: propertyGroupPropertyType
JSON API típus név: Nem önálló típus!
JSON API ID mező: ---
| Mező | Típus | Leírás | Média típus |
|---|---|---|---|
| defaultCompulsory | Integer | Kötelező? | |
| propertyGroupName | String | Tulajdonság csoport név. | |
| propertyTypeCode | String | Jellemző kód. |
PropertyGroup_V1
Tulajdonság csoport adatok.
XML típus név: propertyGroup
JSON API típus név: documentPropertyGroups
JSON API ID mező: name
| Mező | Típus | Leírás | Média típus |
|---|---|---|---|
| id | Integer | Tulajdonság csoport ID. | xml, json |
| name | String | Tulajdonság csoport név. | |
| description | String | Leírás. |
PropertyType_V1
Tulajdonság típus adatok.
XML típus név: propertyType
JSON API típus név: documentTypePropertyTypes
JSON API ID mező: code
| Mező | Típus | Leírás | Média típus |
|---|---|---|---|
| id | Integer | Tulajdonság ID. | xml, json |
| code | String | Tulajdonság kód. | |
| type | String | Tulajdonság adattípusa. | |
| description | String | Leírás. | |
| searchable | Boolean | Kereshető? | |
| compulsory | Boolean | Kötelező? | |
| constraints | Array of Constraint_V1 | Megszorítások. |
Property_V1
Tulajdonság adatok.
XML típus név: property
JSON API típus név: -
JSON API ID mező: -
| Mező | Típus | Leírás |
|---|---|---|
| propCode | String | Tulajdonság kód. |
| value | String | Tulajdonság értéke. |
| index | Integer | Tulajdonság indexe (több azonos kódú esetén). |
RefDocumentUUID_V1
Dokumentumok közötti kapcsolat adatai.
XML típus név: refDocumentUUID
JSON API típus név: -
JSON API ID mező: -
| Mező | Típus | Leírás |
|---|---|---|
| documentUUID | String | Kapcsolódó dokumentum UUID. |
| relation | String | Kapcsolat típus kódja. |
| description | String | Leírás. |
RoleList_V1
Felhasználói szerepkör lista.
XML típus név: roleList
JSON API típus név: -
JSON API ID mező: -
| Mező | Típus | Leírás |
|---|---|---|
| roles | Array of [String] | Szerepkör kódok. |
SearchOperator_V1
Keresési művelet kód.
Értékkészlet: EQUALS, LIKE, LESS_THAN, GREATER_THAN, LESS_OR_EQUAL, GREATER_OR_EQUAL, BETWEEN, EXISTS, IN
SearchTerm_V1
Dokumentum keresési term.
XML típus név: searchTerm
JSON API típus név: -
JSON API ID mező: -
| Mező | Típus | Leírás |
|---|---|---|
| propertyCode | String | Keresési term kód. |
| operator | SearchOperator_V1 | Keresédi term operátor. |
| parameters | Array of [String] | Keresédi term operátor paraméterek. |
User_V1
Felhasználó adatai.
XML típus név: user
JSON API típus név: -
JSON API ID mező: -
| Mező | Típus | Leírás |
|---|---|---|
| name | String | Felhasználónév. |
| admin | Boolean | Adminisztrátor? |
| roleList | RoleList_V1 | Szerepkörök. |
| documentPermissions | Array of [String] | Engedély kódok. |
EmptyResponse_V1
Üres válasz
XML típus név: -
JSON API típus név: emptyResponse
JSON API ID mező: -
| Mező | Típus | Leírás |
|---|---|---|
| id | String | Válasz azonosító. |
| status | ResponseStatus | Kérés eredménye. |
| params | ParamsType | Válasz paraméterek. |