機械翻訳について

移動先

• リクエスト
• レスポンス

すべての星印のフィルタされたリストを取得

get

/social/api/v1/stars

リクエスト

サポートされているメディア・タイプ

• application/json

本文()

問合せ対象のフィルタを指定します。

ルート・スキーマ: XV1StarFilterInfo

型: object

V1星印フィルタ情報DTO。

ソースを表示

• excludeGadgetedConversations(optional): boolean
  ガジェット会話をすべて除外します。
• includeClosed(optional): boolean
  クローズした会話のみを含めるにはtrueを設定します。 デフォルトはfalseです。
• includeOpen(optional): boolean
  オープン中の会話のみを含めるにはtrueを設定します。 デフォルトはfalseです。
• limitToGadgetID(optional):
  オブジェクトのlong integer表現の一意識別子。
• limitToType(optional): array limitToType
  指定したタイプのオブジェクトに限定します。 nullも可。
• sortField(optional): object XStarSummarySortField
• sortOrderDescending(optional): boolean
  ソートは降順です。

{
    "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"
        }
    }
}

ネストされたスキーマ: limitToType

型: array

指定したタイプのオブジェクトに限定します。 nullも可。

ソースを表示

• Array of: string
  指定したタイプのオブジェクトに限定します。 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"
    }
}

ネストされたスキーマ: XStarSummarySortField

型: object

ソースを表示

• field(optional): string
  許容値: [ "NAME", "STARRED_DATE" ]

  XStarSummarySortField.

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

トップに戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

操作の成功

本文()

ルート・スキーマ: XV1StarListInfo

型: object

V1星印リスト情報DTO。

ソースを表示

• hasMore(optional): boolean
  trueの場合、他にも返すアイテムが存在します。
• items(optional): array items
  返される星印。
• nextURL(optional): string(url)
  リストの次のページのURL。 これが最後のページである場合はNull。
• previousURL(optional): string(url)
  リストの前のページのURL。 これが最初のページである場合はNull。
• total(optional): integer(int32)
  指定した場合、これは使用可能なアイテムの合計数です。 合計が不明な場合はNull。

{
    "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"
        }
    }
}

ネストされたスキーマ: items

型: array

返される星印。

ソースを表示

• Array of: object XV1ObjectInfo
  V1基本情報DTO。

  一部の記述フィールドは、システム内のすべてのオブジェクト・タイプに共通です。 これらは共通フィールドです。

  これらのオブジェクトをコラボレーション・オブジェクトと混同しないでください。 コラボレーション・オブジェクトはより汎用的です。 これは、ユーザー、会話、フォローアップ、またはピクチャなどの、様々なタイプのオブジェクトです。

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

ネストされたスキーマ: XV1ObjectInfo

型: object

V1基本情報DTO。

一部の記述フィールドは、システム内のすべてのオブジェクト・タイプに共通です。 これらは共通フィールドです。

これらのオブジェクトをコラボレーション・オブジェクトと混同しないでください。 コラボレーション・オブジェクトはより汎用的です。 これは、ユーザー、会話、フォローアップ、またはピクチャなどの、様々なタイプのオブジェクトです。

ソースを表示

• altitude(optional): number(double)
  オブジェクトの高度。
• collectionURL(optional): string(url)
  コレクションを含むこのオブジェクトのURL。
• conversationURL(optional): string(url)
  このオブジェクトに含まれる会話へのURL。
• createdByID(optional):
  オブジェクトのlong integer表現の一意識別子。
• createdByURL(optional): string(url)
  このオブジェクトを作成したユーザーへのURL。
• createdByUserDisplayName(optional): string
  このオブジェクトを作成したユーザーの表示名。
• createdByUserName(optional): string
  このオブジェクトを作成したユーザーの名前。
• createdDate(optional): string(date)
  このオブジェクトが作成された日付。
• createdDateInISO8601Format(optional): string
  このオブジェクトが作成された日付(ISO 8601書式)。
• displayName(optional): string
  このオブジェクトの表示名。
• id(optional):
  オブジェクトのlong integer表現の一意識別子。
• isRemoved(optional): boolean
  このメッセージが削除された場合はTrue。
• latitude(optional): number(double)
  オブジェクトの緯度。
• longitude(optional): number(double)
  オブジェクトの経度。
• modifiedByID(optional):
  オブジェクトのlong integer表現の一意識別子。
• modifiedByURL(optional): string(url)
  このオブジェクトを最後に変更したユーザーへのURL。
• modifiedByUserDisplayName(optional): string
  このオブジェクトを最後に変更したユーザーの表示名。
• modifiedByUserName(optional): string
  このオブジェクトを最後に変更したユーザーの名前。
• modifiedDate(optional): string(date)
  このオブジェクトが最後に変更された日付。
• modifiedDateInISO8601Format(optional): string
  このオブジェクトが最後に変更された日付(ISO 8601書式)。
• name(optional): string
  このオブジェクトの名前。
• objectType(optional): string
  このオブジェクトのタイプ。
• removedByID(optional):
  オブジェクトのlong integer表現の一意識別子。
• removedByURL(optional): string(url)
  このオブジェクトを最後に削除したユーザーへのURL。
• removedByUserDisplayName(optional): string
  このオブジェクトを最後に削除したユーザーの表示名。
• removedByUserName(optional): string
  このオブジェクトを最後に削除したユーザーの名前。
• removedDate(optional): string(date)
  このオブジェクトが削除された日付。
• removedDateInISO8601Format(optional): string
  このオブジェクトが削除された日付(ISO 8601書式)。
• socialObjectURL(optional): string(url)
  このオブジェクトの格納されているコラボレーション・オブジェクトへのURL。
• url(optional): string(url)
  このオブジェクトへのURL。

{
    "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"
        }
    }
}

先頭に戻る