--- swagger: "2.0" info: x-ibm-name: helpdeskservices title: HelpDeskServices version: 1.0.0 description: "HelpDesk Services for External incoming requests\n\n# Endpoints url \ \ndiscount sandbox \nhttps://mtls-api-nonprod.discountbank.co.il/devapi/cert\n\ndiscount prod \nhttps://mtls-api.discountbank.co.il/prod/d\n\nmercantile sandbox \ \nhttps://mtls-api-nonprod.mercantile.co.il/devapi/cert\n\nmercantile prod \nhttps://mtls-api.mercantile.co.il/prod/d" name: "" schemes: - https basePath: /HelpDeskServices consumes: - application/json produces: - application/json securityDefinitions: Oauth 2.1 B2B: type: oauth2 description: B2B Authorization flow: application scopes: B2B_infra: "" tokenUrl: https://$(api.endpoint.hostname)/$(api.org.name)/$(env.path)/b2b/token x-scopeValidate: tls-profile: sergey.paponov@dbank.co.il security: - Oauth 2.1 B2B: - B2B_infra x-ibm-configuration: testable: true enforced: true phase: realized paths: /callRequest: post: operationId: helpdeskservices.CreateCallRequest responses: 201: description: OK schema: $ref: '#/definitions/CreateCallRequestResponse' parameters: - name: body in: body schema: $ref: '#/definitions/CreateCallRequestRequest' - $ref: '#/parameters/Authorization' summary: CreateCallRequest /changeRequest: post: summary: CreateChangeRequest operationId: helpdeskservices.CreateChangeRequest responses: 201: description: OK schema: $ref: '#/definitions/CreateChangeRequestResponse' parameters: - name: body in: body schema: $ref: '#/definitions/CreateChangeRequestRequest' /callRequest/{callRequestID}: get: summary: GetCallRequest operationId: helpdeskservices.GetCallRequest responses: 200: description: OK schema: $ref: '#/definitions/GetCallRequestResponse' parameters: - name: callRequestID in: path required: true description: מזהה פנייה type: string maxLength: 20 put: summary: UpdateCallRequest operationId: helpdeskservices.UpdateCallRequest responses: 200: description: OK schema: $ref: '#/definitions/UpdateCallRequestResponse' parameters: - name: callRequestID in: path required: true description: מזהה פנייה type: string - name: body in: body schema: $ref: '#/definitions/UpdateCallRequestRequest' tags: [] parameters: Authorization: name: Authorization type: string required: false in: header description: "" definitions: error: properties: error: type: array items: type: object properties: httpCode: type: integer description: קוד החזר example: 400 httpMessage: type: string description: הודעה example: Bad Request code: type: string description: קוד ממערכת המקור message: type: string description: הודעה ממערכת המקור moreInformation: type: string description: מידע נוסף ממערכת המקור warning: type: array items: type: object properties: code: type: string description: קוד החזר example: MC101 message: type: string description: הודעה example: הוחלף יום עסקים... moreInformation: type: string description: מידע נוסף example: יש לעדכן את הלקוח additionalProperties: false required: - error noData: additionalProperties: false CreateCallRequestRequest: properties: callRequestSeverity: title: callRequestSeverity description: חומרת הקריאה type: string enum: - CriticalSystem - UnitDisabled - NotDisabled - WorkStationDisabled - LegacySystemDisabled - Critical - SafetyHazard - BranchDisabled - DisablingEvent - NoEmail - SeriousBusinessHazard - Low - Medium - BranchClient environment: title: environment description: סביבה type: string enum: - Production - Sandbox softwareIssueType: title: softwareIssueType description: סוג בקשה type: string enum: - Bug - Question - Remark reportingUserID: title: reportingUserID description: מזהה המשתמש המדווח type: string example: D123456 impact: title: impact description: השפעה type: string enum: - MediumHigh - SingleEffect - Low - Medium - OverallEffect - SmallGroup - EntireOrganization - NoEffect categoryCode: title: categoryCode description: קוד קטגוריית הפנייה type: string maxLength: 100 example: pcat:1234569 deviceVersion: title: deviceVersion description: גרסת השירות type: string example: V4 callRequestDescription: title: callRequestDescription description: תיאור הפניה type: string maxLength: 4000 example: יש לי בעיה במחשב userID: title: userID description: מזהה משתמש פנים ארגוני type: string example: D123456 deviceName: title: deviceName description: שם הרכיב type: string maxLength: 20 example: i342-sys-01 required: - userID - categoryCode - reportingUserID CreateCallRequestResponse: properties: data: title: data description: אובייקט אב type: object properties: callRequestID: title: callRequestID description: מזהה פנייה type: string required: - callRequestID CreateChangeRequestResponse: properties: data: title: data description: אובייקט אב type: object properties: changeRequestID: title: changeRequestID description: מזהה הדרישה type: integer minimum: 0 CreateChangeRequestRequest: properties: changeRequestDescription: title: changeRequestDescription description: תיאור הדרישה type: string maxLength: 4000 example: יש לי בעיה במחשב entitlementSetting: title: entitlementSetting description: הגדרת זכאות type: object properties: entitlementDate: title: entitlementDate description: תאריך תפוגה להרשאות type: string format: date entitlementCodes: type: array items: title: entitlementCodes description: מספרי קודים של הרשאות type: integer maximum: 4000 minimum: 0 required: - entitlementCodes reportingUserID: title: reportingUserID description: מזהה המשתמש המדווח type: string example: D123456 categoryCode: title: categoryCode description: קוד קטגוריית הפנייה type: string maxLength: 20 example: pcat:1234569 divisionReferent: title: divisionReferent description: מזהה רפרנט חטיבתי type: string example: d641104 userID: title: userID description: מזהה משתמש פנים ארגוני type: string required: - userID - reportingUserID - categoryCode GetCallRequestResponse: properties: data: title: data description: אובייקט אב type: object properties: reportingUserID: title: reportingUserID description: מזהה המשתמש המדווח type: string maxLength: 8 example: D123456 categoryCode: title: categoryCode description: קוד קטגוריית הפנייה type: string maxLength: 20 example: pcat:1234569 callRequestDescription: title: callRequestDescription description: תיאור הפניה type: string maxLength: 4000 example: יש לי בעיה במחשב callRequestID: title: callRequestID description: מזהה פנייה type: string maxLength: 20 example: "1425" userID: title: userID description: מזהה משתמש פנים ארגוני type: string deviceName: title: deviceName description: שם הרכיב type: string maxLength: 20 example: i342-sys-01 required: - callRequestID UpdateCallRequestResponse: properties: data: title: data description: אובייקט אב type: object properties: resultDescription: title: resultDescription description: פלט התוצאה של עדכון הקריאה type: string example: updated required: - resultDescription UpdateCallRequestRequest: properties: callRequestSeverity: title: callRequestSeverity description: חומרת הקריאה type: string enum: - CriticalSystem - UnitDisabled - NotDisabled - WorkStationDisabled - LegacySystemDisabled - Critical - SafetyHazard - BranchDisabled - DisablingEvent - NoEmail - SeriousBusinessHazard - Low - Medium - BranchClient callRequestAssignee: title: callRequestAssignee description: מספר עובד גורם מטפל type: string maxLength: 7 example: d298035 callRequestStatus: title: callRequestStatus description: סטטוס הפניה type: string enum: - PastHandling - Duplication - Solving - Reopened - Closed - EndHandling - Holding - Cancelled - Open - Waiting helpDeskTeam: title: helpDeskTeam description: צוות מטפל בקריאה type: string maxLength: 20 example: טכנאים callRequestCloseDescription: title: callRequestCloseDescription description: תיאור סגירת הפניה type: string maxLength: 4000 example: פנייתך נסגרה categoryCode: title: categoryCode description: קוד קטגוריית הפנייה type: string maxLength: 100 example: pcat:1234569 callRequestDescription: title: callRequestDescription description: תיאור הפניה type: string maxLength: 4000 example: יש לי בעיה במחשב deviceName: title: deviceName description: שם הרכיב type: string maxLength: 20 example: i342-sys-01 x-ibm-endpoints: - endpointUrl: https://mtls-api.discountbank.co.il/prod/d type: - production - development ...