@itentialopensource/adapter-service_desk_plus/report/adapter-openapi.yaml

This adapter integrates with system described as: service_desk_plus.

openapi: 3.0.0
info:
  title: service_desk_plus
  description: >-
    REST API for Service Desk Plus by ManageEngine.

    Maintained by Itential LLC
  contact:
    name: Itential LLC
    url: https://www.itential.com/products/adapters-library/
    email: info@itential.com
  version: '0.0.1'
servers:
- url: https://{defaultHost}
  variables:
    defaultHost:
      default: www.example.com
paths:
  /api/v3/requests:
    get:
      tags:
      - request
      summary: getRequests
      description: Retrieve Requests
      operationId: getRequests
      parameters: []
      responses:
        '200':
          description: success
          headers: {}
          content:
            application/json:
              schema:
                type: object
      deprecated: false
    post:
      tags:
      - request
      summary: postAddRequest
      description: >-
        This operation helps you to add new requests.

        https://ui.servicedeskplus.com/APIDocs3/index.html#add-request
      operationId: postAddRequest
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: object
        required: true
      responses:
        '200':
          description: success creating a new Request
          headers: {}
          content:
            application/json:
              schema:
                type: object
      deprecated: false
  /api/v3/requests/{request_id}:
    get:
      tags:
      - request
      summary: getRequestById
      description: Retrieve Specific Request
      operationId: getRequestById
      parameters:
      - name: request_id
        in: path
        description: Id of this request
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: success
          headers: {}
          content:
            application/json:
              schema:
                type: object
      deprecated: false
    put:
      tags:
      - request
      summary: putUpdateRequest
      description: >-
        This operation helps you to update the request by using the unique request_id

        https://ui.servicedeskplus.com/APIDocs3/index.html#update-request
      operationId: putUpdateRequest
      parameters:
      - name: request_id
        in: path
        description: Id of this request
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: object
        required: true
      responses:
        '200':
          description: '"status": "success"'
          headers: {}
          content:
            application/json:
              schema:
                type: object
      deprecated: false
  /api/v3/requests/{request_id}/summary:
    get:
      tags:
      - request
      summary: getRequestSummary
      description: Retrieve Request Summary
      operationId: getRequestSummary
      parameters:
      - name: request_id
        in: path
        description: Id of this request
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: success
          headers: {}
          content:
            application/json:
              schema:
                type: object
      deprecated: false
  /api/v3/requests/{request_id}/project:
    post:
      tags:
      - request
      summary: postAssociateProjectToRequest
      description: >-
        This operation lets you attach a Project to a Request

        https://ui.servicedeskplus.com/APIDocs3/index.html#associate-project
      operationId: postAssociateProjectToRequest
      parameters:
      - name: request_id
        in: path
        description: Id of this request
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: object
        required: true
      responses:
        '200':
          description: '"status": "success"'
          headers: {}
          content:
            application/json:
              schema:
                type: object
      deprecated: false
  /api/v3/requests/{request_id}/resolutions:
    get:
      tags:
      - request
      summary: getResolutionsFromRequest
      description: Retrieve Resolutions on Request
      operationId: getResolutionsFromRequest
      parameters:
      - name: request_id
        in: path
        description: Id of this request
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: success
          headers: {}
          content:
            application/json:
              schema:
                type: object
      deprecated: false
    post:
      tags:
      - request
      summary: postAddResolution
      description: >-
        This Operation allows you to add/update a resolution of the request.

        https://ui.servicedeskplus.com/APIDocs3/index.html#add-resolution
      operationId: postAddResolution
      parameters:
      - name: request_id
        in: path
        description: Id of this request
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: object
        required: true
      responses:
        '200':
          description: warning
          headers: {}
          content:
            application/json:
              schema:
                type: object
      deprecated: false
  /api/v3/requests/{request_id}/assign:
    put:
      tags:
      - request
      summary: assignRequest
      description: Assign Request
      operationId: assignRequest
      parameters:
      - name: request_id
        in: path
        description: Id of this request
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: object
        required: true
      responses:
        '200':
          description: success
          headers: {}
          content:
            application/json:
              schema:
                type: object
      deprecated: false
  /api/v3/requests/{request_id}/close:
    put:
      tags:
      - request
      summary: closeRequest
      description: Close Request
      operationId: closeRequest
      parameters:
      - name: request_id
        in: path
        description: Id of this request
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: object
        required: true
      responses:
        '200':
          description: success
          headers: {}
          content:
            application/json:
              schema:
                type: object
      deprecated: false
  /api/v3/requests/{request_id}/problem:
    get:
      tags:
      - problem
      summary: getProblemsFromRequest
      description: Retrieve Problems on Request
      operationId: getProblemsFromRequest
      parameters:
      - name: request_id
        in: path
        description: Id of this request
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: success
          headers: {}
          content:
            application/json:
              schema:
                type: object
      deprecated: false
    post:
      tags:
      - problem
      summary: associateProblemWithRequest
      description: Associate problem with Request
      operationId: associateProblemWithRequest
      parameters:
      - name: request_id
        in: path
        description: Id of this request
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: object
        required: true
      responses:
        '200':
          description: success
          headers: {}
          content:
            application/json:
              schema:
                type: object
      deprecated: false
    delete:
      tags:
      - problem
      summary: dissociateProblemWithRequest
      description: Dissociate problem with Request
      operationId: dissociateProblemWithRequest
      parameters:
      - name: request_id
        in: path
        description: Id of this request
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          enum:
          - application/json
          type: string
      responses:
        '200':
          description: success
          headers: {}
          content:
            application/json:
              schema:
                type: object
      deprecated: false
  /sdpapi/change:
    get:
      tags:
      - change
      summary: getChanges
      description: Retrieve Changes
      operationId: getChanges
      parameters: []
      responses:
        '200':
          description: success
          headers: {}
          content:
            application/json:
              schema:
                type: object
      deprecated: false
    post:
      tags:
      - change
      summary: createChange
      description: Create a Change
      operationId: createChange
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: object
        required: true
      responses:
        '200':
          description: success
          headers: {}
          content:
            application/json:
              schema:
                type: object
      deprecated: false
  /api/v3/requests/{change_id}:
    get:
      tags:
      - change
      summary: getChangeById
      description: Retrieve Specific Change
      operationId: getChangeById
      parameters:
      - name: change_id
        in: path
        description: Id of this change
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: success
          headers: {}
          content:
            application/json:
              schema:
                type: object
      deprecated: false
    put:
      tags:
      - change
      summary: updateChange
      description: Update a Change
      operationId: updateChange
      parameters:
      - name: change_id
        in: path
        description: Id of this change
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: object
        required: true
      responses:
        '200':
          description: success
          headers: {}
          content:
            application/json:
              schema:
                type: object
      deprecated: false
tags:
- name: request
  description: ''
- name: problem
  description: ''
- name: change
  description: ''