Jump to

• Request
• Response

Get a filtered list of all stars.

get

/social/api/v1/stars

Request

Supported Media Types

• application/json

Body ()

Specify a filter to query.

Root Schema : XV1StarFilterInfo

Type: object

V1 Star Filter Information DTO.

Show Source

• excludeGadgetedConversations: boolean
  Exclude all gadgeted-conversations.
• includeClosed: boolean
  Set true to include only closed conversations. Default is false.
• includeOpen: boolean
  Set true to include only open conversations. Default is false.
• limitToGadgetID:
  An object's unique identifier from a long integer representation.
• limitToType: array limitToType
  Limit to objects of the specified types. Can be null.
• sortField: object XStarSummarySortField
• sortOrderDescending: boolean
  Sort is descending.

{
    "description":"V1 Star Filter Information DTO.",
    "properties":{
        "excludeGadgetedConversations":{
            "description":"Exclude all gadgeted-conversations.",
            "type":"boolean"
        },
        "includeClosed":{
            "description":"Set true to include only closed conversations. Default is false.",
            "type":"boolean"
        },
        "includeOpen":{
            "description":"Set true to include only open conversations. Default is false.",
            "type":"boolean"
        },
        "limitToGadgetID":{
            "$ref":"#/definitions/XObjectID"
        },
        "limitToType":{
            "description":"Limit to objects of the specified types. Can be null.",
            "type":"array",
            "items":{
                "description":"Limit to objects of the specified types. Can be null.",
                "type":"string"
            }
        },
        "sortField":{
            "$ref":"#/definitions/XStarSummarySortField"
        },
        "sortOrderDescending":{
            "description":"Sort is descending.",
            "type":"boolean"
        }
    }
}

Nested Schema : limitToType

Type: array

Limit to objects of the specified types. Can be null.

Show Source

• [0]: string
  Limit to objects of the specified types. Can be null.

{
    "description":"Limit to objects of the specified types. Can be null.",
    "type":"array",
    "items":{
        "description":"Limit to objects of the specified types. Can be null.",
        "type":"string"
    }
}

Nested Schema : XStarSummarySortField

Type: object

Show Source

• field: string
  Allowed Values: [ "NAME", "STARRED_DATE" ]

  XStarSummarySortField.

{
    "properties":{
        "field":{
            "type":"string",
            "description":"XStarSummarySortField.",
            "enum":[
                "NAME",
                "STARRED_DATE"
            ]
        }
    }
}

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

V1 Star List Information DTO.

Root Schema : XV1StarListInfo

Type: object

V1 Star List Information DTO.

Show Source

• hasMore: boolean
  If true, there are more items to be returned.
• items: array items
  The stars being returned.
• nextURL: string(url)
  Next page URL for the list. Null if this is the last page.
• previousURL: string(url)
  Previous page URL for the list. Null if this is the first page.
• total: integer(int32)
  If specified, this is the total number of available items. Null if the total is unknown.

{
    "description":"V1 Star List Information DTO.",
    "properties":{
        "items":{
            "description":"The stars being returned.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/XV1ObjectInfo"
            }
        },
        "hasMore":{
            "description":"If true, there are more items to be returned.",
            "type":"boolean"
        },
        "nextURL":{
            "description":"Next page URL for the list. Null if this is the last page.",
            "type":"string",
            "format":"url"
        },
        "previousURL":{
            "description":"Previous page URL for the list. Null if this is the first page.",
            "type":"string",
            "format":"url"
        },
        "total":{
            "description":"If specified, this is the total number of available items. Null if the total is unknown.",
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : items

Type: array

The stars being returned.

Show Source

• [0]: 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.

{
    "description":"The stars being returned.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/XV1ObjectInfo"
    }
}

Nested Schema : XV1ObjectInfo

Type: object

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.

Show Source

• altitude: number(double)
  The object's altitude.
• collectionURL: string(url)
  A URL to this object's containing collection.
• conversationURL: string(url)
  A URL to this object's containing conversation.
• createdByID:
  An object's unique identifier from a long integer representation.
• createdByURL: string(url)
  A URL to the user that created this object.
• createdByUserDisplayName: string
  The display name of the user that created this object.
• createdByUserName: string
  The name of the user that created this object.
• createdDate: string(date)
  The date this object was created.
• createdDateInISO8601Format: string
  The date this object was created, in ISO 8601 format.
• displayName: string
  The display name of this object.
• id:
  An object's unique identifier from a long integer representation.
• isRemoved: boolean
  True if this message has been removed.
• latitude: number(double)
  The object's latitude.
• longitude: number(double)
  The object's longitude.
• modifiedByID:
  An object's unique identifier from a long integer representation.
• modifiedByURL: string(url)
  A URL to the user that last modified this object.
• modifiedByUserDisplayName: string
  The display name of the user that last modified this object.
• modifiedByUserName: string
  The name of the user that last modified this object.
• modifiedDate: string(date)
  The date this object was last modified.
• modifiedDateInISO8601Format: string
  The date this object was last modified, in ISO 8601 format.
• name: string
  The name of this object.
• objectType: string
  The type of this object.
• removedByID:
  An object's unique identifier from a long integer representation.
• removedByURL: string(url)
  A URL to the user that last removed this object.
• removedByUserDisplayName: string
  The display name of the user that last removed this object.
• removedByUserName: string
  The name of the user that last removed this object.
• removedDate: string(date)
  The date this object was removed.
• removedDateInISO8601Format: string
  The date this object was removed, in ISO 8601 format.
• socialObjectURL: string(url)
  A URL to this object's containing collaboration object.
• url: string(url)
  A URL to this object.

{
    "description":"V1 Base Information DTO. <p> Some descriptive fields are common among all the object types in the system. These are the common fields. </p> <p> 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. </p>",
    "properties":{
        "altitude":{
            "description":"The object's altitude.",
            "type":"number",
            "format":"double"
        },
        "collectionURL":{
            "description":"A URL to this object's containing collection.",
            "type":"string",
            "format":"url"
        },
        "conversationURL":{
            "description":"A URL to this object's containing conversation.",
            "type":"string",
            "format":"url"
        },
        "createdByID":{
            "$ref":"#/definitions/XObjectID"
        },
        "createdByURL":{
            "description":"A URL to the user that created this object.",
            "type":"string",
            "format":"url"
        },
        "createdByUserDisplayName":{
            "description":"The display name of the user that created this object.",
            "type":"string"
        },
        "createdByUserName":{
            "description":"The name of the user that created this object.",
            "type":"string"
        },
        "createdDate":{
            "description":"The date this object was created.",
            "type":"string",
            "format":"date"
        },
        "createdDateInISO8601Format":{
            "description":"The date this object was created, in ISO 8601 format.",
            "type":"string"
        },
        "displayName":{
            "description":"The display name of this object.",
            "type":"string"
        },
        "id":{
            "$ref":"#/definitions/XObjectID"
        },
        "isRemoved":{
            "description":"True if this message has been removed.",
            "type":"boolean"
        },
        "latitude":{
            "description":"The object's latitude.",
            "type":"number",
            "format":"double"
        },
        "longitude":{
            "description":"The object's longitude.",
            "type":"number",
            "format":"double"
        },
        "modifiedByID":{
            "$ref":"#/definitions/XObjectID"
        },
        "modifiedByURL":{
            "description":"A URL to the user that last modified this object.",
            "type":"string",
            "format":"url"
        },
        "modifiedByUserDisplayName":{
            "description":"The display name of the user that last modified this object.",
            "type":"string"
        },
        "modifiedByUserName":{
            "description":"The name of the user that last modified this object.",
            "type":"string"
        },
        "modifiedDate":{
            "description":"The date this object was last modified.",
            "type":"string",
            "format":"date"
        },
        "modifiedDateInISO8601Format":{
            "description":"The date this object was last modified, in ISO 8601 format.",
            "type":"string"
        },
        "name":{
            "description":"The name of this object.",
            "type":"string"
        },
        "objectType":{
            "description":"The type of this object.",
            "type":"string"
        },
        "removedByID":{
            "$ref":"#/definitions/XObjectID"
        },
        "removedByURL":{
            "description":"A URL to the user that last removed this object.",
            "type":"string",
            "format":"url"
        },
        "removedByUserDisplayName":{
            "description":"The display name of the user that last removed this object.",
            "type":"string"
        },
        "removedByUserName":{
            "description":"The name of the user that last removed this object.",
            "type":"string"
        },
        "removedDate":{
            "description":"The date this object was removed.",
            "type":"string",
            "format":"date"
        },
        "removedDateInISO8601Format":{
            "description":"The date this object was removed, in ISO 8601 format.",
            "type":"string"
        },
        "socialObjectURL":{
            "description":"A URL to this object's containing collaboration object.",
            "type":"string",
            "format":"url"
        },
        "url":{
            "description":"A URL to this object.",
            "type":"string",
            "format":"url"
        }
    }
}