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

Get all Product Specifications

get

https://{hostname}:{port}/scd/tmf-api/productCatalogManagement/v5/productSpecification

This operation retrieves all the Product Specification entities.

Request

Query Parameters
  • The class type of the product, the service, or the resource.
  • The description of the product, the service, or the resource.
  • 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.
  • The unique identifier of the product, service, or the resource item.
    Examples

  • Not Supported -Contains one of the values, True or False. If False, then a single product offering is included. If True, then a bundle of product offerings is included.
  • Not Supported - The current lifecycle status of the product, the service, or the resource.
  • 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.
  • The name of the product, the service or the resource.
  • 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.
  • The current version of the product, the service or the resource.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Success
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : ProductSpecificationOracle
Title: ProductSpecificationOracle
Match All
Show Source
  • ProductSpecification
    Title: ProductSpecification
    Discriminator: { "propertyName":"@type", "mapping":{ "ProductSpecification":"#/components/schemas/ProductSpecification", "ProductSpecificationOracle":"#/components/schemas/ProductSpecificationOracle" } }
  • properties
Nested Schema : ProductSpecification
Type: object
Title: ProductSpecification
Discriminator: @type

Discriminator Values

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
Title: Error
Used 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
  • 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
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "Error":"#/components/schemas/Error" } }
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Show Source
Nested Schema : Extensible
Type: object
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
Show Source

401 Response

Unauthorized: Your request isn't authorized. The authentication credentials included with this request are missing or invalid.
Body ()
Root Schema : Error
Title: Error
Used 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
  • 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
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "Error":"#/components/schemas/Error" } }
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Show Source
Nested Schema : Extensible
Type: object
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
Show Source

404 Response

Not Found: Your request includes a resource URI that doesn't exist.
Body ()
Root Schema : Error
Title: Error
Used 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
  • 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
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "Error":"#/components/schemas/Error" } }
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Show Source
Nested Schema : Extensible
Type: object
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
Show Source

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
Title: Error
Used 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
  • 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
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "Error":"#/components/schemas/Error" } }
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Show Source
Nested Schema : Extensible
Type: object
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
Show Source

500 Response

Internal Server Error: The server encountered something unexpected that prevented it from completing the request.
Body ()
Root Schema : Error
Title: Error
Used 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
  • 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
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "Error":"#/components/schemas/Error" } }
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Show Source
Nested Schema : Extensible
Type: object
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
Show Source
Back to Top