Get all Service Specifications
get
https://{hostname}:{port}/scd/tmf-api/serviceCatalogManagement/v4/serviceSpecification
This operation lists or finds all the Service Specification entities
Request
Query Parameters
-
description: string
The description of the product, the service, or the resource.
-
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 product specification, service specification, or a resource specification.
-
id: string
The unique identifier of the product, service, or the resource item.Examples
-
lifecycleStatus: string
Not Supported - The current lifecycle status of the product, the service, or the resource.
-
limit: integer
The number of resources to be returned in the response. The minimum value that can be specified is 1, and the maximum value that can be specified is 100,000. If the specified value is greater than 100,000, then it defaults to 100,000.
-
name: string
The name of the product, the service or the resource.
-
offset: string
The record number from which the retrieval starts. The default value is zero. If no value is specified, then it defaults to zero. The value zero indicates that the retrieval will start from the beginning of the collection.
-
version: string
The current version of the product, the service or the resource.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Success
Root Schema : schema
Type:
Show Source
array-
Array of:
object ServiceSpecificationOracle
Title:
ServiceSpecificationOracle
Nested Schema : ServiceSpecificationOracle
Type:
objectTitle:
ServiceSpecificationOracleMatch All
Show Source
-
object
ServiceSpecification
Title:
ServiceSpecificationDiscriminator:{ "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. -
object
properties
Nested Schema : ServiceSpecification
Type:
objectTitle:
ServiceSpecificationDiscriminator: @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
-
@baseType: string
Immediate base (class) type of the Service Specification
-
@schemaLocation: string
A link to the schema describing this Service Specification
-
@type: string
Class type of the Service Specification
-
attachment: array
attachment
-
constraint: array
constraint
This is a list of constraint references applied to this specification
-
description: string
A string. A narrative that explains in detail what the service specification is.
-
entitySpecRelationship: array
entitySpecRelationship
Relationship to another specification
-
featureSpecification: array
featureSpecification
A list of Features for this specification.
-
href: string
A string. Reference of the service specification.
-
id: string
Maximum Length:
30A string. Unique identifier of the service specification. -
isBundle: boolean
A boolean. isBundle determines whether a ServiceSpecification represents a single ServiceSpecification (false), or a bundle of ServiceSpecification (true).
-
lastUpdate: string
(date-time)
A date time (DateTime). Date and time of the last update of the service specification.
-
lifecycleStatus: string
A string. Used to indicate the current lifecycle status of the service specification.
-
name(required): string
A string. Name of the service specification.
- relatedParty: array relatedParty
-
resourceSpecification: array
resourceSpecification
-
serviceLevelSpecification: array
serviceLevelSpecification
-
serviceSpecRelationship: array
serviceSpecRelationship
-
specCharacteristic: array
specCharacteristic
List of characteristics that the entity can take
-
targetEntitySchema: object
TargetEntitySchema
The reference object to the schema and type of target entity which is described by a specification
-
validFor: object
TimePeriod
Title:
TimePeriodThe period for which the productOffering is valid -
version: string
A string. Service specification version.
Nested Schema : properties
Type:
Show Source
object-
created: string
(date-time)
Date and time of creation
-
createdBy: string
name of the person who created
-
lastUpdatedBy: string
name of the person who updated
-
project(required): object
ProjectRef
Title:
ProjectRefThe 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. -
serviceCode: string
Code to service specification
Nested Schema : ProjectRef
Type:
objectTitle:
ProjectRefThe 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
-
href: string
Unique reference of the project/initiative
-
id: string
Unique identifier of the project/initiative
-
name: string
Name of the project/initiative. It is required to create a new project
-
version: string
Version of the project/initiative
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.
Root Schema : Error
Title:
ErrorUsed when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Match All
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source
-
object
Extensible
Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
-
object
Discriminator: @type
Discriminator:
{ "propertyName":"@type", "mapping":{ "Error":"#/components/schemas/Error" } }
Nested Schema : Discriminator: @type
Type:
objectDiscriminator: @type
Discriminator Values
Show Source-
code(required): string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
URI of documentation describing the error.
-
status: string
HTTP Error code extension
Nested Schema : Extensible
Type:
objectBase Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
-
@baseType: string
When sub-classing, this defines the super-class
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
When sub-classing, this defines the sub-class Extensible name
401 Response
Unauthorized: Your request isn't authorized. The authentication credentials included with this request are missing or invalid.
Root Schema : Error
Title:
ErrorUsed when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Match All
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source
-
object
Extensible
Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
-
object
Discriminator: @type
Discriminator:
{ "propertyName":"@type", "mapping":{ "Error":"#/components/schemas/Error" } }
Nested Schema : Discriminator: @type
Type:
objectDiscriminator: @type
Discriminator Values
Show Source-
code(required): string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
URI of documentation describing the error.
-
status: string
HTTP Error code extension
Nested Schema : Extensible
Type:
objectBase Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
-
@baseType: string
When sub-classing, this defines the super-class
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
When sub-classing, this defines the sub-class Extensible name
404 Response
Not Found: Your request includes a resource URI that doesn't exist.
Root Schema : Error
Title:
ErrorUsed when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Match All
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source
-
object
Extensible
Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
-
object
Discriminator: @type
Discriminator:
{ "propertyName":"@type", "mapping":{ "Error":"#/components/schemas/Error" } }
Nested Schema : Discriminator: @type
Type:
objectDiscriminator: @type
Discriminator Values
Show Source-
code(required): string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
URI of documentation describing the error.
-
status: string
HTTP Error code extension
Nested Schema : Extensible
Type:
objectBase Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
-
@baseType: string
When sub-classing, this defines the super-class
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
When sub-classing, this defines the sub-class Extensible name
405 Response
Method Not Allowed: HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.
Root Schema : Error
Title:
ErrorUsed when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Match All
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source
-
object
Extensible
Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
-
object
Discriminator: @type
Discriminator:
{ "propertyName":"@type", "mapping":{ "Error":"#/components/schemas/Error" } }
Nested Schema : Discriminator: @type
Type:
objectDiscriminator: @type
Discriminator Values
Show Source-
code(required): string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
URI of documentation describing the error.
-
status: string
HTTP Error code extension
Nested Schema : Extensible
Type:
objectBase Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
-
@baseType: string
When sub-classing, this defines the super-class
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
When sub-classing, this defines the sub-class Extensible name
500 Response
Internal Server Error: The server encountered something unexpected that prevented it from completing the request.
Root Schema : Error
Title:
ErrorUsed when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Match All
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source
-
object
Extensible
Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
-
object
Discriminator: @type
Discriminator:
{ "propertyName":"@type", "mapping":{ "Error":"#/components/schemas/Error" } }
Nested Schema : Discriminator: @type
Type:
objectDiscriminator: @type
Discriminator Values
Show Source-
code(required): string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
URI of documentation describing the error.
-
status: string
HTTP Error code extension
Nested Schema : Extensible
Type:
objectBase Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
-
@baseType: string
When sub-classing, this defines the super-class
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
When sub-classing, this defines the sub-class Extensible name