Dynamisk signal (förhandsversion)
Dynamic Signal är en plattform för kommunikation och engagemang för anställda som är betrodd av organisationer för att ansluta, anpassa och engagera anställda. Anslut till Dynamisk signal för att skapa och hantera dina inlägg och användare.
Den här anslutningsappen är tillgänglig i följande produkter och regioner:
| Tjänster | Class | Regioner |
|---|---|---|
| Copilot Studio | Premie | Alla Power Automate-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Logiska appar | Norm | Alla Logic Apps-regioner utom följande: – Azure Government-regioner – Regioner i Azure Kina - US Department of Defense (DoD) |
| Power Apps | Premie | Alla Power Apps-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premie | Alla Power Automate-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Metadata för anslutningsprogram | |
|---|---|
| Utgivare | Dynamisk signal |
Skapa en anslutning
Anslutningsappen stöder följande autentiseringstyper:
| Standardinställning | Parametrar för att skapa anslutning. | Alla regioner | Går inte att dela |
Standard
Tillämpligt: Alla regioner
Parametrar för att skapa anslutning.
Det här är inte delningsbar anslutning. Om power-appen delas med en annan användare uppmanas en annan användare att skapa en ny anslutning explicit.
| Namn | Typ | Description | Krävs |
|---|---|---|---|
| Ägartoken | securestring | Ägartoken för det här API:et | Sann |
| Dynamisk signal-URL | snöre | Url:en där du kommer åt Dynamic Signal. | Sann |
Begränsningsgränser
| Name | Anrop | Förnyelseperiod |
|---|---|---|
| API-anrop per anslutning | 100 | 60 sekunder |
Åtgärder
| Förregistrera en användare |
Skapar en ny användare i förregistrerat tillstånd |
| Hantera inlägg |
Tillåter serverautentiserade anrop att uppdatera egenskaper för flera inlägg i en enda begäran |
| Hämta användartaggar |
Hämtar en lista över användartaggar som definierats i systemet |
| Hämta divisioner |
Hämtar listan över divisioner |
| Hämta en användare via e-post |
Hämtar en användare via sin e-postadress |
| Hämta ett inlägg |
Hämtar ett specifikt inlägg efter ID |
| Hämta kategorier |
Hämtar en lista över kategorier som är synliga för den autentiserade användaren |
| Hämta mål |
Hämtar en lista över communityns mål och måldefinitioner |
| Hämta posttaggar |
Hämtar posttaggar som definierats i systemet |
| Ladda upp bild |
Laddar upp en bild via binär uppladdning |
| Ladda upp ett dokument till ett inlägg |
Laddar upp ett dokument till ett inlägg via binär uppladdning |
| Lägga till en bild i ett inlägg via uppladdning |
Anger postbilden via binär uppladdning. |
| Lägga till en bild i ett inlägg via URL |
Anger postbilden via en URL. |
| Skapa ett inlägg |
Skapar ett inlägg. |
| Uppdatera ett inlägg |
Redigerar ett befintligt inlägg. |
Förregistrera en användare
Skapar en ny användare i förregistrerat tillstånd
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
E-postmeddelande
|
string |
Användarens e-postadress |
||
|
Externt SSO-användar-ID
|
externalSsoUserId | string |
Användarens ID på det externa systemet som hanteras av SSO-identitetsprovidern |
|
|
Handtag
|
handle | string |
Användarens handtag |
|
|
Förnamn
|
firstName | string |
Användarens förnamn. |
|
|
Efternamn
|
lastName | string |
Användarens efternamn. |
|
|
Division-ID:t
|
divisionIds | array of integer |
En lista över divisioner som användaren ska tilldelas till. |
|
|
Mål-ID:t
|
targetIds | array of integer |
En lista över mål som användaren ska tilldelas. |
|
|
Namn
|
name | string |
Taggen eller attributnamnet |
|
|
Värde
|
value | string |
Det valfria värdet |
|
|
Skicka e-postinbjudan
|
sendInvitationEmail | boolean |
Avgör om du vill skicka ett e-postmeddelande med inbjudan till användaren. |
|
|
Inbjudningsmeddelande
|
invitationMessage | string |
Ett valfritt oformaterad textmeddelande som ska inkluderas i e-postmeddelandet med inbjudan. |
|
|
Standard för meddelanden
|
notificationsDefault | string |
Ange som styr när användarna ska börja ta emot e-postaviseringar. |
|
|
Kan dela inlägg
|
canSharePosts | boolean |
Anger om användaren har möjlighet att dela inlägg |
|
|
Kan kommentera inlägg
|
canCommentPosts | boolean |
Anger om användaren har möjlighet att kommentera och gilla inlägg |
|
|
Kan skicka inlägg
|
canSubmitPosts | boolean |
Anger om användaren har möjlighet att skicka inlägg |
|
|
Kan hantera organisation
|
canManageOrganization | boolean |
Anger om användaren har möjlighet att kommunicera med direkta och indirekta rapporter i communityn |
Returer
- response
- userRequestResponse
Hantera inlägg
Tillåter serverautentiserade anrop att uppdatera egenskaper för flera inlägg i en enda begäran
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Post-ID:t
|
postIds | True | array of uuid |
Inläggen som ändras |
|
Etiketter
|
tags | array of string |
En samling taggnamn som kan tillämpas på inlägg |
|
|
Division-ID:t
|
divisionIds | array of integer |
De divisions-ID:t som inläggen tillhör |
|
|
Kategori-ID:t
|
categoryIds | array of integer |
Kategori-ID:t som inläggen tillhör |
|
|
Mål-ID:t
|
targetIds | array of integer |
Mål-ID:t som inläggen tillhör |
|
|
Tillstånd för godkännande
|
approvalState | string |
Godkännandetillståndet för inläggen (detta påverkas inte av DELETE-begäranden) |
Returer
Ett enkelt svar som anger att åtgärden har utförts
- response
- successResponse
Hämta användartaggar
Hämtar en lista över användartaggar som definierats i systemet
Returer
En lista över användartaggar som definierats i systemet
- response
- manageUserTagsResponse
Hämta divisioner
Hämtar listan över divisioner
Returer
De divisioner som definierats i systemet
- response
- divisionsResponse
Hämta en användare via e-post
Hämtar en användare via sin e-postadress
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
E-postmeddelande
|
True | string |
Användarens e-post |
|
|
Inbegripa
|
include | array of string |
Anger valfria data som ska returneras med användaren. |
Returer
- response
- userRequestResponse
Hämta ett inlägg
Hämtar ett specifikt inlägg efter ID
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
ID-nummer
|
id | True | uuid |
Post-ID:t.; Det här är den unika identifieraren för inlägget. |
|
Användar-ID
|
userId | integer |
Användaren som visar inlägget. Den inloggade användaren används om inget ID har angetts |
Returer
Ett inlägg
- response
- postResponse
Hämta kategorier
Hämtar en lista över kategorier som är synliga för den autentiserade användaren
Returer
Detaljerad information om kategorier
- response
- categoriesResponse
Hämta mål
Hämtar en lista över communityns mål och måldefinitioner
Returer
En lista över måldefinitioner och associerade mål för communityn.
- response
- targetDefinitionsInfoResponse
Hämta posttaggar
Hämtar posttaggar som definierats i systemet
Returer
En lista över posttaggar som definierats i systemet
- response
- managePostTagsResponse
Ladda upp bild
Laddar upp en bild via binär uppladdning
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
File
|
File | True | binary |
Fil som ska laddas upp |
|
Innehållstyp som bild/jpg, bild/pjpeg, bild/png, bild/x-png, bild/gif
|
Content-Type | True | string |
Innehållstyp för uppladdad fil |
Returer
- response
- uploadImageResponse
Ladda upp ett dokument till ett inlägg
Laddar upp ett dokument till ett inlägg via binär uppladdning
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Filnamn
|
fileName | True | string |
Dokumentets önskade filnamn (med tillägg) |
|
ID-nummer
|
id | True | uuid |
Post-ID:t |
|
File
|
File | True | binary |
Fil som ska laddas upp |
|
Innehållstyp som bild/jpg, bild/pjpeg, bild/png, bild/x-png, bild/gif
|
Content-Type | True | string |
Innehållstyp för uppladdad fil |
Returer
Information som är relevant för ett bifogat dokument
- response
- documentInfoResponse
Lägga till en bild i ett inlägg via uppladdning
Anger postbilden via binär uppladdning.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
ID-nummer
|
id | True | uuid |
Post-ID:t |
|
File
|
File | True | binary |
Fil som ska laddas upp |
|
Innehållstyp som bild/jpg, bild/pjpeg, bild/png, bild/x-png, bild/gif
|
Content-Type | True | string |
Innehållstyp för uppladdad fil |
Returer
Ett enkelt svar som anger att åtgärden har utförts
- response
- successResponse
Lägga till en bild i ett inlägg via URL
Anger postbilden via en URL.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
ID-nummer
|
id | True | uuid |
Post-ID: krävs: true |
|
URL
|
url | True | string |
HTTP- eller HTTPS-URL:en |
Returer
Ett enkelt svar som anger att åtgärden har utförts
- response
- successResponse
Skapa ett inlägg
Skapar ett inlägg.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Description
|
description | string |
Den korta beskrivningen av inlägget |
|
|
Taggrad
|
tagLine | string |
Taggraden i inlägget |
|
|
Content
|
content | string |
Brödtexten i inlägget |
|
|
Skaparkommentare
|
creatorComments | string |
Ett meddelande som är associerat med inlägget |
|
|
Perma-länk
|
permaLink | string |
Den externa URL som refereras av inlägget |
|
|
Interna diskussioner aktiverade
|
internalDiscussionsEnabled | boolean |
Om medlemmar får utföra liknande åtgärder och lägga till kommentarer om inlägg internt |
|
|
Titel
|
title | True | string |
Rubriken på inlägget |
|
Video-URL för medlem
|
memberVideoUrl | string |
Video-URL:en som refereras till av inlägget |
|
|
Posttyp
|
postType | string |
Den grundläggande typen av inlägg |
|
|
Tillstånd för godkännande
|
approvalState | string |
Godkännandetillståndet för inlägget. Standardinställningen för författarens granskningsstatus. |
|
|
Visningsläge
|
displayMode | string |
Anger omdirigering av ett inlägg till en intern eller extern plats |
|
|
Delbar
|
sharable | boolean |
Om VoiceStorm-plattformen och widgetarna tillåter att inlägget delas |
|
|
Startdatum
|
startDate | date-time |
Det datum efter vilket inlägget är tillgängligt för visning |
|
|
Slutdatum
|
endDate | date-time |
Datumet då inlägget inte längre är tillgängligt för visning |
|
|
Föreslagen delningstext
|
suggestedShareText | string |
Den föreslagna resurstexten för inlägget |
|
|
Kort föreslagen delningstext
|
shortSuggestedShareText | string |
Den föreslagna resurstexten för inlägget för korta meddelandeleverantörer |
|
|
Dela poäng
|
sharePoints | integer |
Antalet poäng som tilldelas när en användare delar inlägget |
|
|
Klicka på punkter
|
clickPoints | integer |
Antalet poäng som tilldelas när någon klickar på en delad länk till inlägget |
|
|
Dela med bilder
|
shareWithImages | boolean |
Styr om inlägg som delas till korta meddelandetjänster (som Twitter) har delade bilder |
|
|
Dela endast avbildningar
|
shareImagesOnly | boolean |
Kontroller om inlägg som delas till vissa tjänster behandlas som uppdateringar av endast bild/foto |
|
|
Namn
|
name | string |
Taggnamnet |
|
|
Language
|
language | string |
Språket för inläggsinnehållet |
|
|
Documents
|
documents | array of uuid |
En lista över dokument-ID:t som ska bifogas till det här inlägget |
|
|
Skapar-ID
|
creatorId | integer |
Användaren som skapar inlägget. Den här egenskapen är endast tillgänglig för serverautentiserade begäranden just nu. Alla andra inlägg anges automatiskt till den autentiserade användaren. |
|
|
Visa skapare
|
displayCreator | boolean |
Styr om skaparinformationen ska visas med inlägget eller inte. Den här egenskapen är endast tillgänglig för serverautentiserade begäranden just nu. |
|
|
Kategori-ID:t
|
categoryIds | array of integer |
En lista över kategori-ID:t som har tilldelats till inlägget |
|
|
Mål-ID:t
|
targetIds | array of integer |
En lista över mål-ID:t som har tilldelats till inlägget |
Returer
Ett inlägg
- response
- postResponse
Uppdatera ett inlägg
Redigerar ett befintligt inlägg.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
ID-nummer
|
id | True | uuid |
Post-ID:t |
|
Titel
|
title | string |
Rubriken på inlägget |
|
|
Description
|
description | string |
Den korta beskrivningen av inlägget |
|
|
Taggrad
|
tagLine | string |
Taggraden i inlägget |
|
|
Content
|
content | string |
Brödtexten i inlägget |
|
|
Skaparkommentare
|
creatorComments | string |
Ett meddelande som är associerat med inlägget |
|
|
Perma-länk
|
permaLink | string |
Den externa URL som refereras av inlägget |
|
|
Interna diskussioner aktiverade
|
internalDiscussionsEnabled | boolean |
Om medlemmar får utföra liknande åtgärder och lägga till kommentarer om inlägg internt |
Returer
Ett inlägg
- response
- postResponse
Definitioner
successResponse
Ett enkelt svar som anger att åtgärden har utförts
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Kod
|
code | string |
Värdet "lyckad" anger en lyckad åtgärd |
targetDefinitionsInfoResponse
En lista över måldefinitioner och associerade mål för communityn.
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
definitions
|
definitions | array of targetDefinitionInfoResponse |
targetDefinitionInfoResponse
Detaljerad information för en specifik måldefinition och dess associerade mål
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
ID-nummer
|
id | integer |
ID:t för måldefinitionen |
|
Namn
|
name | string |
Namnet på måldefinitionen |
|
Hämta användarbekräftelse
|
getUserConfirmation | boolean |
Avgör om en användare uppmanas att bekräfta/välja sina inställningar |
|
Tillåt flera val
|
allowMultipleSelections | boolean |
Avgör om flera mål kan väljas |
|
Markering krävs
|
selectionRequired | boolean |
Avgör om ett val i den här definitionen krävs |
|
Fråga om målval
|
targetSelectionPrompt | string |
En anpassad etikett som uppmanar användarna att välja sina inställningar |
|
childTargets
|
childTargets | array of targetInfoResponse |
targetInfoResponse
Detaljerad information för ett specifikt mål.
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
ID-nummer
|
id | integer |
Mål-ID:t |
|
Namn
|
name | string |
Namnet på målet |
|
Description
|
description | string |
Målen för descritption |
|
Definitions-ID
|
definitionId | integer |
ID för måldefinitionen som målet tillhör |
|
Överordnat ID
|
parentId | integer |
ID:t för mål överordnad, om det har en |
|
Prenumererar
|
isSubscribed | boolean |
Om användaren prenumererar på ett specifikt mål |
|
childTargets
|
childTargets | array of targetInfoResponse1 |
managePostTagsResponse
En lista över posttaggar som definierats i systemet
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
tags
|
tags | array of managePostTagResponse |
managePostTagResponse
Detaljerad information för en specifik posttagg
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
ID-nummer
|
id | integer |
Tagg-ID:t |
|
Namn
|
name | string |
Taggnamnet |
|
Är tillgänglig för medlemmar
|
isAvailableToMembers | boolean |
Avgör om taggen kan användas på medlemsriktade sidor efter insändning (om den är aktiverad) |
manageUserTagsResponse
En lista över användartaggar som definierats i systemet
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
tags
|
tags | array of manageUserTagResponse |
manageUserTagResponse
Detaljerad information för en specifik användartagg
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
ID-nummer
|
id | integer |
Tagg-ID:t |
|
Namn
|
name | string |
Taggnamnet |
|
type
|
type | string | |
|
acceptedValues
|
acceptedValues | array of string |
categoriesResponse
Detaljerad information om kategorier
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
categories
|
categories | array of categoryResponse | |
|
Prenumerationsprompt
|
subscriptionPrompt | string |
Etiketten som uppmanar medlemmar att välja kategoriprenumerationer |
|
Aktivera kategoriprenumeration
|
enableCategorySubscription | boolean |
Om medlemmar får ändra sina kategoriprenumerationer |
|
Kräv val av prenumeration
|
requireSubscriptionSelection | boolean |
Om medlemmar måste välja kategoriprenumerationer under registrering |
|
Standardkategori för landningssida
|
landingPageDefaultCategory | integer |
Standardinnehållet som ska visas vid inläsning av nyhetsflödesinformation |
categoryResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
ID-nummer
|
id | integer |
Kategori-ID |
|
Namn
|
name | string |
Kategorins namn |
|
Description
|
description | string |
Kategoribeskrivningen |
|
Visningsordning
|
displayOrder | integer |
I vilken ordning kategorin ska visas |
|
Är fäst
|
isPinned | boolean |
Om kategorin har fästs av en administratör |
|
Tvingas
|
isForced | boolean |
Om den autentiserade användaren är tvingad att prenumerera på den angivna kategorin |
|
Prenumererar
|
isSubscribed | boolean |
Den autentiserade användaren prenumererar på den angivna kategorin |
|
Är dold
|
isHidden | boolean |
Om kategorin är dold av en administratör |
|
Är användarvalbar
|
isUserSelectable | boolean |
Om användare får välja kategorier för inskickade inlägg |
|
Överordnat kategori-ID
|
parentCategoryId | integer |
Det överordnade kategori-ID:t |
|
childCategories
|
childCategories | array of categoryResponse1 |
postResponse
Ett inlägg
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Post-ID
|
postId | uuid |
Post-ID:t |
|
Post Source ID
|
postSourceId | integer |
Käll-ID:t |
|
Titel
|
title | string |
Rubriken på inlägget |
|
Description
|
description | string |
Den korta beskrivningen av inlägget |
|
Taggrad
|
tagLine | string |
Taggraden i inlägget |
|
Content
|
content | string |
Brödtexten i inlägget |
|
Råinnehåll
|
rawContent | string |
Brödtexten i inlägget inklusive all HTML (när både Innehåll och RawContent ingår) |
|
Skaparkommentare
|
creatorComments | string |
Ett meddelande som är associerat med inlägget |
|
|
creatorInfo | userOverviewResponse |
Sammanfattningsinformation om en användare |
|
Plats
|
location | string |
Geografisk plats relaterad till inlägget |
|
Egenskaper
|
properties | object |
Diverse egenskaper för inlägget. Inte tillgängligt med alla posttyper |
|
Perma-länk
|
permaLink | string |
Den externa URL som refereras av inlägget |
|
Rensa Perma-länk
|
cleanPermaLink | string |
Permalänken (exklusive problematiska utrymmen och nya streck) |
|
postType
|
postType | string | |
|
postSourceType
|
postSourceType | string | |
|
postBylineType
|
postBylineType | string | |
|
Provider
|
provider | string |
Den sociala provider som inlägget kommer från (t.ex. Facebook, Twitter). |
|
approvalState
|
approvalState | string | |
|
displayMode
|
displayMode | string | |
|
status
|
status | string | |
|
Användaren kan redigeras
|
userEditable | boolean | |
|
Användardelningsbar
|
userShareable | boolean |
Anger om den aktuella användaren kan dela inlägget. Om det inte finns någon aktuell användare är standardvärdet sant. |
|
Användarkommentabel
|
userCommentable | boolean |
Anger om den aktuella användaren kan delta i dicussions på inlägget. Om det inte finns någon aktuell användare är standardvärdet falskt. |
|
Delbar
|
sharable | boolean |
Om plattformen och widgetarna tillåter att inlägget delas |
|
Sänds
|
broadcasted | boolean |
Om inlägget har sänts till användare för delning |
|
Fastnålad
|
pinned | boolean |
Om inlägget har angetts för prioritetsvisning i strömmar |
|
Publiceringsdatum
|
publishDate | date-time |
För användarinskickat innehåll, datum för eftersändning; för innehåll som importerats från en extern källa, publiceringsdatumet enligt källan |
|
Startdatum
|
startDate | date-time |
Det datum efter vilket inlägget är tillgängligt för visning |
|
Slutdatum
|
endDate | date-time |
Datumet då inlägget inte längre är tillgängligt för visning |
|
Händelsestartdatum
|
eventStartDate | date-time |
Datumet då händelsen börjar (för inlägg av händelsetyp) |
|
Händelseslutdatum
|
eventEndDate | date-time |
Datumet då händelsen slutar (för inlägg av händelsetyp) |
|
Tidsstämpel för provider
|
providerTimeStamp | date-time |
Datumet för inlägget från leverantörernas perspektiv, dvs. när det ursprungligen publicerades på den sociala leverantören |
|
Mottagna publiceringspunkter
|
receivedPublishPoints | boolean |
Om användaren som skickade inlägget fick poäng när inlägget publicerades |
|
Föreslagen delningstext
|
suggestedShareText | string |
Den föreslagna resurstexten för inlägget |
|
Kort föreslagen delningstext
|
shortSuggestedShareText | string |
Den föreslagna resurstexten för inlägget för korta meddelandeleverantörer |
|
suggestedShareTextList
|
suggestedShareTextList | array of string | |
|
shortSuggestedShareTextList
|
shortSuggestedShareTextList | array of string | |
|
Dela poäng
|
sharePoints | integer |
Antalet poäng som tilldelas när en användare delar inlägget |
|
Klicka på punkter
|
clickPoints | integer |
Antalet poäng som tilldelas när någon klickar på en delad länk till inlägget |
|
Providerns post-ID
|
providerPostId | string |
Det ursprungliga ID:t för inlägget i providernätverket |
|
Url-snigel
|
urlSlug | string |
SEO-texten för att sätta in offentliga länkar till inlägget |
|
Classification
|
classification | string |
Typ av inlägg i providernätverket. |
|
Dela med bilder
|
shareWithImages | boolean |
Styr om inlägg som delas till korta meddelandetjänster (som Twitter) har delade bilder |
|
Dela endast avbildningar
|
shareImagesOnly | boolean |
Kontroller om inlägg som delas till vissa tjänster behandlas som uppdateringar av endast bild/foto |
|
Åtgärder
|
actions | string |
En JSON-blob som innehåller en lista över åtgärdsobjekt för inlägget och URL:er |
|
Omnämnanden
|
mentions | string |
Omnämnandena (användare, hashtaggar osv.) som lagras som en JSON-blob. |
|
|
statistics | postStatisticsResponse | |
|
|
userShareInfo | postUserShareInfoResponse | |
|
|
author | postAuthorRequestResponse | |
|
links
|
links | array of postLinkRequestResponse | |
|
tags
|
tags | array of postTagRequestResponse | |
|
media
|
media | array of postMediaRequestResponse | |
|
images
|
images | object | |
|
candidateImages
|
candidateImages | array of postCandidateImageResponse | |
|
Synlig
|
visible | boolean |
Om inlägget för närvarande är synligt |
|
shareDisclosures
|
shareDisclosures | array of postShareDisclosureResponse | |
|
shareCommentRules
|
shareCommentRules | array of postShareCommentRulesResponse | |
|
Language
|
language | string |
Språket för inläggsinnehållet |
|
Dold användare
|
userHidden | boolean |
Om användaren har dolt inlägget från en eller flera strömmar |
|
Visas av användaren
|
isViewedByUser | boolean |
Om inlägget har visats av den aktuella användaren. |
|
Visas en diskussion av användaren
|
isDiscussionViewedByUser | boolean |
Om inläggens diskussionstråd har visats av den aktuella användaren |
|
Gillas av användaren
|
isLikedByUser | boolean |
Om inlägget har gillats internt av den aktuella användaren. |
|
Kommenteras av användaren
|
isCommentedByUser | boolean |
Om inlägget har kommenterats av den aktuella användaren. |
|
Delas av användare
|
isSharedByUser | boolean |
Om inlägget tidigare har delats av den aktuella användaren |
|
targets
|
targets | array of targetOverviewResponse | |
|
categories
|
categories | array of categoryOverviewResponse | |
|
Aktuell tid
|
currentTime | date-time |
Aktuell tid på servern. |
categoryOverviewResponse
Grundläggande kategoriinformation
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
ID-nummer
|
id | integer |
Kategori-ID |
|
Namn
|
name | string |
Kategorins namn |
|
Överordnat kategori-ID
|
parentCategoryId | integer |
Det överordnade kategori-ID:t |
targetOverviewResponse
Ett enkelt målsvar som består av målnamnet, ID:t och ID:t för måldefinitionen som det tillhör
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Namn
|
name | string |
Målnamnet |
|
ID-nummer
|
id | integer |
Mål-ID |
|
Definitions-ID
|
definitionId | integer |
ID:t för måldefinitionen som målet tillhör |
postShareCommentRulesResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
provider
|
provider | string | |
|
Dela maxteckengräns
|
shareMaxCharacterLimit | integer |
Den maximala längden på en användare kommenterar i en resurs på den här providern. |
postShareDisclosureResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
provider
|
provider | string | |
|
Providerns visningsnamn
|
providerDisplayName | string |
Leverantörernas visningsnamn |
|
Dela upplysningstext
|
shareDisclosureText | string |
Upplysningstexten som läggs till i varje resurs |
postCandidateImageResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
URL
|
url | string |
Url:en för bilder |
|
Width
|
width | integer |
Bildernas bredd |
|
Höjd
|
height | integer |
Bildhöjden |
|
Mime-typ
|
mimeType | string |
MIME-avbildningstypen |
|
SSL-URL
|
sslUrl | string |
Bildernas säkra URL |
postMediaRequestResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Namn
|
name | string |
Namnet på medieobjektet |
|
Width
|
width | integer |
Medieobjektets bredd i bildpunkter |
|
Höjd
|
height | integer |
Medieobjektets höjd i bildpunkter |
|
Mime-typ
|
mimeType | string |
MIME-typen för medieobjektet |
|
HTML
|
html | string |
HTML som kan användas för att återge medieobjektet |
|
URL
|
url | string |
URL:en till medieobjektet |
|
Ursprung
|
origin | string |
Om det är tillgängligt anger du den ursprungliga platsen för medieobjektet |
|
Provider
|
provider | string |
Namnet på den sociala leverantören |
|
Role
|
role | string |
Typ av media (om det fastställs) |
|
Varaktighet
|
duration | integer |
Videons varaktighet i millisekunder |
|
Description
|
description | string |
Beskrivning av videoformat |
|
Har video-URL
|
hasVideoUrl | boolean |
Anger att det här mediet har en video-URL som måste signeras med hjälp av "WatchVideo"-inkluderingen |
postTagRequestResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Namn
|
name | string |
Taggnamnet |
postLinkRequestResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
URL
|
url | string |
Inläggs-URL:en |
|
Expanderad URL
|
expandedUrl | string |
Den expanderade URL:en (om den finns) |
|
Titel
|
title | string |
Inläggsrubriken |
|
Domän
|
domain | string |
Länkdomänen |
|
Favicon-url
|
faviconUrl | string |
Länkens favicon-URL |
|
Namn
|
name | string |
Namnet på länken som tilldelats av den sociala providern |
|
Bildtext
|
caption | string |
Den korta beskrivningen av länken (dvs. texten under länken) |
|
Description
|
description | string |
Beskrivningen av länken (dvs. den längre texten under bildtexten) |
|
Ändrat datum
|
modifiedDate | date-time | |
|
Skapelsedatum
|
createdDate | date-time |
postAuthorRequestResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Author
|
author | string |
Den lagrade text som ska visas som författare. |
|
Url för profilbild
|
profileImageUrl | string |
Författarnas profilbild på det sociala nätverket |
|
Providerns användar-ID
|
providerUserId | string |
Författarnas ID på det sociala nätverket |
|
Provideranvändarnamn
|
providerUserName | string |
Författarnas namn på det sociala nätverket |
|
Profil-URL
|
profileUrl | string |
Url:en för författarnas profil i det sociala nätverket |
|
Namn på efterkälla
|
postSourceName | string |
Namnet på källan till inlägget. |
|
Webbplats efter källa
|
postSourceSite | string |
Den webbplats där inlägget har sitt ursprung |
postUserShareInfoResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Poäng
|
pointsEarned | integer |
Antalet poäng som användaren har tjänat in för delning |
|
Antal resursresurser
|
shareCount | integer |
Antalet gånger som användaren har delat |
|
Senaste resursdatum
|
mostRecentShareDate | date-time |
Datum för användarnas senaste del av det här inlägget |
postStatisticsResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Totalt antal appresurser
|
totalInAppShareCount | integer |
Synonym för ShareCount |
|
Spårnings-ID
|
trackingId | string | |
|
Antal resursresurser
|
shareCount | integer |
Antalet resurser som initierats i appen som har verifierats som delade |
|
Antal reaktioner
|
reactionCount | integer |
Antalet reaktioner (gillar, retweets osv.) på aktier |
|
Antal visningar
|
impressionCount | integer |
Potentiella vyer av ett inlägg av sharers vänner och följare |
|
Antal visade
|
viewedCount | integer |
Antalet gånger som inlägget har besökts av inloggade användare |
|
Klicka på Antal
|
clickCount | integer |
Antalet klick till inläggslänken från resurser |
|
Like Count
|
likeCount | integer |
Antalet interna gilla-markeringar i inlägget |
|
Antal kommentarer
|
commentCount | integer |
Antalet interna kommentarer i inlägget |
|
Kommentar som antal
|
commentLikeCount | integer |
Summan av alla gilla-markeringar för alla interna kommentarer i inlägget |
userOverviewResponse
Sammanfattningsinformation om en användare
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Användar-ID
|
userId | integer |
Användarens ID |
|
Visningsnamn
|
displayName | string |
Visningsnamn för användaren |
|
profilePictureImages
|
profilePictureImages | object | |
|
Är aktiv
|
isActive | boolean |
Om användaren fortfarande är en aktiv medlem i communityn |
uploadImageResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Bildidentifierare
|
imageIdentifier | string |
Identifieraren till den uppladdade bilden |
userRequestResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
ID-nummer
|
id | integer |
Användarnas interna ID |
|
E-postmeddelande
|
string |
Användarnas e-postadress |
|
|
Handtag
|
handle | string |
Användarna hanterar ("användarnamnet") |
|
Visningsnamn
|
displayName | string |
Användarens önskade visningsnamn |
|
Fullständigt namn
|
fullName | string |
Användarens för- och efternamn |
|
Förnamn
|
firstName | string |
Användarnas förnamn |
|
Efternamn
|
lastName | string |
Användarnas efternamn |
|
displayNameFormat
|
displayNameFormat | string | |
|
status
|
status | string | |
|
Profilen har slutförts
|
profileCompleted | boolean |
Om användarprofilen slutfördes under registreringen |
|
Datum för senaste aktivitet
|
lastActivityDate | date-time |
Senast användaren interagerade med systemet. |
|
Titel
|
title | string |
Användarens rubrik |
|
Plats
|
location | string |
Användarens självbeskrivna plats (kanske inte är en faktisk geografisk plats) |
|
Användar-ID för externt API
|
externalApiUserId | string |
Användar-ID:t i det externa systemet som hanteras av anroparen för det här API:et |
|
Användar-ID för chef
|
managerUserId | integer |
ID:t för användarhanteraren (för funktioner i organisationshierarkin) |
|
Tidszon
|
timeZone | string |
Användartidszonen representeras som ett tidszonsnamn för tz-databasen enligt IANA:s uppsättning. Exempel: "America/Los_Angeles". |
|
Vald tidszon
|
selectedTimeZone | string |
De användare som valt tidszon som representeras som ett tidszonsnamn för tz-databasen enligt IANA:s uppsättning. Exempel: "America/Los_Angeles". |
|
Punktsaldo
|
pointBalance | integer |
Totalt antal intjänade poäng hittills |
|
Oavslutade punkter
|
unredeemedPoints | integer |
De punkter som för närvarande är tillgängliga för inlösen |
|
Inlösta poäng
|
redeemedPoints | integer |
Antalet inlösta poäng under användarnas livslängd |
|
Api-information
|
apiInfo | string |
API-specifik egenskapsväska |
|
Har lösenord
|
hasPassword | boolean |
Om användaren har ett lösenord som är kopplat till kontot. |
|
Måste ändra lösenord
|
mustChangePassword | boolean |
Om användaren måste ändra sitt lösenord baserat på communityinställningar |
|
Är kontoverifierad
|
isAccountVerified | boolean |
Anger om användaren har verifierat sin e-postadress |
|
|
statistics | postStatisticsResponse | |
|
tags
|
tags | object | |
|
Märken
|
badges | object | |
|
Anknytningar
|
affiliations | array of userAffiliationResponse | |
|
uppdelningar
|
divisions | array of divisionResponse | |
|
Kanaler
|
channels | array of userChannelResponse | |
|
profilePictureImages
|
profilePictureImages | object | |
|
Språk
|
languages | array of string | |
|
Primärt språk
|
primaryLanguage | string |
Användarens primära gränssnittsspråk |
|
|
scheduleSettings | userScheduleSettingsResponse |
Inställningar för schemalagd delning för användare |
|
Är enkel inloggning
|
isSso | boolean |
Om användaren är konfigurerad för att autentisera med enkel inloggning |
|
|
permissions | userPermissionsResponse |
Behörigheter för chefer |
|
|
privileges | userPrivilegesResponse |
En användares behörigheter |
|
Identifierare
|
identifiers | array of allowlistIdentifiersResponse | |
|
targets
|
targets | array of targetOverviewResponse | |
|
|
defaults | userDefaultsRequestResponse |
En samling användare som standard |
|
Välkomstbanderollen har stängts
|
welcomeBannerDismissed | boolean |
Om användaren har stängt välkomstbanderollen |
userDefaultsRequestResponse
En samling användare som standard
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
defaultPostState
|
defaultPostState | string | |
|
defaultPostApprovalState
|
defaultPostApprovalState | string | |
|
Standardinlägg för att visa interna diskussioner
|
defaultPostShowInternalDiscussions | boolean |
Användarna publicerar standardtillståndet för interna diskussioner när de skapar ett inlägg |
|
Standardinformation om Skapare efter visning
|
defaultPostShowCreatorInfo | boolean |
Användarnas standardtillstånd när de skapar ett inlägg om att visa skaparnamn och foto |
allowlistIdentifiersResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
ID-nummer
|
id | integer |
Definitions-ID för listan över tillåtna |
|
Värde
|
value | string |
Användarnas svar för den angivna tillåtna listdefinitionen |
userPrivilegesResponse
En användares behörigheter
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Kan skicka inlägg
|
canSubmitPosts | boolean |
Anger om användaren har möjlighet att skicka inlägg baserat på deras behörigheter och communityinställningar |
|
Kan dela inlägg
|
canSharePosts | boolean |
Anger om användaren har möjlighet att dela inlägg baserat på deras behörigheter och communityinställningar |
|
Kan kommentera inlägg
|
canCommentPosts | boolean |
Anger om användaren har möjlighet att kommentera och gilla inlägg baserat på deras behörigheter och communityinställningar |
|
Kan hantera community
|
canManageCommunity | boolean |
Anger om användaren är en chef inom communityn baserat på deras behörigheter och communityinställningar |
|
Kan hantera organisation
|
canManageOrganization | boolean |
Anger om användaren har möjlighet att kommunicera med direkta och indirekta rapporter i communityn, baserat på deras privilegier och communityinställningar |
|
Kan ange postdelningsbar
|
canSetPostShareable | boolean |
Om användaren kan ange shareable-status när han eller hon skickar ett inlägg |
userPermissionsResponse
Behörigheter för chefer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Visa sändning
|
viewBroadcast | boolean |
Tillåter att chefen visar sändningar |
|
Lista sändning
|
listBroadcast | boolean |
Tillåter att chefen visar listor över sändningar |
|
Redigera sändning
|
editBroadcast | boolean |
Tillåter att chefen skapar och redigerar sändningar |
|
Visa sändningsstatistik
|
viewBroadcastStats | boolean |
Tillåter att chefen visar sändningsstatistik |
|
Visa inlägg
|
viewPost | boolean |
Tillåter att chefen visar inlägg |
|
Listinlägg
|
listPost | boolean |
Tillåter att chefen visar listor med inlägg |
|
Redigera inlägg
|
editPost | boolean |
Tillåter att chefen skapar och redigerar inlägg |
|
Visa poststatistik
|
viewPostStats | boolean |
Tillåter att chefen visar poststatistik |
|
Visa undersökning
|
viewSurvey | boolean |
Gör att chefen kan visa undersökningar |
|
Listundersökning
|
listSurvey | boolean |
Gör att chefen kan visa listor med undersökningar |
|
Redigera undersökning
|
editSurvey | boolean |
Tillåter att chefen skapar och redigerar undersökningar |
|
Community-inställningar
|
communitySettings | boolean |
Tillåter att chefen visar och redigerar communityinställningar |
userScheduleSettingsResponse
Inställningar för schemalagd delning för användare
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Dagar
|
days | string | |
|
gånger
|
times | array of string |
userChannelResponse
En användarkanal.
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Användarkanal-ID
|
userChannelId | integer |
Det interna användarkanal-ID:t |
|
Användar-ID
|
userId | integer |
Det interna användar-ID:t |
|
provider
|
provider | string | |
|
Namn
|
name | string |
Användarens namn på den sociala providern |
|
Visningsnamn
|
displayName | string |
Användarnas visningsnamn på den sociala providern |
|
Providerns användar-ID
|
providerUserId | string |
Providerns användar-ID |
|
status
|
status | string | |
|
URL
|
url | string |
URL:en för kanalen |
|
Vänner
|
friends | integer |
Antalet vänner som användaren har på kanalen |
|
Följare
|
followers | integer |
Antalet följare som användaren har på kanalen |
|
Följer
|
following | integer |
Antalet personer som användaren följer på kanalen |
|
Inlägg
|
posts | integer |
Antalet inlägg som användaren har gjort i kanalen. |
|
Views
|
views | integer |
Antalet vyer som användaren har på kanalen |
|
Punktsaldo
|
pointBalance | integer |
Punktsaldot för användaren på kanalen |
|
Källvisningsnamn
|
sourceDisplayName | string |
Visningsnamnet för användarkanalen när den används som innehållskälla |
|
Räckvidd
|
reach | integer |
Användarna når på kanalen |
|
Delbar
|
sharable | boolean |
Om kanalen stöder delning |
|
Delningsstandard
|
sharingDefault | boolean |
Om kanalen är förvald för delning |
|
Autentisering krävs
|
authRequired | boolean |
Om kanalautentiseringsuppgifterna behöver förnyas |
|
|
statistics | postStatisticsResponse | |
|
profilePictureImages
|
profilePictureImages | object |
divisionResponse
En divisionsdefinition
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Division-ID
|
divisionId | integer |
Divisions-ID:t |
|
Namn
|
name | string |
Divisionens namn |
|
Överordnat division-ID
|
parentDivisionId | integer |
ID:t för den överordnade divisionen |
userAffiliationResponse
En användartillhörighet
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
|
question | affiliationQuestionResponse |
En anknytningsfråga |
|
|
answer | affiliationAnswerResponse |
Ett svar om anknytning |
affiliationAnswerResponse
Ett svar om anknytning
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Svars-ID
|
answerId | integer |
Svars-ID |
|
Answer
|
answer | string |
Svaret |
|
Score
|
score | double |
Poängen, om den tillhandahålls |
|
Fritext
|
freeText | string |
Text för frågor med frågetypen FreeText |
|
Avböj att svara
|
declineToAnswer | boolean |
Om det anges är det här svaret som betyder att en användare avböjde att svara på frågan. |
|
Position
|
position | integer |
Svarssorteringspositionen |
affiliationQuestionResponse
En anknytningsfråga
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Fråge-ID
|
questionId | integer |
Fråge-ID |
|
Namn
|
name | string |
Frågan |
|
Poängposition
|
scorePosition | integer |
Sorteringsposition för frågor |
|
Description
|
description | string |
Frågebeskrivningen |
|
questionType
|
questionType | string | |
|
Krävs
|
required | boolean |
Om frågan måste besvaras för att registrera sig |
|
Är offentligt synlig
|
isPubliclyVisible | boolean |
documentInfoResponse
Information som är relevant för ett bifogat dokument
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
ID-nummer
|
id | uuid |
Dokument-ID:t |
|
Filnamn
|
fileName | string |
Dokumentfilnamnet (med tillägget) |
|
Extension
|
extension | string |
Filnamnstillägget för dokument |
|
Mime-typ
|
mimeType | string |
MIME-typen för dokument |
divisionsResponse
De divisioner som definierats i systemet
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
uppdelningar
|
divisions | array of divisionResponse | |
|
Omedelbar
|
prompt | string |
Etiketten som uppmanar medlemmar att välja en division |
|
Visa val av användardivision
|
showUserDivisionSelection | boolean |
Om registrerade medlemmar kan ändra sin egen division |
|
Visa val av användardivision under registrering
|
showUserDivisionSelectionDuringOnboarding | boolean |
Om nya medlemmar ska välja egen division under registreringen |
|
Kräv val av användardivision
|
requireUserDivisionSelection | boolean |
Om medlemmar måste välja sin egen division. |
|
Tillåt flera divisioner
|
allowMultipleDivisions | boolean |
Om medlemmar får välja flera eller endast en division |
categoryResponse1
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
ID-nummer
|
id | integer |
Kategori-ID |
|
Namn
|
name | string |
Kategorins namn |
|
Description
|
description | string |
Kategoribeskrivningen |
|
Visningsordning
|
displayOrder | integer |
I vilken ordning kategorin ska visas |
|
Är fäst
|
isPinned | boolean |
Om kategorin har fästs av en administratör |
|
Tvingas
|
isForced | boolean |
Om den autentiserade användaren är tvingad att prenumerera på den angivna kategorin |
|
Prenumererar
|
isSubscribed | boolean |
Den autentiserade användaren prenumererar på den angivna kategorin |
|
Är dold
|
isHidden | boolean |
Om kategorin är dold av en administratör |
|
Är användarvalbar
|
isUserSelectable | boolean |
Om användare får välja kategorier för inskickade inlägg |
|
Överordnat kategori-ID
|
parentCategoryId | integer |
Det överordnade kategori-ID:t |
targetInfoResponse1
Detaljerad information för ett specifikt mål.
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
ID-nummer
|
id | integer |
Mål-ID:t |
|
Namn
|
name | string |
Namnet på målet |
|
Description
|
description | string |
Målen för descritption |
|
Definitions-ID
|
definitionId | integer |
ID för måldefinitionen som målet tillhör |
|
Överordnat ID
|
parentId | integer |
ID:t för mål överordnad, om det har en |
|
Prenumererar
|
isSubscribed | boolean |
Om användaren prenumererar på ett specifikt mål |
|
childTargets
|
childTargets | array of targetInfoResponse2 |
targetInfoResponse2
Detaljerad information för ett specifikt mål.
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
ID-nummer
|
id | integer |
Mål-ID:t |
|
Namn
|
name | string |
Namnet på målet |
|
Description
|
description | string |
Målen för descritption |
|
Definitions-ID
|
definitionId | integer |
ID för måldefinitionen som målet tillhör |
|
Överordnat ID
|
parentId | integer |
ID:t för mål överordnad, om det har en |
|
Prenumererar
|
isSubscribed | boolean |
Om användaren prenumererar på ett specifikt mål |
|
childTargets
|
childTargets | array of targetInfoResponse3 |
targetInfoResponse3
Detaljerad information för ett specifikt mål.
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
ID-nummer
|
id | integer |
Mål-ID:t |
|
Namn
|
name | string |
Namnet på målet |
|
Description
|
description | string |
Målen för descritption |
|
Definitions-ID
|
definitionId | integer |
ID för måldefinitionen som målet tillhör |
|
Överordnat ID
|
parentId | integer |
ID:t för mål överordnad, om det har en |
|
Prenumererar
|
isSubscribed | boolean |
Om användaren prenumererar på ett specifikt mål |