--- title: "Updates partially a TroubleTicket" method: PATCH path: "/troubleTicket/{id}" tags: ["troubleTicket"] --- # Updates partially a TroubleTicket `PATCH /troubleTicket/{id}` ## Request - Base URL: `https://serverRoot/tmf-api/troubleTicket/v4` - URL: `https://serverRoot/tmf-api/troubleTicket/v4/troubleTicket/{id}` - Auth: none declared - TypeScript: (a function with typed inputs; its response is checked against the schema) This operation updates partially a TroubleTicket entity. ## Path parameters - `id` string, required ## Request body - TroubleTicketUpdate: Base entity schema for use in TMForum Open-APIs - `@type` string: When sub-classing, this defines the sub-class entity name - `@baseType` string: When sub-classing, this defines the super-class - `@schemaLocation` string, uri: A URI to a JSON-Schema file that defines additional attributes and relationships - `description` string: Description of the trouble or issue - `expectedResolutionDate` string, date-time: The expected resolution date determined by the trouble ticket system - `externalId` string: Additional identifier coming from an external system - `name` string: Name of the trouble ticket, typically a short description provided by the user that create the ticket - `priority` string: The priority of the trouble ticket and how quickly the issue should be resolved. Example: Critical, High, Medium, Low. The value is set by the ticket management system considering the severity, ticket type etc... - `requestedResolutionDate` string, date-time: The resolution date requested by the user - `resolutionDate` string, date-time: The date and time the trouble ticket was resolved - `severity` string: The severity of the issue. Indicate the implication of the issue on the expected functionality e.g. of a system, application, service etc.. Severity values can be for example : Critical, Major, Minor - `statusChangeReason` string: The reason for changing the status - `ticketType` string: represent a business type of the trouble ticket e.g. incident, complain, request - `attachment` AttachmentRefOrValue[]: File(s) attached to the trouble ticket. e.g. pictur of broken device, scaning of a bill or charge - `@type` string: When sub-classing, this defines the sub-class entity name - `@baseType` string: When sub-classing, this defines the super-class - `@schemaLocation` string, uri: A URI to a JSON-Schema file that defines additional attributes and relationships - `ref` AttachmentRef: Base entity schema for use in TMForum Open-APIs - `@type` string: When sub-classing, this defines the sub-class entity name - `@baseType` string: When sub-classing, this defines the super-class - `@schemaLocation` string, uri: A URI to a JSON-Schema file that defines additional attributes and relationships - `id` string: Unique identifier of a related entity. - `href` string: Reference of the related entity. - `name` string: Name of the related entity. - `@referredType` string: The actual type of the target instance when needed for disambiguation. - `description` string: A narrative text describing the content of the attachment - `url` string: Link to the attachment media/content - `value` Attachment: Base entity schema for use in TMForum Open-APIs - `@type` string: When sub-classing, this defines the sub-class entity name - `@baseType` string: When sub-classing, this defines the super-class - `@schemaLocation` string, uri: A URI to a JSON-Schema file that defines additional attributes and relationships - `id` string: Unique identifier for this particular attachment - `href` string: URI for this Attachment - `attachmentType` string: Attachment type such as video, picture - `content` string: The actual contents of the attachment object, if embedded, encoded as base64 - `description` string: A narrative text describing the content of the attachment - `mimeType` string: Attachment mime type such as extension file for video, picture and document - `name` string: The name of the attachment - `url` string: Uniform Resource Locator, is a web page address (a subset of URI) - `size` Quantity: An amount in a given unit - `amount` number, float: Numeric value in a given unit - `units` string: Unit - `validFor` TimePeriod: A period of time, either as a deadline (endDateTime only) a startDateTime only, or both - `endDateTime` string, date-time: End of the time period, using IETC-RFC-3339 format - `startDateTime` string, date-time: Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end - `channel` ChannelRef: Base entity schema for use in TMForum Open-APIs - `@type` string: When sub-classing, this defines the sub-class entity name - `@baseType` string: When sub-classing, this defines the super-class - `@schemaLocation` string, uri: A URI to a JSON-Schema file that defines additional attributes and relationships - `id` string: Unique identifier of a related entity. - `href` string: Reference of the related entity. - `name` string: Name of the related entity. - `@referredType` string: The actual type of the target instance when needed for disambiguation. - `note` Note[]: The note(s) that are associated to the ticket. - `@type` string: When sub-classing, this defines the sub-class entity name - `@baseType` string: When sub-classing, this defines the super-class - `@schemaLocation` string, uri: A URI to a JSON-Schema file that defines additional attributes and relationships - `id` string: Identifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation) - `author` string: Author of the note - `date` string, date-time: Date of the note - `text` string: Text of the note - `relatedEntity` RelatedEntity[]: An entity that is related to the ticket such as a bill, a product, etc. The entity against which the ticket is associated. - `@type` string: When sub-classing, this defines the sub-class entity name - `@baseType` string: When sub-classing, this defines the super-class - `@schemaLocation` string, uri: A URI to a JSON-Schema file that defines additional attributes and relationships - `id` string, required: Unique identifier of a related entity. - `href` string: Reference of the related entity. - `name` string: Name of the related entity. - `role` string, required: The role of an entity. - `@referredType` string, required: The actual type of the target instance when needed for disambiguation. - `relatedParty` RelatedParty[]: The related party(ies) that are associated to the ticket. - `@type` string: When sub-classing, this defines the sub-class entity name - `@baseType` string: When sub-classing, this defines the super-class - `@schemaLocation` string, uri: A URI to a JSON-Schema file that defines additional attributes and relationships - `id` string, required: Unique identifier of a related entity. - `href` string: Reference of the related entity. - `name` string: Name of the related entity. - `role` string: Role played by the related party - `@referredType` string, required: The actual type of the target instance when needed for disambiguation. - `status` 'submitted' | 'acknowledged' | 'rejected' | 'pending' | 'held' | 'inProgress' | 'cancelled' | 'closed' | 'resolved': Possible values for the status of the trouble ticket - `troubleTicketRelationship` TroubleTicketRelationship[]: A list of trouble ticket relationships (TroubleTicketRelationship [*]). Represents a relationship between trouble tickets - `@type` string: When sub-classing, this defines the sub-class entity name - `@baseType` string: When sub-classing, this defines the super-class - `@schemaLocation` string, uri: A URI to a JSON-Schema file that defines additional attributes and relationships - `id` string: Unique identifier of the Trouble Ticket - `href` string: Reference of the Trouble Ticket - `name` string: Name of the Trouble Ticket - `relationshipType` string: Type of the Trouble Ticket relationship can be isChiled, dependent etc... ## Response `200` Updated - TroubleTicket: Base entity schema for use in TMForum Open-APIs - `@type` string: When sub-classing, this defines the sub-class entity name - `@baseType` string: When sub-classing, this defines the super-class - `@schemaLocation` string, uri: A URI to a JSON-Schema file that defines additional attributes and relationships - `id` string: Unique identifier of the trouble ticket - `href` string: Hyperlink, a reference to the trouble ticket entity - `creationDate` string, date-time: The date on which the trouble ticket was created - `description` string: Description of the trouble or issue - `expectedResolutionDate` string, date-time: The expected resolution date determined by the trouble ticket system - `externalId` string: Additional identifier coming from an external system - `lastUpdate` string, date-time: The date and time that the trouble ticked was last updated - `name` string: Name of the trouble ticket, typically a short description provided by the user that create the ticket - `priority` string: The priority of the trouble ticket and how quickly the issue should be resolved. Example: Critical, High, Medium, Low. The value is set by the ticket management system considering the severity, ticket type etc... - `requestedResolutionDate` string, date-time: The resolution date requested by the user - `resolutionDate` string, date-time: The date and time the trouble ticket was resolved - `severity` string: The severity of the issue. Indicate the implication of the issue on the expected functionality e.g. of a system, application, service etc.. Severity values can be for example : Critical, Major, Minor - `statusChangeDate` string, date-time: The date and time the status changed. - `statusChangeReason` string: The reason for changing the status - `ticketType` string: represent a business type of the trouble ticket e.g. incident, complain, request - `attachment` AttachmentRefOrValue[]: File(s) attached to the trouble ticket. e.g. pictur of broken device, scaning of a bill or charge - `@type` string: When sub-classing, this defines the sub-class entity name - `@baseType` string: When sub-classing, this defines the super-class - `@schemaLocation` string, uri: A URI to a JSON-Schema file that defines additional attributes and relationships - `ref` AttachmentRef: Base entity schema for use in TMForum Open-APIs - `@type` string: When sub-classing, this defines the sub-class entity name - `@baseType` string: When sub-classing, this defines the super-class - `@schemaLocation` string, uri: A URI to a JSON-Schema file that defines additional attributes and relationships - `id` string: Unique identifier of a related entity. - `href` string: Reference of the related entity. - `name` string: Name of the related entity. - `@referredType` string: The actual type of the target instance when needed for disambiguation. - `description` string: A narrative text describing the content of the attachment - `url` string: Link to the attachment media/content - `value` Attachment: Base entity schema for use in TMForum Open-APIs - `@type` string: When sub-classing, this defines the sub-class entity name - `@baseType` string: When sub-classing, this defines the super-class - `@schemaLocation` string, uri: A URI to a JSON-Schema file that defines additional attributes and relationships - `id` string: Unique identifier for this particular attachment - `href` string: URI for this Attachment - `attachmentType` string: Attachment type such as video, picture - `content` string: The actual contents of the attachment object, if embedded, encoded as base64 - `description` string: A narrative text describing the content of the attachment - `mimeType` string: Attachment mime type such as extension file for video, picture and document - `name` string: The name of the attachment - `url` string: Uniform Resource Locator, is a web page address (a subset of URI) - `size` Quantity: An amount in a given unit - `amount` number, float: Numeric value in a given unit - `units` string: Unit - `validFor` TimePeriod: A period of time, either as a deadline (endDateTime only) a startDateTime only, or both - `endDateTime` string, date-time: End of the time period, using IETC-RFC-3339 format - `startDateTime` string, date-time: Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end - `channel` ChannelRef: Base entity schema for use in TMForum Open-APIs - `@type` string: When sub-classing, this defines the sub-class entity name - `@baseType` string: When sub-classing, this defines the super-class - `@schemaLocation` string, uri: A URI to a JSON-Schema file that defines additional attributes and relationships - `id` string: Unique identifier of a related entity. - `href` string: Reference of the related entity. - `name` string: Name of the related entity. - `@referredType` string: The actual type of the target instance when needed for disambiguation. - `note` Note[]: The note(s) that are associated to the ticket. - `@type` string: When sub-classing, this defines the sub-class entity name - `@baseType` string: When sub-classing, this defines the super-class - `@schemaLocation` string, uri: A URI to a JSON-Schema file that defines additional attributes and relationships - `id` string: Identifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation) - `author` string: Author of the note - `date` string, date-time: Date of the note - `text` string: Text of the note - `relatedEntity` RelatedEntity[]: An entity that is related to the ticket such as a bill, a product, etc. The entity against which the ticket is associated. - `@type` string: When sub-classing, this defines the sub-class entity name - `@baseType` string: When sub-classing, this defines the super-class - `@schemaLocation` string, uri: A URI to a JSON-Schema file that defines additional attributes and relationships - `id` string, required: Unique identifier of a related entity. - `href` string: Reference of the related entity. - `name` string: Name of the related entity. - `role` string, required: The role of an entity. - `@referredType` string, required: The actual type of the target instance when needed for disambiguation. - `relatedParty` RelatedParty[]: The related party(ies) that are associated to the ticket. - `@type` string: When sub-classing, this defines the sub-class entity name - `@baseType` string: When sub-classing, this defines the super-class - `@schemaLocation` string, uri: A URI to a JSON-Schema file that defines additional attributes and relationships - `id` string, required: Unique identifier of a related entity. - `href` string: Reference of the related entity. - `name` string: Name of the related entity. - `role` string: Role played by the related party - `@referredType` string, required: The actual type of the target instance when needed for disambiguation. - `status` 'submitted' | 'acknowledged' | 'rejected' | 'pending' | 'held' | 'inProgress' | 'cancelled' | 'closed' | 'resolved': Possible values for the status of the trouble ticket - `statusChange` StatusChange[]: The status change history that are associated to the ticket.Populated by the server - `@type` string: When sub-classing, this defines the sub-class entity name - `@baseType` string: When sub-classing, this defines the super-class - `@schemaLocation` string, uri: A URI to a JSON-Schema file that defines additional attributes and relationships - `changeDate` string, date-time: The date and time the status changed. - `changeReason` string: The reason why the status changed. - `status` string: The status of the trouble ticket - `troubleTicketRelationship` TroubleTicketRelationship[]: A list of trouble ticket relationships (TroubleTicketRelationship [*]). Represents a relationship between trouble tickets - `@type` string: When sub-classing, this defines the sub-class entity name - `@baseType` string: When sub-classing, this defines the super-class - `@schemaLocation` string, uri: A URI to a JSON-Schema file that defines additional attributes and relationships - `id` string: Unique identifier of the Trouble Ticket - `href` string: Reference of the Trouble Ticket - `name` string: Name of the Trouble Ticket - `relationshipType` string: Type of the Trouble Ticket relationship can be isChiled, dependent etc... ## Other responses - `204`: No Content - `400`: Bad Request - `401`: Unauthorized - `403`: Forbidden - `404`: Not Found - `405`: Method Not allowed - `409`: Conflict - `422`: Unprocessable Entity - `500`: Internal Server Error --- [API](https://skmtc.dev/bell/apis/trouble-ticket.md) - [All operations](https://skmtc.dev/bell/apis/trouble-ticket/llms.txt) - [OpenAPI document](https://skmtc.dev/bell/apis/trouble-ticket/revisions/ceffca30465c?raw)