Revise a Service Order

post

https://serverRoot/tmf-api/serviceOrdering/v4.1.0.1.0/reviseServiceOrder

This operation creates a ReviseServiceOrder entity.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json;charset=utf-8 ()
Root Schema : schema
Type: object
OSM extension to create the ReviseServiceOrder resource. This represents an OSM revision request.
Show Source
Nested Schema : BaseOrderRefOSM
Type: object
OSM extension that allows for a ReviseProductOrder entity to refer to an OSM base ProductOrder by id.
Show Source
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Skipped properties: id,href,orderDate,completionDate,expectedCompletionDate,startDate,state,jeopardyAlert,errorMessage,milestone
Show Source
Nested Schema : externalReference
Type: array
Show Source
Nested Schema : note
Type: array
Additional information about the order; For example, useful to add extra delivery information that could be useful for a human process.
Show Source
Nested Schema : orderRelationship
Type: array
A list of service orders related to this order (for example, prerequisite, dependent on).
Show Source
Nested Schema : relatedParty
Type: array
A list of parties that are involved in this order and the role they are playing.
Show Source
Nested Schema : serviceOrderItem
Type: array
Minimum Number of Items: 1
A list of service order items to be processed by this order.
Show Source
Nested Schema : ExternalReference
Type: object
External reference of the individual or reference in other system.
Show Source
Nested Schema : Note
Type: object
Extra information about a given entity.
Show Source
Nested Schema : ServiceOrderRelationship
Type: object
Linked service order to the one containing this attribute.
Show Source
Nested Schema : RelatedParty
Type: object
Related Entity reference. A related party defines party or party role linked to a specific entity.
Show Source
Nested Schema : ServiceOrderItem
Type: object
Show Source
Nested Schema : AppointmentRef
Type: object
Refers an appointment, such as a Customer presentation or internal meeting or site visit.
Show Source
Nested Schema : errorMessage
Type: array
The errors causes an order item status change.
Show Source
Nested Schema : ServiceRefOrValue
Type: object
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.
Show Source
Nested Schema : serviceOrderItem
Type: array
A list of order items embedded to this order item.
Show Source
Nested Schema : serviceOrderItemRelationship
Type: array
A list of order items related to this order item.
Show Source
Nested Schema : ServiceOrderItemErrorMessage
Type: object
A ServiceOrderItemErrorMessage represents an error that causes a status change in a service order item.
Show Source
Nested Schema : feature
Type: array
A list of features associated with this service.
Show Source
Nested Schema : note
Type: array
A list of notes made on this service.
Show Source
Nested Schema : place
Type: array
A list of places (Place [*]). Used to define a place useful for the service. (For example, a geographical place whre the service is installed.)
Show Source
  • 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.
Nested Schema : relatedEntity
Type: array
A list of related entity in relationship with this service.
Show Source
  • 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.
Nested Schema : relatedParty
Type: array
A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity.
Show Source
Nested Schema : serviceCharacteristic
Type: array
A list of characteristics that characterize this service (ServiceCharacteristic [*])
Show Source
Nested Schema : serviceOrderItem
Type: array
A list of service order items related to this service.
Show Source
Nested Schema : serviceRelationship
Type: array
A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory.
Show Source
Nested Schema : ServiceSpecificationRef
Type: object
Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.
Show Source
Nested Schema : supportingResource
Type: array
A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources
Show Source
Nested Schema : supportingService
Type: array
A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS).
Show Source
  • 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.
Nested Schema : Feature
Type: object
Configuration feature.
Show Source
Nested Schema : constraint
Type: array
This is a list of feature constraints.
Show Source
Nested Schema : featureCharacteristic
Type: array
Minimum Number of Items: 1
This is a list of Characteristics for a particular feature.
Show Source
Nested Schema : featureRelationship
Type: array
Show Source
Nested Schema : ConstraintRef
Type: object
Constraint reference. The Constraint resource represents a policy or rule applied to an entity or entity spec.
Show Source
Nested Schema : Characteristic
Type: object
Describes a given characteristic of an object or entity through a name/value pair.
Show Source
Nested Schema : Any
Type: object
Nested Schema : FeatureRelationship
Type: object
Configuration feature
Show Source
Nested Schema : TimePeriod
Type: object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both.
Show Source
Nested Schema : RelatedPlaceRefOrValue
Type: object
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.
Show Source
Nested Schema : RelatedEntityRefOrValue
Type: object
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.
Show Source
Nested Schema : RelatedServiceOrderItem
Type: object
RelatedServiceOrderItem (a ServiceOrder item). The service order item which triggered service creation/change/termination.
Show Source
Nested Schema : ServiceRelationship
Type: object
Show Source
Nested Schema : serviceRelationshipCharacteristic
Type: array
Show Source
Nested Schema : ResourceRef
Type: object
Show Source
Nested Schema : ServiceOrderItemRelationship
Type: object
Linked service order item to the one containing this attribute.
Show Source
Nested Schema : ServiceOrderItemRef
Type: object
Show Source
Back to Top

Response

Supported Media Types

201 Response

Created
Body ()
Root Schema : ReviseServiceOrderOSM
Type: object
OSM extension to define the ReviseServiceOrder structure.
Show Source
Nested Schema : Error
Type: object
Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx).
Show Source
Nested Schema : ServiceOrderRef
Type: object
Service Order reference. Useful to understand through which Service order the service was instantiated in the service inventory.
Show Source

400 Response

Bad Request
Body ()
Root Schema : Error
Type: object
Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx).
Show Source

401 Response

Unauthorized
Body ()
Root Schema : Error
Type: object
Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx).
Show Source

403 Response

Forbidden
Body ()
Root Schema : Error
Type: object
Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx).
Show Source

405 Response

Method Not allowed
Body ()
Root Schema : Error
Type: object
Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx).
Show Source

409 Response

Conflict
Body ()
Root Schema : Error
Type: object
Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx).
Show Source

500 Response

Internal Server Error
Body ()
Root Schema : Error
Type: object
Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx).
Show Source
Back to Top