REST API Reference for Launch Cloud Service

Get a service specification

get

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

Returns the service specification that matches the specified ID, including its configured details.

Request

Path Parameters

id(required): string

The ID of the resource item.

Query Parameters

eligibleVersionForProject: string

The project ID.
fields: string

The comma-separated field names that are returned in the response. The field names are the names that you specify when you create or retrieve a resource.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

The service specification was returned successfully.

Root Schema : ServiceSpecificationOracle

Title: ServiceSpecificationOracle

Match All

Show Source

object 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.
object type

{
    "title":"ServiceSpecificationOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/ServiceSpecification"
        },
        {
            "type":"object",
            "properties":{
                "serviceCode":{
                    "type":"string",
                    "description":"The service code associated with the service specification."
                },
                "created":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The date and time of creation."
                },
                "createdBy":{
                    "type":"string",
                    "description":"The name of the person who created."
                },
                "lastUpdatedBy":{
                    "type":"string",
                    "description":"The name of the person who updated."
                },
                "project":{
                    "$ref":"#/components/schemas/ProjectRef",
                    "description":"The service specification."
                },
                "externalId":{
                    "type":"string",
                    "description":"The ID of the external associated with the service specification."
                },
                "applicationName":{
                    "type":"string",
                    "description":"The name of the application associated with the service specification."
                },
                "versionState":{
                    "type":"number",
                    "description":"The version state of the Service Specification."
                }
            }
        }
    ]
}

Nested Schema : ServiceSpecification

Type: object

Title: ServiceSpecification

Discriminator: @type

{
    "title":"ServiceSpecification",
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"The ID of the service specification."
        },
        "href":{
            "type":"string",
            "description":"A string. Reference of the service specification."
        },
        "version":{
            "type":"string",
            "description":"A string. Service specification version."
        },
        "name":{
            "type":"string",
            "description":"A string. Name of the service specification."
        },
        "description":{
            "type":"string",
            "description":"A string. A narrative that explains in detail what the service specification is."
        },
        "isBundle":{
            "type":"boolean",
            "description":"A boolean value that determines whether a service specification represents a single service specification (false) or a bundle of service specifications (true)."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Indicates the current lifecycle status of the service specification."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod",
            "description":"The period for which the service specification is valid."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the service specification."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the service specification."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the service specification."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"A date time (DateTime). Date and time of the last update of the service specification."
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef"
            },
            "description":"A list of related parties associated with the service specification."
        },
        "resourceSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceSpecificationRef"
            },
            "description":"A list of resource specifications associated with the service specification."
        },
        "serviceLevelSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceLevelSpecificationRef"
            },
            "description":"A list of service level specifications associated with the service specification."
        },
        "serviceSpecCharacteristic":{
            "type":"array",
            "items":{
                "anyOf":[
                    {
                        "$ref":"#/components/schemas/ServiceSpecCharacteristicOracle"
                    },
                    {
                        "$ref":"#/components/schemas/AttributeRefOracle"
                    }
                ]
            },
            "description":"A list of service specification characteristics associated with the service specification."
        },
        "serviceSpecRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceSpecRelationship"
            },
            "description":"A list of service specification relationships associated with the service specification."
        },
        "targetServiceSchema":{
            "$ref":"#/components/schemas/TargetServiceSchema",
            "description":"The service specification."
        },
        "attachment":{
            "type":"array",
            "items":{
                "anyOf":[
                    {
                        "$ref":"#/components/schemas/Attachment"
                    },
                    {
                        "$ref":"#/components/schemas/AttachmentOracle"
                    },
                    {
                        "$ref":"#/components/schemas/AttachmentRef"
                    }
                ],
                "discriminator":{
                    "propertyName":"@type",
                    "mapping":{
                        "Attachment":"#/components/schemas/Attachment",
                        "AttachmentOracle":"#/components/schemas/AttachmentOracle",
                        "AttachmentRef":"#/components/schemas/AttachmentRef"
                    }
                }
            },
            "description":"A list of attachments associated with the service specification."
        }
    },
    "required":[
        "name",
        "@type"
    ],
    "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.

Show Source

@baseType: string

The base type of the service specification.
@schemaLocation: string

The URI of the schema that defines the service specification.
@type(required): string

The class type of the service specification.
attachment: array attachment

A list of attachments associated with the service specification.
description: string

A string. A narrative that explains in detail what the service specification is.
href: string

A string. Reference of the service specification.
id: string

Maximum Length: 30

The ID of the service specification.
isBundle: boolean

A boolean value that determines whether a service specification represents a single service specification (false) or a bundle of service specifications (true).
lastUpdate: string (date-time)

A date time (DateTime). Date and time of the last update of the service specification.
lifecycleStatus: string

Indicates the current lifecycle status of the service specification.
name(required): string

A string. Name of the service specification.
relatedParty: array relatedParty

A list of related parties associated with the service specification.
resourceSpecification: array resourceSpecification

A list of resource specifications associated with the service specification.
serviceLevelSpecification: array serviceLevelSpecification

A list of service level specifications associated with the service specification.
serviceSpecCharacteristic: array serviceSpecCharacteristic

A list of service specification characteristics associated with the service specification.
serviceSpecRelationship: array serviceSpecRelationship

A list of service specification relationships associated with the service specification.
targetServiceSchema: object TargetServiceSchema

Title: TargetServiceSchema

The reference object to the schema and type of target product which is described by product specification.
validFor: object TimePeriod

Title: TimePeriod

The period for which the productOffering is valid.
version: string

A string. Service specification version.

{
    "title":"ServiceSpecification",
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"The ID of the service specification."
        },
        "href":{
            "type":"string",
            "description":"A string. Reference of the service specification."
        },
        "version":{
            "type":"string",
            "description":"A string. Service specification version."
        },
        "name":{
            "type":"string",
            "description":"A string. Name of the service specification."
        },
        "description":{
            "type":"string",
            "description":"A string. A narrative that explains in detail what the service specification is."
        },
        "isBundle":{
            "type":"boolean",
            "description":"A boolean value that determines whether a service specification represents a single service specification (false) or a bundle of service specifications (true)."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Indicates the current lifecycle status of the service specification."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod",
            "description":"The period for which the service specification is valid."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the service specification."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the service specification."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the service specification."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"A date time (DateTime). Date and time of the last update of the service specification."
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef"
            },
            "description":"A list of related parties associated with the service specification."
        },
        "resourceSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceSpecificationRef"
            },
            "description":"A list of resource specifications associated with the service specification."
        },
        "serviceLevelSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceLevelSpecificationRef"
            },
            "description":"A list of service level specifications associated with the service specification."
        },
        "serviceSpecCharacteristic":{
            "type":"array",
            "items":{
                "anyOf":[
                    {
                        "$ref":"#/components/schemas/ServiceSpecCharacteristicOracle"
                    },
                    {
                        "$ref":"#/components/schemas/AttributeRefOracle"
                    }
                ]
            },
            "description":"A list of service specification characteristics associated with the service specification."
        },
        "serviceSpecRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceSpecRelationship"
            },
            "description":"A list of service specification relationships associated with the service specification."
        },
        "targetServiceSchema":{
            "$ref":"#/components/schemas/TargetServiceSchema",
            "description":"The service specification."
        },
        "attachment":{
            "type":"array",
            "items":{
                "anyOf":[
                    {
                        "$ref":"#/components/schemas/Attachment"
                    },
                    {
                        "$ref":"#/components/schemas/AttachmentOracle"
                    },
                    {
                        "$ref":"#/components/schemas/AttachmentRef"
                    }
                ],
                "discriminator":{
                    "propertyName":"@type",
                    "mapping":{
                        "Attachment":"#/components/schemas/Attachment",
                        "AttachmentOracle":"#/components/schemas/AttachmentOracle",
                        "AttachmentRef":"#/components/schemas/AttachmentRef"
                    }
                }
            },
            "description":"A list of attachments associated with the service specification."
        }
    },
    "required":[
        "name",
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ServiceSpecification":"#/components/schemas/ServiceSpecification",
            "ServiceSpecificationOracle":"#/components/schemas/ServiceSpecificationOracle"
        }
    }
}

Nested Schema : type

Type: object

Show Source

applicationName: string

The name of the application associated with the service specification.
created: string (date-time)

The date and time of creation.
createdBy: string

The name of the person who created.
externalId: string

The ID of the external associated with the service specification.
lastUpdatedBy: string

The name of the person who updated.
project: object ProjectRef

Title: ProjectRef

The project reference resource.
serviceCode: string

The service code associated with the service specification.
versionState: number

The version state of the Service Specification.

{
    "type":"object",
    "properties":{
        "serviceCode":{
            "type":"string",
            "description":"The service code associated with the service specification."
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time of creation."
        },
        "createdBy":{
            "type":"string",
            "description":"The name of the person who created."
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"The name of the person who updated."
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef",
            "description":"The service specification."
        },
        "externalId":{
            "type":"string",
            "description":"The ID of the external associated with the service specification."
        },
        "applicationName":{
            "type":"string",
            "description":"The name of the application associated with the service specification."
        },
        "versionState":{
            "type":"number",
            "description":"The version state of the Service Specification."
        }
    }
}

Nested Schema : ProjectRef

Type: object

Title: ProjectRef

The project reference resource.

Show Source

href: string

The hyperlink reference to the project reference.
id(required): string

The ID of the project reference.
name: string

The name of the project reference.
version: string

The version of the project.

{
    "title":"ProjectRef",
    "type":"object",
    "description":"The project reference resource.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the project reference."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the project reference."
        },
        "name":{
            "type":"string",
            "description":"The name of the project reference."
        },
        "version":{
            "type":"string",
            "description":"The version of the project."
        }
    },
    "required":[
        "id"
    ]
}

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.

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list).
message: string

The text that provides more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

The text that explains the reason for error. This can be shown to a client user.
referenceError: string

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)."
        },
        "reason":{
            "type":"string",
            "description":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list).
message: string

The text that provides more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

The text that explains the reason for error. This can be shown to a client user.
referenceError: string

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)."
        },
        "reason":{
            "type":"string",
            "description":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

404 Response

The resource with the specified URI couldn't be found.

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list).
message: string

The text that provides more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

The text that explains the reason for error. This can be shown to a client user.
referenceError: string

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)."
        },
        "reason":{
            "type":"string",
            "description":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

405 Response

HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list).
message: string

The text that provides more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

The text that explains the reason for error. This can be shown to a client user.
referenceError: string

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)."
        },
        "reason":{
            "type":"string",
            "description":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

500 Response

The server encountered something unexpected that prevented it from completing the request.

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list).
message: string

The text that provides more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

The text that explains the reason for error. This can be shown to a client user.
referenceError: string

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)."
        },
        "reason":{
            "type":"string",
            "description":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

Examples

The following example shows how to get a service specification by submitting a GET request on the REST resource using cURL.

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

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",
    "validFor": {
        "startDateTime": "2024-09-03T00: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"
}