/Reaktion
Artikel
04/04/2023
2 Mitwirkende
Feedback
In diesem Artikel
API-Endpunkt für Abfragereaktionsdaten für jede Aktion, die in einer Gruppe gesendet wird.
POST /reaction
POST {endpoint-url}/v1/groups/{groupId}/reaction
Anforderungsparameter
Parameter
Typ
Optional?
Beschreibung
URL-Pfadparameter
groupId
Zeichenfolge
Nein
GUID, die die groupId der spezifischen Gruppenressource darstellt
HTTP-Header
accessToken
Zeichenfolge
Nein
Zugriffstoken, das vom Authentifizierungsendpunkt empfangen wird
HTTP-Header
Content-Type
Zeichenfolge
Nein
value: application/json
Anforderungstext
Parameter
Typ
Optional?
Beschreibung
referenceId
Zeichenfolge
Nein
GUID, die die ID für einen Entitätsverweis darstellt, der eine Aktion darstellt
sourceGroupId
Zeichenfolge
Nein
GUID der Gruppe, in der die Aktion gesendet wurde. Bei Gruppen, bei denen es sich um eine Untergruppe einer anderen Gruppe handelt, kann sich dies von "groupId" unterscheiden, die im url Path-Parameter angegeben ist.
reactionType
Zeichenfolge
Nein
Enumerationswert: "Gefällt mir"/"Kommentar"
Kommentar
String
Nein
Kommentartext ist nur für reactionType 'Comment' obligatorisch. Für "Gefällt mir" sollte dies ignoriert werden.
JSON-Beispielanforderung
{
"comment":"Comment-3",
"referenceId":"4a44e62f-5142-a980-c7a48e2d92a8",
"sourceGroupId":"fc6f2802-4431-b82f-60985a515b58",
"reactionType":"Comment"
}
Antworttext
Parameter
Typ
Beschreibung
reactionId
Zeichenfolge
GUID, die die ID für die Reaktionsentität nach erfolgreichem Abschluss der Anforderung darstellt
JSON-Beispielantwort
{
"reactionId": "71df-d53a-43cc-9b73-80dcc22502ab"
}
ZUSAMMENFASSUNG VON GET /reaction auf Aktionsebene
GET {endpoint-url}/v1/groups/{groupId}/reaction/{referenceId}/summary?sourceGroupId={sourceGroupId}
Anforderungsparameter
Parameter
Typ
Optional?
Beschreibung
URL-Pfadparameter
groupId
Zeichenfolge
Nein
GUID, die die groupId der spezifischen Gruppenressource darstellt
URL-Pfadparameter
referenceId
Zeichenfolge
Nein
GUID, die die ID für einen Entitätsverweis darstellt, der eine Aktion darstellt
URL-Pfadparameter
sourceGroupId
Zeichenfolge
Nein
GUID der Gruppe, in der die Aktion gesendet wurde
HTTP-Header
accessToken
Zeichenfolge
Nein
Zugriffstoken, das vom Authentifizierungsendpunkt empfangen wird
Antworttext
Parameter
Typ
Beschreibung
Zusammenfassung
JSON-Array
Array von JSON-Objekten, die jeweils die Zusammenfassung der Reaktionen auf eine in einer Gruppe gesendete Aktion darstellen
Zusammenfassungsobjekt des Antworttexts
Parameter
Typ
Beschreibung
referenceId
Zeichenfolge
GUID, die die ID für einen Entitätsverweis darstellt, der eine Aktion darstellt
reactionsCountMap
JSON-Objekt
Json-Objekt, das Likes und Kommentare für diese ReferenceId enthält
JSON-Beispielantwort
{
"summary": [
{
"referenceId": "4a44e62e-4b42-a980-c7a48e2d92a8",
"reactionsCountMap": {
"like": 1,
"comment": 4
}
}
]
}
ZUSAMMENFASSUNG VON GET /reaction auf Gruppenebene
GET {endpoint-url}/v1/groups/{groupId}/reaction/summary?sourceGroupId={sourceGroupId}&cursor={timeStamp}
Anforderungsparameter
Parameter
Typ
Optional?
Beschreibung
URL-Pfadparameter
groupId
Zeichenfolge
Nein
GUID, die die groupId der spezifischen Gruppenressource darstellt
URL-Pfadparameter
sourceGroupId
Zeichenfolge
Nein
GUID der Gruppe, in der die Aktion gesendet wurde
URL-Pfadparameter
Cursor
Timestamp
Nein
timeStamp, aus dem die Zusammenfassung berechnet werden muss. Standardwert 0
HTTP-Header
accessToken
Zeichenfolge
Nein
Zugriffstoken, das vom Authentifizierungsendpunkt empfangen wird
Antworttext
Parameter
Typ
Beschreibung
Cursor
Timestamp
timeStamp, bis zu dem die Zusammenfassung berechnet wurde. Der nächste ReaktionssatzSummary kann mithilfe dieses Cursorwerts generiert werden.
Zusammenfassung
JSON-Array
Array von JSON-Objekten, die jeweils die Zusammenfassung der Reaktionen auf eine in einer Gruppe gesendete Aktion darstellen
Zusammenfassungsobjekt des Antworttexts
Parameter
Typ
Beschreibung
referenceId
Zeichenfolge
GUID, die die ID für einen Entitätsverweis darstellt, der eine Aktion darstellt
reactionsCountMap
JSON-Objekt
Json-Objekt, das Likes und Kommentare für diese ReferenceId enthält
JSON-Beispielantwort
{
"cursor": 636674054802000000,
"summary": [
{
"referenceId": "4a44-51be-4b42-a980-c7a48e2d92a8",
"reactionsCountMap": {
"like": 1,
"comment": 4
}
},
{
"referenceId": "4a44-51be-4b420-c7a48e2d92a8",
"reactionsCountMap": {
"like": 10,
"comment": 14
}
}
]
}
GET/reaction-Details für eine Aktion
GET {endpoint-url}/v1/groups/{groupId}/reaction/{referenceId}?sourceGroupId={sourceGroupId}&reactionType={reactionType}&cursor={timeStamp}
Anforderungsparameter
Parameter
Typ
Optional?
Beschreibung
URL-Pfadparameter
groupId
Zeichenfolge
Nein
GUID, die die groupId der spezifischen Gruppenressource darstellt
URL-Pfadparameter
sourceGroupId
Zeichenfolge
Nein
GUID der Gruppe, in der die Aktion gesendet wurde
URL-Pfadparameter
referenceId
Zeichenfolge
Nein
GUID, die die ID für einen Entitätsverweis darstellt, der eine Aktion darstellt
URL-Pfadparameter
reactionType
Zeichenfolge
Nein
Enumerationswert: "Gefällt mir"/"Kommentar"
URL-Pfadparameter
Cursor
TimeStamp
Nein
TimeStamp, aus dem die Zusammenfassung berechnet werden muss. Standardwert 0
HTTP-Header
accessToken
Zeichenfolge
Nein
Zugriffstoken, das vom Authentifizierungsendpunkt empfangen wird
Antworttext
Parameter
Typ
Beschreibung
Cursor
TimeStamp
TimeStamp, bis zu dem reactionDetail bereitgestellt wurde. Der nächste Satz von reactionDetails kann mithilfe dieses Cursorwerts generiert werden.
reactionDetails
JSON-Array
Array von JSON-Objekten, die jeweils Reaktionsdetails für eine aktion darstellen, die in einer Gruppe gesendet wird
Zusammenfassungsobjekt des Antworttexts
Parameter
Typ
Beschreibung
reactionId
Zeichenfolge
GUID, die die ID für die Reaktion darstellt, die mit referenceId erstellt wurde, die eine Aktion darstellt
userId
JSON-Objekt
UserId für den Benutzer, der die Reaktion auf eine Aktion erstellt hat
lastModifiedTime
Zeitstempel
Zeitstempel, bei dem die Reaktion erstellt/aktualisiert wurde
JSON-Beispielantwort
{
"cursor": 636674054802000000,
"reactionDetails": [
{
"lastModifiedTime": 1529573303063,
"reactionId": "4b2fb78b-b529-4fa1-acda-f670b491ebca",
"userId": "72e29591-f391-4e7b-84eb-4e228406fb9b"
},
{
"lastModifiedTime": 1529573313063,
"reactionId": "4b2fb7529-4fa1-acda-f670b491ebca",
"userId": "72e29591-f391-4eb-4e228406fb9b"
}
]
}