Shadow API V1

Create shadow job

Shadow job létrehozása.

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
requestedBy	String	A kérés feladója
requestReason	String	A kérés oka
requestComment	String	Kérés komment
shadowStore	String	Archiválás típusa, lehetséges értékek: ARCHIVE, DELETE *Ügyfélspecifikusan ez a mező nem elérhető.
filterType	String	Szűrő típusa
filterParams	Map	Szűrő paraméterei, kulcs-érték párokat tartalmaz, ami lehet objektum is.

A szűrők paraméterezésének leírása a Shadow marker selector oldalon található.

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.
shadowJobUuid	String	A létrehozott shadow job UUID-ja.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://chaingun.dbx.hu/api/shadow/v1">
    <soapenv:Header/>
    <soapenv:Body>
        <v1:createShadowJob>
            <!--Optional:-->
            <request>
                <!--Optional:-->
                <requestMeta>
                    <!--Optional:-->
                    <clientHashKey>{hashkey}</clientHashKey>
                    <!--Optional:-->
                    <userName>admin</userName>
                </requestMeta>
                <!--Optional:-->
                <requestedBy>admin</requestedBy>
                <!--Optional:-->
                <requestReason>reason</requestReason>
                <!--Optional:-->
                <requestComment>comment</requestComment>
                <!--Optional:-->
                <shadowStore>DELETE</shadowStore>
                <!--Optional:-->
                <filterType>byUuid</filterType>
                <!--Optional:-->
                <filterParams>{"identifier": "4cb7a359-aa62-4f8c-8c6e-483c743b914b"}</filterParams>
            </request>
        </v1:createShadowJob>
    </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:createShadowJobResponse xmlns:ns2="http://chaingun.dbx.hu/api/shadow/v1">
            <response>
                <status>
                    <code>0</code>
                    <messages/>
                </status>
                <params/>
                <shadowJobUuid>499a6013-6810-40a2-8f7c-a28e4f24691c</shadowJobUuid>
            </response>
        </ns2:createShadowJobResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

POST hammy/json/shadow/v1/shadows

Név	Típus	Leírás
requestedBy	String	A kérés feladója
requestReason	String	A kérés oka
requestComment	String	Kérés komment
shadowStore	String	Archiválás típusa, lehetséges értékek: ARCHIVE, DELETE *Ügyfélspecifikusan ez a mező nem elérhető.
filterType	String	Szűrő típusa
filterParams	String	Szűrő paraméterei (json)

Válasz

Név	Típus	Leírás
meta	JListMeta1	A válaszhoz tartozó metaadatok.
shadowJobUuid	String	A létrehozott shadow job UUID-ja.

Minta

KérésVálasz

POST /hammy/json/shadow/v1/shadows
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/json

{
    "requestedBy": "user",
    "requestReason": "reason",
    "requestComment": "comment",
    "shadowStore":"DELETE",
    "filterType": "byUuid",
    "filterParams": {
        "identifier": "4cb7a359-aa62-4f8c-8c6e-483c743b914b"
    }
}

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

{
  "meta": {
    "responseStatus": {
      "code": 0,
      "messages": []
    },
    "params": []
  },
  "shadowJobUuid": "4cb7a359-aa62-4f8c-8c6e-483c743b914b"
}

Show shadow job

Shadow 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.
withStats	Boolean	Statisztikák lekérdezése.

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	WShadowJob1	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/shadow/v1">
    <soapenv:Header/>
    <soapenv:Body>
        <v1:readShadowJob>
            <!--Optional:-->
            <request>
                <!--Optional:-->
                <requestMeta>
                    <!--Optional:-->
                    <clientHashKey>{hashkey}</clientHashKey>
                    <!--Optional:-->
                    <userName>admin</userName>
                </requestMeta>
                <!--Optional:-->
                <uuid>2bd9969e-7c31-4386-b4c9-28f0e116539f</uuid>
                <withStats>true</withStats>
            </request>
        </v1:readShadowJob>
    </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:readShadowJobResponse xmlns:ns2="http://chaingun.dbx.hu/api/shadow/v1">
            <response>
                <status>
                    <code>0</code>
                    <messages/>
                </status>
                <params/>
                <job>
                    <createdAt>2023-10-10T13:23:49.307Z</createdAt>
                    <uuid>2bd9969e-7c31-4386-b4c9-28f0e116539f</uuid>
                    <requestedBy>admin</requestedBy>
                    <requestReason>reason</requestReason>
                    <requestComment>comment</requestComment>
                    <filterType>type</filterType>
                    <filterParams>params</filterParams>
                    <status>MARKED</status>
                    <markedObjectCount>4</markedObjectCount>
                    <statistics>
                        <status>MARKED</status>
                        <objectCount>4</objectCount>
                    </statistics>
                </job>
            </response>
        </ns2:readShadowJobResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/shadow/v1/shadows/{{uuid}}

path

Név	Típus	Leírás
uuid	String	A job UUID-ja.
withStats	Boolean	Statisztikák lekérdezése.

Válasz

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

Minta

KérésVálasz

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

Query params:
-------------------------
uuid={{A lekérdezendő shadow job uuid-ja}}
withStats={{Statisztikák lekérdezése a válaszban, értékek: true|false, default false}}

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

{
  "meta": {
    "responseStatus": {
      "code": 0,
      "messages": []
    },
    "params": []
  },
  "createdAt": "2023-10-10T13:23:49.307+00:00",
  "uuid": "2bd9969e-7c31-4386-b4c9-28f0e116539f",
  "requestedBy": "admin",
  "requestReason": "reason",
  "requestComment": "comment",
  "filterType": "byUuid",
  "filterParams": {
    "identifier": "4cb7a359-aa62-4f8c-8c6e-483c743b914b"
  },
  "status": "MARKED",
  "markedObjectCount": 4,
  "statistics": [
    {
      "status": "MARKED",
      "objectCount": 4
    }
  ]
}

Find shadow jobs

Shadow job-ok 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	Szűrés egyedi azonosító alapján.
requestedBy	String	Szűrés a kérés feladója alapján.
requestReason	String	Szűrés a kérés oka alapján.
filterType	String	Szűrés a kérés típusa alapján.
statuses	String[]	Szűrés státusz alapján. Lehetséges értékek: NEW, PENDING, MARKED, ERROR
createdAtFrom	Date	Létrehozás dátuma intervallum alsó határa.
createdAtTo	Date	Létrehozás dátuma intervallum 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.
shadowJobs	WShadowJob1 [ ]	A keresett job-ok listája.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://chaingun.dbx.hu/api/shadow/v1">
    <soapenv:Header/>
    <soapenv:Body>
        <v1:findShadowJobs>
            <!--Optional:-->
            <request>
                <!--Optional:-->
                <requestMeta>
                    <!--Optional:-->
                    <clientHashKey>?</clientHashKey>
                    <!--Optional:-->
                    <userName>?</userName>
                    <!--Optional:-->
                    <params>
                        <!--Zero or more repetitions:-->
                        <param>
                            <key>?</key>
                            <value>?</value>
                            <!--Optional:-->
                            <ref>?</ref>
                        </param>
                    </params>
                </requestMeta>
                <!--Optional:-->
                <limit>?</limit>
                <!--Optional:-->
                <offset>?</offset>
                <!--Optional:-->
                <uuid>?</uuid>
                <!--Optional:-->
                <requestedBy>?</requestedBy>
                <!--Optional:-->
                <requestReason>?</requestReason>
                <!--Optional:-->
                <filterType>?</filterType>
                <!--Optional:-->
                <statuses>
                    <!--Zero or more repetitions:-->
                    <status>?</status>
                </statuses>
                <!--Optional:-->
                <createdAtFrom>?</createdAtFrom>
                <!--Optional:-->
                <createdAtTo>?</createdAtTo>
            </request>
        </v1:findShadowJobs>
    </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:findShadowJobsResponse xmlns:ns2="http://chaingun.dbx.hu/api/shadow/v1">
            <response>
                <status>
                    <code>0</code>
                    <messages/>
                </status>
                <params/>
                <total>4</total>
                <shadowJobs>
                    <status>
                        <createdAt>2023-10-11T13:51:00.734Z</createdAt>
                        <uuid>8a5d70ca-9def-4571-965b-fa88f63dc49e</uuid>
                        <requestedBy>admin</requestedBy>
                        <requestReason>Teszt</requestReason>
                        <requestComment>Teszt</requestComment>
                        <filterType>byUuid</filterType>
                        <filterParams>{"identifier":"388e277a-f5bf-c0f4-4432-a889b5e022bf"}</filterParams>
                        <status>MARKED</status>
                        <markedObjectCount>0</markedObjectCount>
                    </status>
                    <status>
                        <createdAt>2023-10-11T14:28:27.719Z</createdAt>
                        <uuid>4cb7a359-aa62-4f8c-8c6e-483c743b914b</uuid>
                        <requestedBy>admin</requestedBy>
                        <requestReason>Teszt</requestReason>
                        <requestComment>Teszt</requestComment>
                        <filterType>byUuid</filterType>
                        <filterParams>{"identifier":"388e277a-f5bf-c0f4-4432-a889b5e022bf"}</filterParams>
                        <status>MARKED</status>
                        <markedObjectCount>0</markedObjectCount>
                    </status>
                    <status>
                        <createdAt>2023-10-10T13:17:05.098Z</createdAt>
                        <uuid>97aeabe8-bb57-4133-98ef-631b12d2e7a4</uuid>
                        <requestedBy>admin</requestedBy>
                        <requestReason>Teszt</requestReason>
                        <requestComment>Teszt</requestComment>
                        <filterType>byUuid</filterType>
                        <filterParams>{"identifier":"388e277a-f5bf-c0f4-4432-a889b5e022bf"}</filterParams>
                        <status>MARKED</status>
                        <markedObjectCount>0</markedObjectCount>
                    </status>
                    <status>
                        <createdAt>2023-10-10T13:23:49.307Z</createdAt>
                        <uuid>2bd9969e-7c31-4386-b4c9-28f0e116539f</uuid>
                        <requestedBy>admin</requestedBy>
                        <requestReason>Teszt</requestReason>
                        <requestComment>Teszt</requestComment>
                        <filterType>byUuid</filterType>
                        <filterParams>{"identifier":"388e277a-f5bf-c0f4-4432-a889b5e022bf"}</filterParams>
                        <status>MARKED</status>
                        <markedObjectCount>4</markedObjectCount>
                    </status>
                </shadowJobs>
            </response>
        </ns2:findShadowJobsResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/shadow/v1/shadows

pathparam

Paraméter	Típus	Leírás
uuid	String	Szűrés egyedi azonosító alapján.
requestedBy	String	Szűrés a kérés feladója alapján.
requestReason	String	Szűrés a kérés oka alapján.
filterType	String	Szűrés a kérés típusa alapján.
statuses	String[]	Szűrés státusz alapján. Lehetséges értékek: NEW, PENDING, MARKED, ERROR
createdAtFrom	Date	Létrehozás dátuma intervallum alsó határa.
createdAtTo	Date	Létrehozás dátuma intervallum felső határa.

Válasz

Típus	Leírás
JShadowJob1 []	A keresett job-ok listája.

Minta

KérésVálasz

GET /hammy/json/shadow/v1/shadows
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": "shadowJobs",
      "id": "8a5d70ca-9def-4571-965b-fa88f63dc49e",
      "attributes": {
        "createdAt": "2023-10-11T13:51:00.734+00:00",
        "requestedBy": "admin",
        "requestReason": "Teszt",
        "requestComment": "Teszt",
        "filterType": "byUuid",
        "filterParams": {
          "identifier": "4cb7a359-aa62-4f8c-8c6e-483c743b914b"
        },
        "status": "MARKED",
        "markedObjectCount": 0
      }
    },
    {
      "type": "shadowJobs",
      "id": "4cb7a359-aa62-4f8c-8c6e-483c743b914b",
      "attributes": {
        "createdAt": "2023-10-11T14:28:27.719+00:00",
        "requestedBy": "admin",
        "requestReason": "Teszt",
        "requestComment": "Teszt",
        "filterType": "byUuid",
        "filterParams": {
          "identifier": "4cb7a359-aa62-4f8c-8c6e-483c743b914b"
        },
        "status": "MARKED",
        "markedObjectCount": 0
      }
    },
    {
      "type": "shadowJobs",
      "id": "97aeabe8-bb57-4133-98ef-631b12d2e7a4",
      "attributes": {
        "createdAt": "2023-10-10T13:17:05.098+00:00",
        "requestedBy": "admin",
        "requestReason": "Teszt",
        "requestComment": "Teszt",
        "filterType": "byUuid",
        "filterParams": {
          "identifier": "4cb7a359-aa62-4f8c-8c6e-483c743b914b"
        },
        "status": "MARKED",
        "markedObjectCount": 0
      }
    },
    {
      "type": "shadowJobs",
      "id": "2bd9969e-7c31-4386-b4c9-28f0e116539f",
      "attributes": {
        "createdAt": "2023-10-10T13:23:49.307+00:00",
        "requestedBy": "admin",
        "requestReason": "Teszt",
        "requestComment": "Teszt",
        "filterType": "byUuid",
        "filterParams": {
          "identifier": "4cb7a359-aa62-4f8c-8c6e-483c743b914b"
        },
        "status": "MARKED",
        "markedObjectCount": 4
      }
    }
  ],
  "meta": {
    "total": 4,
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Restore dump

Dump visszaállítása.

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
reference	String	A visszaállítandó dump fájl referenciája
password	String	A dump fájl jelszava (opcionális)

A dump fájlnak a konfigurált path-on kell lennie a visszaállítás folyamat elkezdéséhez.

Válasz

Név	Típus	Leírás
response	WRestoreDumpResult1	A visszaállítás eredménye

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://chaingun.dbx.hu/api/shadow/v1">
    <soapenv:Header/>
    <soapenv:Body>
        <v1:restoreDump>
            <!--Optional:-->
            <request>
                <!--Optional:-->
                <requestMeta>
                    <!--Optional:-->
                    <clientHashKey>{hashkey}</clientHashKey>
                    <!--Optional:-->
                    <userName>admin</userName>
                    <!--Optional:-->
                    <params>
                        <!--Zero or more repetitions:-->
                        <param>
                            <key>?</key>
                            <value>?</value>
                            <!--Optional:-->
                            <ref>?</ref>
                        </param>
                    </params>
                </requestMeta>
                <!--Optional:-->
                <reference>166f94e9-efcd-4b55-a72b-c9279d5892e2_202311021555.zip</reference>
                <!--Optional:-->
                <password>password</password>
            </request>
        </v1:restoreDump>
    </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:restoreDumpResponse xmlns:ns2="http://chaingun.dbx.hu/api/shadow/v1">
            <response>
                <status>
                    <code>0</code>
                    <messages/>
                </status>
                <params/>
                <restoreStatus>SUCCESSFUL</restoreStatus>
                <objectType>MESSAGE</objectType>
            </response>
        </ns2:restoreDumpResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

POST hammy/json/shadow/v1/shadows/restoreDump

Név	Típus	Leírás
reference	String	A visszaállítandó dump fájl referenciája
password	String	A dump fájl jelszava (opcionális)

Válasz

Típus	Leírás
JRestoreDumpResult1	A visszaállítás eredménye

Minta

KérésVálasz

POST /hammy/json/shadow/v1/shadows/restoreDump
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/json

{
  "reference": "166f94e9-efcd-4b55-a72b-c9279d5892e2_202311021555.zip",
  "password": "password"
}

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

{
  "meta": {
    "responseStatus": {
      "code": 0,
      "messages": []
    },
    "params": []
  },
  "restoreStatus": "SUCCESSFUL",
  "objectType": "MESSAGE",
  "objectRef": "a66e517f-5b56-492d-af56-a34ebc331957"
}