Integrating BMC Helix for CSP with a third-party application by using the REST API
{
"swagger" : "2.0",
"info" : {
"description" : "This is a spec for CSP Trouble Ticket lib REST API",
"version" : "v1",
"title" : "Swagger spec for CSP Trouble Ticket lib REST API",
"contact" : {
"url" : "http://www.bmc.com"
}
},
"host" : "bmc.com",
"basePath" : "/api/com.bmc.dsm.trouble-ticket-lib",
"tags" : [ {
"name" : "The Trouble Ticket API compliant to TMF API 621"
} ],
"schemes" : [ "http", "https" ],
"paths" : {
"/v1/troubleTicket" : {
"get" : {
"tags" : [ "The Trouble Ticket API compliant to TMF API 621" ],
"summary" : "List or find TroubleTicket objects",
"description" : "This operation lists or finds TroubleTicket entities",
"operationId" : "listTroubleTicket",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "fields",
"in" : "query",
"description" : "Comma-separated properties to be provided in response",
"required" : false,
"type" : "string"
}, {
"name" : "offset",
"in" : "query",
"description" : "Requested index for start of resources to be provided in response",
"required" : false,
"type" : "integer",
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Requested number of resources to be provided in response",
"required" : false,
"type" : "integer",
"format" : "int32"
} ],
"responses" : {
"200" : {
"description" : "Success"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"405" : {
"description" : "Method Not allowed"
},
"409" : {
"description" : "Conflict"
},
"500" : {
"description" : "Internal Server Error"
}
}
},
"post" : {
"tags" : [ "The Trouble Ticket API compliant to TMF API 621" ],
"summary" : "Creates a TroubleTicket",
"description" : "This operation creates a TroubleTicket entity.",
"operationId" : "createTroubleTicket",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The TroubleTicket to be created",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"201" : {
"description" : "Created"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"405" : {
"description" : "Method Not allowed"
},
"409" : {
"description" : "Conflict"
},
"500" : {
"description" : "Internal Server Error"
}
}
}
},
"/v1/troubleTicket/{id}" : {
"get" : {
"tags" : [ "The Trouble Ticket API compliant to TMF API 621" ],
"summary" : "Retrieves a TroubleTicket by ID",
"description" : "This operation retrieves a TroubleTicket entity. Attribute selection is enabled for all first level attributes.",
"operationId" : "retrieveTroubleTicket",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "Identifier of the TroubleTicket",
"required" : true,
"type" : "string"
}, {
"name" : "fields",
"in" : "query",
"description" : "Comma-separated properties to provide in response",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "Success"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"405" : {
"description" : "Method Not allowed"
},
"409" : {
"description" : "Conflict"
},
"500" : {
"description" : "Internal Server Error"
}
}
},
"patch" : {
"tags" : [ "The Trouble Ticket API compliant to TMF API 621" ],
"summary" : "Updates partially a TroubleTicket",
"description" : "This operation updates partially a TroubleTicket entity.",
"operationId" : "patchTroubleTicket",
"consumes" : [ "application/merge-patch+json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "Identifier of the TroubleTicket",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The TroubleTicket to be updated",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Updated"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"405" : {
"description" : "Method Not allowed"
},
"409" : {
"description" : "Conflict"
},
"500" : {
"description" : "Internal Server Error"
}
}
}
}
}
}
Was this page helpful? Yes No
Submitting...
Thank you
Comments
Log in or register to comment.