Jump to

• Request
• Response

Get messages

get

/rest/ofscCollaboration/v1/chats/{chatId}/messages

Get all the messages under a chat id

Request

Supported Media Types

• application/json

Path Parameters

• chatId(required): integer
  The unique identifier of the chat in Oracle Field Service.

Back to Top

Response

Supported Media Types

• application/json

200 Response

This section describes the 200 status response for this operation.

Body ()

Root Schema : GetMessageResponse

Type: object

The list of messages of the chat.

Show Source

• direction: string
  Allowed Values: [ "asc", "desc" ]

  order of response retrieved. default: desc
• items: array items
  An array of items containing the message details.
• limit: integer(int32)
  The limit value specified in the request.
• links: array links
  The array of pagination items.
• offset: integer(int32)
  The offset value specified in the request.
• totalResults: integer(int32)
  The total number of messages retrieved.

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"The total number of messages retrieved."
        },
        "limit":{
            "type":"integer",
            "format":"int32",
            "description":"The limit value specified in the request."
        },
        "offset":{
            "type":"integer",
            "format":"int32",
            "description":"The offset value specified in the request."
        },
        "direction":{
            "type":"string",
            "description":"order of response retrieved. default: desc",
            "enum":[
                "asc",
                "desc"
            ]
        },
        "items":{
            "type":"array",
            "description":"An array of items containing the message details.",
            "items":{
                "$ref":"#/definitions/Message"
            }
        },
        "links":{
            "type":"array",
            "description":"The array of pagination items.",
            "items":{
                "$ref":"#/definitions/PaginationLink"
            }
        }
    },
    "description":"The list of messages of the chat."
}

Nested Schema : items

Type: array

An array of items containing the message details.

Show Source

• Array of: object Message
  Chat message details

{
    "type":"array",
    "description":"An array of items containing the message details.",
    "items":{
        "$ref":"#/definitions/Message"
    }
}

Nested Schema : links

Type: array

The array of pagination items.

Show Source

• Array of: object PaginationLink
  The pagination links.

{
    "type":"array",
    "description":"The array of pagination items.",
    "items":{
        "$ref":"#/definitions/PaginationLink"
    }
}

Nested Schema : Message

Type: object

Chat message details

Show Source

• attachment: object Attachment
• author: string
  The user login of the user who created this message
• messageId: integer(int32)
  The identifier of the message in the collaboration server (long).
• sequenceNumber: integer(int32)
  The sequence number of the message in the chat or broadcast (long).
• text: string
  The text content of the message (string).
• time: string
  The time the message was sent in UTC time standard (string). The time format is YYYY-MM-DD HH:MM:SS.
• type: string
  Allowed Values: [ "message", "notification" ]

  Type of message whether its user generated(message) or system generated(notification).

{
    "type":"object",
    "properties":{
        "messageId":{
            "type":"integer",
            "format":"int32",
            "description":"The identifier of the message in the collaboration server (long)."
        },
        "sequenceNumber":{
            "type":"integer",
            "format":"int32",
            "description":"The sequence number of the message in the chat or broadcast (long)."
        },
        "text":{
            "type":"string",
            "description":"The text content of the message (string)."
        },
        "attachment":{
            "type":"object",
            "$ref":"#/definitions/Attachment"
        },
        "author":{
            "type":"string",
            "description":"The user login of the user who created this message"
        },
        "time":{
            "type":"string",
            "description":"The time the message was sent in UTC time standard (string). The time format is YYYY-MM-DD HH:MM:SS."
        },
        "type":{
            "type":"string",
            "description":"Type of message whether its user generated(message) or system generated(notification).",
            "enum":[
                "message",
                "notification"
            ]
        }
    },
    "description":"Chat message details"
}

Nested Schema : Attachment

Type: object

Show Source

• content: object ImageContent
• id: string
  attachment entity ID. activity, resource or inventory ID. no ID field required for image type
• type(required): string
  Allowed Values: [ "activity", "resource", "inventory", "image" ]

  type of attachment

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"type of attachment",
            "enum":[
                "activity",
                "resource",
                "inventory",
                "image"
            ]
        },
        "id":{
            "type":"string",
            "description":"attachment entity ID. activity, resource or inventory ID. no ID field required for image type"
        },
        "content":{
            "type":"object",
            "$ref":"#/definitions/ImageContent"
        }
    },
    "required":[
        "type"
    ]
}

Nested Schema : ImageContent

Type: object

Show Source

• filename(required): string
  image file name
• imageData(required): string
  base64 value of the image content
• mediaType(required): string
  media type

{
    "type":"object",
    "properties":{
        "filename":{
            "type":"string",
            "description":"image file name"
        },
        "mediaType":{
            "type":"string",
            "description":"media type"
        },
        "imageData":{
            "type":"string",
            "description":"base64 value of the image content"
        }
    },
    "required":[
        "filename",
        "mediaType",
        "imageData"
    ]
}

Nested Schema : PaginationLink

Type: object

The pagination links.

Show Source

• href: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "description":"The pagination links."
}

Default Response

This section describes the default error response for this operation.

Body ()

Root Schema : Error

Type: object

Show Source

• detail: string
  The detailed description of this error.
• status: string
  The HTTP status code of this error.
• title(required): string
  The brief description of this error.
• type(required): string
  The URL of the web page containing more details about this error.

{
    "properties":{
        "type":{
            "type":"string",
            "description":"The URL of the web page containing more details about this error."
        },
        "title":{
            "type":"string",
            "description":"The brief description of this error."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code of this error."
        },
        "detail":{
            "type":"string",
            "description":"The detailed description of this error."
        }
    },
    "required":[
        "type",
        "title"
    ]
}

Back to Top