機械翻訳について

移動先

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

指定したメッセージの新規フォローアップを作成

post

/social/api/v1/messages/{messageID}/followups

リクエスト

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

• application/json

パス・パラメータ

• messageID: integer(int64)
  メッセージID。 オブジェクトのlong integer表現の一意識別子。

本文()

リクエスト本文は、リクエストの詳細を定義します。

ルート・スキーマ: XV1MessageFollowupCreateInfo

型: object

V1メッセージ・フォローアップ作成情報。

ソースを表示

• assignee(optional): string
  フォローアップの割当て先。 必須。
• followupType(optional): object XV1FollowupType

{
    "description":"V1 Message Followup Create Information.",
    "properties":{
        "assignee":{
            "description":"The followup assignee. Required.",
            "type":"string"
        },
        "followupType":{
            "$ref":"#/definitions/XV1FollowupType"
        }
    }
}

ネストされたスキーマ: 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レスポンス

操作の成功

本文()

ルート・スキーマ: XV1MessageFollowupInfo

型: 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 Message 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"
            ]
        }
    }
}

先頭に戻る