Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Trouble Ticket Specification API
description: "**TMF API Reference : TMF - 621 Trouble Ticket**\nThe Trouble Ticket API provides a standardized client interface to Trouble Ticket Management Systems for creating, tracking and managing trouble tickets as a result of an issue or problem identified by a customer or another system. \nExamples of Trouble Ticket API originators (clients) include CRM applications, network management or fault management systems, or other Trouble Ticket management systems (e.g. B2B).\nThe API supports the ability to send requests to create a new trouble ticket specifying the nature and severity of the trouble or issue as well as all necessary related information. The API also includes mechanisms to search for and update existing trouble tickets. Notifications are defined to provide information when a trouble ticket has been updated, including status changes. A basic set of states of a trouble ticket has been specified (as an example) to handle trouble ticket lifecycle management.\nTrouble Ticketing API manages trouble ticket resource:\n -\tA trouble ticket represents a record, or an issue raised by requestor that need to be solved, used for reporting and managing the resolution of problems, incidents or request \n -\tMain trouble ticket attributes are its description, severity, type, related dates (creation, expected resolution, resolution), state and related information (change reason and change date), related parties (originator, owner, reviser, etc.), related entities (product, product order, customer bill) and notes \n Trouble Ticket API performs the following operations on trouble ticket: \n -\tRetrieval of a trouble ticket or a collection of trouble ticket depending on filter criteria \n -\tPartial update of a trouble ticket \n -\tCreation of a trouble ticket \n \tNotification of events on trouble ticket: \n \t-\tTrouble ticket state change \n \t-\tTrouble ticket attribute value change \n \t-\tTrouble ticket resoled \n \t-\tTrouble ticket delete (typically restricted to admin role) \n \t-\tTrouble ticket created \n \t-\tTrouble ticket Information required \n Trouble Ticket API performs the following operations on trouble ticket specification \n-\tRetrieval of a trouble ticket specification or a collection of trouble ticket specification depending on filter criteria \n -\tPartial update of a trouble ticket specification \n-\tCreation of a trouble ticket specification \n-\tNotification of events on trouble ticket specification: \n \t-\tTrouble ticket specification state change \n \t-\tTrouble ticket specification attribute value change \n \t-\tTrouble ticket specification delete (typically restricted to admin role) \n \t-\tTrouble ticket specification created "
version: 5.0.1
x-generation-tooling-version: v8.5.3-hotfix.0
x-generation-data-model-version: unknown
servers:
- url: '{apiRoot}/tmf-api/troubleTicket/v5/'
variables:
apiRoot:
default: https://serverRoot
enum:
- https://serverRoot
tags:
- name: troubleTicketSpecification
description: Operations for TroubleTicketSpecification Resource
paths:
/troubleTicketSpecification:
get:
tags:
- troubleTicketSpecification
summary: TM Forum List or Find TroubleTicketSpecification Objects
description: List or find TroubleTicketSpecification objects
operationId: listTroubleTicketSpecification
parameters:
- $ref: '#/components/parameters/Fields'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Before'
- $ref: '#/components/parameters/After'
- $ref: '#/components/parameters/Sort'
- $ref: '#/components/parameters/Filter'
responses:
'200':
$ref: '#/components/responses/200TroubleTicketSpecificationArray'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'503':
$ref: '#/components/responses/503'
post:
tags:
- troubleTicketSpecification
summary: TM Forum Creates a TroubleTicketSpecification
description: This operation creates a TroubleTicketSpecification entity.
operationId: createTroubleTicketSpecification
parameters:
- $ref: '#/components/parameters/Fields'
requestBody:
$ref: '#/components/requestBodies/TroubleTicketSpecification_FVO'
responses:
'201':
$ref: '#/components/responses/201TroubleTicketSpecification'
'202':
description: Accepted
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'409':
$ref: '#/components/responses/409'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'503':
$ref: '#/components/responses/503'
/troubleTicketSpecification/{id}:
get:
tags:
- troubleTicketSpecification
summary: TM Forum Retrieves a TroubleTicketSpecification by ID
description: This operation retrieves a TroubleTicketSpecification entity. Attribute selection enabled for all first level attributes.
operationId: retrieveTroubleTicketSpecification
parameters:
- $ref: '#/components/parameters/Id'
- $ref: '#/components/parameters/Fields'
responses:
'200':
$ref: '#/components/responses/200TroubleTicketSpecification_Get'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'503':
$ref: '#/components/responses/503'
patch:
tags:
- troubleTicketSpecification
summary: TM Forum Updates Partially a TroubleTicketSpecification
description: This operation updates partially a TroubleTicketSpecification entity.
operationId: patchTroubleTicketSpecification
parameters:
- $ref: '#/components/parameters/Id'
- $ref: '#/components/parameters/Fields'
requestBody:
$ref: '#/components/requestBodies/TroubleTicketSpecification_MVO'
responses:
'200':
$ref: '#/components/responses/200TroubleTicketSpecification_Patch'
'202':
description: Accepted
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'409':
$ref: '#/components/responses/409'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'503':
$ref: '#/components/responses/503'
delete:
tags:
- troubleTicketSpecification
summary: TM Forum Deletes a TroubleTicketSpecification
description: This operation deletes a TroubleTicketSpecification entity.
operationId: deleteTroubleTicketSpecification
parameters:
- $ref: '#/components/parameters/Id'
responses:
'202':
$ref: '#/components/responses/202'
'204':
$ref: '#/components/responses/204'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'409':
$ref: '#/components/responses/409'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'503':
$ref: '#/components/responses/503'
components:
schemas:
CharacteristicValueSpecification_FVO:
allOf:
- $ref: '#/components/schemas/Extensible'
- type: object
description: 'specification of a value (number or text or an object) that can be assigned to a Characteristic. This is an abstract base class, the actual value is in one of the strongly-typed subclasses : BooleanArrayCharacteristicValueSpecification, BooleanCharacteristicValueSpecification, FloatArrayCharacteristicValueSpecification, FloatCharacteristicValueSpecification, IntegerArrayCharacteristicValueSpecification, IntegerCharacteristicValueSpecification, MapArrayCharacteristicValueSpecification, MapCharacteristicValueSpecification, NumberArrayCharacteristicValueSpecification, NumberCharacteristicValueSpecification, ObjectArrayCharacteristicValueSpecification, ObjectCharacteristicValueSpecification, StringArrayCharacteristicValueSpecification, StringCharacteristicValueSpecification...'
properties:
valueType:
type: string
description: A kind of value that the characteristic value can take on, such as numeric, text and so forth
isDefault:
type: boolean
description: If true, the Boolean Indicates if the value is the default value for a characteristic
unitOfMeasure:
type: string
description: A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot.
validFor:
$ref: '#/components/schemas/TimePeriod'
valueFrom:
type: integer
description: The low range value that a characteristic can take on
valueTo:
type: integer
description: The upper range value that a characteristic can take on
rangeInterval:
type: string
description: An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are "open", "closed", "closedBottom" and "closedTop".
regex:
type: string
description: A regular expression constraint for given value
discriminator:
propertyName: '@type'
mapping:
BooleanArrayCharacteristicValueSpecification: '#/components/schemas/BooleanArrayCharacteristicValueSpecification_FVO'
BooleanCharacteristicValueSpecification: '#/components/schemas/BooleanCharacteristicValueSpecification_FVO'
CharacteristicValueSpecification: '#/components/schemas/CharacteristicValueSpecification_FVO'
FloatArrayCharacteristicValueSpecification: '#/components/schemas/FloatArrayCharacteristicValueSpecification_FVO'
FloatCharacteristicValueSpecification: '#/components/schemas/FloatCharacteristicValueSpecification_FVO'
IntegerArrayCharacteristicValueSpecification: '#/components/schemas/IntegerArrayCharacteristicValueSpecification_FVO'
IntegerCharacteristicValueSpecification: '#/components/schemas/IntegerCharacteristicValueSpecification_FVO'
MapArrayCharacteristicValueSpecification: '#/components/schemas/MapArrayCharacteristicValueSpecification_FVO'
MapCharacteristicValueSpecification: '#/components/schemas/MapCharacteristicValueSpecification_FVO'
NumberArrayCharacteristicValueSpecification: '#/components/schemas/NumberArrayCharacteristicValueSpecification_FVO'
NumberCharacteristicValueSpecification: '#/components/schemas/NumberCharacteristicValueSpecification_FVO'
ObjectArrayCharacteristicValueSpecification: '#/components/schemas/ObjectArrayCharacteristicValueSpecification_FVO'
ObjectCharacteristicValueSpecification: '#/components/schemas/ObjectCharacteristicValueSpecification_FVO'
StringArrayCharacteristicValueSpecification: '#/components/schemas/StringArrayCharacteristicValueSpecification_FVO'
StringCharacteristicValueSpecification: '#/components/schemas/StringCharacteristicValueSpecification_FVO'
Error:
discriminator:
propertyName: '@type'
mapping:
Error: '#/components/schemas/Error'
allOf:
- $ref: '#/components/schemas/Extensible'
- type: object
required:
- code
- reason
properties:
code:
type: string
description: Application relevant detail, defined in the API or a common list.
reason:
type: string
description: Explanation of the reason for the error which can be shown to a client user.
message:
type: string
description: More details and corrective actions related to the error which can be shown to a client user.
status:
type: string
description: HTTP Error code extension
referenceError:
type: string
description: URI of documentation describing the error.
description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
CharacteristicValueSpecification_MVO:
allOf:
- $ref: '#/components/schemas/Extensible'
- type: object
description: 'specification of a value (number or text or an object) that can be assigned to a Characteristic. This is an abstract base class, the actual value is in one of the strongly-typed subclasses : BooleanArrayCharacteristicValueSpecification, BooleanCharacteristicValueSpecification, FloatArrayCharacteristicValueSpecification, FloatCharacteristicValueSpecification, IntegerArrayCharacteristicValueSpecification, IntegerCharacteristicValueSpecification, MapArrayCharacteristicValueSpecification, MapCharacteristicValueSpecification, NumberArrayCharacteristicValueSpecification, NumberCharacteristicValueSpecification, ObjectArrayCharacteristicValueSpecification, ObjectCharacteristicValueSpecification, StringArrayCharacteristicValueSpecification, StringCharacteristicValueSpecification...'
properties:
valueType:
type: string
description: A kind of value that the characteristic value can take on, such as numeric, text and so forth
isDefault:
type: boolean
description: If true, the Boolean Indicates if the value is the default value for a characteristic
unitOfMeasure:
type: string
description: A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot.
validFor:
$ref: '#/components/schemas/TimePeriod'
valueFrom:
type: integer
description: The low range value that a characteristic can take on
valueTo:
type: integer
description: The upper range value that a characteristic can take on
rangeInterval:
type: string
description: An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are "open", "closed", "closedBottom" and "closedTop".
regex:
type: string
description: A regular expression constraint for given value
discriminator:
propertyName: '@type'
mapping:
BooleanArrayCharacteristicValueSpecification: '#/components/schemas/BooleanArrayCharacteristicValueSpecification_MVO'
BooleanCharacteristicValueSpecification: '#/components/schemas/BooleanCharacteristicValueSpecification_MVO'
CharacteristicValueSpecification: '#/components/schemas/CharacteristicValueSpecification_MVO'
FloatArrayCharacteristicValueSpecification: '#/components/schemas/FloatArrayCharacteristicValueSpecification_MVO'
FloatCharacteristicValueSpecification: '#/components/schemas/FloatCharacteristicValueSpecification_MVO'
IntegerArrayCharacteristicValueSpecification: '#/components/schemas/IntegerArrayCharacteristicValueSpecification_MVO'
IntegerCharacteristicValueSpecification: '#/components/schemas/IntegerCharacteristicValueSpecification_MVO'
MapArrayCharacteristicValueSpecification: '#/components/schemas/MapArrayCharacteristicValueSpecification_MVO'
MapCharacteristicValueSpecification: '#/components/schemas/MapCharacteristicValueSpecification_MVO'
NumberArrayCharacteristicValueSpecification: '#/components/schemas/NumberArrayCharacteristicValueSpecification_MVO'
NumberCharacteristicValueSpecification: '#/components/schemas/NumberCharacteristicValueSpecification_MVO'
ObjectArrayCharacteristicValueSpecification: '#/components/schemas/ObjectArrayCharacteristicValueSpecification_MVO'
ObjectCharacteristicValueSpecification: '#/components/schemas/ObjectCharacteristicValueSpecification_MVO'
StringArrayCharacteristicValueSpecification: '#/components/schemas/StringArrayCharacteristicValueSpecification_MVO'
StringCharacteristicValueSpecification: '#/components/schemas/StringCharacteristicValueSpecification_MVO'
PartyRoleRef_MVO:
allOf:
- $ref: '#/components/schemas/EntityRef_MVO'
- type: object
description: Party role reference. A party role represents the part played by a party in a given context.
properties:
partyId:
type: string
description: The identifier of the engaged party that is linked to the PartyRole object.
partyName:
type: string
description: The name of the engaged party that is linked to the PartyRole object.
discriminator:
propertyName: '@type'
mapping:
PartyRoleRef: '#/components/schemas/PartyRoleRef_MVO'
PartyRoleRef_FVO:
allOf:
- $ref: '#/components/schemas/EntityRef'
- type: object
description: Party role reference. A party role represents the part played by a party in a given context.
properties:
partyId:
type: string
description: The identifier of the engaged party that is linked to the PartyRole object.
partyName:
type: string
description: The name of the engaged party that is linked to the PartyRole object.
discriminator:
propertyName: '@type'
mapping:
PartyRoleRef: '#/components/schemas/PartyRoleRef_FVO'
TroubleTicketSpecification_FVO:
allOf:
- $ref: '#/components/schemas/Entity'
- type: object
description: TroubleTicketSpecification defines the common attributes and relationships of a set of related trouble tickets, while trouble ticket defines a specific instance that is based on a particular trouble ticket specification.
properties:
name:
type: string
description: Name given to the specification
description:
type: string
description: Description of the specification
lifecycleStatus:
type: string
description: Used to indicate the current lifecycle status of this specification such as inDesign,active,rejected,retired
specCharacteristic:
type: array
description: List of characteristics that the entity can take
items:
$ref: '#/components/schemas/CharacteristicSpecification_FVO'
relatedParty:
type: array
description: Parties who manage or otherwise have an interest in this specification
items:
$ref: '#/components/schemas/RelatedPartyRefOrPartyRoleRef_FVO'
validFor:
$ref: '#/components/schemas/TimePeriod'
version:
type: string
description: The version of the trouble ticket specification, in case it is desired to maintain multiple versions of trouble ticket specifications
required:
- name
discriminator:
propertyName: '@type'
mapping:
TroubleTicketSpecification: '#/components/schemas/TroubleTicketSpecification_FVO'
CharacteristicValueSpecification:
allOf:
- $ref: '#/components/schemas/Extensible'
- type: object
description: 'specification of a value (number or text or an object) that can be assigned to a Characteristic. This is an abstract base class, the actual value is in one of the strongly-typed subclasses : BooleanArrayCharacteristicValueSpecification, BooleanCharacteristicValueSpecification, FloatArrayCharacteristicValueSpecification, FloatCharacteristicValueSpecification, IntegerArrayCharacteristicValueSpecification, IntegerCharacteristicValueSpecification, MapArrayCharacteristicValueSpecification, MapCharacteristicValueSpecification, NumberArrayCharacteristicValueSpecification, NumberCharacteristicValueSpecification, ObjectArrayCharacteristicValueSpecification, ObjectCharacteristicValueSpecification, StringArrayCharacteristicValueSpecification, StringCharacteristicValueSpecification...'
properties:
valueType:
type: string
description: A kind of value that the characteristic value can take on, such as numeric, text and so forth
isDefault:
type: boolean
description: If true, the Boolean Indicates if the value is the default value for a characteristic
unitOfMeasure:
type: string
description: A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot.
validFor:
$ref: '#/components/schemas/TimePeriod'
valueFrom:
type: integer
description: The low range value that a characteristic can take on
valueTo:
type: integer
description: The upper range value that a characteristic can take on
rangeInterval:
type: string
description: An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are "open", "closed", "closedBottom" and "closedTop".
regex:
type: string
description: A regular expression constraint for given value
discriminator:
propertyName: '@type'
mapping:
BooleanArrayCharacteristicValueSpecification: '#/components/schemas/BooleanArrayCharacteristicValueSpecification'
BooleanCharacteristicValueSpecification: '#/components/schemas/BooleanCharacteristicValueSpecification'
CharacteristicValueSpecification: '#/components/schemas/CharacteristicValueSpecification'
FloatArrayCharacteristicValueSpecification: '#/components/schemas/FloatArrayCharacteristicValueSpecification'
FloatCharacteristicValueSpecification: '#/components/schemas/FloatCharacteristicValueSpecification'
IntegerArrayCharacteristicValueSpecification: '#/components/schemas/IntegerArrayCharacteristicValueSpecification'
IntegerCharacteristicValueSpecification: '#/components/schemas/IntegerCharacteristicValueSpecification'
MapArrayCharacteristicValueSpecification: '#/components/schemas/MapArrayCharacteristicValueSpecification'
MapCharacteristicValueSpecification: '#/components/schemas/MapCharacteristicValueSpecification'
NumberArrayCharacteristicValueSpecification: '#/components/schemas/NumberArrayCharacteristicValueSpecification'
NumberCharacteristicValueSpecification: '#/components/schemas/NumberCharacteristicValueSpecification'
ObjectArrayCharacteristicValueSpecification: '#/components/schemas/ObjectArrayCharacteristicValueSpecification'
ObjectCharacteristicValueSpecification: '#/components/schemas/ObjectCharacteristicValueSpecification'
StringArrayCharacteristicValueSpecification: '#/components/schemas/StringArrayCharacteristicValueSpecification'
StringCharacteristicValueSpecification: '#/components/schemas/StringCharacteristicValueSpecification'
RelatedPartyRefOrPartyRoleRef_MVO:
allOf:
- $ref: '#/components/schemas/Extensible'
- type: object
description: RelatedParty reference. A related party defines party or party role or its reference, linked to a specific entity
properties:
role:
description: Role played by the related party or party role in the context of the specific entity it is linked to. Such as 'initiator', 'customer', 'salesAgent', 'user'
type: string
partyOrPartyRole:
$ref: '#/components/schemas/PartyRefOrPartyRoleRef_MVO'
discriminator:
propertyName: '@type'
mapping:
RelatedPartyRefOrPartyRoleRef: '#/components/schemas/RelatedPartyRefOrPartyRoleRef_MVO'
TimePeriod:
type: object
description: A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
properties:
startDateTime:
description: Start of the time period, using IETC-RFC-3339 format
type: string
format: date-time
example: '1985-04-12T23:20:50.52Z'
endDateTime:
description: End of the time period, using IETC-RFC-3339 format
type: string
format: date-time
example: '1985-04-12T23:20:50.52Z'
TroubleTicketSpecification:
allOf:
- $ref: '#/components/schemas/Entity'
- type: object
description: TroubleTicketSpecification defines the common attributes and relationships of a set of related trouble tickets, while trouble ticket defines a specific instance that is based on a particular trouble ticket specification.
properties:
name:
type: string
description: Name given to the specification
description:
type: string
description: Description of the specification
lifecycleStatus:
type: string
description: Used to indicate the current lifecycle status of this specification such as inDesign,active,rejected,retired
specCharacteristic:
type: array
description: List of characteristics that the entity can take
items:
$ref: '#/components/schemas/CharacteristicSpecification'
relatedParty:
type: array
description: Parties who manage or otherwise have an interest in this specification
items:
$ref: '#/components/schemas/RelatedPartyRefOrPartyRoleRef'
validFor:
$ref: '#/components/schemas/TimePeriod'
version:
type: string
description: The version of the trouble ticket specification, in case it is desired to maintain multiple versions of trouble ticket specifications
creationDate:
type: string
format: date-time
description: The date on which the trouble ticket specification was created
lastUpdate:
type: string
format: date-time
description: Date and time of the last update of the specification
discriminator:
propertyName: '@type'
mapping:
TroubleTicketSpecification: '#/components/schemas/TroubleTicketSpecification'
Entity:
type: object
description: Base entity schema for use in TMForum Open-APIs. Property.
allOf:
- $ref: '#/components/schemas/Extensible'
- $ref: '#/components/schemas/Addressable'
CharacteristicSpecificationRelationship_FVO:
allOf:
- $ref: '#/components/schemas/Extensible'
- type: object
description: An aggregation, migration, substitution, dependency or exclusivity relationship between/among Characteristic specifications. The specification characteristic is embedded within the specification whose ID and href are in this entity, and identified by its ID.
properties:
relationshipType:
type: string
description: Type of relationship such as aggregation, migration, substitution, dependency, exclusivity
name:
type: string
description: Name of the target characteristic within the specification
characteristicSpecificationId:
type: string
description: Unique identifier of the characteristic within the specification
parentSpecificationHref:
type: string
format: uri
description: Hyperlink reference to the parent specification containing the target characteristic
validFor:
$ref: '#/components/schemas/TimePeriod'
parentSpecificationId:
type: string
description: Unique identifier of the parent specification containing the target characteristic
required:
- parentSpecificationId
- name
- relationshipType
discriminator:
propertyName: '@type'
mapping:
CharacteristicSpecificationRelationship: '#/components/schemas/CharacteristicSpecificationRelationship_FVO'
PartyRef:
type: object
description: A Party reference
allOf:
- $ref: '#/components/schemas/EntityRef'
discriminator:
propertyName: '@type'
mapping:
PartyRef: '#/components/schemas/PartyRef'
CharacteristicSpecificationRelationship_MVO:
allOf:
- $ref: '#/components/schemas/Extensible'
- type: object
description: An aggregation, migration, substitution, dependency or exclusivity relationship between/among Characteristic specifications. The specification characteristic is embedded within the specification whose ID and href are in this entity, and identified by its ID.
properties:
relationshipType:
type: string
description: Type of relationship such as aggregation, migration, substitution, dependency, exclusivity
name:
type: string
description: Name of the target characteristic within the specification
characteristicSpecificationId:
type: string
description: Unique identifier of the characteristic within the specification
parentSpecificationHref:
type: string
format: uri
description: Hyperlink reference to the parent specification containing the target characteristic
validFor:
$ref: '#/components/schemas/TimePeriod'
parentSpecificationId:
type: string
description: Unique identifier of the parent specification containing the target characteristic
discriminator:
propertyName: '@type'
mapping:
CharacteristicSpecificationRelationship: '#/components/schemas/CharacteristicSpecificationRelationship_MVO'
RelatedPartyRefOrPartyRoleRef_FVO:
allOf:
- $ref: '#/components/schemas/Extensible'
- type: object
description: RelatedParty reference. A related party defines party or party role or its reference, linked to a specific entity
properties:
role:
description: Role played by the related party or party role in the context of the specific entity it is linked to. Such as 'initiator', 'customer', 'salesAgent', 'user'
type: string
partyOrPartyRole:
$ref: '#/components/schemas/PartyRefOrPartyRoleRef_FVO'
required:
- role
disc
# --- truncated at 32 KB (80 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/tm-forum/refs/heads/main/openapi/tm-forum-troubleticketspecification-api-openapi.yml