kinlane
2/21/2018 - 4:35 PM
Atlassian Stride OpenAPI
Atlassian Stride OpenAPI
{
"swagger": "2.0",
"info": {
"version": "1.0",
"title": "Stride API",
"description": "This service provides public API for the Stride."
},
"host": "api.atlassian.com",
"basePath": "/",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/app/module/chat/conversation/chat:configuration/{key}/state": {
"post": {
"description": "Post app configuration updates telling the.\n\nAuthentication required.",
"summary": "Send app configuration updates",
"tags": [
"app"
],
"operationId": "AppModuleChatConversationChatConfigurationStateByKeyPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "key",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "key",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/app/module/chat/conversation/chat:configuration/%7B%7Bkey%7D%7D/state",
"headers": {
"Accept": "application/json",
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Send app configuration updates",
"x-testDescription": "Post app configuration updates telling the.\n\nAuthentication required."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/app/module/chat/conversation/chat:glance/{key}/state": {
"post": {
"description": "Post glance updates which will be pushed for all users within the specified context.\n\nAuthentication required.",
"summary": "Send glance updates",
"tags": [
"app"
],
"operationId": "AppModuleChatConversationChatGlanceStateByKeyPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "key",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "key",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/app/module/chat/conversation/chat:glance/%7B%7Bkey%7D%7D/state",
"headers": {
"Accept": "application/json",
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Send glance updates",
"x-testDescription": "Post glance updates which will be pushed for all users within the specified context.\n\nAuthentication required."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/site/{cloudId}/conversation": {
"get": {
"description": "Authentication required, with scope participate:conversation",
"summary": "Get conversation list for site",
"tags": [
"site"
],
"operationId": "SiteConversationByCloudIdGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "include-private",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "include-archived",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "limit",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "query",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "cursor",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "sort",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "cloudId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "cloudId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/site/{{cloudId}}/conversation?include-private={{include-private}}&include-archived={{include-archived}}&limit={{limit}}&query={{query}}&cursor={{cursor}}&sort={{sort}}",
"headers": {
"Accept": "application/json",
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get conversation list for site",
"x-testDescription": "Authentication required, with scope participate:conversation"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Authentication required, with scope manage:conversation",
"summary": "Create conversation",
"tags": [
"site"
],
"operationId": "SiteConversationByCloudIdPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "cloudId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "cloudId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/site/%7B%7BcloudId%7D%7D/conversation",
"headers": {
"Accept": "application/json",
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create conversation",
"x-testDescription": "Authentication required, with scope manage:conversation"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/site/{cloudId}/conversation/user/{userId}/message": {
"post": {
"description": "Authentication required, with scope participate:conversation",
"summary": "Send message to user",
"tags": [
"site"
],
"operationId": "SiteConversationUserMessageByCloudIdAndUserIdPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "cloudId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "cloudId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "userId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "userId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/site/%7B%7BcloudId%7D%7D/conversation/user/%7B%7BuserId%7D%7D/message",
"headers": {
"Accept": "application/json",
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Send message to user",
"x-testDescription": "Authentication required, with scope participate:conversation"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/site/{cloudId}/conversation/{conversationId}": {
"get": {
"description": "Authentication required, with scope participate:conversation",
"summary": "Get conversation details",
"tags": [
"site"
],
"operationId": "SiteConversationByCloudIdAndConversationIdGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "cloudId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "cloudId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "conversationId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "conversationId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/site/%7B%7BcloudId%7D%7D/conversation/%7B%7BconversationId%7D%7D",
"headers": {
"Accept": "application/json",
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get conversation details",
"x-testDescription": "Authentication required, with scope participate:conversation"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"patch": {
"description": "Authentication required, with scope manage:conversation",
"summary": "Update conversation",
"tags": [
"site"
],
"operationId": "SiteConversationByCloudIdAndConversationIdPatch",
"produces": [
"application/json"
],
"parameters": [
{
"name": "cloudId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "cloudId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "conversationId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "conversationId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PATCH",
"uri": "/site/%7B%7BcloudId%7D%7D/conversation/%7B%7BconversationId%7D%7D",
"headers": {
"Accept": "application/json",
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Update conversation",
"x-testDescription": "Authentication required, with scope manage:conversation"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/site/{cloudId}/conversation/{conversationId}/archive": {
"put": {
"description": "Authentication required, with scope manage:conversation",
"summary": "Archive conversation",
"tags": [
"site"
],
"operationId": "SiteConversationArchiveByCloudIdAndConversationIdPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "cloudId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "cloudId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "conversationId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "conversationId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/site/%7B%7BcloudId%7D%7D/conversation/%7B%7BconversationId%7D%7D/archive",
"headers": {
"Accept": "application/json",
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Archive conversation",
"x-testDescription": "Authentication required, with scope manage:conversation"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/site/{cloudId}/conversation/{conversationId}/media": {
"post": {
"description": "Authentication required, with scope participate:conversation",
"summary": "Upload a file",
"tags": [
"site"
],
"operationId": "SiteConversationMediaByCloudIdAndConversationIdPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "name",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "cloudId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "cloudId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "conversationId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "conversationId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/site/{{cloudId}}/conversation/{{conversationId}}/media?name={{name}}",
"headers": {
"Accept": "application/json",
"Content-Type": "application/octet-stream"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Upload a file",
"x-testDescription": "Authentication required, with scope participate:conversation"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/site/{cloudId}/conversation/{conversationId}/media/{mediaId}": {
"get": {
"description": "Authentication required, with scope participate:conversation",
"summary": "Get a file",
"tags": [
"site"
],
"operationId": "SiteConversationMediaMediaIdByCloudIdAndConversationIdGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "cloudId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "cloudId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "conversationId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "conversationId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "mediaId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "mediaId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/site/%7B%7BcloudId%7D%7D/conversation/%7B%7BconversationId%7D%7D/media/%7B%7BmediaId%7D%7D",
"headers": {
"Accept": "application/json",
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a file",
"x-testDescription": "Authentication required, with scope participate:conversation"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/site/{cloudId}/conversation/{conversationId}/message": {
"get": {
"description": "Authentication required, with scope participate:conversation\n\nThis method returns messages after/before a given messageIDs or/and timestamps.\nIf these parameters are omitted the method returns conversation’s latest messages.",
"summary": "Get conversation history",
"tags": [
"site"
],
"operationId": "SiteConversationMessageByCloudIdAndConversationIdGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "beforeMessage",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "beforeTimestamp",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "afterMessage",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "afterTimestamp",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "limit",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "cloudId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "cloudId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "conversationId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "conversationId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/site/{{cloudId}}/conversation/{{conversationId}}/message?beforeMessage={{beforeMessage}}&beforeTimestamp={{beforeTimestamp}}&afterMessage={{afterMessage}}&afterTimestamp={{afterTimestamp}}&limit={{limit}}",
"headers": {
"Accept": "application/json",
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get conversation history",
"x-testDescription": "Authentication required, with scope participate:conversation\n\nThis method returns messages after/before a given messageIDs or/and timestamps.\nIf these parameters are omitted the method returns conversation’s latest messages."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Authentication required, with scope participate:conversation",
"summary": "Send a message to a conversation",
"tags": [
"site"
],
"operationId": "SiteConversationMessageByCloudIdAndConversationIdPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "cloudId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "cloudId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "conversationId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "conversationId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/site/%7B%7BcloudId%7D%7D/conversation/%7B%7BconversationId%7D%7D/message",
"headers": {
"Accept": "application/json",
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Send a message to a conversation",
"x-testDescription": "Authentication required, with scope participate:conversation"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/site/{cloudId}/conversation/{conversationId}/message/recent": {
"get": {
"description": "Authentication required, with scope participate:conversation",
"summary": "Get latest messages for conversation",
"tags": [
"site"
],
"operationId": "SiteConversationMessageRecentByCloudIdAndConversationIdGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "limit",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "cloudId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "cloudId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "conversationId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "conversationId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/site/{{cloudId}}/conversation/{{conversationId}}/message/recent?limit={{limit}}",
"headers": {
"Accept": "application/json",
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get latest messages for conversation",
"x-testDescription": "Authentication required, with scope participate:conversation"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/site/{cloudId}/conversation/{conversationId}/message/{messageId}": {
"get": {
"description": "Authentication required, with scope participate:conversation",
"summary": "Get message by id",
"tags": [
"site"
],
"operationId": "SiteConversationMessageMessageIdByCloudIdAndConversationIdGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "messageId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "messageId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "cloudId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "cloudId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "conversationId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "conversationId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/site/%7B%7BcloudId%7D%7D/conversation/%7B%7BconversationId%7D%7D/message/%7B%7BmessageId%7D%7D",
"headers": {
"Accept": "application/json",
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get message by id",
"x-testDescription": "Authentication required, with scope participate:conversation"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/site/{cloudId}/conversation/{conversationId}/message/{messageId}/context": {
"get": {
"description": "Authentication required, with scope participate:conversation\n\nThis method returns messages after and/or before a given messageID including the message itself.\nDefault value for 'after' and 'before' query parameters is 0.",
"summary": "Get conversation history contextually",
"tags": [
"site"
],
"operationId": "SiteConversationMessageMessageIdContextByCloudIdAndConversationIdGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "before",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "after",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "messageId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "messageId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "cloudId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "cloudId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "conversationId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "conversationId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/site/{{cloudId}}/conversation/{{conversationId}}/message/{{messageId}}/context?before={{before}}&after={{after}}",
"headers": {
"Accept": "application/json",
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get conversation history contextually",
"x-testDescription": "Authentication required, with scope participate:conversation\n\nThis method returns messages after and/or before a given messageID including the message itself.\nDefault value for 'after' and 'before' query parameters is 0."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/site/{cloudId}/conversation/{conversationId}/roster": {
"get": {
"description": "Authentication required, with scope participate:conversation",
"summary": "Get conversation roster",
"tags": [
"site"
],
"operationId": "SiteConversationRosterByCloudIdAndConversationIdGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "start",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "limit",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "cloudId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "cloudId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "conversationId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "conversationId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/site/{{cloudId}}/conversation/{{conversationId}}/roster?start={{start}}&limit={{limit}}",
"headers": {
"Accept": "application/json",
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get conversation roster",
"x-testDescription": "Authentication required, with scope participate:conversation"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/site/{cloudId}/conversation/{conversationId}/unarchive": {
"put": {
"description": "Authentication required, with scope manage:conversation",
"summary": "Unarchive conversation",
"tags": [
"site"
],
"operationId": "SiteConversationUnarchiveByCloudIdAndConversationIdPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "cloudId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "cloudId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "conversationId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "conversationId",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/site/%7B%7BcloudId%7D%7D/conversation/%7B%7BconversationId%7D%7D/unarchive",
"headers": {
"Accept": "application/json",
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Unarchive conversation",
"x-testDescription": "Authentication required, with scope manage:conversation"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
}
}
}