openapi: 3.0.1 info: title: Product Catalog Management agreement resourceSpecification API description: "Product Catalog API is one of Catalog Management API Family. Product Catalog API goal is to provide a catalog of products. \n### Operations\nProduct Catalog API performs the following operations on the resources :\n- Retrieve an entity or a collection of entities depending on filter criteria\n- Partial update of an entity (including updating rules)\n- Create an entity (including default values and creation rules)\n- Delete an entity\n- Manage notification of events" version: 5.0.0 servers: - url: https://serverRoot/productCatalogManagement/v5/ tags: - name: resourceSpecification paths: /resourceSpecification: get: operationId: listResourceSpecification summary: List or find ResourceSpecification objects description: This operation list or find ResourceSpecification entities tags: - resourceSpecification parameters: - name: fields description: Comma-separated properties to be provided in response required: false in: query type: string - name: offset description: Requested index for start of resources to be provided in response required: false in: query type: integer - name: limit description: Requested number of resources to be provided in response required: false in: query type: integer responses: '200': description: Success headers: X-Result-Count: description: Actual number of items returned in the response body type: integer X-Total-Count: description: Total number of items matching criteria type: integer schema: type: array items: $ref: '#/definitions/ResourceSpecification' '400': description: Bad Request schema: $ref: '#/definitions/Error' '401': description: Unauthorized schema: $ref: '#/definitions/Error' '403': description: Forbidden schema: $ref: '#/definitions/Error' '404': description: Not Found schema: $ref: '#/definitions/Error' '405': description: Method Not allowed schema: $ref: '#/definitions/Error' '409': description: Conflict schema: $ref: '#/definitions/Error' '500': description: Internal Server Error schema: $ref: '#/definitions/Error' post: operationId: createResourceSpecification summary: Creates a ResourceSpecification description: This operation creates a ResourceSpecification entity. tags: - resourceSpecification parameters: - name: resourceSpecification description: The ResourceSpecification to be created required: true schema: $ref: '#/definitions/ResourceSpecification_Create' in: body responses: '201': description: Created schema: $ref: '#/definitions/ResourceSpecification' '400': description: Bad Request schema: $ref: '#/definitions/Error' '401': description: Unauthorized schema: $ref: '#/definitions/Error' '403': description: Forbidden schema: $ref: '#/definitions/Error' '405': description: Method Not allowed schema: $ref: '#/definitions/Error' '409': description: Conflict schema: $ref: '#/definitions/Error' '500': description: Internal Server Error schema: $ref: '#/definitions/Error' /resourceSpecification/{id}: get: operationId: retrieveResourceSpecification summary: Retrieves a ResourceSpecification by ID description: This operation retrieves a ResourceSpecification entity. Attribute selection is enabled for all first level attributes. tags: - resourceSpecification parameters: - name: id description: Identifier of the ResourceSpecification required: true type: string in: path - name: fields description: Comma-separated properties to provide in response required: false type: string in: query responses: '200': description: Success schema: $ref: '#/definitions/ResourceSpecification' '400': description: Bad Request schema: $ref: '#/definitions/Error' '401': description: Unauthorized schema: $ref: '#/definitions/Error' '403': description: Forbidden schema: $ref: '#/definitions/Error' '404': description: Not Found schema: $ref: '#/definitions/Error' '405': description: Method Not allowed schema: $ref: '#/definitions/Error' '409': description: Conflict schema: $ref: '#/definitions/Error' '500': description: Internal Server Error schema: $ref: '#/definitions/Error' patch: operationId: patchResourceSpecification summary: Updates partially a ResourceSpecification description: This operation updates partially a ResourceSpecification entity. tags: - resourceSpecification parameters: - name: id description: Identifier of the ResourceSpecification required: true type: string in: path - name: resourceSpecification description: The ResourceSpecification to be updated required: true schema: $ref: '#/definitions/ResourceSpecification_Update' in: body responses: '200': description: Updated schema: $ref: '#/definitions/ResourceSpecification' '400': description: Bad Request schema: $ref: '#/definitions/Error' '401': description: Unauthorized schema: $ref: '#/definitions/Error' '403': description: Forbidden schema: $ref: '#/definitions/Error' '404': description: Not Found schema: $ref: '#/definitions/Error' '405': description: Method Not allowed schema: $ref: '#/definitions/Error' '409': description: Conflict schema: $ref: '#/definitions/Error' '500': description: Internal Server Error schema: $ref: '#/definitions/Error' delete: operationId: deleteResourceSpecification summary: Deletes a ResourceSpecification description: This operation deletes a ResourceSpecification entity. tags: - resourceSpecification parameters: - name: id description: Identifier of the ResourceSpecification required: true type: string in: path responses: '204': description: Deleted '400': description: Bad Request schema: $ref: '#/definitions/Error' '401': description: Unauthorized schema: $ref: '#/definitions/Error' '403': description: Forbidden schema: $ref: '#/definitions/Error' '404': description: Not Found schema: $ref: '#/definitions/Error' '405': description: Method Not allowed schema: $ref: '#/definitions/Error' '409': description: Conflict schema: $ref: '#/definitions/Error' '500': description: Internal Server Error schema: $ref: '#/definitions/Error' definitions: ResourceSpecificationCharacteristicRelationship: type: object description: An aggregation, migration, substitution, dependency or exclusivity relationship between/among ResourceSpecificationCharacteristics. The specification characteristic is embedded within the specification whose ID and href are in this entity, and identified by its ID. properties: characteristicSpecificationId: type: string description: Unique identifier of the characteristic within the specification name: type: string description: Name of the target characteristic within the specification relationshipType: type: string description: Type of relationship such as aggregation, migration, substitution, dependency, exclusivity resourceSpecificationHref: type: string description: Hyperlink reference to the resource specification containing the target characteristic resourceSpecificationId: type: string description: Unique identifier of the resource specification containing the target characteristic validFor: $ref: '#/definitions/TimePeriod' description: The period for which the object is valid '@baseType': type: string description: When sub-classing, this defines the super-class '@schemaLocation': type: string format: uri description: A URI to a JSON-Schema file that defines additional attributes and relationships '@type': type: string description: When sub-classing, this defines the sub-class entity name Error: description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx) type: object required: - code - reason properties: code: type: string description: Application relevant detail, defined in the API or a common list. reason: type: string description: Explanation of the reason for the error which can be shown to a client user. message: type: string description: More details and corrective actions related to the error which can be shown to a client user. status: type: string description: HTTP Error code extension referenceError: type: string format: uri description: URI of documentation describing the error. '@baseType': type: string description: When sub-classing, this defines the super-class. '@schemaLocation': type: string format: uri description: A URI to a JSON-Schema file that defines additional attributes and relationships '@type': type: string description: When sub-classing, this defines the sub-class entity name. FeatureSpecificationRelationship: type: object description: Configuration feature required: - name - relationshipType properties: featureId: type: string description: Unique identifier of the target feature specification. name: type: string description: This is the name of the target feature specification. relationshipType: type: string description: This is the type of the feature specification relationship. resourceSpecificationHref: type: string description: Hyperlink reference to the resource specification containing the target feature resourceSpecificationId: type: string description: Unique identifier of the resource specification containing the target feature validFor: $ref: '#/definitions/TimePeriod' description: The period for which this feature spoecification relationship is valid. '@baseType': type: string description: When sub-classing, this defines the super-class '@schemaLocation': type: string format: uri description: A URI to a JSON-Schema file that defines additional attributes and relationships '@type': type: string description: When sub-classing, this defines the sub-class entity name ResourceSpecificationRelationship: type: object description: A migration, substitution, dependency or exclusivity relationship between/among resource specifications. properties: id: type: string description: Unique identifier of target ResourceSpecification href: type: string description: Reference of the target ResourceSpecification defaultQuantity: type: integer description: The default number of the related resource that should be instantiated, for example a rack would typically have 4 cards, although it could support more. maximumQuantity: type: integer description: The maximum number of the related resource that should be instantiated, for example a rack supports a maximum of 16 cards minimumQuantity: type: integer description: The minimum number of the related resource that should be instantiated, for example a rack must have at least 1 card name: type: string description: The name given to the target resource specification instance relationshipType: type: string description: Type of relationship such as migration, substitution, dependency, exclusivity role: type: string description: The association role for this resource specification characteristic: type: array items: $ref: '#/definitions/ResourceSpecificationCharacteristic' description: A characteristic that refines the relationship. For example, consider the relationship between a slot and a card. For a half-height card it is important to know the position at which the card is inserted, so a characteristic Position might be defined on the relationship to allow capturing of this in the inventory validFor: $ref: '#/definitions/TimePeriod' description: The period for which the ResourceSpecRelationship is valid '@baseType': type: string description: When sub-classing, this defines the super-class '@schemaLocation': type: string format: uri description: A URI to a JSON-Schema file that defines additional attributes and relationships '@type': type: string description: When sub-classing, this defines the sub-class entity name FeatureSpecification: type: object description: Specification for applicable configuration features for a resource specification. properties: id: type: string description: Identifier of the feature specification. Must be locally unique within the containing resource specification, thus allowing direct access to the feature spec. isBundle: type: boolean description: A flag indicating if this is a feature group (true) or not (false) isEnabled: type: boolean description: A flag indicating if the feature is enabled (true) or not (false) name: type: string description: Unique name given to the feature specification version: type: string description: Version of the feature specification constraint: type: array items: $ref: '#/definitions/ConstraintRef' description: This is a list of feature constraints featureSpecCharacteristic: type: array items: $ref: '#/definitions/FeatureSpecificationCharacteristic' description: This is a list of characteristics for a particular feature featureSpecRelationship: type: array items: $ref: '#/definitions/FeatureSpecificationRelationship' description: A dependency, exclusivity or aggratation relationship between/among feature specifications. validFor: $ref: '#/definitions/TimePeriod' description: The period for which this feature specification is valid '@baseType': type: string description: When sub-classing, this defines the super-class '@schemaLocation': type: string format: uri description: A URI to a JSON-Schema file that defines additional attributes and relationships '@type': type: string description: When sub-classing, this defines the sub-class entity name FeatureSpecificationCharacteristicValue: type: object description: A number or text that can be assigned to a FeatureSpecificationCharacteristic. required: - valueType properties: isDefault: type: boolean description: True if the value is the default value for a characteristic. rangeInterval: type: string description: Specifies the inclusion or exclusion of the valueFrom and valueTo attributes. regex: type: string description: A regular expression constraint for given value. unitOfMeasure: type: string description: A determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values. valueFrom: type: integer description: The low range value that a characteristic can take on. valueTo: type: integer description: The upper range value that a characteristic can take on. valueType: type: string description: A kind of value that the characteristic value can take on. validFor: $ref: '#/definitions/TimePeriod' description: The period of time for which a value is applicable. value: $ref: '#/definitions/Any' description: A discrete value that the characteristic can take on, or the actual value of the characteristic '@baseType': type: string description: When sub-classing, this defines the super-class '@schemaLocation': type: string format: uri description: A URI to a JSON-Schema file that defines additional attributes and relationships '@type': type: string description: When sub-classing, this defines the sub-class entity name ConstraintRef: type: object description: Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec. properties: id: type: string description: reference id to the target constraint href: type: string description: Hyperlink reference to the target constraint name: type: string description: Name given to the constraint version: type: string description: constraint version '@baseType': type: string description: When sub-classing, this defines the super-class '@schemaLocation': type: string format: uri description: A URI to a JSON-Schema file that defines additional attributes and relationships '@type': type: string description: When sub-classing, this defines the sub-class entity name '@referredType': type: string description: The (class) type of the referred constraint required: - id Quantity: type: object description: An amount in a given unit properties: amount: default: 1 type: number format: float description: Numeric value in a given unit units: type: string description: Unit ResourceSpecification_Create: type: object description: '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. Skipped properties: id,href' required: - name properties: category: type: string description: Category of the target resource like NetworkConnectivity, PhysicalLinks, Generic, L2Network and so on. description: type: string description: Description of this REST resource isBundle: type: boolean description: A flag indicates that if this resource specification is a bundled specification (true) or single (false). lastUpdate: type: string format: date-time description: Date and time of the last update of this REST resource lifecycleStatus: type: string description: Used to indicate the current lifecycle status of the resource specification name: type: string description: Name given to this REST resource version: type: string description: Resource Specification version attachment: type: array items: $ref: '#/definitions/AttachmentRefOrValue' description: Complements the description of an element (for instance a resource) through video, pictures ... featureSpecification: type: array items: $ref: '#/definitions/FeatureSpecification' description: A list of Features for this specification. relatedParty: type: array items: $ref: '#/definitions/RelatedParty' description: A related party defines party or party role linked to a specific entity. resourceSpecCharacteristic: type: array items: $ref: '#/definitions/ResourceSpecificationCharacteristic' description: A characteristic quality or distinctive feature of a ResourceSpecification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process. resourceSpecRelationship: type: array items: $ref: '#/definitions/ResourceSpecificationRelationship' description: A migration, substitution, dependency or exclusivity relationship between/among resource specifications. targetResourceSchema: $ref: '#/definitions/TargetResourceSchema' description: A target resource schema reference. The reference object to the schema and type of target resource which is described by resource specification. validFor: $ref: '#/definitions/TimePeriod' description: The period for which this REST resource is valid '@baseType': type: string description: When sub-classing, this defines the super-class '@schemaLocation': type: string format: uri description: A URI to a JSON-Schema file that defines additional attributes and relationships '@type': type: string description: When sub-classing, this defines the sub-class entity name TimePeriod: type: object description: A period of time, either as a deadline (endDateTime only) a startDateTime only, or both properties: endDateTime: type: string format: date-time description: End of the time period, using IETC-RFC-3339 format startDateTime: type: string format: date-time description: Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end ResourceSpecification: type: object description: '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: id: type: string description: Unique identifier of this REST resource href: type: string description: Hyperlink reference to this REST resource category: type: string description: Category of the target resource like NetworkConnectivity, PhysicalLinks, Generic, L2Network and so on. description: type: string description: Description of this REST resource isBundle: type: boolean description: A flag indicates that if this resource specification is a bundled specification (true) or single (false). lastUpdate: type: string format: date-time description: Date and time of the last update of this REST resource lifecycleStatus: type: string description: Used to indicate the current lifecycle status of the resource specification name: type: string description: Name given to this REST resource version: type: string description: Resource Specification version attachment: type: array items: $ref: '#/definitions/AttachmentRefOrValue' description: Complements the description of an element (for instance a resource) through video, pictures ... featureSpecification: type: array items: $ref: '#/definitions/FeatureSpecification' description: A list of Features for this specification. relatedParty: type: array items: $ref: '#/definitions/RelatedParty' description: A related party defines party or party role linked to a specific entity. resourceSpecCharacteristic: type: array items: $ref: '#/definitions/ResourceSpecificationCharacteristic' description: A characteristic quality or distinctive feature of a ResourceSpecification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process. resourceSpecRelationship: type: array items: $ref: '#/definitions/ResourceSpecificationRelationship' description: A migration, substitution, dependency or exclusivity relationship between/among resource specifications. targetResourceSchema: $ref: '#/definitions/TargetResourceSchema' description: A target resource schema reference. The reference object to the schema and type of target resource which is described by resource specification. validFor: $ref: '#/definitions/TimePeriod' description: The period for which this REST resource is valid '@baseType': type: string description: When sub-classing, this defines the super-class '@schemaLocation': type: string format: uri description: A URI to a JSON-Schema file that defines additional attributes and relationships '@type': type: string description: When sub-classing, this defines the sub-class entity name ResourceSpecificationCharacteristic: type: object description: 'This class defines the characteristic features of a resource specification. Every ResourceSpecification has a variety of important attributes, methods, constraints, and relationships, which distinguish a resource specification from other resource specifications.' properties: id: type: string description: Unique ID for the characteristic configurable: type: boolean description: If true, the Boolean indicates that the ResourceSpecCharacteristic is configurable description: type: string description: A narrative that explains the CharacteristicSpecification. extensible: type: boolean description: An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for a resource. isUnique: type: boolean description: An indicator that specifies if a value is unique for the specification. Possible values are; "unique while value is in effect" and "unique whether value is in effect or not" maxCardinality: type: integer description: The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality. minCardinality: type: integer description: The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality. name: type: string description: A word, term, or phrase by which this characteristic specification is known and distinguished from other characteristic specifications. regex: type: string description: A rule or principle represented in regular expression used to derive the value of a characteristic value. valueType: type: string description: A kind of value that the characteristic can take on, such as numeric, text and so forth resourceSpecCharRelationship: type: array items: $ref: '#/definitions/ResourceSpecificationCharacteristicRelationship' description: An aggregation, migration, substitution, dependency or exclusivity relationship between/among Specification Characteristics. resourceSpecCharacteristicValue: type: array items: $ref: '#/definitions/ResourceSpecificationCharacteristicValue' description: A ResourceSpecificationCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a ResourceSpecificationCharacteristic object. The values of the attributes in the ResourceSpecificationCharacteristicValue object describe the values of the attributes that a corresponding ResourceSpecificationCharacteristic object can take on. validFor: $ref: '#/definitions/TimePeriod' description: The period of time for which a characteristic is applicable. '@baseType': type: string description: When sub-classing, this defines the super-class '@schemaLocation': type: string format: uri description: A URI to a JSON-Schema file that defines additional attributes and relationships '@type': type: string description: When sub-classing, this defines the sub-class entity name '@valueSchemaLocation': type: string description: This (optional) field provides a link to the schema describing the value type. Any: {} TargetResourceSchema: type: object description: The reference object to the schema and type of target resource which is described by resource specification required: - '@schemaLocation' - '@type' properties: '@baseType': type: string description: When sub-classing, this defines the super-class '@schemaLocation': type: string description: This field provides a link to the schema describing the target resource '@type': type: string description: Class type of the target resource ResourceSpecificationCharacteristicValue: type: object description: A number or text that can be assigned to a ResourceSpecCharacteristic. properties: isDefault: type: boolean description: If true, the Boolean Indicates if the value is the default value for a characteristic rangeInterval: type: string description: An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are "open", "closed", "closedBottom" and "closedTop". regex: type: string description: A regular expression constraint for given value unitOfMeasure: type: string description: A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot. valueFrom: type: integer description: The low range value that a characteristic can take on valueTo: type: integer description: The upper range value that a characteristic can take on valueType: type: string description: A kind of value that the characteristic value can take on, such as numeric, text and so forth validFor: $ref: '#/definitions/TimePeriod' description: The period of time for which a value is applicable. value: $ref: '#/definitions/Any' description: A discrete value that the characteristic can take on, or the actual value of the characteristic '@baseType': type: string description: When sub-classing, this defines the super-class '@schemaLocation': type: string format: uri description: A URI to a JSON-Schema file that defines additional attributes and relationships '@type': type: string description: When sub-classing, this defines the sub-class entity name AttachmentRefOrValue: type: object description: An attachment by value or by reference. For AttachmentRefOrValue, the attribute type,schemaLocation and referredType are related to the contained entity and not to AttchmentRefOrValue itself properties: id: type: string description: Unique identifier for this particular attachment href: type: string description: URI for this Attachment attachmentType: type: string description: Attachment type such as video, picture content: type: string description: The actual contents of the attachment object, if embedded, encoded as base64 description: type: string description: A narrative text describing the content of the attachment mimeType: type: string description: Attachment mime type such as extension file for video, picture and document name: type: string description: The name of the attachment url: type: string description: Uniform Resource Locator, is a web page address (a subset of URI) size: $ref: '#/definitions/Quantity' description: The size of the attachment. validFor: $ref: '#/definitions/TimePeriod' description: The period of time for which the attachment is valid '@baseType': type: string description: When sub-classing, this defines the super-class '@schemaLocation': type: string format: uri description: A URI to a JSON-Schema file that defines additional attributes and relationships '@type': type: string description: When sub-classing, this defines the sub-class entity name '@referredType': type: string description: The actual type of the target instance when needed for disambiguation. FeatureSpecificationCharacteristic: type: object description: Configuration feature characteristic specification. required: - name properties: configurable: type: boolean description: True is the feature is configurable. extensible: type: boolean description: An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for a feature. isUnique: type: boolean description: An indicator that specifies if a value is unique for the specification. maxCardinality: type: integer description: The maximum number of instances a CharacteristicValue can take on. minCardinality: type: integer description: The minimum number of instances a CharacteristicValue can take on. name: type: string description: This is the name for the feature charateristic. regex: type: string description: A rule or principle represented in regular expression used to derive the value of a characteristic value. valueType: type: string description: A kind of value that the characteristic can take on. featureSpecCharRelationship: type: array items: $ref: '#/definitions/FeatureSpecificationCharacteristicRelationship' description: An aggregation, migration, substitution, dependency or exclusivity relationship between/among feature characteristics. featureSpecCharacteristicValue: type: array items: $ref: '#/definitions/FeatureSpecificationCharacteristicValue' description: Used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a FeatureCharacteristic object. validFor: $ref: '#/definitions/TimePeriod' description: The period of time for which a characteristic is applicable. '@baseType': type: string description: When sub-classing, this defines the super-class '@schemaLocation': type: string format: uri description: A URI to a JSON-Schema file that defines additional attributes and relationships '@type': type: string description: When sub-classing, this defines the sub-class entity name '@valueSchemaLocation': type: string description: This (optional) field provides a link to the schema describing the value type. ResourceSpecification_Update: type: object description: '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. Skipped properties: id,href' properties: category: type: string description: Category of the target resource like NetworkConnectivity, PhysicalLinks, Generic, L2Network and so on. description: type: string description: Description of this REST resource isBundle: type: boolean description: A flag indicates that if this resource specification is a bundled specification (true) or single (false). lastUpdate: type: string format: date-time description: Date and time of the last update of this REST resource lifecycleStatus: type: string description: Used to indicate the current lifecycle status of the resource specification name: type: string description: Name given to this REST resource version: type: string description: Resource Specification version attachment: type: array items: $ref: '#/definitions/AttachmentRefOrValue' description: Complements the description of an element (for instance a resource) through video, pictures ... featureSpecification: type: array items: $ref: '#/definitions/FeatureSpecification' description: A list of Features for this specification. relatedParty: type: array items: $ref: '#/definitions/RelatedParty' description: A related party defines party or party role linked to a specific entity. resourceSpecCharacteristic: type: array items: $ref: '#/definitions/ResourceSpecificationCharacteristic' description: A characteristic quality or distinctive feature of a ResourceSpecification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process. resourceSpecRelationship: type: array items: $ref: '#/definitions/ResourceSpecificationRelationship' description: A migration, substitution, dependency or exclusivity relationship between/among resource specifications. targetResourceSchema: $ref: '#/definitions/TargetResourceSchema' description: A target resource schema reference. The reference object to the schema and type of target resource which is described by resource specification. validFor: $ref: '#/definitions/TimePeriod' description: The period for which this REST resource is valid '@baseType': type: string description: When sub-classing, this defines the super-class '@schemaLocation': type: string format: uri description: A URI to a JSON-Schema file that defines additional attributes and relationships '@type': type: string description: When sub-classing, this defines the sub-class entity name FeatureSpecificationCharacteristicRelationship: type: object description: An aggregation, migration, substitution, dependency or exclusivity relationship between/among FeatureSpecificationCharacteristics. properties: characteristicId: type: string description: Unique identifier of the characteristic within the the target feature specification featureId: type: string description: Unique identifier of the target feature specification within the resource specification. name: type: string description: Name of the target characteristic relationshipType: type: string description: Type of relationship such as aggregation, migration, substitution, dependency, exclusivity resourceSpecificationHref: type: string description: Hyperlink reference to the resource specification containing the target feature and feature characteristic resourceSpecificationId: type: string description: Unique identifier of the resource specification containing the target feature and feature characteristic validFor: $ref: '#/definitions/TimePeriod' description: The period for which the object is valid '@baseType': type: string description: When sub-classing, this defines the super-class '@schemaLocation': type: string format: uri description: A URI to a JSON-Schema file that defines additional attributes and relationships '@type': type: string description: When sub-classing, this defines the sub-class entity name RelatedParty: type: object description: Related Entity reference. A related party defines party or party role linked to a specific entity. required: - '@referredType' - id properties: id: type: string description: Unique identifier of a related entity. href: type: string description: Reference of the related entity. name: type: string description: Name of the related entity. role: type: string description: Role played by the related party '@baseType': type: string description: When sub-classing, this defines the super-class '@schemaLocation': type: string format: uri description: A URI to a JSON-Schema file that defines additional attributes and relationships '@type': type: string description: When sub-classing, this defines the sub-class entity name '@referredType': type: string description: The actual type of the target instance when needed for disambiguation.