Comment API V1

REST API

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

Find comments

Kommentek listázása.

REST API

Kérés

GET hammy/json/comment/v1/comments

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.
createdFromDate	Date	A komment létrehozási intervallumának kezdő dátuma.
createdToDate	Date	A komment létrehozási intervallumának befejező dátuma.
updatedFromDate	Date	A komment legfrissebb módosítási intervallumának kezdő dátuma.
updatedToDate	Date	A komment legfrissebb módosítási intervallumának befejező dátuma.
commentPart	String	A komment tartalmának egy része.
entityType	String	Annak az elemnek a típusa, amihez a kommentet fűzték.
entityId	String	Annak az elemnek az azonosítója, amihez a kommentet fűzték.
createdBy	String	A komment létrehozójának felhasználóneve.
includeDeleted	Boolean	Törölt elemek megjelenítése.

Válasz

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

Minta

KérésVálasz

GET /hammy/json/comment/v1/comments
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/json

Query params:
-------------------------
commentPart={{commentPart}}
createdBy={{userName}}
createdFromDate={{YYYY-MM-DD}}
createdToDate={{YYYY-MM-DD}}
updatedFromDate={{YYYY-MM-DD}}
updatedToDate={{YYYY-MM-DD}}
includeDeleted={{true|false|null}} - delfault értéke false
entityType={{entityType}}
enitityId={{entityId}}

{{hammy-base}}/json/comment/v1/comments?commentPart=eg&createdFromDate=2021-10-05&createdToDate=2021-10-06&includeDeleted=TRUE&entityType=recipientgroup&entityId=xx

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

{
  "data": [
    {
      "type": "comments",
      "id": "158e76f1-bd46-4128-9346-256321d4f066",
      "attributes": {
        "entityType": "RECIPIENTGROUP",
        "entityId": "xx",
        "commentText": "Kiegészítő komment",
        "createdBy": "admin",
        "createdAt": "2021-10-05T16:21:40.254+0200",
        "updatedAt": "2021-10-05T16:21:40.254+0200"
      }
    }
  ],
  "meta": {
    "total": 1,
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Create comment

Új komment létrehozása.

REST API

REST API Info

Kérés

POST hammy/json/comment/v1/comments

body: JComment1

Válasz

Típus	Leírás
JComment1	A létrehozott komment.

Minta

KérésVálasz

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

{
    "data": {
      "id": "{{$guid}}",
      "type": "comments",
      "attributes": {
        "commentText": "Kiegészítő komment",
        "entityType": "RecipientGroup",
        "entityId": "xx"
      }
    }
}

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

{
  "data": {
    "type": "comments",
    "id": "158e76f1-bd46-4128-9346-256321d4f066",
    "attributes": {
      "entityType": "RECIPIENTGROUP",
      "entityId": "xx",
      "commentText": "Kiegészítő komment",
      "createdBy": "admin",
      "createdAt": "2021-10-05T16:21:40.254+0200",
      "updatedAt": "2021-10-05T16:21:40.254+0200"
    }
  },
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Update comment

Komment módosítása.

REST API

REST API Info

Kérés

PUT hammy/json/comment/v1/comments/{{commentUuid}}

body: JComment1

path

Név	Típus	Leírás
commentUuid	String	A módosítandó komment UUID-ja.

Válasz

Típus	Leírás
JComment1	A módosított komment.

Minta

KérésVálasz

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

{
    "data": {
        "id": "{{$guid}}",
        "type": "comments",
        "attributes": {
        "commentText": "Kiegészítő komment",
        "entityType": "RecipientGroup",
        "entityId": "xx"
        }
    }
}

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

{
  "data": {
    "type": "comments",
    "id": "158e76f1-bd46-4128-9346-256321d4f066",
    "attributes": {
      "entityType": "RECIPIENTGROUP",
      "entityId": "xx",
      "commentText": "Kiegészítő komment",
      "createdBy": "admin",
      "createdAt": "2021-10-05T16:21:40.254+0200",
      "updatedAt": "2021-10-05T16:21:40.254+0200"
    }
  },
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Delete comment

Komment törlése. Logikai törlés történik, azaz fizikailag nem töröljük ki a kommentet az adatbázisból, hanem deletedAt mezőt és státuszt állítunk a komment entitáson.

REST API

REST API Info

Kérés

DELETE hammy/json/comment/v1/comments/{{commentUuid}}

path

Név	Típus	Leírás
commentUuid	String	A törlendő komment UUID-ja.

Válasz

Név	Típus	Leírás
meta	JMeta1	Metaadatok.

Minta

KérésVálasz

DELETE /hammy/json/comment/v1/comments/{{commentuuid}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}

DELETE /hammy/json/comment/v1/comments/158e76f1-bd46-4128-9346-256321d4f066

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

{
  "data": {
    "type": "emptyResponse",
    "id": "d659070d-82a3-474a-89f2-f27f07d58a8f",
    "attributes": {}
  },
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}