1. REST API Reference for Launch Cloud Service
  2. Tasks
  3. Service Specification

Update a service specification

patch

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/serviceCatalogManagement/v3/serviceSpecification/{id}

Updates the service specification that matches the specified ID using the supplied request payload.

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : ServiceSpecificationOracle
Title: ServiceSpecificationOracle
Match All
Show Source
  • ServiceSpecification
    Title: ServiceSpecification
    Discriminator: { "propertyName":"@type", "mapping":{ "ServiceSpecification":"#/components/schemas/ServiceSpecification", "ServiceSpecificationOracle":"#/components/schemas/ServiceSpecificationOracle" } }
    The serviceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics.
  • type
Nested Schema : ServiceSpecification
Type: object
Title: ServiceSpecification
Discriminator: @type

Discriminator Values

The serviceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
The project reference resource.
Show Source
Back to Top

Response

Supported Media Types

200 Response

The service specification was updated successfully.
Body ()
Root Schema : ServiceSpecificationOracle
Title: ServiceSpecificationOracle
Match All
Show Source
  • ServiceSpecification
    Title: ServiceSpecification
    Discriminator: { "propertyName":"@type", "mapping":{ "ServiceSpecification":"#/components/schemas/ServiceSpecification", "ServiceSpecificationOracle":"#/components/schemas/ServiceSpecificationOracle" } }
    The serviceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics.
  • type
Nested Schema : ServiceSpecification
Type: object
Title: ServiceSpecification
Discriminator: @type

Discriminator Values

The serviceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
The project reference resource.
Show Source

400 Response

Your request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth.
Body ()
Root Schema : Error
Type: object
Title: Error
The error resource.
Show Source

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.
Body ()
Root Schema : Error
Type: object
Title: Error
The error resource.
Show Source

404 Response

The resource with the specified URI couldn't be found.
Body ()
Root Schema : Error
Type: object
Title: Error
The error resource.
Show Source

405 Response

HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.
Body ()
Root Schema : Error
Type: object
Title: Error
The error resource.
Show Source

500 Response

The server encountered something unexpected that prevented it from completing the request.
Body ()
Root Schema : Error
Type: object
Title: Error
The error resource.
Show Source
Back to Top

Examples

The following example shows how to update a service specification by submitting a PATCH request on the REST resource using cURL. In this example, we will update the lifestyle status of the service specification to Rejected.

curl -u username:password -X PATCH \
'https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/serviceCatalogManagement/v3/serviceSpecification/

Example of Request Body

The following shows an example of the request body.

{
    "description" : "Text Roaming Service Specification",
    "validFor": {
        "startDateTime": "2024-08-09T00:00:00.000Z",
        "endDateTime": "2028-08-09T00:00:00.000Z"
    }
}

Example of Response Body

The following shows an example of the response body.

{
    "id": "SS-TXT-ROAMING",
    "name": "Text Roaming SS",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/serviceCatalogManagement/v3/serviceSpecification/SS-TXT-ROAMING",
    "version": "1.0",
    "lifecycleStatus": "In design",
    "created": "2025-01-20T13:24:50.000Z",
    "createdBy": "booth",
    "lastUpdate": "2025-02-17T10:57:47.009Z",
    "lastUpdatedBy": "booth",
    "isBundle": false,
    "@type": "ServiceSpecificationOracle",
    "description" : "Text Roaming Service Specification",
    "validFor": {
        "startDateTime": "2024-08-09T00:00:00.000Z",
        "endDateTime": "2028-08-09T00:00:00.000Z"
    }
    "project": {
        "id": "DBE_RI_ProdModel_PreSeed_PSP",
        "name": "DBE RI Product Model Preseed",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DBE_RI_ProdModel_PreSeed_PSP",
        "version": "1.0",
        "@referredType": "ProjectOracle"
    },
    "serviceCode": "/service/telco/gsm/sms"
}
Back to Top