swagger: '2.0'
|
info:
|
version: '1.0'
|
title: SOA REST API
|
description: REST API Exposed on SOA
|
termsOfService: 'http://swagger.io/terms/'
|
license:
|
name: MIT
|
url: 'http://github.com/gruntjs/grunt/blob/master/LICENSE-MIT'
|
host: 'host:7004'
|
basePath: /rest
|
securityDefinitions:
|
basicAuth:
|
type: basic
|
schemes:
|
- http
|
consumes:
|
- application/json
|
produces:
|
- application/json
|
paths:
|
/v1/manage-service-incident:
|
post:
|
summary: This API will have the specifications that are needed for Remedy to create/Udpdate a service request on Service now
|
description: >-
|
The service will be exposed to create or update an service request created on the service now in Remedy.
|
operationId: ManageSR
|
parameters:
|
- name: body
|
in: body
|
required: true
|
schema:
|
$ref: '#/definitions/ServiceIncidentRequest'
|
responses:
|
'200':
|
description: lead Management request
|
schema:
|
$ref: '#/definitions/ServiceIncidentResponse'
|
'401':
|
$ref: '#/responses/unauthorizedError'
|
'500':
|
description: Internal server error
|
schema:
|
$ref: '#/responses/unexpectedError'
|
definitions:
|
ServiceIncidentRequest:
|
required:
|
- transactionId
|
- sourceIdentifier
|
properties:
|
transactionId:
|
type: string
|
example: 101813
|
description: This parameter respresents the unique identifier of the transaction.
|
sourceIdentifier:
|
type: string
|
example: MNP
|
description: This parameter respresents the unique identifier of the channel/Application that is invoking this service.
|
|
action:
|
type: string
|
example: CREATE
|
description: This field defines the action that needs to be taken on the ticket. CREATE to create a ticket and UPDATE to update an existing ticket.
|
category:
|
type: string
|
example: APN, Static-Ip
|
description: "Used to categorize the order, useful for the OM system."
|
description:
|
type: string
|
description: "This field will have the description of the service request that is raised"
|
priority:
|
type: string
|
description: "This field will determine the priority of the service request that is raised."
|
descriptionList:
|
type: array
|
description: "Extra-information about the order; e.g. useful to add extra delivery information that could be useful for a human process."
|
items:
|
type: object
|
required:
|
- type
|
- text
|
properties:
|
type:
|
type: string
|
description: "Type of extra informationm entered by user while raising a service request."
|
example : comment, WorkNote
|
text:
|
type: string
|
description: "The text for the description"
|
example : "This field has additional information for the service request"
|
attachmentList:
|
type: array
|
description: "This array will have the list of attachments when creating or updating a service request"
|
items:
|
type: object
|
required:
|
- attachmentName
|
- attachmentDescription
|
- attachment
|
properties:
|
attachmentName:
|
type: string
|
description: "This field will have the type of file that is attached while creating or updating a service request"
|
example : worknotes.jpg
|
attachmentDescription:
|
type: string
|
description: "This field will have the description of the file that is attached"
|
attachment:
|
type: string
|
description: "This field will have the base 64 format of the file that is attached"
|
orderItemList:
|
type: array
|
description: "This array will have the list of order items that will be processed.This is a key value pair of the target system name and signals that will be passed by Remedy to MAD API which will indicate on creating or updating a service request with either work notes or changing the state of the service request"
|
items:
|
type: object
|
required:
|
- type
|
- text
|
properties:
|
type:
|
type: string
|
description: "Type of key value pairs for the variables"
|
example : targetSystem, Signal Name
|
text:
|
type: string
|
description: "The value of the key that is being passed"
|
example : servicenow, Remedy-ServiceNow-CreateSR
|
|
ServiceIncidentResponse:
|
properties:
|
transactionId:
|
type: string
|
example: 12345
|
description: >-
|
This field will be mapped in the response from the transation id given in the input.
|
statusCode:
|
type: string
|
example: 0
|
description: >-
|
0 for success. Any code other than 0 will be failure.
|
statusMessage:
|
type: string
|
example: Transaction processed successfully.
|
description: Status message for the transaction.
|
supportMessage:
|
type: string
|
description: This field will have the ticket id that SOA recieves from Remedy.
|
responses:
|
unexpectedError:
|
description: Internal Server Error
|
unauthorizedError:
|
description: Authentication information is missing or invalid
|
