pycti.entities.opencti_stix_nested_ref_relationship

Classes

StixNestedRefRelationship

Main StixNestedRefRelationship class for OpenCTI

Module Contents

class pycti.entities.opencti_stix_nested_ref_relationship.StixNestedRefRelationship(opencti)

Main StixNestedRefRelationship class for OpenCTI

Manages nested reference relationships in the OpenCTI platform.

Parameters:

opencti (OpenCTIApiClient) – instance of OpenCTIApiClient

Initialize the StixNestedRefRelationship instance.

Parameters:

opencti (OpenCTIApiClient) – OpenCTI API client instance

opencti

properties = Multiline-String

Show Value

"""
            id
            entity_type
            parent_types
            spec_version
            created_at
            updated_at
            standard_id
            relationship_type
            start_time
            stop_time
            from {
                ... on StixObject {
                    id
                    standard_id
                    entity_type
                    parent_types
                }
                ... on StixCoreRelationship {
                    id
                    standard_id
                    entity_type
                    parent_types
                }
                ... on StixSightingRelationship {
                    id
                    standard_id
                    entity_type
                    parent_types
                }
                ... on StixCyberObservable {
                    observable_value
                }
            }
            to {
                ... on StixObject {
                    id
                    standard_id
                    entity_type
                    parent_types
                }
                ... on StixCoreRelationship {
                    id
                    standard_id
                    entity_type
                    parent_types
                }
                ... on StixSightingRelationship {
                    id
                    standard_id
                    entity_type
                    parent_types
                }
                ... on StixCyberObservable {
                    observable_value
                }
            }
        """

list(**kwargs)

List stix nested ref relationship objects.

Parameters:

• fromOrToId (str) – the id of either the source or target entity

• fromId (str) – the id of the source entity of the relation

• fromTypes (list) – the types of the source entities

• toId (str) – the id of the target entity of the relation

• toTypes (list) – the types of the target entities

• relationship_type (str) – the relation type

• startTimeStart (str) – the first_seen date start filter

• startTimeStop (str) – the first_seen date stop filter

• stopTimeStart (str) – the last_seen date start filter

• stopTimeStop (str) – the last_seen date stop filter

• first (int) – return the first n rows from the after ID (or the beginning if not set)

• after (str) – ID of the first row for pagination

Returns:

List of stix nested ref relationship objects

Return type:

list

read(**kwargs)

Read a stix nested ref relationship object.

Parameters:

• id (str) – the id of the stix nested ref relationship

• fromOrToId (str) – the id of either the source or target entity

• fromId (str) – the id of the source entity of the relation

• toId (str) – the id of the target entity of the relation

• relationship_type (str) – the relation type

• startTimeStart (str) – the first_seen date start filter

• startTimeStop (str) – the first_seen date stop filter

• stopTimeStart (str) – the last_seen date start filter

• stopTimeStop (str) – the last_seen date stop filter

• customAttributes (str) – custom attributes to return

• filters (dict) – the filters to apply

Returns:

stix nested ref relationship object

Return type:

dict or None

create(**kwargs)

Create a stix nested ref relationship object.

Parameters:

• fromId (str) – the id of the source entity

• toId (str) – the id of the target entity

• relationship_type (str) – the type of the relationship

• start_time (str) – (optional) the start time of the relationship

• stop_time (str) – (optional) the stop time of the relationship

• stix_id (str) – (optional) the STIX ID

• created (str) – (optional) creation date

• modified (str) – (optional) modification date

• createdBy (str) – (optional) the creator ID

• objectMarking (list) – (optional) list of marking definition IDs

• x_opencti_stix_ids (list) – (optional) list of additional STIX IDs

• update (bool) – (optional) whether to update if exists

Returns:

stix nested ref relationship object

Return type:

dict

update_field(**kwargs)

Update a stix nested ref relationship object field.

Parameters:

• id (str) – the stix nested ref relationship id

• input (list) – the input of the field to update

Returns:

The updated stix nested ref relationship object

Return type:

dict or None