Bell Canada Change Request API

openapi: 3.2.0
info:
  title: ChangeManagement Change Request API
  description: '## TMF API Reference : TMF 655 The Change Management API provides the standard integration capabilities between external applications and Change Management Application'
  version: 4.2.0
servers:
- url: https://serverRoot/tmf-api/ChangeManagement/v4/
tags:
- name: changeRequest
paths:
  /changeRequest:
    get:
      operationId: listChangeRequest
      summary: List or find ChangeRequest objects
      description: This operation list or find ChangeRequest entities
      tags:
      - changeRequest
      parameters:
      - in: query
        name: fields
        required: false
        description: Comma-separated properties to be provided in response
        schema:
          type: string
      - in: query
        name: offset
        required: false
        description: Requested index for start of resources to be provided in response
        schema:
          type: integer
      - in: query
        name: limit
        required: false
        description: Requested number of resources to be provided in response
        schema:
          type: integer
      - in: query
        name: sort
        required: false
        description: To have the output sorted by fields. Can support one or many fields, as well as ascending and descending sort order
        schema:
          type: string
      - in: query
        name: expand
        required: false
        description: Lists the sub-entities to expand along with the depth value. Empty means expand all at depth level N
        schema:
          type: string
      - in: query
        name: depth
        required: false
        description: Depth level where objects are dereferenced and inserted as values into the response
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers:
            X-Result-Count:
              description: Actual number of items returned in the response body
              schema:
                type: integer
            X-Total-Count:
              description: Total number of items matching criteria
              schema:
                type: integer
          content:
            application/json;charset=utf-8:
              schema:
                items:
                  $ref: '#/components/schemas/ChangeRequest'
                type: array
        '400':
          description: Bad Request
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '405':
          description: Method Not allowed
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Conflict
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      operationId: createChangeRequest
      summary: Creates a ChangeRequest
      description: This operation creates a ChangeRequest entity.
      tags:
      - changeRequest
      responses:
        '201':
          description: Created
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/ChangeRequest'
        '202':
          description: Accepted
        '400':
          description: Bad Request
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '405':
          description: Method Not allowed
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Conflict
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Unprocessable Entity
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json;charset=utf-8:
            schema:
              $ref: '#/components/schemas/ChangeRequest_Create'
        description: The ChangeRequest to be created
        required: true
  /changeRequest/{id}:
    get:
      operationId: retrieveChangeRequest
      summary: Retrieves a ChangeRequest by ID
      description: This operation retrieves a ChangeRequest entity. Attribute selection is enabled for all first level attributes.
      tags:
      - changeRequest
      parameters:
      - in: path
        name: id
        required: true
        description: Identifier of the ChangeRequest
        schema:
          type: string
      - in: query
        name: fields
        required: false
        description: Comma-separated properties to be provided in response
        schema:
          type: string
      - in: query
        name: expand
        required: false
        description: Lists the sub-entities to expand along with the depth value. Empty means expand all at depth level N
        schema:
          type: string
      - in: query
        name: depth
        required: false
        description: Depth level where objects are dereferenced and inserted as values into the response
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/ChangeRequest'
        '400':
          description: Bad Request
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '405':
          description: Method Not allowed
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Conflict
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
    patch:
      operationId: patchChangeRequest
      summary: Updates partially a ChangeRequest
      description: This operation updates partially a ChangeRequest entity.
      tags:
      - changeRequest
      parameters:
      - in: path
        name: id
        required: true
        description: Identifier of the ChangeRequest
        schema:
          type: string
      responses:
        '200':
          description: Updated
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/ChangeRequest'
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '405':
          description: Method Not allowed
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Conflict
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Unprocessable Entity
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json;charset=utf-8:
            schema:
              $ref: '#/components/schemas/ChangeRequest_Update'
        description: The ChangeRequest to be updated
        required: true
    delete:
      operationId: deleteChangeRequest
      summary: Deletes a ChangeRequest
      description: This operation deletes a ChangeRequest entity.
      tags:
      - changeRequest
      parameters:
      - in: path
        name: id
        required: true
        description: Identifier of the ChangeRequest
        schema:
          type: string
      responses:
        '204':
          description: Deleted
        '400':
          description: Bad Request
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '405':
          description: Method Not allowed
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Conflict
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    AttachmentRefOrValue:
      description: An attachment by value or by reference. An attachment complements the description of an element, for example through a document, a video, a picture.
      properties:
        ref:
          $ref: '#/components/schemas/AttachmentRef'
          description: A reference to the Attachment.
        value:
          $ref: '#/components/schemas/Attachment'
          description: The Attachment (as a value).
        '@baseType':
          type: string
          description: When sub-classing, this defines the super-class
        '@schemaLocation':
          type: string
          description: A URI to a JSON-Schema file that defines additional attributes and relationships
        '@type':
          type: string
          description: When sub-classing, this defines the sub-class entity name
    ChangeRequestStatusType:
      type: string
      description: Possible values for the state of the change request
      enum:
      - acknowledged
      - requestForAuthorization
      - waitForApproval
      - approved
      - scheduled
      - postImplementationReview
      - fallbackExecution
      - cancelled
      - rejected
      - inProgress
      - failed
      - completed
    RelatedParty:
      description: Related Entity reference. A related party defines party or party role linked to a specific entity.
      allOf:
      - $ref: '#/components/schemas/Entity'
      - required:
        - id
        - '@referredType'
        properties:
          id:
            type: string
            description: unique identifier
          href:
            type: string
            format: uri
            description: Hyperlink reference
          name:
            type: string
            description: Name of the related entity.
          role:
            type: string
            description: Role played by the related party
          '@referredType':
            type: string
            description: The actual type of the target instance when needed for disambiguation.
    ChangeRequestRelationship:
      allOf:
      - $ref: '#/components/schemas/Entity'
      - required:
        - relationshipType
        properties:
          id:
            type: string
            description: unique identifier
          href:
            type: string
            format: uri
            description: Hyperlink reference
          relationshipType:
            type: string
          changeRequest:
            $ref: '#/components/schemas/ChangeRequestRefOrValue'
          changeRequestRelationshipCharacteristic:
            type: array
            items:
              $ref: '#/components/schemas/Characteristic'
    AttachmentRef:
      description: Attachment reference. An attachment complements the description of an element (for instance a product) through video, pictures
      allOf:
      - $ref: '#/components/schemas/EntityRef'
      - properties:
          description:
            type: string
            description: A narrative text describing the content of the attachment
          url:
            type: string
            format: uri
            description: Link to the attachment media/content
    ChangeRequestRef:
      description: Reference to a Change Request
      allOf:
      - $ref: '#/components/schemas/EntityRef'
    Record:
      description: A record in a worklog.
      allOf:
      - $ref: '#/components/schemas/Entity'
      - properties:
          id:
            type: string
            description: unique identifier
          href:
            type: string
            format: uri
            description: Hyperlink reference
          dateTime:
            type: string
            format: date-time
            description: The date time that a record is generated.
          description:
            type: string
            description: The detail description in a record.
          supportPerson:
            type: string
            description: The person who logged that record.
    Entity:
      discriminator:
        propertyName: '@type'
      description: Base entity schema for use in TMForum Open-APIs
      properties:
        '@type':
          type: string
          description: When sub-classing, this defines the sub-class entity name
        '@baseType':
          type: string
          description: When sub-classing, this defines the super-class
        '@schemaLocation':
          type: string
          format: uri
          description: A URI to a JSON-Schema file that defines additional attributes and relationships
    RelatedEntity:
      description: A reference to an entity, where the type of the entity is not known in advance.
      allOf:
      - $ref: '#/components/schemas/Entity'
      - required:
        - id
        - role
        - '@referredType'
        properties:
          id:
            type: string
            description: unique identifier
          href:
            type: string
            format: uri
            description: Hyperlink reference
          name:
            type: string
            description: Name of the related entity.
          role:
            type: string
            description: The role of an entity.
          '@referredType':
            type: string
            description: The actual type of the target instance when needed for disambiguation.
    ImpactEntity:
      description: A reference to an imapcted entity
      allOf:
      - $ref: '#/components/schemas/Entity'
      - required:
        - id
        - role
        - '@referredType'
        properties:
          id:
            type: string
            description: unique identifier
          href:
            type: string
            format: uri
            description: Hyperlink reference
          action:
            type: string
            description: The action on an entity.
          name:
            type: string
            description: Name of the related entity.
          role:
            type: string
            description: The role of an entity.
          '@referredType':
            type: string
            description: The actual type of the target instance when needed for disambiguation.
    ChangeRequestRefOrValue:
      description: A Service to be created defined by value or existing defined by reference. The polymorphic attributes @type, @schemaLocation & @referredType are related to the Service entity and not the RelatedServiceRefOrValue class itself
      properties:
        ref:
          $ref: '#/components/schemas/ChangeRequestRef'
          description: A reference to the ChangeRequest.
        value:
          $ref: '#/components/schemas/ChangeRequest'
          description: The ChangeRequest (as a value).
        '@baseType':
          type: string
          description: When sub-classing, this defines the super-class
        '@schemaLocation':
          type: string
          description: A URI to a JSON-Schema file that defines additional attributes and relationships
        '@type':
          type: string
          description: When sub-classing, this defines the sub-class entity name
    Characteristic:
      discriminator:
        propertyName: '@type'
      type: object
      description: Describes a given characteristic of an object or entity through a name/value pair.
      properties:
        id:
          type: string
          description: Unique identifier of the characteristic
        name:
          type: string
          description: Name of the characteristic
        valueType:
          type: string
          description: Data type of the value of the characteristic
        characteristicRelationship:
          type: array
          items:
            $ref: '#/components/schemas/CharacteristicRelationship'
        '@schemaLocation':
          type: string
          format: uri
          description: A URI to a JSON-Schema file that defines additional attributes and relationships
        '@baseType':
          type: string
          description: When sub-classing, this defines the super-class
        '@type':
          type: string
          description: When sub-classing, this defines the sub-class Extensible name
    Attachment:
      description: Complements the description of an element (for instance a product) through video, pictures...
      allOf:
      - $ref: '#/components/schemas/Entity'
      - properties:
          id:
            type: string
            description: Unique identifier for this particular attachment
          href:
            type: string
            format: uri
            description: URI for this Attachment
          attachmentType:
            type: string
            description: Attachment type such as video, picture
          content:
            type: string
            format: base64
            description: The actual contents of the attachment object, if embedded, encoded as base64
          description:
            type: string
            description: A narrative text describing the content of the attachment
          mimeType:
            type: string
            description: Attachment mime type such as extension file for video, picture and document
          name:
            type: string
            description: The name of the attachment
          url:
            type: string
            format: uri
            description: Uniform Resource Locator, is a web page address (a subset of URI)
          size:
            $ref: '#/components/schemas/Quantity'
            description: The size of the attachment.
          validFor:
            $ref: '#/components/schemas/TimePeriod'
            description: The period of time for which the attachment is valid
    Task:
      description: A step or task along in the process of implementation a Change Request.
      allOf:
      - $ref: '#/components/schemas/Entity'
      - properties:
          id:
            type: string
            description: unique identifier
          href:
            type: string
            format: uri
            description: Hyperlink reference
          description:
            type: string
            description: The description of the task.
          name:
            type: string
            description: The name of the task.
          state:
            type: string
            description: The state of the task.
    ChangeRequest:
      description: "Change Request is a type of request which can be used for the management and control of Change Management process \n -within a service provider organisation or \n -between a customer and a service provider or \n -between a service provider and a partner and vice versa."
      allOf:
      - $ref: '#/components/schemas/Entity'
      - required:
        - targetEntity
        properties:
          id:
            type: string
            description: Identifier of a Change Request. It is created on repository side (a Change Management system)
          href:
            type: string
            format: uri
            description: Hyperlink to access a change request
          actualEndTime:
            type: string
            format: date-time
            description: Date and time when the change implementation actually finished
          actualStartTime:
            type: string
            format: date-time
            description: Date and time when the change implementation actually started
          channel:
            type: string
            description: A channel represents the way the Change Request was created
          completionDate:
            type: string
            format: date-time
            description: Date and time when the change request is confirmed to be completed
          description:
            type: string
            description: Description of the change request
          impact:
            type: string
            description: Indicates the impact of this change
          lastUpdateDate:
            type: string
            format: date-time
            description: Date and time when the change request was updated
          plannedEndTime:
            type: string
            format: date-time
            description: Date and time when the change implementation is planned to be finished
          plannedStartTime:
            type: string
            format: date-time
            description: Date and time when the change implementation is planned to be started
          priority:
            type: string
            description: Used by consumers to prioritize a change request in Change Management system
          requestDate:
            type: string
            format: date-time
            description: Date and time when the change request is raised
          requestType:
            type: string
            description: Indicates the type of the change request
          risk:
            type: string
            description: The risk to implement this change request
          riskMitigationPlan:
            type: string
            description: The risk mitigation plan
          riskValue:
            type: string
            description: The additional cost if the risk will happen
          scheduledDate:
            type: string
            format: date-time
            description: Date and time that the schedule is made
          statusChangeDate:
            type: string
            format: date-time
            description: Date and time when the change request status was changed
          statusChangeReason:
            type: string
            description: Reason of the status change
          attachment:
            description: The attachments of the communication message (when it is email type)
            type: array
            items:
              $ref: '#/components/schemas/AttachmentRefOrValue'
          budget:
            $ref: '#/components/schemas/Money'
          changeRelationship:
            type: array
            items:
              $ref: '#/components/schemas/ChangeRequestRelationship'
          changeRequestCharacteristic:
            type: array
            items:
              $ref: '#/components/schemas/Characteristic'
          externalReference:
            type: array
            items:
              $ref: '#/components/schemas/ExternalReference'
          impactEntity:
            type: array
            items:
              $ref: '#/components/schemas/ImpactEntity'
          location:
            $ref: '#/components/schemas/RelatedPlaceRefOrValue'
            description: A list of places (Place [*]). Used to define a place useful for the service (for example a geographical place whre the service is installed)
          note:
            type: array
            items:
              $ref: '#/components/schemas/Note'
          problemTicket:
            type: array
            items:
              $ref: '#/components/schemas/ServiceProblemRef'
          relatedParty:
            description: The parties involved in the change request
            type: array
            items:
              $ref: '#/components/schemas/RelatedParty'
          resolution:
            $ref: '#/components/schemas/Resolution'
          sla:
            type: array
            items:
              $ref: '#/components/schemas/SLARef'
          specification:
            $ref: '#/components/schemas/EntitySpecificationRef'
          status:
            $ref: '#/components/schemas/ChangeRequestStatusType'
          targetEntity:
            type: array
            items:
              $ref: '#/components/schemas/RelatedEntity'
            minItems: 1
          troubleTicket:
            type: array
            items:
              $ref: '#/components/schemas/TroubleTicketRef'
          workLog:
            type: array
            items:
              $ref: '#/components/schemas/WorkLog'
    ChangeRequest_Update:
      description: "Change Request is a type of request which can be used for the management and control of Change Management process \n -within a service provider organisation or \n -between a customer and a service provider or \n -between a service provider and a partner and vice versa.\nSkipped properties: id,href,@baseType,@schemaLocation,@type"
      allOf:
      - $ref: '#/components/schemas/Entity'
      - required:
        - targetEntity
        properties:
          actualEndTime:
            type: string
            format: date-time
            description: Date and time when the change implementation actually finished
          actualStartTime:
            type: string
            format: date-time
            description: Date and time when the change implementation actually started
          channel:
            type: string
            description: A channel represents the way the Change Request was created
          completionDate:
            type: string
            format: date-time
            description: Date and time when the change request is confirmed to be completed
          description:
            type: string
            description: Description of the change request
          impact:
            type: string
            description: Indicates the impact of this change
          lastUpdateDate:
            type: string
            format: date-time
            description: Date and time when the change request was updated
          plannedEndTime:
            type: string
            format: date-time
            description: Date and time when the change implementation is planned to be finished
          plannedStartTime:
            type: string
            format: date-time
            description: Date and time when the change implementation is planned to be started
          priority:
            type: string
            description: Used by consumers to prioritize a change request in Change Management system
          requestDate:
            type: string
            format: date-time
            description: Date and time when the change request is raised
          requestType:
            type: string
            description: Indicates the type of the change request
          risk:
            type: string
            description: The risk to implement this change request
          riskMitigationPlan:
            type: string
            description: The risk mitigation plan
          riskValue:
            type: string
            description: The additional cost if the risk will happen
          scheduledDate:
            type: string
            format: date-time
            description: Date and time that the schedule is made
          statusChangeDate:
            type: string
            format: date-time
            description: Date and time when the change request status was changed
          statusChangeReason:
            type: string
            description: Reason of the status change
          attachment:
            description: The attachments of the communication message (when it is email type)
            type: array
            items:
              $ref: '#/components/schemas/AttachmentRefOrValue'
          budget:
            $ref: '#/components/schemas/Money'
          changeRelationship:
            type: array
            items:
              $ref: '#/components/schemas/ChangeRequestRelationship'
          changeRequestCharacteristic:
            type: array
            items:
              $ref: '#/components/schemas/Characteristic'
          externalReference:
            type: array
            items:
              $ref: '#/components/schemas/ExternalReference'
          impactEntity:
            type: array
            items:
              $ref: '#/components/schemas/ImpactEntity'
          location:
            $ref: '#/components/schemas/RelatedPlaceRefOrValue'
            description: A list of places (Place [*]). Used to define a place useful for the service (for example a geographical place whre the service is installed)
          note:
            type: array
            items:
              $ref: '#/components/schemas/Note'
          problemTicket:
            type: array
            items:
              $ref: '#/components/schemas/ServiceProblemRef'
          relatedParty:
            description: The parties involved in the change request
            type: array
            items:
              $ref: '#/components/schemas/RelatedParty'
          resolution:
            $ref: '#/components/schemas/Resolution'
          sla:
            type: array
            items:
              $ref: '#/components/schemas/SLARef'
          

# --- truncated at 32 KB (45 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bell-canada/refs/heads/main/openapi/bell-canada-changerequest-api-openapi.yml