Get a Product Specification
get
https://{hostname}:{port}/scd/tmf-api/productCatalogManagement/v5/productSpecification/{id}
This operation retrieves a Product Specification entity. Attribute selection is enabled for all first level attributes.
Request
Path Parameters
-
id(required): string
The unique identifier of the Product Specification.Examples
Query Parameters
-
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Success
Root Schema : ProductSpecificationOracle
Title:
ProductSpecificationOracleMatch All
Show Source
-
object
ProductSpecification
Title:
ProductSpecificationDiscriminator:{ "propertyName":"@type", "mapping":{ "ProductSpecification":"#/components/schemas/ProductSpecification", "ProductSpecificationOracle":"#/components/schemas/ProductSpecificationOracle" } } -
object
properties
Nested Schema : ProductSpecification
Type:
objectTitle:
ProductSpecificationDiscriminator: @type
Discriminator Values
Show Source-
@baseType: string
base class type (immediate parent) of the product specification
-
@schemaLocation: string
hyperlink reference to schema describing this object
-
@type: string
class type of the product specification
-
attachment: array
attachment
-
brand: string
The manufacturer or trademark of the specification
-
bundledProductSpecification: array
bundledProductSpecification
-
description: string
A narrative that explains in detail what the product specification is
-
href: string
Reference of the product specification
-
id: string
Maximum Length:
30Unique identifier of the product specification -
isBundle: boolean
isBundle determines whether a productSpecification represents a single productSpecification (false), or a bundle of productSpecification (true).
-
lastUpdate(required): string
(date-time)
Date and time of the last update
-
lifecycleStatus(required): string
Used to indicate the current lifecycle status
-
name(required): string
Name of the product specification
-
productNumber: string
An identification number assigned to uniquely identity the specification
-
productSpecCharacteristic: array
productSpecCharacteristic
-
productSpecificationRelationship: array
productSpecificationRelationship
- relatedParty: array relatedParty
-
resourceSpecification: array
resourceSpecification
-
serviceSpecification: array
serviceSpecification
-
targetProductSchema: object
TargetProductSchema
Title:
TargetProductSchemaThe reference object to the schema and type of target product which is described by product specification -
validFor: object
TimePeriod
Title:
TimePeriodThe period for which the productOffering is valid -
version: string
Product specification version
Nested Schema : properties
Type:
Show Source
object-
created: string
(date-time)
Date and time of the creation
-
createdBy: string
name of the person who created item
-
lastUpdatedBy: string
name of the person who updated item
-
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.
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