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

Create or update a service specification

put

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

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" } }
    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

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
Project Reference
Show Source
Back to Top

Response

Supported Media Types

200 Response

OK
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" } }
    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

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
Project Reference
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
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
Show Source

404 Response

Your request includes a resource URI that doesn't exist.
Body ()
Root Schema : Error
Type: object
Title: Error
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
Show Source

500 Response

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

Examples

The following example shows how to create or update a service specification by submitting a PUT request on the REST resource using cURL. In this example, we will add a resource specification to the service specification.

curl PUT "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/serviceCatalogManagement/v3/serviceSpecification/Serv_Spec_132"

Example of Request Body

The following shows an example of the request body.

{
        "id": "Test_ServicSpec_30032022334",
        "name": "Test_ServicSpec_30032022334",
        "description": "Service specification for Test_ServicSpec_30032022334"
}

Example of Response Body

The following shows an example of the response body.

{
    "id": "Test_ServicSpec_30032022334",
    "name": "Test_ServicSpec_30032022334",
    "description": "Service specification for Test_ServicSpec_30032022334",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/serviceCatalogManagement/v3/serviceSpecification/Test_ServicSpec_30032022334/Test_ServicSpec_30032022334",
    "version": "1.0",
    "lifecycleStatus": "",
    "created": "2022-03-30T11:36:53.000Z",
    "createdBy": "booth",
    "lastUpdate": "2022-05-27T07:25:37.000Z",
    "lastUpdatedBy": "booth",
    "isBundle": false,
    "@type": "ServiceSpecificationOracle"
}
Back to Top