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

Get all Resource Specifications

get

https://{hostname}:{port}/scd/tmf-api/resourceCatalogManagement/v4/resourceSpecification

This operation lists or finds ResourceSpecification entities

Request

Query Parameters
  • The class type of the resource.
  • The description of 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 resource.
  • The unique identifier of 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 resource. TODO
  • 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 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 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 : ResourceSpecificationOracle
Title: ResourceSpecificationOracle
Match All
Show Source
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "ResourceSpecification":"#/components/schemas/ResourceSpecification", "ResourceSpecificationOracle":"#/components/schemas/ResourceSpecificationOracle" } }
    Resources are physical or non-physical components (or some combination of these) within an enterprise's infrastructure or inventory. They are typically consumed or used by services (for example a physical port assigned to a service) or contribute to the realization of a Product (for example, a SIM card). They can be drawn from the Application, Computing and Network domains, and include, for example, Network Elements, software, IT systems, content and information, and technology components. A ResourceSpecification is an abstract base class for representing a generic means for implementing a particular type of Resource. In essence, a ResourceSpecification defines the common attributes and relationships of a set of related Resources, while Resource defines a specific instance that is based on a particular ResourceSpecification.
  • properties
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Resources are physical or non-physical components (or some combination of these) within an enterprise's infrastructure or inventory. They are typically consumed or used by services (for example a physical port assigned to a service) or contribute to the realization of a Product (for example, a SIM card). They can be drawn from the Application, Computing and Network domains, and include, for example, Network Elements, software, IT systems, content and information, and technology components. A ResourceSpecification is an abstract base class for representing a generic means for implementing a particular type of Resource. In essence, a ResourceSpecification defines the common attributes and relationships of a set of related Resources, while Resource defines a specific instance that is based on a particular ResourceSpecification.
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
Nested Schema : relatedPlaceRefOrValue
Type: array
Show Source
  • RelatedPlaceRefOrValue
    Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself
Nested Schema : serviceSpecRelationship
Type: array
Show Source
  • ServiceSpecRelationship
    Title: ServiceSpecRelationship
    A list of service spec relationships (ServiceSpecRelationship [*]). A list of service specifications related to this specification, e.g. migration, substitution, dependency or exclusivity relationship.
Nested Schema : RelatedPlaceRefOrValue
Type: object
Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself
Show Source
Nested Schema : ServiceSpecRelationship
Type: object
Title: ServiceSpecRelationship
A list of service spec relationships (ServiceSpecRelationship [*]). A list of service specifications related to this specification, e.g. migration, substitution, dependency or exclusivity relationship.
Show Source
Nested Schema : TimePeriodOracle
Type: object
Title: TimePeriodOracle
Validity period of the related party
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

403 Response

Forbidden: You don't have authorization to perform this 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

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

409 Response

Conflict: The request can't be completed due to a conflict with the current state of the resource.
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