OBJECT

Address

A geographical address.

link GraphQL Schema definition

  • type Address implements SearchableInterface, InventoryitemableInterface, GenericinventoryitemableInterface, GenericinventoryitemactionloggableInterface, LoggableInterface {
  • # The ID of the entity.
  • id: Int64Bit!
  • # An ID that uniquely identifies this entity across the whole Sonar system.
  • sonar_unique_id: ID!
  • # The date and time this entity was created.
  • created_at: Datetime!
  • # The last date and time this entity was modified.
  • updated_at: Datetime!
  • # A string that shows the version of this entity. It will be incremented whenever
  • # the entity is modified.
  • _version: String!
  • # The ID of the entity that owns this address.
  • addressable_id: Int64Bit
  • # The type of entity that owns this address.
  • addressable_type: AddressableType
  • # A city.
  • city: String
  • # A two character country code.
  • country: Country
  • # A US county. Only used for US addresses.
  • county: UsCounty
  • # Only used in the USA, this is the census tract information used for calculating
  • # things like FCC Form 477.
  • fips: String
  • # A decimal latitude.
  • latitude: Latitude
  • # Address line 1.
  • line1: String
  • # Address line 2.
  • line2: String
  • # A decimal longitude.
  • longitude: Longitude
  • # Whether or not the address is serviceable, and can be used for new accounts.
  • serviceable: Boolean!
  • # A state, province, or other country subdivision.
  • subdivision: Subdivision
  • # The type.
  • type: AddressType!
  • # A ZIP or postal code.
  • zip: String
  • # The owner of this `Address`.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • addressable(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String
  • ): AddressableInterface
  • # An inventory item.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # deployment_type_id: The ID of a `DeploymentType`.
  • # icmp_device_status: The ICMP monitoring status of an
  • # `InventoryItem`.
  • # icmp_status_last_change: The timestamp of when the ICMP status
  • # last changed.
  • # icmp_threshold_violation: The ICMP monitoring threshold
  • # violation type.
  • # inventory_model_id: The ID of an `InventoryModel`.
  • # inventoryitemable_id: The ID of the entity that this inventory
  • # item is assigned to.
  • # inventoryitemable_type: The type of entity that this inventory
  • # item is assigned to.
  • # parent_inventory_item_id: The ID of the parent `InventoryItem`.
  • # preseem_status: The status of the device, as read from Preseem.
  • # purchase_price: The purchase price of this item.
  • # snmp_device_status: The SNMP monitoring status of an
  • # `InventoryItem`.
  • # snmp_status_last_change: The timestamp of when the SNMP status
  • # last changed.
  • # snmp_status_message: The SNMP monitoring status message.
  • # status: The physical status of this item.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • inventory_items(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • deployment_type_id: Int64Bit,
  • icmp_device_status: InventoryItemDeviceStatus,
  • icmp_status_last_change: Datetime,
  • icmp_threshold_violation: InventoryItemIcmpThresholdViolation,
  • inventory_model_id: Int64Bit,
  • inventoryitemable_id: Int64Bit,
  • inventoryitemable_type: InventoryitemableType,
  • parent_inventory_item_id: Int64Bit,
  • preseem_status: PreseemStatus,
  • purchase_price: Int,
  • snmp_device_status: InventoryItemDeviceStatus,
  • snmp_status_last_change: Datetime,
  • snmp_status_message: String,
  • status: InventoryItemStatus,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): InventoryItemConnection!
  • # A generic inventory item.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # genericinventoryitemable_id: The type of entity that owns this
  • # generic `InventoryItem`.
  • # genericinventoryitemable_type: The ID of the entity that owns
  • # this generic `InventoryItem`.
  • # inventory_model_id: The ID of an `InventoryModel`.
  • # quantity: The quantity for this service.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • generic_inventory_items(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • genericinventoryitemable_id: Int64Bit,
  • genericinventoryitemable_type: InventoryitemableType,
  • inventory_model_id: Int64Bit,
  • quantity: Int,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): GenericInventoryItemConnection!
  • # A log of an action taken against a set of generic inventory items.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # action: The action that was performed.
  • # genericinventoryitemactionloggable_id: The ID of the entity
  • # that this `GenericInventoryItemActionLog` is for.
  • # genericinventoryitemactionloggable_type: The type of entity
  • # that this `GenericInventoryItemActionLog` is for.
  • # inventory_model_id: The ID of an `InventoryModel`.
  • # purchase_price: The purchase price of this item.
  • # quantity: The quantity for this service.
  • # user_id: The ID of a User.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • generic_inventory_item_action_logs(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • action: GenericInventoryItemActionLogAction,
  • genericinventoryitemactionloggable_id: Int64Bit,
  • genericinventoryitemactionloggable_type: InventoryitemableType,
  • inventory_model_id: Int64Bit,
  • purchase_price: Float,
  • quantity: Int,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): GenericInventoryItemActionLogConnection!
  • # A log entry.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # current: Current data.
  • # legacy: Whether or not this log was transferred from a Sonar v1
  • # instance. If so, the formatting will not match current version logs.
  • # legacy_title: A title which is only populated on logs that were
  • # imported from Sonar v1.
  • # level: The severity level.
  • # loggable_id: The ID of the entity that this log is attached to.
  • # loggable_type: The type of entity that this log is attached to.
  • # logged_entity_id: The entity ID that triggered the log.
  • # logged_entity_type: The entity that triggered the log.
  • # message: The message.
  • # previous: Previous data.
  • # relation_data: Data from objects related to this change.
  • # type: The type.
  • # user_id: The ID of a User.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • logs(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • current: Text,
  • legacy: Boolean,
  • legacy_title: String,
  • level: LogLevel,
  • loggable_id: Int64Bit,
  • loggable_type: String,
  • logged_entity_id: Int64Bit,
  • logged_entity_type: String,
  • message: Text,
  • previous: Text,
  • relation_data: Text,
  • type: LogType,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): LogConnection!
  • # A `ServiceableAddressAccountAssignmentHistory` for accounts and addresses.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # account_id: The ID of an Account.
  • # address_id: The ID of the address.
  • # end_date: The date that this ends.
  • # start_date: The start date for this `ScheduleAvailability`.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • serviceable_address_account_assignment_histories(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • address_id: Int64Bit,
  • end_date: Date,
  • start_date: Date,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): ServiceableAddressAccountAssignmentHistoryConnection!
  • }