docs/offeredapis/serviceOrder/markDown.md

   1 # This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 # http://creativecommons.org/licenses/by/4.0
   3 # Copyright 2018 Orange
   4
   5 # API ServiceOrder
   6
   7
   8 <a name="overview"></a>
   9 ## Overview
  10
  11 ### Api URL
  12
  13 [Swagger UI](https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/kl1kgvz1zR/swagger.json)
  14
  15
  16 [plant UML UI](https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/kl1kgvz1zR/plantuml&noCache=934804.0)
  17
  18 serviceOrder API designed for ONAP Beijing Release.
  19 This API is build from TMF open API18.0 (applying TMF Guideline 3.0);
  20 Only operations GET (by id and list) and POST are available.
  21
  22
  23 ### Version information
  24 *Version* : 1.0.0_inProgress
  25
  26
  27 ### URI scheme
  28 *Host* : serverRoot
  29 *BasePath* : /nbi/api/v1
  30 *Schemes* : HTTPS
  31
  32
  33 ### Tags
  34
  35 * ServiceOrder : A Service Order is a type of order which can be used to describe a group of operations on service – one service order item per service. An action at the level of the service order item describe the operation to be done on a service (add, terminate for example). The service order is triggered from the BSS system in charge of the product order management to ONAP that will manage the service fulfillment.
  36
  37
  38 ### Consumes
  39
  40 * `application/json;charset=utf-8`
  41
  42
  43 ### Produces
  44
  45 * `application/json;charset=utf-8`
  46
  47
  48 <a name="paths"></a>
  49 ## Resources
  50
  51 <a name="serviceorder_resource"></a>
  52 ### ServiceOrder
  53 A Service Order is a type of order which can be used to describe a group of operations on service – one service order item per service. An action at the level of the service order item describe the operation to be done on a service (add, terminate for example). The service order is triggered from the BSS system in charge of the product order management to ONAP that will manage the service fulfillment.
  54
  55
  56 <a name="serviceordercreate"></a>
  57 #### Create a service order
  58 ```
  59 POST /serviceOrder
  60 ```
  61
  62
  63 ##### Description
  64 This operation creates a service order entity.
  65 The TMF Open API specification document provides the list of mandatory and non mandatory attributes when creating a ServiceOrder, including any possible rule conditions and applicable default values.
  66 POST should be used without specifying the id and the href, the Service Order Management system is in charge of generating the id + href for the ServiceOrder.
  67
  68 Specific business errors for current operation will be encapsulated in
  69
  70 HTTP Response 422 Unprocessable entity
  71
  72  - 100: OrderItem with 'add' action but serviceSpecification id missing
  73
  74  - 101: OrderItem with 'change'/'noChange'/'remove' but service id missing
  75
  76  - 102: OrderItem with 'add' action - serviceSpecification id provided but not existing
  77
  78  - 103: OrderItem with 'add' action but service id already existing in the inventory
  79
  80  - 104: A customer for existing service(s) is provided but he did not exist
  81
  82  - 105: OrderItem with 'change'/'noChange'/'remove' - Service id provided but it is not existing in the inventory
  83
  84  - 106: [Not managed for current Relese] Issue with lcpCloudRegionId  and tenantId provided
  85
  86
  87 ##### Parameters
  88
  89 |Type|Name|Schema|
  90 |---|---|---|
  91 |**Body**|**serviceOrder**  <br>*required*|[CreateServiceOrder](#createserviceorder)|
  92
  93
  94 ##### Responses
  95
  96 |HTTP Code|Description|Schema|
  97 |---|---|---|
  98 |**201**|Success|[CreateServiceOrder](#createserviceorder)|
  99 |**400**|Bad Request<br><br>List of supported error codes:<br>- 20: Invalid URL parameter value<br>- 21: Missing body<br>- 22: Invalid body<br>- 23: Missing body field<br>- 24: Invalid body field<br>- 25: Missing header<br>- 26: Invalid header value<br>- 27: Missing query-string parameter<br>- 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)|
 100 |**401**|Unauthorized<br><br>List of supported error codes:<br>- 40: Missing credentials<br>- 41: Invalid credentials<br>- 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)|
 101 |**403**|Forbidden<br><br>List of supported error codes:<br>- 50: Access denied<br>- 51: Forbidden requester<br>- 52: Forbidden user<br>- 53: Too many requests|[ErrorRepresentation](#errorrepresentation)|
 102 |**404**|Not Found<br><br>List of supported error codes:<br>- 60: Resource not found|[ErrorRepresentation](#errorrepresentation)|
 103 |**422**|Unprocessable entity<br><br>Functional error<br><br>Specific encapsulated business errors for current operation<br><br> - 100: OrderItem with 'add' action but serviceSpecification id missing<br>   <br> - 101: OrderItem with 'change'/'noChange'/'remove' but service id missing<br>   <br> - 102: OrderItem with 'add' action - serviceSpecification id provided but not existing<br>   <br> - 103: OrderItem with 'add' action but service id already existing in the inventory<br>   <br> - 104: A customer for existing service(s) is provided but he did not exist<br>   <br> - 105: OrderItem with 'change'/'noChange'/'remove' - Service id provided but it is not existing in the inventory<br>   <br> - 106: [Not managed for current Relese] Issue with lcpCloudRegionId  and tenantId provided|[ErrorRepresentation](#errorrepresentation)|
 104 |**500**|Internal Server Error<br><br>List of supported error codes:<br>- 1: Internal error|[ErrorRepresentation](#errorrepresentation)|
 105 |**503**|Service Unavailable<br><br>List of supported error codes:<br>- 5: The service is temporarily unavailable<br>- 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)|
 106
 107
 108 <a name="serviceorderfind"></a>
 109 #### List service orders
 110 ```
 111 GET /serviceOrder
 112 ```
 113
 114
 115 ##### Description
 116 Retrieve and list service order entities according to given criteria.
 117 Only a predefined set of attribute is proposed.
 118 Attribute selection could be described in the fields attribute.
 119
 120 Specific business errors for current operation will be encapsulated in
 121
 122 HTTP Response 422 Unprocessable entity
 123
 124
 125 ##### Parameters
 126
 127 |Type|Name|Description|Schema|
 128 |---|---|---|---|
 129 |**Query**|**description**  <br>*optional*||string|
 130 |**Query**|**externalId**  <br>*optional*||string|
 131 |**Query**|**fields**  <br>*optional*|this attribute could be used to filter retrieved attribute(s) and/or sort SO.|string|
 132 |**Query**|**limit**  <br>*optional*|The maximum number of elements to retrieve (it can be greater than the actual available number of items).|integer (int32)|
 133 |**Query**|**offset**  <br>*optional*|The index of the first element to retrieve. Zero is the first element of the collection.|integer (int32)|
 134 |**Query**|**orderDate.gt**  <br>*optional*|order date greather than|string|
 135 |**Query**|**orderDate.lt**  <br>*optional*|order date lower than|string|
 136 |**Query**|**state**  <br>*optional*|state of the order(s) to be retrieved|string|
 137
 138
 139 ##### Responses
 140
 141 |HTTP Code|Description|Schema|
 142 |---|---|---|
 143 |**200**|Success  <br>**Headers** :   <br>`X-Total-Count` (integer (int32))  <br>`X-Result-Count` (integer (int32))|< [ServiceOrder](#serviceorder) > array|
 144 |**400**|Bad Request<br><br>List of supported error codes:<br>- 20: Invalid URL parameter value<br>- 21: Missing body<br>- 22: Invalid body<br>- 23: Missing body field<br>- 24: Invalid body field<br>- 25: Missing header<br>- 26: Invalid header value<br>- 27: Missing query-string parameter<br>- 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)|
 145 |**401**|Unauthorized<br><br>List of supported error codes:<br>- 40: Missing credentials<br>- 41: Invalid credentials<br>- 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)|
 146 |**403**|Forbidden<br><br>List of supported error codes:<br>- 50: Access denied<br>- 51: Forbidden requester<br>- 52: Forbidden user<br>- 53: Too many requests|[ErrorRepresentation](#errorrepresentation)|
 147 |**404**|Not Found<br><br>List of supported error codes:<br>- 60: Resource not found|[ErrorRepresentation](#errorrepresentation)|
 148 |**422**|Unprocessable entity<br><br>Functional error|[ErrorRepresentation](#errorrepresentation)|
 149 |**500**|Internal Server Error<br><br>List of supported error codes:<br>- 1: Internal error|[ErrorRepresentation](#errorrepresentation)|
 150 |**503**|Service Unavailable<br><br>List of supported error codes:<br>- 5: The service is temporarily unavailable<br>- 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)|
 151
 152
 153 <a name="serviceorderget"></a>
 154 #### Retrieve a service order
 155 ```
 156 GET /serviceOrder/{id}
 157 ```
 158
 159
 160 ##### Description
 161 This operation retrieves a service order entity.
 162 Attribute selection is enabled for all first level attributes.
 163
 164 Specific business errors for current operation will be encapsulated in
 165
 166 HTTP Response 422 Unprocessable entity
 167
 168
 169 ##### Parameters
 170
 171 |Type|Name|Description|Schema|
 172 |---|---|---|---|
 173 |**Path**|**id**  <br>*required*||string|
 174 |**Query**|**fields**  <br>*optional*|Attribute selection|string|
 175
 176
 177 ##### Responses
 178
 179 |HTTP Code|Description|Schema|
 180 |---|---|---|
 181 |**200**|Success|[ServiceOrder](#serviceorder)|
 182 |**400**|Bad Request<br><br>List of supported error codes:<br>- 20: Invalid URL parameter value<br>- 21: Missing body<br>- 22: Invalid body<br>- 23: Missing body field<br>- 24: Invalid body field<br>- 25: Missing header<br>- 26: Invalid header value<br>- 27: Missing query-string parameter<br>- 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)|
 183 |**401**|Unauthorized<br><br>List of supported error codes:<br>- 40: Missing credentials<br>- 41: Invalid credentials<br>- 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)|
 184 |**403**|Forbidden<br><br>List of supported error codes:<br>- 50: Access denied<br>- 51: Forbidden requester<br>- 52: Forbidden user<br>- 53: Too many requests|[ErrorRepresentation](#errorrepresentation)|
 185 |**404**|Not Found<br><br>List of supported error codes:<br>- 60: Resource not found|[ErrorRepresentation](#errorrepresentation)|
 186 |**422**|Unprocessable entity<br><br>Functional error|[ErrorRepresentation](#errorrepresentation)|
 187 |**500**|Internal Server Error<br><br>List of supported error codes:<br>- 1: Internal error|[ErrorRepresentation](#errorrepresentation)|
 188 |**503**|Service Unavailable<br><br>List of supported error codes:<br>- 5: The service is temporarily unavailable<br>- 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)|
 189
 190
 191 <a name="definitions"></a>
 192 ## Definitions
 193
 194 <a name="actiontype"></a>
 195 ### ActionType
 196 Action type to be describer on the order item.
 197 modify is not managed in Beijing release
 198
 199 *Type* : enum (add, modify, delete, noChange)
 200
 201
 202 <a name="createserviceorder"></a>
 203 ### CreateServiceOrder
 204 This structure is used in the operation POST for a serviceOrder request.
 205 Attribute description is not accurate and should be find in the serviceOrder class.
 206
 207
 208 |Name|Description|Schema|
 209 |---|---|---|
 210 |**@baseType**  <br>*optional*||string|
 211 |**@schemaLocation**  <br>*optional*||string|
 212 |**@type**  <br>*optional*||string|
 213 |**category**  <br>*optional*|Used to categorize the order that can be useful for the OM system (e.g. “broadband”, “TVOption”, ...)|string|
 214 |**description**  <br>*optional*|A free-text description of the service order|string|
 215 |**externalId**  <br>*optional*|ID given by the consumer and only understandable by him (to facilitate his searches)|string|
 216 |**orderItem**  <br>*optional*||< [CreateServiceOrderItem](#createserviceorderitem) > array|
 217 |**orderRelationship**  <br>*optional*||< [OrderRelationship](#orderrelationship) > array|
 218 |**priority**  <br>*optional*|A way that can be used by consumers to prioritize orders in Service Order Management system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)|string|
 219 |**relatedParty**  <br>*optional*||< [RelatedParty](#relatedparty) > array|
 220 |**requestedCompletionDate**  <br>*optional*|Requested delivery date from the requestor perspective|string (date-time)|
 221 |**requestedStartDate**  <br>*optional*|Order start date wished by the requestor|string (date-time)|
 222
 223
 224 <a name="createserviceorderitem"></a>
 225 ### CreateServiceOrderItem
 226 This structure is used in the operation POST for a serviceOrder request to describe an item.
 227 Attribute description is not accurate and should be find in the serviceOrderItem class.
 228
 229
 230 |Name|Description|Schema|
 231 |---|---|---|
 232 |**@baseType**  <br>*optional*|Indicates the base type of the resource.|string|
 233 |**@schemaLocation**  <br>*optional*|A link to the schema describing this REST resource|string|
 234 |**@type**  <br>*optional*|Indicates the type of resource.|string|
 235 |**action**  <br>*optional*||[ActionType](#actiontype)|
 236 |**id**  <br>*required*|Identifier of the line item (generally it is a sequence number 01, 02, 03, …)|string|
 237 |**orderItemRelationship**  <br>*optional*||< [OrderItemRelationship](#orderitemrelationship) > array|
 238 |**service**  <br>*required*||[Service](#service)|
 239
 240
 241 <a name="errorrepresentation"></a>
 242 ### ErrorRepresentation
 243 Representation of an error.
 244
 245
 246 |Name|Description|Schema|
 247 |---|---|---|
 248 |**@schemaLocation**  <br>*optional*|it provides a link to the schema describing a REST resource|string|
 249 |**@type**  <br>*optional*|The class type of a REST resource|string|
 250 |**code**  <br>*required*|Application related code (as defined in the API or from a common list)|integer (int32)|
 251 |**message**  <br>*optional*|Text that provide more details and corrective actions related to the error. This can be shown to a client user|string|
 252 |**reason**  <br>*required*|Text that explains the reason for error. This can be shown to a client user.|string|
 253 |**referenceError**  <br>*optional*|url pointing to documentation describing the error|string|
 254 |**status**  <br>*optional*|http error code extension like 400-2|string|
 255
 256
 257 <a name="hub"></a>
 258 ### Hub
 259 An HUB resource is used by client side to subscribe to notification.
 260 Not managed in the Beijing release.
 261
 262
 263 |Name|Schema|
 264 |---|---|
 265 |**callback**  <br>*required*|string|
 266 |**id**  <br>*optional*|string|
 267 |**query**  <br>*optional*|string|
 268
 269
 270 <a name="orderitemrelationship"></a>
 271 ### OrderItemRelationship
 272 Linked order item to the one containing this attribute.
 273 nbi component used this relationship to sort request to ONAP.
 274
 275
 276 |Name|Description|Schema|
 277 |---|---|---|
 278 |**id**  <br>*required*|Unique identifier of an order item|string|
 279 |**type**  <br>*required*||[RelationshipType](#relationshiptype)|
 280
 281
 282 <a name="orderrelationship"></a>
 283 ### OrderRelationship
 284 Linked order to the one containing this attribute.
 285 This relationship is not used to sort ONAP request.
 286
 287
 288 |Name|Description|Schema|
 289 |---|---|---|
 290 |**@referredType**  <br>*optional*|Type of the referred order.|string|
 291 |**href**  <br>*optional*|A hyperlink to the related order|string|
 292 |**id**  <br>*required*|The id of the related order|string|
 293 |**type**  <br>*optional*|The type of related order, can be : “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)|string|
 294
 295
 296 <a name="relatedparty"></a>
 297 ### RelatedParty
 298 A related party defines party which are involved in this order and the role they are playing.
 299 for Beijing release:
 300 With the current version of APIs used from SO and AAI we need to manage a ‘customer’. This customer concept is confusing with Customer BSS concept. We took the following rules to manage the ‘customer’ information:
 301 o       It could be provided through a serviceOrder in the service Order a relatedParty with role ‘ONAPcustomer’ should be provided in the serviceOrder header (we will not consider in this release the party at item level); External API component will check if this customer exists and create it in AAI if not.
 302 o       If no relatedParty are provided the service will be affected to ‘generic’ customer (dummy customer) – we assume this ‘generic’ customer always exists.
 303
 304
 305 |Name|Description|Schema|
 306 |---|---|---|
 307 |**@referredType**  <br>*optional*||string|
 308 |**href**  <br>*optional*|An hyperlink to the party - not used in Beijnig release|string|
 309 |**id**  <br>*required*|Unique identifier of a related party|string|
 310 |**name**  <br>*optional*|Name of the related party|string|
 311 |**role**  <br>*required*|The role of the related party (e.g. Owner, requester, fullfiller etc).<br>ONLY 'ONAPcustomer' is considered|string|
 312
 313
 314 <a name="relationshiptype"></a>
 315 ### RelationshipType
 316 Relationship type;
 317 Only reliesOn is managed in Beijing release.
 318
 319 *Type* : enum (reliesOn)
 320
 321
 322 <a name="service"></a>
 323 ### Service
 324 Service (to be added, modified, deleted) description
 325
 326
 327 |Name|Description|Schema|
 328 |---|---|---|
 329 |**@schemaLocation**  <br>*optional*|The URL to get the resource schema.<br>Not managed in Beijing Release|string|
 330 |**@type**  <br>*optional*|To define the service type<br>Not managed in Beijing Release|string|
 331 |**href**  <br>*optional*|Reference to the Service (useful for delete or modify command).<br>Not managed in Beijing release.|string|
 332 |**id**  <br>*required*|Identifier of a service instance.<br>It must be valued if orderItem action is 'delete' and corresponds to a AAI service.id|string|
 333 |**name**  <br>*optional*|Name of the service - When orderItem action is 'add' this name will be used in ONAP/SO request as InstaceName.|string|
 334 |**relatedParty**  <br>*optional*||< [RelatedParty](#relatedparty) > array|
 335 |**serviceCharacteristic**  <br>*optional*||< [ServiceCharacteristic](#servicecharacteristic) > array|
 336 |**serviceRelationship**  <br>*optional*||< [ServiceRelationship](#servicerelationship) > array|
 337 |**serviceSpecification**  <br>*optional*||[ServiceSpecificationRef](#servicespecificationref)|
 338 |**serviceState**  <br>*optional*|The lifecycle state of the service requested;<br>Not managed in Beijing release.|string|
 339
 340
 341 <a name="servicecharacteristic"></a>
 342 ### ServiceCharacteristic
 343 ServiceCharacteristic
 344
 345
 346 |Name|Description|Schema|
 347 |---|---|---|
 348 |**name**  <br>*required*|Name of characteristic|string|
 349 |**value**  <br>*optional*||[Value](#value)|
 350 |**valueType**  <br>*optional*||string|
 351
 352
 353 <a name="serviceorder"></a>
 354 ### ServiceOrder
 355 A Service Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa
 356
 357
 358 |Name|Description|Schema|
 359 |---|---|---|
 360 |**@baseType**  <br>*optional*||string|
 361 |**@schemaLocation**  <br>*optional*||string|
 362 |**@type**  <br>*optional*||string|
 363 |**category**  <br>*optional*|Used to categorize the order that can be useful for the OM system (e.g. “broadband”, “TVOption”, ...)|string|
 364 |**completionDateTime**  <br>*optional*|Date when the order was completed|string (date-time)|
 365 |**description**  <br>*optional*|A free-text description of the service order|string|
 366 |**expectedCompletionDate**  <br>*optional*||string (date-time)|
 367 |**externalId**  <br>*optional*|ID given by the consumer and only understandable by him (to facilitate his searches)|string|
 368 |**href**  <br>*optional*|Hyperlink to access the order|string|
 369 |**id**  <br>*required*|ID created on repository side|string|
 370 |**orderDate**  <br>*optional*||string (date-time)|
 371 |**orderItem**  <br>*optional*||< [ServiceOrderItem](#serviceorderitem) > array|
 372 |**orderRelationship**  <br>*optional*||< [OrderRelationship](#orderrelationship) > array|
 373 |**priority**  <br>*optional*|A way that can be used by consumers to prioritize orders in Service Order Management system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)|string|
 374 |**relatedParty**  <br>*optional*||< [RelatedParty](#relatedparty) > array|
 375 |**requestedCompletionDate**  <br>*optional*|Requested delivery date from the requestor perspective|string (date-time)|
 376 |**requestedStartDate**  <br>*optional*|Order start date wished by the requestor|string (date-time)|
 377 |**startDate**  <br>*optional*|Date when the order was started for processing|string (date-time)|
 378 |**state**  <br>*optional*||[StateType](#statetype)|
 379
 380
 381 <a name="serviceorderitem"></a>
 382 ### ServiceOrderItem
 383 An identified part of the order. A service order is decomposed into one or more order items.
 384
 385
 386 |Name|Description|Schema|
 387 |---|---|---|
 388 |**@baseType**  <br>*optional*|not used in Beijing relase|string|
 389 |**@schemaLocation**  <br>*optional*|not used in Beijing relase|string|
 390 |**@type**  <br>*optional*|Used to extend the order item.<br>not used in Beijing relase|string|
 391 |**action**  <br>*optional*||[ActionType](#actiontype)|
 392 |**id**  <br>*required*|Identifier of the line item (generally it is a sequence number 01, 02, 03, …)|string|
 393 |**orderItemRelationship**  <br>*optional*||< [OrderItemRelationship](#orderitemrelationship) > array|
 394 |**service**  <br>*required*||[Service](#service)|
 395 |**state**  <br>*optional*||[StateType](#statetype)|
 396
 397
 398 <a name="serviceref"></a>
 399 ### ServiceRef
 400 Service references
 401
 402
 403 |Name|Description|Schema|
 404 |---|---|---|
 405 |**href**  <br>*optional*|Reference of the service|string|
 406 |**id**  <br>*required*|Unique identifier of the service|string|
 407
 408
 409 <a name="servicerelationship"></a>
 410 ### ServiceRelationship
 411 Linked Services to the one instantiate
 412 nbi component used this relationship to sort request to ONAP.
 413
 414
 415 |Name|Schema|
 416 |---|---|
 417 |**service**  <br>*required*|[Service](#service)|
 418 |**type**  <br>*required*|[RelationshipType](#relationshiptype)|
 419
 420
 421 <a name="servicespecificationref"></a>
 422 ### ServiceSpecificationRef
 423 The service specification (these attributes are fetched from the catalogue).
 424
 425
 426 |Name|Description|Schema|
 427 |---|---|---|
 428 |**@baseType**  <br>*optional*|Not used in Beijing release|string|
 429 |**@schemaLocation**  <br>*optional*|Not used in Beijing release|string|
 430 |**@type**  <br>*optional*|Not used in Beijing release|string|
 431 |**href**  <br>*optional*|Reference of the service specification<br>Not used in Beijing release.|string|
 432 |**id**  <br>*required*|Unique identifier of the service specification<br>This information will be used to retrieve SDC information + mapped to SO ModelNameVersionIdin the request.|string|
 433 |**name**  <br>*optional*|Name of the service specification<br>Not used in Beijing release|string|
 434 |**targetServiceSchema**  <br>*optional*||[TargetServiceSchema](#targetserviceschema)|
 435 |**version**  <br>*optional*|Version of the service Specification<br>Not used in Beijing release|string|
 436
 437
 438 <a name="statetype"></a>
 439 ### StateType
 440 List of possible state for the order and the orderItem.
 441
 442 *Type* : enum (acknowledged, rejected, pending, held, inProgress, cancelled, completed, failed, partial)
 443
 444
 445 <a name="targetserviceschema"></a>
 446 ### TargetServiceSchema
 447 Target to the schema describing the service spec resource
 448
 449
 450 |Name|Description|Schema|
 451 |---|---|---|
 452 |**@schemaLocation**  <br>*required*|This field provided a link to the schema describing this REST resource.|string|
 453 |**@type**  <br>*required*|Indicates the (class) type of resource.|string|
 454
 455
 456 <a name="value"></a>
 457 ### Value
 458 Value is a descriptive structure for service characteristic;
 459 For Beijing we only manage 'basic' attribute - the serviceCharacteristicValue must be used.
 460
 461
 462 |Name|Description|Schema|
 463 |---|---|---|
 464 |**@schemaLocation**  <br>*optional*|This field provided a link to the schema describing this REST resource.<br>Not used in Beijing Release|string|
 465 |**@type**  <br>*optional*|Indicates the (class) type of resource.<br>Not used in Beijing Release|string|
 466 |**serviceCharacteristicValue**  <br>*optional*|Value of the characteristic.<br>This attribute must be used in Beijing Release to provide characteristic value.|string|
 467