ServiceChannel Attachments API

The Attachments API from ServiceChannel — 28 operation(s) for attachments.

OpenAPI Specification

servicechannel-attachments-api-openapi.yml Raw ↑
swagger: '2.0'
info:
  version: bearer.v1
  title: Fixxbook.Bearer.Api.V1 AfterHours Attachments API
  isOdataApi: false
  relativePath: ''
  discoveryPath: docs/bearer.v1
  _isAuthorizedAccess: true
host: sb2fixxbook.servicechannel.com:443
basePath: /api
schemes:
- https
security:
- oauth2: []
tags:
- name: Attachments
paths:
  /workorders/{workorderId}/notes/{noteId}/attachments:
    post:
      tags:
      - Attachments
      summary: Add Attachments to Work Order Note
      description: <para>Add Attachments to Work Order Note. Returns list of attachments Id for successful request.</para>
      operationId: POSTv3_workorders_{workorderId}_notes_{noteId}_attachments
      consumes:
      - multipart/form-data
      produces:
      - application/json
      - text/json
      parameters:
      - name: workorderId
        in: path
        description: Numeric Id of the Work order to perform action with.
        required: true
        type: integer
        format: int32
      - name: noteId
        in: path
        description: Numeric Id of the Note to perform action with.
        required: true
        type: integer
        format: int64
      - name: AddAttachmentsRequest
        in: formData
        description: Optional Descriptor for file(s)
        required: false
        schema:
          type: array
          items:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.Attachments.AddAttachmentRequest'
        type: application/json
      - name: file
        in: formData
        description: File to attach to note
        required: true
        type: file
      responses:
        '201':
          description: Created indicates that the request resulted in a new resource created before the response was sent.
        '400':
          description: "Bad Request - the request could not be understood or was missing required parameters.\r\n            <br/>Error codes:\r\n            <br/> 503 - Validation fails;\r\n            <br/> 917 - InvalidWoIdentifier;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "Indicates that the requested resource requires authentication.\r\n            <br/>Error codes:\r\n            <br/> 504 - API call rejected by security permissions;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: Indicates that a generic error has occurred on the server.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Any
  /rfps/{id}/attachments:
    post:
      tags:
      - Attachments
      summary: Add attchment to RFP
      description: <para>Adds attchment to RFP. Returns RFP attachment Id for successful request.</para>
      operationId: POSTv3_rfps_{id}_attachments
      consumes:
      - multipart/form-data
      produces:
      - application/json
      - text/json
      parameters:
      - name: id
        in: path
        description: Rfp ID to perform action with.
        required: true
        type: integer
        format: int32
      - name: file
        in: formData
        description: File to attach to RFP
        required: true
        type: file
      responses:
        '201':
          description: Created indicates that the request resulted in a new resource created before the response was sent.
        '400':
          description: "Bad Request - the request could not be understood or was missing required parameters.\r\n            <br/>Error codes:\r\n            <br/> 501 - Failed to upload attachment;\r\n            <br/> 502 - Data not found. Returned if target Rfp is not found;\r\n            <br/> 503 - Request data is empty;\r\n            <br/>Invalid Attachment Request;\r\n            <br/>User info should not be null;\r\n            <br/>SubscriberId is null;\r\n            <br/>Cannot accept file(s) of this type;\r\n            <br/>The file that you're trying to attach has name that exceed the maximum allowable name length;\r\n            <br/>The file that you're trying to attach has length that exceed the maximum allowable length;\r\n            <br/>Empty Location or Store ID;\r\n            <br/>Empty Provider ID;\r\n            <br/>Provider is not valid;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "Indicates that the requested resource requires authentication.\r\n            <br/>Error codes:\r\n            <br/> 504 - API call rejected by security permissions;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: Indicates that a generic error has occurred on the server.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Subscribers
  /siteaudit/comments/{commentId}/attachments:
    get:
      tags:
      - Attachments
      summary: Returns list of attachment ids and urls.
      operationId: GETv3_siteaudit_comments_{commentId}_attachments
      consumes: []
      produces:
      - application/json
      - text/json
      parameters:
      - name: commentId
        in: path
        description: Numeric Id of the Comment which Attachment belongs to.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: Request succeeded and the requested information is in the response.
          schema:
            type: array
            items:
              $ref: '#/definitions/ServiceChannel.Api.Model.SiteAudit.AttachmentInComment'
        '400':
          description: "Bad Request - the request could not be executed or was missing required parameters.\r\n            <br/>Error codes:\r\n            <br/> 503 - validation fails;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "Unauthorized indicates that the requested resource requires authentication.\r\n            <br/>Error codes:\r\n            <br/> 504 - API call rejected by security permissions;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '404':
          description: "The requested resource does not exist on the server.\r\n            <br/>Error codes:\r\n            502 — Data not found"
      deprecated: false
      x-access: Any
    post:
      tags:
      - Attachments
      summary: Add attchment to Comment
      description: Adds attchment to Comment. If Comment is not created yet specify {commentId} = -1.
      operationId: POSTv3_siteaudit_comments_{commentId}_attachments
      consumes:
      - multipart/form-data
      produces:
      - application/json
      - text/json
      parameters:
      - name: commentId
        in: path
        description: Numeric Id of the Comment to perform action with.
        required: true
        type: integer
        format: int32
      - name: file
        in: formData
        description: File to attach to Comment
        required: true
        type: file
      responses:
        '201':
          description: Created indicates that the request resulted in a new resource created before the response was sent.
        '400':
          description: "Bad Request - the request could not be understood or was missing required parameters.\r\n            <br/>Error codes:\r\n            <br/> 501 - Failed to upload attachment;\r\n            <br/> 502 - Data not found. Returned if target Comment is not found;\r\n            <br/> 503 - Request data is empty;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "Indicates that the requested resource requires authentication.\r\n            <br/>Error codes:\r\n            <br/> 504 - API call rejected by security permissions;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: Indicates that a generic error has occurred on the server.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Any
  /siteaudit/comments/{commentId}/attachments/{attachmentId}:
    get:
      tags:
      - Attachments
      summary: Retrieve original attchment from Comment
      operationId: GETv3_siteaudit_comments_{commentId}_attachments_{attachmentId}
      consumes: []
      produces:
      - application/json
      - text/json
      parameters:
      - name: commentId
        in: path
        description: Numeric Id of the Comment which Attachment belongs to.
        required: true
        type: integer
        format: int32
      - name: attachmentId
        in: path
        description: Numeric Id of the Attachment to perform action with.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/System.Object'
      deprecated: false
      x-access: Any
  /siteaudit/comments/{commentId}/attachments/{attachmentId}/thumbnail:
    get:
      tags:
      - Attachments
      summary: Retrieve resized attchment from Comment
      operationId: GETv3_siteaudit_comments_{commentId}_attachments_{attachmentId}_thumbnail?width={width}&height={height}&mode={mode}&imageFormat={imageFormat}
      consumes: []
      produces:
      - application/json
      - text/json
      parameters:
      - name: commentId
        in: path
        description: Numeric Id of the Comment which Attachment belongs to.
        required: true
        type: integer
        format: int32
      - name: attachmentId
        in: path
        description: Numeric Id of the Attachment to perform action with.
        required: true
        type: integer
        format: int32
      - name: width
        in: query
        description: Width of the output file.
        required: false
        type: integer
        format: int32
      - name: height
        in: query
        description: Height of the output file.
        required: false
        type: integer
        format: int32
      - name: mode
        in: query
        description: "How to resolve aspect ratio differences between the requested size and the \r\n            original image's size: Max = 1, Pad = 2, Crop = 3, Carve = 4, Stretch = 5."
        required: false
        type: string
        enum:
        - None
        - Max
        - Pad
        - Crop
        - Carve
        - Stretch
      - name: imageFormat
        in: query
        description: "The desired image format, like 'jpg', 'gif', or 'png'. Do not specify \r\n            if you want to preserve the original format."
        required: false
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/System.Object'
      deprecated: false
      x-access: Any
  /assets/{assetId}/attachments:
    get:
      tags:
      - Attachments
      summary: Get Asset Attachments
      description: ''
      operationId: GETv3_assets_{assetId}_attachments?providerId={providerId}
      consumes: []
      produces:
      - application/json
      - text/json
      parameters:
      - name: assetId
        in: path
        description: Asset Identifier
        required: true
        type: integer
        format: int32
      - name: providerId
        in: query
        description: The provider identifier. Required for sub-contractor request. [Required Special permissions]
        required: false
        type: integer
        format: int32
      responses:
        '200':
          description: Request succeeded and the requested information is in the response.
          schema:
            type: array
            items:
              $ref: '#/definitions/ServiceChannel.Services.Messaging.Assets.AssetAttachment'
        '400':
          description: "Bad Request - the request could not be executed or was missing required parameters.\r\n            <br/>Error codes:\r\n            <br/> 503 - User info should not be null;\r\n            <br/>SubscriberId is null;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "Unauthorized indicates that the requested resource requires authentication.\r\n            <br/>Error codes:\r\n            <br/> 504 - API call rejected by security permissions;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Any
    post:
      tags:
      - Attachments
      summary: Add Attachments to Asset
      operationId: POSTv3_assets_{assetId}_attachments?isDefault={isDefault}
      consumes:
      - multipart/form-data
      produces:
      - application/json
      - text/json
      parameters:
      - name: assetId
        in: path
        required: true
        type: integer
        format: int32
      - name: isDefault
        in: query
        required: false
        type: boolean
        default: false
      - name: AddAttachmentsRequest
        in: formData
        description: Required Descriptor for file(s)
        required: false
        schema:
          type: array
          items:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.Assets.AssetAttachment'
        type: application/json
      - name: file
        in: formData
        description: File to attach to workorder
        required: true
        type: file
      responses:
        '200':
          description: Created indicates that the request resulted in a new resource created before the response was sent.
          schema:
            type: array
            items:
              $ref: '#/definitions/ServiceChannel.Services.Messaging.Assets.AddAssetAttachmentResponse'
        '400':
          description: "Bad Request - the request could not be executed or was missing required parameters.\r\n            <br/>Error codes:\r\n            <br/> 502 - Asset Not found;\r\n            < br/> 503 - Bad Request;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "Indicates that the requested resource requires authentication.\r\n            <br/>Error codes:\r\n            <br/> 504 - API call rejected by security permissions;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: Indicates that a generic error has occurred on the server.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Any
  /assets/{assetAttachmentId}/deleteAttachment:
    post:
      tags:
      - Attachments
      summary: Delete Asset Attachment
      operationId: POSTv3_assets_{assetAttachmentId}_deleteAttachment
      consumes: []
      produces:
      - application/json
      - text/json
      parameters:
      - name: assetAttachmentId
        in: path
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: Request succeeded and the requested information is in the response.
          schema:
            $ref: '#/definitions/System.Object'
        '400':
          description: "Bad Request - the request could not be executed or was missing required parameters.\r\n            <br/>Error codes:\r\n            <br/> 503 - User info should not be null;\r\n            <br/>SubscriberId is null;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "Unauthorized indicates that the requested resource requires authentication.\r\n            <br/>Error codes:\r\n            <br/> 504 - API call rejected by security permissions;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Any
  /assets/getattachmentsbyassetids:
    post:
      tags:
      - Attachments
      summary: Get Asset Attachments
      operationId: POSTv3_assets_getattachmentsbyassetids
      consumes:
      - application/json
      - text/json
      produces:
      - application/json
      - text/json
      parameters:
      - name: assetIds
        in: body
        required: true
        schema:
          type: array
          items:
            format: int32
            type: integer
      responses:
        '200':
          description: Request succeeded and the requested information is in the response.
          schema:
            type: object
            additionalProperties:
              type: array
              items:
                $ref: '#/definitions/ServiceChannel.Services.Messaging.Assets.AssetAttachment'
        '400':
          description: "Bad Request - the request could not be executed or was missing required parameters.\r\n            <br/>Error codes:\r\n            <br/> 503 - User info should not be null;\r\n            <br/>SubscriberId is null;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "Unauthorized indicates that the requested resource requires authentication.\r\n            <br/>Error codes:\r\n            <br/> 504 - API call rejected by security permissions;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Any
  /assets/getattachmentsbyassetids_v1:
    post:
      tags:
      - Attachments
      summary: Get Asset Attachments
      operationId: POSTv3_assets_getattachmentsbyassetids_v1
      consumes:
      - application/json
      - text/json
      produces:
      - application/json
      - text/json
      parameters:
      - name: assetAttachmentsRequest
        in: body
        required: true
        schema:
          $ref: '#/definitions/ServiceChannel.Services.WebApi.Models.AssetAttachmentsRequest'
      responses:
        '200':
          description: Request succeeded and the requested information is in the response.
          schema:
            type: object
            additionalProperties:
              type: array
              items:
                $ref: '#/definitions/ServiceChannel.Services.Messaging.Assets.AssetAttachment'
        '400':
          description: "Bad Request - the request could not be executed or was missing required parameters.\r\n            <br/>Error codes:\r\n            <br/> 503 - User info should not be null;\r\n            <br/>SubscriberId is null;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "Unauthorized indicates that the requested resource requires authentication.\r\n            <br/>Error codes:\r\n            <br/> 504 - API call rejected by security permissions;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Any
  /assets/updateAssetAttachment:
    put:
      tags:
      - Attachments
      summary: Update asset attachment by id
      description: ''
      operationId: PUTv3_assets_updateAssetAttachment?attachmentId={attachmentId}&fileName={fileName}&description={description}
      consumes: []
      produces:
      - application/json
      - text/json
      parameters:
      - name: attachmentId
        in: query
        description: Attachment identifier
        required: true
        type: integer
        format: int32
      - name: fileName
        in: query
        description: New file name
        required: false
        type: string
      - name: description
        in: query
        description: New file description(comment)
        required: false
        type: string
      responses:
        '200':
          description: Request succeeded and the requested information is in the response.
          schema:
            $ref: '#/definitions/System.Object'
        '400':
          description: "Bad Request - the request could not be understood or was missing required parameters.\r\n            <br/>Error codes:\r\n            <br/> 503 - FileName or Description is required;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "Unauthorized indicates that the requested resource requires authentication.\r\n            <br/>Error codes:\r\n            <br/> 504 - API call rejected by security permissions;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Any
  /workrequest/{workRequestId}/attachments:
    get:
      tags:
      - Attachments
      summary: Get WorkRequest Attachments
      description: '*In limited availability phase.*'
      operationId: GETv3_workrequest_{workRequestId}_attachments
      consumes: []
      produces:
      - application/json
      - text/json
      parameters:
      - name: workRequestId
        in: path
        description: WorkRequest Identifier
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: Request succeeded and the requested information is in the response.
          schema:
            type: array
            items:
              $ref: '#/definitions/ServiceChannel.Services.Messaging.Attachments.Attachment'
        '401':
          description: "Unauthorized indicates that the requested resource requires authentication.\r\n            <br/>Error codes:\r\n            <br/> 504 - API call rejected by security permissions;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Any
    post:
      tags:
      - Attachments
      summary: Add attachments to a WorkRequest
      description: "*In limited availability phase.*\r\n            <br />Adds attachments to the specified WorkRequest."
      operationId: POSTv3_workrequest_{workRequestId}_attachments?actor={actor}
      consumes:
      - multipart/form-data
      produces:
      - application/json
      - text/json
      parameters:
      - name: workRequestId
        in: path
        description: Numeric ID of the WorkRequest to add attachments to.
        required: true
        type: integer
        format: int32
      - name: actor
        in: query
        description: Name of the person on whose behalf you are performing the action
        required: false
        type: string
      - name: AddAttachmentsRequest
        in: formData
        description: ''
        required: false
        schema:
          $ref: '#/definitions/ServiceChannel.Services.Messaging.Attachments.AddAttachmentsRequest'
        type: application/json
      - name: file
        in: formData
        description: File to attach to the work request.
        required: true
        type: file
      responses:
        '201':
          description: Created indicates that the request resulted in a new resource created before the response was sent.
        '400':
          description: "Bad Request - the request could not be understood or was missing required parameters.\r\n            <br/>Error codes:\r\n            <br/> 502 - Work Request not found;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "Indicates that the requested resource requires authentication.\r\n            <br/>Error codes:\r\n            <br/> 504 - API call rejected by security permissions;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: Indicates that a generic error has occurred on the server.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Any
  /workrequest/{workRequestId}/notes/{noteId}/attachments:
    post:
      tags:
      - Attachments
      summary: Add Attachments to Work Request Note
      description: "*In limited availability phase.*\r\n            <br />Add Attachments to Work Request Note. Returns list of attachments Id for successful request."
      operationId: POSTv3_workrequest_{workRequestId}_notes_{noteId}_attachments
      consumes:
      - multipart/form-data
      produces:
      - application/json
      - text/json
      parameters:
      - name: workRequestId
        in: path
        description: Numeric Id of the Work Request to perform action with.
        required: true
        type: integer
        format: int32
      - name: noteId
        in: path
        description: Numeric Id of the Note to perform action with.
        required: true
        type: integer
        format: int32
      - name: AddAttachmentsRequest
        in: formData
        description: Optional Descriptor for file(s)
        required: false
        schema:
          type: array
          items:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.Attachments.AddAttachmentRequest'
        type: application/json
      - name: file
        in: formData
        description: File to attach to note
        required: true
        type: file
      responses:
        '201':
          description: Created indicates that the request resulted in a new resource created before the response was sent.
        '400':
          description: "Bad Request - the request could not be understood or was missing required parameters.\r\n            <br/>Error codes:\r\n            <br/> 503 - Validation fails;\r\n            <br/> 8020 - InvalidWorkRequestIdentifier;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "Indicates that the requested resource requires authentication.\r\n            <br/>Error codes:\r\n            <br/> 504 - API call rejected by security permissions;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: Indicates that a generic error has occurred on the server.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Any
  /workrequest({workRequestId})/notes({noteId})/attachments:
    get:
      tags:
      - Attachments
      summary: Get WorkRequest Note Attachments
      description: '*In limited availability phase.*'
      operationId: GETv3_workrequest({workRequestId})_notes({noteId})_attachments
      consumes: []
      produces:
      - application/json
      - text/json
      parameters:
      - name: workRequestId
        in: path
        description: WorkRequest Identifier
        required: true
        type: integer
        format: int32
      - name: noteId
        in: path
        description: Note Identifier
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: Indicates that the request succeeded and that the requested information is in the response.
          schema:
            type: array
            items:
              $ref: '#/definitions/ServiceChannel.Services.Messaging.Attachments.Attachment'
        '401':
          description: "Unauthorized indicates that the requested resource requires authentication.\r\n            <br/>Error codes:\r\n            <br/> 504 - API call rejected by security permissions;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Any
  /refrigeranttracking/uploadplanattachmentsonblob:
    post:
      tags:
      - Attachments
      summary: Upload Attachments To Storage
      operationId: POSTv3_refrigeranttracking_uploadplanattachmentsonblob
      consumes:
      - multipart/form-data
      produces:
      - application/json
      - text/json
      parameters:
      - name: file
        in: formData
        description: File to upload
        required: true
        type: file
      - name: UploadRetrofitRetireAttachmentsRequest
        in: formData
        description: Required Descriptor for file(s)
        required: false
        schema:
          $ref: '#/definitions/ServiceChannel.Services.Messaging.Attachments.UploadRetrofitRetireAttachmentsRequest'
        type: application/json
      responses:
        '200':
          description: Created indicates that the request resulted in a new resource created before the response was sent.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.WebApi.Models.Response.Attachments.UploadRetrofitRetireAttachmentsResponse'
        '400':
          description: "Bad Request - the request could not be executed or was missing required parameters.\r\n            <br/>Error codes:\r\n            <br/> 502 - Asset Not found;\r\n            < br/> 503 - Bad Request;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "Indicates that the requested resource requires authentication.\r\n            <br/>Error codes:\r\n            <br/> 504 - API call rejected by security permissions;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: Indicates that a generic error has occurred on the server.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Any
  /refrigeranttracking/RetrofitRetirePlanAttachments:
    get:
      tags:
      - Attachments
      summary: Get retrofit retire plan attachments
      description: Returns list of attachments for the specific plan.
      operationId: GETv3_refrigeranttracking_RetrofitRetirePlanAttachments?planId={planId}
      consumes: []
      produces:
      - application/json
      - text/json
      parameters:
      - name: planId
        in: query
        description: Request
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: The request succeeded and the requested information is in the response.
          schema:
            type: array
            items:
              $ref: '#/definitions/ServiceChannel.Services.Messaging.RefrigerantTracking.RetrofitRetireDoc'
        '400':
          description: The request was not accepted due to bad syntax, missing parameters, insufficient data, etc.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "Indicates that the requested resource requires authentication.\r\n            <br>Error codes:\r\n            <br> 504 - API call rejected by security permissions;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: "Something went wrong, and the server was unable to complete your request.\r\n            <br>Error codes:\r\n            501 - Internal Error"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Any
  /refrigeranttracking/linkPlanAttachments:
    post:
      tags:
      - Attachments
      summary: Add file link to the specific retrofit retire plan
      operationId: POSTv3_refrigeranttracking_linkPlanAttachments
      consumes:
      - application/json
      - text/json
      produces:
      - application/json
      - text/json
      parameters:
      - name: request
        in: body
        description: ''
        required: true
        schema:
          $ref: '#/definitions/ServiceChannel.Services.Messaging.RefrigerantTracking.AddRetrofitRetirePlanDocsRequest'
      responses:
        '200':
          description: Indicates that the request succeeded and that the requested information is in the response.
          schema:
            $ref: '#/definitions/System.Object'
        '400':
          description: "Bad Request - the request could not be understood or was missing required parameters.\r\n            <br/>Error codes:     

# --- truncated at 32 KB (132 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/servicechannel/refs/heads/main/openapi/servicechannel-attachments-api-openapi.yml