/
Service Catalog & Item Query

Service Catalog & Item Query

Owned by Kevin Scaggs
Jul 27, 2018
3 min read

Following is a work in progress draft with a few refinements per the Wednesday, 25 July ONAP Service Model call.   Interactions with the External API team are to follow.   Note the questions in the diagram to be explored.





Attachment Class

 

Applied stereotypes:

  • OnapModelLifecycle

    •  state: INPUT

  • OpenModelClass

 

 

Attribute   Name

Type

Mult.

Stereotypes

Description

id

String

1

OpenModelAttribute

  •  isInvariant: false

  • valueRange: no range constraint

  • support:    MANDATORY

OnapModelLifecycle

  • state:  INPUT

 

 

href

String

1

OpenModelAttribute

  •  isInvariant: false

  • valueRange: no range constraint

  • support:    MANDATORY

OnapModelLifecycle

  • state:  INPUT

 

 

name

String

1

OpenModelAttribute

  •  isInvariant: false

  • valueRange: no range constraint

  • support:    MANDATORY

OnapModelLifecycle

  • state:  INPUT

 

 

description

String

1

OpenModelAttribute

  •  isInvariant: false

  • valueRange: no range constraint

  • support:    MANDATORY

OnapModelLifecycle

  • state:  INPUT

 

 

type

String

1

OpenModelAttribute

  •  isInvariant: false

  • valueRange: no range constraint

  • support:    MANDATORY

OnapModelLifecycle

  • state:  INPUT

 

 

uri

String

1

OpenModelAttribute

  •  isInvariant: false

  • valueRange: no range constraint

  • support:    MANDATORY

OnapModelLifecycle

  • state:  INPUT

 

 

mimeType

String

1

OpenModelAttribute

  •  isInvariant: false

  • valueRange: no range constraint

  • support:    MANDATORY

OnapModelLifecycle

  • state:  INPUT

 

 

validFor

TimePeriod

1

OpenModelAttribute

  •  isInvariant: false

  • valueRange: no range constraint

  • support:    MANDATORY

OnapModelLifecycle

  • state:  INPUT

 

 





ServiceCandidate (ServiceCatalogItem)

A ServiceCandidate (ServiceCatalogItem) is an entity that makes a ServiceSpecification available to a catalog. A ServiceCandidate and its associated ServiceSpecification may be "published" (made visible) in any number of ServiceCatalogs, or in none. One ServiceSpecification can be composed of other ServiceSpecifications. These ServiceSpecifications may also be published.

 

Applied stereotypes:

  • OnapModelLifecycle

    •  state: INPUT

  • OpenModelClass

 

 

Attribute   Name

Type

Mult.

Stereotypes

Description

ID

String

1

OpenModelAttribute

  •  isInvariant: false

  • valueRange: no range constraint

  • support:    MANDATORY

OnapModelLifecycle

  • state:  INPUT

A unique identifier for the ServiceCandidate

 

 

name

String

1

OpenModelAttribute

  •  isInvariant: false

  • valueRange: no range constraint

  • support:    MANDATORY

OnapModelLifecycle

  • state:  INPUT

A word or phrase that a ServiceCandidate is known and   distinguished from other ServiceCandidates.

 

 

description

String

1

OpenModelAttribute

  •  isInvariant: false

  • valueRange: no range constraint

  • support:    MANDATORY

OnapModelLifecycle

  • state:  INPUT

A narrative that explains the ServiceCandidate.

 

 

validFor

EDate

1

OpenModelAttribute

  •  isInvariant: false

  • valueRange: no range constraint

  • support:    MANDATORY

OnapModelLifecycle

  • state:  INPUT

The period of time during which the ServiceCandidate   is applicable.

 

 

status

String

1

OpenModelAttribute

  •  isInvariant: false

  • valueRange: no range constraint

  • support:    MANDATORY

OnapModelLifecycle

  • state:  INPUT

The condition at which the ServiceCandidate exists   such as planned, active and Obsolete.

 

 

 

ServiceCatalog Class

A ServiceCatalog is a collection of ServiceCandidates representing ServiceSpecifications. ServiceCandidates define the underlying services that support a ProductOffering. ServiceCandidates are exposed to one or more Product Catalogs to be utilized to configure one or more ProductOfferings. ServiceCandidates can be exposed to one or more Service Catalogs to be utilized or incorporated in one or more ServiceCandidates. A collection may consist of similar ServiceCandidates, such as a collection of broadband ServiceCatalogCandidates or a collection of wireless ServiceCatalogCandidates. A Service Catalog contents can expose a collection of ServiceCandidates to be utilized internal/external to an enterprise.

 

Applied stereotypes:

  • OnapModelLifecycle

    •  state: INPUT

  • OpenModelClass







TimePeriod Datatype

A base / value business entity used to represent a period of time, between two timepoints

 

Attribute   Name

Type

Mult.

Access

Stereotypes

Description

startDateTime

EDate

1

RW

OpenModelAttribute

  • isInvariant: false

  • valueRange: no range constraint

  • support:    MANDATORY

OnapModelLifecycle

 An instant of time, starting at the TimePeriod  Notes: If null, then represents to the   beginning of time

 

 

endDateTime

EDate

1

RW

OpenModelAttribute

  • isInvariant: false

  • valueRange: no range constraint

  • support:    MANDATORY

OnapModelLifecycle

 An instant of time, ending at the TimePeriod:  Notes: If null, then represents to the end   of time