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

Create a service specification

post

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

Request

There are no request parameters for this operation.

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

201 Response

Your request is successful and a new resource has been created.
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 a service specification by submitting a POST request on the REST resource using cURL.

curl -u username:password -X POST https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/serviceCatalogManagement/v3/serviceSpecification/ -D @create_serviceSpec.json | json_pp

Example of Request Body

The following shows an example of the request body.

{
    "id": "Test_ServicSpec_05272022",
    "name": "Test_ServicSpec_05272022",
    "description": "Service specification for Test",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/serviceCatalogManagement/v3/serviceSpecification/Test_ServicSpec_05272022",
    "version": "1.0",
    "lifecycleStatus": "In design",
    "created": "2022-03-08T05:15:21.000Z",
    "createdBy": "booth",
    "lastUpdate": "2022-03-08T05:19:03.220Z",
    "lastUpdatedBy": "booth",
    "isBundle": false,
    "@type": "ServiceSpecificationOracle",
    "validFor": {
        "startDateTime": "2020-01-18T00:00:00.000Z",
        "endDateTime": "2022-02-20T16:42:23.000Z"
    },
    "serviceSpecCharacteristic": [
        {
            "name": "ServiceSpecChar1",
            "description": "spec char 1 UPDATE",
            "valueType": "STRING",
            "extensible": false,
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2020-01-18T00:00:00.000Z",
                "endDateTime": "2022-02-20T16:42:23.000Z"
            },
            "serviceSpecCharacteristicValue": [
                {
                    "value": "Android Kitkat",
                    "valueType": "STRING",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2020-01-18T00:00:00.000Z",
                        "endDateTime": "2022-02-20T16:42:23.000Z"
                    },
                    "sequence": 1
                }
            ],
            "displayName": "testDN1",
            "sensitive": false
        },
        {
            "name": "ServiceSpecChar3",
            "description": "spec char 3 UPDATE",
            "valueType": "NUMBER",
            "extensible": false,
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2020-01-18T00:00:00.000Z",
                "endDateTime": "2022-02-20T16:42:23.000Z"
            },
            "serviceSpecCharacteristicValue": [
                {
                    "value": 100,
                    "valueType": "NUMBER",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2020-01-18T00:00:00.000Z",
                        "endDateTime": "2022-02-20T16:42:23.000Z"
                    },
                    "sequence": 2
                }
            ],
            "displayName": "testDN2",
            "sensitive": false
        },
        {
            "name": "ServiceSpecChar2",
            "description": "spec char 2",
            "valueType": "STRING",
            "extensible": false,
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2020-01-18T00:00:00.000Z",
                "endDateTime": "2022-02-20T16:42:23.000Z"
            },
            "serviceSpecCharacteristicValue": [
                {
                    "value": "Android Kitkat CATBURY",
                    "valueType": "STRING",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2020-01-18T00:00:00.000Z",
                        "endDateTime": "2022-02-20T16:42:23.000Z"
                    }
                }
            ],
            "displayName": "testDisName3",
            "sensitive": false
        }
    ],
    "relatedParty": [
        {
            "id": "Test11",
            "name": "TestRelated UPDATE patch it",
            "href": "TestHref",
            "role": "supplier"
        }
    ],
    "attachment": [
        {
            "href": "TestHref",
            "id": "221",
            "url": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/attachment/221",
            "attachmentType": "AGREEMENT",
            "name": "Attachment desc UPDATE patch it"
        }
    ],
    "resourceSpecification": [
        {
            "id": "421",
            "name": "Firewall UPDATE",
            "version": "1.0",
            "@referredType": "ResourceSpecificationOracle"
        }
    ]
}

Example of Response Body

The following shows an example of the response body.

{
    "id": "Test_ServicSpec_05272022",
    "name": "Test_ServicSpec_05272022",
    "description": "Service specification for Test",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/serviceCatalogManagement/v3/serviceSpecification/Test_ServicSpec_05272022",
    "version": "1.0",
    "lifecycleStatus": "In design",
    "created": "2022-05-27T05:22:05.000Z",
    "createdBy": "booth",
    "lastUpdate": "2022-05-27T05:22:11.217Z",
    "lastUpdatedBy": "booth",
    "isBundle": false,
    "@type": "ServiceSpecificationOracle",
    "validFor": {
        "startDateTime": "2020-01-18T00:00:00.000Z",
        "endDateTime": "2022-02-20T16:42:23.000Z"
    },
    "serviceSpecCharacteristic": [
        {
            "name": "ServiceSpecChar1",
            "description": "spec char 1 UPDATE",
            "valueType": "STRING",
            "extensible": false,
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2020-01-18T00:00:00.000Z",
                "endDateTime": "2022-02-20T16:42:23.000Z"
            },
            "serviceSpecCharacteristicValue": [
                {
                    "value": "Android Kitkat",
                    "valueType": "STRING",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2020-01-18T00:00:00.000Z",
                        "endDateTime": "2022-02-20T16:42:23.000Z"
                    },
                    "sequence": 1
                }
            ],
            "displayName": "testDN1",
            "sensitive": false
        },
        {
            "name": "ServiceSpecChar3",
            "description": "spec char 3 UPDATE",
            "valueType": "NUMBER",
            "extensible": false,
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2020-01-18T00:00:00.000Z",
                "endDateTime": "2022-02-20T16:42:23.000Z"
            },
            "serviceSpecCharacteristicValue": [
                {
                    "value": 100,
                    "valueType": "NUMBER",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2020-01-18T00:00:00.000Z",
                        "endDateTime": "2022-02-20T16:42:23.000Z"
                    },
                    "sequence": 2
                }
            ],
            "displayName": "testDN2",
            "sensitive": false
        },
        {
            "name": "ServiceSpecChar2",
            "description": "spec char 2",
            "valueType": "STRING",
            "extensible": false,
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2020-01-18T00:00:00.000Z",
                "endDateTime": "2022-02-20T16:42:23.000Z"
            },
            "serviceSpecCharacteristicValue": [
                {
                    "value": "Android Kitkat CATBURY",
                    "valueType": "STRING",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2020-01-18T00:00:00.000Z",
                        "endDateTime": "2022-02-20T16:42:23.000Z"
                    }
                }
            ],
            "displayName": "testDisName3",
            "sensitive": false
        }
    ],
    "relatedParty": [
        {
            "id": "Test11",
            "name": "TestRelated UPDATE patch it",
            "href": "TestHref",
            "role": "supplier"
        }
    ],
    "attachment": [
        {
            "href": "TestHref",
            "id": "221",
            "url": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/attachment/221",
            "attachmentType": "AGREEMENT",
            "name": "Attachment desc UPDATE patch it"
        }
    ],
    "resourceSpecification": [
        {
            "id": "421",
            "name": "Firewall UPDATE",
            "version": "1.0",
            "@referredType": "ResourceSpecificationOracle"
        }
    ]
}
Back to Top