swagger: '2.0' info: title: Chatops version: 1.0.0 host: test-int.chatops.kyndryl.net basePath: / schemes: - https paths: /api/root/ping: get: parameters: [] responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - PingController x-controller-name: PingController x-operation-name: ping /api/v1/account: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely Iidentifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: >- String that uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Accountcode locator in: body name: body required: true schema: type: object x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - ChatopsKnightController summary: Get Account On Boarded x-controller-name: ChatopsKnightController x-operation-name: getAccountBoardedPost /api/v1/accounts/list: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely Iidentifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: >- String that uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Sends a JSON-formated message using the provided URL in: body name: body required: true schema: $ref: '#/definitions/GetAccountsListRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorController x-controller-name: CollaboratorController x-operation-name: getAccountsList /api/v1/addReaction: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: Uniquely identifies the transaction in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to add reaction to channel in: body name: body required: true schema: $ref: '#/definitions/AddReactionToMessageRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |- **Request Parameters:** **callbackUrl:** URL used to return Response ( **Optional** ) **accountCodeLocators:** Uniquely Identifies the account,(**Optional** against workspaceName) **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps ( **Optional** against accountCodeLocators ) **ts:** timestamp of message to add reactions in channel **channelId:** channel id of the collaborator channel summary: Add Reaction to a Message in Channel by Channel Id x-controller-name: CollaboratorAuthenticatedController x-operation-name: addReaction /api/v1/addReaction/sync: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: Uniquely identifies the transaction in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to add reaction to channel in: body name: body required: true schema: $ref: '#/definitions/AddReactionToMessageSyncRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps **ts:** timestamp of message to add reactions in channel **channelId:** channel id of the collaborator channel summary: Add Reaction to a Message in Channel by Channel Id x-controller-name: CollaboratorAuthenticatedController x-operation-name: addReactionSync /api/v1/addResources: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: Uniquely identifies the transaction in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Add resources to channel in: body name: body required: true schema: $ref: '#/definitions/AddResourceToChannelRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **callbackUrl:** URL used to return Response ( **Optional** ) **accountCodeLocators:** Uniquely Identifies the account,(**Optional** against workspaceName) **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps ( **Optional** against accountCodeLocators ) **resourceIds:** List of email Ids **channelId:** channel id of the collaborator channel ( **Optional** against ticketId ) **ticketId:** ticket id of the collaborator channel ( **Optional** against channelId, if provided given first precedence ) summary: Add resources to Channel by Email IDs x-controller-name: CollaboratorAuthenticatedController x-operation-name: addResourcesToChannel /api/v1/addResources/sync: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: 'Api Token (Signed Payload) or generated api key ' in: header name: X-Chatops-Source-Api-Token required: true type: string - description: >- Uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Add resources to channel in: body name: body required: true schema: $ref: '#/definitions/AddResourceToChannelSyncRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps **resourceIds:** List of email Ids **channelId:** channel id of the collaborator channel summary: Add resources to Channel by Email IDs x-controller-name: CollaboratorAuthenticatedController x-operation-name: addResourcesToChannelSync /api/v1/archiveChannel: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: Uniquely identifies the transaction in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to post message to channel in: body name: body required: true schema: $ref: '#/definitions/ChannelInfoAuthenticatedRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **callbackUrl:** URL used to return Response ( **Optional** ) **accountCodeLocators:** Uniquely Identifies the account,(**Optional** against workspaceName) **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps ( **Optional** against accountCodeLocators ) **channelId:** channel id of the collaborator channel ( **Optional** against ticketId ) **ticketId:** ticket id of the collaborator channel ( **Optional** against channelId, if provided given first precedence ) summary: Archive Channel by Channel Id x-controller-name: CollaboratorAuthenticatedController x-operation-name: archiveChannel /api/v1/archiveChannel/sync: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: >- Uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Archive channel in sync mode in: body name: body required: true schema: $ref: '#/definitions/ChannelInfoAuthenticatedSyncRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps ( **Optional** and if provided given first precedence ) **channelId:** channel id of the collaborator channel summary: Archive Channel by Channel Id x-controller-name: CollaboratorAuthenticatedController x-operation-name: archiveChannelSync /api/v1/assignRole: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely Iidentifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: >- Api Token (Signed Payload) or generated api key ( begins with apiKey: ) should be accomponied with accountCodeLocators in: header name: X-Chatops-Source-Api-Token required: true type: string - description: >- String that uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to post message to user in: body name: body required: true schema: $ref: '#/definitions/AssignRoleRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **accountCodeLocators:** Uniquely Identifies the account,(**Optional** against workspaceName) **workspaceName:** Uniquely identifies workspace name of ChatOps ( **Optional** and if provided given first precedence ) **ticketId:** ticket id of the collaborator channel **channelId:** channel Id of the collaborator channel(**Optional**) **roles:** roles that user can be mapped "roleName": "INC Commander" / "Practitioner" / "DPE" "users": "Email Id of users to assign roles" summary: Assign Roles by Ticket Id x-controller-name: CollaboratorAuthenticatedController x-operation-name: assignRole /api/v1/assignRole/sync: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely Iidentifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: >- Api Token (Signed Payload) or generated api key ( begins with apiKey: ) should be accomponied with accountCodeLocators in: header name: X-Chatops-Source-Api-Token required: true type: string - description: >- String that uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to post message to user in: body name: body required: true schema: $ref: '#/definitions/AssignRoleSyncRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps **ticketId:** ticket Id of the collaborator channel **channelId:** channel Id of the collaborator channel(**Optional**) **roles:** roles that user can be mapped to "roleName": "INC Commander" / "Practitioner" / "DPE" "users": "Email Id of users to assign roles" summary: Assign Roles by Ticket Id x-controller-name: CollaboratorAuthenticatedController x-operation-name: assignRoleSync /api/v1/createChannel: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: Uniquely identifies the transaction in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Create channel in: body name: body required: true schema: $ref: '#/definitions/CreateChannelRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **callbackUrl:** URL used to return Response ( **Optional** ) **accountCodeLocators:** Uniquely Identifies the account,(**Optional** against workspaceName) **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps ( **Optional** against accountCodeLocators ) **channelName:** channel name to be created **isPrivate:** true for private, false for public ( default to false ) summary: Create Channel in Slack x-controller-name: CollaboratorAuthenticatedController x-operation-name: createChannel /api/v1/createChannel/sync: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: >- Uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Create channel in: body name: body required: true schema: $ref: '#/definitions/CreateChannelSyncRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps **channelName:** channel name to be created **isPrivate:** true for private, false for public ( default to false ) summary: 'Create Channel in Slack ' x-controller-name: CollaboratorAuthenticatedController x-operation-name: createChannelSync /api/v1/createGroupConversation: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: Uniquely identifies the transaction in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to send message to a userr in: body name: body required: true schema: $ref: '#/definitions/CreateGroupConversationRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps **emailID:** Email ID of user to get profile link **message:** message to start a conversation summary: 'Initiate a Group Conversation between multiple users ' x-controller-name: CollaboratorAuthenticatedController x-operation-name: createGroupConversation /api/v1/createGroupConversation/sync: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: Uniquely identifies the transaction in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to send message to a userr in: body name: body required: true schema: $ref: '#/definitions/CreateGroupConversationRequestSync' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps **emailID:** Email ID of user to get profile link **message:** message to start a conversation summary: 'Initiate a Group Conversation between multiple users ' x-controller-name: CollaboratorAuthenticatedController x-operation-name: createGroupConversationSync /api/v1/deleteMessageInChannel: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: Uniquely identifies the transaction in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to add reaction to channel in: body name: body required: true schema: $ref: '#/definitions/DeleteMessageInChannelRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **callbackUrl:** URL used to return Response ( **Optional** ) **accountCodeLocators:** Uniquely Identifies the account,(**Optional** against workspaceName) **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps ( **Optional** against accountCodeLocators ) **ts:** timestamp of the message to be deleted in channel **channelId:** channel id of the collaborator channel summary: Deletes a Message in a Channel using Channel Id x-controller-name: CollaboratorAuthenticatedController x-operation-name: deleteMessageInChannel /api/v1/deleteMessageInChannel/sync: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: Uniquely identifies the transaction in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to add reaction to channel in: body name: body required: true schema: $ref: '#/definitions/DeleteMessageInChannelSyncRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **callbackUrl:** URL used to return Response ( **Optional** ) **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps **ts:** timestamp of message to be deleted **channelId:** channel id of the collaborator channel summary: Deletes a Message in a Channel using Channel Id x-controller-name: CollaboratorAuthenticatedController x-operation-name: deleteMessageInChannelSync /api/v1/directIntegrationAction: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely Iidentifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: >- String that uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Payload from Business Rule of ticketing tool in: body name: body required: true schema: $ref: '#/definitions/DirectIntegrationRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - BusinessruleController x-controller-name: BusinessruleController x-operation-name: directIntegrationAction /api/v1/externalansiblelaunch: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: 'Api Token (Signed Payload) or generated api key ' in: header name: X-Chatops-Source-Api-Token required: true type: string - description: >- Uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - description: Request to lunch job template for external call in: body name: body required: true schema: $ref: '#/definitions/AnsibleLaunchRequest' x-parameter-index: 4 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - ChatopsKnightController x-controller-name: ChatopsKnightController x-operation-name: externalAnsibleLaunch /api/v1/fileUpload: post: consumes: - multipart/form-data parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: Uniquely identifies the transaction in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: multipart/form-data value. in: formData name: body required: true type: object x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |- **Request Parameters:** **File Restricted to 10MB.** Follow the link for Restricted File types:- **https://slack.com/intl/en-in/help/articles/1500002249342-Restricted-file-types-in-Slack-Connect** **callbackUrl:** URL used to return Response ( **Optional** ) **accountCodeLocators:** Uniquely Identifies the account,(**Optional** against workspaceName) **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **file:** select file to upload. **title:** Title of file. **channels:** Comma-separated list of channel names or IDs where the file will be shared. **workspaceName:** Uniquely identifies workspace name of ChatOps **initialComment:** The message text introducing the file in specified channels. **threadTs:** Provide another message's ts value to upload this file as a reply. Never use a reply's ts value; use its parent instead. summary: 'Upload file to channel(s)) ' x-controller-name: CollaboratorAuthenticatedController x-operation-name: fileUpload /api/v1/fileUpload/sync: post: consumes: - multipart/form-data parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: Uniquely identifies the transaction in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: multipart/form-data value. in: formData name: body required: true type: object x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |- **Request Parameters:** **File Restricted to 10MB.** Follow the link for Restricted File types:- **https://slack.com/intl/en-in/help/articles/1500002249342-Restricted-file-types-in-Slack-Connect** **file:** select file to upload. **title:** Title of file. **channels:** Comma-separated list of channel names or IDs where the file will be shared. **workspaceName:** Uniquely identifies workspace name of ChatOps **initialComment:** The message text introducing the file in specified channels. **threadTs:** Provide another message's ts value to upload this file as a reply. Never use a reply's ts value; use its parent instead. summary: 'Upload file to channel(s)) ' x-controller-name: CollaboratorAuthenticatedController x-operation-name: fileUploadSync /api/v1/findResources: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: Uniquely identifies the transaction in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Find channel memebers async in: body name: body required: true schema: $ref: '#/definitions/ChannelInfoAuthenticatedRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **callbackUrl:** URL used to return Response ( **Optional** ) **accountCodeLocators:** Uniquely Identifies the account,(**Optional** against workspaceName) **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps ( **Optional** against accountCodeLocators ) **channelId:** channel id of the collaborator channel ( **Optional** against ticketId ) **ticketId:** ticket id of the collaborator channel ( **Optional** against channelId, if provided given first precedence ) summary: Find Channel Members by Channel Id x-controller-name: CollaboratorAuthenticatedController x-operation-name: findChannelResources /api/v1/findResources/sync: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: >- Uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Find channel memebers sync in: body name: body required: true schema: $ref: '#/definitions/ChannelInfoAuthenticatedSyncRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps ( **Optional** and if provided given first precedence ) **channelId:** channel id of the collaborator channel summary: Find Channel Members by Channel Id x-controller-name: CollaboratorAuthenticatedController x-operation-name: findChannelResourcesSync /api/v1/getChannelConversationInfo: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: Uniquely identifies the transaction in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: get Conversation Info of a channel in: body name: body required: true schema: $ref: '#/definitions/GetConvInfoAuthenticatedRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **callbackUrl:** URL used to return Response ( **Optional** ) **accountCodeLocators:** Uniquely Identifies the account,(**Optional** against workspaceName) **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps ( **Optional** against accountCodeLocators ) **channelId:** channel id of the collaborator channel ( **Optional** against ticketId ) **ticketId:** ticket id of the collaborator channel ( **Optional** against channelId, if provided given first precedence ) summary: Retrieves information about a conversation in a Channel x-controller-name: CollaboratorAuthenticatedController x-operation-name: getChannelConversationInfo /api/v1/getChannelConversationInfo/sync: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: >- Uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Get a Channels Conversation Information in: body name: body required: true schema: $ref: '#/definitions/GetConvInfoAuthenticatedSyncRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps **channelId:** channel id of the collaborator channel summary: Retrieves information about a conversation in a Channel x-controller-name: CollaboratorAuthenticatedController x-operation-name: getChannelConversationInfoSync /api/v1/getChannelInactiveTime: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: Uniquely identifies the transaction in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to post message to user in: body name: body required: true schema: $ref: '#/definitions/GetChannelInactiveTimeRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **callbackUrl:** URL used to return Response ( **Optional** ) **accountCodeLocators:** Uniquely Identifies the account,(**Optional** against workspaceName) **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps ( **Optional** against accountCodeLocators ) **channelId:** channel id of the collaborator channel ( **Optional** against ticketId ) **ticketId:** ticket id of the collaborator channel ( **Optional** against channelId, if provided given first precedence ) summary: Get Channel Inactive Time by Channel Id x-controller-name: CollaboratorAuthenticatedController x-operation-name: getChannelInactiveTime /api/v1/getChannelInactiveTime/sync: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: >- Uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to post message to user in: body name: body required: true schema: $ref: '#/definitions/GetChannelInactiveTimeSyncRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps **channelId:** channel id of the collaborator channel summary: Get Channel Inactive Time by Channel Id x-controller-name: CollaboratorAuthenticatedController x-operation-name: getChannelInactiveTimeSync /api/v1/getChatPlatformInfo: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: Uniquely identifies the transaction in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to post message to user in: body name: body required: true schema: $ref: '#/definitions/ChatPlatformInfoRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **callbackUrl:** URL used to return Response ( **Optional** ) **accountCodeLocators:** Uniquely Identifies the account,(**Optional** against workspaceName) **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps ( **Optional** against accountCodeLocators ) **channelId:** channel id of the collaborator channel ( **Optional** against ticketId ) **ticketId:** ticket id of the collaborator channel ( **Optional** against channelId, if provided given first precedence ) summary: Get Chat Platform Information by Channel Id x-controller-name: CollaboratorAuthenticatedController x-operation-name: getChatPlatformInfo /api/v1/getChatPlatformInfo/sync: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: >- Uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to post message to user in: body name: body required: true schema: $ref: '#/definitions/ChatPlatformInfoSyncRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps **channelId:** channel id of the collaborator channel ( **Optional** against ticketId ) **ticketId:** ticket id of the collaborator channel ( **Optional** against channelId, if provided given first precedence ) summary: Get Chat Platform Information by Channel Id x-controller-name: CollaboratorAuthenticatedController x-operation-name: getChatPlatformInfoSync /api/v1/getConversationHistory: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: >- Uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to get conversation history of channel in: body name: body required: true schema: $ref: '#/definitions/ConversationHistoryRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **callbackUrl:** URL used to return Response ( **Optional** ) **accountCodeLocators:** Uniquely Identifies the account,(**Optional** against workspaceName) **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps ( **Optional** against accountCodeLocators ) **channelId:** channel id of the collaborator channel ( **Optional** against ticketId ) **ticketId:** ticket id of the collaborator channel ( **Optional** against channelId, if provided given first precedence ) **latest:** timestamp from which messages to be displayed ( **Optional**, if provided limit should be given ) **oldest:** timestamp to which messages to be displayed ( **Optional**, if provided limit should be given ) **limit:** number of messages to be displayed ( **Optional**, if provided then latest/oldest timestamp value should be given ) **cursor:** [next_cursor] value to be provided given in response if it has more messages to be displayed ( **Optional** ) summary: Get Conversation History of a Channel x-controller-name: CollaboratorAuthenticatedController x-operation-name: getConversationHistory /api/v1/getConversationHistory/sync: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: >- Uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Get Conversation History of channel in: body name: body required: true schema: $ref: '#/definitions/ConversationHistorySyncRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps **channelId:** channel id of the collaborator channel **latest:** timestamp from which messages to be displayed ( **Optional**, if provided limit should be given ) **oldest:** timestamp to which messages to be displayed ( **Optional**, if provided limit should be given ) **limit:** number of messages to be displayed ( **Optional**, if provided then latest/oldest timestamp value should be given ) **cursor:** [next_cursor] value to be provided given in response if it has more messages to be displayed ( **Optional** ) summary: Get Conversation History of a Channel x-controller-name: CollaboratorAuthenticatedController x-operation-name: getConversationHistorySync /api/v1/getGroupMembers: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: Uniquely identifies the transaction in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Find channel memebers async in: body name: body required: true schema: $ref: '#/definitions/GroupMembersAuthenticatedRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |- **Request Parameters:** **callbackUrl:** URL used to return Response ( **Optional** ) **accountCodeLocators:** Uniquely Identifies the account,(**Optional** against workspaceName) **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps ( **Optional** against accountCodeLocators ) **channelId:** channel id of the collaborator channel summary: Find Channel Members by Channel Id x-controller-name: CollaboratorAuthenticatedController x-operation-name: getGroupMembers /api/v1/getGroupMembers/sync: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: Uniquely identifies the transaction in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Find channel memebers async in: body name: body required: true schema: $ref: '#/definitions/GroupMembersAuthenticatedRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |- **Request Parameters:** **callbackUrl:** URL used to return Response ( **Optional** ) **accountCodeLocators:** Uniquely Identifies the account,(**Optional** against workspaceName) **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps ( **Optional** against accountCodeLocators ) **channelId:** channel id of the collaborator channel summary: Find Channel Members by Channel Id x-controller-name: CollaboratorAuthenticatedController x-operation-name: getGroupMembersSync /api/v1/getMessageReactionInChannel: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: Uniquely identifies the transaction in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to add reaction to channel in: body name: body required: true schema: $ref: '#/definitions/GetMessageReactionInChannelRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **callbackUrl:** URL used to return Response ( **Optional** ) **accountCodeLocators:** Uniquely Identifies the account,(**Optional** against workspaceName) **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps ( **Optional** against accountCodeLocators ) **ts:** timestamp of message to add reactions in channel **channelId:** channel id of the collaborator channel ( **Optional** against ticketId ) **ticketId:** ticket id of the collaborator channel summary: Get Reaction to a Message in Channel by Channel Id x-controller-name: CollaboratorAuthenticatedController x-operation-name: getMessageReactionInChannel /api/v1/getMessageReactionInChannel/sync: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: Uniquely identifies the transaction in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to add reaction to channel in: body name: body required: true schema: $ref: '#/definitions/GetMessageReactionInChannelSyncRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps **ts:** timestamp of the message to get reactions from **channelId:** channel id of the collaborator channel summary: Get Reaction to a Message in Channel by Channel Id x-controller-name: CollaboratorAuthenticatedController x-operation-name: getMessageReactionInChannelSync /api/v1/getOpenTickets: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely Iidentifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: >- String that uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to get open tickets via Incident Manager in: body name: body required: true schema: $ref: '#/definitions/GetOpenticketsForAccountRequestAsync' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - ChatopsKnightController summary: >- Get Open Tickets for an Account filtered by type(Ticket Priority(number) and isMajor(boolean)) x-controller-name: ChatopsKnightController x-operation-name: getOpenTickets /api/v1/getOpenTickets/sync: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely Iidentifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: >- String that uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to get open tickets via Incident Manager in: body name: body required: true schema: $ref: '#/definitions/GetOpenticketsForAccountRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - ChatopsKnightController summary: >- Get Open Tickets for an Account filtered by type(Ticket Priority(number) and isMajor(boolean)) x-controller-name: ChatopsKnightController x-operation-name: getOpenTicketsSync /api/v1/getRoles: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely Iidentifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: >- String that uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to post message to user in: body name: body required: true schema: $ref: '#/definitions/GetRolesRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **callbackUrl:** URL used to return Response ( **Optional** ) **accountCodeLocators:** Uniquely Identifies the account,(**Optional** against workspaceName) **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps ( **Optional** against accountCodeLocators ) **channelId:** channel id of the collaborator channel ( **Optional** against ticketId ) **ticketId:** ticket id of the collaborator channel summary: Get Roles by Channel Id x-controller-name: CollaboratorAuthenticatedController x-operation-name: getRoles /api/v1/getRoles/sync: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely Iidentifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: >- String that uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to post message to user in: body name: body required: true schema: $ref: '#/definitions/GetRolesSyncRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps **ticketId:** ticket id of the collaborator channel summary: Get Roles by Ticket Id x-controller-name: CollaboratorAuthenticatedController x-operation-name: getRolesSync /api/v1/getSubSkillDetails: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: >- Uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to post message to user in: body name: body required: true schema: $ref: '#/definitions/GetSubSkillDetailsRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps **channelId:** channel id of the collaborator channel ( **Optional**) **ticketId:** ticket id of the collaborator channel ( **Optional** ) summary: Get Sub Skill API Details by Sub Skill x-controller-name: CollaboratorAuthenticatedController x-operation-name: getSubSkillDetails /api/v1/getUserProfileLink: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: Uniquely identifies the transaction in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to send message to a userr in: body name: body required: true schema: $ref: '#/definitions/GetUserProfileLinkRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **callbackUrl:** URL used to return Response ( **Optional** ) **accountCodeLocators:** Uniquely Identifies the account,(**Optional** against workspaceName) **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps ( **Optional** against accountCodeLocators ) **emailID:** Email ID of the user to get profile link summary: get user Profile link by email Id x-controller-name: CollaboratorAuthenticatedController x-operation-name: getUserProfileLink /api/v1/getUserProfileLink/sync: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: Uniquely identifies the transaction in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to send message to a userr in: body name: body required: true schema: $ref: '#/definitions/GetUserProfileLinkRequestSync' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps **emailID:** Email ID of user to get profile link summary: get user Profile link by email Id x-controller-name: CollaboratorAuthenticatedController x-operation-name: getUserProfileLinkSync /api/v1/initiateIncident: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely Iidentifies the source system in chatops) in: header name: CHATOPS-SOURCE-ID required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: CHATOPS-SOURCE-APITOKEN required: true type: string - description: >- String that uniquely identifies the transaction, can be obtained from event Payload in: header name: transactionid type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to create Channel via Incident Manager in: body name: body required: true schema: $ref: '#/definitions/ChatopsKnightChannelCreateRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - ChatopsKnightController deprecated: true summary: Create Channel with Incident Details x-controller-name: ChatopsKnightController x-operation-name: initiateChatOpsIncidentProcess /api/v1/initiateTicket: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely Iidentifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: >- String that uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to create Channel via Incident Manager in: body name: body required: true schema: $ref: '#/definitions/ChatopsKnightTicketChannelCreateRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - ChatopsKnightController summary: Create Channel with Ticket Details x-controller-name: ChatopsKnightController x-operation-name: initiateTicket /api/v1/metrics_data: get: parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: 'Api Token (Signed Payload) or generated api key ' in: header name: X-Chatops-Source-Api-Token required: true type: string - description: >- Uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - in: query name: from type: string - in: query name: to type: string - in: query name: page type: string - in: query name: per_page type: string responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **from:** from date ( **required** ) **to:** To date(**required**) **page:** page no ( **Optional**) **per_page:** No of items in a page( **Optional**) summary: Get metrics data for a given period x-controller-name: CollaboratorAuthenticatedController x-operation-name: metricsData /api/v1/pa/CrtGrpConvWithChannelDetails: post: consumes: - application/json parameters: - description: >- Uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: false type: string - description: String that uniquely identifies the Key used for Authentication in: header name: Authorization type: string - in: header name: proxy type: string - description: Request to send message to a userr in: body name: body required: true schema: $ref: '#/definitions/CrtGrpConvWithChannelDetPARequestSync' x-parameter-index: 3 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedPaController description: |2- **Request Parameters:** **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps **emailID:** Email ID of user to get profile link **message:** message to start a conversation summary: >- Initiate a Group Conversation between multiple users that got saved in channel details table x-controller-name: CollaboratorAuthenticatedPaController x-operation-name: CrtGrpConvWithChannelDetails /api/v1/pa/createChannel/sync: post: consumes: - application/json parameters: - description: >- Uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: false type: string - description: String that uniquely identifies the Key used for Authentication in: header name: Authorization type: string - in: header name: proxy type: string - description: fetch icd change requests in: body name: body required: true schema: $ref: '#/definitions/CreateChannelPARequestSync' x-parameter-index: 3 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedPaController description: |2- **Request Parameters:** **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps **channelName:** channel name to be created **isPrivate:** true for private, false for public ( default to false ) summary: 'Create Channel in Slack ' x-controller-name: CollaboratorAuthenticatedPaController x-operation-name: createChannelSync /api/v1/pa/createGroupConversation/sync: post: consumes: - application/json parameters: - description: >- Uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: false type: string - description: String that uniquely identifies the Key used for Authentication in: header name: Authorization type: string - in: header name: proxy type: string - description: Request to send message to a userr in: body name: body required: true schema: $ref: '#/definitions/CreateGroupConversationPARequestSync' x-parameter-index: 3 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedPaController description: |2- **Request Parameters:** **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps **emailID:** Email ID of user to get profile link **message:** message to start a conversation summary: 'Initiate a Group Conversation between multiple users ' x-controller-name: CollaboratorAuthenticatedPaController x-operation-name: createGroupConversationSync /api/v1/pa/createTab/sync: post: consumes: - application/json parameters: - description: >- Uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: false type: string - description: String that uniquely identifies the Key used for Authentication in: header name: Authorization required: true type: string - in: header name: proxy type: string - description: Create channel/group tab in: body name: body required: true schema: $ref: '#/definitions/CreateChannelTabSync' x-parameter-index: 3 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedPaController description: |- **Request Parameters:** **channelId:** Channel or Group Id **accountCode:** Uniquely identifies account in ChatOps summary: Create a tab in group or channel x-controller-name: CollaboratorAuthenticatedPaController x-operation-name: createTabSync /api/v1/pa/getaccounts/sync: post: consumes: - application/json parameters: - description: >- Uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: false type: string - description: String that uniquely identifies the Key used for Authentication in: header name: Authorization type: string - in: header name: proxy type: string - description: get Account Info based on ACL in: body name: body required: true schema: $ref: '#/definitions/AccountsRequest' x-parameter-index: 3 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedPaController description: |2- **Request Parameters:** **accountCodeLocators:** uniquely identifies accounts summary: Returns Account info x-controller-name: CollaboratorAuthenticatedPaController x-operation-name: getAccounts /api/v1/pa/icd/changerequests/sync: post: consumes: - application/json parameters: - description: >- Uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: false type: string - description: String that uniquely identifies the Key used for Authentication in: header name: Authorization type: string - in: header name: proxy type: string - description: Create channel in: body name: body required: true schema: $ref: '#/definitions/GetICDChangeRequestsSync' x-parameter-index: 3 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedPaController description: |2- **Request Parameters:** **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps **channelName:** channel name to be created **isPrivate:** true for private, false for public ( default to false ) summary: get icd change requests with given server names x-controller-name: CollaboratorAuthenticatedPaController x-operation-name: getICDChangeRequests /api/v1/pa/incidentdetails/sync: post: consumes: - application/json parameters: - description: >- Uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: false type: string - description: String that uniquely identifies the Key used for Authentication in: header name: Authorization type: string - in: header name: proxy type: string - description: get Incident details based on the filter in: body name: body required: true schema: $ref: '#/definitions/RequestFilter' x-parameter-index: 3 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedPaController description: |2- **Request Parameters:** **filter:** filter can be ticket id or channel id summary: Returns Incident details x-controller-name: CollaboratorAuthenticatedPaController x-operation-name: getIncidentManagerDetails /api/v1/pa/operationaltasks/audit: get: parameters: - description: >- Uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: false type: string - description: String that uniquely identifies the Key used for Authentication in: header name: Authorization type: string - in: header name: proxy type: string - in: query name: region required: true type: string - in: query name: dayBeforeYesterday required: true type: string - in: query name: dayYesterday required: true type: string - in: query name: truncate required: true type: string responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedPaController description: Fetch tasks from OperationalTaskAudits collection summary: Fetch Operational tasks from audits x-controller-name: CollaboratorAuthenticatedPaController x-operation-name: fetchOperationalTasks /api/v1/pa/operationaltasks/cache: post: consumes: - application/json parameters: - description: >- Uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: false type: string - description: String that uniquely identifies the Key used for Authentication in: header name: Authorization type: string - in: header name: proxy type: string - description: Post operational tasks to the collection in: body name: body required: true schema: $ref: '#/definitions/OperationalTaskCacheData' x-parameter-index: 3 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedPaController description: ' **Post Operational tasks cache to the collection ' summary: Post Operational tasks cache x-controller-name: CollaboratorAuthenticatedPaController x-operation-name: postOperationalTasksCache /api/v1/pa/operationaltasks/checklist: get: parameters: - description: >- Uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: false type: string - description: String that uniquely identifies the Key used for Authentication in: header name: Authorization type: string - in: header name: proxy type: string - in: query name: region type: string - in: query name: timeframe type: string responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedPaController description: '**fetch operational tasks for given time window in ET zone**' summary: Get Operational Task Checklist x-controller-name: CollaboratorAuthenticatedPaController x-operation-name: getOperationalTaskChecklist /api/v1/pa/operationaltasks/sync: post: consumes: - application/json parameters: - description: >- Uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: false type: string - description: String that uniquely identifies the Key used for Authentication in: header name: Authorization type: string - in: header name: proxy type: string - description: Post operational tasks to the collection in: body name: body required: true schema: $ref: '#/definitions/OperationalTaskData' x-parameter-index: 3 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedPaController description: ' **Post Operational tasks by region to the collection ' summary: Post Operational tasks x-controller-name: CollaboratorAuthenticatedPaController x-operation-name: postOperationalTasks /api/v1/pa/postWowMetrics/sync: post: consumes: - application/json parameters: - description: >- Uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: false type: string - description: String that uniquely identifies the Key used for Authentication in: header name: Authorization type: string - in: header name: proxy type: string - description: Post metrics of project to the collection in: body name: body required: true schema: $ref: '#/definitions/MetricsData' x-parameter-index: 3 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedPaController description: ' **Post metrics of project to the collection ' summary: Post Wow metrics x-controller-name: CollaboratorAuthenticatedPaController x-operation-name: postWowMetrics /api/v1/pa/postmessage/adaptivecard/sync: post: consumes: - application/json parameters: - description: >- Uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: false type: string - description: String that uniquely identifies the Key used for Authentication in: header name: Authorization type: string - in: header name: proxy type: string - description: Send Message to user/group in: body name: body required: true schema: $ref: '#/definitions/ACMessageRequest' x-parameter-index: 3 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedPaController description: |2- **Request Parameters:** **postType:** ( supported values [group/user] ) **message:** Adaptive Card object **postingBot:** Name of the Bot **email:** (Optional) user email id **groupId:** (Optional) group id **language:** prefered value english summary: Add resources to Channel by Email IDs x-controller-name: CollaboratorAuthenticatedPaController x-operation-name: messasgeAC /api/v1/pa/postmessage/sync: post: consumes: - application/json parameters: - description: >- Uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: false type: string - description: String that uniquely identifies the Key used for Authentication in: header name: Authorization type: string - in: header name: proxy type: string - description: Send Message to user/group in: body name: body required: true schema: $ref: '#/definitions/TextMessageRequest' x-parameter-index: 3 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedPaController description: |2- **Request Parameters:** **postType:** ( supported values [group/user] ) **message:** plain message object **postingBot:** Name of the Bot **email:** (Optional) user email id **groupId:** (Optional) group id **language:** prefered value english summary: Add resources to Channel by Email IDs x-controller-name: CollaboratorAuthenticatedPaController x-operation-name: messasge /api/v1/passThrough: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely Iidentifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: >- String that uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Payload for exploiting chatops pass through API in: body name: body required: true schema: $ref: '#/definitions/PassThroughRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - PassthroughController x-controller-name: PassthroughController x-operation-name: passThrough /api/v1/passThrough/sync: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely Iidentifies the source system in chatops) in: header name: X-Chatops-Source-Id type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: String that uniquely identifies the Key used for Authentication in: header name: Authorization type: string - description: Payload for exploiting chatops pass through API in: body name: body required: true schema: $ref: '#/definitions/PassThroughSyncRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - PassthroughController x-controller-name: PassthroughController x-operation-name: passThroughSync /api/v1/pinMessageToChannel: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: Uniquely identifies the transaction in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to pin message to channel in: body name: body required: true schema: $ref: '#/definitions/PinMessageRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **callbackUrl:** URL used to return Response ( **Optional** ) **accountCodeLocators:** Uniquely Identifies the account,(**Optional** against workspaceName) **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps ( **Optional** against accountCodeLocators ) **ts:** timestamp of message to pin in channel **channelId:** channel id of the collaborator channel ( **Optional** against ticketId ) **ticketId:** ticket id of the collaborator channel ( **Optional** against channelId, if provided given first precedence ) summary: Pin Message to a Channel x-controller-name: CollaboratorAuthenticatedController x-operation-name: pinMessageToChannel /api/v1/pinMessageToChannel/sync: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: >- Uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Pin message to channel in: body name: body required: true schema: $ref: '#/definitions/PinMessageSyncRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps ( **Optional** and if provided given first precedence ) **ts:** timestamp of message to pin in channel **channelId:** channel id of the collaborator channel summary: Pin Message to a Channel x-controller-name: CollaboratorAuthenticatedController x-operation-name: pinMessageToChannelSync /api/v1/postMessage: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: CHATOPS-SOURCE-ID required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: CHATOPS-SOURCE-APITOKEN required: true type: string - description: >- Uniquely identifies the transaction, can be obtained from event Payload in: header name: transactionid required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to post message to channel in: body name: body required: true schema: $ref: '#/definitions/PostMessageOldRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController deprecated: true description: |2- **Request Parameters:** **callbackUrl:** URL used to return Response ( **Optional** ) **accountCodeLocators:** Uniquely Identifies the account,(**Optional** against workspaceName) **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps ( **Optional** against accountCodeLocators ) **message:** message to post in slack ( Slack message object **Message Builder** ) **channelid:** channel id of the collaborator channel **ts:** timestamp of message to which text to be posted as reply ( **Optional** ) **isUpdate:** true if request is update, false if its new request ( **Optional**, defaults to true ) summary: 'Post Message to a Channel ' x-controller-name: CollaboratorAuthenticatedController x-operation-name: postMessageToChannelOld /api/v1/postMessage/sync: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: >- Uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to post message to channel in: body name: body required: true schema: $ref: '#/definitions/PostMessageSyncRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps **message:** message to post in slack ( Slack message object **Message Builder** ) **channelId:** channel id of the collaborator channel **ts:** timestamp of message to which text to be posted as reply ( **Optional** ) **isUpdate:** true if request is update, false if its new request ( **Optional**, defaults to true ) summary: 'Post Message to a Channel ' x-controller-name: CollaboratorAuthenticatedController x-operation-name: postMessageToChannelSync /api/v1/postMessageToUser: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: Uniquely identifies the transaction in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to post message to user in: body name: body required: true schema: $ref: '#/definitions/PostMessageUserRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **callbackUrl:** URL used to return Response ( **Optional** ) **accountCodeLocators:** Uniquely Identifies the account,(**Optional** against workspaceName) **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps ( **Optional** against accountCodeLocators ) **channelId:** channel id of the collaborator channel ( **Optional** against ticketId ) **ticketId:** ticket id of the collaborator channel ( **Optional** against channelId, if provided given first precedence ) **emailId:** email id of user to post the message **text:** message to post summary: Post Message to User by Channel Id and Email Id x-controller-name: CollaboratorAuthenticatedController x-operation-name: postMessageToUser /api/v1/postMessageToUser/sync: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: >- Uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to post message to user in: body name: body required: true schema: $ref: '#/definitions/PostMessageUserSyncRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps **channelId:** channel id of the collaborator channel **emailId:** email id of user to post the message **text:** message to post summary: Post Message to User by Channel Id and Email Id x-controller-name: CollaboratorAuthenticatedController x-operation-name: postMessageToUserSync /api/v1/postMessageWithTemplate: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: Uniquely identifies the transaction in: header name: X-Transaction-Id required: true type: string - in: header name: proxy type: string - description: Request to post message to channel With Template in: body name: body required: true schema: $ref: '#/definitions/PostMessageWithTemplateRequest' x-parameter-index: 4 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **callbackUrl:** URL used to return Response ( **Optional** ) **accountCodeLocators:** Uniquely Identifies the account,(**Optional** against workspaceName) **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps ( **Optional** against accountCodeLocators ) **message:** message to post in slack ( Slack message object: **Message Builder** ) **channelId:** channel id of the collaborator channel ( **Optional** against ticketId ) **ticketId:** ticket id of the collaborator channel ( **Optional** against channelId, if provided given first precedence ) summary: Post Message to a Channel With Template x-controller-name: CollaboratorAuthenticatedController x-operation-name: postMessageWithTemplate /api/v1/postModalToChannel: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: Uniquely identifies the transaction in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to post message to channel in: body name: body required: true schema: $ref: '#/definitions/ShowView' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **callbackUrl:** URL used to return Response ( **Optional** ) **accountCodeLocators:** Uniquely Identifies the account,(**Optional** against workspaceName) **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps ( **Optional** against accountCodeLocators ) **view:** modal to post in slack ( Slack message object: **Message Builder** ) **channelId:** channel id of the collaborator channel ( **Optional** against ticketId ) **ticketId:** ticket id of the collaborator channel ( **Optional** against channelId, if provided given first precedence **callbackId:** used as a reference on submit button **triggerId:** Unique for each trigger, generated by slack and avalable in actionPayload) summary: >- Post Modal to Channel by Channel Id, available in async mode to deal with response window of slack x-controller-name: CollaboratorAuthenticatedController x-operation-name: postModalToChannel /api/v1/sendDirectMessageToUser: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: Uniquely identifies the transaction in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to send message to a userr in: body name: body required: true schema: $ref: '#/definitions/SendDirectMessageToUserRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **callbackUrl:** URL used to return Response ( **Optional** ) **accountCodeLocators:** Uniquely Identifies the account,(**Optional** against workspaceName) **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps ( **Optional** against accountCodeLocators ) **ts:** Provide another message's timestamp value to make this message a reply. Avoid using a reply's ts value; use its parent instead. summary: Send Direct Message to a user by email Id x-controller-name: CollaboratorAuthenticatedController x-operation-name: sendDirectMessageToUser /api/v1/sendDirectMessageToUser/sync: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: Uniquely identifies the transaction in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to send message to a userr in: body name: body required: true schema: $ref: '#/definitions/SendDirectMessageToUser' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps **emailId:** email id of user to send direct message to **message:** message to post, summary: Send Direct Message to a user by email Id x-controller-name: CollaboratorAuthenticatedController x-operation-name: sendDirectMessageToUserSync /api/v1/sendDirectMessageToUsers: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: Uniquely identifies the transaction in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to send message to a userr in: body name: body required: true schema: $ref: '#/definitions/SendDirectMessageToUsersRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **callbackUrl:** URL used to return Response ( **Optional** ) **accountCodeLocators:** Uniquely Identifies the account,(**Optional** against workspaceName) **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps ( **Optional** against accountCodeLocators ) **ts:** timestamp of message to add reactions in channel **channelId:** channel id of the collaborator channel **message:** message to post in slack ( Slack message object **Message Builder** ) **emailID:** Email ID of the users to send the message to summary: Send Direct Message to a user by email Id x-controller-name: CollaboratorAuthenticatedController x-operation-name: sendDirectMessageToUsers /api/v1/sendDirectMessageToUsers/sync: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: Uniquely identifies the transaction in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to send message to a userr in: body name: body required: true schema: $ref: '#/definitions/SendDirectMessageToUsers' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps **channelId:** channel id of the collaborator channel summary: Send Direct Message to a user by email Id x-controller-name: CollaboratorAuthenticatedController x-operation-name: sendDirectMessageToUsersSync /api/v1/setPurposeConversationChannel: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: Uniquely identifies the transaction in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Set Purpose Conversation to channel in: body name: body required: true schema: $ref: '#/definitions/SetPurposeAuthenticatedRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **callbackUrl:** URL used to return Response ( **Optional** ) **accountCodeLocators:** Uniquely Identifies the account,(**Optional** against workspaceName) **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps ( **Optional** against accountCodeLocators ) **purpose:** Channel description **channelId:** channel id of the collaborator channel ( **Optional** against ticketId ) **ticketId:** ticket id of the collaborator channel ( **Optional** against channelId, if provided given first precedence ) summary: Set Conversation Purpose to a Channel by Channel Id x-controller-name: CollaboratorAuthenticatedController x-operation-name: setPurposeConversationChannel /api/v1/setPurposeConversationChannel/sync: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: >- Uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Set Purpose Conversation to Channel in: body name: body required: true schema: $ref: '#/definitions/SetPurposeAuthenticatedSyncRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps ( **Optional** and if provided given first precedence ) **purpose:** Channel description **channelId:** channel id of the collaborator channel summary: Set Conversation Purpose to a Channel by Channel Id x-controller-name: CollaboratorAuthenticatedController x-operation-name: setPurposeConversationChannelSync /api/v1/setTopicConversationChannel: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: Uniquely identifies the transaction in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Set Topic for a Conversation to channel in: body name: body required: true schema: $ref: '#/definitions/SetTopicAuthenticatedRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **callbackUrl:** URL used to return Response ( **Optional** ) **accountCodeLocators:** Uniquely Identifies the account,(**Optional** against workspaceName) **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps ( **Optional** against accountCodeLocators ) **topic:** Channel description **channelId:** channel id of the collaborator channel ( **Optional** against ticketId ) **ticketId:** ticket id of the collaborator channel ( **Optional** against channelId, if provided given first precedence ) summary: Sets the Topic for a Conversation in a Channel x-controller-name: CollaboratorAuthenticatedController x-operation-name: setTopicConversationChannel /api/v1/setTopicConversationChannel/sync: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: >- Uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Set Topic Conversation to Channel in: body name: body required: true schema: $ref: '#/definitions/SetTopicAuthenticatedSyncRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps ( **Optional** and if provided given first precedence ) **topic:** Channel description **channelId:** channel id of the collaborator channel summary: Sets the Topic for a conversation in a channel x-controller-name: CollaboratorAuthenticatedController x-operation-name: setTopicConversationChannelSync /api/v1/unarchiveConversationChannel: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: Uniquely identifies the transaction in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Unarchieve channel in: body name: body required: true schema: $ref: '#/definitions/ChannelInfoAuthenticatedRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **callbackUrl:** URL used to return Response ( **Optional** ) **accountCodeLocators:** Uniquely Identifies the account,(**Optional** against workspaceName) **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps ( **Optional** against accountCodeLocators ) **channelId:** channel id of the collaborator channel ( **Optional** against ticketId ) **ticketId:** ticket id of the collaborator channel ( **Optional** against channelId, if provided given first precedence ) summary: Unarchive Channel by Channel Id x-controller-name: CollaboratorAuthenticatedController x-operation-name: unarchiveConversationChannel /api/v1/unarchiveConversationChannel/sync: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: >- Uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Unarchieve Channel in: body name: body required: true schema: $ref: '#/definitions/ChannelInfoAuthenticatedSyncRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps **channelId:** channel id of the collaborator channel summary: Unarchive Channel by Channel Id x-controller-name: CollaboratorAuthenticatedController x-operation-name: unarchiveConversationChannelSync /api/v1/updateIncident: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely Iidentifies the source system in chatops) in: header name: CHATOPS-SOURCE-ID required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: CHATOPS-SOURCE-APITOKEN required: true type: string - description: >- String that uniquely identifies the transaction, can be obtained from event Payload in: header name: transactionid type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to update Channel via Incident Manager in: body name: body required: true schema: $ref: '#/definitions/UpdateIncidentRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - ChatopsKnightController deprecated: true summary: Update Channel with Incident Details x-controller-name: ChatopsKnightController x-operation-name: updateIncident /api/v1/updateTicket: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely Iidentifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: >- String that uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to update Channel via Incident Manager in: body name: body required: true schema: $ref: '#/definitions/UpdateTicketRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - ChatopsKnightController summary: Update Channel with Ticket Details x-controller-name: ChatopsKnightController x-operation-name: updateTicket /api/v1/updateTicketInEcosystem: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely Iidentifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: >- String that uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - in: header name: X-Routing-Req type: string - in: header name: X-Req-Routed-From type: string - description: Request to update ticket in ChatOps Ecosystem in: body name: body required: true schema: $ref: '#/definitions/UpdateTicketInChannelRequest' x-parameter-index: 7 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - ChatopsKnightController description: |2- **Request Parameters:** **ticketId:** Identifies unique Ticket Id ( **Required** ) **createIncidentChannel:** if set to true, creates a incident channel for onboarded/non-onboarded Accounts with assignments if any(**Optional**) **status:** Status of the ticket (**Optional**, supported values [ Hold| Inprogress | Discovery | Resolve | Close ]) **assignmentEmails**:List of email Ids to be added in the channel (**Optional**,supported values for roles [ROLE_DPE | ROLE_PRACTITIONER | ROLE_INC_COMMANDER | NONE] ) **notificationEmails**:Email ids of those who gets notified in the Index Channel when updates happen (**Optional**) summary: Update Ticket in ChatOps Ecosystem x-controller-name: ChatopsKnightController x-operation-name: updateTicketInEcosystem /api/v2/getChatPlatformInfo: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: Uniquely identifies the transaction in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to post message to user in: body name: body required: true schema: $ref: '#/definitions/ChatPlatformInfoRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **callbackUrl:** URL used to return Response ( **Optional** ) **accountCodeLocators:** Uniquely Identifies the account,(**Optional** against workspaceName) **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps ( **Optional** against accountCodeLocators ) **channelId:** channel id of the collaborator channel ( **Optional** ) **ticketId:** ticket id of the collaborator channel ( **Optional** ) summary: Get Chat Platform Information by Channel Id x-controller-name: CollaboratorAuthenticatedController x-operation-name: chatPlatformInfo /api/v2/getChatPlatformInfo/sync: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: >- Uniquely identifies the transaction, can be obtained from event Payload in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to post message to user in: body name: body required: true schema: $ref: '#/definitions/ChatPlatformInfoSyncRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps **channelId:** channel id of the collaborator channel ( **Optional**) **ticketId:** ticket id of the collaborator channel ( **Optional** ) summary: Get Chat Platform Information by Channel Id x-controller-name: CollaboratorAuthenticatedController x-operation-name: chatPlatformInfoSync /api/v2/postMessage: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: Uniquely identifies the transaction in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to post message to channel in: body name: body required: true schema: $ref: '#/definitions/PostMessageRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **callbackUrl:** URL used to return Response ( **Optional** ) **accountCodeLocators:** Uniquely Identifies the account,(**Optional** against workspaceName) **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps ( **Optional** against accountCodeLocators ) **message:** message to post in slack ( Slack message object: **Message Builder** ) **channelId:** channel id of the collaborator channel ( **Optional** against ticketId ) **ticketId:** ticket id of the collaborator channel ( **Optional** against channelId, if provided given first precedence ) summary: Post Message to a Channel x-controller-name: CollaboratorAuthenticatedController x-operation-name: postMessageToChannel /api/v3/postMessage: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: X-Chatops-Source-Id required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: X-Chatops-Source-Api-Token required: true type: string - description: Uniquely identifies the transaction in: header name: X-Transaction-Id required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to post message to channel in: body name: body required: true schema: $ref: '#/definitions/PostMessageRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController description: |2- **Request Parameters:** **callbackUrl:** URL used to return Response ( **Optional** ) **accountCodeLocators:** Uniquely Identifies the account,(**Optional** against workspaceName) **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps ( **Optional** against accountCodeLocators ) **message:** message to post in slack ( Slack message object: **Message Builder** ) **channelId:** channel id of the collaborator channel ( **Optional** against ticketId ) **ticketId:** ticket id of the collaborator channel ( **Optional** against channelId, if provided given first precedence ) summary: Post Message to a Channel x-controller-name: CollaboratorAuthenticatedController x-operation-name: postMessageToChannel /healthCheck: get: parameters: [] responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - PingController x-controller-name: PingController x-operation-name: ping /initiateChatOpsIncidentProcess: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely Iidentifies the source system in chatops) in: header name: CHATOPS-SOURCE-ID required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: CHATOPS-SOURCE-APITOKEN required: true type: string - description: >- String that uniquely identifies the transaction, can be obtained from event Payload in: header name: transactionid type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to create Channel via Incident Manager in: body name: body required: true schema: $ref: '#/definitions/ChatopsKnightChannelCreateRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - ChatopsKnightController deprecated: true summary: Create Channel with Incident Details x-controller-name: ChatopsKnightController x-operation-name: initiateChatOpsIncidentProcess /ping: get: parameters: [] responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - PingController x-controller-name: PingController x-operation-name: ping /postMessageToChannel: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely identifies the source system in chatops) in: header name: CHATOPS-SOURCE-ID required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: CHATOPS-SOURCE-APITOKEN required: true type: string - description: >- Uniquely identifies the transaction, can be obtained from event Payload in: header name: transactionid required: true type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to post message to channel in: body name: body required: true schema: $ref: '#/definitions/PostMessageOldRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - CollaboratorAuthenticatedController deprecated: true description: |2- **Request Parameters:** **callbackUrl:** URL used to return Response ( **Optional** ) **accountCodeLocators:** Uniquely Identifies the account,(**Optional** against workspaceName) **collabPlatform:** Collaboration Platform ( **Optional**, supported values [SLACK] ) **workspaceName:** Uniquely identifies workspace name of ChatOps ( **Optional** against accountCodeLocators ) **message:** message to post in slack ( Slack message object **Message Builder** ) **channelid:** channel id of the collaborator channel **ts:** timestamp of message to which text to be posted as reply ( **Optional** ) **isUpdate:** true if request is update, false if its new request ( **Optional**, defaults to true ) summary: 'Post Message to a Channel ' x-controller-name: CollaboratorAuthenticatedController x-operation-name: postMessageToChannelOld /updateChatOpsIncident: post: consumes: - application/json parameters: - description: >- Source Identification Code,(uniquely Iidentifies the source system in chatops) in: header name: CHATOPS-SOURCE-ID required: true type: string - description: Api Token (Signed Payload) or generated api key in: header name: CHATOPS-SOURCE-APITOKEN required: true type: string - description: >- String that uniquely identifies the transaction, can be obtained from event Payload in: header name: transactionid type: string - description: String that uniquely identifies the Key used for Authentication in: header name: X-Chatops-Key type: string - in: header name: proxy type: string - description: Request to update Channel via Incident Manager in: body name: body required: true schema: $ref: '#/definitions/UpdateChatOpsIncidentEventRequest' x-parameter-index: 5 responses: '200': description: Success response '400': description: Invalid Request '401': description: Unauthenticated Request '403': description: Un-Authorized Request tags: - ChatopsKnightController deprecated: true summary: Update Channel with Incident Details x-controller-name: ChatopsKnightController x-operation-name: updateChatOpsIncident definitions: ACMessageRequest: additionalProperties: false properties: email: type: string feature: type: string groupId: type: string message: type: object postType: type: string postingBot: type: string priority: type: string ts: type: string required: - postType - message - postingBot title: ACMessageRequest type: object AccountCodeLocator: additionalProperties: false properties: SearchKey: type: string SearchValue: type: string required: - SearchKey - SearchValue title: AccountCodeLocator type: object AccountCodeLocatorModel: additionalProperties: false properties: blueId: type: string cdic: type: string cdir: type: string countryName: enum: - United States - Austria - Belgium - Argentina - Canada - Brazil - Colombia - Czech Republic - China - United Arab Emirates - Denmark - ABUDhabi - Chile - Australia - Germany - Greece - Hong Kong - Franc e - Iceland - India - Ireland - Israel - Italy - Japan - 'Korea, Republic of' - Kuwait - Indonesia - Malaysia - Netherlands - New Zealand - Norway - Pakistan - Phillipines - Poland - Russian Federation - Qatar - Portugal - Peru - Romania - Saudi Arabia - Paraguay - Mexico - Spain - Singapore - Sweden - Thailand - South Africa - Turkey - Egypt - United Kingdom type: string gbgid: type: string geography: enum: - Japan - APAC - EMEA - Americas type: string industry: enum: - CrossCompetency - Education - AerospaceDefense - Electronics - Finance - EnergyUtilities - FinancialMarkets - GeneralBusinessEnterprise - ChemicalsPetroleum - GeneralBusinessMidMarket - GlobalServices - GovernmentCentralFederal - IBMGlobalAccount - Automotive - noIndustry - IndustrialProducts - Insurance - Life Sciences - ProfessionalServices - MediaEntertainment - ComputerServices - Banking - GovernmentStateProvincialLocal - Healthcare - ConsumerProducts - Retail - SharedCommercialInfrastructure - Telecommunications - TechnologyGroup - TravelTransportation - WholesaleDistributionServices - Technology type: string isoCountryCode: enum: - US - AT - BE - AR - CA - BR - CO - CZ - CN - AE - DK - KW - CL - AU - DE - GR - HK - FR - IS - IN - IE - IL - IT - JP - KR - KW - ID - MY - NL - NZ - 'NO' - PK - PH - PL - RU - QA - PT - PE - RO - SA - PY - MX - ES - SG - SE - TH - ZA - TR - EG - GB type: string market: enum: - CHANCE - JAPAN - JUUDANKAI - ASEAN - AUSTRALIA/NEW ZEALAND - ISA - KOREA - BENELUX - BNL - CEE - DACH - FRANCE - GULF & LEVANTE - ITALY - NORDICS - SPGI - South Africa - TURKEY - UKI - BRAZIL - BENELUX - CDG - CEE - DACH - FRANCE - ITALY - MEXICO - NORDICS - SPGI - SSA - UKI - US type: string sector: enum: - noSector - CommunicationsSector - ComputerServicesIndustry - DistributionSector - FinancialServicesSector - GeneralBusinessEnterprise - IBMInternalAccount - IndustrialSector - MidMarket - MultiSector - PublicSector - TBD - PrivateSector type: string required: - geography - market - countryName - sector - industry - blueId - cdir - gbgid - isoCountryCode - cdic title: AccountCodeLocatorModel type: object AccountsModel: additionalProperties: false properties: accountCode: type: string accountCodeLocators: $ref: '#/definitions/AccountCodeLocatorModel' accountId: type: string accountName: type: string accountStatus: type: object additionalProperty: type: object allowedPriorities: items: type: number type: array ansibleInstance: type: string ansibleInstanceLog: type: object assignmentItsmServiceType: type: string assignmentService: type: string assignmentServiceType: items: type: string type: array blueid: type: string channeleventServiceType: type: string channeltype: type: string collabConfig: type: object collaborationTool: type: string collaboratorServiceType: type: string commentsEnabled: type: boolean defaultLanguage: enum: - Arabic - Bulgarian - Bengali - Catalan - Czech - Welsh - Danish - German - Greek - English - Spanish - Estonian - Finnish - French - Irish - Gujarati - Hebrew - Hindi - Croatian - Hungarian - Italian - Japanese - Korean - Lithuanian - Latvian - Malayalam - Malay - Maltese - Norwegian Bokmal - Nepali - Dutch - Polish - Portuguese - Romanian - Russian - Sinhala - Slovakian - Slovenian - Serbian - Swedish - Tamil - Telugu - Thai - Turkish - Ukrainian - Urdu - Vietnamese - Simplified Chinese - Traditional Chinese type: string directIntegEnabled: type: boolean enableAttachments: type: boolean enableCiDetails: type: boolean enableDescDetails: type: boolean enableOwner: type: string enableStackDetails: type: boolean enrollMaintenanceWindow: type: boolean enterprise: type: string eventSource: type: string feedStatus: type: string gbgid: type: string gsmaConfig: type: object isCICRInsight: type: boolean isLatestCRInsight: type: boolean itsmMSEnabled: type: boolean itsmServiceType: type: string itsmadminname: type: string itsmeadminemail: type: string maceDisabled: type: boolean owneremail: type: string ownername: type: string rbacConfig: type: object relatedInsights: type: boolean sourceSystemKeys: items: type: string type: array squadGeo: type: string statusEnabled: type: string ticketToolUsed: type: string toolInitiateComment: type: boolean watsonAssistant: type: object workspaceName: type: string required: - accountCode - accountName - accountCodeLocators title: AccountsModel type: object AccountsRequest: additionalProperties: false properties: accountCode: type: string title: AccountsRequest type: object AddReactionToMessageRequest: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array callbackUrl: description: Used only in case of Non Sync apis to return Response type: string channelId: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string name: type: string ts: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - channelId - name - ts title: AddReactionToMessageRequest type: object AddReactionToMessageSyncRequest: additionalProperties: false properties: channelId: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string name: type: string ts: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - channelId - name - ts title: AddReactionToMessageSyncRequest type: object AddResourceToChannelRequest: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array callbackUrl: description: Used only in case of Non Sync apis to return Response type: string channelId: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string resourceIds: items: type: string type: array ticketId: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - resourceIds title: AddResourceToChannelRequest type: object AddResourceToChannelSyncRequest: additionalProperties: false properties: channelId: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string resourceIds: items: type: string type: array workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - resourceIds - channelId title: AddResourceToChannelSyncRequest type: object AnsibleLaunchRequest: additionalProperties: false properties: accountCode: type: string callBack: type: object msgRequest: type: object templateId: type: string userEmail: type: string required: - msgRequest - userEmail - templateId - accountCode title: AnsibleLaunchRequest type: object AssignRoleRequest: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array callbackUrl: description: Used only in case of Non Sync apis to return Response type: string channelId: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string roles: items: $ref: '#/definitions/Role' type: array ticketId: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - ticketId - roles title: AssignRoleRequest type: object AssignRoleSyncRequest: additionalProperties: false properties: channelId: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string roles: items: $ref: '#/definitions/Role' type: array ticketId: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - ticketId - roles title: AssignRoleSyncRequest type: object AssignmentEmails: additionalProperties: false properties: email: type: string role: type: string required: - role - email title: AssignmentEmails type: object AutoUpdateTicketRequest: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array affectedSite: type: string breach_time: type: string channelid: type: string close_notes: type: string conversationId: type: string environment: type: string eventid: type: string has_breached: type: string incident_url: type: string isFetchDetailsRequired: type: boolean isMajor: type: boolean last_updated_time: type: string problem_id: type: string problem_id_url: type: string reported_priority: type: string resolver: type: string resolvetime: type: string sourceidentificationcode: type: string start_time: type: string status: type: string statusdescription: type: string ticketDetail: type: object ticketassignmentgroups: items: type: string type: array ticketdesc: type: string ticketid: type: string ticketimpact: type: string ticketpriority: type: number tickettype: type: string work_notes: type: string required: - accountCodeLocators - eventid - ticketid - environment - status title: AutoUpdateTicketRequest type: object BasicAuthModel: additionalProperties: false properties: password: type: string username: type: string title: BasicAuthModel type: object BasicCallBackInfo: additionalProperties: false properties: callbackUrl: type: string error: type: object message: type: string sourceCode: type: string required: - callbackUrl - sourceCode title: BasicCallBackInfo type: object ChannelInfoAuthenticatedRequest: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array callbackUrl: description: Used only in case of Non Sync apis to return Response type: string channelId: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string ticketId: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string title: ChannelInfoAuthenticatedRequest type: object ChannelInfoAuthenticatedSyncRequest: additionalProperties: false properties: channelId: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - channelId title: ChannelInfoAuthenticatedSyncRequest type: object ChannelInfoRequest: additionalProperties: false properties: accountCode: type: string channelid: type: string required: - accountCode - channelid title: ChannelInfoRequest type: object ChannelParams: additionalProperties: false properties: allowFutureUpdates: type: boolean assignmentEmails: items: $ref: '#/definitions/AssignmentEmails' type: array callbackUrl: type: string createTicketChannel: type: boolean title: ChannelParams type: object ChannelResourceAssignmentRequest: additionalProperties: false properties: accountCode: type: string callbackUrl: type: string channelid: type: string customKey: type: string resourceids: items: type: string type: array uniqueId: type: string required: - resourceids - channelid - accountCode title: ChannelResourceAssignmentRequest type: object ChatPlatformInfoRequest: additionalProperties: false properties: accountCode: type: string accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array callbackUrl: description: Used only in case of Non Sync apis to return Response type: string channelId: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string ticketId: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string title: ChatPlatformInfoRequest type: object ChatPlatformInfoSyncRequest: additionalProperties: false properties: accountCode: type: string channelId: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string ticketId: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string title: ChatPlatformInfoSyncRequest type: object ChatopsKnightChannelCreateRequest: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array callbackaddress: type: string channelCreateRequest: type: object environment: type: string eventid: type: string incidentassignmentgroups: items: type: string type: array incidentdesc: type: string incidentid: type: string incidentimpact: type: string incidentpriority: type: number incidenttype: type: string required: - accountCodeLocators - incidentid - incidentpriority - incidentdesc - environment title: ChatopsKnightChannelCreateRequest type: object ChatopsKnightChannelCreationEvent: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array accountcode: type: string callbackid: type: string channelCreateRequest: type: object channelExists: type: boolean channelid: type: string channelname: type: string channelurl: type: string collabTool: type: string createRequest: type: object eventid: type: string externalcallbackaddress: type: string mappedRule: type: object reAssignAssignmentUsers: type: boolean sourceidentificationcode: type: string ticketid: type: string workspaceid: type: string required: - accountCodeLocators - channelid - channelname - accountcode - workspaceid - ticketid title: ChatopsKnightChannelCreationEvent type: object ChatopsKnightRequestCreate: additionalProperties: false properties: accountCode: type: string accountCodeLocators: items: type: object type: array accountid: type: string accountname: type: string additionalProperties: type: object affectedSite: type: string assignmentEmails: items: type: object type: array blockAction: type: boolean breach_time: type: string channelCreateRequest: type: object close_notes: type: string conversationId: type: string dashboardstatus: type: string defaultassignments: items: type: string type: array environment: type: string eventid: type: string externalcallbackaddress: type: string extraProp: type: object has_breached: type: string incident_url: type: string isAccountOnboarded: type: boolean isFetchDetailsRequired: type: boolean isIncident: type: boolean isMajor: type: boolean last_updated_time: type: string notificationEmails: items: type: object type: array problem_id: type: string problem_id_url: type: string reported_priority: type: string sourceidentificationcode: type: string start_time: type: string status: type: string ticketDescriptionHash: type: string ticketassignmentgroups: items: type: string type: array ticketdesc: type: string ticketid: type: string ticketimpact: type: string ticketpriority: type: number tickettype: type: string vendorOrPMR: type: string work_notes: type: string required: - accountCode - ticketid - tickettype - ticketdesc - ticketpriority - ticketimpact - environment - accountCodeLocators title: ChatopsKnightRequestCreate type: object ChatopsKnightRequestUpdate: additionalProperties: false properties: accountCode: type: string additionalProperties: type: object affectedSite: type: string breach_time: type: string channelid: type: string close_notes: type: string conversationId: type: string dashboardstatus: type: object environment: type: string eventid: type: string has_breached: type: string incident_url: type: string isMajor: type: boolean last_updated_time: type: string owner: type: string problem_id: type: string problem_id_url: type: string reported_priority: type: string resolvername: type: string resolvetime: type: string sourceidentificationcode: type: string start_time: type: string status: type: string statusdescription: type: string ticketassignmentgroups: items: type: string type: array ticketdesc: type: string ticketid: type: string ticketimpact: type: string ticketpriority: type: number tickettype: type: string work_notes: type: string required: - accountCode - ticketid - channelid title: ChatopsKnightRequestUpdate type: object ChatopsKnightTicketChannelCreateRequest: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array additionalProperties: type: object callbackAddress: type: string channelCreateRequest: type: object environment: type: string eventId: type: string status: type: string ticketAssignmentGroups: items: type: string type: array ticketDesc: type: string ticketId: type: string ticketImpact: type: string ticketPriority: type: number ticketType: type: string required: - accountCodeLocators - ticketId - ticketPriority - ticketDesc - environment title: ChatopsKnightTicketChannelCreateRequest type: object ConversationHistoryRequest: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array callbackUrl: description: Used only in case of Non Sync apis to return Response type: string channelId: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string cursor: type: string latest: type: string limit: type: number oldest: type: string payloadAction: type: string teamId: type: string ticketId: type: string uniqueId: type: string webHookRequest: type: object workspaceName: description: 'Identifies the Workspace,(optional against )' type: string title: ConversationHistoryRequest type: object ConversationHistorySyncRequest: additionalProperties: false properties: channelId: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string cursor: type: string latest: type: string limit: type: number oldest: type: string teamId: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - channelId title: ConversationHistorySyncRequest type: object ConversationHistoryWebhookRequest: additionalProperties: false properties: callbackActionType: type: string callbackUrl: type: string channelId: type: string cursor: type: string latest: type: string limit: type: number oldest: type: string status: type: string teamsid: type: string ticketId: type: string title: type: string uniqueId: type: string webHookRequest: type: object workspaceName: type: string required: - workspaceName - channelId title: ConversationHistoryWebhookRequest type: object CreateChannelPARequestSync: additionalProperties: false properties: channelName: type: string isPrivate: type: boolean postingBot: type: string teamId: type: string required: - channelName - postingBot title: CreateChannelPARequestSync type: object CreateChannelRequest: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array callbackUrl: description: Used only in case of Non Sync apis to return Response type: string channelName: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string isPrivate: type: boolean teamId: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - channelName title: CreateChannelRequest type: object CreateChannelSyncRequest: additionalProperties: false properties: channelName: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string isPrivate: type: boolean teamId: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - channelName title: CreateChannelSyncRequest type: object CreateChannelTabSync: additionalProperties: false properties: accountCode: type: string channelId: type: string tabName: type: string required: - channelId - tabName title: CreateChannelTabSync type: object CreateConverstionChannelRequest: additionalProperties: false properties: accountCode: type: string channelName: type: string isPrivate: type: boolean required: - accountCode - channelName title: CreateConverstionChannelRequest type: object CreateGroupChatRequest: additionalProperties: false properties: accountCode: type: string emailId: items: type: string type: array groupName: type: string message: type: object workspaceName: type: string required: - emailId - message - groupName title: CreateGroupChatRequest type: object CreateGroupConversationPARequestSync: additionalProperties: false properties: emailId: type: string groupName: type: string postingBot: type: string required: - emailId - groupName - postingBot title: CreateGroupConversationPARequestSync type: object CreateGroupConversationRequest: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array callbackUrl: description: Used only in case of Non Sync apis to return Response type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string emailId: items: type: string type: array groupName: type: string message: type: object workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - emailId - message title: CreateGroupConversationRequest type: object CreateGroupConversationRequestSync: additionalProperties: false properties: collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string emailId: items: type: string type: array groupName: type: string message: type: object workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - emailId - message title: CreateGroupConversationRequestSync type: object CrtGrpConvWithChannelDetPARequestSync: additionalProperties: false properties: accountName: type: string channelName: type: string customParam: type: object emailId: type: string message: type: string ouId: type: string postingBot: type: string requestType: type: string transactionid: type: string required: - emailId - channelName - message - postingBot - requestType title: CrtGrpConvWithChannelDetPARequestSync type: object DefaultIndexChannelModel: additionalProperties: false properties: channel: type: string rule: type: string workspaceName: type: string required: - channel - rule - workspaceName title: DefaultIndexChannelModel type: object DeleteMessageFromChannelRequest: additionalProperties: false properties: callbackUrl: type: string channelid: type: string ts: type: string uniqueId: type: string workspaceName: type: string required: - channelid - ts - workspaceName title: DeleteMessageFromChannelRequest type: object DeleteMessageInChannelRequest: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array callbackUrl: description: Used only in case of Non Sync apis to return Response type: string channelId: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string ts: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - channelId - ts title: DeleteMessageInChannelRequest type: object DeleteMessageInChannelSyncRequest: additionalProperties: false properties: channelId: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string ts: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - channelId - ts title: DeleteMessageInChannelSyncRequest type: object DirectIntegrationRequest: additionalProperties: false properties: accountCode: type: string currentData: type: object previousData: type: object ticketId: type: string ticketType: type: string required: - accountCode - ticketId - previousData title: DirectIntegrationRequest type: object FileUploadRequest: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array callbackUrl: description: Used only in case of Non Sync apis to return Response type: string channels: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string initial_comment: type: string thread_ts: type: string title: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string title: FileUploadRequest type: object FileUploadRequestSync: additionalProperties: false properties: channels: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string initial_comment: type: string thread_ts: type: string title: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string title: FileUploadRequestSync type: object FilterTicketParameter: additionalProperties: false properties: isMajor: type: boolean ticketPriority: type: number title: FilterTicketParameter type: object GetAccountsListRequest: additionalProperties: false properties: limit: type: number page: type: number platformType: type: string required: - page - limit title: GetAccountsListRequest type: object GetChannelInactiveTimeRequest: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array callbackUrl: description: Used only in case of Non Sync apis to return Response type: string channelId: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string ticketId: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string title: GetChannelInactiveTimeRequest type: object GetChannelInactiveTimeSyncRequest: additionalProperties: false properties: channelId: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - channelId title: GetChannelInactiveTimeSyncRequest type: object GetConvInfoAuthenticatedRequest: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array callbackUrl: description: Used only in case of Non Sync apis to return Response type: string channelId: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string ticketId: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string title: GetConvInfoAuthenticatedRequest type: object GetConvInfoAuthenticatedSyncRequest: additionalProperties: false properties: channelId: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - channelId title: GetConvInfoAuthenticatedSyncRequest type: object GetICDChangeRequestsSync: additionalProperties: false properties: accountCode: type: string conversationId: type: string serverNames: type: string tlrange: type: string required: - conversationId title: GetICDChangeRequestsSync type: object GetMessageReactionInChannelRequest: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array callbackUrl: description: Used only in case of Non Sync apis to return Response type: string channelId: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string ts: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - channelId - ts title: GetMessageReactionInChannelRequest type: object GetMessageReactionInChannelSyncRequest: additionalProperties: false properties: channelId: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string ts: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - channelId - ts title: GetMessageReactionInChannelSyncRequest type: object GetOpenticketsForAccountRequest: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array filterParameters: $ref: '#/definitions/FilterTicketParameter' required: - accountCodeLocators title: GetOpenticketsForAccountRequest type: object GetOpenticketsForAccountRequestAsync: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array callbackUrl: type: string filterParameters: $ref: '#/definitions/FilterTicketParameter' required: - accountCodeLocators title: GetOpenticketsForAccountRequestAsync type: object GetRolesRequest: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array callbackUrl: description: Used only in case of Non Sync apis to return Response type: string channelId: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string ticketId: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - ticketId title: GetRolesRequest type: object GetRolesSyncRequest: additionalProperties: false properties: channelId: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string ticketId: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - ticketId title: GetRolesSyncRequest type: object GetSubSkillDetailsRequest: additionalProperties: false properties: accountCode: type: string intent: type: string subIntent: type: string workspaceName: type: string required: - accountCode - intent - subIntent title: GetSubSkillDetailsRequest type: object GetUserProfileLinkRequest: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array callbackUrl: description: Used only in case of Non Sync apis to return Response type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string emailId: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - emailId title: GetUserProfileLinkRequest type: object GetUserProfileLinkRequestSync: additionalProperties: false properties: collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string emailId: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - emailId title: GetUserProfileLinkRequestSync type: object GroupMembersAuthenticatedRequest: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array callbackUrl: description: Used only in case of Non Sync apis to return Response type: string channelId: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string title: GroupMembersAuthenticatedRequest type: object IncidentAction: additionalProperties: false properties: action: type: string imDocument: type: object mappedRule: type: object step: type: string required: - imDocument - action - step title: IncidentAction type: object IncidentMappingModel: additionalProperties: false properties: assignmentServiceToAssignResource: type: string assignmentServiceType: items: type: string type: array assignments: type: object chatPlatform: type: string defaultassignments: items: type: string type: array defaultindexchannels: items: $ref: '#/definitions/DefaultIndexChannelModel' type: array extAssignments: items: type: string type: array externalAssignment: type: string gnmAccName: type: string gnmAssignments: type: string gnmMapFields: items: type: string type: array gnmMapping: type: string groupAssignment: type: string isSummaryChannel: type: boolean mapName: type: string pagerDutyAPIKey: type: string pagerDutyAssignments: type: string removedAssigments: items: type: string type: array rules: type: string summaryChannel: items: type: object type: array teamsChatType: type: string ticketType: type: string useCurrentDateForMeeting: type: boolean workspace: type: string required: - mapName title: IncidentMappingModel type: object IncidentProcessCompletion: additionalProperties: false properties: action: type: string imDocument: type: object mappedRule: type: object processInsights: type: object step: type: string required: - action title: IncidentProcessCompletion type: object InformationParams: additionalProperties: false properties: additionalInfo: type: string message: type: object notificationEmails: items: $ref: '#/definitions/NotificationEmails' type: array reportingSystemName: type: string reportingSystemURL: type: string threadPayload: type: object ts: type: string title: InformationParams type: object InviteUserToChannelRequest: additionalProperties: false properties: accountCode: type: string channelid: type: string userid: type: string required: - accountCode - channelid - userid title: InviteUserToChannelRequest type: object MetricsData: additionalProperties: false properties: projectData: items: type: object type: array projectName: type: string required: - projectName title: MetricsData type: object NotificationEmails: additionalProperties: false properties: email: type: string required: - email title: NotificationEmails type: object OperationalTaskCacheData: additionalProperties: false properties: adaptiveCardJson: type: object group: type: string region: type: string replyToid: type: string uuid: type: string weekday: type: string required: - region - uuid - group - replyToid - weekday title: OperationalTaskCacheData type: object OperationalTaskData: additionalProperties: false properties: operationalTasks: items: type: object type: array region: type: string required: - region title: OperationalTaskData type: object PassThroughRequest: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array passThroughCallback: $ref: '#/definitions/PassthroughCallback' passThroughRequest: $ref: '#/definitions/PassthroughRequest' required: - passThroughRequest - passThroughCallback title: PassThroughRequest type: object PassThroughSyncRequest: additionalProperties: false properties: accountCode: type: string isSync: type: boolean method: type: string passThroughHeaders: type: object passThroughPayload: type: object requestType: type: string uri: type: string required: - method - uri - requestType - passThroughHeaders - passThroughPayload title: PassThroughSyncRequest type: object PassthroughCallback: additionalProperties: false properties: callbackHeaders: type: object callbackUrl: type: string method: type: string returnData: type: object required: - returnData - callbackUrl title: PassthroughCallback type: object PassthroughRequest: additionalProperties: false properties: method: type: string passThroughHeaders: type: object passThroughPayload: type: object requestType: type: string uri: type: string required: - method - uri - requestType - passThroughHeaders - passThroughPayload title: PassthroughRequest type: object PinMessageInChannelRequest: additionalProperties: false properties: accountCode: type: string channelid: type: string timestamp: type: string ts: type: string workspaceName: type: string required: - accountCode - channelid - timestamp title: PinMessageInChannelRequest type: object PinMessageRequest: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array callbackUrl: description: Used only in case of Non Sync apis to return Response type: string channelId: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string ticketId: type: string ts: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - ts title: PinMessageRequest type: object PinMessageSyncRequest: additionalProperties: false properties: channelId: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string ts: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - channelId - ts title: PinMessageSyncRequest type: object PingResponse: properties: date: type: string greeting: type: string headers: additionalProperties: true properties: Content-Type: type: string type: object url: type: string title: PingResponse type: object PostMessageOldRequest: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array callbackUrl: description: Used only in case of Non Sync apis to return Response type: string channelid: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string isUpdate: type: boolean message: type: object ts: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - message - channelid title: PostMessageOldRequest type: object PostMessageRequest: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array actions: type: object callbackUrl: description: Used only in case of Non Sync apis to return Response type: string channelId: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string isUpdate: type: boolean language: type: string message: type: object ticketId: type: string ts: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - message title: PostMessageRequest type: object PostMessageSyncRequest: additionalProperties: false properties: actions: type: object channelId: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string isUpdate: type: boolean language: type: string message: type: object ts: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - message - channelId title: PostMessageSyncRequest type: object PostMessageTemplateRequest: additionalProperties: false properties: accountCode: type: string channelId: type: string data: type: object templateType: type: string ts: type: string workspaceName: type: string required: - data - channelId - templateType - ts title: PostMessageTemplateRequest type: object PostMessageToUserRequest: additionalProperties: false properties: accountCode: type: string callbackActionType: type: string emailId: type: string feature: type: string isSync: type: boolean language: type: string message: type: object priority: type: string workspaceName: type: string required: - message - emailId title: PostMessageToUserRequest type: object PostMessageToUsersRequest: additionalProperties: false properties: emailId: items: type: string type: array feature: type: string language: type: string message: type: object priority: type: string ts: type: string workspaceName: type: string required: - emailId - message title: PostMessageToUsersRequest type: object PostMessageUserRequest: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array callbackUrl: description: Used only in case of Non Sync apis to return Response type: string channelId: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string emailId: type: string text: type: string ticketId: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - text - emailId title: PostMessageUserRequest type: object PostMessageUserSyncRequest: additionalProperties: false properties: channelId: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string emailId: type: string text: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - text - emailId - channelId title: PostMessageUserSyncRequest type: object PostMessageWithTemplateRequest: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array callbackUrl: description: Used only in case of Non Sync apis to return Response type: string channelId: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string data: type: object templateType: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - data - templateType title: PostMessageWithTemplateRequest type: object PostOnboardAccountRequest: additionalProperties: false properties: Accounts: $ref: '#/definitions/AccountsModel' IncidentMapping: $ref: '#/definitions/IncidentMappingModel' ServiceManager: $ref: '#/definitions/ServiceManagerModel' SourceSystems: $ref: '#/definitions/SourceSystemModel' TicketingTool: $ref: '#/definitions/TicketingToolModel' Vault: type: object Workspace: $ref: '#/definitions/WorkspaceModel' required: - Accounts - SourceSystems - IncidentMapping - TicketingTool title: PostOnboardAccountRequest type: object ProcessCommandRequest: additionalProperties: false properties: parameters: type: object accountCode: type: string msgRequest: type: object required: - accountCode - msgRequest - parameters title: ProcessCommandRequest type: object ReceiveChannelCreationEvent: additionalProperties: false properties: error: type: object payload: $ref: '#/definitions/ChatopsKnightChannelCreationEvent' status: type: boolean required: - status title: ReceiveChannelCreationEvent type: object RequestFilter: additionalProperties: false properties: filter: type: string title: RequestFilter type: object Role: additionalProperties: false properties: roleName: enum: - INC Commander - DPE - Practitioner type: string users: items: type: string type: array required: - roleName - users title: Role type: object RulesTicketRequest: additionalProperties: false properties: accountCode: type: string chatopsKnightRequest: type: object ticketDetail: type: object required: - accountCode - chatopsKnightRequest - ticketDetail title: RulesTicketRequest type: object SendDirectMessageToUser: additionalProperties: false properties: actions: type: object collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string emailId: type: string feature: type: string isUpdate: type: boolean language: type: string message: type: object priority: type: string ts: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - emailId - message title: SendDirectMessageToUser type: object SendDirectMessageToUserRequest: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array actions: type: object callbackUrl: description: Used only in case of Non Sync apis to return Response type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string emailId: type: string feature: type: string isUpdate: type: boolean language: type: string message: type: object priority: type: string ts: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - emailId - message title: SendDirectMessageToUserRequest type: object SendDirectMessageToUsers: additionalProperties: false properties: collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string emailId: items: type: string type: array feature: type: string language: type: string message: type: object priority: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - emailId - message title: SendDirectMessageToUsers type: object SendDirectMessageToUsersRequest: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array callbackUrl: description: Used only in case of Non Sync apis to return Response type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string emailId: items: type: string type: array feature: type: string language: type: string message: type: object priority: type: string ts: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - emailId - message title: SendDirectMessageToUsersRequest type: object SendEmailRequestSync: additionalProperties: false properties: accountCode: type: string cc: items: pattern: >- ^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ type: string type: array emailBody: type: string from: type: string subject: type: string to: items: pattern: >- ^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ type: string type: array required: - from - to - cc - subject - emailBody title: SendEmailRequestSync type: object SendMessageToResponseURLRequest: additionalProperties: false properties: accountCode: type: string message: type: object url: type: string required: - accountCode - message - url title: SendMessageToResponseURLRequest type: object SendMessagesRequest: additionalProperties: false properties: accountCode: type: string channelId: type: string emailId: type: string text: type: string required: - text - emailId title: SendMessagesRequest type: object SendUpdateMessageRequest: additionalProperties: false properties: accountCode: type: string actions: type: object callbackActionType: type: string callbackUrl: type: string channelAutoCreate: type: boolean channelName: type: string channelid: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' enum: - SLACK - TEAMS - slack - teams type: string feature: type: string isPrivate: type: boolean isUpdate: type: boolean language: type: string limit: type: number message: type: object payloadKeyValue: type: string priority: type: string serviceChannelName: type: string status: type: string title: type: string ts: type: string uniqueId: type: string webHookRequest: type: object workspaceName: type: string required: - message - channelid - ts title: SendUpdateMessageRequest type: object ServiceManagerModel: additionalProperties: false properties: assignmentGroup: type: string breachTime: type: string breachTimeUnit: type: string breachType: type: string channelId: type: string enableOwnerNotification: type: boolean groupName: type: string incidentChannelEnabled: type: boolean isRuleEnabled: type: boolean lastJobRun: type: string priority: type: string queryParameters: items: type: string type: array sla: type: string slaUnit: type: string table: type: string ticketStates: items: type: object type: array userEmail: type: string title: ServiceManagerModel type: object SetChannelPurpouseRequest: additionalProperties: false properties: accountCode: type: string channelid: type: string purpose: type: string required: - accountCode - purpose - channelid title: SetChannelPurpouseRequest type: object SetPurposeAuthenticatedRequest: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array callbackUrl: description: Used only in case of Non Sync apis to return Response type: string channelId: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string purpose: maxLength: 250 minLength: 0 type: string ticketId: type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - purpose title: SetPurposeAuthenticatedRequest type: object SetPurposeAuthenticatedSyncRequest: additionalProperties: false properties: channelId: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string purpose: maxLength: 250 minLength: 0 type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - purpose - channelId title: SetPurposeAuthenticatedSyncRequest type: object SetTopicAuthenticatedRequest: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array callbackUrl: description: Used only in case of Non Sync apis to return Response type: string channelId: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string ticketId: type: string topic: maxLength: 250 minLength: 0 type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - topic title: SetTopicAuthenticatedRequest type: object SetTopicAuthenticatedSyncRequest: additionalProperties: false properties: channelId: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string topic: maxLength: 250 minLength: 0 type: string workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - topic - channelId title: SetTopicAuthenticatedSyncRequest type: object ShowView: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array callbackId: type: string callbackUrl: description: Used only in case of Non Sync apis to return Response type: string channelId: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' type: string triggerId: type: string view: type: object workspaceName: description: 'Identifies the Workspace,(optional against )' type: string required: - view - channelId - callbackId - triggerId title: ShowView type: object ShowViewRequest: additionalProperties: false properties: accountCode: type: string callbackId: type: string channelId: type: string triggerId: type: string view: type: object workspaceName: type: string required: - view - channelId - triggerId - callbackId title: ShowViewRequest type: object SourceSystemModel: additionalProperties: false properties: SourceAPIKey: type: string SourceDescription: type: string additionalProperties: items: type: string type: array keySpecifications: type: object keys: type: object oldAuthSystem: type: boolean required: - SourceAPIKey - SourceDescription title: SourceSystemModel type: object TextMessageRequest: additionalProperties: false properties: email: type: string feature: type: string groupId: type: string message: type: string postType: type: string postingBot: type: string priority: type: string ts: type: string required: - postType - message - postingBot title: TextMessageRequest type: object TicketParams: additionalProperties: false properties: dashboardstatus: type: object environment: type: string resolvername: type: string resolvetime: type: string status: type: string statusdescription: type: string ticketassignmentgroups: items: type: string type: array ticketdesc: type: string ticketid: type: string ticketimpact: type: string ticketpriority: type: number tickettype: type: string required: - ticketid title: TicketParams type: object TicketRequestDetail: additionalProperties: false properties: accountCodeLocators: items: type: object type: array additionalProperties: type: object assignments: items: type: string type: array autoIndexChannelCreation: type: boolean callbackUrl: type: string channelConfig: $ref: '#/definitions/ChannelParams' information: $ref: '#/definitions/InformationParams' isAccountOnboarded: type: boolean routedFrom: type: string ticket: $ref: '#/definitions/TicketParams' required: - ticket title: TicketRequestDetail type: object TicketingToolModel: additionalProperties: false properties: ApiKeyDetails: type: object Ticket_Channel_Assigned_Message: type: string authType: type: string basicAuth: $ref: '#/definitions/BasicAuthModel' businessRulesData: type: object changeRequest: type: object csmEnabled: type: boolean customItsmFlowEnabled: type: boolean defaultEnabled: type: boolean defaultImpact: type: string dropletEnabled: type: boolean enableServiceManager: type: boolean instanceUrl: type: string isStatusValueAsNumber: type: boolean msStatusValues: type: object msTicketUpdateRules: type: object newAccount: type: boolean oauth2Auth: type: object passwordExpDate: type: string refresh_token: type: object rules: type: string ticketingConfigurations: type: object updateChannelRules: type: string update_itsm_dashboard_field: items: type: object type: array title: TicketingToolModel type: object UpdateChatOpsIncidentEventRequest: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array channelid: type: string environment: type: string eventid: type: string incidentassignmentgroups: items: type: string type: array incidentdesc: type: string incidentid: type: string incidentimpact: type: string incidentpriority: type: number incidenttype: type: string status: type: string statusdescription: type: string required: - accountCodeLocators - eventid - incidentid - incidenttype - incidentpriority - incidentdesc - environment - incidentassignmentgroups - status - statusdescription - channelid title: UpdateChatOpsIncidentEventRequest type: object UpdateIncidentRequest: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array channelid: type: string environment: type: string eventid: type: string incidentDetail: type: object incidentassignmentgroups: items: type: string type: array incidentdesc: type: string incidentid: type: string incidentimpact: type: string incidentpriority: type: number incidenttype: type: string isFetchDetailsRequired: type: boolean resolver: type: string resolvetime: type: string status: type: string statusdescription: type: string required: - accountCodeLocators - eventid - incidentid - incidentpriority - incidentdesc - environment - status - statusdescription title: UpdateIncidentRequest type: object UpdateOnboardAccountRequestPayload: additionalProperties: false properties: Accounts: $ref: '#/definitions/AccountsModel' IncidentMapping: $ref: '#/definitions/IncidentMappingModel' ServiceManager: $ref: '#/definitions/ServiceManagerModel' SourceSystems: $ref: '#/definitions/SourceSystemModel' TicketingTool: $ref: '#/definitions/TicketingToolModel' Vault: type: object Workspace: $ref: '#/definitions/WorkspaceModel' accountCode: type: string required: - accountCode title: UpdateOnboardAccountRequestPayload type: object UpdateTicketInChannelRequest: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array additionalProperties: type: object assignments: items: type: string type: array callbackUrl: type: string channelConfig: $ref: '#/definitions/ChannelParams' information: $ref: '#/definitions/InformationParams' ticket: $ref: '#/definitions/TicketParams' required: - ticket title: UpdateTicketInChannelRequest type: object UpdateTicketReq: additionalProperties: false properties: accountCode: type: string locators: type: object ticketReq: $ref: '#/definitions/TicketRequestDetail' required: - ticketReq title: UpdateTicketReq type: object UpdateTicketRequest: additionalProperties: false properties: accountCodeLocators: items: $ref: '#/definitions/AccountCodeLocator' type: array channelId: type: string conversationId: type: string environment: type: string eventId: type: string isFetchDetailsRequired: type: boolean resolveTime: type: string resolver: type: string sourceIdentificationCode: type: string status: type: string statusDescription: type: string ticketAssignmentGroups: items: type: string type: array ticketDesc: type: string ticketDetail: type: object ticketId: type: string ticketImpact: type: string ticketPriority: type: number ticketType: type: string required: - accountCodeLocators - eventId - ticketId - environment - status title: UpdateTicketRequest type: object UserInfoRequest: additionalProperties: false properties: accountCode: type: string collabPlatform: description: 'Collaboration Platorm, supported values [SLACK,TEAMS]' enum: - SLACK - TEAMS - slack - teams type: string userid: type: string required: - accountCode - userid title: UserInfoRequest type: object WorkspaceModel: additionalProperties: false properties: accountType: type: string bot: type: object isService: type: boolean name: type: string region: enum: - NA - EU - AP - IN type: string team: $ref: '#/definitions/WorkspaceTeamModel' workspaceType: enum: - TEAMS type: string required: - name title: WorkspaceModel type: object WorkspaceResourceAssignmentRequest: additionalProperties: false properties: accountCode: type: string callbackUrl: type: string customKey: type: string resourceids: items: type: string type: array uniqueId: type: string workspaceid: type: string required: - resourceids - workspaceid - accountCode title: WorkspaceResourceAssignmentRequest type: object WorkspaceTeamModel: additionalProperties: false properties: id: type: string name: type: string title: WorkspaceTeamModel type: object x-components: {}