Admin API V1

ChaingunAdminAPI WSDL letöltése

List queues

A használt sorok listázása.

Web service API

Kérés

Név	Típus	Leírás
clientHashKey	String	A webszolgáltatást hívó kliens azonosítója.
queueNames	String [ ]	A sorok neveit tartalmazó lista. Ha nincs megadva, a válaszban az összes sor szerepelni fog.

Válasz

Név	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.
queues	Queue_V1 [ ]	Sorokat tartalmazó lista.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adm="http://admin.api.chaingun.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <adm:listQueues>
            <request>
                <clientHashKey>fhuekgduewg3232ew3222</clientHashKey>
                <queueNames>
                    <queueName>?</queueName>
                </queueNames>
            </request>
        </adm:listQueues>
    </soapenv:Body>
</soapenv:Envelope>

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <dlwmin:listQueuesResponse xmlns:dlwmin="http://admin.api.chaingun.dbx.hu/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <response>
                <queues>
                    <queue>
                        <name>attachmentGetterQueue</name>
                        <size>0</size>
                    </queue>
                    <queue>
                        <name>hammyResponseQueue</name>
                        <size>0</size>
                    </queue>
                    <queue>
                        <name>returnPathQueue</name>
                        <size>0</size>
                    </queue>
                    <queue>
                        <name>archiveQueue</name>
                        <size>0</size>
                    </queue>
                    <queue>
                        <name>attachmentGetterQueueError</name>
                        <size>14</size>
                    </queue>
                    <queue>
                        <name>outgoingMailQueueError</name>
                        <size>16</size>
                    </queue>
                    <queue>
                        <name>leisureOverflowQueue</name>
                        <size>0</size>
                    </queue>
                    <queue>
                        <name>leisureDispatcherQueue</name>
                        <size>0</size>
                    </queue>
                    <queue>
                        <name>savedRequestQueueError</name>
                        <size>15</size>
                    </queue>
                    <queue>
                        <name>leisureQueueError</name>
                        <size>0</size>
                    </queue>
                    <queue>
                        <name>leisureQueue</name>
                        <size>0</size>
                    </queue>
                    <queue>
                        <name>archiveQueueError</name>
                        <size>177</size>
                    </queue>
                    <queue>
                        <name>outgoingMailQueue</name>
                        <size>0</size>
                    </queue>
                    <queue>
                        <name>jobsQueue</name>
                        <size>0</size>
                    </queue>
                    <queue>
                        <name>returnPathQueueError</name>
                        <size>0</size>
                    </queue>
                    <queue>
                        <name>mailRequestQueue</name>
                        <size>0</size>
                    </queue>
                </queues>
                <status>
                    <code>0</code>
                    <messages/>
                </status>
            </response>
        </dlwmin:listQueuesResponse>
    </soapenv:Body>
</soapenv:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/admin/v1/listQueues

Paraméter	Típus	Leírás
queueNames	String [ ]	A sorok neveit tartalmazó lista. Ha nincs megadva, a válaszban az összes sor szerepelni fog.

Válasz

Név	Típus	Leírás
meta	JListMeta1	A válaszhoz tartozó metaadatok.
list	Queue_V1 [ ]	A megtalált sorok.

Minta

KérésVálasz

GET hammy/json/admin/v1/listQueues?queueNames[]=jobsQueue

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": [
          {
                "type": "queues",
                "id": "jobsQueue",
                "attributes": {
                     "size": 0
                }
          }
    ],
    "meta": {
          "total": null,
          "responseStatus": {
                "code": 0,
                "messages": []
          },
          "params": []
    } 
}

List config

A rendszer MDB komponensek futási állapotainak listázása.

Web service API

Kérés

Név	Típus	Leírás
clientHashKey	String	A webszolgáltatást hívó kliens azonosítója.
configKeyList	String [ ]	Konfigurációs kulcs lista.

Válasz

Név	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.
parameters	Parameter_V1 [ ]	Konfigurációs paraméterlista.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adm="http://admin.api.chaingun.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <adm:listConfig>
            <request>
                <clientHashKey>fhuekgduewg3232ew3222</clientHashKey>
                <configKeyList>
                    <configKey></configKey>
                </configKeyList>
            </request>
        </adm:listConfig>
    </soapenv:Body>
</soapenv:Envelope>

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <dlwmin:listConfigResponse xmlns:dlwmin="http://admin.api.chaingun.dbx.hu/"
                                            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <response>
                <parameters>
                    <parameter>
                        <key>general.default.ELASTICSEARCH_CONFIGURED</key>
                        <configValue>NO</configValue>
                        <runningValue/>
                    </parameter>
                    <parameter>
                        <key>general.default.ARCHIVE_DATABASE_CONFIGURED</key>
                        <configValue>NO</configValue>
                        <runningValue/>
                    </parameter>
                    <parameter>
                        <key>component.elasticsearchIndexerQueueMDB.status</key>
                        <configValue>STOPPED</configValue>
                        <runningValue>STOPPED</runningValue>
                        <description>Elasticsearch indexelés</description>
                    </parameter>
                    <parameter>
                        <key>component.savedRequestQueueMDB.status</key>
                        <configValue>RUNNING</configValue>
                        <runningValue>RUNNING</runningValue>
                    </parameter>
                    <parameter>
                        <key>component.mailRequestQueueMDB.status</key>
                        <configValue>RUNNING</configValue>
                        <runningValue>RUNNING</runningValue>
                    </parameter>
                    <parameter>
                        <key>component.notificationQueueMDB.status</key>
                        <configValue>RUNNING</configValue>
                        <runningValue>RUNNING</runningValue>
                    </parameter>
                    <parameter>
                        <key>component.outgoingMailQueueMDB.status</key>
                        <configValue>RUNNING</configValue>
                        <runningValue>RUNNING</runningValue>
                    </parameter>
                    <parameter>
                        <key>component.replyToQueueMDB.status</key>
                        <configValue>STOPPED</configValue>
                        <runningValue>STOPPED</runningValue>
                    </parameter>
                    <parameter>
                        <key>component.returnPathQueueMDB.status</key>
                        <configValue>RUNNING</configValue>
                        <runningValue>RUNNING</runningValue>
                    </parameter>
                    <parameter>
                        <key>template.KOTVENY.LAYOUT</key>
                        <configValue>101</configValue>
                        <runningValue/>
                        <description/>
                    </parameter>
                    <parameter>
                        <key>template.AJANLAT.custom_action</key>
                        <configValue>send_mail_after_link_click_based_on_message</configValue>
                        <runningValue/>
                    </parameter>
                </parameters>
                <status>
                    <code>0</code>
                    <messages/>
                </status>
            </response>
        </dlwmin:listConfigResponse>
    </soapenv:Body>
</soapenv:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/admin/v1/listConfig

Paraméter	Típus	Leírás
configKeys	String [ ]	Konfigurációs kulcs lista.

Válasz

Név	Típus	Leírás
meta	JListMeta1	A válaszhoz tartozó metaadatok.
list	Parameter_V1 [ ]	Konfigurációs paraméterlista.

Minta

KérésVálasz

GET hammy/json/admin/v1/listConfig?configKeys[]=component.savedRequestQueueMDB.status

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data":[
        {
            "type":"parameters",
            "id":"component.savedRequestQueueMDB.status",
            "attributes":{
                "configValue":"RUNNING",
                "runningValue":"RUNNING"
            }
        }
    ],
    "meta":{
        "total":null,
        "responseStatus":{
            "code":0,
            "messages":[

            ]
        },
        "params":[

        ]
    }
 }

Move messages

A queue-ban lévő üzenetek mozgatására szolgáló eljárás. Lehetőség van cg_items tábla azonosítója (itemId), JMS üzenet ID (jmsMessageId) vagy egyéb property szerinti szűrésre.

Web service API

Kérés

Név	Típus	Leírás
clientHashKey	String	A webszolgáltatást hívó kliens azonosítója.
fromQueueName	String	A kezdeti, forrás sor neve.
toQueueName	String	A cél sor neve.
count	Integer	Maximálisan átmásolható üzenetek száma.
itemIdList	Integer [ ]	Szűrőfeltétel, CG_ITEM táblabeli azonosító lista.
jmsMessageIdList	String [ ]	Szűrőfeltétel, JMS üzenet ID listája.
queuePropertyList	Param_V1 [ ]	Szűrőfeltétel.

Válasz

Név	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adm="http://admin.api.chaingun.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <adm:moveMessages>
            <request>
                <clientHashKey>fhuekgduewg3232ew3222</clientHashKey>
                <fromQueueName>returnPathQueue</fromQueueName>
                <toQueueName>returnPathQueueError</toQueueName>
                <jmsMessageIdList>
                    <jmsMessageId>ID:414d5120484541492e502e454149302067dbe35724662244</jmsMessageId>
                    <jmsMessageId>ID:414d5120484541492e502e454149302067dbe35724606ee6</jmsMessageId>
                    <jmsMessageId>ID:414d5120484541492e502e454149302067dbe3572464d654</jmsMessageId>
                </jmsMessageIdList>
                <queuePropertyList>
                    <queueProperty>
                        <key>messageType</key>
                        <value>KOTVENY</value>
                    </queueProperty>
                </queuePropertyList>
            </request>
        </adm:moveMessages>
    </soapenv:Body>
</soapenv:Envelope>

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <dlwmin:moveMessagesResponse xmlns:dlwmin="http://admin.api.chaingun.dbx.hu/"
                                              xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <response>
                <status>
                    <code>0</code>
                    <messages>
                        <message>
                            <severity>INFO</severity>
                            <code>MOVED_MESSAGES_COUNT</code>
                            <description>10 db üzenet sikeresen mozgatva!</description>
                            <refValue>10</refValue>
                        </message>
                    </messages>
                </status>
            </response>
        </dlwmin:moveMessagesResponse>
    </soapenv:Body>
</soapenv:Envelope>

REST API

REST API Info

Kérés

POST hammy/json/admin/v1/moveMessages

body

Név	Típus	Leírás
itemIds	Integer [ ]	Szűrőfeltétel, CG_ITEM táblabeli azonosító lista.
jmsMessageIds	String [ ]	Szűrőfeltétel, JMS üzenet ID listája.
queueProperties	Param_V1 [ ]	Szűrőfeltétel.
id	String	A kérés azonosítója. (vnd.api ID)
fromQueueName	String	A kezdeti, forrás sor neve.
toQueueName	String	A cél sor neve.
count	Integer	Maximálisan átmásolható üzenetek száma.

Válasz

Név	Típus	Leírás
meta	JListMeta1	A válaszhoz tartozó metaadatok.
uuid	String	A válasz UUID-ja. (vnd.api ID)

Minta

KérésVálasz

POST hammy/json/admin/v1/moveMessages
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json

{
  "data" : {
     "type" : "moveMessagesRequests",
     "id": "123456789",
     "attributes" : {
          "fromQueueName" : "outgoingMailQueueError",
          "toQueueName" : "outgoingMailQueue"
     }
  }
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
         "type": "adminResponses",
         "id": "7e4e4990-d664-4cea-b94c-495ec1815ff7",
         "attributes": {}
    },
    "meta": {
         "total": null,
         "responseStatus": {
               "code": 0,
               "messages": [
                    {
                         "severity": "INFO",
                         "code": "MOVED_MESSAGES_COUNT",
                         "description": "10 db üzenet sikeresen mozgatva!",
                         "refValue": "10"
                    }
               ]
         },
         "params": []
    }
}

Purge messages

A queue-ban lévő üzenetek törlésére szolgáló eljárás. Lehetőség van cg_items tábla azonosítója (itemId), JMS üzenet ID (jmsMessageId) vagy egyéb property szerinti szűrésre.

Web service API

Kérés

Név	Típus	Leírás
clientHashKey	String	A webszolgáltatást hívó kliens azonosítója.
queueName	String	A sor neve.
itemIdList	Integer [ ]	Szűrőfeltétel, CG_ITEM táblabeli azonosító lista.
jmsMessageIdList	String [ ]	Szűrőfeltétel, JMS üzenet ID listája.
queuePropertyList	Param_V1 [ ]	Szűrőfeltétel.

Válasz

Név	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adm="http://admin.api.chaingun.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <adm:purgeMessages>
            <request>
                <clientHashKey>fhuekgduewg3232ew3222</clientHashKey>
                <queueName>archiveQueueError</queueName>
                <count>5</count>
            </request>
        </adm:purgeMessages>
    </soapenv:Body>
</soapenv:Envelope>

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <dlwmin:purgeMessagesResponse xmlns:dlwmin="http://admin.api.chaingun.dbx.hu/"
                                             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <response>
                <status>
                    <code>0</code>
                    <messages>
                        <message>
                            <severity>INFO</severity>
                            <code>PURGED_MESSAGES_COUNT</code>
                            <description>5 db üzenet sikeresen törölve!</description>
                            <refValue>5</refValue>
                        </message>
                    </messages>
                </status>
            </response>
        </dlwmin:purgeMessagesResponse>
    </soapenv:Body>
</soapenv:Envelope>

REST API

REST API Info

Kérés

POST hammy/json/admin/v1/purgeMessages

body

Név	Típus	Leírás
itemIds	Integer [ ]	Szűrőfeltétel, CG_ITEM táblabeli azonosító lista.
jmsMessageIds	String [ ]	Szűrőfeltétel, JMS üzenet ID listája.
queueProperties	Param_V1 [ ]	Szűrőfeltétel.
id	String	A kérés azonosítója. (vnd.api ID)
queueName	String	A sor neve.

Válasz

Név	Típus	Leírás
meta	JListMeta1	A válaszhoz tartozó metaadatok.
uuid	String	A válasz UUID-ja. (vnd.api ID)

Minta

KérésVálasz

POST hammy/json/admin/v1/purgeMessages
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json

{
  "data" : {
     "type" : "purgeMessagesRequests",
     "id": "123456789",
     "attributes" : {
          "queueName" : "outgoingMailQueueError"
     }
  }
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
         "type": "adminResponses",
         "id": "09c217e6-25dd-493d-b8bd-a20b12e018b8",
         "attributes": {}
    },
    "meta": {
         "total": null,
         "responseStatus": {
               "code": 0,
               "messages": [
                    {
                         "severity": "INFO",
                         "code": "PURGED_MESSAGES_COUNT",
                         "description": "5 db üzenet sikeresen törölve!",
                         "refValue": "5"
                    }
               ]
         },
         "params": []
    }
}

List task chains

A definiált taskchainek listázása.

Web service API

Kérés

Név	Típus	Leírás
clientHashKey	String	A webszolgáltatást hívó kliens azonosítója.

Válasz

Név	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.
taskChainWMList	TaskChainWM_V1 [ ]	A megtalált task chainek.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adm="http://admin.api.chaingun.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <adm:listTaskChains>
            <request>
                <clientHashKey>fhuekgduewg3232ew3222</clientHashKey>
            </request>
        </adm:listTaskChains>
    </soapenv:Body>
</soapenv:Envelope>

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <dlwmin:listTaskChainsResponse xmlns:dlwmin="http://admin.api.chaingun.dbx.hu/"
                                              xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <response>
                <status>
                    <code>0</code>
                    <messages/>
                </status>
                <taskChainWMList>
                    <taskChainWMList>
                        <name>savedRequestQueueTaskChainManager</name>
                        <description>savedRequestQueueMDB chain</description>
                        <queueName>savedRequestQueue</queueName>
                        <errorQueueName>savedRequestQueueError</errorQueueName>
                    </taskChainWMList>
                    <taskChainWMList>
                        <name>attachmentGetterQueueTaskChainManager</name>
                        <description>attachmentGetterQueueMDB chain</description>
                        <queueName>attachmentGetterQueue</queueName>
                        <errorQueueName>attachmentGetterQueueError</errorQueueName>
                    </taskChainWMList>
                    <taskChainWMList>
                        <name>mailRequestQueueTaskChainManager</name>
                        <description>mailRequestQueueMDB chain</description>
                        <queueName>mailRequestQueue</queueName>
                        <errorQueueName>mailRequestQueueError</errorQueueName>
                    </taskChainWMList>
                    <taskChainWMList>
                        <name>outgoingMailQueueTaskChainManager</name>
                        <description>outgoingMailQueueMDB chain</description>
                        <queueName>outgoingMailQueue</queueName>
                        <errorQueueName>outgoingMailQueueError</errorQueueName>
                    </taskChainWMList>
                    <taskChainWMList>
                        <name>archiveQueueTaskChainManager</name>
                        <description>archiveQueueMDB chain</description>
                        <queueName>archiveQueue</queueName>
                        <errorQueueName>archiveQueueError</errorQueueName>
                    </taskChainWMList>
                    <taskChainWMList>
                        <name>replyToTaskChainManager</name>
                        <description>replyToQueueMDB chain</description>
                        <queueName>replyToQueue</queueName>
                        <errorQueueName>replyToQueueError</errorQueueName>
                    </taskChainWMList>
                    <taskChainWMList>
                        <name>leisureOverflowQueueTaskChainManager</name>
                        <description>leisureOverflowQueueMDB chain</description>
                        <queueName>leisureOverflowQueue</queueName>
                        <errorQueueName>leisureOverflowQueueError</errorQueueName>
                    </taskChainWMList>
                    <taskChainWMList>
                        <name>jobsQueueTaskChainManager</name>
                        <description>jobsQueueMDB chain</description>
                        <queueName>jobsQueue</queueName>
                    </taskChainWMList>
                    <taskChainWMList>
                        <name>replyReceiverTaskChainManager</name>
                        <description>replyToReceiver chain</description>
                    </taskChainWMList>
                    <taskChainWMList>
                        <name>returnPathReceiverTaskChainManager</name>
                        <description>returnPathReceiver chain</description>
                    </taskChainWMList>
                    <taskChainWMList>
                        <name>exportTemplatesTaskChainManager</name>
                        <description>exportTemplates chain</description>
                    </taskChainWMList>
                    <taskChainWMList>
                        <name>importTemplatesTaskChainManager</name>
                        <description>exportTemplates chain</description>
                    </taskChainWMList>
                    <taskChainWMList>
                        <name>statisticsAPIGetStatisticsTaskChainManager</name>
                        <description>statistics api getStatistics chain</description>
                    </taskChainWMList>
                    <taskChainWMList>
                        <name>mailActionExecutorTaskChainManager</name>
                        <description/>
                    </taskChainWMList>
                    <taskChainWMList>
                        <name>dropToArchiveTaskChainManager</name>
                        <description>mail server log drop to archive chain</description>
                    </taskChainWMList>
                </taskChainWMList>
            </response>
        </dlwmin:listTaskChainsResponse>
    </soapenv:Body>
</soapenv:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/admin/v1/listTaskChains

Válasz

Név	Típus	Leírás
meta	JListMeta1	A válaszhoz tartozó metaadatok.
list	TaskChainWM_V1 [ ]	A megtalált task chainek.

Minta

KérésVálasz

GET hammy/json/admin/v1/listTaskChains

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": [
         {
               "type": "taskChainWMs",
               "id": "hammyRequestQueueTaskChainManager",
               "attributes": {
                    "description": "",
                    "queueName": "hammyRequestQueue",
                    "errorQueueName": "hammyRequestQueueError"
               }
         },
         {
               "type": "taskChainWMs",
               "id": "savedRequestQueueTaskChainManager",
               "attributes": {
                    "description": "savedRequestQueueMDB chain",
                    "queueName": "savedRequestQueue",
                    "errorQueueName": "savedRequestQueueError"
               }
         },
         {
               "type": "taskChainWMs",
               "id": "attachmentGetterQueueTaskChainManager",
               "attributes": {
                    "description": "attachmentGetterQueueMDB chain",
                    "queueName": "attachmentGetterQueue",
                    "errorQueueName": "attachmentGetterQueueError"
               }
         },
         {
               "type": "taskChainWMs",
               "id": "mailRequestQueueTaskChainManager",
               "attributes": {
                    "description": "mailRequestQueueMDB chain",
                    "queueName": "mailRequestQueue",
                    "errorQueueName": "mailRequestQueueError"
               }
         },
         {
               "type": "taskChainWMs",
               "id": "outgoingMailQueueTaskChainManager",
               "attributes": {
                    "description": "outgoingMailQueueMDB chain",
                    "queueName": "outgoingMailQueue",
                    "errorQueueName": "outgoingMailQueueError"
               }
         },
         {
               "type": "taskChainWMs",
               "id": "archiveQueueTaskChainManager",
               "attributes": {
                    "description": "archiveQueueMDB chain",
                    "queueName": "archiveQueue",
                    "errorQueueName": "archiveQueueError"
               }
         },
         {
               "type": "taskChainWMs",
               "id": "replyToTaskChainManager",
               "attributes": {
                    "description": "replyToQueueMDB chain",
                    "queueName": "replyToQueue",
                    "errorQueueName": "replyToQueueError"
               }
         },
         {
               "type": "taskChainWMs",
               "id": "returnPathTaskChainManager",
               "attributes": {
                    "description": "returnPathQueueMDB chain",
                    "queueName": "returnPathQueue",
                    "errorQueueName": "returnPathQueueError"
               }
         },
         {
               "type": "taskChainWMs",
               "id": "notificationQueueTaskChainManager",
               "attributes": {
                    "description": "notificationQueueMDB chain",
                    "queueName": "notificationQueue",
                    "errorQueueName": "notificationQueueError"
               }
         },
         {
               "type": "taskChainWMs",
               "id": "suspendedItemBackToOriginalQueueTaskChainManager",
               "attributes": {
                    "description": "suspendedItemBack chain"
               }
         },
         {
               "type": "taskChainWMs",
               "id": "leisureQueueTaskChainManager",
               "attributes": {
                    "description": "leisureQueueMDB chain",
                    "queueName": "leisureQueue",
                    "errorQueueName": "leisureQueueError"
               }
         },
         {
               "type": "taskChainWMs",
               "id": "leisureDispatcherQueueTaskChainManager",
               "attributes": {
                    "description": "leisureDispatcherQueueMDB chain",
                    "queueName": "leisureDispatcherQueue",
                    "errorQueueName": "leisureDispatcherQueueError"
               }
         },
         {
               "type": "taskChainWMs",
               "id": "leisureOverflowQueueTaskChainManager",
               "attributes": {
                    "description": "leisureOverflowQueueMDB chain",
                    "queueName": "leisureOverflowQueue",
                    "errorQueueName": "leisureOverflowQueueError"
               }
         },
         {
               "type": "taskChainWMs",
               "id": "jobsQueueTaskChainManager",
               "attributes": {
                    "description": "jobsQueueMDB chain",
                    "queueName": "jobsQueue"
               }
         },
         {
               "type": "taskChainWMs",
               "id": "queryAPIFindMessagesTaskChainManager",
               "attributes": {
                    "description": "query api findMessages chain"
               }
         },
         {
               "type": "taskChainWMs",
               "id": "queryAPIShowAttachmentTaskChainManager",
               "attributes": {
                    "description": "query api showAttachment chain"
               }
         },
         {
               "type": "taskChainWMs",
               "id": "queryAPIListEventsTaskChainManager",
               "attributes": {
                    "description": "query api listEvents chain"
               }
         }
    ],
    "meta": {
         "total": null,
         "responseStatus": {
               "code": 0,
               "messages": []
         },
         "params": []
    }
}

Run macro

Makró futtatás.

Web service

Ez a szolgáltatás jelenleg csak Web service-n keresztül elérhető.

Web service API

Kérés

Név	Típus	Leírás
clientHashKey	String	A webszolgáltatást hívó kliens azonosítói.
macroName	String	A makró neve.

Válasz

Név	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                      xmlns:adm="http://admin.api.chaingun.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <adm:runMacro>
            <request>
                <clientHashKey>fhuekgduewg3232ew3222</clientHashKey>
                <macroName>macro_name</macroName>
            </request>
        </adm:runMacro>
    </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:runMacroResponse xmlns:ns2="http://admin.api.chaingun.dbx.hu/">
            <response>
                <status>
                    <code>0</code>
                    <messages/>
                </status>
            </response>
        </ns2:runMacroResponse>
    </S:Body>
</S:Envelope>

Set config

A rendszer MDB komponenseinek futási állapotának beállítása.

Web service API

Kérés

Név	Típus	Leírás
clientHashKey	String	A webszolgáltatást hívó kliens azonosítója.
parameters	Parameter_V1 [ ]	Konfigurációs paraméterlista.

Válasz

Név	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                     xmlns:adm="http://admin.api.chaingun.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <adm:setConfig>
            <request>
                <clientHashKey>fhuekgduewg3232ew3222</clientHashKey>
                <parameters>
                    <parameter>
                        <key>component.jobsQueueMDB.status</key>
                        <configValue>RUNNING</configValue>
                        <runningValue>RUNNING</runningValue>
                    </parameter>
                </parameters>
            </request>
        </adm:setConfig>
    </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:setConfigResponse xmlns:ns2="http://admin.api.chaingun.dbx.hu/">
            <response>
                <status>
                    <code>0</code>
                    <messages/>
                </status>
            </response>
        </ns2:setConfigResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

PUT hammy/json/admin/v1/setConfig

body

Név	Típus	Leírás
id	String	A kérés azonosítója. (vnd.api ID)
params	Param_V1 [ ]	Egyéb paraméterek listája.

Válasz

Név	Típus	Leírás
meta	JListMeta1	A válaszhoz tartozó metaadatok.
uuid	String	A válasz UUID-ja. (vnd.api ID)

Minta

KérésVálasz

PUT hammy/json/admin/v1/setConfig
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json

{
    "data" : {
        "type" : "setConfigRequests",
        "id": "jobsQueueMDB",
        "attributes" : {
            "parameters" : [ 
            {
                "key" : "component.jobsQueueMDB.status",
                "configValue" : "RUNNING",
                "runningValue" : "RUNNING"
            } 
            ]
        }
    }
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "adminResponses",
        "id": "981f3bc4-f2c2-4506-a97f-f729b13754bd",
        "attributes": {}
    },
    "meta": {
        "total": null,
        "responseStatus": {
            "code": 0,
            "messages": []
        },
        "params": []
    }
}

Sync config

Az MDB beállítások adatbázisból történő szinkronizálása.

Web service API

Kérés

Név	Típus	Leírás
clientHashKey	String	A webszolgáltatást hívó kliens azonosítója.

Válasz

Név	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                      xmlns:adm="http://admin.api.chaingun.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <adm:syncConfig>
            <request>
                <clientHashKey>fhuekgduewg3232ew3222</clientHashKey>
            </request>
        </adm:syncConfig>
    </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:syncConfigResponse xmlns:ns2="http://admin.api.chaingun.dbx.hu/">
            <response>
                <status>
                    <code>0</code>
                    <messages/>
                </status>
            </response>
        </ns2:syncConfigResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/admin/v1/syncConfig

Válasz

Név	Típus	Leírás
meta	JListMeta1	A válaszhoz tartozó metaadatok.
uuid	String	A válasz UUID-ja. (vnd.api ID)

Minta

KérésVálasz

GET hammy/json/admin/v1/syncConfig

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
         "type": "adminResponses",
         "id": "a03e0353-3c74-4d70-a8df-290272cd724b",
         "attributes": {}
    },
    "meta": {
         "total": null,
         "responseStatus": {
               "code": 0,
               "messages": []
         },
         "params": []
    }
}

Authenticate

Az autentikációt végző szolgáltatás.

Web service API

Kérés

Név	Típus	Leírás
clientHashKey	String	A webszolgáltatást hívó kliens azonosítója.
userName	String	Felhasználónév.
password	String	Jelszó.

Válasz

Név	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.
userName	String	Felhasználónév.
roles	String [ ]	A felhasználóhoz tartozó AD-s szerepkörök.

Minta

KérésVálasz

<soapenv:Envelope 
        xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
        xmlns:adm="http://admin.api.chaingun.dbx.hu/">
    <soapenv:Body>
        <adm:authenticate>
            <request>
                <clientHashKey>fhuekgduewg3232ew32d</clientHashKey>
                <userName>elek</userName>
                <password>Aa1234aA</password>
            </request>
        </adm:authenticate>
    </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:authenticateResponse 
        xmlns:ns2="http://admin.api.chaingun.dbx.hu/">
            <response>
                <userName>elek</userName>
                <roles>
                        <role>hammy_nyomda</role>
                        <role>hammy_uzemeltetes</role>
                        <role>hammy_uzlet</role>
                </roles>
                <status>
                        <code>0</code>
                        <messages/>
                </status>
            </response>
        </ns2:authenticateResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

POST hammy/json/admin/v1/authenticate

body

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
id	String	A kérés azonosítója. (vnd.api ID)
password	String	Jelszó.

Válasz

Név	Típus	Leírás
meta	JMeta1	Metaadatok.
userName	String	Felhasználónév.
roles	JRole_V1 [ ]	A felhasználóhoz tartozó AD-s szerepkörök.

Minta

KérésVálasz

POST hammy/json/admin/v1/authenticate
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json

{
  "data" : {
     "type" : "authenticateRequests",
     "id": "elek",
     "attributes" : {
          "password" : "Aa1234aA"
     }
  }
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
          "type": "authenticateResults",
          "id": "elek",
          "attributes": {
               "roles": [
                    {
                          "role": "hammy_nyomda"
                    },
                    {
                          "role": "hammy_uzemeltetes"
                    },
                    {
                          "role": "hammy_uzlet"
                    }
               ]
          }
    }
}

Trigger job

Definiált triggerek azonnali futtatása.

Web service API

Kérés

Név	Típus	Leírás
clientHashKey	String	A webszolgáltatást hívó kliens azonosítója.
jobName	String	A trigger neve.
legIds	String [ ]	A lábak azonosítói.

Válasz

Név	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                      xmlns:adm="http://admin.api.chaingun.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <adm:triggerJobRequest>
            <request>
                <clientHashKey>fhuekgduewg3232ew3222</clientHashKey>
                <jobName>campaignJob</jobName>
            </request>
        </adm:triggerJobRequest>
    </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:triggerJobResponse xmlns:ns2="http://admin.api.chaingun.dbx.hu/">
            <response>
                <status>
                    <code>0</code>
                    <messages/>
                </status>
            </response>
        </ns2:triggerJobResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/admin/v1/triggerJob

Paraméter	Típus	Leírás
jobName	String	A trigger neve. (vnd.api ID)
legIds	String [ ]	A lábak azonosítói.

Válasz

Név	Típus	Leírás
meta	JListMeta1	A válaszhoz tartozó metaadatok.
uuid	String	A válasz UUID-ja. (vnd.api ID)

Minta

KérésVálasz

GET hammy/json/admin/v1/triggerJob?jobName=campaignJob

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
         "type": "adminResponses",
         "id": "c0cfd51c-cce8-4173-b01d-73a8a704391f",
         "attributes": {}
    },
    "meta": {
         "total": null,
         "responseStatus": {
               "code": 0,
               "messages": []
         },
         "params": []
    }
}

Set job status

Job státuszok beállítása.

Web service API

Kérés

Név	Típus	Leírás
clientHashKey	String	A webszolgáltatást hívó kliens azonosítója.
jobId	Integer [ ]	A job azonosítója, többet is meg lehet adni belőle.
jobStatus	JobStatus	A job kívánt státusza.

Válasz

Név	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adm="http://admin.api.chaingun.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <adm:setJobStatusRequest>
            <request>
                <clientHashKey>?</clientHashKey>
                <jobId>7191</jobId>
                <jobId>7192</jobId>
                <jobStatus>CANCELLED</jobStatus>
            </request>
        </adm:setJobStatusRequest>
    </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:setJobStatusResponse xmlns:ns2="http://admin.api.chaingun.dbx.hu/">
            <response>
                <status>
                    <code>0</code>
                    <messages/>
                </status>
            </response>
        </ns2:setJobStatusResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

PUT hammy/json/admin/v1/setJobStatus

body

Név	Típus	Leírás
requestMeta	JRequestMeta_V1	A kérés metaadatai.
id	Integer	A kérés azonosítója. (vnd.api ID)
jobId	Integer [ ]	A job azonosítója, többet is meg lehet adni belőle.
jobStatus	JobStatus	A job kívánt státusza.

Válasz

Név	Típus	Leírás
meta	JListMeta1	A válaszhoz tartozó metaadatok.
uuid	String	A válasz UUID-ja. (vnd.api ID)

Minta

KérésVálasz

PUT hammy/json/admin/v1/setJobStatus
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json

{
    "data" : {
        "type" : "setJobStatusRequests",
        "id" : "1",
        "attributes" : {
            "jobStatus" : "CANCELLED",
            "jobId": ["7159"]
        }
    }
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
         "type": "adminResponses",
         "id": "64db0481-8542-417f-964a-6e63fbc77a91",
         "attributes": {}
    },
    "meta": {
         "total": null,
         "responseStatus": {
               "code": 0,
               "messages": []
         },
         "params": []
    }
}

Get job info

Futó job-okról információ lekérése. Visszaadja job státuszát, százalékos végrehajtottságát és egyéb paramétereit a job jellegétől függően.

Web service API

Kérés

Név	Típus	Leírás
clientHashKey	String	A webszolgáltatást hívó kliens azonosítója.
jobId	String	A keresett job azonosítója.
params	Param_V1 [ ]	A szolgáltatás működését befolyásoló egyéb paraméterek listája.

Válasz

Név	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.
jobInfo	JobInfo_V1	Job információi.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                    xmlns:adm="http://admin.api.chaingun.dbx.hu/">
    <soapenv:Body>
        <adm:getJobInfo>
            <request>
                <clientHashKey>aa87cd4bcd3445bbc4</clientHashKey>
                <jobId>24628</jobId>
            </request>
        </adm:getJobInfo>
    </soapenv:Body>
</soapenv:Envelope>

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <dlwmin:getJobInfoResponse xmlns:dlwmin="http://admin.api.chaingun.dbx.hu/"
                                            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <response>
                <jobInfo>
                    <jobId>24628</jobId>
                    <jobStatus>FINISHED</jobStatus>
                    <jobClass>hu.dbx.hammy.processor.query.FindMessagesExportResultJobRunner</jobClass>
                    <createdAt>2018-07-05T09:12:28.185+02:00</createdAt>
                    <startedAt>2018-07-05T09:12:28.569+02:00</startedAt>
                    <finishedAt>2018-07-05T09:12:28.850+02:00</finishedAt>
                    <progressPct>100</progressPct>
                    <jobParams>
                        <param>
                            <key>TOTAL</key>
                            <value>8</value>
                        </param>
                        <param>
                            <key>FINISHED</key>
                            <value>8</value>
                        </param>
                        <param>
                            <key>EXPORTED_FILE_PATH</key>
                            <value>exports/20180705/export_result_24628.csv</value>
                        </param>
                        <param>
                            <key>MESSAGE_STATUSES</key>
                            <value>FAILED</value>
                        </param>
                        <param>
                            <key>FROM_DATE</key>
                            <value>2018.07.04T00:00:00</value>
                        </param>
                        <param>
                            <key>TO_DATE</key>
                            <value>2018.07.05T08:00:00</value>
                        </param>
                        <param>
                            <key>MESSAGE_TYPES</key>
                            <value>BUROFFICE</value>
                        </param>
                        <param>
                            <key>MESSAGE_CHANNELS</key>
                            <value>EMAIL</value>
                        </param>
                    </jobParams>
                </jobInfo>
                <status>
                    <code>0</code>
                    <messages/>
                </status>
            </response>
        </dlwmin:getJobInfoResponse>
    </soapenv:Body>
</soapenv:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/admin/v1/getJobInfo

Válasz

Név	Típus	Leírás
meta	JMeta1	Metaadatok.
id	String	A válasz azonosítója. (vnd.api ID)
jobInfo	JobInfo_V1	Job információi.

Minta

KérésVálasz

GET hammy/json/admin/v1/getJobInfo?jobId=24628

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
         "type": "getJobInfoResult",
         "attributes": {
               "jobInfo": {
                    "jobId": 24628,
                    "jobStatus": "FINISHED",
                    "jobClass": "hu.dbx.hammy.processor.query.FindMessagesExportResultJobRunner",
                    "createdAt": "2018-07-05T07:12:28.185+0000",
                    "startedAt": "2018-07-05T07:12:28.569+0000",
                    "finishedAt": "2018-07-05T07:12:28.850+0000",
                    "progressPct": 100,
                    "jobParams": [
                         {
                               "key": "TOTAL",
                               "value": "8"
                         },
                         {
                               "key": "FINISHED",
                               "value": "8"
                         },
                         {
                               "key": "FROM_DATE",
                               "value": "2018.07.04T00:00:00"
                         },
                         {
                               "key": "MESSAGE_CHANNELS",
                               "value": "EMAIL"
                         },
                         {
                               "key": "TO_DATE",
                               "value": "2018.07.05T08:00:00"
                         },
                         {
                               "key": "EXPORTED_FILE_PATH",
                               "value": "exports/20180705/export_result_24628.csv"
                         },
                         {
                               "key": "MESSAGE_TYPES",
                               "value": "BUROFFICE"
                         },
                         {
                               "key": "MESSAGE_STATUSES",
                               "value": "FAILED"
                         }
                    ]
               }
         }
    },
    "meta": {
         "total": null,
         "responseStatus": {
               "code": 0,
               "messages": []
         },
         "params": []
    }
}

Set CG param

Konfigurációs paraméterek beállítása.

Web service API

Kérés

Név	Típus	Leírás
clientHashKey	String	A webszolgáltatást hívó kliens azonosítója.
cgParamList	CGParam_V1 [ ]	CG paraméterek listája.

Válasz

Név	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.
cgParamList	CGParam_V1 [ ]	CG paraméterek listája.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adm="http://admin.api.chaingun.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <adm:setCGParam>
            <request>
                <clientHashKey>?</clientHashKey>
                <cgParamList>
                    <cgParam>
                        <key>layout</key>
                        <value>1</value>
                        <objectType>template</objectType>
                        <objectId>KOTVENY</objectId>
                    </cgParam>
                </cgParamList>
            </request>
        </adm:setCGParam>
    </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:setCGParamResponse xmlns:ns2="http://admin.api.chaingun.dbx.hu/">
            <response>
                <cgParamList>
                    <cgParam>
                        <id>5133</id>
                        <key>layout</key>
                        <value>1</value>
                        <objectType>template</objectType>
                        <objectId>KOTVENY</objectId>
                    </cgParam>
                </cgParamList>
                <status>
                    <code>0</code>
                    <messages/>
                </status>
            </response>
        </ns2:setCGParamResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

PUT hammy/json/admin/v1/setCGParam

body

Név	Típus	Leírás
requestMeta	JRequestMeta_V1	A kérés metaadatai.
id	Integer	A kérés azonosítója. (vnd.api ID)
cgParams	CGParam_V1 [ ]	CG paraméterek listája.

Válasz

Név	Típus	Leírás
meta	JListMeta1	A válaszhoz tartozó metaadatok.
list	CGParam_V1 [ ]	CG paraméterek listája.

Minta

KérésVálasz

PUT hammy/json/admin/v1/setCGParam
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json

{
    "data" : {
        "type" : "setCGParamRequests",
        "id": "alma",
        "attributes" : {
            "cgParams" : [ {
            "key" : "layout",
            "value" : "1",
            "objectType" : "template",
            "objectId" : "KOTVENY"
            } ]
        }
    }
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": [
        {
            "type": "parameters",
            "id": "5133",
            "attributes": {
                    "key": "layout",
                    "value": "1",
                    "objectType": "template",
                    "objectId": "KOTVENY"
            }
        }
    ],
    "meta": {
        "total": null,
        "responseStatus": {
            "code": 2,
            "messages": [
                    {
                        "severity": "ERROR",
                        "code": "PARAM_IS_ALREADY_DEFINED",
                        "description": "Már létezik ilyen CgParam!",
                        "refElement": "request/cgParamList"
                    }
            ]
        },
        "params": []
    }
}

Delete CG param

Konfigurációs paraméterek törlése. Lehetőség van id-szerinti törlésre, illetve a kulcs, érték és hatókör szerinti eltávolításra.

Web service API

Kérés

Név	Típus	Leírás
clientHashKey	String	A webszolgáltatást hívó kliens azonosítója.
cgParamList	CGParam_V1 [ ]	CG paraméterek listája.

Válasz

Név	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adm="http://admin.api.chaingun.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <adm:deleteCGParam>
            <request>
                <clientHashKey>?</clientHashKey>
                <cgParamList>
                    <cgParam>
                        <id>5133</id>
                    </cgParam>
                </cgParamList>
            </request>
        </adm:deleteCGParam>
    </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:deleteCGParamResponse xmlns:ns2="http://admin.api.chaingun.dbx.hu/">
            <response>
                <status>
                    <code>0</code>
                    <messages/>
                </status>
            </response>
        </ns2:deleteCGParamResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

DELETE hammy/json/admin/v1/deleteCGParam

Paraméter	Típus	Leírás
requestMeta	JRequestMeta_V1	A kérés metaadatai.
id	Integer	A kérés azonosítója. (vnd.api ID)
cgParams	CGParam_V1 [ ]	CG paraméterek listája.

Válasz

Név	Típus	Leírás
meta	JListMeta1	A válaszhoz tartozó metaadatok.
uuid	String	A válasz UUID-ja. (vnd.api ID)

Minta

KérésVálasz

DELETE hammy/json/admin/v1/deleteCGParam?cgParams[]=1221213&cgParams[]=2341234

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
         "type": "adminResponses",
         "id": "50a2f59e-a196-4c0d-99b2-c19dff1ee7a5",
         "attributes": {}
    },
    "meta": {
         "total": null,
         "responseStatus": {
               "code": 0,
               "messages": []
         },
         "params": []
    }
}

List CG params

Konfigurációs paraméterek listázása.

Web service API

Kérés

Név	Típus	Leírás
clientHashKey	String	A webszolgáltatást hívó kliens azonosítója.
key	String	A paramétert azonosító kulcs.
objectType	String	A paraméter hatókör típusa.
objectId	String	A paraméter hatókör azonosítója.
sort	String	A találatok rendezése.
limit	Integer	A találatok maximális száma.
offset	Integer	A találati lista kezdete.

Válasz

Név	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.
cgParamList	CGParam_V1 [ ]	CG paraméterek listája.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adm="http://admin.api.chaingun.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <adm:listCGParams>
            <request>
                <clientHashKey>?</clientHashKey>
                <objectType>template_handling_category</objectType>
            </request>
        </adm:listCGParams>
    </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:listCGParamsResponse xmlns:ns2="http://admin.api.chaingun.dbx.hu/">
            <response>
                <cgParamList>
                    <cgParam>
                        <id>69</id>
                        <key>leisure_rounds</key>
                        <value>6</value>
                        <objectType>template_handling_category</objectType>
                        <objectId>1</objectId>
                    </cgParam>
                    <cgParam>
                        <id>70</id>
                        <key>security_channel</key>
                        <value>NO</value>
                        <objectType>template_handling_category</objectType>
                        <objectId>1</objectId>
                    </cgParam>
                    <cgParam>
                        <id>5078</id>
                        <key>ARCHIVED_MESSAGE_STATES</key>
                        <value>SENT,ERROR</value>
                        <objectType>template_handling_category</objectType>
                        <objectId>2</objectId>
                    </cgParam>
                    <cgParam>
                        <id>5079</id>
                        <key>DAYS_BEFORE_DELETION</key>
                        <value>20</value>
                        <objectType>template_handling_category</objectType>
                        <objectId>2</objectId>
                    </cgParam>
                </cgParamList>
                <status>
                    <code>0</code>
                    <messages/>
                </status>
            </response>
        </ns2:listCGParamsResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/admin/v1/listCGParams

Paraméter	Típus	Leírás
id	String	A kérés azonosítója. (vnd.api ID)
key	String	A paramétert azonosító kulcs.
objectType	String	A paraméter hatókör típusa.
objectId	String	A paraméter hatókör azonosítója.
limit	Integer	A keresési találatok maximális száma.
offset	Integer	A találati lista kezdete.
sort	String	Rendezés.
clientHashKey	String	A hívó kliens azonosítója.
userName	String	A felhasználó neve.
params	Param_V1 [ ]	Egyéb meta adatok.

Válasz

Név	Típus	Leírás
meta	JListMeta1	A válaszhoz tartozó metaadatok.
list	CGParam_V1 [ ]	CG paraméterek listája.

Minta

KérésVálasz

GET hammy/json/admin/v1/listCGParams?key=DAYS_BEFORE_DELETION

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": [
         {
               "type": "parameters",
               "id": "5074",
               "attributes": {
                    "key": "DAYS_BEFORE_DELETION",
                    "value": "30",
                    "objectType": "template",
                    "objectId": "351.DI"
               }
         },
         {
               "type": "parameters",
               "id": "5077",
               "attributes": {
                    "key": "DAYS_BEFORE_DELETION",
                    "value": "40",
                    "objectType": "template",
                    "objectId": "351.A"
               }
         },
         {
               "type": "parameters",
               "id": "5079",
               "attributes": {
                    "key": "DAYS_BEFORE_DELETION",
                    "value": "20",
                    "objectType": "template_handling_category",
                    "objectId": "2"
               }
         },
         {
               "type": "parameters",
               "id": "5084",
               "attributes": {
                    "key": "DAYS_BEFORE_DELETION",
                    "value": "100",
                    "objectType": "cg_client",
                    "objectId": "Marci"
               }
         }
    ],
    "meta": {
         "total": null,
         "responseStatus": {
               "code": 0,
               "messages": []
         },
         "params": []
    }
}

List user groups

A felhasználó csoportjainak listázása.

Web service API

Kérés

Név	Típus	Leírás
clientHashKey	String	A webszolgáltatást hívó kliens azonosítója.
userName	String	Felhasználó neve.

Válasz

Név	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.
userGroupList	String [ ]	A felhasználó csoportjainak listája.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adm="http://admin.api.chaingun.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <adm:listUserGroups>
            <request>
                <clientHashKey>?</clientHashKey>
                <userName>admin</userName>
            </request>
        </adm:listUserGroups>
    </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:listUserGroupsResponse xmlns:ns2="http://admin.api.chaingun.dbx.hu/">
            <response>
                <status>
                    <code>0</code>
                    <messages/>
                </status>
                <userGroupList>
                    <userGroup>hammy_admin</userGroup>
                    <userGroup>hammy_viewer</userGroup>
                    <userGroup>hammy_editor</userGroup>
                    <userGroup>hammy_stats_viewer</userGroup>
                    <userGroup>hammy_edm_user</userGroup>
                    <userGroup>hammy_batch_manager</userGroup>
                </userGroupList>
            </response>
        </ns2:listUserGroupsResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/admin/v1/listUserGroups

Paraméter	Típus	Leírás
userName	String	Felhasználó neve. (vnd.api ID)

Válasz

Név	Típus	Leírás
meta	JMeta1	Metaadatok.
id	String	A válasz azonosítója. (vnd.api ID)
userGroups	JUserGroup_V1 [ ]	A felhasználó csoportjainak listája.

Minta

KérésVálasz

GET hammy/json/admin/v1/listUserGroups?userName=admin

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
         "type": "listUserGroupsResults",
         "attributes": {
               "userGroups": [
                    {
                         "id": "hammy_admin",
                         "groupName": "hammy_admin"
                    },
                    {
                         "id": "hammy_viewer",
                         "groupName": "hammy_viewer"
                    },
                    {
                         "id": "hammy_editor",
                         "groupName": "hammy_editor"
                    },
                    {
                         "id": "hammy_stats_viewer",
                         "groupName": "hammy_stats_viewer"
                    },
                    {
                         "id": "hammy_edm_user",
                         "groupName": "hammy_edm_user"
                    },
                    {
                         "id": "hammy_batch_manager",
                         "groupName": "hammy_batch_manager"
                    }
               ]
         }
    }
}

Drop to JMS queue

Adattartalom queue-ba helyezése. Az adattartalmat kulcs-érték párossal kell megadni.

Web service API

Kérés

Név	Típus	Leírás
clientHashKey	String	A webszolgáltatást hívó kliens azonosítója.
destinationQueueWM	String	A queue neve.
taskChainElementList	TaskChainElement_V1 [ ]	Queue adattartalom lista.

Válasz

Név	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.
destinationQueueWM	String	A queue neve.
taskChainElementListSuccess	TaskChainElement_V1 [ ]	A sikeresen beillesztett adattartalom listája.
taskChainElementListError	TaskChainElement_V1 [ ]	Hiba miatt nem beilleszthető adattartalom listája.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adm="http://admin.api.chaingun.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <adm:dropToJMSQueue>
            <request>
                <clientHashKey>?</clientHashKey>
                <destinationQueueWM>hammyRequestQueue</destinationQueueWM>
                <taskChainElementList>
                    <taskChainElement>
                        <key>cg.item.id.key</key>
                        <value>12</value>
                        <valueType>integer</valueType>
                    </taskChainElement>
                </taskChainElementList>
            </request>
        </adm:dropToJMSQueue>
    </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:dropToJMSQueueResponse xmlns:ns2="http://admin.api.chaingun.dbx.hu/">
            <response>
                <status>
                    <code>0</code>
                    <messages/>
                </status>
                <taskChainElementListError/>
                <taskChainElementListSuccess>
                    <taskChainElement>
                        <key>cg.item.id.key</key>
                        <value>12</value>
                        <valueType>integer</valueType>
                    </taskChainElement>
                </taskChainElementListSuccess>
            </response>
        </ns2:dropToJMSQueueResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

POST hammy/json/admin/v1/dropToJMSQueue

body

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
id	String	A kérés azonosítója. (vnd.api ID)
destinationQueueWM	String	A queue neve.
taskChainElementList	JTaskChainElement_V1 [ ]	Queue adattartalom lista.

Válasz

Név	Típus	Leírás
meta	JMeta1	Metaadatok.
id	String	A válasz azonosítója. (vnd.api ID)
destinationQueueWM	String	A queue neve.
taskChainElementListSuccess	JTaskChainElement_V1 [ ]	A sikeresen beillesztett adattartalom listája.
taskChainElementListError	JTaskChainElement_V1 [ ]	Hiba miatt nem beilleszthető adattartalom listája.

Minta

KérésVálasz

POST hammy/json/admin/v1/dropToJMSQueue
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json

{
    "data" : {
        "type" : "dropToJMSQueueRequests",
        "id": "alma",
        "attributes" : {
            "destinationQueueWM" : "archiveQueue",
            "taskChainElements" : [ {
            "id" : "1",
            "key" : "cg.item.id.key",
            "value" : "1",
            "valueType" : "integer"
            } ]
        }
    }
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "dropToJMSQueueResults",
        "attributes": {
            "taskChainElementListSuccess": [
                    {
                        "key": "cg.item.id.key",
                        "value": "1",
                        "valueType": "integer"
                    }
            ],
            "taskChainElementListError": []
        }
    }
}

List CG error types

A regisztrált error típusok listázása. Konkrét azonosító megadásával egy hibatípus lekérdezésére szolgál.

Web service API

Kérés

Név	Típus	Leírás
clientHashKey	String	A webszolgáltatást hívó kliens azonosítója.
id	Integer	A hiba azonosítója, opcionális.

Válasz

Név	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.
cgErrorTypeList	CGErrorType_V1 [ ]	A regisztrált hibafajták listája.

Minta

KérésVálasz

 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adm="http://admin.api.chaingun.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <adm:listCGErrorTypes>
            <request>
                <clientHashKey>?</clientHashKey>
            </request>
        </adm:listCGErrorTypes>
    </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:listCGErrorTypesResponse xmlns:ns2="http://admin.api.chaingun.dbx.hu/">
            <response>
                <cgErrorTypeList>
                    <cgErrorType>
                        <id>12</id>
                        <errorName>General error</errorName>
                        <errorClass>GENERAL_ERROR</errorClass>
                        <errorType>E</errorType>
                        <errorHandlingCategory>21</errorHandlingCategory>
                    </cgErrorType>
                    <cgErrorType>
                        <id>11</id>
                        <errorName>Template merging error</errorName>
                        <errorClass>TemplateMergeException</errorClass>
                        <errorType>E</errorType>
                        <errorHandlingCategory>21</errorHandlingCategory>
                    </cgErrorType>
                    <cgErrorType>
                        <id>10</id>
                        <errorName>Archive error</errorName>
                        <errorClass>ArchiveException</errorClass>
                        <errorType>E</errorType>
                        <errorHandlingCategory>21</errorHandlingCategory>
                    </cgErrorType>
                    <cgErrorType>
                        <id>9</id>
                        <errorName>PDF signing error</errorName>
                        <errorClass>PdfSignException</errorClass>
                        <errorType>F</errorType>
                        <errorHandlingCategory>20</errorHandlingCategory>
                    </cgErrorType>
                </cgErrorTypeList>
                <status>
                    <code>0</code>
                    <messages/>
                </status>
            </response>
        </ns2:listCGErrorTypesResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/admin/v1/listCGErrorTypes

Válasz

Név	Típus	Leírás
meta	JListMeta1	A válaszhoz tartozó metaadatok.
list	JCGErrorType_V1 [ ]	A megtalált hibatípusok.

Minta

KérésVálasz

GET hammy/json/admin/v1/listCGErrorTypes?id=1

 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adm="http://admin.api.chaingun.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <adm:listCGErrorTypes>
            <request>
                <clientHashKey>?</clientHashKey>
            </request>
        </adm:listCGErrorTypes>
    </soapenv:Body>
</soapenv:Envelope>

Set CG error type

Hiba típusok regisztrálása.

Web service API

Kérés

Név	Típus	Leírás
clientHashKey	String	A webszolgáltatást hívó kliens azonosítója.
cgErrorTypeList	CGErrorType_V1 [ ]	A regisztrálandó hibafajták listája.

Válasz

Név	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.
cgErrorTypeList	CGErrorType_V1 [ ]	A regisztrált hibafajták listája.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adm="http://admin.api.chaingun.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <adm:setCGErrorType>
            <request>
                <clientHashKey>?</clientHashKey>
                <cgErrorTypeList>
                    <cgErrorType>
                        <errorName>Task hiba validációnál</errorName>
                        <errorClass>TaskException</errorClass>
                        <errorType>E</errorType>
                        <errorHandlingCategory>21</errorHandlingCategory>
                        <errorMessage>hu.dbx.chaingun.util.taskchain.TaskException: Destination Queue not found</errorMessage>
                    </cgErrorType>
                </cgErrorTypeList>
            </request>
        </adm:setCGErrorType>
    </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:setCGErrorTypeResponse xmlns:ns2="http://admin.api.chaingun.dbx.hu/">
            <response>
                <cgErrorTypeList>
                    <cgErrorType>
                        <id>81</id>
                        <errorName>Task hiba validációnál</errorName>
                        <errorClass>TaskException</errorClass>
                        <errorType>E</errorType>
                        <errorHandlingCategory>21</errorHandlingCategory>
                        <errorMessage>hu.dbx.chaingun.util.taskchain.TaskException: Destination Queue not found</errorMessage>
                    </cgErrorType>
                </cgErrorTypeList>
                <status>
                    <code>0</code>
                    <messages/>
                </status>
            </response>
        </ns2:setCGErrorTypeResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

POST hammy/json/admin/v1/setCGErrorType

body

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
id	String	A kérés azonosítója. (vnd.api ID)
cgErrorTypes	JCGErrorType_V1 [ ]	A regisztrált hibatípusok.

Válasz

Név	Típus	Leírás
meta	JListMeta1	A válaszhoz tartozó metaadatok.
list	JCGErrorType_V1 [ ]	A regisztrált hibatípusok.

Minta

KérésVálasz

POST hammy/json/admin/v1/setCGErrorType
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json

{
    "data" : {
        "type" : "setCGErrorTypeRequests",
        "id": "bela",
        "attributes" : {
            "cgErrorTypes" : [ {
            "errorName" : "Task hiba általános",
            "errorClass" : "TaskException",
            "errorType" : "E",
            "errorMessage" : "hu.dbx.chaingun.util.taskchain.TaskException"
            } ]
        }
    }
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": [
         {
               "type": "parameters",
               "id": "82",
               "attributes": {
                    "errorName": "Task hiba általános",
                    "errorClass": "TaskException",
                    "errorType": "E",
                    "errorMessage": "hu.dbx.chaingun.util.taskchain.TaskException"
               }
         }
    ],
    "meta": {
         "total": null,
         "responseStatus": {
               "code": 0,
               "messages": []
         },
         "params": []
    }
}

Delete CG error type

Hibatípusok törlése.

Web service API

Kérés

Név	Típus	Leírás
clientHashKey	String	A webszolgáltatást hívó kliens azonosítója.
id	Integer	A hiba azonosítója.

Válasz

Név	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adm="http://admin.api.chaingun.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <adm:deleteCGErrorType>
            <request>
                <clientHashKey>?</clientHashKey>
                <id>82</id>
            </request>
        </adm:deleteCGErrorType>
    </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:deleteCGErrorTypeResponse xmlns:ns2="http://admin.api.chaingun.dbx.hu/">
            <response>
                <status>
                    <code>0</code>
                    <messages/>
                </status>
            </response>
        </ns2:deleteCGErrorTypeResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

DELETE hammy/json/admin/v1/deleteCGErrorType

Paraméter	Típus	Leírás
id	Integer	A hiba azonosítója.

Válasz

Név	Típus	Leírás
meta	JListMeta1	A válaszhoz tartozó metaadatok.
uuid	String	A válasz UUID-ja. (vnd.api ID)

Minta

KérésVálasz

DELETE hammy/json/admin/v1/deleteCGErrorType?id=83

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
         "type": "adminResponses",
         "id": "2027522d-0908-45af-846a-6b61c35642f0",
         "attributes": {}
    },
    "meta": {
         "total": null,
         "responseStatus": {
               "code": 0,
               "messages": []
         },
         "params": []
    }
}

Upload file

Fájl feltöltése.

Web service API

Kérés

Név	Típus	Leírás	Kötelező
clientHashKey	String	A webszolgáltatást hívó kliens azonosítója.	*
content	Byte [ ]	A fájtartalom Base64 kódolva
contentStream	DataStream	A fájltartalom streamként.
filePath	String	A fájl elérési útja belül definiált roothoz képest.	*
fileUploader	String	A feltöltő osztály neve, ha nincs megadva a default használatos.

Válasz

Név	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adm="http://admin.api.chaingun.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <adm:uploadFile>
            <request>
                <clientHashKey>?</clientHashKey>
                <content>cid:287897590190</content>
                <filePath>sample.pdf</filePath>
            </request>
        </adm:uploadFile>
    </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:uploadFileResponse xmlns:ns2="http://admin.api.chaingun.dbx.hu/">
            <response>
                <status>
                    <code>0</code>
                    <messages/>
                </status>
            </response>
        </ns2:uploadFileResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

POST hammy/json/admin/v1/uploadFile

multipart/form-data kérés.

Form data param	Típus	Leírás
file	Bináris tartalom/file név	A fájl.
fileUploader	String	A feltöltő osztály neve, ha nincs megadva a default használatos.
filePath	String	A fájl elérési útja belül definiált roothoz képest.

Válasz

Név	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.

Minta