Bell Canada Service Order API

openapi: 3.2.0
info:
  title: ServiceOrdering Service Order API
  description: '## TMF API Reference : TMF 641 - Service Ordering Management


    Version 4.6


    The Service Order API provides a standardized mechanism for managing Service Order, a type of order which can be used to place an order between internal Customer Order management system to service order management system or between a service provider and a partner and vice versa.'
  version: 4.6.0
servers:
- url: https://serverRoot/tmf-api/serviceOrdering/v4
tags:
- name: Service Order
paths:
  /serviceOrder:
    get:
      operationId: listServiceOrder
      summary: List or find ServiceOrder objects
      description: This operation list or find ServiceOrder entities
      tags:
      - Service Order
      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/ServiceOrder'
                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: createServiceOrder
      summary: Creates a ServiceOrder
      description: This operation creates a ServiceOrder entity.
      tags:
      - Service Order
      responses:
        '201':
          description: Created
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/ServiceOrder'
        '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/ServiceOrder_Create'
        description: The ServiceOrder to be created
        required: true
  /serviceOrder/{id}:
    get:
      operationId: retrieveServiceOrder
      summary: Retrieves a ServiceOrder by ID
      description: This operation retrieves a ServiceOrder entity. Attribute selection is enabled for all first level attributes.
      tags:
      - Service Order
      parameters:
      - in: path
        name: id
        required: true
        description: Identifier of the ServiceOrder
        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/ServiceOrder'
        '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: patchServiceOrder
      summary: Updates partially a ServiceOrder
      description: This operation updates partially a ServiceOrder entity.
      tags:
      - Service Order
      parameters:
      - in: path
        name: id
        required: true
        description: Identifier of the ServiceOrder
        schema:
          type: string
      responses:
        '200':
          description: Updated
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/ServiceOrder'
        '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/ServiceOrder_Update'
        description: The ServiceOrder to be updated
        required: true
    delete:
      operationId: deleteServiceOrder
      summary: Deletes a ServiceOrder
      description: This operation deletes a ServiceOrder entity.
      tags:
      - Service Order
      parameters:
      - in: path
        name: id
        required: true
        description: Identifier of the ServiceOrder
        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:
    ServiceOrderItemStateType:
      type: string
      description: Possible values for the state of the order item
      enum:
      - acknowledged
      - rejected
      - pending
      - held
      - inProgress
      - cancelled
      - completed
      - failed
      - assessingCancellation
      - pendingCancellation
      - partial
    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
    EntityRef:
      description: Base entityRef schema for use in TMForum Open-APIs
      allOf:
      - $ref: '#/components/schemas/Entity'
      - properties:
          id:
            type: string
            description: Unique identifier of a related entity.
          href:
            type: string
            description: Reference of the related entity.
          name:
            type: string
            description: Name of the related entity.
          '@referredType':
            type: string
            description: The actual type of the target instance when needed for disambiguation.
    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
    ServiceSpecificationRef:
      description: 'Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.'
      allOf:
      - $ref: '#/components/schemas/EntityRef'
      - properties:
          version:
            type: string
            description: Service specification version
    ServiceOrderItemErrorMessage:
      description: AServiceOrderItemErrorMessage represents an error that causes a status change in a service order item.
      allOf:
      - $ref: '#/components/schemas/Entity'
      - properties:
          code:
            type: string
            description: error code
          message:
            type: string
            description: More details and corrective actions related to the error
          reason:
            type: string
            description: Explanation of the reason for the error
          referenceError:
            type: string
            format: uri
            description: URI of documentation describing the error
          status:
            type: string
            description: error code extension like sys-ABC-2001
          timestamp:
            type: string
            format: date-time
            description: Date when the error happened
    ServiceRefOrValue:
      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/ServiceRef'
          description: A reference to the Service.
        value:
          $ref: '#/components/schemas/Service'
          description: The Service (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
    ConstraintRef:
      description: Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec.
      allOf:
      - $ref: '#/components/schemas/EntityRef'
      - properties:
          version:
            type: string
            description: constraint version
    ServiceStateType:
      type: string
      description: Valid values for the lifecycle state of the service
      enum:
      - feasibilityChecked
      - designed
      - reserved
      - inactive
      - active
      - terminated
    ServiceRelationship:
      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
          service:
            $ref: '#/components/schemas/ServiceRefOrValue'
          serviceRelationshipCharacteristic:
            type: array
            items:
              $ref: '#/components/schemas/Characteristic'
    RelatedServiceOrderItem:
      description: RelatedServiceOrderItem (a ServiceOrder item) .The service order item which triggered service creation/change/termination.
      allOf:
      - $ref: '#/components/schemas/Entity'
      - properties:
          id:
            type: string
            description: unique identifier
          href:
            type: string
            format: uri
            description: Hyperlink reference
          itemId:
            type: string
            description: Identifier of the order item where the service was managed
          role:
            type: string
            description: role of the service order item for this service
          serviceOrderHref:
            type: string
            description: Reference of the related entity.
          serviceOrderId:
            type: string
            description: Unique identifier of a related entity.
          itemAction:
            $ref: '#/components/schemas/OrderItemActionType'
            description: Action of the order item for this service
          '@referredType':
            type: string
            description: The actual type of the target instance when needed for disambiguation.
    OrderItemActionType:
      type: string
      description: action to be performed on the product
      enum:
      - add
      - modify
      - delete
      - noChange
    Feature:
      type: object
      description: Configuration feature.
      required:
      - name
      - featureCharacteristic
      properties:
        id:
          type: string
          description: Unique identifier of the feature.
        isBundle:
          type: boolean
          description: True if this is a feature group. Default is false.
        isEnabled:
          type: boolean
          description: True if this feature is enabled. Default is true.
        name:
          type: string
          description: This is the name for the feature.
        constraint:
          description: This is a list of feature constraints.
          type: array
          items:
            $ref: '#/components/schemas/ConstraintRef'
        featureCharacteristic:
          description: This is a list of Characteristics for a particular feature.
          type: array
          items:
            $ref: '#/components/schemas/Characteristic'
          minItems: 1
        featureRelationship:
          type: array
          items:
            $ref: '#/components/schemas/FeatureRelationship'
    ResourceRef:
      allOf:
      - $ref: '#/components/schemas/EntityRef'
    ServiceOrder:
      allOf:
      - $ref: '#/components/schemas/Entity'
      - properties:
          id:
            type: string
            description: ID created on repository side
          href:
            type: string
            description: Hyperlink to access the order
          cancellationDate:
            type: string
            format: date-time
            description: 'Date when the order is cancelled. This is used when order is cancelled. '
          cancellationReason:
            type: string
            description: 'Reason why the order is cancelled. This is used when order is cancelled. '
          category:
            type: string
            description: 'Used to categorize the order, useful for the OM system, such as: Broadband, TVOption'
          completionDate:
            type: string
            format: date-time
            description: Effective delivery date amended by the provider
          description:
            type: string
            description: A free-text description of the service order
          expectedCompletionDate:
            type: string
            format: date-time
            description: Expected delivery date amended by the provider
          externalId:
            type: string
            description: ID given by the consumer to facilitate searches
          notificationContact:
            type: string
            description: Contact attached to the order to send back information regarding this order
          orderDate:
            type: string
            format: date-time
          priority:
            type: string
            description: Can be used by consumers to prioritize orders in a Service Order Management system
          requestedCompletionDate:
            type: string
            format: date-time
            description: Requested delivery date from the requestors perspective
          requestedStartDate:
            type: string
            format: date-time
            description: Order start date wished by the requestor
          startDate:
            type: string
            format: date-time
            description: Date when the order was started for processing
          errorMessage:
            description: the error(s) cause an order status change
            type: array
            items:
              $ref: '#/components/schemas/ServiceOrderErrorMessage'
          externalReference:
            type: array
            items:
              $ref: '#/components/schemas/ExternalReference'
          jeopardyAlert:
            description: A list of jeopardy alerts related to this order
            type: array
            items:
              $ref: '#/components/schemas/ServiceOrderJeopardyAlert'
          milestone:
            description: A list of milestones related to this order
            type: array
            items:
              $ref: '#/components/schemas/ServiceOrderMilestone'
          note:
            description: Extra-information about the order; e.g. useful to add extra delivery information that could be useful for a human process
            type: array
            items:
              $ref: '#/components/schemas/Note'
          orderRelationship:
            description: A list of service orders related to this order (e.g. prerequisite, dependent on)
            type: array
            items:
              $ref: '#/components/schemas/ServiceOrderRelationship'
          relatedParty:
            description: A list of parties which are involved in this order and the role they are playing
            type: array
            items:
              $ref: '#/components/schemas/RelatedParty'
          serviceOrderItem:
            description: A list of service order items to be processed by this order
            type: array
            items:
              $ref: '#/components/schemas/ServiceOrderItem'
          state:
            $ref: '#/components/schemas/ServiceOrderStateType'
            description: 'State of the order: described in the state-machine diagram'
    ServiceOrderItem:
      allOf:
      - $ref: '#/components/schemas/Entity'
      - required:
        - id
        - action
        - service
        properties:
          id:
            type: string
            description: Identifier of the individual line item
          quantity:
            type: integer
            description: Quantity ordered
          action:
            $ref: '#/components/schemas/OrderItemActionType'
            description: 'The action to be carried out on the Service. Can be: add, modify, delete, noChange'
          appointment:
            $ref: '#/components/schemas/AppointmentRef'
            description: An appointment that was set up with a related party for this order item
          errorMessage:
            description: the error(s) cause an order item status change
            type: array
            items:
              $ref: '#/components/schemas/ServiceOrderItemErrorMessage'
          service:
            $ref: '#/components/schemas/ServiceRefOrValue'
            description: The Service to be acted on by the order item
          serviceOrderItem:
            description: A list of order items embedded to this order item
            type: array
            items:
              $ref: '#/components/schemas/ServiceOrderItem'
          serviceOrderItemRelationship:
            description: A list of order items related to this order item
            type: array
            items:
              $ref: '#/components/schemas/ServiceOrderItemRelationship'
          state:
            $ref: '#/components/schemas/ServiceOrderItemStateType'
            description: 'State of the order item: described in the state machine diagram. This is the requested state.'
    AppointmentRef:
      description: Refers an appointment, such as a Customer presentation or internal meeting or site visit
      allOf:
      - $ref: '#/components/schemas/EntityRef'
      - properties:
          description:
            type: string
            description: An explanatory text regarding the appointment made with a party
    RelatedEntityRefOrValue:
      description: A reference to an entity, where the type of the entity is not known in advance. A related entity defines a entity described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the Entity and not the RelatedEntityRefOrValue class itself
      properties:
        role:
          type: string
        ref:
          $ref: '#/components/schemas/EntityRef'
          description: A reference to the Entity.
        value:
          $ref: '#/components/schemas/Entity'
          description: The Entity (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
    RelatedParty:
      description: Related Party 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.
    ServiceOrderJeopardyAlert:
      description: A ServiceOrderJeopardyAlert represents a predicted exception during a service order processing that would brings risk to complete successfully the ordetr.
      allOf:
      - $ref: '#/components/schemas/Entity'
      - properties:
          id:
            type: string
            description: identifier of the JeopardyAlert
          alertDate:
            type: string
            format: date-time
            description: A date time( DateTime). The date that the alert issued
          exception:
            type: string
            description: ' The exception associated with this jeopardy alert'
          jeopardyType:
            type: string
            description: A string represents the type of jeopardy/risk like Normal, Hazard, Critical, ...
          message:
            type: string
            description: A string represents the message of the alert
          name:
            type: string
            description: A string used to give a name to the jeopardy alert
          serviceOrderItem:
            description: A list of order item references corresponded to this alert
            type: array
            items:
              $ref: '#/components/schemas/ServiceOrderItemRef'
    ServiceOrder_Update:
      type: object
      description: '

        Skipped properties: id,href,orderDate,jeopardyAlert,errorMessage,milestone,@baseType,@schemaLocation,@type,cancellationDate,cancellationReason,category,completionDate,startDate'
      properties:
        description:
          type: string
          description: A free-text description of the service order
        expectedCompletionDate:
          type: string
          format: date-time
          description: Expected delivery date amended by the provider
        externalId:
          type: string
          description: ID given by the consumer to facilitate searches
        notificationContact:
          type: string
          description: Contact attached to the order to send back information regarding this order
        priority:
          type: string
          description: Can be used by consumers to prioritize orders in a Service Order Management system
        requestedCompletionDate:
          type: string
          format: date-time
          description: Requested delivery date from the requestors perspective
        requestedStartDate:
          type: string
          format: date-time
          description: Order start date wished by the requestor
        externalReference:
          type: array
          items:
            $ref: '#/components/schemas/ExternalReference'
        note:
          description: Extra-information about the order; e.g. useful to add extra delivery information that could be useful for a human process
          type: array
          items:
            $ref: '#/components/schemas/Note'
        orderRelationship:
          description: A list of service orders related to this order (e.g. prerequisite, dependent on)
          type: array
          items:
            $ref: '#/components/schemas/ServiceOrderRelationship'
        relatedParty:
          description: A list of parties which are involved in this order and the role they are playing
          type: array
          items:
            $ref: '#/components/schemas/RelatedParty'
        serviceOrderItem:
          description: A list of service order items to be processed by this order
          type: array
          items:
            $ref: '#/components/schemas/ServiceOrderItem'
        state:
          $ref: '#/components/schemas/ServiceOrderStateType'
          description: 'State of the order: described in the state-machine diagram'
    ServiceOrderItemRelationship:
      description: Linked service order item to the one containing this attribute
      allOf:
      - $ref: '#/components/schemas/Entity'
      - properties:
          relationshipType:
            type: string
            d

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