Job API V1

Find jobs

Jobok keresése.

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
offset	Integer	A találati lista kezdete.
limit	Integer	A keresési találatok maximális száma.
jobClasses	String [ ]	A jobok osztályai.
statuses	String [ ]	A jobok státuszai.
createdAtFrom	Date	A létrehozási idő alsó határa.
createdAtTo	Date	A létrehozási idő felső határa.

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.
total	Integer	Találatok száma.
jobs	WJob1 [ ]	Megtalálat jobok.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://chaingun.dbx.hu/api/job/v1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:findJobs>
         <request>
            <requestMeta>
               <clientHashKey>{clientHashKey}</clientHashKey>
               <userName>admin</userName>
            </requestMeta>
            <limit>2</limit>
            <offset>0</offset>
            <statuses>
               <status>FINISHED</status>
            </statuses>
            <createdAtFrom>2025-02-10</createdAtFrom>
            <createdAtTo>2025-02-11</createdAtTo>
         </request>
      </v1:findJobs>
   </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>
      <ns2:findJobsResponse xmlns:ns2="http://chaingun.dbx.hu/api/job/v1" xmlns:ns3="http://chaingun.dbx.hu/model/job/v1">
         <response>
            <status>
               <code>0</code>
               <messages/>
            </status>
            <params/>
            <total>342</total>
            <jobs>
               <job>
                  <uuid>01afb93a-a8f3-4867-8433-272717d28fad</uuid>
                  <jobClass>hu.dbx.hammy.processor.lifecourse.LifeCourseStatusUpdaterJob</jobClass>
                  <status>FINISHED</status>
                  <createdAt>2025-02-10T23:55:00.190+01:00</createdAt>
                  <startedAt>2025-02-10T23:55:06.026+01:00</startedAt>
                  <finishedAt>2025-02-10T23:55:06.173+01:00</finishedAt>
                  <updatedAt>2025-02-10T23:55:06.176+01:00</updatedAt>
                  <jobParams/>
               </job>
               <job>
                  <uuid>710ef9cd-d118-461d-9e66-db22a915eee2</uuid>
                  <jobClass>hu.dbx.hammy.processor.lifecourse.LifeCourseStatusUpdaterJob</jobClass>
                  <status>FINISHED</status>
                  <createdAt>2025-02-10T23:50:00.489+01:00</createdAt>
                  <startedAt>2025-02-10T23:50:06.044+01:00</startedAt>
                  <finishedAt>2025-02-10T23:50:06.181+01:00</finishedAt>
                  <updatedAt>2025-02-10T23:50:06.183+01:00</updatedAt>
                  <jobParams/>
               </job>
            </jobs>
         </response>
      </ns2:findJobsResponse>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/job/v1/jobs

Paraméter	Típus	Leírás
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.
rootJobId	String	A gyökérelem azonosítója.
jobClasses	String [ ]	A jobok osztályai.
statuses	String [ ]	A jobok státuszai.
createdAtFrom	Date	A létrehozási idő alsó határa.
createdAtTo	Date	A létrehozási idő felső határa.

Válasz

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

Minta

KérésVálasz

GET: hammy/json/job/v1/jobs
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}

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

{
  "data": [
    {
      "type": "jobs",
      "id": "3ec9d30c-9251-4bd9-8417-a63e7184326c",
      "attributes": {
        "jobClass": "hu.dbx.hammy.processor.statistics.StatisticsSendingHandlerJobRunner",
        "status": "FAILED",
        "createdAt": "2024-05-09T22:34:01.391+02:00",
        "startedAt": "2024-05-09T22:34:44.864+02:00",
        "finishedAt": "2024-05-09T22:34:47.832+02:00",
        "updatedAt": "2024-05-09T22:34:47.865+02:00",
        "jobParams": []
      }
    },
    {
      "type": "jobs",
      "id": "3e3ec5f1-9d37-4937-8200-2983713c863d",
      "attributes": {
        "jobClass": "hu.dbx.chaingun.processor.queue.QueueItemSynchronizerJobRunner",
        "status": "FINISHED",
        "createdAt": "2024-05-08T08:20:20.402+02:00",
        "startedAt": "2024-05-08T08:27:21.063+02:00",
        "finishedAt": "2024-05-08T08:27:21.195+02:00",
        "updatedAt": "2024-05-08T08:27:21.416+02:00",
        "jobParams": [
          {
            "key": "LIMIT_DATE",
            "value": "2024-05-08T08:20:20+02"
          },
          {
            "key": "QUEUE_NAME",
            "value": "returnPathQueueError"
          }
        ]
      }
    },
    {
      "type": "jobs",
      "id": "043faf80-dee0-40e2-8f5b-183e5e127ed9",
      "attributes": {
        "jobClass": "hu.dbx.chaingun.processor.queue.QueueItemSynchronizerJobRunner",
        "status": "FINISHED",
        "createdAt": "2024-05-08T07:37:25.707+02:00",
        "startedAt": "2024-05-08T07:37:34.248+02:00",
        "finishedAt": "2024-05-08T07:38:02.925+02:00",
        "updatedAt": "2024-05-08T07:38:03.111+02:00",
        "jobParams": [
          {
            "key": "LIMIT_DATE",
            "value": "2024-05-08T07:37:25+02"
          },
          {
            "key": "QUEUE_NAME",
            "value": "returnPathQueueError"
          }
        ]
      }
    },
    {
      "type": "jobs",
      "id": "2762717e-31c5-4a05-b729-08b1868a2da4",
      "attributes": {
        "jobClass": "hu.dbx.hammy.processor.statistics.StatisticsSendingHandlerJobRunner",
        "status": "FAILED",
        "createdAt": "2024-05-07T12:47:50.079+02:00",
        "startedAt": "2024-05-07T12:49:38.781+02:00",
        "finishedAt": "2024-05-07T12:49:41.239+02:00",
        "updatedAt": "2024-05-07T12:49:41.269+02:00",
        "jobParams": []
      }
    },
    {
      "type": "jobs",
      "id": "fc4ceff4-61df-40ec-8b3e-878d1709eb55",
      "attributes": {
        "jobClass": "hu.dbx.hammy.processor.statistics.StatisticsSendingHandlerJobRunner",
        "status": "FAILED",
        "createdAt": "2024-05-07T11:32:01.238+02:00",
        "startedAt": "2024-05-07T11:32:45.611+02:00",
        "finishedAt": "2024-05-07T11:32:49.786+02:00",
        "updatedAt": "2024-05-07T11:32:50.029+02:00",
        "jobParams": []
      }
    },
    {
      "type": "jobs",
      "id": "0ecd8fe7-bf4b-4ae2-bbae-302522668b09",
      "attributes": {
        "jobClass": "hu.dbx.hammy.processor.statistics.StatisticsSendingHandlerJobRunner",
        "status": "FAILED",
        "createdAt": "2024-05-06T15:18:13.915+02:00",
        "startedAt": "2024-05-06T15:18:57.280+02:00",
        "finishedAt": "2024-05-06T15:19:00.516+02:00",
        "updatedAt": "2024-05-06T15:19:00.604+02:00",
        "jobParams": []
      }
    },
    {
      "type": "jobs",
      "id": "71200d7b-ebfb-4ada-8fe8-4d2ca104490b",
      "attributes": {
        "jobClass": "hu.dbx.hammy.processor.statistics.StatisticsSendingHandlerJobRunner",
        "status": "FAILED",
        "createdAt": "2024-04-24T12:56:08.695+02:00",
        "startedAt": "2024-04-24T20:19:38.096+02:00",
        "finishedAt": "2024-04-24T20:19:47.026+02:00",
        "updatedAt": "2024-04-24T20:19:47.216+02:00",
        "jobParams": []
      }
    },
    {
      "type": "jobs",
      "id": "a0dab618-6bf3-4f8c-9764-384b735a469c",
      "attributes": {
        "jobClass": "hu.dbx.chaingun.processor.queue.QueueItemSynchronizerJobRunner",
        "status": "FINISHED",
        "createdAt": "2024-03-21T10:43:07.941+01:00",
        "startedAt": "2024-03-21T10:43:34.041+01:00",
        "finishedAt": "2024-03-21T10:43:34.071+01:00",
        "updatedAt": "2024-04-03T14:54:26.113+02:00",
        "jobParams": [
          {
            "key": "LIMIT_DATE",
            "value": "2024-03-21T10:43:07+01"
          },
          {
            "key": "QUEUE_NAME",
            "value": "archiveQueueError"
          }
        ]
      }
    },
    {
      "type": "jobs",
      "id": "461170d3-901c-464f-9292-2827c591fe55",
      "attributes": {
        "jobClass": "hu.dbx.chaingun.processor.queue.QueueItemSynchronizerJobRunner",
        "status": "FINISHED",
        "createdAt": "2024-03-21T10:42:17.113+01:00",
        "startedAt": "2024-03-21T10:42:34.070+01:00",
        "finishedAt": "2024-03-21T10:42:34.148+01:00",
        "updatedAt": "2024-04-03T14:54:26.092+02:00",
        "jobParams": [
          {
            "key": "LIMIT_DATE",
            "value": "2024-03-21T10:42:16+01"
          },
          {
            "key": "QUEUE_NAME",
            "value": "outgoingMailQueueError"
          }
        ]
      }
    },
    {
      "type": "jobs",
      "id": "b87d159f-cc80-4b15-9e57-982ef9b1b990",
      "attributes": {
        "jobClass": "hu.dbx.hammy.processor.suspend.SuspendRequestHandlerJobRunner",
        "status": "FINISHED",
        "createdAt": "2024-03-13T14:12:09.216+01:00",
        "startedAt": "2024-03-13T14:12:31.089+01:00",
        "finishedAt": "2024-03-13T14:12:31.108+01:00",
        "updatedAt": "2024-04-03T14:54:26.067+02:00",
        "jobParams": [
          {
            "key": "templates.suspended_to_enabled",
            "value": "Teszt0206"
          }
        ]
      }
    },
    {
      "type": "jobs",
      "id": "b74e3444-22ab-4df8-b34d-5f8825d73f6a",
      "attributes": {
        "jobClass": "hu.dbx.hammy.processor.suspend.SuspendRequestHandlerJobRunner",
        "status": "FINISHED",
        "createdAt": "2024-03-13T14:12:03.672+01:00",
        "startedAt": "2024-03-13T14:12:30.960+01:00",
        "finishedAt": "2024-03-13T14:12:31.054+01:00",
        "updatedAt": "2024-04-03T14:54:26.055+02:00",
        "jobParams": [
          {
            "key": "templates.suspended_to_enabled",
            "value": "Teszt0206"
          }
        ]
      }
    },
    {
      "type": "jobs",
      "id": "6d9effdf-543e-406d-8a53-43c5924a67c2",
      "attributes": {
        "jobClass": "hu.dbx.hammy.processor.suspend.SuspendRequestHandlerJobRunner",
        "status": "FINISHED",
        "createdAt": "2024-03-01T19:39:29.667+01:00",
        "startedAt": "2024-03-01T19:39:56.110+01:00",
        "finishedAt": "2024-03-01T19:39:56.126+01:00",
        "updatedAt": "2024-04-03T14:54:24.864+02:00",
        "jobParams": [
          {
            "key": "templates.suspended_to_enabled",
            "value": "TesztPdf"
          }
        ]
      }
    },
    {
      "type": "jobs",
      "id": "19fe5cc3-f6d4-4ef3-b399-3a89b2fd00b7",
      "attributes": {
        "jobClass": "hu.dbx.hammy.processor.suspend.SuspendRequestHandlerJobRunner",
        "status": "FINISHED",
        "createdAt": "2024-03-01T19:26:20.190+01:00",
        "startedAt": "2024-03-01T19:26:26.134+01:00",
        "finishedAt": "2024-03-01T19:26:26.179+01:00",
        "updatedAt": "2024-04-03T14:54:24.839+02:00",
        "jobParams": [
          {
            "key": "templates.suspended_to_enabled",
            "value": "TesztEmail"
          }
        ]
      }
    },
    {
      "type": "jobs",
      "id": "3b62cbfd-bf17-4950-99d0-05f95e344ede",
      "attributes": {
        "jobClass": "hu.dbx.hammy.processor.suspend.SuspendRequestHandlerJobRunner",
        "status": "FINISHED",
        "createdAt": "2024-02-21T11:03:22.911+01:00",
        "startedAt": "2024-03-01T11:06:06.129+01:00",
        "finishedAt": "2024-03-01T11:06:06.143+01:00",
        "updatedAt": "2024-04-03T14:53:30.299+02:00",
        "jobParams": [
          {
            "key": "templates.suspended_to_enabled",
            "value": "CLAIM_NOTIFICATION_EMAIL"
          }
        ]
      }
    },
    {
      "type": "jobs",
      "id": "d598e33c-1b8a-4c3c-bfbf-443691b36ccc",
      "attributes": {
        "jobClass": "hu.dbx.hammy.processor.suspend.SuspendRequestHandlerJobRunner",
        "status": "FINISHED",
        "createdAt": "2024-02-21T09:33:23.471+01:00",
        "startedAt": "2024-03-01T11:06:06.113+01:00",
        "finishedAt": "2024-03-01T11:06:06.122+01:00",
        "updatedAt": "2024-04-03T14:53:30.279+02:00",
        "jobParams": [
          {
            "key": "templates.suspended_to_enabled",
            "value": "Teszt0206"
          }
        ]
      }
    },
    {
      "type": "jobs",
      "id": "a8f2a1b4-2571-4b9e-8966-7e8df2b9dfc0",
      "attributes": {
        "jobClass": "hu.dbx.hammy.processor.suspend.SuspendRequestHandlerJobRunner",
        "status": "FINISHED",
        "createdAt": "2024-02-20T11:16:45.564+01:00",
        "startedAt": "2024-03-01T11:06:05.669+01:00",
        "finishedAt": "2024-03-01T11:06:05.680+01:00",
        "updatedAt": "2024-04-03T14:53:30.260+02:00",
        "jobParams": [
          {
            "key": "templates.suspended_to_enabled",
            "value": "TesztPdf"
          }
        ]
      }
    },
    {
      "type": "jobs",
      "id": "5c2c93f0-540d-40c8-acb8-e3400e075a6a",
      "attributes": {
        "jobClass": "hu.dbx.hammy.processor.suspend.SuspendRequestHandlerJobRunner",
        "status": "FINISHED",
        "createdAt": "2024-02-20T11:16:03.637+01:00",
        "startedAt": "2024-03-01T11:06:05.652+01:00",
        "finishedAt": "2024-03-01T11:06:05.662+01:00",
        "updatedAt": "2024-04-03T14:53:30.239+02:00",
        "jobParams": [
          {
            "key": "templates.suspended_to_enabled",
            "value": "TesztPdf"
          }
        ]
      }
    },
    {
      "type": "jobs",
      "id": "e8d4a827-247c-4a39-9f08-d5a10bf22428",
      "attributes": {
        "jobClass": "hu.dbx.hammy.processor.suspend.SuspendRequestHandlerJobRunner",
        "status": "FINISHED",
        "createdAt": "2024-02-20T11:15:55.605+01:00",
        "startedAt": "2024-03-01T11:06:05.638+01:00",
        "finishedAt": "2024-03-01T11:06:05.647+01:00",
        "updatedAt": "2024-04-03T14:53:30.221+02:00",
        "jobParams": [
          {
            "key": "templates.suspended_to_enabled",
            "value": "TesztPdf"
          }
        ]
      }
    },
    {
      "type": "jobs",
      "id": "6b96838b-3b53-4ac0-b2f9-78e23b963072",
      "attributes": {
        "jobClass": "hu.dbx.hammy.processor.suspend.SuspendRequestHandlerJobRunner",
        "status": "FINISHED",
        "createdAt": "2024-02-19T20:40:00.363+01:00",
        "startedAt": "2024-03-01T11:06:05.618+01:00",
        "finishedAt": "2024-03-01T11:06:05.632+01:00",
        "updatedAt": "2024-04-03T14:53:30.201+02:00",
        "jobParams": [
          {
            "key": "templates.suspended_to_enabled",
            "value": "TesztEmail"
          }
        ]
      }
    },
    {
      "type": "jobs",
      "id": "961a413e-7169-4a50-92ab-0ebd27c91396",
      "attributes": {
        "jobClass": "hu.dbx.chaingun.processor.queue.QueueItemSynchronizerJobRunner",
        "status": "FINISHED",
        "createdAt": "2024-02-05T08:44:42.347+01:00",
        "startedAt": "2024-03-01T10:59:58.172+01:00",
        "finishedAt": "2024-03-01T10:59:58.183+01:00",
        "updatedAt": "2024-04-03T14:53:30.106+02:00",
        "jobParams": [
          {
            "key": "LIMIT_DATE",
            "value": "2024-02-05T08:44:42+01"
          },
          {
            "key": "QUEUE_NAME",
            "value": "mailRequestQueueError"
          }
        ]
      }
    }
  ],
  "meta": {
    "total": 6885,
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Show job

Job adatainak lekérése.

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
uuid	String	A job UUID-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.
job	WJob1	A keresett job.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://chaingun.dbx.hu/api/job/v1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:showJob>
         <request>
            <requestMeta>
               <clientHashKey>{clientHashKey}</clientHashKey>
               <userName>admin</userName>
            </requestMeta>
            <uuid>ab399ef3-b3b1-4d3d-9529-d42191877692</uuid>
         </request>
      </v1:showJob>
   </soapenv:Body>
</soapenv:Envelope>

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://chaingun.dbx.hu/api/job/v1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:showJob>
         <request>
            <requestMeta>
               <clientHashKey>{clientHashKey}</clientHashKey>
               <userName>admin</userName>
            </requestMeta>
            <uuid>ab399ef3-b3b1-4d3d-9529-d42191877692</uuid>
         </request>
      </v1:showJob>
   </soapenv:Body>
</soapenv:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/job/v1/jobs/{{uuid}}

path

Név	Típus	Leírás
uuid	String	A job UUID-ja.

Válasz

Típus	Leírás
JJob1	A keresett job.

Minta

KérésVálasz

GET: /hammy/json/job/v1/jobs/{{uuid}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}

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

{
  "data": {
    "type": "jobs",
    "id": "f4cc537b-e579-4c36-a633-ddacd8398992",
    "attributes": {
      "jobClass": "hu.dbx.hammy.processor.lifecourse.LifeCourseStatusUpdaterJob",
      "status": "FINISHED",
      "createdAt": "2024-05-13T14:25:00.225+02:00",
      "startedAt": "2024-05-13T14:25:31.926+02:00",
      "finishedAt": "2024-05-13T14:25:32.090+02:00",
      "updatedAt": "2024-05-13T14:25:32.092+02:00",
      "jobParams": []
    }
  },
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

List job events

Job eseményeinek listázása.

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
uuid	String	A job UUID-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.
jobEvents	WJobEvent1 [ ]	A job eseményei.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://chaingun.dbx.hu/api/job/v1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:listJobEvents>
         <request>
            <requestMeta>
               <clientHashKey>221d316146c591897238</clientHashKey>
               <userName>admin</userName>
            </requestMeta>
            <uuid>ab399ef3-b3b1-4d3d-9529-d42191877692</uuid>
         </request>
      </v1:listJobEvents>
   </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>
      <ns2:listJobEventsResponse xmlns:ns2="http://chaingun.dbx.hu/api/job/v1" xmlns:ns3="http://chaingun.dbx.hu/model/job/v1">
         <response>
            <status>
               <code>0</code>
               <messages/>
            </status>
            <params/>
            <jobEvents>
               <uuid>457852a4-d5d4-4acb-a560-db926ca6c952</uuid>
               <createdAt>2025-02-11T13:10:06.202+01:00</createdAt>
               <eventName>FINISHED</eventName>
            </jobEvents>
         </response>
      </ns2:listJobEventsResponse>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/job/v1/jobs/{{uuid}}/events

path

Név	Típus	Leírás
uuid	String	A job UUID-ja.

Válasz

Név	Típus	Leírás
meta	JListMeta1	A válaszhoz tartozó metaadatok.
list	JJobEvent1 [ ]	A job eseményei.

Minta

KérésVálasz

GET: hammy/json/job/v1/jobs/{{uuid}}/events
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}

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

{
  "data": [
    {
      "type": "jobEvents",
      "id": "a31260a7-b0c1-484c-ae35-d878cd5a0220",
      "attributes": {
        "createdAt": "2024-05-13T14:25:32.090+02:00",
        "eventName": "FINISHED"
      }
    }
  ],
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

List relatives

Adott jobhoz kapcsolódó jobok lekérdezése.

REST API

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

REST API

REST API Info

Kérés

GET hammy/json/job/v1/jobs/{{uuid}}/relatives

path

Név	Típus	Leírás
uuid	String	A job UUID-ja.

Válasz

Név	Típus	Leírás
meta	JListMeta1	A válaszhoz tartozó metaadatok.
list	JJob1 [ ]	A kapcsolódó jobok.

Minta

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:v1="http://chaingun.dbx.hu/api/job/v1">
    <soapenv:Header/>
    <soapenv:Body>
        <v1:triggerJob>
            <request>
                <jobName>campaignJob</jobName>
                <requestMeta>
                    <clientHashKey>221d316146c591897238</clientHashKey>
                </requestMeta>
            </request>
        </v1:triggerJob>
    </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>
        <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

POST hammy/json/job/v1/jobs

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

json POST: hammy/json/job/v1/jobs?jobName=campaignJob Authorization: JWT {{jwtToken}} X-Client-Hash-Key: {{clientHashKey}} X-User-Name: {{userName}}

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

{
  "data": {
    "type": "jobResponses",
    "id": "2602328e-c5fc-4f60-9329-f91a256981f6",
    "attributes": {}
  },
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

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	Long [ ]	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:v1="http://chaingun.dbx.hu/api/job/v1">
    <soapenv:Header/>
    <soapenv:Body>
        <v1:setJobStatus>
            <request>
                <uuids>23aa0406-6ad8-4b77-8818-92083a01365b</uuids>
                <jobStatus>FINISHED</jobStatus>
                <requestMeta>
                    <clientHashKey>221d316146c591897238</clientHashKey>
                </requestMeta>
            </request>
        </v1:setJobStatus>
    </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>
        <ns2:setJobStatusResponse xmlns:ns2="http://chaingun.dbx.hu/api/job/v1" xmlns:ns3="http://chaingun.dbx.hu/model/jobs/v1">
            <response>
                <jobs>
                    <uuid>23aa0406-6ad8-4b77-8818-92083a01365b</uuid>
                    <jobClass>hu.dbx.hammy.processor.recipient.csv.ImportRecipientsJobRunner</jobClass>
                    <status>FINISHED</status>
                    <createdAt>2024-10-16T17:02:21.294+02:00</createdAt>
                    <startedAt>2024-10-16T17:02:28.692+02:00</startedAt>
                    <finishedAt>2024-10-16T17:02:28.755+02:00</finishedAt>
                    <updatedAt>2024-10-28T20:26:00.711+01:00</updatedAt>
                    <total>2</total>
                    <completed>2</completed>
                    <jobParams>
                        <jobParam>
                            <key>RESULT_RELATIVE_FILE_PATH</key>
                            <value>20241016/cb863668-9032-4533-b8ac-2e4863866184/b3088a71-c917-4e8c-b311-28ec36909926.csv-invalid-addresses.csv</value>
                        </jobParam>
                        <jobParam>
                            <key>RELATIVE_FILE_PATH</key>
                            <value>20241016/cb863668-9032-4533-b8ac-2e4863866184/b3088a71-c917-4e8c-b311-28ec36909926.csv</value>
                        </jobParam>
                        <jobParam>
                            <key>RECIPIENT_GROUP_UUID</key>
                            <value>cb863668-9032-4533-b8ac-2e4863866184</value>
                        </jobParam>
                        <jobParam>
                            <key>FILE_NAME</key>
                            <value>CÃmzett 2024.09.csv</value>
                        </jobParam>
                        <jobParam>
                            <key>FILE_CONTENT_CHECKSUM</key>
                            <value>30477ed0e5c8f156d446a3ea404839a64fac52f1</value>
                        </jobParam>
                        <jobParam>
                            <key>CSV_SEPARATOR</key>
                            <value>;</value>
                        </jobParam>
                        <jobParam>
                            <key>RECIPIENT_DUPLICATION_HANDLING_TYPE</key>
                            <value>ALLOW_DUPLICATIONS</value>
                        </jobParam>
                    </jobParams>
                </jobs>
                <status>
                    <code>0</code>
                    <messages/>
                </status>
            </response>
        </ns2:setJobStatusResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

PUT hammy/json/job/v1/jobs

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/job/v1/jobs
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}

{
  "jobStatus" : "CANCELLED",
  "jobId": ["280475"]
}

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

{
  "data": {
    "type": "jobResponses",
    "id": "d0715836-a0ad-481f-9bc9-1713f859aa4a",
    "attributes": {}
  },
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Job Infos

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:v1="http://chaingun.dbx.hu/api/job/v1">
    <soapenv:Header/>
    <soapenv:Body>
        <v1:getJobInfo>
            <request>
                <uuid>23aa0406-6ad8-4b77-8818-92083a01365b</uuid>
                <requestMeta>
                    <clientHashKey>{clientHashKey}</clientHashKey>
                </requestMeta>
            </request>
        </v1:getJobInfo>
    </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>
        <ns2:getJobInfoResponse xmlns:ns2="http://chaingun.dbx.hu/api/job/v1" xmlns:ns3="http://chaingun.dbx.hu/model/job/v1">
            <response>
                <jobInfo>
                    <jobId>280698</jobId>
                    <jobStatus>FINISHED</jobStatus>
                    <jobClass>hu.dbx.hammy.processor.recipient.csv.ImportRecipientsJobRunner</jobClass>
                    <createdAt>2024-10-16T17:02:21.294+02:00</createdAt>
                    <startedAt>2024-10-16T17:02:28.692+02:00</startedAt>
                    <finishedAt>2024-10-16T17:02:28.755+02:00</finishedAt>
                    <progressPct>100</progressPct>
                    <jobParams>
                        <param>
                            <key>TOTAL</key>
                            <value>2</value>
                        </param>
                        <param>
                            <key>FINISHED</key>
                            <value>2</value>
                        </param>
                        <param>
                            <key>RELATIVE_FILE_PATH</key>
                            <value>20241016/cb863668-9032-4533-b8ac-2e4863866184/b3088a71-c917-4e8c-b311-28ec36909926.csv</value>
                        </param>
                        <param>
                            <key>FILE_NAME</key>
                            <value>Cimzett 2024.09.csv</value>
                        </param>
                        <param>
                            <key>FILE_CONTENT_CHECKSUM</key>
                            <value>30477ed0e5c8f156d446a3ea404839a64fac52f1</value>
                        </param>
                        <param>
                            <key>RECIPIENT_DUPLICATION_HANDLING_TYPE</key>
                            <value>ALLOW_DUPLICATIONS</value>
                        </param>
                        <param>
                            <key>RECIPIENT_GROUP_UUID</key>
                            <value>cb863668-9032-4533-b8ac-2e4863866184</value>
                        </param>
                        <param>
                            <key>CSV_SEPARATOR</key>
                            <value>;</value>
                        </param>
                        <param>
                            <key>RESULT_RELATIVE_FILE_PATH</key>
                            <value>20241016/cb863668-9032-4533-b8ac-2e4863866184/b3088a71-c917-4e8c-b311-28ec36909926.csv-invalid-addresses.csv</value>
                        </param>
                    </jobParams>
                </jobInfo>
                <status>
                    <code>0</code>
                    <messages/>
                </status>
            </response>
        </ns2:getJobInfoResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/job/v1/jobInfos/{{uuid}}

Válasz

Név	Típus	Leírás
meta	JMeta1	Metaadatok.
uuid	String	Job uuid-ja
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/job/v1/jobInfos/{{jobUuid}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}

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

{
  "data": {
    "type": "getJobInfoResults",
    "attributes": {
      "jobInfo": {
        "jobId": 280698,
        "jobStatus": "FINISHED",
        "jobClass": "hu.dbx.hammy.processor.recipient.csv.ImportRecipientsJobRunner",
        "createdAt": "2024-10-16T17:02:21.294+02:00",
        "startedAt": "2024-10-16T17:02:28.692+02:00",
        "finishedAt": "2024-10-16T17:02:28.755+02:00",
        "progressPct": 100,
        "jobParams": [
          {
            "key": "TOTAL",
            "value": "2"
          },
          {
            "key": "FINISHED",
            "value": "2"
          },
          {
            "key": "FILE_CONTENT_CHECKSUM",
            "value": "30477ed0e5c8f156d446a3ea404839a64fac52f1"
          },
          {
            "key": "RESULT_RELATIVE_FILE_PATH",
            "value": "20241016/cb863668-9032-4533-b8ac-2e4863866184/b3088a71-c917-4e8c-b311-28ec36909926.csv-invalid-addresses.csv"
          },
          {
            "key": "RECIPIENT_GROUP_UUID",
            "value": "cb863668-9032-4533-b8ac-2e4863866184"
          },
          {
            "key": "CSV_SEPARATOR",
            "value": ";"
          },
          {
            "key": "FILE_NAME",
            "value": "Cimzett 2024.09.csv"
          },
          {
            "key": "RECIPIENT_DUPLICATION_HANDLING_TYPE",
            "value": "ALLOW_DUPLICATIONS"
          },
          {
            "key": "RELATIVE_FILE_PATH",
            "value": "20241016/cb863668-9032-4533-b8ac-2e4863866184/b3088a71-c917-4e8c-b311-28ec36909926.csv"
          }
        ]
      }
    }
  },
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}