Tag API V1
Find tags
Tagek keresése.
Web service API
Kérés
| Név | Típus | Leírás |
|---|---|---|
| requestMeta | RequestMeta_V1 | A kérés metaadatai. |
| limit | Integer | A keresési találatok maximális száma. |
| offset | Integer | A találati lista kezdete. |
| name | String | A tag neve. |
| description | String | A tag leírása. |
| createdAt | Date | A tag létrehozásának ideje. |
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. |
| tags | WTag1 [ ] | A tagek adatai. |
Minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.service.tag.api.chaingun.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ws:findTags>
<request>
<requestMeta>
<clientHashKey>?</clientHashKey>
</requestMeta>
</request>
</ws:findTags>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://ws.service.tag.api.chaingun.dbx.hu/">
<ns2:findTagsResponse>
<response>
<status>
<code>0</code>
<messages/>
</status>
<total>4</total>
<tags>
<tag>
<uuid>94fbdfa3-2b52-4fd9-9cb3-73e72cdfa007</uuid>
<name>Végső Teszt</name>
<description>Végső teszt tag api leírása megváltoztatva</description>
<createdAt>2021-08-24T11:44:05.008+02:00</createdAt>
</tag>
<tag>
<uuid>07a9d9cd-99f1-433b-a1fe-e9deff16c8e0</uuid>
<name>Teszt Tag</name>
<description>Ezt a taget apin keresztül hozom már létre!</description>
<createdAt>2021-08-17T14:06:14.550+02:00</createdAt>
</tag>
<tag>
<uuid>314e52a4-2eec-47e7-97eb-fa4568a47b38</uuid>
<name>Random</name>
<description>Ez egy teljesen random tag</description>
<createdAt>2021-08-06T15:07:55.002+02:00</createdAt>
</tag>
<tag>
<uuid>4da4484e-2b4f-46d5-a5f3-86e93982f833</uuid>
<name>Teszt</name>
<description>Ez egy teszt tag</description>
<createdAt>2021-08-06T15:01:49.776+02:00</createdAt>
</tag>
</tags>
</response>
</ns2:findTagsResponse>
</S:Body>
</S:Envelope>
REST API
Kérés
GET hammy/json/tag/v1/tags
| Név | 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. |
| name | String | A tag neve. |
| description | String | A tag leírása. |
| createdAtFrom | Date | A tag létrehozásának kezdete. |
| createdAtTo | Date | A tag létrehozásának vége. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| meta | JListMeta1 | A válaszhoz tartozó metaadatok. |
| list | JTag1 [ ] | A megtalált tagek. |
Minta
GET {{baseUrl}}/json/tag/v1/tags
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": "tags",
"id": "94fbdfa3-2b52-4fd9-9cb3-73e72cdfa007",
"attributes": {
"name": "Végső Teszt",
"description": "Végső teszt tag api leírása megváltoztatva",
"createdAt": "2021-08-24T11:44:05.008+0200"
}
},
{
"type": "tags",
"id": "07a9d9cd-99f1-433b-a1fe-e9deff16c8e0",
"attributes": {
"name": "Teszt Tag",
"description": "Ezt a taget apin keresztül hozom már létre!",
"createdAt": "2021-08-17T14:06:14.550+0200"
}
},
{
"type": "tags",
"id": "314e52a4-2eec-47e7-97eb-fa4568a47b38",
"attributes": {
"name": "Random",
"description": "Ez egy teljesen random tag",
"createdAt": "2021-08-06T15:07:55.002+0200"
}
},
{
"type": "tags",
"id": "4da4484e-2b4f-46d5-a5f3-86e93982f833",
"attributes": {
"name": "Teszt",
"description": "Ez egy teszt tag",
"createdAt": "2021-08-06T15:01:49.776+0200"
}
}
],
"meta": {
"total": 4,
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
Create tag
Tag létrehozása.
Web service API
Kérés
| Név | Típus | Leírás |
|---|---|---|
| requestMeta | RequestMeta_V1 | A kérés metaadatai. |
| tag | WTag1 | A létrehozandó tag. |
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. |
| tag | WTag1 | A létrehozott tag. |
Minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.service.tag.api.chaingun.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ws:createTag>
<request>
<requestMeta>
<clientHashKey>?</clientHashKey>
</requestMeta>
<tag>
<name>Új tag</name>
<description>Ez egy teljesen új tag</description>
</tag>
</request>
</ws:createTag>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://ws.service.tag.api.chaingun.dbx.hu/">
<ns2:createTagResponse>
<response>
<status>
<code>0</code>
<messages/>
</status>
<tag>
<uuid>66b35c99-d3fb-40b3-883d-1e6aaad0b2dd</uuid>
<name>Új tag</name>
<description>Ez egy teljesen új tag</description>
<createdAt>2021-08-25T13:45:24.130+02:00</createdAt>
</tag>
</response>
</ns2:createTagResponse>
</S:Body>
</S:Envelope>
REST API
Kérés
POST hammy/json/tag/v1/tags
body: JTag1
Válasz
| Típus | Leírás |
|---|---|
| JTag1 | A létrehozott tag. |
Minta
POST {{baseUrl}}/json/tag/v1/tags
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
{
"data": {
"type": "tags",
"attributes": {
"name": "Másik új tag",
"description": "Ez egy másik új tag"
}
}
}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "tags",
"id": "f4087929-cd09-436d-9c89-e85b315d37bc",
"attributes": {
"name": "Másik új tag",
"description": "Ez egy másik új tag",
"createdAt": "2021-08-25T13:48:31.412+0200"
}
},
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
Update tag
Tag adatainak módosítása.
Web service API
Kérés
| Név | Típus | Leírás |
|---|---|---|
| requestMeta | RequestMeta_V1 | A kérés metaadatai. |
| tag | WTag1 | A módosítandó tag. |
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. |
| tag | WTag1 | A módosított tag. |
Minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.service.tag.api.chaingun.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ws:updateTag>
<request>
<requestMeta>
<clientHashKey>?</clientHashKey>
</requestMeta>
<tag>
<uuid>66b35c99-d3fb-40b3-883d-1e6aaad0b2dd</uuid>
<description>Új tag leírása módosítva</description>
</tag>
</request>
</ws:updateTag>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://ws.service.tag.api.chaingun.dbx.hu/">
<ns2:updateTagResponse>
<response>
<status>
<code>0</code>
<messages/>
</status>
<tag>
<uuid>66b35c99-d3fb-40b3-883d-1e6aaad0b2dd</uuid>
<name>Új tag</name>
<description>Új tag leírása módosítva</description>
<createdAt>2021-08-25T13:45:24.130+02:00</createdAt>
</tag>
</response>
</ns2:updateTagResponse>
</S:Body>
</S:Envelope>
REST API
Kérés
PUT hammy/json/tag/v1/tags/{{uuid}}
body: JTag1
path
| Név | Típus | Leírás |
|---|---|---|
| uuid | String | A módosítandó tag UUID-ja. |
Válasz
| Típus | Leírás |
|---|---|
| JTag1 | A módosított tag. |
Minta
PUT {{baseUrl}}/json/tag/v1/tags/{tagUuid}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
{
"data": {
"type": "tags",
"attributes": {
"description": "Másik új tag leírása módosítva."
}
}
}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "tags",
"id": "f4087929-cd09-436d-9c89-e85b315d37bc",
"attributes": {
"name": "Másik új tag",
"description": "Másik új tag leírása módosítva.",
"createdAt": "2021-08-25T13:48:31.412+0200"
}
},
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
Delete tag
Tag törlé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 törlendő tag UUID-je. |
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
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.service.tag.api.chaingun.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ws:deleteTag>
<request>
<requestMeta>
<clientHashKey>?</clientHashKey>
</requestMeta>
<uuid>66b35c99-d3fb-40b3-883d-1e6aaad0b2dd</uuid>
</request>
</ws:deleteTag>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://ws.service.tag.api.chaingun.dbx.hu/">
<ns2:deleteTagResponse>
<response>
<status>
<code>0</code>
<messages/>
</status>
</response>
</ns2:deleteTagResponse>
</S:Body>
</S:Envelope>
REST API
Kérés
DELETE hammy/json/tag/v1/tags/{{uuid}}
path
| Név | Típus | Leírás |
|---|---|---|
| uuid | String | A törlendő tag UUID-ja. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| meta | JMeta1 | Metaadatok. |
Minta
DELETE {{baseUrl}}/json/tag/v1/tags/{tagUuid}
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": "emptyResponse",
"id": "603db9f6-01ff-4202-8ca1-a32af0bc0aad",
"attributes": {}
},
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
Find tagged objects
Tagelt objektumok megkeresése egy adott taghez.
Web service API
Kérés
| Név | Típus | Leírás |
|---|---|---|
| requestMeta | RequestMeta_V1 | A kérés metaadatai. |
| limit | Integer | A keresési találatok maximális száma. |
| offset | Integer | A találati lista kezdete. |
| tagUuid | String | A tag UUID azonosítója. |
| refType | String | A tagelt objektum típusa. |
| taggedObjectUuid | String | A tagelt objektum UUID 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. |
| total | Integer | Találatok száma. |
| taggedObjects | WTaggedObject1 [ ] | Tagelt objektumok adatai. |
Minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.service.tag.api.chaingun.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ws:findTaggedObjects>
<request>
<requestMeta>
<clientHashKey>?</clientHashKey>
</requestMeta>
<tagUuid>94fbdfa3-2b52-4fd9-9cb3-73e72cdfa007</tagUuid>
</request>
</ws:findTaggedObjects>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://ws.service.tag.api.chaingun.dbx.hu/">
<ns2:findTaggedObjectsResponse>
<response>
<status>
<code>0</code>
<messages/>
</status>
<total>4</total>
<taggedObjects>
<taggedObject>
<tagUuid>94fbdfa3-2b52-4fd9-9cb3-73e72cdfa007</tagUuid>
<refType>campaign</refType>
<taggedObjectUuid>5db89447-3863-46f8-aa53-e6dfb17b6e14</taggedObjectUuid>
</taggedObject>
<taggedObject>
<tagUuid>94fbdfa3-2b52-4fd9-9cb3-73e72cdfa007</tagUuid>
<refType>campaign</refType>
<taggedObjectUuid>49a36796-d8ea-40d7-bac4-c18318e511a2</taggedObjectUuid>
</taggedObject>
<taggedObject>
<tagUuid>94fbdfa3-2b52-4fd9-9cb3-73e72cdfa007</tagUuid>
<refType>message</refType>
<taggedObjectUuid>32da8c7b-43d1-47f0-b387-2deef8fa7dc0</taggedObjectUuid>
</taggedObject>
<taggedObject>
<tagUuid>94fbdfa3-2b52-4fd9-9cb3-73e72cdfa007</tagUuid>
<refType>campaign</refType>
<taggedObjectUuid>2703153e-ab67-4071-9010-667131bff09c</taggedObjectUuid>
</taggedObject>
</taggedObjects>
</response>
</ns2:findTaggedObjectsResponse>
</S:Body>
</S:Envelope>
REST API
Kérés
GET hammy/json/tag/v1/tags/{{uuid}}
path
| Név | Típus | Leírás |
|---|---|---|
| uuid | String | A keresett tag UUID-ja. |
| Paraméter | Típus | Leírás |
|---|---|---|
| tagUuid | String | A tag UUID azonosítója. |
| refType | String | A tagelt objektum típusa. |
| taggedObjectUuid | String | A tagelt objektum UUID azonosítója. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| meta | JListMeta1 | A válaszhoz tartozó metaadatok. |
| list | JTaggedObject1 [ ] | A megtalált objektumok. |
Minta
GET {{baseUrl}}/json/tag/v1/tags/{tagUuid}
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": "taggedObjects",
"id": "5db89447-3863-46f8-aa53-e6dfb17b6e14",
"attributes": {
"refType": "campaign",
"tagUuid": "94fbdfa3-2b52-4fd9-9cb3-73e72cdfa007"
}
},
{
"type": "taggedObjects",
"id": "49a36796-d8ea-40d7-bac4-c18318e511a2",
"attributes": {
"refType": "campaign",
"tagUuid": "94fbdfa3-2b52-4fd9-9cb3-73e72cdfa007"
}
},
{
"type": "taggedObjects",
"id": "32da8c7b-43d1-47f0-b387-2deef8fa7dc0",
"attributes": {
"refType": "message",
"tagUuid": "94fbdfa3-2b52-4fd9-9cb3-73e72cdfa007"
}
},
{
"type": "taggedObjects",
"id": "2703153e-ab67-4071-9010-667131bff09c",
"attributes": {
"refType": "campaign",
"tagUuid": "94fbdfa3-2b52-4fd9-9cb3-73e72cdfa007"
}
}
],
"meta": {
"total": 4,
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
Add tagged object
Tagelt objektum hozzáadása egy adott taghez.
Web service API
Kérés
| Név | Típus | Leírás |
|---|---|---|
| requestMeta | RequestMeta_V1 | A kérés metaadatai. |
| taggedObject | WTaggedObject1 | Tagelt objektum adatai. |
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. |
| taggedObject | WTaggedObject1 | Tagelt objektum adatai. |
Minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.service.tag.api.chaingun.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ws:addTaggedObject>
<request>
<requestMeta>
<clientHashKey>?</clientHashKey>
</requestMeta>
<taggedObject>
<tagUuid>07a9d9cd-99f1-433b-a1fe-e9deff16c8e0</tagUuid>
<refType>message</refType>
<taggedObjectUuid>32da8c7b-43d1-47f0-b387-2deef8fa7dc1</taggedObjectUuid>
</taggedObject>
</request>
</ws:addTaggedObject>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://ws.service.tag.api.chaingun.dbx.hu/">
<ns2:addTaggedObjectResponse>
<response>
<status>
<code>0</code>
<messages/>
</status>
<taggedObject>
<tagUuid>07a9d9cd-99f1-433b-a1fe-e9deff16c8e0</tagUuid>
<refType>message</refType>
<taggedObjectUuid>32da8c7b-43d1-47f0-b387-2deef8fa7dc1</taggedObjectUuid>
</taggedObject>
</response>
</ns2:addTaggedObjectResponse>
</S:Body>
</S:Envelope>
REST API
Kérés
POST hammy/json/tag/v1/tags/{{uuid}}
body: JTaggedObject1
path
| Név | Típus | Leírás |
|---|---|---|
| uuid | String | Az adott tag UUID-ja. |
Válasz
| Típus | Leírás |
|---|---|
| JTaggedObject1 | Az adott objektum. |
Minta
POST {{baseUrl}}/json/tag/v1/tags/{tagUuid}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
{
"data": {
"type": "taggedObjects",
"attributes": {
"refType": "message",
"taggedObjectUuid": "bfd412ab-b583-4318-ac13-e9d3fca21761"
}
}
}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "taggedObjects",
"id": "bfd412ab-b583-4318-ac13-e9d3fca21761",
"attributes": {
"refType": "message",
"tagUuid": "07a9d9cd-99f1-433b-a1fe-e9deff16c8e0"
}
},
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
Delete tagged object
Tagelt objektum törlése egy adott tagről.
Web service API
Kérés
| Név | Típus | Leírás |
|---|---|---|
| requestMeta | RequestMeta_V1 | A kérés metaadatai. |
| taggedObject | WTaggedObject1 | Tagelt objektum adatai. |
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. |
| taggedObject | WTaggedObject1 | Tagelt objektum adatai. |
Minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.service.tag.api.chaingun.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ws:deleteTaggedObject>
<request>
<requestMeta>
<clientHashKey>?</clientHashKey>
</requestMeta>
<taggedObject>
<tagUuid>07a9d9cd-99f1-433b-a1fe-e9deff16c8e0</tagUuid>
<refType>message</refType>
<taggedObjectUuid>32da8c7b-43d1-47f0-b387-2deef8fa7dc1</taggedObjectUuid>
</taggedObject>
</request>
</ws:deleteTaggedObject>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://ws.service.tag.api.chaingun.dbx.hu/">
<ns2:deleteTaggedObjectResponse>
<response>
<status>
<code>0</code>
<messages/>
</status>
</response>
</ns2:deleteTaggedObjectResponse>
</S:Body>
</S:Envelope>
REST API
Kérés
DELETE hammy/json/tag/v1/tags/{{uuid}}/deleteTaggedObject
body: JTaggedObject1
path
| Név | Típus | Leírás |
|---|---|---|
| uuid | String | Az adott tag UUID-ja. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| meta | JMeta1 | Metaadatok. |
Minta
DELETE {{baseUrl}}/json/tag/v1/tags/{tagUuid}/deleteTaggedObject
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
{
"data": {
"type": "taggedObjects",
"attributes": {
"refType": "message",
"taggedObjectUuid": "bfd412ab-b583-4318-ac13-e9d3fca21761"
}
}
}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "emptyResponse",
"id": "ae8645a6-8380-4b56-bb4c-e81cd73046fc",
"attributes": {}
},
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
Find all tagged objects
Tagelt objektumok keresése.
REST API
Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.
REST API
Kérés
GET hammy/json/tag/v1/taggedObjects
| 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. |
| taggedObjectUuid | String | A tagelt objektum UUID azonosítója. |
| refType | String | A tagelt objektum típusa. |
| tagUuid | String | A tag UUID azonosítója. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| meta | JListMeta1 | A válaszhoz tartozó metaadatok. |
| list | JTaggedObject1 [ ] | A megtalált objektumok. |
Minta
GET {{baseUrl}}/json/tag/v1/taggedObjects
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": "taggedObjects",
"id": "5db89447-3863-46f8-aa53-e6dfb17b6e14",
"attributes": {
"refType": "campaign",
"tagUuid": "94fbdfa3-2b52-4fd9-9cb3-73e72cdfa007"
}
},
{
"type": "taggedObjects",
"id": "49a36796-d8ea-40d7-bac4-c18318e511a2",
"attributes": {
"refType": "campaign",
"tagUuid": "94fbdfa3-2b52-4fd9-9cb3-73e72cdfa007"
}
},
{
"type": "taggedObjects",
"id": "32da8c7b-43d1-47f0-b387-2deef8fa7dc1",
"attributes": {
"refType": "message",
"tagUuid": "314e52a4-2eec-47e7-97eb-fa4568a47b38"
}
},
{
"type": "taggedObjects",
"id": "32da8c7b-43d1-47f0-b387-2deef8fa7dc0",
"attributes": {
"refType": "message",
"tagUuid": "314e52a4-2eec-47e7-97eb-fa4568a47b38"
}
},
{
"type": "taggedObjects",
"id": "32da8c7b-43d1-47f0-b387-2deef8fa7dc0",
"attributes": {
"refType": "message",
"tagUuid": "94fbdfa3-2b52-4fd9-9cb3-73e72cdfa007"
}
},
{
"type": "taggedObjects",
"id": "2703153e-ab67-4071-9010-667131bff09c",
"attributes": {
"refType": "campaign",
"tagUuid": "94fbdfa3-2b52-4fd9-9cb3-73e72cdfa007"
}
}
],
"meta": {
"total": 6,
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
Find tagged object tags
Tagelt objektumhoz csatolt tagek keresése.
Web service API
Kérés
| Név | Típus | Leírás |
|---|---|---|
| requestMeta | RequestMeta_V1 | A kérés metaadatai. |
| limit | Integer | A keresési találatok maximális száma. |
| offset | Integer | A találati lista kezdete. |
| name | String | A tag neve. |
| description | String | A tag leírása. |
| createdAt | Date | A tag létrehozásának ideje. |
| taggedObjectUuid | String | A tagelt objektum UUID 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. |
| total | Integer | Találatok száma. |
| tags | WTag1 [ ] | A tagek adatai. |
Minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.service.tag.api.chaingun.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ws:findTaggedObjectTags>
<request>
<requestMeta>
<clientHashKey>?</clientHashKey>
</requestMeta>
<taggedObjectUuid>32da8c7b-43d1-47f0-b387-2deef8fa7dc0</taggedObjectUuid>
</request>
</ws:findTaggedObjectTags>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://ws.service.tag.api.chaingun.dbx.hu/">
<ns2:findTaggedObjectTagsResponse>
<response>
<status>
<code>0</code>
<messages/>
</status>
<total>2</total>
<tags>
<tag>
<uuid>94fbdfa3-2b52-4fd9-9cb3-73e72cdfa007</uuid>
<name>Végső Teszt</name>
<description>Végső teszt tag api leírása megváltoztatva</description>
<createdAt>2021-08-24T11:44:05.008+02:00</createdAt>
</tag>
<tag>
<uuid>314e52a4-2eec-47e7-97eb-fa4568a47b38</uuid>
<name>Random</name>
<description>Ez egy teljesen random tag</description>
<createdAt>2021-08-06T15:07:55.002+02:00</createdAt>
</tag>
</tags>
</response>
</ns2:findTaggedObjectTagsResponse>
</S:Body>
</S:Envelope>
REST API
Kérés
GET hammy/json/tag/v1/taggedObjects/{{uuid}}
| 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. |
| name | String | A tag neve. |
| description | String | A tag leírása. |
| createdAtFrom | Date | A tag létrehozásának kezdete. |
| createdAtTo | Date | A tag létrehozásának vége. |
| taggedObjectUuid | String | A tagelt objektum UUID azonosítója. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| meta | JListMeta1 | A válaszhoz tartozó metaadatok. |
| list | JTag1 [ ] | A megtalált tagek. |
Minta
GET {{baseUrl}}/json/tag/v1/taggedObjects/{taggedObjectUuid}
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": "tags",
"id": "94fbdfa3-2b52-4fd9-9cb3-73e72cdfa007",
"attributes": {
"name": "Végső Teszt",
"description": "Végső teszt tag api leírása megváltoztatva",
"createdAt": "2021-08-24T11:44:05.008+0200"
}
},
{
"type": "tags",
"id": "314e52a4-2eec-47e7-97eb-fa4568a47b38",
"attributes": {
"name": "Random",
"description": "Ez egy teljesen random tag",
"createdAt": "2021-08-06T15:07:55.002+0200"
}
}
],
"meta": {
"total": 2,
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
Delete tagged object from all tags
Tagelt objektum törlése az összes tag-ről.
Web service API
Kérés
| Név | Típus | Leírás |
|---|---|---|
| requestMeta | RequestMeta_V1 | A kérés metaadatai. |
| taggedObject | WTaggedObject1 | A tagelt objektum. |
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
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.service.tag.api.chaingun.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<ws:deleteTaggedObjectFromAllTags>
<request>
<requestMeta>
<clientHashKey>?</clientHashKey>
</requestMeta>
<taggedObject>
<refType>message</refType>
<taggedObjectUuid>32da8c7b-43d1-47f0-b387-2deef8fa7dc1</taggedObjectUuid>
</taggedObject>
</request>
</ws:deleteTaggedObjectFromAllTags>
</soapenv:Body>
</soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<S:Body xmlns:ns2="http://ws.service.tag.api.chaingun.dbx.hu/">
<ns2:deleteTaggedObjectFromAllTagsResponse>
<response>
<status>
<code>0</code>
<messages/>
</status>
</response>
</ns2:deleteTaggedObjectFromAllTagsResponse>
</S:Body>
</S:Envelope>
REST API
Kérés
DELETE hammy/json/tag/v1/taggedObjects/{{uuid}}
body: JTaggedObject1
Válasz
| Név | Típus | Leírás |
|---|---|---|
| meta | JMeta1 | Metaadatok. |
Minta
DELETE {{baseUrl}}/json/tag/v1/taggedObjects/{taggedObjectUuid}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
{
"data": {
"type": "taggedObjects",
"attributes": {
"refType": "campaign"
}
}
}
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "emptyResponse",
"id": "a1a1f6c3-12d1-47db-b043-f6baca27c2dd",
"attributes": {}
},
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}