pycti.entities.opencti_stix_nested_ref_relationship
===================================================

.. py:module:: pycti.entities.opencti_stix_nested_ref_relationship


Classes
-------

.. autoapisummary::

   pycti.entities.opencti_stix_nested_ref_relationship.StixNestedRefRelationship


Module Contents
---------------

.. py:class:: StixNestedRefRelationship(opencti)

   Main StixNestedRefRelationship class for OpenCTI

   Manages nested reference relationships in the OpenCTI platform.

   :param opencti: instance of :py:class:`~pycti.api.opencti_api_client.OpenCTIApiClient`
   :type opencti: OpenCTIApiClient

   Initialize the StixNestedRefRelationship instance.

   :param opencti: OpenCTI API client instance
   :type opencti: OpenCTIApiClient


   .. py:attribute:: opencti


   .. py:attribute:: properties
      :value: Multiline-String

      .. raw:: html

         <details><summary>Show Value</summary>

      .. code-block:: python

         """
                     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
                         }
                     }
                 """

      .. raw:: html

         </details>




   .. py:method:: list(**kwargs)

      List stix nested ref relationship objects.

      :param fromOrToId: the id of either the source or target entity
      :type fromOrToId: str
      :param fromId: the id of the source entity of the relation
      :type fromId: str
      :param fromTypes: the types of the source entities
      :type fromTypes: list
      :param toId: the id of the target entity of the relation
      :type toId: str
      :param toTypes: the types of the target entities
      :type toTypes: list
      :param relationship_type: the relation type
      :type relationship_type: str
      :param startTimeStart: the first_seen date start filter
      :type startTimeStart: str
      :param startTimeStop: the first_seen date stop filter
      :type startTimeStop: str
      :param stopTimeStart: the last_seen date start filter
      :type stopTimeStart: str
      :param stopTimeStop: the last_seen date stop filter
      :type stopTimeStop: str
      :param first: return the first n rows from the after ID (or the beginning if not set)
      :type first: int
      :param after: ID of the first row for pagination
      :type after: str
      :return: List of stix nested ref relationship objects
      :rtype: list



   .. py:method:: read(**kwargs)

      Read a stix nested ref relationship object.

      :param id: the id of the stix nested ref relationship
      :type id: str
      :param fromOrToId: the id of either the source or target entity
      :type fromOrToId: str
      :param fromId: the id of the source entity of the relation
      :type fromId: str
      :param toId: the id of the target entity of the relation
      :type toId: str
      :param relationship_type: the relation type
      :type relationship_type: str
      :param startTimeStart: the first_seen date start filter
      :type startTimeStart: str
      :param startTimeStop: the first_seen date stop filter
      :type startTimeStop: str
      :param stopTimeStart: the last_seen date start filter
      :type stopTimeStart: str
      :param stopTimeStop: the last_seen date stop filter
      :type stopTimeStop: str
      :param customAttributes: custom attributes to return
      :type customAttributes: str
      :param filters: the filters to apply
      :type filters: dict
      :return: stix nested ref relationship object
      :rtype: dict or None



   .. py:method:: create(**kwargs)

      Create a stix nested ref relationship object.

      :param fromId: the id of the source entity
      :type fromId: str
      :param toId: the id of the target entity
      :type toId: str
      :param relationship_type: the type of the relationship
      :type relationship_type: str
      :param start_time: (optional) the start time of the relationship
      :type start_time: str
      :param stop_time: (optional) the stop time of the relationship
      :type stop_time: str
      :param stix_id: (optional) the STIX ID
      :type stix_id: str
      :param created: (optional) creation date
      :type created: str
      :param modified: (optional) modification date
      :type modified: str
      :param createdBy: (optional) the creator ID
      :type createdBy: str
      :param objectMarking: (optional) list of marking definition IDs
      :type objectMarking: list
      :param x_opencti_stix_ids: (optional) list of additional STIX IDs
      :type x_opencti_stix_ids: list
      :param update: (optional) whether to update if exists
      :type update: bool
      :return: stix nested ref relationship object
      :rtype: dict



   .. py:method:: update_field(**kwargs)

      Update a stix nested ref relationship object field.

      :param id: the stix nested ref relationship id
      :type id: str
      :param input: the input of the field to update
      :type input: list
      :return: The updated stix nested ref relationship object
      :rtype: dict or None