Skip to content
oscal

Class: Metadata

Provides information about the containing document, and defines concepts shared across the document.

URI: oscal:Metadata

 classDiagram
    class Metadata
    click Metadata href "../Metadata/"
      OscalCommon <|-- Metadata
        click OscalCommon href "../OscalCommon/"
      HasResponsibleParties <|-- Metadata
        click HasResponsibleParties href "../HasResponsibleParties/"
      
      Metadata : actions
        
          
    
        
        
        Metadata --> "*" Action : actions
        click Action href "../Action/"
    

        
      Metadata : document_ids
        
          
    
        
        
        Metadata --> "*" DocumentId : document_ids
        click DocumentId href "../DocumentId/"
    

        
      Metadata : last_modified
        
      Metadata : links
        
          
    
        
        
        Metadata --> "*" Link : links
        click Link href "../Link/"
    

        
      Metadata : locations
        
          
    
        
        
        Metadata --> "*" Location : locations
        click Location href "../Location/"
    

        
      Metadata : oscal_version
        
      Metadata : parties
        
          
    
        
        
        Metadata --> "*" Party : parties
        click Party href "../Party/"
    

        
      Metadata : props
        
          
    
        
        
        Metadata --> "*" MetadataProperty : props
        click MetadataProperty href "../MetadataProperty/"
    

        
      Metadata : published
        
      Metadata : remarks
        
      Metadata : responsible_parties
        
          
    
        
        
        Metadata --> "*" ResponsibleParty : responsible_parties
        click ResponsibleParty href "../ResponsibleParty/"
    

        
      Metadata : revisions
        
          
    
        
        
        Metadata --> "*" Revision : revisions
        click Revision href "../Revision/"
    

        
      Metadata : roles
        
          
    
        
        
        Metadata --> "*" Role : roles
        click Role href "../Role/"
    

        
      Metadata : title
        
      Metadata : version

Inheritance

Section titled “Inheritance”

Slots

Section titled “Slots”
Name Cardinality and Range Description Inheritance
title 1
MarkupLineType		 A name given to the document direct
published 0..1
DateTimeWithTimezoneType		 The date and time the document was last made available direct
last_modified 1
DateTimeWithTimezoneType		 The date and time the document was last stored for later retrieval direct
version 1
String		 Used to distinguish a specific revision of an OSCAL document direct
oscal_version 1
String		 The OSCAL model version the document was authored against direct
document_ids *
DocumentId		 Document identifiers qualified by an identifier scheme direct
revisions *
Revision		 An entry in a sequential list of revisions to the containing document, expect… direct
roles *
Role		 Defines a function, which might be assigned to a party in a specific situatio… direct
locations *
Location		 A physical point of presence, which may be associated with people, organizati… direct
parties *
Party		 An organization or person, which may be associated with roles or other concep… direct
actions *
Action		 An action applied by a role within a given party to the content direct
remarks 0..1
MarkupMultilineType		 Additional commentary about the containing object OscalCommon
responsible_parties *
ResponsibleParty		 Responsible party assignments HasResponsibleParties
props *
MetadataProperty		 A list of properties HasPropsAndLinks
links *
Link		 A list of links HasPropsAndLinks

Usages

Section titled “Usages”
used by used in type used
Catalog metadata range Metadata
Profile metadata range Metadata
AssessmentPlan metadata range Metadata
SystemSecurityPlan metadata range Metadata
AssessmentResults metadata range Metadata
ComponentDefinition metadata range Metadata
MappingCollection metadata range Metadata
PlanOfActionAndMilestones metadata range Metadata

In Subsets

Section titled “In Subsets”

Identifier and Mapping Information

Section titled “Identifier and Mapping Information”

Schema Source

Section titled “Schema Source”

Mappings

Section titled “Mappings”
Mapping Type Mapped Value
self oscal:Metadata
native oscal:Metadata

LinkML Source

Section titled “LinkML Source”

Direct

Section titled “Direct”
name: Metadata
description: Provides information about the containing document, and defines concepts
  shared across the document.
in_subset:
- oscal_metadata
from_schema: https://w3id.org/lmodel/oscal
mixins:
- OscalCommon
- HasResponsibleParties
slots:
- title
- published
- last-modified
- version
- oscal-version
- document-ids
- revisions
- roles
- locations
- parties
- actions
slot_usage:
  title:
    name: title
    description: A name given to the document.
    required: true
  last-modified:
    name: last-modified
    description: The date and time the document was last stored for later retrieval.
    required: true
  version:
    name: version
    description: Used to distinguish a specific revision of an OSCAL document.
    required: true
  oscal-version:
    name: oscal-version
    description: The OSCAL model version the document was authored against.
    required: true
  props:
    name: props
    range: MetadataProperty
  links:
    name: links
    range: Link

Induced

Section titled “Induced”
name: Metadata
description: Provides information about the containing document, and defines concepts
  shared across the document.
in_subset:
- oscal_metadata
from_schema: https://w3id.org/lmodel/oscal
mixins:
- OscalCommon
- HasResponsibleParties
slot_usage:
  title:
    name: title
    description: A name given to the document.
    required: true
  last-modified:
    name: last-modified
    description: The date and time the document was last stored for later retrieval.
    required: true
  version:
    name: version
    description: Used to distinguish a specific revision of an OSCAL document.
    required: true
  oscal-version:
    name: oscal-version
    description: The OSCAL model version the document was authored against.
    required: true
  props:
    name: props
    range: MetadataProperty
  links:
    name: links
    range: Link
attributes:
  title:
    name: title
    description: A name given to the document.
    from_schema: https://w3id.org/lmodel/oscal
    rank: 1000
    owner: Metadata
    domain_of:
    - Group
    - Control
    - Metadata
    - Revision
    - Role
    - Location
    - Resource
    - Part
    - ProfileGroup
    - Addition
    - SubjectReference
    - AssessmentPlatform
    - Activity
    - Step
    - Task
    - AssessmentPart
    - ControlPart
    - SystemComponent
    - Protocol
    - SystemUser
    - AuthorizedPrivilege
    - Observation
    - Finding
    - FindingTarget
    - Risk
    - Response
    - RequiredAsset
    - RiskLogEntry
    - InformationType
    - LeveragedAuthorization
    - Result
    - AssessmentLogEntry
    - DefinedComponent
    - PoamItem
    range: MarkupLineType
    required: true
  published:
    name: published
    description: The date and time the document was last made available.
    from_schema: https://w3id.org/lmodel/oscal
    rank: 1000
    owner: Metadata
    domain_of:
    - Metadata
    - Revision
    range: DateTimeWithTimezoneType
  last-modified:
    name: last-modified
    description: The date and time the document was last stored for later retrieval.
    from_schema: https://w3id.org/lmodel/oscal
    rank: 1000
    alias: last_modified
    owner: Metadata
    domain_of:
    - Metadata
    - Revision
    range: DateTimeWithTimezoneType
    required: true
  version:
    name: version
    description: Used to distinguish a specific revision of an OSCAL document.
    from_schema: https://w3id.org/lmodel/oscal
    rank: 1000
    owner: Metadata
    domain_of:
    - Metadata
    - Revision
    range: string
    required: true
  oscal-version:
    name: oscal-version
    description: The OSCAL model version the document was authored against.
    from_schema: https://w3id.org/lmodel/oscal
    rank: 1000
    alias: oscal_version
    owner: Metadata
    domain_of:
    - Metadata
    - Revision
    range: string
    required: true
  document-ids:
    name: document-ids
    description: Document identifiers qualified by an identifier scheme.
    from_schema: https://w3id.org/lmodel/oscal
    rank: 1000
    alias: document_ids
    owner: Metadata
    domain_of:
    - Metadata
    - Resource
    range: DocumentId
    multivalued: true
    inlined: true
    inlined_as_list: true
  revisions:
    name: revisions
    description: An entry in a sequential list of revisions to the containing document,
      expected to be in reverse chronological order (i.e. latest first).
    from_schema: https://w3id.org/lmodel/oscal
    rank: 1000
    owner: Metadata
    domain_of:
    - Metadata
    range: Revision
    multivalued: true
    inlined: true
    inlined_as_list: true
  roles:
    name: roles
    description: Defines a function, which might be assigned to a party in a specific
      situation.
    from_schema: https://w3id.org/lmodel/oscal
    rank: 1000
    owner: Metadata
    domain_of:
    - Metadata
    range: Role
    multivalued: true
    inlined: true
    inlined_as_list: true
  locations:
    name: locations
    description: A physical point of presence, which may be associated with people,
      organizations, or other concepts within the current or linked OSCAL document.
    from_schema: https://w3id.org/lmodel/oscal
    rank: 1000
    owner: Metadata
    domain_of:
    - Metadata
    range: Location
    multivalued: true
    inlined: true
    inlined_as_list: true
  parties:
    name: parties
    description: An organization or person, which may be associated with roles or
      other concepts within the current or linked OSCAL document.
    from_schema: https://w3id.org/lmodel/oscal
    rank: 1000
    owner: Metadata
    domain_of:
    - Metadata
    range: Party
    multivalued: true
    inlined: true
    inlined_as_list: true
  actions:
    name: actions
    description: An action applied by a role within a given party to the content.
    from_schema: https://w3id.org/lmodel/oscal
    rank: 1000
    owner: Metadata
    domain_of:
    - Metadata
    range: Action
    multivalued: true
    inlined: true
    inlined_as_list: true
  remarks:
    name: remarks
    description: Additional commentary about the containing object.
    from_schema: https://w3id.org/lmodel/oscal
    rank: 1000
    owner: Metadata
    domain_of:
    - OscalCommon
    - Property
    - Resource
    - ConstraintTest
    - ControlMatching
    - Removal
    - ImportSSP
    - LocalDefinitions
    - SelectObjectiveById
    - AssessmentSubjectSource
    - OnDateCondition
    - WithinDateRange
    - AtFrequency
    - TaskDependency
    - SetParameter
    - ComponentStatus
    - PortRange
    - ImplementationStatus
    - ObjectiveStatus
    - RelatedObservation
    - AssociatedRisk
    - LoggedBy
    - ImportProfile
    - SystemCharacteristics
    - SystemStatus
    - AuthorizationBoundary
    - Diagram
    - NetworkArchitecture
    - DataFlow
    - SystemImplementation
    - LeveragedAuthorization
    - SspImplementedRequirement
    - SspStatement
    - ByComponent
    - ProvidedControlImplementation
    - ControlResponsibility
    - InheritedControlImplementation
    - SatisfiedControlImplementation
    - ImportAssessmentPlan
    - AssessmentResultsLocalDefinitions
    - ImportComponentDefinition
    - ImplementedRequirement
    - ImplementedControlStatement
    - QualifierItem
    - PoamLocalDefinitions
    - RelatedFinding
    range: MarkupMultilineType
  responsible-parties:
    name: responsible-parties
    description: Responsible party assignments.
    from_schema: https://w3id.org/lmodel/oscal
    rank: 1000
    alias: responsible_parties
    owner: Metadata
    domain_of:
    - HasResponsibleParties
    - SystemCharacteristics
    range: ResponsibleParty
    multivalued: true
    inlined: true
    inlined_as_list: true
  props:
    name: props
    description: A list of properties.
    from_schema: https://w3id.org/lmodel/oscal
    rank: 1000
    owner: Metadata
    domain_of:
    - HasPropsAndLinks
    - Resource
    - Addition
    - SystemCharacteristics
    - SystemInformation
    - InformationType
    - ImpactLevel
    - AuthorizationBoundary
    - Diagram
    - NetworkArchitecture
    - DataFlow
    - SystemImplementation
    - LeveragedAuthorization
    - SspImplementedRequirement
    - SspStatement
    - ByComponent
    - Export
    - ProvidedControlImplementation
    - ControlResponsibility
    - InheritedControlImplementation
    - SatisfiedControlImplementation
    range: MetadataProperty
    multivalued: true
    inlined: true
    inlined_as_list: true
  links:
    name: links
    description: A list of links.
    from_schema: https://w3id.org/lmodel/oscal
    rank: 1000
    owner: Metadata
    domain_of:
    - HasPropsAndLinks
    - Addition
    - SystemCharacteristics
    - SystemInformation
    - InformationType
    - ImpactLevel
    - AuthorizationBoundary
    - Diagram
    - NetworkArchitecture
    - DataFlow
    - SystemImplementation
    - LeveragedAuthorization
    - SspImplementedRequirement
    - SspStatement
    - ByComponent
    - Export
    - ProvidedControlImplementation
    - ControlResponsibility
    - InheritedControlImplementation
    - SatisfiedControlImplementation
    range: Link
    multivalued: true
    inlined: true
    inlined_as_list: true