Skip to content

Latest commit

 

History

History
266 lines (157 loc) · 8.17 KB

relationship.md

File metadata and controls

266 lines (157 loc) · 8.17 KB

Relationship Object

Represents a relationship between two entities

Property Type Description Required?
id String Globally unique URI identifying this object. ✓
relationship_type RelationshipType String ✓
schema_version String CTIM schema version for this entity ✓
source_ref String ✓
target_ref String ✓
type RelationshipTypeIdentifier String ✓
description Markdown String A description of object, which may be detailed.
external_ids String List
external_references ExternalReference Object List Specifies a list of external references which refers to non-CTIM information. This property is used to provide one or more URLs, descriptions, or IDs to records in other systems.
language ShortString String The human language this object is specified in.
revision Integer A monotonically increasing revision, incremented each time the object is changed.
short_description MedString String A single line, short summary of the object.
source MedString String
source_uri String
timestamp Inst (Date) The time this object was created at, or last modified.
title ShortString String A short title for this object, used as primary display and reference value
tlp TLP String Specification for how, and to whom, this object can be shared.

Property description ∷ Markdown String

A description of object, which may be detailed.

  • This entry is optional

    • Markdown string with at most 5000 characters

Property external_ids ∷ String List

  • This entry is optional
  • This entry's type is sequential (allows zero or more values)

Property external_references ∷ ExternalReference Object List

Specifies a list of external references which refers to non-CTIM information. This property is used to provide one or more URLs, descriptions, or IDs to records in other systems.

  • This entry is optional
  • This entry's type is sequential (allows zero or more values)

Property id ∷ String

Globally unique URI identifying this object.

  • This entry is required

    • IDs are URIs, for example https://www.domain.com/ctia/judgement/judgement-de305d54-75b4-431b-adb2-eb6b9e546014 for a Judgement. This ID type compares to the STIX id field. The optional STIX idref field is not used.

Property language ∷ ShortString String

The human language this object is specified in.

  • This entry is optional

    • String with at most 1024 characters

Property relationship_type ∷ RelationshipType String

  • This entry is required

    • Allowed Values:
      • attributed-to
      • based-on
      • derived-from
      • detects
      • duplicate-of
      • element-of
      • exploits
      • indicates
      • member-of
      • mitigates
      • related-to
      • targets
      • uses
      • variant-of

Property revision ∷ Integer

A monotonically increasing revision, incremented each time the object is changed.

  • This entry is optional

    • Zero, or a positive integer

Property schema_version ∷ String

CTIM schema version for this entity

  • This entry is required

    • A semantic version matching the CTIM version against which this object should be valid.

Property short_description ∷ MedString String

A single line, short summary of the object.

  • This entry is optional

    • String with at most 2048 characters

Property source ∷ MedString String

  • This entry is optional

    • String with at most 2048 characters

Property source_ref ∷ String

  • This entry is required

    • A URI leading to an entity

Property source_uri ∷ String

  • This entry is optional

    • A URI

Property target_ref ∷ String

  • This entry is required

    • A URI leading to an entity

Property timestamp ∷ Inst (Date)

The time this object was created at, or last modified.

  • This entry is optional

    • Schema definition for all date or timestamp values. Serialized as a string, the field should follow the rules of the ISO8601 standard.

Property title ∷ ShortString String

A short title for this object, used as primary display and reference value

  • This entry is optional

    • String with at most 1024 characters

Property tlp ∷ TLP String

Specification for how, and to whom, this object can be shared.

  • This entry is optional

    • TLP stands for Traffic Light Protocol, which indicates precisely how this resource is intended to be shared, replicated, copied, etc.
    • Default: green
    • Allowed Values:
      • amber
      • green
      • red
      • white

Property type ∷ RelationshipTypeIdentifier String

  • This entry is required

    • Must equal: "relationship"

ExternalReference Object

External references are used to describe pointers to information represented outside of CTIM. For example, a Malware object could use an external reference to indicate an ID for that malware in an external database or a report could use references to represent source material.

Property Type Description Required?
source_name MedString String The source within which the external-reference is defined (system, registry, organization, etc.) ✓
description Markdown String
external_id String An identifier for the external reference content.
hashes String List Specifies a dictionary of hashes for the contents of the url.
url String A URL reference to an external resource

Property description ∷ Markdown String

  • This entry is optional

    • Markdown string with at most 5000 characters

Property external_id ∷ String

An identifier for the external reference content.

  • This entry is optional

Property hashes ∷ String List

Specifies a dictionary of hashes for the contents of the url.

  • This entry is optional
  • This entry's type is sequential (allows zero or more values)

Property source_name ∷ MedString String

The source within which the external-reference is defined (system, registry, organization, etc.)

  • This entry is required

    • String with at most 2048 characters

Property url ∷ String

A URL reference to an external resource

  • This entry is optional

    • A URI