Updates a service
Endpoint
This operation updates partially a Service entity. (TMF 640)
oauth2
Query Parameters
- @typestringEnum: [ResellerMobileLineService]Set to ResellerMobileLineService to qualify the type of id in the request.
Path Parameters
- idstringRequiredIdentifier of the Resource - msisdnPattern: ^[2-9]\d{2}[2-9]\d{6}$
Body Parameters
- objectRequiredThe information regarding the activation.
- serviceSpecificationobjectThe specification from which this service was instantiated
- isServiceEnabledbooleanIf 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
- serviceCharacteristicarray of objects
A list of characteristics that characterize this service (ServiceCharacteristic [*])
Describes a given characteristic of an object or entity through a name/value pair. - endDatestringDate when the service endsPattern: ^[?-~ -%'-;=]{0,200}$
- statestringEnum: [feasibilityChecked, designed, reserved, inactive, active, terminated]The life cycle state of the service, such as designed, reserved, active, etc...
- hasStartedbooleanIf TRUE, this Service has already been started
- startModestringThis 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 abovePattern: ^[?-~ -%'-;=]{0,200}$
- actionstringEnum: [UpdateSubscriberStatus, SwapEquipment]
- modestringObjective is to limit the data provided to safeguard parameters.Pattern: ^[?-~ -%'-;=]{0,200}$
- @schemaLocationstringA URI to a JSON-Schema file that defines additional attributes and relationshipsPattern: ^[?-~ -%'-;=]{0,200}$
- namestringName of the servicePattern: ^[?-~ -%'-;=]{0,200}$
- userNotestringObjective is to limit the data provided to safeguard parameters.Pattern: ^[?-~ -%'-;=]{0,200}$
- nciRateCenterFilterobject
- eligibilityResultobject
- waiveOrCreditActivationFeeIndicatorstringObjective is to limit the data provided to safeguard parameters.Pattern: ^[?-~ -%'-;=]{0,200}$
- relatedPartyarray of objects
A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity
Related Entity reference. A related party defines party or party role linked to a specific entity. - switchStatusstringObjective is to limit the data provided to safeguard parameters.Pattern: ^[?-~ -%'-;=]{0,200}$
- subReasonCodestringObjective is to limit the data provided to safeguard parameters.Pattern: ^[?-~ -%'-;=]{0,200}$
- relatedEntityarray of objects
A list of related entity in relationship with this service
A reference to an entity, where the type of the entity is not known in advance. A related entity defines a entity described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the Entity and not the RelatedEntityRefOrValue class itself - startDatestringDate when the service startsPattern: ^[?-~ -%'-;=]{0,200}$
- isStatefulbooleanIf TRUE, this Service can be changed without affecting any other services
- supportingServicearray of objects
A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)
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 - placearray of objects
A list of places (Place [*]). Used to define a place useful for the service (for example a geographical place whre the service is installed)
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 - serviceOrderItemarray of objects
A list of service order items related to this service
RelatedServiceOrderItem (a ServiceOrder item) .The service order item which triggered service creation/change/termination. - serviceTypestringBusiness type of the servicePattern: ^[?-~ -%'-;=]{0,200}$
- portedInNumberstringObjective is to limit the data provided to safeguard parameters.Pattern: ^[?-~ -%'-;=]{0,200}$
- @typestringWhen sub-classing, this defines the sub-class entity namePattern: ^[?-~ -%'-;=]{0,200}$
- suspendPeriodstringObjective is to limit the data provided to safeguard parameters.Pattern: ^[?-~ -%'-;=]{0,200}$
- categorystringIs it a customer facing or resource facing servicePattern: ^[?-~ -%'-;=]{0,200}$
- commonOrderIdstringObjective is to limit the data provided to safeguard parameters.Pattern: ^[?-~ -%'-;=]{0,200}$
- notearray of objects
A list of notes made on this service
Extra information about a given entity - @basetypestringWhen sub-classing, this defines the super-classPattern: ^[?-~ -%'-;=]{0,200}$
- featurearray of objects
A list of feature associated with this service
Configuration feature. - userIdstringObjective is to limit the data provided to safeguard parameters.Pattern: ^[?-~ -%'-;=]{0,200}$
- serviceRelationshiparray of objects
A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory (useful for describing relies-on, relies-from between CFS for example).
- descriptionstringFree-text description of the servicePattern: ^[?-~ -%'-;=]{0,200}$
- supportingResourcearray of objects
A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources
Resource is an abstract entity that describes the common set of attributes shared by all concrete resources (e.g. TPE, EQUIPMENT) in the inventory. - isBundlebooleanIf true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a 'atomic' service (hierachy leaf).
- reasonCodestringObjective is to limit the data provided to safeguard parameters.Pattern: ^[?-~ -%'-;=]{0,200}$
- serviceOrderNumberstringObjective is to limit the data provided to safeguard parameters.Pattern: ^[?-~ -%'-;=]{0,200}$
Responses
Body
- objectRequiredService is a base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. This gives rise to the two subclasses of Service: CustomerFacingService and ResourceFacingService.
- isServiceEnabledbooleanIf 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
- serviceSpecificationobjectThe specification from which this service was instantiated
- endDatestringDate when the service endsPattern: ^[?-~ -%'-;=]{0,200}$
- serviceCharacteristicarray of objects
A list of characteristics that characterize this service (ServiceCharacteristic [*])
Describes a given characteristic of an object or entity through a name/value pair. - hrefstringReference of the servicePattern: ^[?-~ -%'-;=]{0,200}$
- statestringEnum: [feasibilityChecked, designed, reserved, inactive, active, terminated]The life cycle state of the service, such as designed, reserved, active, etc...
- hasStartedbooleanIf TRUE, this Service has already been started
- startModestringThis 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 abovePattern: ^[?-~ -%'-;=]{0,200}$
- responseobjectA response to a request
- actionstringObjective is to limit the data provided to safeguard parameters.Pattern: ^[?-~ -%'-;=]{0,200}$
- modestringObjective is to limit the data provided to safeguard parameters.Pattern: ^[?-~ -%'-;=]{0,200}$
- @schemaLocationstringA URI to a JSON-Schema file that defines additional attributes and relationshipsPattern: ^[?-~ -%'-;=]{0,200}$
- namestringName of the servicePattern: ^[?-~ -%'-;=]{0,200}$
- userNotestringObjective is to limit the data provided to safeguard parameters.Pattern: ^[?-~ -%'-;=]{0,200}$
- nciRateCenterFilterobject
- idstringUnique identifier of the servicePattern: ^[?-~ -%'-;=]{0,200}$
- eligibilityResultobject
- serviceDatestringDate when the service was created (whatever its status).Pattern: ^[?-~ -%'-;=]{0,200}$
- waiveOrCreditActivationFeeIndicatorstringObjective is to limit the data provided to safeguard parameters.Pattern: ^[?-~ -%'-;=]{0,200}$
- relatedPartyarray of objects
A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity
Related Entity reference. A related party defines party or party role linked to a specific entity. - switchStatusstringObjective is to limit the data provided to safeguard parameters.Pattern: ^[?-~ -%'-;=]{0,200}$
- subReasonCodestringObjective is to limit the data provided to safeguard parameters.Pattern: ^[?-~ -%'-;=]{0,200}$
- relatedEntityarray of objects
A list of related entity in relationship with this service
A reference to an entity, where the type of the entity is not known in advance. A related entity defines a entity described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the Entity and not the RelatedEntityRefOrValue class itself - supportingServicearray of objects
A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)
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 - startDatestringDate when the service startsPattern: ^[?-~ -%'-;=]{0,200}$
- isStatefulbooleanIf TRUE, this Service can be changed without affecting any other services
- placearray of objects
A list of places (Place [*]). Used to define a place useful for the service (for example a geographical place whre the service is installed)
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 - serviceOrderItemarray of objects
A list of service order items related to this service
RelatedServiceOrderItem (a ServiceOrder item) .The service order item which triggered service creation/change/termination. - portedInNumberstringObjective is to limit the data provided to safeguard parameters.Pattern: ^[?-~ -%'-;=]{0,200}$
- serviceTypestringBusiness type of the servicePattern: ^[?-~ -%'-;=]{0,200}$
- suspendPeriodstringObjective is to limit the data provided to safeguard parameters.Pattern: ^[?-~ -%'-;=]{0,200}$
- @typestringWhen sub-classing, this defines the sub-class entity namePattern: ^[?-~ -%'-;=]{0,200}$
- commonOrderIdstringObjective is to limit the data provided to safeguard parameters.Pattern: ^[?-~ -%'-;=]{0,200}$
- categorystringIs it a customer facing or resource facing servicePattern: ^[?-~ -%'-;=]{0,200}$
- notearray of objects
A list of notes made on this service
Extra information about a given entity - @basetypestringWhen sub-classing, this defines the super-classPattern: ^[?-~ -%'-;=]{0,200}$
- featurearray of objects
A list of feature associated with this service
Configuration feature. - userIdstringObjective is to limit the data provided to safeguard parameters.Pattern: ^[?-~ -%'-;=]{0,200}$
- serviceRelationshiparray of objects
A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory (useful for describing relies-on, relies-from between CFS for example).
- descriptionstringFree-text description of the servicePattern: ^[?-~ -%'-;=]{0,200}$
- isBundlebooleanIf true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a 'atomic' service (hierachy leaf).
- supportingResourcearray of objects
A list of supporting resources SupportingResource Note only Service of type RFS can be associated with Resources
Resource is an abstract entity that describes the common set of attributes shared by all concrete resources (e.g. TPE, EQUIPMENT) in the inventory. - reasonCodestringObjective is to limit the data provided to safeguard parameters.Pattern: ^[?-~ -%'-;=]{0,200}$
- serviceOrderNumberstringObjective is to limit the data provided to safeguard parameters.Pattern: ^[?-~ -%'-;=]{0,200}$