Get a filtered list of all stars.
get
/social/api/v1/stars
Request
Supported Media Types
- application/json
Specify a filter to query.
Root Schema : XV1StarFilterInfo
Type:
object
V1 Star Filter Information DTO.
Show Source
-
excludeGadgetedConversations(optional):
boolean
Exclude all gadgeted-conversations.
-
includeClosed(optional):
boolean
Set true to include only closed conversations. Default is false.
-
includeOpen(optional):
boolean
Set true to include only open conversations. Default is false.
-
limitToGadgetID(optional):
An object's unique identifier from a long integer representation.
-
limitToType(optional):
array limitToType
Limit to objects of the specified types. Can be null.
-
sortField(optional):
object XStarSummarySortField
-
sortOrderDescending(optional):
boolean
Sort is descending.
Nested Schema : limitToType
Type:
array
Limit to objects of the specified types. Can be null.
Show Source
-
Array of:
string
Limit to objects of the specified types. Can be null.
Nested Schema : XStarSummarySortField
Type:
Show Source
object
-
field(optional):
string
Allowed Values:
[ "NAME", "STARRED_DATE" ]
XStarSummarySortField.
Response
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : XV1StarListInfo
Type:
object
V1 Star List Information DTO.
Show Source
-
hasMore(optional):
boolean
If true, there are more items to be returned.
-
items(optional):
array items
The stars being returned.
-
nextURL(optional):
string(url)
Next page URL for the list. Null if this is the last page.
-
previousURL(optional):
string(url)
Previous page URL for the list. Null if this is the first page.
-
total(optional):
integer(int32)
If specified, this is the total number of available items. Null if the total is unknown.
Nested Schema : items
Type:
array
The stars being returned.
Show Source
-
Array of:
object XV1ObjectInfo
V1 Base Information DTO.
Some descriptive fields are common among all the object types in the system. These are the common fields.
These objects should not be confused with collaboration objects. A collaboration object is more generic. This object can be one of various types, including user, conversation, followup, or picture.
Nested Schema : XV1ObjectInfo
Type:
object
V1 Base Information DTO.
Show Source
Some descriptive fields are common among all the object types in the system. These are the common fields.
These objects should not be confused with collaboration objects. A collaboration object is more generic. This object can be one of various types, including user, conversation, followup, or picture.
-
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.
-
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.