OverviewTopPackageElement
Software Resource Specification ABE UML Documentation
Summary:AttributesPropertiesDetail:Attributes
Resource Domain::Resource Specification ABE::LogicalResource Specification ABE::Software Resource and Software Specifications ABE::Software Resource Specification ABE
Class APISpecification

The definition of an API whose attribute values are shared by every instance of an API related to it.

Attributes
String allowedApiEntities allowedApiEntities

A comma separated list of authorised entities for this API.
String allowedOperations allowedOperations

A comma separated list of authorised operations like POST, PATCH for this API.
API aPI aPI
String apiProtocolType apiProtocolType

API protocol type like REST, SOAP and so on.
String authenticationType authenticationType

The authentication type like OAUTH, SSL used for this API
String externalSchema externalSchema

The external API schema of the (external) url offered to the client of this API.
«baseType» URL externalUrl externalUrl

The url of an API offered to the user. this is seen as external url for an API brokerage.
String internalSchema internalSchema

The internal API schema of the (internal) url which an API broker uses.
«baseType» URL internalUrl internalUrl

The url of an API offered to an API brokerage.
String responseTypeFormat responseTypeFormat

Response type format of this API like Text and Json.

Attributes inherited from SID Models::Resource Domain::Resource Specification ABE::LogicalResource Specification ABE::Software Resource and Software Specifications ABE::Software Resource Specification ABE::SoftwareResourceSpecification SID Models::Resource Domain::Resource Specification ABE::LogicalResource Specification ABE::Software Resource and Software Specifications ABE::Software Resource Specification ABE::SoftwareResourceSpecification
releaseStatus releaseStatus, buildNumber buildNumber, minorVersion minorVersion, majorVersion majorVersion, isDistributable isDistributable, installSize installSize, otherDesignator otherDesignator, maintenanceVersion maintenanceVersion, isExperimental isExperimental, softwareResourceSpecRelationship softwareResourceSpecRelationship, softwareResourceSpecRelationship2 softwareResourceSpecRelationship2, _language _language

Attributes inherited from SID Models::Resource Domain::Resource Specification ABE::LogicalResource Specification ABE::LogicalResourceSpec SID Models::Resource Domain::Resource Specification ABE::LogicalResource Specification ABE::LogicalResourceSpec
physicalResourceSpec physicalResourceSpec, logicalResourceRole logicalResourceRole

Attributes inherited from SID Models::Resource Domain::Resource Specification ABE::ResourceSpecification SID Models::Resource Domain::Resource Specification ABE::ResourceSpecification
_businessInteractionItem _businessInteractionItem, _resourceSpecVersion _resourceSpecVersion, _resourceSpecification2 _resourceSpecification2, _resourceSpecification1 _resourceSpecification1, _resourceSpecType _resourceSpecType, _resource _resource, _compoundResourceSpec _compoundResourceSpec, _resourceUsageSpec _resourceUsageSpec, _resourceFacingServiceSpec _resourceFacingServiceSpec, _productSpecification2 _productSpecification2, _networkAddressSpecification _networkAddressSpecification, performancespecification performancespecification, sapSpec sapSpec, resourceCapacity resourceCapacity, resourceCapacityDemand resourceCapacityDemand, resourceCandidate resourceCandidate, supplier supplier, softwareSpecification4 softwareSpecification4, resourceConfigSpec resourceConfigSpec, resourceTestSpecRole resourceTestSpecRole, fulfilledSalesProdSpec fulfilledSalesProdSpec, purchaseProductSpecification purchaseProductSpecification, resourceSpecificationRelationship resourceSpecificationRelationship, resourceSpecificationRelationship2 resourceSpecificationRelationship2, resourceSpecCharUse resourceSpecCharUse, projectdeliverable projectdeliverable, resourcePerformanceSpec resourcePerformanceSpec

Attributes inherited from SID Models::Common Domain::Root Business Entities ABE::EntitySpecification SID Models::Common Domain::Root Business Entities ABE::EntitySpecification
_entityIdentificationSpecification _entityIdentificationSpecification, _entitySpecCharUse _entitySpecCharUse, _metricDefinition _metricDefinition, externalSystemCapability externalSystemCapability, entitySpecificationAction entitySpecificationAction, entitySpecificationType entitySpecificationType, validFor validFor, status status

Attributes inherited from SID Models::Common Domain::Root Business Entities ABE::RootEntity SID Models::Common Domain::Root Business Entities ABE::RootEntity
_rootEntityType _rootEntityType, _revenueAssuranceParmValue _revenueAssuranceParmValue, _characteristicValue _characteristicValue, name name, description description, ID ID, metric metric, _monitoredMetricInstancesCriteria _monitoredMetricInstancesCriteria, directedEdge directedEdge, vertex vertex, entityCatalogItem entityCatalogItem, rootEntityGroupMember rootEntityGroupMember, rootEntityGroup rootEntityGroup, rootEntityRelationship rootEntityRelationship, rootEntityRelationship2 rootEntityRelationship2, associationRole associationRole, entitySpecificationAttachment entitySpecificationAttachment, interactionUseCase interactionUseCase, interactionResult interactionResult

Properties:
Alias
Classifier Behavior
Is Abstractfalse
Is Activefalse
Is Leaffalse
Keywords
NameAPISpecification
Name Expression
NamespaceSoftware Resource Specification ABE
Owned Template Signature
OwnerSoftware Resource Specification ABE
Owning Template Parameter
PackageSoftware Resource Specification ABE
Qualified NameSID Models::Resource Domain::Resource Specification ABE::LogicalResource Specification ABE::Software Resource and Software Specifications ABE::Software Resource Specification ABE::APISpecification
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 allowedApiEntities 
Public String allowedApiEntities

A comma separated list of authorised entities for this API.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassAPISpecification
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1..*
NameallowedApiEntities
Name Expression
NamespaceAPISpecification
Opposite
OwnerAPISpecification
Owning Association
Owning Template Parameter
Qualified NameSID Models::Resource Domain::Resource Specification ABE::LogicalResource Specification ABE::Software Resource and Software Specifications ABE::Software Resource Specification ABE::APISpecification::allowedApiEntities
Stereotype
Template Parameter
TypeString
Upper*
Upper Value(*)
VisibilityPublic

 allowedOperations 
Public String allowedOperations

A comma separated list of authorised operations like POST, PATCH for this API.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassAPISpecification
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1..*
NameallowedOperations
Name Expression
NamespaceAPISpecification
Opposite
OwnerAPISpecification
Owning Association
Owning Template Parameter
Qualified NameSID Models::Resource Domain::Resource Specification ABE::LogicalResource Specification ABE::Software Resource and Software Specifications ABE::Software Resource Specification ABE::APISpecification::allowedOperations
Stereotype
Template Parameter
TypeString
Upper*
Upper Value(*)
VisibilityPublic

 aPI 
Public API aPI
Constraints:
Properties:

AggregationNone
Alias
AssociationAPISpecificationDescribes
Association End
ClassAPISpecification
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NameaPI
Name Expression
NamespaceAPISpecification
OppositeaPISpecification
OwnerAPISpecification
Owning Association
Owning Template Parameter
Qualified NameSID Models::Resource Domain::Resource Specification ABE::LogicalResource Specification ABE::Software Resource and Software Specifications ABE::Software Resource Specification ABE::APISpecification::aPI
Stereotype
Template Parameter
TypeAPI
Upper*
Upper Value(*)
VisibilityPublic

 apiProtocolType 
Public String apiProtocolType

API protocol type like REST, SOAP and so on.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassAPISpecification
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value
MultiplicityNone (1)
NameapiProtocolType
Name Expression
NamespaceAPISpecification
Opposite
OwnerAPISpecification
Owning Association
Owning Template Parameter
Qualified NameSID Models::Resource Domain::Resource Specification ABE::LogicalResource Specification ABE::Software Resource and Software Specifications ABE::Software Resource Specification ABE::APISpecification::apiProtocolType
Stereotype
Template Parameter
TypeString
Upper1
Upper Value
VisibilityPublic

 authenticationType 
Public String authenticationType

The authentication type like OAUTH, SSL used for this API

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassAPISpecification
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value
MultiplicityNone (1)
NameauthenticationType
Name Expression
NamespaceAPISpecification
Opposite
OwnerAPISpecification
Owning Association
Owning Template Parameter
Qualified NameSID Models::Resource Domain::Resource Specification ABE::LogicalResource Specification ABE::Software Resource and Software Specifications ABE::Software Resource Specification ABE::APISpecification::authenticationType
Stereotype
Template Parameter
TypeString
Upper1
Upper Value
VisibilityPublic

 externalSchema 
Public String externalSchema

The external API schema of the (external) url offered to the client of this API.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassAPISpecification
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value
MultiplicityNone (1)
NameexternalSchema
Name Expression
NamespaceAPISpecification
Opposite
OwnerAPISpecification
Owning Association
Owning Template Parameter
Qualified NameSID Models::Resource Domain::Resource Specification ABE::LogicalResource Specification ABE::Software Resource and Software Specifications ABE::Software Resource Specification ABE::APISpecification::externalSchema
Stereotype
Template Parameter
TypeString
Upper1
Upper Value
VisibilityPublic

 externalUrl 
Public «baseType» URL externalUrl

The url of an API offered to the user. this is seen as external url for an API brokerage.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassAPISpecification
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value
MultiplicityNone (1)
NameexternalUrl
Name Expression
NamespaceAPISpecification
Opposite
OwnerAPISpecification
Owning Association
Owning Template Parameter
Qualified NameSID Models::Resource Domain::Resource Specification ABE::LogicalResource Specification ABE::Software Resource and Software Specifications ABE::Software Resource Specification ABE::APISpecification::externalUrl
Stereotype
Template Parameter
Type«baseType» URL
Upper1
Upper Value
VisibilityPublic

 internalSchema 
Public String internalSchema

The internal API schema of the (internal) url which an API broker uses.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassAPISpecification
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value
MultiplicityNone (1)
NameinternalSchema
Name Expression
NamespaceAPISpecification
Opposite
OwnerAPISpecification
Owning Association
Owning Template Parameter
Qualified NameSID Models::Resource Domain::Resource Specification ABE::LogicalResource Specification ABE::Software Resource and Software Specifications ABE::Software Resource Specification ABE::APISpecification::internalSchema
Stereotype
Template Parameter
TypeString
Upper1
Upper Value
VisibilityPublic

 internalUrl 
Public «baseType» URL internalUrl

The url of an API offered to an API brokerage.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassAPISpecification
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value
MultiplicityNone (1)
NameinternalUrl
Name Expression
NamespaceAPISpecification
Opposite
OwnerAPISpecification
Owning Association
Owning Template Parameter
Qualified NameSID Models::Resource Domain::Resource Specification ABE::LogicalResource Specification ABE::Software Resource and Software Specifications ABE::Software Resource Specification ABE::APISpecification::internalUrl
Stereotype
Template Parameter
Type«baseType» URL
Upper1
Upper Value
VisibilityPublic

 responseTypeFormat 
Public String responseTypeFormat

Response type format of this API like Text and Json.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassAPISpecification
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value
MultiplicityNone (1)
NameresponseTypeFormat
Name Expression
NamespaceAPISpecification
Opposite
OwnerAPISpecification
Owning Association
Owning Template Parameter
Qualified NameSID Models::Resource Domain::Resource Specification ABE::LogicalResource Specification ABE::Software Resource and Software Specifications ABE::Software Resource Specification ABE::APISpecification::responseTypeFormat
Stereotype
Template Parameter
TypeString
Upper1
Upper Value
VisibilityPublic

OverviewTopPackageElement
Software Resource Specification ABE UML Documentation
Summary:AttributesPropertiesDetail:Attributes