Get whether this message is starred.
get
/social/api/v1/messages/{messageID}/stars
Request
Supported Media Types
- application/json
Path Parameters
-
messageID: integer(int64)
The message ID. The object's unique identifier from a long integer representation.
Response
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : XV1MessageStarInfo
Type:
object
V1 Message Star Information DTO.
Show Source
-
altitude(optional):
number(double)
The object's altitude.
-
collectionURL(optional):
string(url)
A URL to this object's containing collection.
-
conversationURL(optional):
string(url)
A URL to this object's containing conversation.
-
createdByID(optional):
An object's unique identifier from a long integer representation.
-
createdByURL(optional):
string(url)
A URL to the user that created this object.
-
createdByUserDisplayName(optional):
string
The display name of the user that created this object.
-
createdByUserName(optional):
string
The name of the user that created this object.
-
createdDate(optional):
string(date)
The date this object was created.
-
createdDateInISO8601Format(optional):
string
The date this object was created, in ISO 8601 format.
-
displayName(optional):
string
The display name of this object.
-
id(optional):
An object's unique identifier from a long integer representation.
-
isRemoved(optional):
boolean
True if this message has been removed.
-
isStarred(optional):
boolean
True if starred.
-
latitude(optional):
number(double)
The object's latitude.
-
longitude(optional):
number(double)
The object's longitude.
-
modifiedByID(optional):
An object's unique identifier from a long integer representation.
-
modifiedByURL(optional):
string(url)
A URL to the user that last modified this object.
-
modifiedByUserDisplayName(optional):
string
The display name of the user that last modified this object.
-
modifiedByUserName(optional):
string
The name of the user that last modified this object.
-
modifiedDate(optional):
string(date)
The date this object was last modified.
-
modifiedDateInISO8601Format(optional):
string
The date this object was last modified, in ISO 8601 format.
-
name(optional):
string
The name of this object.
-
objectType(optional):
string
The type of this object.
-
removedByID(optional):
An object's unique identifier from a long integer representation.
-
removedByURL(optional):
string(url)
A URL to the user that last removed this object.
-
removedByUserDisplayName(optional):
string
The display name of the user that last removed this object.
-
removedByUserName(optional):
string
The name of the user that last removed this object.
-
removedDate(optional):
string(date)
The date this object was removed.
-
removedDateInISO8601Format(optional):
string
The date this object was removed, in ISO 8601 format.
-
socialObjectURL(optional):
string(url)
A URL to this object's containing collaboration object.
-
url(optional):
string(url)
A URL to this object.