機械翻訳について

移動先

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

すべてのフォローアップのフィルタされたリストを取得

get

/social/api/v1/followups

リクエスト

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

• application/json

本文()

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

ルート・スキーマ: XV1FollowupFilterInfo

型: object

V1フォローアップ・フィルタ情報DTO。

ソースを表示

• excludeSelfAssigned(optional): boolean
  ターゲット・ユーザーが割当て元と割当て先の両方であるフォローアップを除外します。
• includeAssignee(optional): boolean
  現在のユーザーに割り当てられているフォローアップを含めます。 includeAssigneeまたはincludeAssignerフィールド、あるいはその両方をtrueとして指定する必要があります。 両方falseであることは両方trueであるのと同じです。 このフィールドは、includeAssigneesとincludeAssignersの両方がnullの場合にのみ使用されます。
• includeAssignees(optional): array includeAssignees
  指定したフォローアップ割当て先を含めます。 includeAssigneesまたはincludeAssignersフィールド、あるいはその両方を指定する必要があります。 両方のフィールドがnullの場合は、フィールドincludeAssigneeおよびincludeAssignerが使用されます。
• includeAssigner(optional): boolean
  現在のユーザーが割り当てたフォローアップを含めます。 includeAssigneeまたはincludeAssignerフィールド、あるいはその両方をtrueとして指定する必要があります。 両方falseであることは両方trueであるのと同じです。 このフィールドは、includeAssigneesとincludeAssignersの両方がnullの場合にのみ使用されます。
• includeAssigners(optional): array includeAssigners
  指定したフォローアップ割当て元を含めます。 includeAssigneesまたはincludeAssignersフィールド、あるいはその両方を指定する必要があります。 両方のフィールドがNULLフィールドの場合、includeAssigneeおよびincludeAssignerが使用されます。
• includeClosed(optional): boolean
  クローズしたフォローアップを含めます。 includeOpenまたはincludeClosedフィールド、あるいはその両方をtrueとして指定する必要があります。 どちらのfalseも、includeOpen trueと同じです。
• includeNoReply(optional): boolean
  非返信フォローアップを含めます。 includeReplyまたはincludeNoReplyフィールド、あるいはその両方をtrueとして指定する必要があります。 両方falseであることは両方trueであるのと同じです。
• includeOpen(optional): boolean
  オープン中のフォローアップを含めます。 includeOpenまたはincludeClosedフィールド、あるいはその両方をtrueとして指定する必要があります。 どちらのfalseも、includeOpen trueと同じです。
• includeRead(optional): boolean
  既読のフォローアップを含めます。 includeReadまたはincludeUnreadフィールド、あるいはその両方をtrueとして指定する必要があります。 両方falseであることは両方trueであるのと同じです。
• includeReply(optional): boolean
  返信フォローアップを含めます。 includeReplyまたはincludeNoReplyフィールド、あるいはその両方をtrueとして指定する必要があります。 両方falseであることは両方trueであるのと同じです。
• includeTypes(optional): array includeTypes
  指定したフォローアップ・タイプを含めます。 指定しない場合、すべてのタイプのフォローアップが返されます。
• includeUnread(optional): boolean
  未読のフォローアップを含めます。 includeReadまたはincludeUnreadフィールド、あるいはその両方をtrueとして指定する必要があります。 両方falseであることは両方trueであるのと同じです。
• sortField(optional): object XV1FollowupSortField
• sortOrderDescending(optional): boolean
  ソートは降順です。

{
    "description":"V1 Followup Filter Information DTO.",
    "properties":{
        "excludeSelfAssigned":{
            "description":"Exclude followups where the target user is both the assigner and assignee.",
            "type":"boolean"
        },
        "includeAssignee":{
            "description":"Include followups assigned to the current user.   The includeAssignee or includeAssigner field or both must be specified as true. Both false  is the same as both true. This field is used only if both includeAssignees and includeAssigners are null.",
            "type":"boolean"
        },
        "includeAssignees":{
            "description":"Include specified followups assignees. The includeAssignees or includeAssigners field or both  must be specified. If both fields are null, fields includeAssignee and includeAssigner are  used.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/XObjectID"
            }
        },
        "includeAssigner":{
            "description":"Include followups assigned by the current user.   The includeAssignee or includeAssigner field or both must be specified as true. Both false  is the same as both true. This field is used only if both includeAssignees and includeAssigners are null.",
            "type":"boolean"
        },
        "includeAssigners":{
            "description":"Include specified followups assigners. The includeAssignees or includeAssigners field or both  must be specified. If both fields are null fields, includeAssignee and includeAssigner are  used.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/XObjectID"
            }
        },
        "includeClosed":{
            "description":"Include closed followups.   The includeOpen or includeClosed field or both must be specified as true. Both false is  the same as includeOpen true.",
            "type":"boolean"
        },
        "includeNoReply":{
            "description":"Include no-reply followups.   The includeReply or includeNoReply field or both must be specified as true. Both false is the same as both true.",
            "type":"boolean"
        },
        "includeOpen":{
            "description":"Include open followups.   The includeOpen or includeClosed field or both must be specified as true. Both false  is the same as includeOpen true.",
            "type":"boolean"
        },
        "includeRead":{
            "description":"Include read followups.   The includeRead or includeUnread field or both must be specified as true. Both false is the same as both true.",
            "type":"boolean"
        },
        "includeReply":{
            "description":"Include reply followups.   The includeReply or includeNoReply field or both must be specified as true. Both false is the same as both true.",
            "type":"boolean"
        },
        "includeTypes":{
            "description":"Include specified followups types. If not specified, all types of followups are returned.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/XV1FollowupType"
            }
        },
        "includeUnread":{
            "description":"Include unread followups.   The includeRead or includeUnread field or both must be specified as true. Both false is the same as both true.",
            "type":"boolean"
        },
        "sortField":{
            "$ref":"#/definitions/XV1FollowupSortField"
        },
        "sortOrderDescending":{
            "description":"Sort is descending.",
            "type":"boolean"
        }
    }
}

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

型: array

指定したフォローアップ割当て先を含めます。 includeAssigneesまたはincludeAssignersフィールド、あるいはその両方を指定する必要があります。 両方のフィールドがnullの場合は、フィールドincludeAssigneeおよびincludeAssignerが使用されます。

ソースを表示

• Array of:
  オブジェクトのlong integer表現の一意識別子。

{
    "description":"Include specified followups assignees. The includeAssignees or includeAssigners field or both  must be specified. If both fields are null, fields includeAssignee and includeAssigner are  used.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/XObjectID"
    }
}

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

型: array

指定したフォローアップ割当て元を含めます。 includeAssigneesまたはincludeAssignersフィールド、あるいはその両方を指定する必要があります。 両方のフィールドがNULLフィールドの場合、includeAssigneeおよびincludeAssignerが使用されます。

ソースを表示

• Array of:
  オブジェクトのlong integer表現の一意識別子。

{
    "description":"Include specified followups assigners. The includeAssignees or includeAssigners field or both  must be specified. If both fields are null fields, includeAssignee and includeAssigner are  used.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/XObjectID"
    }
}

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

型: array

指定したフォローアップ・タイプを含めます。 指定しない場合、すべてのタイプのフォローアップが返されます。

ソースを表示

• Array of: object XV1FollowupType

{
    "description":"Include specified followups types. If not specified, all types of followups are returned.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/XV1FollowupType"
    }
}

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

型: object

ソースを表示

• field(optional): string
  許容値: [ "FOLLOWUP_CHAT_DATE", "FOLLOWUP_CREATED_DATE", "FOLLOWUP_RECENT_ACTIVITY", "FOLLOWUP_TYPE" ]

  V1フォローアップ・ソート・フィールド。

{
    "properties":{
        "field":{
            "type":"string",
            "description":"V1 Followup Sort Fields.",
            "enum":[
                "FOLLOWUP_CHAT_DATE",
                "FOLLOWUP_CREATED_DATE",
                "FOLLOWUP_RECENT_ACTIVITY",
                "FOLLOWUP_TYPE"
            ]
        }
    }
}

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

型: object

ソースを表示

• field(optional): string
  許容値: [ "FOR_YOUR_INFORMATION", "PLEASE_REPLY", "PLEASE_REPLY_URGENT" ]

  V1フォローアップ・タイプ。

{
    "properties":{
        "field":{
            "type":"string",
            "description":"V1 Followup Types.",
            "enum":[
                "FOR_YOUR_INFORMATION",
                "PLEASE_REPLY",
                "PLEASE_REPLY_URGENT"
            ]
        }
    }
}

トップに戻る

レスポンス

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

• application/json

200レスポンス

操作の成功

本文()

ルート・スキーマ: XV1FollowupListInfo

型: 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 Followup List Information DTO.",
    "properties":{
        "items":{
            "description":"The followups being returned.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/XV1FollowupInfo"
            }
        },
        "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 XV1FollowupInfo
  V1フォローアップ情報DTO。

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

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

型: object

V1フォローアップ情報DTO。

ソースを表示

• altitude(optional): number(double)
  オブジェクトの高度。
• assigneeDisplayName(optional): string
  このフォローアップが割り当てられているユーザーの表示名。
• assigneeID(optional):
  オブジェクトのlong integer表現の一意識別子。
• assigneeName(optional): string
  このフォローアップが割り当てられているユーザーの名前。
• assigneeURL(optional): string
  このフォローアップが割り当てられているユーザーへのURL。
• assignerDisplayName(optional): string
  このフォローアップを割り当てたユーザーの表示名。
• assignerID(optional):
  オブジェクトのlong integer表現の一意識別子。
• assignerName(optional): string
  このフォローアップを割り当てたユーザーの名前。
• assignerURL(optional): string(url)
  このフォローアップを割り当てたユーザーへのURL。
• 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
  このオブジェクトの表示名。
• followupType(optional): object XV1FollowupType
• id(optional):
  オブジェクトのlong integer表現の一意識別子。
• isOpen(optional): boolean
  このフォローアップがオープン中であるかクローズしているか。
• isRead(optional): boolean
  このフォローアップが既読であるかどうか。
• isRemoved(optional): boolean
  このメッセージが削除された場合はTrue。
• isReply(optional): boolean
  このフォローアップに返信があるかどうか。
• latitude(optional): number(double)
  オブジェクトの緯度。
• longitude(optional): number(double)
  オブジェクトの経度。
• messageURL(optional): string(url)
  このフォローアップが設定されているメッセージへのURL。
• 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
  このオブジェクトのタイプ。
• openDate(optional): string(date)
  オープン/クローズの状態が最後に変更されたのはいつか。
• openDateInISO8601Format(optional): string
  オープン/クローズの状態が最後に変更されたのはいつか(ISO 8601書式)。
• openURL(optional): string(url)
  オープン/クローズ状態を最後に変更したユーザーへのURL。
• readDate(optional): string(date)
  既読の状態が最後に変更されたのはいつか。
• readDateInISO8601Format(optional): string
  既読の状態が最後に変更されたのはいつか(ISO 8601書式)。
• removedByID(optional):
  オブジェクトのlong integer表現の一意識別子。
• removedByURL(optional): string(url)
  このオブジェクトを最後に削除したユーザーへのURL。
• removedByUserDisplayName(optional): string
  このオブジェクトを最後に削除したユーザーの表示名。
• removedByUserName(optional): string
  このオブジェクトを最後に削除したユーザーの名前。
• removedDate(optional): string(date)
  このオブジェクトが削除された日付。
• removedDateInISO8601Format(optional): string
  このオブジェクトが削除された日付(ISO 8601書式)。
• replyDate(optional): string(date)
  最後の返信が発生したのはいつか。
• replyDateInISO8601Format(optional): string
  最後の返信が発生したのはいつか(ISO 8601書式)。
• replyURL(optional): string(url)
  返信メッセージへのURL。
• socialObjectURL(optional): string(url)
  このオブジェクトの格納されているコラボレーション・オブジェクトへのURL。
• url(optional): string(url)
  このオブジェクトへのURL。

{
    "description":"V1 Followup Information DTO.",
    "properties":{
        "assigneeDisplayName":{
            "description":"The display name of the user this followup is assigned to.",
            "type":"string"
        },
        "assigneeID":{
            "$ref":"#/definitions/XObjectID"
        },
        "assigneeName":{
            "description":"The name of the user this followup is assigned to.",
            "type":"string"
        },
        "assigneeURL":{
            "description":"A URL to the user this followup is assigned to.",
            "type":"string"
        },
        "assignerDisplayName":{
            "description":"The display name of the user who assigned this followup.",
            "type":"string"
        },
        "assignerID":{
            "$ref":"#/definitions/XObjectID"
        },
        "assignerName":{
            "description":"The name of the user who assigned this followup.",
            "type":"string"
        },
        "assignerURL":{
            "description":"A URL to the user who assigned this followup.",
            "type":"string",
            "format":"url"
        },
        "followupType":{
            "$ref":"#/definitions/XV1FollowupType"
        },
        "isOpen":{
            "description":"Whether this followup is open or closed.",
            "type":"boolean"
        },
        "isRead":{
            "description":"Whether this followup is read.",
            "type":"boolean"
        },
        "isReply":{
            "description":"Whether this followup has been replied to.",
            "type":"boolean"
        },
        "messageURL":{
            "description":"A URL to the message this followup is set on.",
            "type":"string",
            "format":"url"
        },
        "openDate":{
            "description":"When the open/close state last changed.",
            "type":"string",
            "format":"date"
        },
        "openDateInISO8601Format":{
            "description":"When the open/close state last changed, in ISO 8601 format.",
            "type":"string"
        },
        "openURL":{
            "description":"A URL to the user who last changed the open/close state.",
            "type":"string",
            "format":"url"
        },
        "readDate":{
            "description":"When the read state last changed.",
            "type":"string",
            "format":"date"
        },
        "readDateInISO8601Format":{
            "description":"When the read state last changed, in ISO 8601 format.",
            "type":"string"
        },
        "replyDate":{
            "description":"When the last reply happened.",
            "type":"string",
            "format":"date"
        },
        "replyDateInISO8601Format":{
            "description":"When the last reply happened, in ISO 8601 format.",
            "type":"string"
        },
        "replyURL":{
            "description":"A URL to any reply message.",
            "type":"string",
            "format":"url"
        },
        "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"
        }
    }
}

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

型: object

ソースを表示

• field(optional): string
  許容値: [ "FOR_YOUR_INFORMATION", "PLEASE_REPLY", "PLEASE_REPLY_URGENT" ]

  V1フォローアップ・タイプ。

{
    "properties":{
        "field":{
            "type":"string",
            "description":"V1 Followup Types.",
            "enum":[
                "FOR_YOUR_INFORMATION",
                "PLEASE_REPLY",
                "PLEASE_REPLY_URGENT"
            ]
        }
    }
}

先頭に戻る