Zoho EntityBlueprints API

openapi: 3.1.0
info:
  title: Helpcenter EntityBlueprints API
  version: 1.0.0
tags:
- name: EntityBlueprints
paths:
  /api/v1/tickets/{ticketId}/transitions/{transitionId}/discardDraft:
    post:
      tags:
      - EntityBlueprints
      summary: Delete the during actions transition draft
      description: To delete the during actions transition draft
      operationId: deleteDuringActionTransitionDraft
      parameters:
      - $ref: '#/components/parameters/transitionId'
      - $ref: '#/components/parameters/ticketId'
      - $ref: ./Common.json#/components/parameters/orgId
      responses:
        '404':
          $ref: ./Common.json#/components/responses/urlNotFoundErrorResponse
        '200':
          $ref: ./Common.json#/components/responses/emptyResponse
        '422':
          $ref: ./Common.json#/components/responses/multipleUnprocessEntityResponse
        '401':
          $ref: ./Common.json#/components/responses/unauthorizedErrorResponse
        '403':
          $ref: ./Common.json#/components/responses/forbiddenErrorResponse
      security:
      - iam-oauth2-schema:
        - Desk.tickets.UPDATE
      x-audience:
      - external-public
  /api/v1/tickets/{ticketId}/transitions/{transitionId}/saveDraft:
    post:
      tags:
      - EntityBlueprints
      summary: Save the during actions transition draft
      description: To save the during actions transition draft
      operationId: saveDuringActionTransitionDraft
      parameters:
      - $ref: '#/components/parameters/transitionId'
      - $ref: '#/components/parameters/ticketId'
      - $ref: ./Common.json#/components/parameters/orgId
      requestBody:
        $ref: '#/components/requestBodies/saveDraftRequestJson'
      responses:
        '404':
          $ref: ./Common.json#/components/responses/urlNotFoundErrorResponse
        '200':
          $ref: '#/components/responses/saveDraftResponseJson'
        '422':
          $ref: ./Common.json#/components/responses/multipleUnprocessEntityResponse
        '401':
          $ref: ./Common.json#/components/responses/unauthorizedErrorResponse
        '403':
          $ref: ./Common.json#/components/responses/forbiddenErrorResponse
      security:
      - iam-oauth2-schema:
        - Desk.tickets.UPDATE
      x-audience:
      - external-public
components:
  requestBodies:
    saveDraftRequestJson:
      content:
        application/json:
          schema:
            type:
            - 'null'
            - object
            additionalProperties: false
            properties:
              ATTACHMENT:
                $ref: ./EntityBlueprints.json#/components/schemas/attachmentJson
              RESOLUTION:
                $ref: ./EntityBlueprints.json#/components/schemas/draftedResolutionJson
              FIELD_UPDATE:
                $ref: ./EntityBlueprints.json#/components/schemas/fieldJson
              APPROVAL:
                $ref: ./EntityBlueprints.json#/components/schemas/draftedApprovalJson
              REPLY:
                $ref: ./EntityBlueprints.json#/components/schemas/replyJson
              COMMENT:
                $ref: ./EntityBlueprints.json#/components/schemas/commentJson
          examples:
            Valid requestBody Definitions:
              value:
                ATTACHMENT:
                  uploads:
                  - isPublic: false
                    id: 1000000096035
                FIELD_UPDATE:
                  customFields:
                    cf_cffdate_time: 1606113000000
                    cf_cfphone: '9999456789'
                    cf_cfinteger: '19'
                    cf_cfemail: carol@zylker.com
                    cf_cfpicklist: Option 1
                    cf_cffdate: 1606262400000
                    cf_cfpercent: '32'
                    cf_cfmultiselect: ;Option 1
                    cf_cfcheckbox: true
                    cf_cfsingle_line: Hi Sandeep here!
                    cf_cfcurrency: '134'
                    cf_cfmulti_line: 'adad

                      asdd'
                    cf_cfdecimal: '23.0'
                    cf_cfurl: www.desk.zoho.com
                  channel: Email
                RESOLUTION:
                  toNotifyContactForResolution: true
                  content: This ticket has to be solved
                APPROVAL:
                  approverIds:
                  - 1000000012635
                  subject: Has to be sent for approval
                REPLY:
                  channel: EMAIL
                  to: carol@zylker.com
                  isPrivate: false
                  fromEmailAddress: support@zylker.com
                  contentType: plainText
                  content: Hi Sandeep here!
                  isForward: false
                  uploads:
                  - 1000000096035
                COMMENT:
                  isPublicComment: false
                  content: Comment is to test transition Draft
                  uploads:
                  - 1000000096035
  responses:
    saveDraftResponseJson:
      description: saveDraftResponseJson template definitions
      content:
        application/json:
          schema:
            type:
            - 'null'
            - object
            additionalProperties: false
            properties:
              totalNoOfDraftActions:
                type:
                - string
                - 'null'
                - integer
                format: int32
                minimum: 1
                pattern: ([0-9]+)
              draftBy:
                $ref: ./EntityBlueprints.json#/components/schemas/draftByJson
              totalNoOfActions:
                type:
                - string
                - 'null'
                - integer
                format: int32
                minimum: 1
                pattern: ([0-9]+)
              draftAt:
                type:
                - string
                - 'null'
                maxLength: 100
                minLength: 0
                pattern: (((19|20)\d\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\d]{0,3})?(Z))
            required:
            - draftAt
            - draftBy
            - totalNoOfActions
            - totalNoOfDraftActions
          examples:
            Valid responses Definitions:
              value:
                draftBy:
                  name: Sandeep Ghemire
                  id: '8000000000053'
                draftAt: 1605284320000
  parameters:
    ticketId:
      name: ticketId
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type:
        - string
        - 'null'
        - integer
        format: int64
        pattern: ([0-9]+)
    transitionId:
      name: transitionId
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type:
        - string
        - 'null'
        - integer
        format: int64
        pattern: ([0-9]+)
  securitySchemes:
    iam-oauth2-schema:
      $ref: ./Common.json#/components/securitySchemes/iam-oauth2-schema
x-entity: Helpcenter