1. REST API for Oracle Communications Service Catalog and Design
  2. Tasks
  3. Service Specification

Get a Service Specification

get

https://{hostname}:{port}/scd/tmf-api/serviceCatalogManagement/v4/serviceSpecification/{id}

Request

Path Parameters
Query Parameters
  • 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.

Back to Top

Response

Supported Media Types

200 Response

Success
Body ()
Root Schema : ServiceSpecificationOracle
Type: object
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.
  • properties
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 : properties
Type: object
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
The existing project is retrieved by id or name. If the project doesn't exist, a new project is created with the specified name and id.
Show Source

400 Response

Bad Request: 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
  • The class type of a REST resource.
    Example: type of resource
  • Application related code (as defined in the API or from a common list)
    Example: application error code
  • Text that provide more details and corrective actions related to the error. This can be shown to a client user.
    Example: detailed message for the error with corrective actions
  • Text that explains the reason for error. This can be shown to a client user.
    Example: reason for error
  • url pointing to documentation describing the error
    Example: url pointing to documentation describing the error
  • http error code extension like 400-2
    Example: http error code extension

401 Response

Unauthorized: 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
  • The class type of a REST resource.
    Example: type of resource
  • Application related code (as defined in the API or from a common list)
    Example: application error code
  • Text that provide more details and corrective actions related to the error. This can be shown to a client user.
    Example: detailed message for the error with corrective actions
  • Text that explains the reason for error. This can be shown to a client user.
    Example: reason for error
  • url pointing to documentation describing the error
    Example: url pointing to documentation describing the error
  • http error code extension like 400-2
    Example: http error code extension

404 Response

Not Found: Your request includes a resource URI that doesn't exist.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source
  • The class type of a REST resource.
    Example: type of resource
  • Application related code (as defined in the API or from a common list)
    Example: application error code
  • Text that provide more details and corrective actions related to the error. This can be shown to a client user.
    Example: detailed message for the error with corrective actions
  • Text that explains the reason for error. This can be shown to a client user.
    Example: reason for error
  • url pointing to documentation describing the error
    Example: url pointing to documentation describing the error
  • http error code extension like 400-2
    Example: http error code extension

405 Response

Method Not Allowed: 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
  • The class type of a REST resource.
    Example: type of resource
  • Application related code (as defined in the API or from a common list)
    Example: application error code
  • Text that provide more details and corrective actions related to the error. This can be shown to a client user.
    Example: detailed message for the error with corrective actions
  • Text that explains the reason for error. This can be shown to a client user.
    Example: reason for error
  • url pointing to documentation describing the error
    Example: url pointing to documentation describing the error
  • http error code extension like 400-2
    Example: http error code extension

500 Response

Internal Server Error: The server encountered something unexpected that prevented it from completing the request.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source
  • The class type of a REST resource.
    Example: type of resource
  • Application related code (as defined in the API or from a common list)
    Example: application error code
  • Text that provide more details and corrective actions related to the error. This can be shown to a client user.
    Example: detailed message for the error with corrective actions
  • Text that explains the reason for error. This can be shown to a client user.
    Example: reason for error
  • url pointing to documentation describing the error
    Example: url pointing to documentation describing the error
  • http error code extension like 400-2
    Example: http error code extension
Back to Top