Discriminator Values

• ServiceOrder
• ServiceOrderOSM

{
    "type":"object",
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ServiceOrder":"#/components/schemas/ServiceOrder",
            "ServiceOrderOSM":"#/components/schemas/ServiceOrderOSM"
        }
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"ID created on repository side."
        },
        "href":{
            "type":"string",
            "description":"Hyperlink to access the order."
        },
        "cancellationDate":{
            "type":"string",
            "description":"Date when the order is cancelled. This is used when order is cancelled.",
            "format":"date-time"
        },
        "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",
            "description":"Effective delivery date amended by the provider.",
            "format":"date-time"
        },
        "description":{
            "type":"string",
            "description":"A free-text description of the service order."
        },
        "expectedCompletionDate":{
            "type":"string",
            "description":"Expected delivery date amended by the provider",
            "format":"date-time."
        },
        "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",
            "description":"Requested delivery date from the requestors perspective.",
            "format":"date-time"
        },
        "requestedStartDate":{
            "type":"string",
            "description":"Order start date wished by the requestor.",
            "format":"date-time"
        },
        "startDate":{
            "type":"string",
            "description":"Date when the order was started for processing.",
            "format":"date-time"
        },
        "errorMessage":{
            "type":"array",
            "description":"The error(s) cause an order status change.",
            "items":{
                "$ref":"#/components/schemas/ServiceOrderErrorMessage"
            }
        },
        "externalReference":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExternalReference"
            }
        },
        "jeopardyAlert":{
            "type":"array",
            "description":"A list of jeopardy alerts related to this order.",
            "items":{
                "$ref":"#/components/schemas/ServiceOrderJeopardyAlert"
            }
        },
        "milestone":{
            "type":"array",
            "description":"A list of milestones related to this order.",
            "items":{
                "$ref":"#/components/schemas/ServiceOrderMilestone"
            }
        },
        "note":{
            "type":"array",
            "description":"Extra-information about the order; For example, to add extra delivery information that could be useful for a human process.",
            "items":{
                "$ref":"#/components/schemas/Note"
            }
        },
        "orderRelationship":{
            "type":"array",
            "description":"A list of service orders related to this order (For example, prerequisite, dependent on).",
            "items":{
                "$ref":"#/components/schemas/ServiceOrderRelationship"
            }
        },
        "relatedParty":{
            "type":"array",
            "description":"A list of parties that are involved in this order and the role they are playing.",
            "items":{
                "$ref":"#/components/schemas/RelatedParty"
            }
        },
        "serviceOrderItem":{
            "type":"array",
            "description":"A list of service order items to be processed by this order.",
            "items":{
                "$ref":"#/components/schemas/ServiceOrderItem"
            }
        },
        "state":{
            "$ref":"#/components/schemas/ServiceOrderStateType"
        },
        "@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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class Extensible name."
        }
    }
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class Extensible name.
• cancellationDate: string (date-time)
  Date when the order is cancelled. This is used when order is cancelled.
• cancellationReason: string
  Reason why the order is cancelled. This is used when order is cancelled.
• category: string
  Used to categorize the order, useful for the OM system, such as: Broadband, TVOption
• completionDate: string (date-time)
  Effective delivery date amended by the provider.
• description: string
  A free-text description of the service order.
• errorMessage: array errorMessage
  The error(s) cause an order status change.
• expectedCompletionDate: string (date-time.)
  Expected delivery date amended by the provider
• externalId: string
  ID given by the consumer to facilitate searches.
• externalReference: array externalReference
• href: string
  Hyperlink to access the order.
• id: string
  ID created on repository side.
• jeopardyAlert: array jeopardyAlert
  A list of jeopardy alerts related to this order.
• milestone: array milestone
  A list of milestones related to this order.
• note: array note
  Extra-information about the order; For example, to add extra delivery information that could be useful for a human process.
• notificationContact: string
  Contact attached to the order to send back information regarding this order.
• orderDate: string (date-time)
• orderRelationship: array orderRelationship
  A list of service orders related to this order (For example, prerequisite, dependent on).
• priority: string
  Can be used by consumers to prioritize orders in a Service Order Management system.
• relatedParty: array relatedParty
  A list of parties that are involved in this order and the role they are playing.
• requestedCompletionDate: string (date-time)
  Requested delivery date from the requestors perspective.
• requestedStartDate: string (date-time)
  Order start date wished by the requestor.
• serviceOrderItem: array serviceOrderItem
  A list of service order items to be processed by this order.
• startDate: string (date-time)
  Date when the order was started for processing.
• state: string
  Allowed Values: [ "acknowledged", "rejected", "pending", "held", "inProgress", "cancelled", "completed", "failed", "partial", "assessingCancellation", "pendingCancellation", "inProgress.fallout", "amending.fallout", "amending", "pendingCancellation.fallout", "inProgress.suspended", "inProgress.fallout.suspended", "amending.suspended", "amending.fallout.suspended", "pendingCancellation.suspended", "pendingCancellation.fallout.suspended" ]

  Possible values for the state of the order.

{
    "type":"object",
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ServiceOrder":"#/components/schemas/ServiceOrder",
            "ServiceOrderOSM":"#/components/schemas/ServiceOrderOSM"
        }
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"ID created on repository side."
        },
        "href":{
            "type":"string",
            "description":"Hyperlink to access the order."
        },
        "cancellationDate":{
            "type":"string",
            "description":"Date when the order is cancelled. This is used when order is cancelled.",
            "format":"date-time"
        },
        "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",
            "description":"Effective delivery date amended by the provider.",
            "format":"date-time"
        },
        "description":{
            "type":"string",
            "description":"A free-text description of the service order."
        },
        "expectedCompletionDate":{
            "type":"string",
            "description":"Expected delivery date amended by the provider",
            "format":"date-time."
        },
        "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",
            "description":"Requested delivery date from the requestors perspective.",
            "format":"date-time"
        },
        "requestedStartDate":{
            "type":"string",
            "description":"Order start date wished by the requestor.",
            "format":"date-time"
        },
        "startDate":{
            "type":"string",
            "description":"Date when the order was started for processing.",
            "format":"date-time"
        },
        "errorMessage":{
            "type":"array",
            "description":"The error(s) cause an order status change.",
            "items":{
                "$ref":"#/components/schemas/ServiceOrderErrorMessage"
            }
        },
        "externalReference":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExternalReference"
            }
        },
        "jeopardyAlert":{
            "type":"array",
            "description":"A list of jeopardy alerts related to this order.",
            "items":{
                "$ref":"#/components/schemas/ServiceOrderJeopardyAlert"
            }
        },
        "milestone":{
            "type":"array",
            "description":"A list of milestones related to this order.",
            "items":{
                "$ref":"#/components/schemas/ServiceOrderMilestone"
            }
        },
        "note":{
            "type":"array",
            "description":"Extra-information about the order; For example, to add extra delivery information that could be useful for a human process.",
            "items":{
                "$ref":"#/components/schemas/Note"
            }
        },
        "orderRelationship":{
            "type":"array",
            "description":"A list of service orders related to this order (For example, prerequisite, dependent on).",
            "items":{
                "$ref":"#/components/schemas/ServiceOrderRelationship"
            }
        },
        "relatedParty":{
            "type":"array",
            "description":"A list of parties that are involved in this order and the role they are playing.",
            "items":{
                "$ref":"#/components/schemas/RelatedParty"
            }
        },
        "serviceOrderItem":{
            "type":"array",
            "description":"A list of service order items to be processed by this order.",
            "items":{
                "$ref":"#/components/schemas/ServiceOrderItem"
            }
        },
        "state":{
            "$ref":"#/components/schemas/ServiceOrderStateType"
        },
        "@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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class Extensible name."
        }
    }
}

• Array of: object ServiceOrderErrorMessage
  A ServiceOrderErrorMessage represents an error that causes a status change in a service order.

{
    "type":"array",
    "description":"The error(s) cause an order status change.",
    "items":{
        "$ref":"#/components/schemas/ServiceOrderErrorMessage"
    }
}

• Array of: object ExternalReference
  External reference of the individual or reference in other system.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ExternalReference"
    }
}

• Array of: object ServiceOrderJeopardyAlert
  A ServiceOrderJeopardyAlert represents a predicted exception during a service order processing that would brings risk to complete the order successfully.

{
    "type":"array",
    "description":"A list of jeopardy alerts related to this order.",
    "items":{
        "$ref":"#/components/schemas/ServiceOrderJeopardyAlert"
    }
}

• Array of: object ServiceOrderMilestone
  ServiceOrderMilestone represents an action or event marking a significant change or stage in the processing of a service order.

{
    "type":"array",
    "description":"A list of milestones related to this order.",
    "items":{
        "$ref":"#/components/schemas/ServiceOrderMilestone"
    }
}

• Array of: object Note
  Extra information about a given entity.

{
    "type":"array",
    "description":"Extra-information about the order; For example, to add extra delivery information that could be useful for a human process.",
    "items":{
        "$ref":"#/components/schemas/Note"
    }
}

• Array of: object ServiceOrderRelationship
  Linked service order to the one containing this attribute.

{
    "type":"array",
    "description":"A list of service orders related to this order (For example, prerequisite, dependent on).",
    "items":{
        "$ref":"#/components/schemas/ServiceOrderRelationship"
    }
}

• Array of: object RelatedParty
  Related Entity reference. A related party defines party or party role linked to a specific entity.

{
    "type":"array",
    "description":"A list of parties that are involved in this order and the role they are playing.",
    "items":{
        "$ref":"#/components/schemas/RelatedParty"
    }
}

• Array of: object ServiceOrderItem

{
    "type":"array",
    "description":"A list of service order items to be processed by this order.",
    "items":{
        "$ref":"#/components/schemas/ServiceOrderItem"
    }
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class Extensible name.
• code: string
  error code
• message: string
  More details and corrective actions related to the error.
• reason: string
  Explanation of the reason for the error.
• referenceError: string (uri)
  URI of documentation describing the error.
• serviceOrderItem: array serviceOrderItem
  A list of order item references corresponded to this error.
• status: string
  Error code extension like sys-ABC-2001.
• timestamp: string (date-time)
  Date when the error happened.

{
    "type":"object",
    "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",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "status":{
            "type":"string",
            "description":"Error code extension like sys-ABC-2001."
        },
        "timestamp":{
            "type":"string",
            "description":"Date when the error happened.",
            "format":"date-time"
        },
        "serviceOrderItem":{
            "type":"array",
            "description":"A list of order item references corresponded to this error.",
            "items":{
                "$ref":"#/components/schemas/ServiceOrderItemRef"
            }
        },
        "@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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class Extensible name."
        }
    },
    "description":"A ServiceOrderErrorMessage represents an error that causes a status change in a service order."
}

• Array of: object ServiceOrderItemRef

{
    "type":"array",
    "description":"A list of order item references corresponded to this error.",
    "items":{
        "$ref":"#/components/schemas/ServiceOrderItemRef"
    }
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class Extensible name.
• itemId: string
  Identifier of the line item.
• serviceOrderHref: string (uri)
  Link to the order this item belongs to.
• serviceOrderId: string
  Identifier of the order that this item belongs to.

{
    "type":"object",
    "properties":{
        "itemId":{
            "type":"string",
            "description":"Identifier of the line item."
        },
        "serviceOrderHref":{
            "type":"string",
            "description":"Link to the order this item belongs to.",
            "format":"uri"
        },
        "serviceOrderId":{
            "type":"string",
            "description":"Identifier of the order that this item belongs to."
        },
        "@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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class Extensible name."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    }
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class Extensible name.
• externalReferenceType: string
  Type of the external reference.
• href: string (uri)
  Hyperlink reference.
• id: string
  Unique identifier.
• name(required): string
  External reference name.

{
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier."
        },
        "href":{
            "type":"string",
            "description":"Hyperlink reference.",
            "format":"uri"
        },
        "externalReferenceType":{
            "type":"string",
            "description":"Type of the external reference."
        },
        "name":{
            "type":"string",
            "description":"External reference name."
        },
        "@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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class Extensible name."
        }
    },
    "description":"External reference of the individual or reference in other system."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class Extensible name,
• alertDate: string (date-time)
  A date time (DateTime). The date that the alert issued on.
• exception: string
  The exception associated with this jeopardy alert.
• id: string
  Identifier of the JeopardyAlert.
• jeopardyType: string
  A string represents the type of jeopardy/risk. For example, Normal, Hazard, and Critical.
• message: string
  A string represents the message of the alert.
• name: string
  A string used to give a name to the jeopardy alert.
• serviceOrderItem: array serviceOrderItem
  A list of order item references corresponding to this alert.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Identifier of the JeopardyAlert."
        },
        "alertDate":{
            "type":"string",
            "description":"A date time (DateTime). The date that the alert issued on.",
            "format":"date-time"
        },
        "exception":{
            "type":"string",
            "description":"The exception associated with this jeopardy alert."
        },
        "jeopardyType":{
            "type":"string",
            "description":"A string represents the type of jeopardy/risk. For example, Normal, Hazard, and 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":{
            "type":"array",
            "description":"A list of order item references corresponding to this alert.",
            "items":{
                "$ref":"#/components/schemas/ServiceOrderItemRef"
            }
        },
        "@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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class Extensible name,"
        }
    },
    "description":"A ServiceOrderJeopardyAlert represents a predicted exception during a service order processing that would brings risk to complete the order successfully."
}

• Array of: object ServiceOrderItemRef

{
    "type":"array",
    "description":"A list of order item references corresponding to this alert.",
    "items":{
        "$ref":"#/components/schemas/ServiceOrderItemRef"
    }
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class Extensible name.
• description: string
  Free-text description of the Milestone.
• id: string
  Identifier of the Milestone.
• message: string
  A string represents the message of the milestone.
• milestoneDate: string (date-time)
  A date time (DateTime). The date that the milestone happens.
• name: string
  A string used to give a name to the milestone.
• serviceOrderItem: array serviceOrderItem
  A list of order item references corresponding to this milestone.
• status: string
  The milestone status.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Identifier of the Milestone."
        },
        "description":{
            "type":"string",
            "description":"Free-text description of the Milestone."
        },
        "message":{
            "type":"string",
            "description":"A string represents the message of the milestone."
        },
        "milestoneDate":{
            "type":"string",
            "description":"A date time (DateTime). The date that the milestone happens.",
            "format":"date-time"
        },
        "name":{
            "type":"string",
            "description":"A string used to give a name to the milestone."
        },
        "status":{
            "type":"string",
            "description":"The milestone status."
        },
        "serviceOrderItem":{
            "type":"array",
            "description":"A list of order item references corresponding to this milestone.",
            "items":{
                "$ref":"#/components/schemas/ServiceOrderItemRef"
            }
        },
        "@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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class Extensible name."
        }
    },
    "description":"ServiceOrderMilestone represents an action or event marking a significant change or stage in the processing of a service order."
}

• Array of: object ServiceOrderItemRef

{
    "type":"array",
    "description":"A list of order item references corresponding to this milestone.",
    "items":{
        "$ref":"#/components/schemas/ServiceOrderItemRef"
    }
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• author: string
  Author of the note.
• date: string (date-time)
  Date of the note.
• id: string
  Identifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation).
• text(required): string
  Text of the note.

{
    "required":[
        "text"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Identifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation)."
        },
        "author":{
            "type":"string",
            "description":"Author of the note."
        },
        "date":{
            "type":"string",
            "description":"Date of the note.",
            "format":"date-time"
        },
        "text":{
            "type":"string",
            "description":"Text of the note."
        },
        "@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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Extra information about a given entity."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @referredType: string
  The entity type of the related order.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class Extensible name.
• href: string
  A hyperlink to the related order.
• id(required): string
  The id of the related order.
• relationshipType(required): string
  The type of related order, such as: [dependency] if the order needs to be [not started] until another order item is complete (a service order in this case) or [cross-ref] to keep track of the source order (a productOrder).

{
    "required":[
        "id",
        "relationshipType"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the related order."
        },
        "href":{
            "type":"string",
            "description":"A hyperlink to the related order."
        },
        "relationshipType":{
            "type":"string",
            "description":"The type of related order, such as: [dependency] if the order needs to be [not started] until another order item is complete (a service order in this case) or [cross-ref] to keep track of the source order (a productOrder)."
        },
        "@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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class Extensible name."
        },
        "@referredType":{
            "type":"string",
            "description":"The entity type of the related order."
        }
    },
    "description":"Linked service order to the one containing this attribute."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @referredType(required): string
  The actual type of the target instance when needed for disambiguation.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• href: string
  Reference of the related entity.
• id(required): string
  Unique identifier of a related entity.
• name: string
  Name of the related entity.
• role: string
  Role played by the related party.

{
    "required":[
        "@referredType",
        "id"
    ],
    "type":"object",
    "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."
        },
        "role":{
            "type":"string",
            "description":"Role played by the related party."
        },
        "@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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "description":"Related Entity reference. A related party defines party or party role linked to a specific entity."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class Extensible name.
• action(required): string
  Allowed Values: [ "add", "modify", "delete", "noChange", "suspend", "resume", "terminate" ]

  The action to be performed on the product.
• appointment: object AppointmentRef
  Refers an appointment, such as a Customer presentation or internal meeting or site visit.
• errorMessage: array errorMessage
  The errors causes an order item status change.
• id(required): string
  Identifier of the individual line item.
• quantity: integer
  Quantity ordered.
• service(required): object ServiceRefOrValue
  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.
• serviceOrderItem: array serviceOrderItem
  A list of order items embedded to this order item.
• serviceOrderItemRelationship: array serviceOrderItemRelationship
  A list of order items related to this order item.
• state: string
  Allowed Values: [ "acknowledged", "rejected", "pending", "held", "inProgress", "cancelled", "completed", "failed", "partial", "assessingCancellation", "pendingCancellation", "inProgress.fallout", "amending.fallout", "amending", "pendingCancellation.fallout" ]

  Possible values for the state of the order item.

{
    "required":[
        "action",
        "id",
        "service"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Identifier of the individual line item."
        },
        "quantity":{
            "type":"integer",
            "description":"Quantity ordered."
        },
        "action":{
            "$ref":"#/components/schemas/OrderItemActionType"
        },
        "appointment":{
            "$ref":"#/components/schemas/AppointmentRef"
        },
        "errorMessage":{
            "type":"array",
            "description":"The errors causes an order item status change.",
            "items":{
                "$ref":"#/components/schemas/ServiceOrderItemErrorMessage"
            }
        },
        "service":{
            "$ref":"#/components/schemas/ServiceRefOrValue"
        },
        "serviceOrderItem":{
            "type":"array",
            "description":"A list of order items embedded to this order item.",
            "items":{
                "$ref":"#/components/schemas/ServiceOrderItem"
            }
        },
        "serviceOrderItemRelationship":{
            "type":"array",
            "description":"A list of order items related to this order item.",
            "items":{
                "$ref":"#/components/schemas/ServiceOrderItemRelationship"
            }
        },
        "state":{
            "$ref":"#/components/schemas/ServiceOrderItemStateType"
        },
        "@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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class Extensible name."
        }
    }
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• description: string
  An explanatory text regarding the appointment made with a party.
• href: string
  The reference of the appointment.
• id(required): string
  The identifier of the referred appointment.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The identifier of the referred appointment."
        },
        "href":{
            "type":"string",
            "description":"The reference of the appointment."
        },
        "description":{
            "type":"string",
            "description":"An explanatory text regarding the appointment made with a party."
        },
        "@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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "description":"Refers an appointment, such as a Customer presentation or internal meeting or site visit."
}

• Array of: object ServiceOrderItemErrorMessage
  A ServiceOrderItemErrorMessage represents an error that causes a status change in a service order item.

{
    "type":"array",
    "description":"The errors causes an order item status change.",
    "items":{
        "$ref":"#/components/schemas/ServiceOrderItemErrorMessage"
    }
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class Extensible name.
• category: string
  A customer facing service or resource facing service.
• description: string
  Free-text description of the service.
• endDate: string (date-time)
  Date when the service ends.
• feature: array feature
  A list of features associated with this service.
• hasStarted: boolean
  If TRUE, this Service has already been started.
• href: string
  Reference of the service.
• id: string
  Unique identifier of the service.
• isBundle: boolean
  If true, the service is a ServiceBundle which regroup a service. hierachy. If false, the service is an 'atomic' service (hierarchy leaf).
• isServiceEnabled: boolean
  If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed.
• isStateful: boolean
  If TRUE, this Service can be changed without affecting any other services.
• name: string
  Name of the service.
• note: array note
  A list of notes made on this service.
• place: array place
  A list of places (Place [*]). Used to define a place useful for the service. (For example, a geographical place whre the service is installed.)
• relatedEntity: array relatedEntity
  A list of related entity in relationship with this service.
• relatedParty: array relatedParty
  A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity.
• serviceCharacteristic: array serviceCharacteristic
  A list of characteristics that characterize this service (ServiceCharacteristic [*])
• serviceDate: string
  Date when the service was created (whatever its status).
• serviceOrderItem: array serviceOrderItem
  A list of service order items related to this service.
• serviceRelationship: array serviceRelationship
  A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory.
• serviceSpecification: object ServiceSpecificationRef
  Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.
• serviceType: string
  Business type of the service.
• startDate: string (date-time)
  Date when the service starts.
• startMode: string
  This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above
• state: string
  Allowed Values: [ "feasibilityChecked", "designed", "reserved", "inactive", "active", "terminated" ]

  Valid values for the lifecycle state of the service.
• supportingResource: array supportingResource
  A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources
• supportingService: array supportingService
  A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS).

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the service."
        },
        "href":{
            "type":"string",
            "description":"Reference of the service."
        },
        "category":{
            "type":"string",
            "description":"A customer facing service or resource facing service."
        },
        "description":{
            "type":"string",
            "description":"Free-text description of the service."
        },
        "endDate":{
            "type":"string",
            "description":"Date when the service ends.",
            "format":"date-time"
        },
        "hasStarted":{
            "type":"boolean",
            "description":"If TRUE, this Service has already been started."
        },
        "isBundle":{
            "type":"boolean",
            "description":"If true, the service is a ServiceBundle which regroup a service. hierachy. If false, the service is an 'atomic' service (hierarchy leaf)."
        },
        "isServiceEnabled":{
            "type":"boolean",
            "description":"If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed."
        },
        "isStateful":{
            "type":"boolean",
            "description":"If TRUE, this Service can be changed without affecting any other services."
        },
        "name":{
            "type":"string",
            "description":"Name of the service."
        },
        "serviceDate":{
            "type":"string",
            "description":"Date when the service was created (whatever its status)."
        },
        "serviceType":{
            "type":"string",
            "description":"Business type of the service."
        },
        "startDate":{
            "type":"string",
            "description":"Date when the service starts.",
            "format":"date-time"
        },
        "startMode":{
            "type":"string",
            "description":"This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above"
        },
        "feature":{
            "type":"array",
            "description":"A list of features associated with this service.",
            "items":{
                "$ref":"#/components/schemas/Feature"
            }
        },
        "note":{
            "type":"array",
            "description":"A list of notes made on this service.",
            "items":{
                "$ref":"#/components/schemas/Note"
            }
        },
        "place":{
            "type":"array",
            "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.)",
            "items":{
                "$ref":"#/components/schemas/RelatedPlaceRefOrValue"
            }
        },
        "relatedEntity":{
            "type":"array",
            "description":"A list of related  entity in relationship with this service.",
            "items":{
                "$ref":"#/components/schemas/RelatedEntityRefOrValue"
            }
        },
        "relatedParty":{
            "type":"array",
            "description":"A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity.",
            "items":{
                "$ref":"#/components/schemas/RelatedParty"
            }
        },
        "serviceCharacteristic":{
            "type":"array",
            "description":"A list of characteristics that characterize this service (ServiceCharacteristic [*]) ",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            }
        },
        "serviceOrderItem":{
            "type":"array",
            "description":"A list of service order items related to this service.",
            "items":{
                "$ref":"#/components/schemas/RelatedServiceOrderItem"
            }
        },
        "serviceRelationship":{
            "type":"array",
            "description":"A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory.",
            "items":{
                "$ref":"#/components/schemas/ServiceRelationship"
            }
        },
        "serviceSpecification":{
            "$ref":"#/components/schemas/ServiceSpecificationRef"
        },
        "state":{
            "$ref":"#/components/schemas/ServiceStateType"
        },
        "supportingResource":{
            "type":"array",
            "description":"A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources",
            "items":{
                "$ref":"#/components/schemas/ResourceRef"
            }
        },
        "supportingService":{
            "type":"array",
            "description":"A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS).",
            "items":{
                "$ref":"#/components/schemas/ServiceRefOrValue"
            }
        },
        "@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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class Extensible name."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "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."
}

• Array of: object ServiceOrderItem

{
    "type":"array",
    "description":"A list of order items embedded to this order item.",
    "items":{
        "$ref":"#/components/schemas/ServiceOrderItem"
    }
}

• Array of: object ServiceOrderItemRelationship
  Linked service order item to the one containing this attribute.

{
    "type":"array",
    "description":"A list of order items related to this order item.",
    "items":{
        "$ref":"#/components/schemas/ServiceOrderItemRelationship"
    }
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class Extensible name.
• code: string
  Error code.
• message: string
  More details and corrective actions related to the error.
• reason: string
  Explanation of the reason for the error.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  Error code extension like sys-ABC-2001.
• timestamp: string (date-time)
  Date when the error happened.

{
    "type":"object",
    "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",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "status":{
            "type":"string",
            "description":"Error code extension like sys-ABC-2001."
        },
        "timestamp":{
            "type":"string",
            "description":"Date when the error happened.",
            "format":"date-time"
        },
        "@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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class Extensible name."
        }
    },
    "description":"A ServiceOrderItemErrorMessage represents an error that causes a status change in a service order item."
}

• Array of: object Feature
  Configuration feature.

{
    "type":"array",
    "description":"A list of features associated with this service.",
    "items":{
        "$ref":"#/components/schemas/Feature"
    }
}

• Array of: object Note
  Extra information about a given entity.

{
    "type":"array",
    "description":"A list of notes made on this service.",
    "items":{
        "$ref":"#/components/schemas/Note"
    }
}

• Array of: object RelatedPlaceRefOrValue
  Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself.

{
    "type":"array",
    "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.)",
    "items":{
        "$ref":"#/components/schemas/RelatedPlaceRefOrValue"
    }
}

• Array of: object RelatedEntityRefOrValue
  A reference to an entity, where the type of the entity is not known in advance. A related entity defines an 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.

{
    "type":"array",
    "description":"A list of related  entity in relationship with this service.",
    "items":{
        "$ref":"#/components/schemas/RelatedEntityRefOrValue"
    }
}

• Array of: object RelatedParty
  Related Entity reference. A related party defines party or party role linked to a specific entity.

{
    "type":"array",
    "description":"A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity.",
    "items":{
        "$ref":"#/components/schemas/RelatedParty"
    }
}

• Array of: object Characteristic
  Describes a given characteristic of an object or entity through a name/value pair.

{
    "type":"array",
    "description":"A list of characteristics that characterize this service (ServiceCharacteristic [*]) ",
    "items":{
        "$ref":"#/components/schemas/Characteristic"
    }
}

• Array of: object RelatedServiceOrderItem
  RelatedServiceOrderItem (a ServiceOrder item). The service order item which triggered service creation/change/termination.

{
    "type":"array",
    "description":"A list of service order items related to this service.",
    "items":{
        "$ref":"#/components/schemas/RelatedServiceOrderItem"
    }
}

• Array of: object ServiceRelationship

{
    "type":"array",
    "description":"A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory.",
    "items":{
        "$ref":"#/components/schemas/ServiceRelationship"
    }
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class Extensible name.
• href: string (uri)
  Hyperlink reference
• id(required): string
  unique identifier
• name: string
  Name of the related entity.
• version: string
  Service specification version

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"unique identifier"
        },
        "href":{
            "type":"string",
            "description":"Hyperlink reference",
            "format":"uri"
        },
        "name":{
            "type":"string",
            "description":"Name of the related entity."
        },
        "version":{
            "type":"string",
            "description":"Service specification version"
        },
        "@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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class Extensible name."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "description":"Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification."
}

• Array of: object ResourceRef

{
    "type":"array",
    "description":"A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources",
    "items":{
        "$ref":"#/components/schemas/ResourceRef"
    }
}

• Array of: object ServiceRefOrValue
  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.

{
    "type":"array",
    "description":"A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS).",
    "items":{
        "$ref":"#/components/schemas/ServiceRefOrValue"
    }
}

• constraint: array constraint
  This is a list of feature constraints.
• featureCharacteristic(required): array featureCharacteristic
  Minimum Number of Items: 1

  This is a list of Characteristics for a particular feature.
• featureRelationship: array featureRelationship
• id: string
  Unique identifier of the feature.
• isBundle: boolean
  True, if this is a feature group. The default is false.
• isEnabled: boolean
  True, if this feature is enabled. The default is true.
• name(required): string
  This is the name for the feature.

{
    "required":[
        "featureCharacteristic",
        "name"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the feature."
        },
        "isBundle":{
            "type":"boolean",
            "description":"True, if this is a feature group. The default is false."
        },
        "isEnabled":{
            "type":"boolean",
            "description":"True, if this feature is enabled. The default is true."
        },
        "name":{
            "type":"string",
            "description":"This is the name for the feature."
        },
        "constraint":{
            "type":"array",
            "description":"This is a list of feature constraints.",
            "items":{
                "$ref":"#/components/schemas/ConstraintRef"
            }
        },
        "featureCharacteristic":{
            "minItems":1,
            "type":"array",
            "description":"This is a list of Characteristics for a particular feature.",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            }
        },
        "featureRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FeatureRelationship"
            }
        }
    },
    "description":"Configuration feature."
}

• Array of: object ConstraintRef
  Constraint reference. The Constraint resource represents a policy or rule applied to an entity or entity spec.

{
    "type":"array",
    "description":"This is a list of feature constraints.",
    "items":{
        "$ref":"#/components/schemas/ConstraintRef"
    }
}

• Array of: object Characteristic
  Describes a given characteristic of an object or entity through a name/value pair.

{
    "minItems":1,
    "type":"array",
    "description":"This is a list of Characteristics for a particular feature.",
    "items":{
        "$ref":"#/components/schemas/Characteristic"
    }
}

• Array of: object FeatureRelationship
  Configuration feature

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FeatureRelationship"
    }
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class Extensible name.
• href: string (uri)
  Hyperlink reference.
• id(required): string
  Unique identifier.
• name: string
  Name of the related entity.
• version: string
  Constraint version.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier."
        },
        "href":{
            "type":"string",
            "description":"Hyperlink reference.",
            "format":"uri"
        },
        "name":{
            "type":"string",
            "description":"Name of the related entity."
        },
        "version":{
            "type":"string",
            "description":"Constraint version."
        },
        "@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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class Extensible name."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "description":"Constraint reference. The Constraint resource represents a policy or rule applied to an entity or entity spec."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• name(required): string
  Name of the characteristic.
• value(required): object Any
• valueType: string
  Data type of the value of the characteristic.

{
    "required":[
        "name",
        "value"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the characteristic."
        },
        "valueType":{
            "type":"string",
            "description":"Data type of the value of the characteristic."
        },
        "value":{
            "$ref":"#/components/schemas/Any"
        },
        "@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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Describes a given characteristic of an object or entity through a name/value pair."
}

• id: string
  Unique identifier of the target feature.
• name(required): string
  This is the name of the target feature.
• relationshipType(required): string
  This is the type of the feature relationship.
• validFor: object TimePeriod
  A period of time, either as a deadline (endDateTime only) a startDateTime only, or both.

{
    "required":[
        "name",
        "relationshipType"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the target feature."
        },
        "name":{
            "type":"string",
            "description":"This is the name of the target feature."
        },
        "relationshipType":{
            "type":"string",
            "description":"This is the type of the feature relationship."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        }
    },
    "description":"Configuration feature"
}

• endDateTime: string (date-time)
  End of the time period, using IETC-RFC-3339 format.
• startDateTime: string (date-time)
  Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end.

{
    "type":"object",
    "properties":{
        "endDateTime":{
            "type":"string",
            "description":"End of the time period, using IETC-RFC-3339 format.",
            "format":"date-time"
        },
        "startDateTime":{
            "type":"string",
            "description":"Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end.",
            "format":"date-time"
        }
    },
    "description":"A period of time, either as a deadline (endDateTime only) a startDateTime only, or both."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• href: string
  Unique reference of the place.
• id: string
  Unique identifier of the place.
• name: string
  A user-friendly name for place, such as [Paris Store], [London Store], [Main Home].
• role(required): string

{
    "required":[
        "role"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the place."
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the place."
        },
        "name":{
            "type":"string",
            "description":"A user-friendly name for place, such as [Paris Store], [London Store], [Main Home]."
        },
        "role":{
            "type":"string"
        },
        "@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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "description":"Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class Extensible name.
• href: string
  Reference of the related entity.
• id: string
  Unique identifier of a related entity.
• name: string
  Name of the related entity.
• role(required): string

{
    "required":[
        "role"
    ],
    "type":"object",
    "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."
        },
        "role":{
            "type":"string"
        },
        "@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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class Extensible name."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "description":"A reference to an entity, where the type of the entity is not known in advance. A related entity defines an 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."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class Extensible name.
• href: string (uri)
  Hyperlink reference.
• id: string
  Unique identifier.
• itemAction: string
  Allowed Values: [ "add", "modify", "delete", "noChange", "suspend", "resume", "terminate" ]

  The action to be performed on the product.
• itemId: string
  Identifier of the order item where the service was managed.
• role: string
  Role of the service order item for this service.
• serviceOrderHref: string
  Reference of the related entity.
• serviceOrderId: string
  Unique identifier of a related entity.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier."
        },
        "href":{
            "type":"string",
            "description":"Hyperlink reference.",
            "format":"uri"
        },
        "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"
        },
        "@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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class Extensible name."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "description":"RelatedServiceOrderItem (a ServiceOrder item). The service order item which triggered service creation/change/termination."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class Extensible name.
• href: string (uri)
  Hyperlink reference.
• id: string
  Unique identifier.
• relationshipType(required): string
• service: object ServiceRefOrValue
  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.
• serviceRelationshipCharacteristic: array serviceRelationshipCharacteristic

{
    "required":[
        "relationshipType"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier."
        },
        "href":{
            "type":"string",
            "description":"Hyperlink reference.",
            "format":"uri"
        },
        "relationshipType":{
            "type":"string"
        },
        "service":{
            "$ref":"#/components/schemas/ServiceRefOrValue"
        },
        "serviceRelationshipCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            }
        },
        "@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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class Extensible name."
        }
    }
}

• Array of: object Characteristic
  Describes a given characteristic of an object or entity through a name/value pair.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Characteristic"
    }
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• href: string
  Reference of the related entity.
• id(required): string
  Unique identifier of a related entity.
• name: string
  Name of the resource.
• value: string
  The resource value that can be used to identify a resource. with a public key (e.g.: a tel nr, an msisdn)

{
    "required":[
        "id"
    ],
    "type":"object",
    "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 resource."
        },
        "value":{
            "type":"string",
            "description":"The resource value that can be used to identify a resource. with a public key (e.g.: a tel nr, an msisdn)"
        },
        "@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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    }
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class Extensible name.
• orderItem: object ServiceOrderItemRef
• relationshipType: string
  The type of related order item. Can be: dependency. If the order item should not be started until another order item is complete.

{
    "type":"object",
    "properties":{
        "relationshipType":{
            "type":"string",
            "description":"The type of related order item. Can be: dependency. If the order item should not be started until another order item is complete."
        },
        "orderItem":{
            "$ref":"#/components/schemas/ServiceOrderItemRef"
        },
        "@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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class Extensible name."
        }
    },
    "description":"Linked service order item to the one containing this attribute."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error shown to a client user.
• reason(required): string
  Explanation of the reason for the error shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• state: string
  HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "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 shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error shown to a client user."
        },
        "state":{
            "type":"string",
            "description":"HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx)."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error shown to a client user.
• reason(required): string
  Explanation of the reason for the error shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• state: string
  HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "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 shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error shown to a client user."
        },
        "state":{
            "type":"string",
            "description":"HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx)."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error shown to a client user.
• reason(required): string
  Explanation of the reason for the error shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• state: string
  HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "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 shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error shown to a client user."
        },
        "state":{
            "type":"string",
            "description":"HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx)."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error shown to a client user.
• reason(required): string
  Explanation of the reason for the error shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• state: string
  HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "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 shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error shown to a client user."
        },
        "state":{
            "type":"string",
            "description":"HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx)."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error shown to a client user.
• reason(required): string
  Explanation of the reason for the error shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• state: string
  HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "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 shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error shown to a client user."
        },
        "state":{
            "type":"string",
            "description":"HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx)."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error shown to a client user.
• reason(required): string
  Explanation of the reason for the error shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• state: string
  HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "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 shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error shown to a client user."
        },
        "state":{
            "type":"string",
            "description":"HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx)."
}

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error shown to a client user.
• reason(required): string
  Explanation of the reason for the error shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• state: string
  HTTP error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "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 shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error shown to a client user."
        },
        "state":{
            "type":"string",
            "description":"HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    },
    "description":"Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx)."
}