diff --git a/api/v4.html b/api/v4.html index 46296ac..ac1a3ee 100644 --- a/api/v4.html +++ b/api/v4.html @@ -12,2259 +12,422 @@ margin: 0; } - -

Metasys REST API (4.494)

Download OpenAPI specification:Download

Introduction

The Metasys REST API is the exposed interface for accessing data from a Johnson + " fill="currentColor">

Metasys REST API (4.496)

Download OpenAPI specification:Download

Introduction

The Metasys REST API is the exposed interface for accessing data from a Johnson Controls® Metasys system. This spec documents v4 of the API first released as part of Metasys 12.0. This documentation was last -updated on November 16, 2023 at 5:23 PM (UTC).

+updated on June 25, 2024 at 2:04 PM (UTC).

Note
The Metasys REST API is only supported on the following Metasys products: ADS, ADX, and OAS. The REST API is not supported on Metasys for Validated Environments @@ -2303,7 +487,28 @@ the API. For further information on the Metasys API, including tutorials, see the Metasys API home page.

© 2022 Johnson Controls Tyco IP Holdings LLP.

-

Base URL

This documentation is for Metasys 12.0 which ships with version +

Base URL

This documentation is for Metasys 12.0 which ships with version 4 of the Metasys Server.

The base path for the API is https://{hostname}/api/v4 where {hostname} is the host name of your Metasys server.

@@ -2324,7 +529,25 @@

Version Response Behavior

identify which version of the API was utilized.

For example, Content-Type: application/vnd.metasysapi.v4+json for version 4.

-

Licensed Operations

You must obtain an additional license to access some operations. For more +

Licensed Operations

You must obtain an additional license to access some operations. For more information, refer to the Licensing information and Software information sections in Metasys System Software Purchase Options Product Bulletin (LIT-12011703).

@@ -2342,7 +565,18 @@

Monitoring and Commanding API lic
  • Batch object operations
  • Case Sensitivity Rules

    In general, you should assume that all URLs, parameter names, parameter values, +will need to be customized for offline APIs -->

    Case Sensitivity Rules

    In general, you should assume that all URLs, parameter names, parameter values, payload property names and payload property values are case sensitive. For example:

      @@ -2353,7 +587,18 @@

      Monitoring and Commanding API lic reliabilityEnumSet.reliable, displayPrecisionEnumSet.displayPrecision1, and writePriorityEnumSet.priorityDefault).

    -

    Pagination

    For operations where page and pageSize is allowed, the default page number +

    Pagination

    For operations where page and pageSize is allowed, the default page number will be 1 and is 1-based for all paths while the default pageSize will vary between paths. The page parameter indicates the page number of items to return from the path. The pageSize parameter indicates the maximum number of items in @@ -2364,11 +609,28 @@

    Monitoring and Commanding API lic data, respectively. These properties can be empty if irrelevant (for example, if it is the first/last page, or there is only one page of data). The items property contains the data included in the page.

    -

    Sorting Rules

    For operations where a sort query parameter is allowed, the supplied value +

    Sorting Rules

    For operations where a sort query parameter is allowed, the supplied value should be in the format of a single attribute name, optionally prefixed with - to indicate descending sort order (ascending order is used if no prefix is supplied).

    -

    DateTimes

    All date-times in the alarms, audits, activities, and samples operations are +

    DateTimes

    All date-times in the alarms, audits, activities, and samples operations are ISO-8601 encoded strings in UTC. Other operations, such as objects, use a proprietary structure further described in supporting documentation.

    -

    Validation and Common Error Codes

    There are some general rules that apply across all operations. If certain +

    Validation and Common Error Codes

    There are some general rules that apply across all operations. If certain provided inputs are invalid or preconditions are not met, the API will respond with an appropriate error to indicate what went wrong.

    @@ -2476,13 +833,32 @@

    Monitoring and Commanding API lic

    An attempt was made to talk to another device that is currently offline.
    -

    Schemas in Response Payloads

    The response payload of some operations in this document have a section of +

    Schemas in Response Payloads

    The response payload of some operations in this document have a section of information labeled schema. This section of information includes important pieces of metadata about the item or items attributes that gives better context to the meaning of attribute values. This section follows JSON Schema specification with added custom annotation keywords.

    -

    Security

    Bearer-Authentication

    Most of the calls in the API use bearer token authentication. What this +

    Security

    Bearer-Authentication

    Most of the calls in the API use bearer token authentication. What this means is that these requests require an Authorization header to be set to a value with the following format: Bearer: {accessToken}. Use the /login operation to request an accessToken. An @@ -2495,10 +871,503 @@

    Monitoring and Commanding API lic from issue, disregard and refresh before 60 minutes to prevent session expiration. The next version of the API will provide the correct expiration time.

    -

    Security Scheme Type: HTTP
    HTTP Authorization Scheme: bearer
    Bearer format: JWT

    API-Key-Authentication

    The Streaming operation is the only operation to use +

    Security Scheme Type: HTTP
    HTTP Authorization Scheme: bearer
    Bearer format: JWT

    API-Key-Authentication

    The Streaming operation is the only operation to use API key authentication, because web browsers do not allow setting custom headers when initiating Server Sent Event connections.

    -
    Security Scheme Type: API Key
    Query parameter name: access_token

    activities

    This section describes the operations you can perform on activities. Activities +

    Security Scheme Type: API Key
    Query parameter name: access_token

    activities

    This section describes the operations you can perform on activities. Activities are a superset of all alarms and audits in a Metasys system. Use activities operations to view audits and alarms. Apply filters to further refine the results.

    @@ -2988,9 +1857,21 @@

    Filter Behavior

    discarded activity even though your filters exclude activities that are discarded. This is necessary so that you can properly maintain the state of activities already received in your application.

    -

    List activities

    Retrieves a collection of activities.

    -
    Authorizations:
    Bearer-Authentication
    query Parameters
    activityType
    Array of strings[ items <= 2 items ]
    Items Enum: "alarm" "audit"
    Example: activityType=alarm

    Limit the activities returned to a specific type

    -
    includeDiscarded
    boolean

    Determines whether discarded activities will be included in the results or +

    List activities

    Retrieves a collection of activities.

    +
    Authorizations:
    Bearer-Authentication
    query Parameters
    activityType
    Array of strings[ items <= 2 items ]
    Items Enum: "alarm" "audit"
    Example: activityType=alarm

    Limit the activities returned to a specific type

    +
    includeDiscarded
    boolean

    Determines whether discarded activities will be included in the results or be the only type of activity in the results. Discarded activities are those for which the activityManagementStatus is discarded.

    This parameter can produce 3 different types of results.

    @@ -3000,15 +1881,31 @@

    Filter Behavior

  • missing - (default) Discarded status is ignored; both discarded and non-discarded activities are returned.
  • -
    continuationToken
    string
    Example: continuationToken=eyJhdWRpdCI6eyJpZCI6IjgOTQ2NjUzLTlmM...

    Provide a token from a previous request to fetch the next set of results. Ignored for streaming subscriptions.

    -
    sort
    string
    Default: "creationTime"
    Enum: "creationTime" "-creationTime" "priority" "-priority"
    Example: sort=creationTime

    The criteria to use when sorting results (see rules).

    -
    startTime
    string <date-time>
    Example: startTime=2018-05-21T13:58:20.243Z

    Only include results generated on or after this date-time.

    -
    endTime
    string <date-time>
    Example: endTime=2018-05-21T13:58:20.243Z

    Only include results generated on or before this date-time.

    -
    equipment
    Array of strings <= 100 items
    Example: equipment=b7ed8b3e-cb95-410d-aaa7-37158852c398

    Filter by list of equipment identifiers.

    -
    object
    Array of strings <= 100 items
    Example: object=06d77c63-6357-467a-a306-5e1ab3eb3aa7

    Filter by list of object identifiers.

    -
    space
    Array of strings <= 100 items
    Example: space=214f52d1-0c56-4a29-a690-abe5656d1647

    Filter by list of space identifiers.

    -
    priorityRange
    string^\d+,\d+$
    Example: priorityRange=0,255

    Includes only results within the specified alarm priority range, from 0 to 255 inclusive.

    -
    type
    Array of strings[ items <= 100 items ]
    Example: type=alarmValueEnumSet.avHighLimit
    metasysEnum: alarmValueEnumSet

    Limits the alarms returned to specified types.

    +
    continuationToken
    string
    Example: continuationToken=eyJhdWRpdCI6eyJpZCI6IjgOTQ2NjUzLTlmM...

    Provide a token from a previous request to fetch the next set of results. Ignored for streaming subscriptions.

    +
    sort
    string
    Default: "creationTime"
    Enum: "creationTime" "-creationTime" "priority" "-priority"
    Example: sort=creationTime

    The criteria to use when sorting results (see rules).

    +
    startTime
    string <date-time>
    Example: startTime=2018-05-21T13:58:20.243Z

    Only include results generated on or after this date-time.

    +
    endTime
    string <date-time>
    Example: endTime=2018-05-21T13:58:20.243Z

    Only include results generated on or before this date-time.

    +
    equipment
    Array of strings <= 100 items
    Example: equipment=b7ed8b3e-cb95-410d-aaa7-37158852c398

    Filter by list of equipment identifiers.

    +
    object
    Array of strings <= 100 items
    Example: object=06d77c63-6357-467a-a306-5e1ab3eb3aa7

    Filter by list of object identifiers.

    +
    space
    Array of strings <= 100 items
    Example: space=214f52d1-0c56-4a29-a690-abe5656d1647

    Filter by list of space identifiers.

    +
    priorityRange
    string^\d+,\d+$
    Example: priorityRange=0,255

    Includes only results within the specified alarm priority range, from 0 to 255 inclusive.

    +
    type
    Array of strings[ items <= 100 items ]
    Example: type=alarmValueEnumSet.avHighLimit
    metasysEnum: alarmValueEnumSet

    Limits the alarms returned to specified types.

    The acceptable values for the elements of this parameter come from the alarmValueEnumSet enumeration. Only the long name of the alarm value (for example, alarmValueEnumSet.avHighLimit instead of avHighLimit) is accepted. Find the definition of alarmValueEnumSet at the relative URL of /schemas/enums/alarmValueEnumSet.

    @@ -3016,7 +1913,17 @@

    Filter Behavior

    -
    includeAcknowledged
    boolean

    Determines whether acknowledged alarms will be included in the results or be +

    includeAcknowledged
    boolean

    Determines whether acknowledged alarms will be included in the results or be the only type of alarm in the results. Acknowledged alarms are those which have an acknowledgedTime value set.

    This parameter can produce 3 different types of results.

    @@ -3026,19 +1933,39 @@

    Filter Behavior

  • missing - (default) Acknowledged status is ignored; both acknowledged and non-acknowledged alarms are returned.
  • -
    includeAcknowledgementRequired
    boolean
    Default: true
    Example: includeAcknowledgementRequired=true

    Determines whether activities which can be acknowledged are included in the +

    includeAcknowledgementRequired
    boolean
    Default: true
    Example: includeAcknowledgementRequired=true

    Determines whether activities which can be acknowledged are included in the results. When the value is true, activities which can be acknowledged will be included in the results. When false, activities which can be acknowledged will not be included in the results.

    The use of this parameter implies a filter of activityType=alarm and the results will not include any audits.

    -
    includeAcknowledgementNotRequired
    boolean
    Default: true
    Example: includeAcknowledgementNotRequired=true

    Determines whether activities which can not be acknowledged are included in +

    includeAcknowledgementNotRequired
    boolean
    Default: true
    Example: includeAcknowledgementNotRequired=true

    Determines whether activities which can not be acknowledged are included in the results. When the value is true then the results will include activities which cannot be acknowledged. When the value is false then the results will not include activities which cannot be acknowledged.

    The use of this parameter implies a filter of activityType=alarm and the results will not include any audits.

    -
    category
    Array of strings
    Example: category=objectCategoryEnumSet.hvacCategory
    metasysEnum: objectCategoryEnumSet

    The authorization category of the requested activities.

    +
    category
    Array of strings
    Example: category=objectCategoryEnumSet.hvacCategory
    metasysEnum: objectCategoryEnumSet

    The authorization category of the requested activities.

    The acceptable values for the elements of this parameter come from the objectCategoryEnumSet enumeration. Only the long name of the object category (for example, objectCategoryEnumSet.hvacCategory instead of hvacCategory) is accepted. Find the definition of objectCategoryEnumSet at the relative URL of /schemas/enums/objectCategoryEnumSet.

    @@ -3046,7 +1973,16 @@

    Filter Behavior

    -
    originApplication
    Array of strings
    Example: originApplication=auditOriginAppEnumSet.deviceManagerAuditOriginApp
    metasysEnum: auditOriginAppEnumSet

    Filter by list of origin applications. The origin application property +

    originApplication
    Array of strings
    Example: originApplication=auditOriginAppEnumSet.deviceManagerAuditOriginApp
    metasysEnum: auditOriginAppEnumSet

    Filter by list of origin applications. The origin application property indicates which application in Metasys generated the audit message.

    The acceptable values for the elements of this parameter come from the auditOriginAppEnumSet enumeration. Only the long name of the origin application (for example, auditOriginAppEnumSet.deviceManagerAuditOriginApp instead of deviceManagerAuditOriginApp) is accepted. @@ -3055,7 +1991,23 @@

    Filter Behavior

    -
    classLevel
    Array of strings
    Example: classLevel=auditClassesEnumSet.userActionAuditClass
    metasysEnum: auditClassesEnumSet

    Filter by list of class levels. The class level of an audit indicates the +

    classLevel
    Array of strings
    Example: classLevel=auditClassesEnumSet.userActionAuditClass
    metasysEnum: auditClassesEnumSet

    Filter by list of class levels. The class level of an audit indicates the class or family the audit belongs to. Typically, each level of audit provides additional detail about the system, with Diagnostic audits being the most verbose.

    @@ -3071,7 +2023,16 @@

    Filter Behavior

    -
    actionType
    Array of strings
    Example: actionType=auditActionTypeEnumSet.writeAuditActionType
    metasysEnum: auditActionTypeEnumSet

    Filter by list of action types. The action type property indicates the user +

    actionType
    Array of strings
    Example: actionType=auditActionTypeEnumSet.writeAuditActionType
    metasysEnum: auditActionTypeEnumSet

    Filter by list of action types. The action type property indicates the user or system action performed.

    The acceptable values for the elements of this parameter come from the auditActionTypeEnumSet enumeration. Only the long name of the action type (for example, auditActionTypeEnumSet.writeAuditActionType instead of writeAuditActionType) is accepted. @@ -3080,9 +2041,20 @@

    Filter Behavior

    -
    user
    Array of strings <= 100 items
    Example: user=metasysuser

    Filter by list of users. The user property indicates which user initiated +

    user
    Array of strings <= 100 items
    Example: user=metasysuser

    Filter by list of users. The user property indicates which user initiated the action being audited.

    -
    header Parameters
    METASYS-SUBSCRIBE
    string
    Example: 40e47e37-0f24-4101-8e1d-de96af4b648b

    If present, subscribes the client for streaming events associated with the +

    header Parameters
    METASYS-SUBSCRIBE
    string
    Example: 40e47e37-0f24-4101-8e1d-de96af4b648b

    If present, subscribes the client for streaming events associated with the resource. The value of this header is a stream id obtained by opening a stream with Get a stream. The response will have a METASYS-SUBSCRIPTION-LOCATION header which identifies the created @@ -3091,13 +2063,25 @@

    Filter Behavior

    -

    Responses

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v4/activities?activityType=alarm&includeDiscarded=false&continuationToken=eyJhdWRpdCI6eyJpZCI6IjgOTQ2NjUzLTlmM...&sort=creationTime&startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&equipment=b7ed8b3e-cb95-410d-aaa7-37158852c398&object=06d77c63-6357-467a-a306-5e1ab3eb3aa7&space=214f52d1-0c56-4a29-a690-abe5656d1647&priorityRange=0%2C255&type=alarmValueEnumSet.avHighLimit&includeAcknowledged=false&includeAcknowledgementRequired=true&includeAcknowledgementNotRequired=true&category=objectCategoryEnumSet.hvacCategory&originApplication=auditOriginAppEnumSet.deviceManagerAuditOriginApp&classLevel=auditClassesEnumSet.userActionAuditClass&actionType=auditActionTypeEnumSet.writeAuditActionType&user=metasysuser' \
    +

    Responses

    Request samples

    curl --request GET \
    +  --url 'https://metasys-server.example.com/api/v4/activities?activityType=alarm&includeDiscarded=false&continuationToken=eyJhdWRpdCI6eyJpZCI6IjgOTQ2NjUzLTlmM...&sort=creationTime&startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&equipment=b7ed8b3e-cb95-410d-aaa7-37158852c398&object=06d77c63-6357-467a-a306-5e1ab3eb3aa7&space=214f52d1-0c56-4a29-a690-abe5656d1647&priorityRange=0%2C255&type=alarmValueEnumSet.avHighLimit&includeAcknowledged=false&includeAcknowledgementRequired=true&includeAcknowledgementNotRequired=true&category=objectCategoryEnumSet.hvacCategory&originApplication=auditOriginAppEnumSet.deviceManagerAuditOriginApp&classLevel=auditClassesEnumSet.userActionAuditClass&actionType=auditActionTypeEnumSet.writeAuditActionType&user=metasysuser' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
    -  --header 'METASYS-SUBSCRIBE: 40e47e37-0f24-4101-8e1d-de96af4b648b'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    The first 10 activities.

    -
    {}

    Batch operations

    Used to invoke multiple activity operations in a single HTTP request. In this + --header 'METASYS-SUBSCRIBE: 40e47e37-0f24-4101-8e1d-de96af4b648b'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    The first 10 activities.

    +
    {}

    Batch operations

    Used to invoke multiple activity operations in a single HTTP request. In this version of the API, the only activity-related operations that can be used in a batch are listed below.

    See also

    @@ -3106,34 +2090,67 @@

    Filter Behavior

  • Add audit annotation
  • Edit an alarm
  • -
    Authorizations:
    Bearer-Authentication
    Request Body schema: application/json
    method
    required
    string
    Enum: "PATCH" "POST"

    The HTTP method to use for each request.

    -
    required
    Array of objects

    A collection of entries that represent the operations to invoke.

    -

    Responses

    Request samples

    Content type
    application/json
    Example

    A request to discard multiple activities (2 audits and 2 alarms). +

    Authorizations:
    Bearer-Authentication
    Request Body schema: application/json
    required
    method
    required
    string
    Enum: "PATCH" "POST"

    The HTTP method to use for each request.

    +
    required
    Array of objects

    A collection of entries that represent the operations to invoke.

    +

    Responses

    Request samples

    Content type
    application/json
    Example

    A request to discard multiple activities (2 audits and 2 alarms). One audit request and one alarm request include annotation text and the other requests do not.

    -
    {}

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    This is an example response to a batch request. Two of the +

    {}

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    This is an example response to a batch request. Two of the operations succeeded and two of them failed.

    -
    {
    • "responses": [
      ]
    }

    Delete activities subscription

    Deletes a subscription to the activities resource.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    streamId
    required
    string
    Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb

    The stream identifier that contains the subscription. This is the unique +

    {
    • "responses": [
      ]
    }

    Delete activities subscription

    Deletes a subscription to the activities resource.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    streamId
    required
    string
    Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb

    The stream identifier that contains the subscription. This is the unique identifier for the client's stream obtained via GET /stream.

    -
    subscriptionId
    required
    string
    Example: 626e5ac3-506d-4017-bb8f-973f1c54ddb5

    The identifier of the subscription to act upon. This is the unique +

    subscriptionId
    required
    string
    Example: 626e5ac3-506d-4017-bb8f-973f1c54ddb5

    The identifier of the subscription to act upon. This is the unique identifier to the subscription for a specific resource or type of event. This value is found as the last parameter of a METASYS-SUBSCRIPTION-LOCATION header returned for the original subscription request.

    -

    Responses

    Request samples

    curl --request DELETE \
    -  --url https:///%7Bhostname%7D/api/v4/activities/streams/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/subscriptions/626e5ac3-506d-4017-bb8f-973f1c54ddb5 \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    alarms

    Alarms alert users to potential problems identified by a Metasys system, for example high zone temperatures. Use alarms operations to get object alarms, network device alarms, single alarms, alarm collections, and alarm annotations. Acknowledge or discard alarms with the edit patch operation. Filter the results with the query parameters time, priority, type, category, acknowledgement, and page. Sort the results by creation time and priority.

    -

    Get alarms for an object

    Retrieves a collection of alarms for the specified object.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    objectId
    required
    string
    Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb

    The identifier of the object.

    -
    query Parameters
    startTime
    string <date-time>
    Example: startTime=2018-05-21T13:58:20.243Z

    Only include results generated on or after this date-time.

    -
    endTime
    string <date-time>
    Example: endTime=2018-05-21T13:58:20.243Z

    Only include results generated on or before this date-time.

    -
    priorityRange
    string^\d+,\d+$
    Example: priorityRange=0,255

    Includes only results within the specified alarm priority range, from 0 to 255 inclusive.

    -
    type
    Array of strings[ items <= 100 items ]
    Example: type=alarmValueEnumSet.avHighLimit
    metasysEnum: alarmValueEnumSet

    Limits the alarms returned to specified types.

    +

    Responses

    Request samples

    curl --request DELETE \
    +  --url https://metasys-server.example.com/api/v4/activities/streams/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/subscriptions/626e5ac3-506d-4017-bb8f-973f1c54ddb5 \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    alarms

    Alarms alert users to potential problems identified by a Metasys system, for example high zone temperatures. Use alarms operations to get object alarms, network device alarms, single alarms, alarm collections, and alarm annotations. Acknowledge or discard alarms with the edit patch operation. Filter the results with the query parameters time, priority, type, category, acknowledgement, and page. Sort the results by creation time and priority.

    +

    Get alarms for an object

    Retrieves a collection of alarms for the specified object.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    objectId
    required
    string
    Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb

    The identifier of the object.

    +
    query Parameters
    startTime
    string <date-time>
    Example: startTime=2018-05-21T13:58:20.243Z

    Only include results generated on or after this date-time.

    +
    endTime
    string <date-time>
    Example: endTime=2018-05-21T13:58:20.243Z

    Only include results generated on or before this date-time.

    +
    priorityRange
    string^\d+,\d+$
    Example: priorityRange=0,255

    Includes only results within the specified alarm priority range, from 0 to 255 inclusive.

    +
    type
    Array of strings[ items <= 100 items ]
    Example: type=alarmValueEnumSet.avHighLimit
    metasysEnum: alarmValueEnumSet

    Limits the alarms returned to specified types.

    The acceptable values for the elements of this parameter come from the alarmValueEnumSet enumeration. Only the long name of the alarm value (for example, alarmValueEnumSet.avHighLimit instead of avHighLimit) is accepted. Find the definition of alarmValueEnumSet at the relative URL of /schemas/enums/alarmValueEnumSet.

    @@ -3141,7 +2158,17 @@

    Filter Behavior

    -
    includeAcknowledged
    boolean

    Determines whether acknowledged alarms will be included in the results or be +

    includeAcknowledged
    boolean

    Determines whether acknowledged alarms will be included in the results or be the only type of alarm in the results. Acknowledged alarms are those which have an acknowledgedTime value set.

    This parameter can produce 3 different types of results.

    @@ -3151,7 +2178,17 @@

    Filter Behavior

  • missing - (default) Acknowledged status is ignored; both acknowledged and non-acknowledged alarms are returned.
  • -
    includeDiscarded
    boolean

    Determines whether discarded alarms will be included in the results or be +

    includeDiscarded
    boolean

    Determines whether discarded alarms will be included in the results or be the only type of alarm in the results. Discarded alarms are those for which the activityManagementStatus is discarded. This parameter can produce 3 different types of results.

    @@ -3161,9 +2198,19 @@

    Filter Behavior

  • missing - (default) Discarded status is ignored; both discarded and non-discarded alarms are returned.
  • -
    includeAcknowledgementRequired
    boolean
    Default: true
    Example: includeAcknowledgementRequired=true

    Determines whether alarms which can be acknowledged are included in the results. When the value is true, alarms which can be acknowledged will be included in the results. When false, alarms which can be acknowledged will not be included in the results.

    -
    includeAcknowledgementNotRequired
    boolean
    Default: true
    Example: includeAcknowledgementNotRequired=true

    Determines whether alarms which can not be acknowledged are included in the results. When the value is true then the results will include alarms which cannot be acknowledged. When the value is false then the results will not include alarms which cannot be acknowledged.

    -
    category
    Array of strings
    Example: category=objectCategoryEnumSet.hvacCategory
    metasysEnum: objectCategoryEnumSet

    The authorization category of the requested activities.

    +
    includeAcknowledgementRequired
    boolean
    Default: true
    Example: includeAcknowledgementRequired=true

    Determines whether alarms which can be acknowledged are included in the results. When the value is true, alarms which can be acknowledged will be included in the results. When false, alarms which can be acknowledged will not be included in the results.

    +
    includeAcknowledgementNotRequired
    boolean
    Default: true
    Example: includeAcknowledgementNotRequired=true

    Determines whether alarms which can not be acknowledged are included in the results. When the value is true then the results will include alarms which cannot be acknowledged. When the value is false then the results will not include alarms which cannot be acknowledged.

    +
    category
    Array of strings
    Example: category=objectCategoryEnumSet.hvacCategory
    metasysEnum: objectCategoryEnumSet

    The authorization category of the requested activities.

    The acceptable values for the elements of this parameter come from the objectCategoryEnumSet enumeration. Only the long name of the object category (for example, objectCategoryEnumSet.hvacCategory instead of hvacCategory) is accepted. Find the definition of objectCategoryEnumSet at the relative URL of /schemas/enums/objectCategoryEnumSet.

    @@ -3171,20 +2218,39 @@

    Filter Behavior

    -
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    -
    pageSize
    integer [ 1 .. 10000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    -
    sort
    string
    Default: "creationTime"
    Enum: "creationTime" "-creationTime" "priority" "-priority"
    Example: sort=creationTime

    The criteria to use when sorting results (see rules).

    -

    Responses

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v4/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/alarms?startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&priorityRange=0%2C255&type=alarmValueEnumSet.avHighLimit&includeAcknowledged=false&includeDiscarded=false&includeAcknowledgementRequired=true&includeAcknowledgementNotRequired=true&category=objectCategoryEnumSet.hvacCategory&page=1&pageSize=100&sort=creationTime' \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    The first 10 alarms.

    -
    {}

    Get alarms for a network device

    Retrieves a collection of alarms for the specified network device.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    networkDeviceId
    required
    string
    Example: d9bf66bd-22f8-425b-82a4-44ba153d79c7

    The identifier of a network device.

    -
    query Parameters
    startTime
    string <date-time>
    Example: startTime=2018-05-21T13:58:20.243Z

    Only include results generated on or after this date-time.

    -
    endTime
    string <date-time>
    Example: endTime=2018-05-21T13:58:20.243Z

    Only include results generated on or before this date-time.

    -
    priorityRange
    string^\d+,\d+$
    Example: priorityRange=0,255

    Includes only results within the specified alarm priority range, from 0 to 255 inclusive.

    -
    type
    Array of strings[ items <= 100 items ]
    Example: type=alarmValueEnumSet.avHighLimit
    metasysEnum: alarmValueEnumSet

    Limits the alarms returned to specified types.

    +
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    +
    pageSize
    integer [ 1 .. 10000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    +
    sort
    string
    Default: "creationTime"
    Enum: "creationTime" "-creationTime" "priority" "-priority"
    Example: sort=creationTime

    The criteria to use when sorting results (see rules).

    +

    Responses

    Request samples

    curl --request GET \
    +  --url 'https://metasys-server.example.com/api/v4/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/alarms?startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&priorityRange=0%2C255&type=alarmValueEnumSet.avHighLimit&includeAcknowledged=false&includeDiscarded=false&includeAcknowledgementRequired=true&includeAcknowledgementNotRequired=true&category=objectCategoryEnumSet.hvacCategory&page=1&pageSize=100&sort=creationTime' \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    The first 10 alarms.

    +
    {}

    Get alarms for a network device

    Retrieves a collection of alarms for the specified network device.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    networkDeviceId
    required
    string
    Example: d9bf66bd-22f8-425b-82a4-44ba153d79c7

    The identifier of a network device.

    +
    query Parameters
    startTime
    string <date-time>
    Example: startTime=2018-05-21T13:58:20.243Z

    Only include results generated on or after this date-time.

    +
    endTime
    string <date-time>
    Example: endTime=2018-05-21T13:58:20.243Z

    Only include results generated on or before this date-time.

    +
    priorityRange
    string^\d+,\d+$
    Example: priorityRange=0,255

    Includes only results within the specified alarm priority range, from 0 to 255 inclusive.

    +
    type
    Array of strings[ items <= 100 items ]
    Example: type=alarmValueEnumSet.avHighLimit
    metasysEnum: alarmValueEnumSet

    Limits the alarms returned to specified types.

    The acceptable values for the elements of this parameter come from the alarmValueEnumSet enumeration. Only the long name of the alarm value (for example, alarmValueEnumSet.avHighLimit instead of avHighLimit) is accepted. Find the definition of alarmValueEnumSet at the relative URL of /schemas/enums/alarmValueEnumSet.

    @@ -3192,7 +2258,17 @@

    Filter Behavior

    -
    includeAcknowledged
    boolean

    Determines whether acknowledged alarms will be included in the results or be +

    includeAcknowledged
    boolean

    Determines whether acknowledged alarms will be included in the results or be the only type of alarm in the results. Acknowledged alarms are those which have an acknowledgedTime value set.

    This parameter can produce 3 different types of results.

    @@ -3202,7 +2278,17 @@

    Filter Behavior

  • missing - (default) Acknowledged status is ignored; both acknowledged and non-acknowledged alarms are returned.
  • -
    includeDiscarded
    boolean

    Determines whether discarded alarms will be included in the results or be +

    includeDiscarded
    boolean

    Determines whether discarded alarms will be included in the results or be the only type of alarm in the results. Discarded alarms are those for which the activityManagementStatus is discarded. This parameter can produce 3 different types of results.

    @@ -3212,12 +2298,25 @@

    Filter Behavior

  • missing - (default) Discarded status is ignored; both discarded and non-discarded alarms are returned.
  • -
    includeAcknowledgementRequired
    boolean
    Default: true
    Example: includeAcknowledgementRequired=true

    Determines whether alarms which can be acknowledged are included in the results. When the value is true, alarms which can be acknowledged will be included in the results. When false, alarms which can be acknowledged will not be included in the results.

    -
    includeAcknowledgementNotRequired
    boolean
    Default: true
    Example: includeAcknowledgementNotRequired=true

    Determines whether alarms which can not be acknowledged are included in the results. When the value is true then the results will include alarms which cannot be acknowledged. When the value is false then the results will not include alarms which cannot be acknowledged.

    -
    equipment
    Array of strings <= 100 items
    Example: equipment=b7ed8b3e-cb95-410d-aaa7-37158852c398

    Filter by list of equipment identifiers.

    -
    object
    Array of strings <= 100 items
    Example: object=06d77c63-6357-467a-a306-5e1ab3eb3aa7

    Filter by list of object identifiers.

    -
    space
    Array of strings <= 100 items
    Example: space=214f52d1-0c56-4a29-a690-abe5656d1647

    Filter by list of space identifiers.

    -
    category
    Array of strings
    Example: category=objectCategoryEnumSet.hvacCategory
    metasysEnum: objectCategoryEnumSet

    The authorization category of the requested activities.

    +
    includeAcknowledgementRequired
    boolean
    Default: true
    Example: includeAcknowledgementRequired=true

    Determines whether alarms which can be acknowledged are included in the results. When the value is true, alarms which can be acknowledged will be included in the results. When false, alarms which can be acknowledged will not be included in the results.

    +
    includeAcknowledgementNotRequired
    boolean
    Default: true
    Example: includeAcknowledgementNotRequired=true

    Determines whether alarms which can not be acknowledged are included in the results. When the value is true then the results will include alarms which cannot be acknowledged. When the value is false then the results will not include alarms which cannot be acknowledged.

    +
    equipment
    Array of strings <= 100 items
    Example: equipment=b7ed8b3e-cb95-410d-aaa7-37158852c398

    Filter by list of equipment identifiers.

    +
    object
    Array of strings <= 100 items
    Example: object=06d77c63-6357-467a-a306-5e1ab3eb3aa7

    Filter by list of object identifiers.

    +
    space
    Array of strings <= 100 items
    Example: space=214f52d1-0c56-4a29-a690-abe5656d1647

    Filter by list of space identifiers.

    +
    category
    Array of strings
    Example: category=objectCategoryEnumSet.hvacCategory
    metasysEnum: objectCategoryEnumSet

    The authorization category of the requested activities.

    The acceptable values for the elements of this parameter come from the objectCategoryEnumSet enumeration. Only the long name of the object category (for example, objectCategoryEnumSet.hvacCategory instead of hvacCategory) is accepted. Find the definition of objectCategoryEnumSet at the relative URL of /schemas/enums/objectCategoryEnumSet.

    @@ -3225,25 +2324,49 @@

    Filter Behavior

    -
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    -
    pageSize
    integer [ 1 .. 10000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    -
    sort
    string
    Default: "creationTime"
    Enum: "creationTime" "-creationTime" "priority" "-priority"
    Example: sort=creationTime

    The criteria to use when sorting results (see rules).

    -

    Responses

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v4/networkDevices/d9bf66bd-22f8-425b-82a4-44ba153d79c7/alarms?startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&priorityRange=0%2C255&type=alarmValueEnumSet.avHighLimit&includeAcknowledged=false&includeDiscarded=false&includeAcknowledgementRequired=true&includeAcknowledgementNotRequired=true&equipment=b7ed8b3e-cb95-410d-aaa7-37158852c398&object=06d77c63-6357-467a-a306-5e1ab3eb3aa7&space=214f52d1-0c56-4a29-a690-abe5656d1647&category=objectCategoryEnumSet.hvacCategory&page=1&pageSize=100&sort=creationTime' \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    The first 10 alarms.

    -
    {}

    Get alarms Deprecated

    Retrieves a collection of alarms.

    +
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    +
    pageSize
    integer [ 1 .. 10000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    +
    sort
    string
    Default: "creationTime"
    Enum: "creationTime" "-creationTime" "priority" "-priority"
    Example: sort=creationTime

    The criteria to use when sorting results (see rules).

    +

    Responses

    Request samples

    curl --request GET \
    +  --url 'https://metasys-server.example.com/api/v4/networkDevices/d9bf66bd-22f8-425b-82a4-44ba153d79c7/alarms?startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&priorityRange=0%2C255&type=alarmValueEnumSet.avHighLimit&includeAcknowledged=false&includeDiscarded=false&includeAcknowledgementRequired=true&includeAcknowledgementNotRequired=true&equipment=b7ed8b3e-cb95-410d-aaa7-37158852c398&object=06d77c63-6357-467a-a306-5e1ab3eb3aa7&space=214f52d1-0c56-4a29-a690-abe5656d1647&category=objectCategoryEnumSet.hvacCategory&page=1&pageSize=100&sort=creationTime' \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    The first 10 alarms.

    +
    {}

    Get alarms Deprecated

    Retrieves a collection of alarms.

    Note: This operation is deprecated and may be removed in a future release. To retrieve alarms, consider using GET /activities?activityType=alarm instead. See List activities

    -
    Authorizations:
    Bearer-Authentication
    query Parameters
    startTime
    string <date-time>
    Example: startTime=2018-05-21T13:58:20.243Z

    Only include results generated on or after this date-time.

    -
    endTime
    string <date-time>
    Example: endTime=2018-05-21T13:58:20.243Z

    Only include results generated on or before this date-time.

    -
    priorityRange
    string^\d+,\d+$
    Example: priorityRange=0,255

    Includes only results within the specified alarm priority range, from 0 to 255 inclusive.

    -
    type
    Array of strings[ items <= 100 items ]
    Example: type=alarmValueEnumSet.avHighLimit
    metasysEnum: alarmValueEnumSet

    Limits the alarms returned to specified types.

    +
    Authorizations:
    Bearer-Authentication
    query Parameters
    startTime
    string <date-time>
    Example: startTime=2018-05-21T13:58:20.243Z

    Only include results generated on or after this date-time.

    +
    endTime
    string <date-time>
    Example: endTime=2018-05-21T13:58:20.243Z

    Only include results generated on or before this date-time.

    +
    priorityRange
    string^\d+,\d+$
    Example: priorityRange=0,255

    Includes only results within the specified alarm priority range, from 0 to 255 inclusive.

    +
    type
    Array of strings[ items <= 100 items ]
    Example: type=alarmValueEnumSet.avHighLimit
    metasysEnum: alarmValueEnumSet

    Limits the alarms returned to specified types.

    The acceptable values for the elements of this parameter come from the alarmValueEnumSet enumeration. Only the long name of the alarm value (for example, alarmValueEnumSet.avHighLimit instead of avHighLimit) is accepted. Find the definition of alarmValueEnumSet at the relative URL of /schemas/enums/alarmValueEnumSet.

    @@ -3251,7 +2374,17 @@

    Filter Behavior

    -
    includeAcknowledged
    boolean

    Determines whether acknowledged alarms will be included in the results or be +

    includeAcknowledged
    boolean

    Determines whether acknowledged alarms will be included in the results or be the only type of alarm in the results. Acknowledged alarms are those which have an acknowledgedTime value set.

    This parameter can produce 3 different types of results.

    @@ -3261,7 +2394,17 @@

    Filter Behavior

  • missing - (default) Acknowledged status is ignored; both acknowledged and non-acknowledged alarms are returned.
  • -
    includeDiscarded
    boolean

    Determines whether discarded alarms will be included in the results or be +

    includeDiscarded
    boolean

    Determines whether discarded alarms will be included in the results or be the only type of alarm in the results. Discarded alarms are those for which the activityManagementStatus is discarded. This parameter can produce 3 different types of results.

    @@ -3271,12 +2414,25 @@

    Filter Behavior

  • missing - (default) Discarded status is ignored; both discarded and non-discarded alarms are returned.
  • -
    includeAcknowledgementRequired
    boolean
    Default: true
    Example: includeAcknowledgementRequired=true

    Determines whether alarms which can be acknowledged are included in the results. When the value is true, alarms which can be acknowledged will be included in the results. When false, alarms which can be acknowledged will not be included in the results.

    -
    includeAcknowledgementNotRequired
    boolean
    Default: true
    Example: includeAcknowledgementNotRequired=true

    Determines whether alarms which can not be acknowledged are included in the results. When the value is true then the results will include alarms which cannot be acknowledged. When the value is false then the results will not include alarms which cannot be acknowledged.

    -
    equipment
    Array of strings <= 100 items
    Example: equipment=b7ed8b3e-cb95-410d-aaa7-37158852c398

    Filter by list of equipment identifiers.

    -
    object
    Array of strings <= 100 items
    Example: object=06d77c63-6357-467a-a306-5e1ab3eb3aa7

    Filter by list of object identifiers.

    -
    space
    Array of strings <= 100 items
    Example: space=214f52d1-0c56-4a29-a690-abe5656d1647

    Filter by list of space identifiers.

    -
    category
    Array of strings
    Example: category=objectCategoryEnumSet.hvacCategory
    metasysEnum: objectCategoryEnumSet

    The authorization category of the requested activities.

    +
    includeAcknowledgementRequired
    boolean
    Default: true
    Example: includeAcknowledgementRequired=true

    Determines whether alarms which can be acknowledged are included in the results. When the value is true, alarms which can be acknowledged will be included in the results. When false, alarms which can be acknowledged will not be included in the results.

    +
    includeAcknowledgementNotRequired
    boolean
    Default: true
    Example: includeAcknowledgementNotRequired=true

    Determines whether alarms which can not be acknowledged are included in the results. When the value is true then the results will include alarms which cannot be acknowledged. When the value is false then the results will not include alarms which cannot be acknowledged.

    +
    equipment
    Array of strings <= 100 items
    Example: equipment=b7ed8b3e-cb95-410d-aaa7-37158852c398

    Filter by list of equipment identifiers.

    +
    object
    Array of strings <= 100 items
    Example: object=06d77c63-6357-467a-a306-5e1ab3eb3aa7

    Filter by list of object identifiers.

    +
    space
    Array of strings <= 100 items
    Example: space=214f52d1-0c56-4a29-a690-abe5656d1647

    Filter by list of space identifiers.

    +
    category
    Array of strings
    Example: category=objectCategoryEnumSet.hvacCategory
    metasysEnum: objectCategoryEnumSet

    The authorization category of the requested activities.

    The acceptable values for the elements of this parameter come from the objectCategoryEnumSet enumeration. Only the long name of the object category (for example, objectCategoryEnumSet.hvacCategory instead of hvacCategory) is accepted. Find the definition of objectCategoryEnumSet at the relative URL of /schemas/enums/objectCategoryEnumSet.

    @@ -3284,24 +2440,48 @@

    Filter Behavior

    -
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    -
    pageSize
    integer [ 1 .. 10000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    -
    sort
    string
    Default: "creationTime"
    Enum: "creationTime" "-creationTime" "priority" "-priority"
    Example: sort=creationTime

    The criteria to use when sorting results (see rules).

    -

    Responses

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v4/alarms?startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&priorityRange=0%2C255&type=alarmValueEnumSet.avHighLimit&includeAcknowledged=false&includeDiscarded=false&includeAcknowledgementRequired=true&includeAcknowledgementNotRequired=true&equipment=b7ed8b3e-cb95-410d-aaa7-37158852c398&object=06d77c63-6357-467a-a306-5e1ab3eb3aa7&space=214f52d1-0c56-4a29-a690-abe5656d1647&category=objectCategoryEnumSet.hvacCategory&page=1&pageSize=100&sort=creationTime' \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    The first 10 alarms.

    -
    {}

    Get an alarm

    Retrieves the specified alarm.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    alarmId
    required
    string
    Example: 4d0598d4-2836-4efd-84b8-6f39754b1fc5

    The identifier of the alarm.

    -

    Responses

    Request samples

    curl --request GET \
    -  --url https:///%7Bhostname%7D/api/v4/alarms/4d0598d4-2836-4efd-84b8-6f39754b1fc5 \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    An alarm for an analog value object.

    -
    {}

    Edit an alarm

    Allows for acknowledging or discarding an alarm.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    alarmId
    required
    string
    Example: 4d0598d4-2836-4efd-84b8-6f39754b1fc5

    The identifier of the alarm.

    -
    Request Body schema: application/json
    activityManagementStatus
    required
    string
    Enum: "acknowledged" "discarded"

    The new activity management status of the alarm.

    +
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    +
    pageSize
    integer [ 1 .. 10000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    +
    sort
    string
    Default: "creationTime"
    Enum: "creationTime" "-creationTime" "priority" "-priority"
    Example: sort=creationTime

    The criteria to use when sorting results (see rules).

    +

    Responses

    Request samples

    curl --request GET \
    +  --url 'https://metasys-server.example.com/api/v4/alarms?startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&priorityRange=0%2C255&type=alarmValueEnumSet.avHighLimit&includeAcknowledged=false&includeDiscarded=false&includeAcknowledgementRequired=true&includeAcknowledgementNotRequired=true&equipment=b7ed8b3e-cb95-410d-aaa7-37158852c398&object=06d77c63-6357-467a-a306-5e1ab3eb3aa7&space=214f52d1-0c56-4a29-a690-abe5656d1647&category=objectCategoryEnumSet.hvacCategory&page=1&pageSize=100&sort=creationTime' \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    The first 10 alarms.

    +
    {}

    Get an alarm

    Retrieves the specified alarm.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    alarmId
    required
    string
    Example: 4d0598d4-2836-4efd-84b8-6f39754b1fc5

    The identifier of the alarm.

    +

    Responses

    Request samples

    curl --request GET \
    +  --url https://metasys-server.example.com/api/v4/alarms/4d0598d4-2836-4efd-84b8-6f39754b1fc5 \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    An alarm for an analog value object.

    +
    {}

    Edit an alarm

    Allows for acknowledging or discarding an alarm.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    alarmId
    required
    string
    Example: 4d0598d4-2836-4efd-84b8-6f39754b1fc5

    The identifier of the alarm.

    +
    Request Body schema: application/json
    required
    activityManagementStatus
    required
    string
    Enum: "acknowledged" "discarded"

    The new activity management status of the alarm.

    The values of this property are described as follows:

    • acknowledged - The alarm has been recognized and viewed by a @@ -3312,28 +2492,76 @@

      Filter Behavior

      user. Once an alarm is discarded, it cannot be changed to any other state.
    -
    annotationText
    string or null

    The annotation associated with the change of alarm state.

    -

    Responses

    annotationText
    string or null

    The annotation associated with the change of alarm state.

    +

    Responses

    Request samples

    Content type
    application/json
    Example
    {
    • "activityManagementStatus": "acknowledged"
    }

    Get alarm annotations

    Retrieves the collection of annotations available for the specified alarm.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    alarmId
    required
    string
    Example: 4d0598d4-2836-4efd-84b8-6f39754b1fc5

    The identifier of the alarm.

    -
    query Parameters
    startTime
    string <date-time>
    Example: startTime=2018-05-21T13:58:20.243Z

    Only include results generated on or after this date-time.

    -
    endTime
    string <date-time>
    Example: endTime=2018-05-21T13:58:20.243Z

    Only include results generated on or before this date-time.

    -
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    -
    pageSize
    integer [ 1 .. 10000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    -
    sort
    string
    Default: "creationTime"
    Enum: "creationTime" "-creationTime" "user" "-user"
    Example: sort=creationTime

    The criteria to use when sorting results (see rules).

    -

    Responses

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v4/alarms/4d0598d4-2836-4efd-84b8-6f39754b1fc5/annotations?startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&page=1&pageSize=100&sort=creationTime' \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    {}

    audits

    How to retrieve, discard, and annotate audits.

    +

    Request samples

    Content type
    application/json
    Example
    {
    • "activityManagementStatus": "acknowledged"
    }

    Get alarm annotations

    Retrieves the collection of annotations available for the specified alarm.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    alarmId
    required
    string
    Example: 4d0598d4-2836-4efd-84b8-6f39754b1fc5

    The identifier of the alarm.

    +
    query Parameters
    startTime
    string <date-time>
    Example: startTime=2018-05-21T13:58:20.243Z

    Only include results generated on or after this date-time.

    +
    endTime
    string <date-time>
    Example: endTime=2018-05-21T13:58:20.243Z

    Only include results generated on or before this date-time.

    +
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    +
    pageSize
    integer [ 1 .. 10000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    +
    sort
    string
    Default: "creationTime"
    Enum: "creationTime" "-creationTime" "user" "-user"
    Example: sort=creationTime

    The criteria to use when sorting results (see rules).

    +

    Responses

    Request samples

    curl --request GET \
    +  --url 'https://metasys-server.example.com/api/v4/alarms/4d0598d4-2836-4efd-84b8-6f39754b1fc5/annotations?startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&page=1&pageSize=100&sort=creationTime' \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    {}

    audits

    How to retrieve, discard, and annotate audits.

    Relationships

    Audits have relationships to other resources in the system. Find information about the most important below.

    @@ -3362,11 +2590,24 @@

    Relationships

    explanation. Equipment instances can serve spaces, such as an Air Handler Unit (AHU) serving the floor of a building. Therefore, audits associated with a particular equipment instance are associated to the spaces they serve.

    -

    Get audits for an object

    Retrieves a collection of audits for the specified object.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    objectId
    required
    string
    Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb

    The identifier of the object.

    -
    query Parameters
    startTime
    string <date-time>
    Example: startTime=2018-05-21T13:58:20.243Z

    Only include results generated on or after this date-time.

    -
    endTime
    string <date-time>
    Example: endTime=2018-05-21T13:58:20.243Z

    Only include results generated on or before this date-time.

    -
    originApplication
    Array of strings
    Example: originApplication=auditOriginAppEnumSet.deviceManagerAuditOriginApp
    metasysEnum: auditOriginAppEnumSet

    Filter by list of origin applications. The origin application property +

    Get audits for an object

    Retrieves a collection of audits for the specified object.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    objectId
    required
    string
    Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb

    The identifier of the object.

    +
    query Parameters
    startTime
    string <date-time>
    Example: startTime=2018-05-21T13:58:20.243Z

    Only include results generated on or after this date-time.

    +
    endTime
    string <date-time>
    Example: endTime=2018-05-21T13:58:20.243Z

    Only include results generated on or before this date-time.

    +
    originApplication
    Array of strings
    Example: originApplication=auditOriginAppEnumSet.deviceManagerAuditOriginApp
    metasysEnum: auditOriginAppEnumSet

    Filter by list of origin applications. The origin application property indicates which application in Metasys generated the audit message.

    The acceptable values for the elements of this parameter come from the auditOriginAppEnumSet enumeration. Only the long name of the origin application (for example, auditOriginAppEnumSet.deviceManagerAuditOriginApp instead of deviceManagerAuditOriginApp) is accepted. @@ -3375,7 +2616,23 @@

    Relationships

    -
    classLevel
    Array of strings
    Example: classLevel=auditClassesEnumSet.userActionAuditClass
    metasysEnum: auditClassesEnumSet

    Filter by list of class levels. The class level of an audit indicates the +

    classLevel
    Array of strings
    Example: classLevel=auditClassesEnumSet.userActionAuditClass
    metasysEnum: auditClassesEnumSet

    Filter by list of class levels. The class level of an audit indicates the class or family the audit belongs to. Typically, each level of audit provides additional detail about the system, with Diagnostic audits being the most verbose.

    @@ -3391,7 +2648,16 @@

    Relationships

    -
    actionType
    Array of strings
    Example: actionType=auditActionTypeEnumSet.writeAuditActionType
    metasysEnum: auditActionTypeEnumSet

    Filter by list of action types. The action type property indicates the user +

    actionType
    Array of strings
    Example: actionType=auditActionTypeEnumSet.writeAuditActionType
    metasysEnum: auditActionTypeEnumSet

    Filter by list of action types. The action type property indicates the user or system action performed.

    The acceptable values for the elements of this parameter come from the auditActionTypeEnumSet enumeration. Only the long name of the action type (for example, auditActionTypeEnumSet.writeAuditActionType instead of writeAuditActionType) is accepted. @@ -3400,35 +2666,70 @@

    Relationships

    -
    user
    Array of strings <= 100 items
    Example: user=metasysuser

    Filter by list of users. The user property indicates which user initiated +

    user
    Array of strings <= 100 items
    Example: user=metasysuser

    Filter by list of users. The user property indicates which user initiated the action being audited.

    -
    includeDiscarded
    boolean

    Determines whether discarded audits will be included in the results.

    +
    includeDiscarded
    boolean

    Determines whether discarded audits will be included in the results.

    • true - Return only discarded audits in the response.
    • false - Do not include any discarded audits in the response.
    • missing - Discarded status is ignored; both discarded and non-discarded audits are returned.
    -
    equipment
    Array of strings <= 100 items
    Example: equipment=b7ed8b3e-cb95-410d-aaa7-37158852c398

    Filter by list of equipment identifiers.

    -
    space
    Array of strings <= 100 items
    Example: space=214f52d1-0c56-4a29-a690-abe5656d1647

    Filter by list of space identifiers.

    -
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    -
    pageSize
    integer [ 1 .. 10000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    -
    sort
    string
    Default: "creationTime"
    Enum: "creationTime" "-creationTime"
    Example: sort=creationTime

    The criteria to use when sorting results (see rules).

    -

    Responses

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v4/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/audits?startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&originApplication=auditOriginAppEnumSet.deviceManagerAuditOriginApp&classLevel=auditClassesEnumSet.userActionAuditClass&actionType=auditActionTypeEnumSet.writeAuditActionType&user=metasysuser&includeDiscarded=false&equipment=b7ed8b3e-cb95-410d-aaa7-37158852c398&space=214f52d1-0c56-4a29-a690-abe5656d1647&page=1&pageSize=100&sort=creationTime' \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    Gets the first 10 audits.

    -
    {
    • "total": 400,
    • "previous": null,
    • "items": [
      ],
    • "effectivePermissions": [
      ],
    }

    Get audits Deprecated

    Retrieves a collection of audits.

    +
    equipment
    Array of strings <= 100 items
    Example: equipment=b7ed8b3e-cb95-410d-aaa7-37158852c398

    Filter by list of equipment identifiers.

    +
    space
    Array of strings <= 100 items
    Example: space=214f52d1-0c56-4a29-a690-abe5656d1647

    Filter by list of space identifiers.

    +
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    +
    pageSize
    integer [ 1 .. 10000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    +
    sort
    string
    Default: "creationTime"
    Enum: "creationTime" "-creationTime"
    Example: sort=creationTime

    The criteria to use when sorting results (see rules).

    +

    Responses

    Request samples

    curl --request GET \
    +  --url 'https://metasys-server.example.com/api/v4/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/audits?startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&originApplication=auditOriginAppEnumSet.deviceManagerAuditOriginApp&classLevel=auditClassesEnumSet.userActionAuditClass&actionType=auditActionTypeEnumSet.writeAuditActionType&user=metasysuser&includeDiscarded=false&equipment=b7ed8b3e-cb95-410d-aaa7-37158852c398&space=214f52d1-0c56-4a29-a690-abe5656d1647&page=1&pageSize=100&sort=creationTime' \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    Gets the first 10 audits.

    +
    {
    • "total": 400,
    • "previous": null,
    • "items": [
      ],
    • "effectivePermissions": [
      ],
    }

    Get audits Deprecated

    Retrieves a collection of audits.

    Note: This operation is deprecated and may be removed in a future release. To retrieve audits, consider using GET /activities?activityType=audit instead. See List activities

    -
    Authorizations:
    Bearer-Authentication
    query Parameters
    startTime
    string <date-time>
    Example: startTime=2018-05-21T13:58:20.243Z

    Only include results generated on or after this date-time.

    -
    endTime
    string <date-time>
    Example: endTime=2018-05-21T13:58:20.243Z

    Only include results generated on or before this date-time.

    -
    originApplication
    Array of strings
    Example: originApplication=auditOriginAppEnumSet.deviceManagerAuditOriginApp
    metasysEnum: auditOriginAppEnumSet

    Filter by list of origin applications. The origin application property +

    Authorizations:
    Bearer-Authentication
    query Parameters
    startTime
    string <date-time>
    Example: startTime=2018-05-21T13:58:20.243Z

    Only include results generated on or after this date-time.

    +
    endTime
    string <date-time>
    Example: endTime=2018-05-21T13:58:20.243Z

    Only include results generated on or before this date-time.

    +
    originApplication
    Array of strings
    Example: originApplication=auditOriginAppEnumSet.deviceManagerAuditOriginApp
    metasysEnum: auditOriginAppEnumSet

    Filter by list of origin applications. The origin application property indicates which application in Metasys generated the audit message.

    The acceptable values for the elements of this parameter come from the auditOriginAppEnumSet enumeration. Only the long name of the origin application (for example, auditOriginAppEnumSet.deviceManagerAuditOriginApp instead of deviceManagerAuditOriginApp) is accepted. @@ -3437,7 +2738,23 @@

    Relationships

    -
    classLevel
    Array of strings
    Example: classLevel=auditClassesEnumSet.userActionAuditClass
    metasysEnum: auditClassesEnumSet

    Filter by list of class levels. The class level of an audit indicates the +

    classLevel
    Array of strings
    Example: classLevel=auditClassesEnumSet.userActionAuditClass
    metasysEnum: auditClassesEnumSet

    Filter by list of class levels. The class level of an audit indicates the class or family the audit belongs to. Typically, each level of audit provides additional detail about the system, with Diagnostic audits being the most verbose.

    @@ -3453,7 +2770,16 @@

    Relationships

    -
    actionType
    Array of strings
    Example: actionType=auditActionTypeEnumSet.writeAuditActionType
    metasysEnum: auditActionTypeEnumSet

    Filter by list of action types. The action type property indicates the user +

    actionType
    Array of strings
    Example: actionType=auditActionTypeEnumSet.writeAuditActionType
    metasysEnum: auditActionTypeEnumSet

    Filter by list of action types. The action type property indicates the user or system action performed.

    The acceptable values for the elements of this parameter come from the auditActionTypeEnumSet enumeration. Only the long name of the action type (for example, auditActionTypeEnumSet.writeAuditActionType instead of writeAuditActionType) is accepted. @@ -3462,163 +2788,305 @@

    Relationships

    -
    user
    Array of strings <= 100 items
    Example: user=metasysuser

    Filter by list of users. The user property indicates which user initiated +

    user
    Array of strings <= 100 items
    Example: user=metasysuser

    Filter by list of users. The user property indicates which user initiated the action being audited.

    -
    includeDiscarded
    boolean

    Determines whether discarded audits will be included in the results.

    +
    includeDiscarded
    boolean

    Determines whether discarded audits will be included in the results.

    • true - Return only discarded audits in the response.
    • false - Do not include any discarded audits in the response.
    • missing - Discarded status is ignored; both discarded and non-discarded audits are returned.
    -
    equipment
    Array of strings <= 100 items
    Example: equipment=b7ed8b3e-cb95-410d-aaa7-37158852c398

    Filter by list of equipment identifiers.

    -
    object
    Array of strings <= 100 items
    Example: object=06d77c63-6357-467a-a306-5e1ab3eb3aa7

    Filter by list of object identifiers.

    -
    space
    Array of strings <= 100 items
    Example: space=214f52d1-0c56-4a29-a690-abe5656d1647

    Filter by list of space identifiers.

    -
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    -
    pageSize
    integer [ 1 .. 10000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    -
    sort
    string
    Default: "creationTime"
    Enum: "creationTime" "-creationTime"
    Example: sort=creationTime

    The criteria to use when sorting results (see rules).

    -

    Responses

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v4/audits?startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&originApplication=auditOriginAppEnumSet.deviceManagerAuditOriginApp&classLevel=auditClassesEnumSet.userActionAuditClass&actionType=auditActionTypeEnumSet.writeAuditActionType&user=metasysuser&includeDiscarded=false&equipment=b7ed8b3e-cb95-410d-aaa7-37158852c398&object=06d77c63-6357-467a-a306-5e1ab3eb3aa7&space=214f52d1-0c56-4a29-a690-abe5656d1647&page=1&pageSize=100&sort=creationTime' \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    Gets the first 10 audits.

    -
    {
    • "total": 400,
    • "previous": null,
    • "items": [
      ],
    • "effectivePermissions": [
      ],
    }

    Get an audit

    Retrieves the specific audit.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    auditId
    required
    string
    Example: 4990ee27-7a0a-4b2b-9b27-279e3f1a060c

    The identifier of the audit.

    -

    Responses

    Request samples

    curl --request GET \
    -  --url https:///%7Bhostname%7D/api/v4/audits/4990ee27-7a0a-4b2b-9b27-279e3f1a060c \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    An audit for an analog value object.

    -
    {
    • "id": "6c6ae3dd-c514-423d-bd22-0b48678c5384",
    • "creationTime": "2021-12-10T21:05:53Z",
    • "actionType": "auditActionTypeEnumSet.commandAuditActionType",
    • "activityManagementStatus": "pending",
    • "status": "statusEnumSet.ok",
    • "spaces": [ ],
    • "equipment": [ ],
    • "preData": {
      },
    • "postData": null,
    • "parameters": [
      ],
    • "errorString": null,
    • "user": null,
    • "signature": null,
    • "itemReference": "{hostname}:{deviceHostname}/AV1",
    • "objectName": "Interlock1/AV1",
    • "classLevel": "auditClassesEnumSet.applicationAuditClass",
    • "originApplication": "auditOriginAppEnumSet.interlockAuditOriginApp",
    • "description": "commandIdEnumSet.adjustCommand"
    }

    Edit an audit

    Allows for discarding an audit.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    auditId
    required
    string
    Example: 4990ee27-7a0a-4b2b-9b27-279e3f1a060c

    The identifier of the audit.

    -
    Request Body schema: application/json
    activityManagementStatus
    required
    string
    Value: "discarded"

    The new activity management status of the audit.

    +
    equipment
    Array of strings <= 100 items
    Example: equipment=b7ed8b3e-cb95-410d-aaa7-37158852c398

    Filter by list of equipment identifiers.

    +
    object
    Array of strings <= 100 items
    Example: object=06d77c63-6357-467a-a306-5e1ab3eb3aa7

    Filter by list of object identifiers.

    +
    space
    Array of strings <= 100 items
    Example: space=214f52d1-0c56-4a29-a690-abe5656d1647

    Filter by list of space identifiers.

    +
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    +
    pageSize
    integer [ 1 .. 10000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    +
    sort
    string
    Default: "creationTime"
    Enum: "creationTime" "-creationTime"
    Example: sort=creationTime

    The criteria to use when sorting results (see rules).

    +

    Responses

    Request samples

    curl --request GET \
    +  --url 'https://metasys-server.example.com/api/v4/audits?startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&originApplication=auditOriginAppEnumSet.deviceManagerAuditOriginApp&classLevel=auditClassesEnumSet.userActionAuditClass&actionType=auditActionTypeEnumSet.writeAuditActionType&user=metasysuser&includeDiscarded=false&equipment=b7ed8b3e-cb95-410d-aaa7-37158852c398&object=06d77c63-6357-467a-a306-5e1ab3eb3aa7&space=214f52d1-0c56-4a29-a690-abe5656d1647&page=1&pageSize=100&sort=creationTime' \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    Gets the first 10 audits.

    +
    {
    • "total": 400,
    • "previous": null,
    • "items": [
      ],
    • "effectivePermissions": [
      ],
    }

    Get an audit

    Retrieves the specific audit.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    auditId
    required
    string
    Example: 4990ee27-7a0a-4b2b-9b27-279e3f1a060c

    The identifier of the audit.

    +

    Responses

    Request samples

    curl --request GET \
    +  --url https://metasys-server.example.com/api/v4/audits/4990ee27-7a0a-4b2b-9b27-279e3f1a060c \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    An audit for an analog value object.

    +
    {
    • "id": "6c6ae3dd-c514-423d-bd22-0b48678c5384",
    • "creationTime": "2021-12-10T21:05:53Z",
    • "actionType": "auditActionTypeEnumSet.commandAuditActionType",
    • "activityManagementStatus": "pending",
    • "status": "statusEnumSet.ok",
    • "spaces": [ ],
    • "equipment": [ ],
    • "preData": {
      },
    • "postData": null,
    • "parameters": [
      ],
    • "errorString": null,
    • "user": null,
    • "signature": null,
    • "itemReference": "{hostname}:{deviceHostname}/AV1",
    • "objectName": "Interlock1/AV1",
    • "classLevel": "auditClassesEnumSet.applicationAuditClass",
    • "originApplication": "auditOriginAppEnumSet.interlockAuditOriginApp",
    • "description": "commandIdEnumSet.adjustCommand"
    }

    Edit an audit

    Allows for discarding an audit.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    auditId
    required
    string
    Example: 4990ee27-7a0a-4b2b-9b27-279e3f1a060c

    The identifier of the audit.

    +
    Request Body schema: application/json
    required
    activityManagementStatus
    required
    string
    Value: "discarded"

    The new activity management status of the audit.

    The only accepted value of this property is discarded because it is the only valid activity management state transition for an audit. Once an audit is discarded, it cannot be changed to any other state.

    -
    annotationText
    string or null

    The annotation to associate with the change of audit state.

    -

    Responses

    Request samples

    Content type
    application/json
    {
    • "activityManagementStatus": "discarded"
    }

    Get audit annotations

    Retrieves the collection of annotations available for the specified audit.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    auditId
    required
    string
    Example: 4990ee27-7a0a-4b2b-9b27-279e3f1a060c

    The identifier of the audit.

    -
    query Parameters
    startTime
    string <date-time>
    Example: startTime=2018-05-21T13:58:20.243Z

    Only include results generated on or after this date-time.

    -
    endTime
    string <date-time>
    Example: endTime=2018-05-21T13:58:20.243Z

    Only include results generated on or before this date-time.

    -
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    -
    pageSize
    integer [ 1 .. 10000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    -
    sort
    string
    Default: "creationTime"
    Enum: "creationTime" "-creationTime"
    Example: sort=creationTime

    The criteria to use when sorting results (see rules).

    -

    Responses

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v4/audits/4990ee27-7a0a-4b2b-9b27-279e3f1a060c/annotations?startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&page=1&pageSize=100&sort=creationTime' \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    {}

    Add audit annotation

    Adds an annotation to an audit.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    auditId
    required
    string
    Example: 4990ee27-7a0a-4b2b-9b27-279e3f1a060c

    The identifier of the audit.

    -
    Request Body schema: application/json
    text
    required
    string [ 1 .. 255 ] characters \S

    The text of the annotation to create. This must not be null, empty, nor only whitespace. Additionally, any surrounding whitespace will be trimmed.

    -

    Responses

    annotationText
    string or null

    The annotation to associate with the change of audit state.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "activityManagementStatus": "discarded"
    }

    Get audit annotations

    Retrieves the collection of annotations available for the specified audit.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    auditId
    required
    string
    Example: 4990ee27-7a0a-4b2b-9b27-279e3f1a060c

    The identifier of the audit.

    +
    query Parameters
    startTime
    string <date-time>
    Example: startTime=2018-05-21T13:58:20.243Z

    Only include results generated on or after this date-time.

    +
    endTime
    string <date-time>
    Example: endTime=2018-05-21T13:58:20.243Z

    Only include results generated on or before this date-time.

    +
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    +
    pageSize
    integer [ 1 .. 10000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    +
    sort
    string
    Default: "creationTime"
    Enum: "creationTime" "-creationTime"
    Example: sort=creationTime

    The criteria to use when sorting results (see rules).

    +

    Responses

    Request samples

    curl --request GET \
    +  --url 'https://metasys-server.example.com/api/v4/audits/4990ee27-7a0a-4b2b-9b27-279e3f1a060c/annotations?startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&page=1&pageSize=100&sort=creationTime' \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    {}

    Add audit annotation

    Adds an annotation to an audit.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    auditId
    required
    string
    Example: 4990ee27-7a0a-4b2b-9b27-279e3f1a060c

    The identifier of the audit.

    +
    Request Body schema: application/json
    required
    text
    required
    string [ 1 .. 255 ] characters \S

    The text of the annotation to create. This must not be null, empty, nor only whitespace. Additionally, any surrounding whitespace will be trimmed.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "text": "Looks okay."
    }

    List audit users

    Retrieves a list of unique usernames from all users present in a currently +

    Request samples

    Content type
    application/json
    {
    • "text": "Looks okay."
    }

    List audit users

    Retrieves a list of unique usernames from all users present in a currently stored audit. The provided usernames may or may not reflect known users of the current system, but were known when the system recorded an audit for them.

    -
    Authorizations:
    Bearer-Authentication

    Responses

    Request samples

    curl --request GET \
    -  --url https:///%7Bhostname%7D/api/v4/audits/users \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    {}

    authentication

    Operations to get and refresh an access token.

    -

    Request access token

    Use this to request an access token that can be used for authentication on other API calls.

    -
    Request Body schema: application/json

    Used to supply credentials for login.

    -
    username
    string

    The user name of an account. This can either be a local Metasys +

    Authorizations:
    Bearer-Authentication

    Responses

    Request samples

    curl --request GET \
    +  --url https://metasys-server.example.com/api/v4/audits/users \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    {}

    authentication

    Operations to get and refresh an access token.

    +

    Request access token

    Use this to request an access token that can be used for authentication on other API calls.

    +
    Request Body schema: application/json
    required

    Used to supply credentials for login.

    +
    username
    string

    The user name of an account. This can either be a local Metasys account, or an Active Directory account that has been granted access to Metasys. When using an Active Directory account, the value should be in the format {name}@{domain} (for example, jane-doe@mycorp.com).

    Note: Only accounts with an Access Type of API can be used to request a token from the REST API.

    -
    password
    string

    The corresponding password of a Metasys account.

    -

    Responses

    Request samples

    Content type
    application/json
    Example
    {
    • "username": "jane-doe",
    • "password": "strongPassword"
    }

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    The result includes the access token needed to make requests. (The token in this example has been truncated.)

    -
    {
    • "accessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1...",
    • "expires": "2021-04-22T00:12:18Z"
    }

    Refresh a token

    Use this operation to request a new token before the previous one expires. Note: If the expiration time of the access token is greater than 60 minutes from issue, disregard and refresh before 60 minutes to prevent session expiration. The next version of the API will provide the correct expiration time.

    -
    Authorizations:
    Bearer-Authentication

    Responses

    Request samples

    curl --request GET \
    -  --url https:///%7Bhostname%7D/api/v4/refreshToken \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    The result includes the access token needed to make requests. (The token in this example has been truncated.)

    -
    {
    • "accessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1...",
    • "expires": "2021-04-22T00:12:18Z"
    }

    equipment

    This section describes the operations you can perform on equipment. Equipment is a broad term for anything that makes a building run, including boilers, chillers, air handling units, lights, meters, and security systems. Use equipment operations to get equipment instances and to list equipment points. Apply filters, sorting, and paging to further refine the results.

    -

    Get equipment hosted by a network device

    Retrieves the collection of equipment instances hosted by the specified network device or its children. A network device is considered to host an equipment if the equipment defines points that map to an attribute of any object contained on the network device.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    networkDeviceId
    required
    string
    Example: d9bf66bd-22f8-425b-82a4-44ba153d79c7

    The identifier of a network device.

    -
    query Parameters
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    -
    pageSize
    integer [ 1 .. 1000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    -
    sort
    string
    Default: "name"
    Enum: "itemReference" "-itemReference" "name" "-name" "type" "-type"
    Example: sort=name

    The criteria to use when sorting results (see rules).

    -

    Responses

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v4/networkDevices/d9bf66bd-22f8-425b-82a4-44ba153d79c7/equipment?page=1&pageSize=100&sort=name' \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    Get equipment instances

    Retrieves a collection of equipment instances.

    -
    Authorizations:
    Bearer-Authentication
    query Parameters
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    -
    pageSize
    integer [ 1 .. 1000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    -
    sort
    string
    Default: "name"
    Enum: "itemReference" "-itemReference" "name" "-name" "type" "-type"
    Example: sort=name

    The criteria to use when sorting results (see rules).

    -

    Responses

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v4/equipment?page=1&pageSize=100&sort=name' \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    A page of equipment instances.

    -

    Get a single equipment instance

    Retrieves the specified equipment instance.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    equipmentId
    required
    string
    Example: b78fa672-3ec9-4794-bd00-7aeafeb9cde0

    The identifier of the equipment instance.

    -

    Responses

    Request samples

    curl --request GET \
    -  --url https:///%7Bhostname%7D/api/v4/equipment/b78fa672-3ec9-4794-bd00-7aeafeb9cde0 \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    Get equipment served by an equipment instance

    Retrieves the equipment served by the specified equipment instance.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    equipmentId
    required
    string
    Example: b78fa672-3ec9-4794-bd00-7aeafeb9cde0

    The identifier of the equipment instance.

    -
    query Parameters
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    -
    pageSize
    integer [ 1 .. 1000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    -
    sort
    string
    Default: "name"
    Enum: "itemReference" "-itemReference" "name" "-name" "type" "-type"
    Example: sort=name

    The criteria to use when sorting results (see rules).

    -

    Responses

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v4/equipment/b78fa672-3ec9-4794-bd00-7aeafeb9cde0/equipment?page=1&pageSize=100&sort=name' \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    Get equipment that serve an equipment instance

    Retrieves the collection of equipment that serve the specified equipment instance.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    equipmentId
    required
    string
    Example: 04d68394-3415-4813-b5ec-43d840deee38

    The identifier of the equipment instance.

    -
    query Parameters
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    -
    pageSize
    integer [ 1 .. 1000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    -
    sort
    string
    Default: "name"
    Enum: "itemReference" "-itemReference" "name" "-name" "type" "-type"
    Example: sort=name

    The criteria to use when sorting results (see rules).

    -

    Responses

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v4/equipment/04d68394-3415-4813-b5ec-43d840deee38/upstreamEquipment?page=1&pageSize=100&sort=name' \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    List equipment points

    Retrieves the collection of points that are defined by the specified equipment instance. Each point contains a mapping to an attribute on an object.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    equipmentId
    required
    string
    Example: b78fa672-3ec9-4794-bd00-7aeafeb9cde0

    The identifier of the equipment instance.

    -
    query Parameters
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    -
    pageSize
    integer [ 1 .. 1000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    -
    sort
    string
    Default: "shortName"
    Enum: "category" "-category" "equipmentName" "-equipmentName" "isDisplayData" "-isDisplayData" "shortName" "-shortName"
    Example: sort=shortName

    The criteria to use when sorting results (see rules).

    -

    Responses

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v4/equipment/b78fa672-3ec9-4794-bd00-7aeafeb9cde0/points?page=1&pageSize=100&sort=shortName' \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    A page of equipment points

    -
    {}

    Get equipment serving a space

    Retrieves the collection of equipment that serve the specified space.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    spaceId
    required
    string
    Example: bf254f63-2cbb-4195-8c53-a1d6fcbe54f6

    The identifier of a space.

    -
    query Parameters
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    -
    pageSize
    integer [ 1 .. 1000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    -
    sort
    string
    Default: "name"
    Enum: "itemReference" "-itemReference" "name" "-name" "type" "-type"
    Example: sort=name

    The criteria to use when sorting results (see rules).

    -

    Responses

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v4/spaces/bf254f63-2cbb-4195-8c53-a1d6fcbe54f6/equipment?page=1&pageSize=100&sort=name' \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    network-devices

    This section describes the operations you can perform on network devices. Network devices are physical devices such as coordinators and routers that are required for communication between hardware on a computer network. Use network device operations to get, list, and delete network devices. Apply filters, sorting, and paging to further refine the results.

    -

    List network devices

    Retrieves a collection of network devices.

    -
    Authorizations:
    Bearer-Authentication
    query Parameters
    objectType
    string
    Example: objectType=bacnetIntegrationClass
    metasysType: enum
    metasysEnum: objectTypeEnumSet

    The type of network device to return.

    +
    password
    string

    The corresponding password of a Metasys account.

    +

    Responses

    Request samples

    Content type
    application/json
    Example
    {
    • "username": "jane-doe",
    • "password": "strongPassword"
    }

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    The result includes the access token needed to make requests. (The token in this example has been truncated.)

    +
    {
    • "accessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1...",
    • "expires": "2021-04-22T00:12:18Z"
    }

    Refresh a token

    Use this operation to request a new token before the previous one expires. Note: If the expiration time of the access token is greater than 60 minutes from issue, disregard and refresh before 60 minutes to prevent session expiration. The next version of the API will provide the correct expiration time.

    +
    Authorizations:
    Bearer-Authentication

    Responses

    Request samples

    curl --request GET \
    +  --url https://metasys-server.example.com/api/v4/refreshToken \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    The result includes the access token needed to make requests. (The token in this example has been truncated.)

    +
    {
    • "accessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1...",
    • "expires": "2021-04-22T00:12:18Z"
    }

    equipment

    This section describes the operations you can perform on equipment. Equipment is a broad term for anything that makes a building run, including boilers, chillers, air handling units, lights, meters, and security systems. Use equipment operations to get equipment instances and to list equipment points. Apply filters, sorting, and paging to further refine the results.

    +

    Get equipment hosted by a network device

    Retrieves the collection of equipment instances hosted by the specified network device or its children. A network device is considered to host an equipment if the equipment defines points that map to an attribute of any object contained on the network device.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    networkDeviceId
    required
    string
    Example: d9bf66bd-22f8-425b-82a4-44ba153d79c7

    The identifier of a network device.

    +
    query Parameters
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    +
    pageSize
    integer [ 1 .. 1000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    +
    sort
    string
    Default: "name"
    Enum: "itemReference" "-itemReference" "name" "-name" "type" "-type"
    Example: sort=name

    The criteria to use when sorting results (see rules).

    +

    Responses

    Request samples

    curl --request GET \
    +  --url 'https://metasys-server.example.com/api/v4/networkDevices/d9bf66bd-22f8-425b-82a4-44ba153d79c7/equipment?page=1&pageSize=100&sort=name' \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    Get equipment instances

    Retrieves a collection of equipment instances.

    +
    Authorizations:
    Bearer-Authentication
    query Parameters
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    +
    pageSize
    integer [ 1 .. 1000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    +
    sort
    string
    Default: "name"
    Enum: "itemReference" "-itemReference" "name" "-name" "type" "-type"
    Example: sort=name

    The criteria to use when sorting results (see rules).

    +

    Responses

    Request samples

    curl --request GET \
    +  --url 'https://metasys-server.example.com/api/v4/equipment?page=1&pageSize=100&sort=name' \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    A page of equipment instances.

    +

    Get a single equipment instance

    Retrieves the specified equipment instance.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    equipmentId
    required
    string
    Example: b78fa672-3ec9-4794-bd00-7aeafeb9cde0

    The identifier of the equipment instance.

    +

    Responses

    Request samples

    curl --request GET \
    +  --url https://metasys-server.example.com/api/v4/equipment/b78fa672-3ec9-4794-bd00-7aeafeb9cde0 \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    Get equipment served by an equipment instance

    Retrieves the equipment served by the specified equipment instance.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    equipmentId
    required
    string
    Example: b78fa672-3ec9-4794-bd00-7aeafeb9cde0

    The identifier of the equipment instance.

    +
    query Parameters
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    +
    pageSize
    integer [ 1 .. 1000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    +
    sort
    string
    Default: "name"
    Enum: "itemReference" "-itemReference" "name" "-name" "type" "-type"
    Example: sort=name

    The criteria to use when sorting results (see rules).

    +

    Responses

    Request samples

    curl --request GET \
    +  --url 'https://metasys-server.example.com/api/v4/equipment/b78fa672-3ec9-4794-bd00-7aeafeb9cde0/equipment?page=1&pageSize=100&sort=name' \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    Get equipment that serve an equipment instance

    Retrieves the collection of equipment that serve the specified equipment instance.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    equipmentId
    required
    string
    Example: 04d68394-3415-4813-b5ec-43d840deee38

    The identifier of the equipment instance.

    +
    query Parameters
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    +
    pageSize
    integer [ 1 .. 1000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    +
    sort
    string
    Default: "name"
    Enum: "itemReference" "-itemReference" "name" "-name" "type" "-type"
    Example: sort=name

    The criteria to use when sorting results (see rules).

    +

    Responses

    Request samples

    curl --request GET \
    +  --url 'https://metasys-server.example.com/api/v4/equipment/04d68394-3415-4813-b5ec-43d840deee38/upstreamEquipment?page=1&pageSize=100&sort=name' \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    List equipment points

    Retrieves the collection of points that are defined by the specified equipment instance. Each point contains a mapping to an attribute on an object.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    equipmentId
    required
    string
    Example: b78fa672-3ec9-4794-bd00-7aeafeb9cde0

    The identifier of the equipment instance.

    +
    query Parameters
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    +
    pageSize
    integer [ 1 .. 1000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    +
    sort
    string
    Default: "shortName"
    Enum: "category" "-category" "equipmentName" "-equipmentName" "isDisplayData" "-isDisplayData" "shortName" "-shortName"
    Example: sort=shortName

    The criteria to use when sorting results (see rules).

    +

    Responses

    Request samples

    curl --request GET \
    +  --url 'https://metasys-server.example.com/api/v4/equipment/b78fa672-3ec9-4794-bd00-7aeafeb9cde0/points?page=1&pageSize=100&sort=shortName' \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    A page of equipment points

    +
    {}

    Get equipment serving a space

    Retrieves the collection of equipment that serve the specified space.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    spaceId
    required
    string
    Example: bf254f63-2cbb-4195-8c53-a1d6fcbe54f6

    The identifier of a space.

    +
    query Parameters
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    +
    pageSize
    integer [ 1 .. 1000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    +
    sort
    string
    Default: "name"
    Enum: "itemReference" "-itemReference" "name" "-name" "type" "-type"
    Example: sort=name

    The criteria to use when sorting results (see rules).

    +

    Responses

    Request samples

    curl --request GET \
    +  --url 'https://metasys-server.example.com/api/v4/spaces/bf254f63-2cbb-4195-8c53-a1d6fcbe54f6/equipment?page=1&pageSize=100&sort=name' \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    network-devices

    This section describes the operations you can perform on network devices. Network devices are physical devices such as coordinators and routers that are required for communication between hardware on a computer network. Use network device operations to get, list, and delete network devices. Apply filters, sorting, and paging to further refine the results.

    +

    List network devices

    Retrieves a collection of network devices.

    +
    Authorizations:
    Bearer-Authentication
    query Parameters
    objectType
    string
    Example: objectType=bacnetIntegrationClass
    metasysType: enum
    metasysEnum: objectTypeEnumSet

    The type of network device to return.

    The objectType query parameter cannot be used in conjunction with the classification query parameter.

    The acceptable values for this parameter come from the objectTypeEnumSet enumeration. @@ -3628,66 +3096,221 @@

    Relationships

    -
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    -
    pageSize
    integer [ 1 .. 1000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    -
    sort
    string
    Default: "name"
    Enum: "categoryId" "-categoryId" "firmwareVersion" "-firmwareVersion" "itemReference" "-itemReference" "name" "-name" "typeId" "-typeId"
    Example: sort=name

    The criteria to use when sorting results (see rules).

    -
    classification
    Array of strings
    Items Enum: "device" "integration" "server" "controller"
    Examples:
    • classification=device&classification=server&classification=controller - Only devices (excludes integrations)
    • classification=device - Only supervisory engines
    • classification=server&classification=device - Servers and supervisory engines

    The classification to filter devices on. One or more values are supported.

    +
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    +
    pageSize
    integer [ 1 .. 1000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    +
    sort
    string
    Default: "name"
    Enum: "categoryId" "-categoryId" "firmwareVersion" "-firmwareVersion" "itemReference" "-itemReference" "name" "-name" "typeId" "-typeId"
    Example: sort=name

    The criteria to use when sorting results (see rules).

    +
    classification
    Array of strings
    Items Enum: "device" "integration" "server" "controller"
    Examples:
    • classification=device&classification=server&classification=controller - Only devices (excludes integrations)
    • classification=device - Only supervisory engines
    • classification=server&classification=device - Servers and supervisory engines

    The classification to filter devices on. One or more values are supported.

    The classification query parameter cannot be used in conjunction with the objectType query parameter.

    -

    Responses

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v4/networkDevices?objectType=bacnetIntegrationClass&page=1&pageSize=100&sort=name&classification=device&classification=server&classification=controller' \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    A page of network devices.

    -
    {}

    Get a single network device

    Retrieves the specified network device.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    networkDeviceId
    required
    string
    Example: d9bf66bd-22f8-425b-82a4-44ba153d79c7

    The identifier of a network device.

    -

    Responses

    Request samples

    curl --request GET \
    -  --url https:///%7Bhostname%7D/api/v4/networkDevices/d9bf66bd-22f8-425b-82a4-44ba153d79c7 \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    A single network device.

    -
    {}

    Deletes a network device

    Deletes an engine or a server which is a child device of the site director. +

    Responses

    Request samples

    curl --request GET \
    +  --url 'https://metasys-server.example.com/api/v4/networkDevices?objectType=bacnetIntegrationClass&page=1&pageSize=100&sort=name&classification=device&classification=server&classification=controller' \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    A page of network devices.

    +
    {}

    Get a single network device

    Retrieves the specified network device.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    networkDeviceId
    required
    string
    Example: d9bf66bd-22f8-425b-82a4-44ba153d79c7

    The identifier of a network device.

    +

    Responses

    Request samples

    curl --request GET \
    +  --url https://metasys-server.example.com/api/v4/networkDevices/d9bf66bd-22f8-425b-82a4-44ba153d79c7 \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    A single network device.

    +
    {}

    Deletes a network device

    Deletes an engine or a server which is a child device of the site director. Cannot be used to delete controllers, integrations, or the site director.

    Note: The device must be offline for the operation to succeed.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    networkDeviceId
    required
    string
    Example: d9bf66bd-22f8-425b-82a4-44ba153d79c7

    The identifier of a network device.

    -

    Responses

    Request samples

    curl --request DELETE \
    -  --url https:///%7Bhostname%7D/api/v4/networkDevices/d9bf66bd-22f8-425b-82a4-44ba153d79c7 \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    List network device children

    Retrieves the collection of network devices that are children of the specified network device.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    networkDeviceId
    required
    string
    Example: d9bf66bd-22f8-425b-82a4-44ba153d79c7

    The identifier of a network device.

    -
    query Parameters
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    -
    pageSize
    integer [ 1 .. 1000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    -
    sort
    string
    Default: "name"
    Enum: "categoryId" "-categoryId" "firmwareVersion" "-firmwareVersion" "itemReference" "-itemReference" "name" "-name" "typeId" "-typeId"
    Example: sort=name

    The criteria to use when sorting results (see rules).

    -

    Responses

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v4/networkDevices/d9bf66bd-22f8-425b-82a4-44ba153d79c7/networkDevices?page=1&pageSize=100&sort=name' \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    A page of network devices.

    -
    {}

    List network devices hosting an equipment instance

    Retrieves the collection of network devices that host the specified equipment instance, along with the parents of those network devices. A network device hosts an equipment when the equipment defines points that map to an attribute of any object contained on the network device.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    equipmentId
    required
    string
    Example: b78fa672-3ec9-4794-bd00-7aeafeb9cde0

    The identifier of the equipment instance.

    -
    query Parameters
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    -
    pageSize
    integer [ 1 .. 1000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    -
    sort
    string
    Default: "name"
    Enum: "categoryId" "-categoryId" "firmwareVersion" "-firmwareVersion" "itemReference" "-itemReference" "name" "-name" "typeId" "-typeId"
    Example: sort=name

    The criteria to use when sorting results (see rules).

    -

    Responses

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v4/equipment/b78fa672-3ec9-4794-bd00-7aeafeb9cde0/networkDevices?page=1&pageSize=100&sort=name' \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    A page of network devices.

    -
    {}

    List network devices serving a space

    Retrieves the collection of network devices that serve the specified space. A space serves a network device when any equipment instance serving the space defines points that map to an attribute of any object contained on the network device.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    spaceId
    required
    string
    Example: bf254f63-2cbb-4195-8c53-a1d6fcbe54f6

    The identifier of a space.

    -
    query Parameters
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    -
    pageSize
    integer [ 1 .. 1000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    -
    sort
    string
    Default: "name"
    Enum: "categoryId" "-categoryId" "firmwareVersion" "-firmwareVersion" "itemReference" "-itemReference" "name" "-name" "typeId" "-typeId"
    Example: sort=name

    The criteria to use when sorting results (see rules).

    -

    Responses

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v4/spaces/bf254f63-2cbb-4195-8c53-a1d6fcbe54f6/networkDevices?page=1&pageSize=100&sort=name' \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    A page of network devices.

    -
    {}

    objects

    This section describes the operations you can perform on objects. Objects are +

    Authorizations:
    Bearer-Authentication
    path Parameters
    networkDeviceId
    required
    string
    Example: d9bf66bd-22f8-425b-82a4-44ba153d79c7

    The identifier of a network device.

    +

    Responses

    Request samples

    curl --request DELETE \
    +  --url https://metasys-server.example.com/api/v4/networkDevices/d9bf66bd-22f8-425b-82a4-44ba153d79c7 \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    List network device children

    Retrieves the collection of network devices that are children of the specified network device.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    networkDeviceId
    required
    string
    Example: d9bf66bd-22f8-425b-82a4-44ba153d79c7

    The identifier of a network device.

    +
    query Parameters
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    +
    pageSize
    integer [ 1 .. 1000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    +
    sort
    string
    Default: "name"
    Enum: "categoryId" "-categoryId" "firmwareVersion" "-firmwareVersion" "itemReference" "-itemReference" "name" "-name" "typeId" "-typeId"
    Example: sort=name

    The criteria to use when sorting results (see rules).

    +

    Responses

    Request samples

    curl --request GET \
    +  --url 'https://metasys-server.example.com/api/v4/networkDevices/d9bf66bd-22f8-425b-82a4-44ba153d79c7/networkDevices?page=1&pageSize=100&sort=name' \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    A page of network devices.

    +
    {}

    List network devices hosting an equipment instance

    Retrieves the collection of network devices that host the specified equipment instance, along with the parents of those network devices. A network device hosts an equipment when the equipment defines points that map to an attribute of any object contained on the network device.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    equipmentId
    required
    string
    Example: b78fa672-3ec9-4794-bd00-7aeafeb9cde0

    The identifier of the equipment instance.

    +
    query Parameters
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    +
    pageSize
    integer [ 1 .. 1000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    +
    sort
    string
    Default: "name"
    Enum: "categoryId" "-categoryId" "firmwareVersion" "-firmwareVersion" "itemReference" "-itemReference" "name" "-name" "typeId" "-typeId"
    Example: sort=name

    The criteria to use when sorting results (see rules).

    +

    Responses

    Request samples

    curl --request GET \
    +  --url 'https://metasys-server.example.com/api/v4/equipment/b78fa672-3ec9-4794-bd00-7aeafeb9cde0/networkDevices?page=1&pageSize=100&sort=name' \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    A page of network devices.

    +
    {}

    List network devices serving a space

    Retrieves the collection of network devices that serve the specified space. A space serves a network device when any equipment instance serving the space defines points that map to an attribute of any object contained on the network device.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    spaceId
    required
    string
    Example: bf254f63-2cbb-4195-8c53-a1d6fcbe54f6

    The identifier of a space.

    +
    query Parameters
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    +
    pageSize
    integer [ 1 .. 1000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    +
    sort
    string
    Default: "name"
    Enum: "categoryId" "-categoryId" "firmwareVersion" "-firmwareVersion" "itemReference" "-itemReference" "name" "-name" "typeId" "-typeId"
    Example: sort=name

    The criteria to use when sorting results (see rules).

    +

    Responses

    Request samples

    curl --request GET \
    +  --url 'https://metasys-server.example.com/api/v4/spaces/bf254f63-2cbb-4195-8c53-a1d6fcbe54f6/networkDevices?page=1&pageSize=100&sort=name' \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    A page of network devices.

    +
    {}

    objects

    This section describes the operations you can perform on objects. Objects are self-contained functional items in the Metasys system, for a full definition refer to the Metasys System Glossary. @@ -3795,31 +3418,79 @@

    Events

    -

    List objects

    Returns the root object of the tree and, optionally, its children. The root +

    List objects

    Returns the root object of the tree and, optionally, its children. The root object is the site object. The default response is a tree representation. Set flatten=true to flatten the tree into a list representation. The number of levels returned depends on the value of the depth parameter. To get just the root of the tree use a depth of 0. Values of depth greater than 1 are not allowed on this endpoint.

    -
    Authorizations:
    Bearer-Authentication
    query Parameters
    depth
    integer [ 0 .. 1 ]
    Default: 1
    Example: depth=1

    The depth of the tree to return. The provided value is ignored if pathTo, objectType, or classification are specified.

    -
    flatten
    boolean
    Default: false

    A value of true indicates the response payload should be a flat list. A value of false (the default) indicates the response payload should be a tree with child objects nested under their parent object. While this parameter influences the shape of the response, it does not affect the content. The same set of objects is returned no matter the value of this parameter.

    -
    includeExtensions
    boolean
    Default: false

    A value of true indicates that extension objects should be included in the +

    Authorizations:
    Bearer-Authentication
    query Parameters
    depth
    integer [ 0 .. 1 ]
    Default: 1
    Example: depth=1

    The depth of the tree to return. The provided value is ignored if pathTo, objectType, or classification are specified.

    +
    flatten
    boolean
    Default: false

    A value of true indicates the response payload should be a flat list. A value of false (the default) indicates the response payload should be a tree with child objects nested under their parent object. While this parameter influences the shape of the response, it does not affect the content. The same set of objects is returned no matter the value of this parameter.

    +
    includeExtensions
    boolean
    Default: false

    A value of true indicates that extension objects should be included in the result. A value of false (the default) indicates that they should not be included.

    This parameter is ignored if pathTo is specified.

    -
    pathTo
    string
    Example: pathTo=a5885077-9dba-5923-a6d8-ae4aabdc6f0a

    This parameter causes the response to contain the object specified by +

    pathTo
    string
    Example: pathTo=a5885077-9dba-5923-a6d8-ae4aabdc6f0a

    This parameter causes the response to contain the object specified by this parameter, the root object, and the objects in between.

    If this parameter is specified, then depth and includeExtensions are ignored.

    -
    includeEffectivePermissions
    boolean
    Default: false
    Example: includeEffectivePermissions=true

    Include the effectivePermissions property in the response payload. This +

    includeEffectivePermissions
    boolean
    Default: false
    Example: includeEffectivePermissions=true

    Include the effectivePermissions property in the response payload. This property describes which objects in the response the current user can view, modify or delete.

    -

    Responses

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v4/objects?depth=1&flatten=false&includeExtensions=false&pathTo=a5885077-9dba-5923-a6d8-ae4aabdc6f0a&includeEffectivePermissions=true' \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    Example

    The objects are returned in a tree structure. Child objects are nested under their parents.

    -
    {}

    Create object

    Creates a new object. Several things are needed to successfully create an +

    Responses

    Request samples

    curl --request GET \
    +  --url 'https://metasys-server.example.com/api/v4/objects?depth=1&flatten=false&includeExtensions=false&pathTo=a5885077-9dba-5923-a6d8-ae4aabdc6f0a&includeEffectivePermissions=true' \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    Example

    The objects are returned in a tree structure. Child objects are nested under their parents.

    +
    {}

    Create object

    Creates a new object. Several things are needed to successfully create an object. You must know

    -
    Authorizations:
    Bearer-Authentication
    Request Body schema: application/json
    parentId
    required
    string

    The ID of the parent object. The new object will be created under this +

    Authorizations:
    Bearer-Authentication
    Request Body schema: application/json
    required
    parentId
    required
    string

    The ID of the parent object. The new object will be created under this object.

    -
    localUniqueIdentifier
    required
    string <= 32 characters ^[^\x00-\x1F\x7F\x22#'*,.\/:<>?@\[\\\]|]+$

    A string that is locally unique within the context of the parent object +

    localUniqueIdentifier
    required
    string <= 32 characters ^[^\x00-\x1F\x7F\x22#'*,.\/:<>?@\[\\\]|]+$

    A string that is locally unique within the context of the parent object for identifying the new object. This string will be the last component of the itemReference of the newly created object. For example, assume you have a folder with an itemReference of adx:oas/Programming. Then you @@ -3856,42 +3538,94 @@

    Events

    adx:oas/Programming.ZN-3-T.

    The value must not contain any control characters or any of the following characters: " # ' * , . / : < > ? @ [ \ ] |

    -
    objectType
    required
    string
    metasysType: enum
    metasysEnum: objectTypeEnumSet

    The type of object to create.

    +
    objectType
    required
    string
    metasysType: enum
    metasysEnum: objectTypeEnumSet

    The type of object to create.

    The values for this property come from the objectTypeEnumSet enumeration. Find the definition of objectTypeEnumSet at the relative URL of /schemas/enums/objectTypeEnumSet.

    See also:

    -
    item
    object

    The item object is where you set the properties of the newly created +

    item
    object

    The item object is where you set the properties of the newly created object. Which properties can be set and their data types can be discovered by using the Get schema for object type operation.

    This property may or may not be required depending on the object you are creating. Some objects have defaults for all properties and require nothing to be set when creating them. Others have required properties that must be set at creation time.

    -

    Responses

    Request samples

    Content type
    application/json
    Example

    This request body creates a new object of type objectTypeEnumSet.avClass under a folder with an identifier of 82b6f2d5-6fed-5074-b611-94dd40028312 with a locally unique identifier of ZN-3-SETPT. The properties on the new object are name, description, objectCategory, minPresValue and maxPresValue.

    -
    {
    • "parentId": "82b6f2d5-6fed-5074-b611-94dd40028312",
    • "localUniqueIdentifier": "ZN-3-SETPT",
    • "objectType": "objectTypeEnumSet.avClass",
    • "item": {
      }
    }

    List child objects

    Returns the specified object and optionally one or more levels of the tree +

    Responses

    Request samples

    Content type
    application/json
    Example

    This request body creates a new object of type objectTypeEnumSet.avClass under a folder with an identifier of 82b6f2d5-6fed-5074-b611-94dd40028312 with a locally unique identifier of ZN-3-SETPT. The properties on the new object are name, description, objectCategory, minPresValue and maxPresValue.

    +
    {
    • "parentId": "82b6f2d5-6fed-5074-b611-94dd40028312",
    • "localUniqueIdentifier": "ZN-3-SETPT",
    • "objectType": "objectTypeEnumSet.avClass",
    • "item": {
      }
    }

    List child objects

    Returns the specified object and optionally one or more levels of the tree under the object. The default response is a tree representation. Set flatten=true to flatten the tree into a list representation.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    objectId
    required
    string
    Example: 767d8af0-163f-552c-ba37-a884466075f9

    Specifies the root of the subtree to return for this request. The objectId is the identifier of the object to retrieve (optionally along with 1 or more levels of descendants).

    -
    query Parameters
    depth
    integer >= -1
    Default: 1
    Example: depth=1

    The depth of the tree to return. For typical usage, a value or 1 or 2 is +

    Authorizations:
    Bearer-Authentication
    path Parameters
    objectId
    required
    string
    Example: 767d8af0-163f-552c-ba37-a884466075f9

    Specifies the root of the subtree to return for this request. The objectId is the identifier of the object to retrieve (optionally along with 1 or more levels of descendants).

    +
    query Parameters
    depth
    integer >= -1
    Default: 1
    Example: depth=1

    The depth of the tree to return. For typical usage, a value or 1 or 2 is recommended. Use -1 for maximum depth.

    The provided value is ignored if pathTo, objectType, or classification are specified.

    -
    flatten
    boolean
    Default: false

    A value of true indicates the response payload should be a flat list. A value of false (the default) indicates the response payload should be a tree with child objects nested under their parent object. While this parameter influences the shape of the response, it does not affect the content. The same set of objects is returned no matter the value of this parameter.

    -
    includeExtensions
    boolean
    Default: false

    A value of true indicates that extension objects should be included in the +

    flatten
    boolean
    Default: false

    A value of true indicates the response payload should be a flat list. A value of false (the default) indicates the response payload should be a tree with child objects nested under their parent object. While this parameter influences the shape of the response, it does not affect the content. The same set of objects is returned no matter the value of this parameter.

    +
    includeExtensions
    boolean
    Default: false

    A value of true indicates that extension objects should be included in the result. A value of false (the default) indicates that they should not be included.

    This parameter is ignored if pathTo is specified.

    -
    pathTo
    string
    Example: pathTo=a5885077-9dba-5923-a6d8-ae4aabdc6f0a

    This parameter filters the response down to just containing the object +

    pathTo
    string
    Example: pathTo=a5885077-9dba-5923-a6d8-ae4aabdc6f0a

    This parameter filters the response down to just containing the object specified by this parameter, the object specified by objectId in the path, and the objects in between.

    If this parameter is specified, then depth, includeExtensions, objectType and classification are ignored.

    -
    objectType
    string
    Examples:
    • objectType=objectTypeEnumSet.avClass - Analog Value Object Type
    • objectType=objectTypeEnumSet.bvClass - Binary Value Object Type
    • objectType=objectTypeEnumSet.mvClass - Multiple Value Object Type
    metasysType: enum
    metasysEnum: objectTypeEnumSet

    Type of objects to include in the response. This parameter may be +

    objectType
    string
    Examples:
    • objectType=objectTypeEnumSet.avClass - Analog Value Object Type
    • objectType=objectTypeEnumSet.bvClass - Binary Value Object Type
    • objectType=objectTypeEnumSet.mvClass - Multiple Value Object Type
    metasysType: enum
    metasysEnum: objectTypeEnumSet

    Type of objects to include in the response. This parameter may be repeated. To search for all AV and AI objects one would specify /objects?type=objectTypeEnumSet.avClass&type=objectTypeEnumSet.aiClass.

    The use of this parameter overrides depth to -1 and @@ -3908,28 +3642,57 @@

    Events

    -
    classification
    string
    Enum: "object" "device" "integration" "controller" "point" "site" "navList" "extension" "folder" "reference" "server" "archive"
    Examples:
    • classification=object - Any object not classified by one of the other classification values
    • classification=device - An object that represents a supervisory controller
    • classification=controller - An object that represents a field controller

    Filter objects to those with the specific classification. The use of this parameter overrides depth to -1 and includeExtensions to true. It is an error to specify this parameter if objectType is specified.

    -
    includeEffectivePermissions
    boolean
    Default: false
    Example: includeEffectivePermissions=true

    Include the effectivePermissions property in the response payload. This +

    classification
    string
    Enum: "object" "device" "integration" "controller" "point" "site" "navList" "extension" "folder" "reference" "server" "archive"
    Examples:
    • classification=object - Any object not classified by one of the other classification values
    • classification=device - An object that represents a supervisory controller
    • classification=controller - An object that represents a field controller

    Filter objects to those with the specific classification. The use of this parameter overrides depth to -1 and includeExtensions to true. It is an error to specify this parameter if objectType is specified.

    +
    includeEffectivePermissions
    boolean
    Default: false
    Example: includeEffectivePermissions=true

    Include the effectivePermissions property in the response payload. This property describes which objects in the response the current user can view, modify or delete.

    -

    Responses

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v4/objects/767d8af0-163f-552c-ba37-a884466075f9/objects?depth=1&flatten=false&includeExtensions=false&pathTo=a5885077-9dba-5923-a6d8-ae4aabdc6f0a&objectType=objectTypeEnumSet.avClass&classification=object&includeEffectivePermissions=true' \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    Example

    The objects are returned in a tree structure. Child objects are nested under their parents.

    -
    {}

    Get object id

    Finds the object identifier (the id property of an object) for the object with the specified fully qualified reference (fqr).

    -
    Authorizations:
    Bearer-Authentication
    query Parameters
    fqr
    required
    string
    Examples:
    • fqr=adx:adx - An example of a site director fqr
    • fqr=adx:nae23/Programming.AV1 - An example an analog value object fqr
    format: fully-qualified-reference

    The fully qualified reference of an object.

    +

    Responses

    Request samples

    curl --request GET \
    +  --url 'https://metasys-server.example.com/api/v4/objects/767d8af0-163f-552c-ba37-a884466075f9/objects?depth=1&flatten=false&includeExtensions=false&pathTo=a5885077-9dba-5923-a6d8-ae4aabdc6f0a&objectType=objectTypeEnumSet.avClass&classification=object&includeEffectivePermissions=true' \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    Example

    The objects are returned in a tree structure. Child objects are nested under their parents.

    +
    {}

    Get object id

    Finds the object identifier (the id property of an object) for the object with the specified fully qualified reference (fqr).

    +
    Authorizations:
    Bearer-Authentication
    query Parameters
    fqr
    required
    string
    Examples:
    • fqr=adx:adx - An example of a site director fqr
    • fqr=adx:nae23/Programming.AV1 - An example an analog value object fqr
    format: fully-qualified-reference

    The fully qualified reference of an object.

    Fully qualified references use characters that must be escaped when used as query parameters. Most HTTP libraries do this for you automatically. However, if you are using curl or PowerShell where you specify the full URL yourself you may need to be aware. For example, here is the URL to use with curl for a reference of oas:oas/Programming.AV3: https://{hostname}/api/v4/objectIdentifiers?fqr=oas%3Aoas%2FProgramming.AV3

    -

    Responses

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v4/objectIdentifiers?fqr=adx%3Aadx' \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    "32cfddc0-411f-5b9e-9a6d-442cb62fecbb"

    Get an object

    Objects support one or more views. By default, this operation gets the +

    Responses

    Request samples

    curl --request GET \
    +  --url 'https://metasys-server.example.com/api/v4/objectIdentifiers?fqr=adx%3Aadx' \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    "32cfddc0-411f-5b9e-9a6d-442cb62fecbb"

    Get an object

    Objects support one or more views. By default, this operation gets the default view of an object. For many objects this is the Focus View (identifier viewNameEnumSet.focusView). To see the list of views an object supports see List Views (/objects/{objectId}/views). To get a different @@ -3941,8 +3704,20 @@

    Events

  • List Views for information on retrieving the view collection of an object.
  • -
    Authorizations:
    Bearer-Authentication
    path Parameters
    objectId
    required
    string
    Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb

    The identifier of the object.

    -
    query Parameters
    viewId
    string
    Examples:
    • viewId=viewNameEnumSet.focusView - Focus View
    • viewId=viewNameEnumSet.diagnosticView - Diagnostic View
    metasysEnum: viewNameEnumSet

    The view to retrieve.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    objectId
    required
    string
    Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb

    The identifier of the object.

    +
    query Parameters
    viewId
    string
    Examples:
    • viewId=viewNameEnumSet.focusView - Focus View
    • viewId=viewNameEnumSet.diagnosticView - Diagnostic View
    metasysEnum: viewNameEnumSet

    The view to retrieve.

    This parameter is optional and if it is not specified the default view for the object will be returned. For many objects this is the Focus view (focusView).

    @@ -3953,19 +3728,49 @@

    Events

    -
    includeSchema
    boolean

    Every object can have a unique schema. Set this parameter to true to include the schema for this object in the response payload.

    -

    Responses

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v4/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb?viewId=viewNameEnumSet.focusView&includeSchema=false' \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    Example

    This is an example of an AV object without a schema. Notice that the +

    includeSchema
    boolean

    Every object can have a unique schema. Set this parameter to true to include the schema for this object in the response payload.

    +

    Responses

    Request samples

    curl --request GET \
    +  --url 'https://metasys-server.example.com/api/v4/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb?viewId=viewNameEnumSet.focusView&includeSchema=false' \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    Example

    This is an example of an AV object without a schema. Notice that the presentValue is 105 but the maxPresValue is set to 100. This results in the presentValue attribute going unreliable. This can be seen in the condition object where presentValue has a reliability value of reliabilityEnumSet.unreliableHigh. We can also see that the current priority for presentValue is set to writePriorityEnumSet.priorityCriticalEquipment.

    -
    {}

    Edit an object

    This operation modifies one or more attributes of an object. Note: +

    {}

    Edit an object

    This operation modifies one or more attributes of an object. Note: attributes must be updated in whole. For example, if you wish to modify an attribute of metasysType struct which is modelled as a JSON object you must include all elements of the struct. It is undefined what might happen @@ -3985,20 +3790,42 @@

    Events

  • List object views
  • List object attributes
  • -
    Authorizations:
    Bearer-Authentication
    path Parameters
    objectId
    required
    string
    Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb

    The identifier of the object.

    -
    Request Body schema: application/json
    item
    object

    The attributes to update.

    -

    Responses

    Request samples

    Content type
    application/json
    Example
    {
    • "item": {
      }
    }

    Delete an object

    Deletes the specified object.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    objectId
    required
    string
    Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb

    The identifier of the object.

    +
    Request Body schema: application/json
    required
    item
    object

    The attributes to update.

    +

    Responses

    Request samples

    Content type
    application/json
    Example
    {
    • "item": {
      }
    }

    Delete an object

    Deletes the specified object.

    Not all objects can be deleted (not even by an administrator). Examine the effectivePermissions of an object to determine if it can be deleted by the current user.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    objectId
    required
    string
    Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb

    The identifier of the object.

    -

    Responses

    Request samples

    curl --request DELETE \
    -  --url https:///%7Bhostname%7D/api/v4/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    List the views of an object

    Objects support one or more views. Each view of an object contains a logical +

    Authorizations:
    Bearer-Authentication
    path Parameters
    objectId
    required
    string
    Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb

    The identifier of the object.

    +

    Responses

    Request samples

    curl --request DELETE \
    +  --url https://metasys-server.example.com/api/v4/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    List the views of an object

    Objects support one or more views. Each view of an object contains a logical grouping of the object's attributes. This operation lists the collection of views that an object has.

    Each entry in the response contains the id of a view, and also the @@ -4009,13 +3836,26 @@

    Events

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    objectId
    required
    string
    Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb

    The identifier of the object.

    -
    query Parameters
    includeSchema
    boolean

    Set this parameter to true to include a schema in the response.

    -

    Responses

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v4/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/views?includeSchema=false' \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    Example

    List attributes of an object

    Returns an object payload with a JSON schema that contains all of the +

    Authorizations:
    Bearer-Authentication
    path Parameters
    objectId
    required
    string
    Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb

    The identifier of the object.

    +
    query Parameters
    includeSchema
    boolean

    Set this parameter to true to include a schema in the response.

    +

    Responses

    Request samples

    curl --request GET \
    +  --url 'https://metasys-server.example.com/api/v4/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/views?includeSchema=false' \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    Example

    List attributes of an object

    Returns an object payload with a JSON schema that contains all of the properties of the object. Each property entry contains only a partial schema for that property. (To discover the full schema of an attribute use /objects/{objectId}?includeSchema=true or @@ -4024,12 +3864,27 @@

    Events

    defaultAttribute. The item section will be completely missing if the object does not have a default attribute.

    There will be no views or condition sections like a typical object payload.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    objectId
    required
    string
    Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb

    The identifier of the object.

    -

    Responses

    Request samples

    curl --request GET \
    -  --url https:///%7Bhostname%7D/api/v4/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/attributes \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    Example
    {
    • "item": {
      },
    • "schema": {
      }
    }

    Get attribute value

    Returns an object payload containing the specified attribute. Invoke this +

    Authorizations:
    Bearer-Authentication
    path Parameters
    objectId
    required
    string
    Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb

    The identifier of the object.

    +

    Responses

    Request samples

    curl --request GET \
    +  --url https://metasys-server.example.com/api/v4/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/attributes \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    Example
    {
    • "item": {
      },
    • "schema": {
      }
    }

    Get attribute value

    Returns an object payload containing the specified attribute. Invoke this operation with a valid METASYS-SUBSCRIBE header to create a subscription for changes to that attribute, rather than returning a value. The current value and any updates to the attribute are instead sent over the specified @@ -4041,8 +3896,17 @@

    Events

  • Get a stream
  • Change of value subscriptions
  • -
    Authorizations:
    Bearer-Authentication
    path Parameters
    objectId
    required
    string
    Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb

    The identifier of the object.

    -
    attributeId
    required
    string
    Examples:
    • presentValue - The Present Value
    • itemReference - The Fully Qualified reference
    metasysEnum: attributeEnumSet

    The attribute to read.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    objectId
    required
    string
    Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb

    The identifier of the object.

    +
    attributeId
    required
    string
    Examples:
    • presentValue - The Present Value
    • itemReference - The Fully Qualified reference
    metasysEnum: attributeEnumSet

    The attribute to read.

    The acceptable values for this parameter come from the attributeEnumSet enumeration. Only the short name of the attribute (for example, presentValue instead of attributeEnumSet.presentValue) is accepted. Find the definition of attributeEnumSet at the relative URL of /schemas/enums/attributeEnumSet.

    @@ -4050,8 +3914,18 @@

    Events

    -
    query Parameters
    includeSchema
    boolean

    Set this parameter to true to include a schema in the response.

    -
    header Parameters
    METASYS-SUBSCRIBE
    string
    Example: 40e47e37-0f24-4101-8e1d-de96af4b648b

    If present, subscribes the client for streaming events associated with the +

    query Parameters
    includeSchema
    boolean

    Set this parameter to true to include a schema in the response.

    +
    header Parameters
    METASYS-SUBSCRIBE
    string
    Example: 40e47e37-0f24-4101-8e1d-de96af4b648b

    If present, subscribes the client for streaming events associated with the resource. The value of this header is a stream id obtained by opening a stream with Get a stream. The response will have a METASYS-SUBSCRIPTION-LOCATION header which identifies the created @@ -4060,8 +3934,17 @@

    Events

    -

    Responses

    Responses

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v4/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/attributes/presentValue?includeSchema=false' \
    +

    Request samples

    curl --request GET \
    +  --url 'https://metasys-server.example.com/api/v4/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/attributes/presentValue?includeSchema=false' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
    -  --header 'METASYS-SUBSCRIBE: 40e47e37-0f24-4101-8e1d-de96af4b648b'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    Example
    {
    • "item": {
      },
    • "condition": {
      },
    • "schema": {
      }
    }

    List commands

    Returns a payload that lists all of the commands that an object supports. + --header 'METASYS-SUBSCRIBE: 40e47e37-0f24-4101-8e1d-de96af4b648b'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    Example
    {
    • "item": {
      },
    • "condition": {
      },
    • "schema": {
      }
    }

    List commands

    Returns a payload that lists all of the commands that an object supports. Each command entry has an invokeUrl property, which is the URL needed to invoke the command. In addition, each command entry has a commandBodySchema property, which is a JSON schema that describes the @@ -4094,12 +3999,24 @@

    Events

    individual commands as the parameter to send.

    Licensing Restrictions

    Requires Monitoring and Commanding API license.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    objectId
    required
    string
    Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb

    The identifier of the object.

    -

    Responses

    Request samples

    curl --request GET \
    -  --url https:///%7Bhostname%7D/api/v4/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/commands \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    Example
    {
    • "items": [
      ],
    • "effectivePermissions": {
      }
    }

    Send command

    Used to send a command to an object. The payloads of commands differ, but +

    Authorizations:
    Bearer-Authentication
    path Parameters
    objectId
    required
    string
    Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb

    The identifier of the object.

    +

    Responses

    Request samples

    curl --request GET \
    +  --url https://metasys-server.example.com/api/v4/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/commands \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    Example
    {
    • "items": [
      ],
    • "effectivePermissions": {
      }
    }

    Send command

    Used to send a command to an object. The payloads of commands differ, but they share some similarities. To learn the specifics of the commands of an object use List commands.

    Licensing Restrictions

    @@ -4108,8 +4025,17 @@

    Events

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    objectId
    required
    string
    Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb

    The identifier of the object.

    -
    commandId
    required
    string
    Example: adjustCommand
    metasysEnum: commandIdEnumSet

    The identifier of the command to send.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    objectId
    required
    string
    Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb

    The identifier of the object.

    +
    commandId
    required
    string
    Example: adjustCommand
    metasysEnum: commandIdEnumSet

    The identifier of the command to send.

    The acceptable values for this parameter come from the commandIdEnumSet enumeration. It is acceptable to use the short name of the command identifier (for example, adjustCommand instead of commandIdEnumSet.adjustCommand) because the enumeration set is known from context. Find the definition of commandIdEnumSet at the relative URL of /schemas/enums/commandIdEnumSet.

    @@ -4117,36 +4043,78 @@

    Events

    -
    Request Body schema: application/json

    The body of a command is defined by the commandBodySchema. The +

    Request Body schema: application/json
    required

    The body of a command is defined by the commandBodySchema. The commandBodySchema is a property of every command returned by the List commands operation.

    -
    priority
    string (write-priority-enum-set)
    Enum: "writePriorityEnumSet.priorityNone" "writePriorityEnumSet.priorityManualEmergency" "writePriorityEnumSet.priorityFireApplications" "writePriorityEnumSet.priority3" "writePriorityEnumSet.priority4" "writePriorityEnumSet.priorityCriticalEquipment" "writePriorityEnumSet.priorityMinimumOnOff" "writePriorityEnumSet.priorityHeavyEquipDelay" "writePriorityEnumSet.priorityOperatorOverride" "writePriorityEnumSet.priority9" "writePriorityEnumSet.priority10" "writePriorityEnumSet.priorityDemandLimiting" "writePriorityEnumSet.priority12" "writePriorityEnumSet.priorityLoadRolling" "writePriorityEnumSet.priority14" "writePriorityEnumSet.prioritySchedulingOst" "writePriorityEnumSet.priorityDefault"
    metasysType: enum
    metasysEnum: writePriorityEnumSet
    parameters
    Array of any >= 0 items
    annotation
    string

    Responses

    Request samples

    Content type
    application/json
    Example

    This body is used with the adjust command of an Analog Value (AV). +

    priority
    string (write-priority-enum-set)
    Enum: "writePriorityEnumSet.priorityNone" "writePriorityEnumSet.priorityManualEmergency" "writePriorityEnumSet.priorityFireApplications" "writePriorityEnumSet.priority3" "writePriorityEnumSet.priority4" "writePriorityEnumSet.priorityCriticalEquipment" "writePriorityEnumSet.priorityMinimumOnOff" "writePriorityEnumSet.priorityHeavyEquipDelay" "writePriorityEnumSet.priorityOperatorOverride" "writePriorityEnumSet.priority9" "writePriorityEnumSet.priority10" "writePriorityEnumSet.priorityDemandLimiting" "writePriorityEnumSet.priority12" "writePriorityEnumSet.priorityLoadRolling" "writePriorityEnumSet.priority14" "writePriorityEnumSet.prioritySchedulingOst" "writePriorityEnumSet.priorityDefault"
    metasysType: enum
    metasysEnum: writePriorityEnumSet
    parameters
    Array of any >= 0 items
    annotation
    string

    Responses

    Request samples

    Content type
    application/json
    Example

    This body is used with the adjust command of an Analog Value (AV). It sends the value 72.5 along with an annotation about why the command was invoked. The URL for this command is /objects/{objectId}/commands/adjustCommand

    -
    {
    • "parameters": [
      ],
    • "annotation": "Increase the set point to make it warmer."
    }

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    "Success"

    List supported child types

    Many objects support nested objects. The obvious examples of this are +

    {
    • "parameters": [
      ],
    • "annotation": "Increase the set point to make it warmer."
    }

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    "Success"

    List supported child types

    Many objects support nested objects. The obvious examples of this are folder objects and device objects. Less obvious examples include objects like analog value and multi-state value objects (which can have child objects like integrations). This operation lists the types of objects that can be created under an object.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    objectId
    required
    string
    Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb

    The identifier of the object.

    -

    Responses

    Request samples

    curl --request GET \
    -  --url https:///%7Bhostname%7D/api/v4/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/supportedChildTypes \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    Example

    The supported child types of a folder.

    -
    [
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      }
    ]

    List object equipment points

    Retrieves all equipment points mapped to attributes of this object.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    objectId
    required
    string
    Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb

    The identifier of the object.

    -
    query Parameters
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    -
    pageSize
    integer [ 1 .. 1000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    -
    sort
    string
    Default: "shortName"
    Enum: "category" "-category" "equipmentName" "-equipmentName" "isDisplayData" "-isDisplayData" "shortName" "-shortName"
    Example: sort=shortName

    The criteria to use when sorting results (see rules).

    -

    Responses

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v4/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/points?page=1&pageSize=100&sort=shortName' \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    {}

    Batch operations

    This operation is used to invoke multiple operations in a single HTTP +

    Authorizations:
    Bearer-Authentication
    path Parameters
    objectId
    required
    string
    Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb

    The identifier of the object.

    +

    Responses

    Request samples

    curl --request GET \
    +  --url https://metasys-server.example.com/api/v4/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/supportedChildTypes \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    Example

    The supported child types of a folder.

    +
    [
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      }
    ]

    List object equipment points

    Retrieves all equipment points mapped to attributes of this object.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    objectId
    required
    string
    Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb

    The identifier of the object.

    +
    query Parameters
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    +
    pageSize
    integer [ 1 .. 1000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    +
    sort
    string
    Default: "shortName"
    Enum: "category" "-category" "equipmentName" "-equipmentName" "isDisplayData" "-isDisplayData" "shortName" "-shortName"
    Example: sort=shortName

    The criteria to use when sorting results (see rules).

    +

    Responses

    Request samples

    curl --request GET \
    +  --url 'https://metasys-server.example.com/api/v4/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/points?page=1&pageSize=100&sort=shortName' \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    {}

    Batch operations

    This operation is used to invoke multiple operations in a single HTTP request. Often a batch request is more efficient than sending each individual operation in its own HTTP request.

    In this version of the API, the only objects related operation that can be @@ -4163,7 +4131,16 @@

    Events

  • Get a stream
  • Change of value subscriptions
  • -
    Authorizations:
    Bearer-Authentication
    header Parameters
    METASYS-SUBSCRIBE
    string
    Example: 40e47e37-0f24-4101-8e1d-de96af4b648b

    If present, subscribes the client for streaming events associated with the +

    Authorizations:
    Bearer-Authentication
    header Parameters
    METASYS-SUBSCRIBE
    string
    Example: 40e47e37-0f24-4101-8e1d-de96af4b648b

    If present, subscribes the client for streaming events associated with the resource. The value of this header is a stream id obtained by opening a stream with Get a stream. The response will have a METASYS-SUBSCRIPTION-LOCATION header which identifies the created @@ -4172,33 +4149,66 @@

    Events

    -
    Request Body schema: application/json
    method
    required
    string
    Value: "GET"

    The HTTP method to use for each request. This property is restricted to GET for this version of the API since Get attribute value is the only operation supported in a batch.

    -
    required
    Array of objects non-empty

    A collection of entries that represent the operations to invoke.

    -

    Responses

    Request samples

    Content type
    application/json

    This example shows a request body that will read the +

    Request Body schema: application/json
    required
    method
    required
    string
    Value: "GET"

    The HTTP method to use for each request. This property is restricted to GET for this version of the API since Get attribute value is the only operation supported in a batch.

    +
    required
    Array of objects non-empty

    A collection of entries that represent the operations to invoke.

    +

    Responses

    Request samples

    Content type
    application/json

    This example shows a request body that will read the presentValue and status from 3 different objects using sequential numbers as request identifiers.

    This example shows the use of sequential numeric values used as request identifiers but any unique strings can be used.

    -
    {
    • "method": "GET",
    • "requests": [
      ]
    }

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    Example

    This example shows the response to a read multiple attributes +

    {
    • "method": "GET",
    • "requests": [
      ]
    }

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    Example

    This example shows the response to a read multiple attributes request. Each operation response is uniquely identified by the corresponding identifier (id) from the request.

    -
    {
    • "responses": [
      ]
    }

    Delete object subscription

    Delete a subscription to a resource in the objects domain.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    streamId
    required
    string
    Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb

    The stream identifier that contains the subscription. This is the unique +

    {
    • "responses": [
      ]
    }

    Delete object subscription

    Delete a subscription to a resource in the objects domain.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    streamId
    required
    string
    Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb

    The stream identifier that contains the subscription. This is the unique identifier for the client's stream obtained via GET /stream.

    -
    subscriptionId
    required
    string
    Example: 626e5ac3-506d-4017-bb8f-973f1c54ddb5

    The identifier of the subscription to act upon. This is the unique +

    subscriptionId
    required
    string
    Example: 626e5ac3-506d-4017-bb8f-973f1c54ddb5

    The identifier of the subscription to act upon. This is the unique identifier to the subscription for a specific resource or type of event. This value is found as the last parameter of a METASYS-SUBSCRIPTION-LOCATION header returned for the original subscription request.

    -

    Responses

    Request samples

    curl --request DELETE \
    -  --url https:///%7Bhostname%7D/api/v4/objects/streams/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/subscriptions/626e5ac3-506d-4017-bb8f-973f1c54ddb5 \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    schemas

    A collection of JSON schemas for describing enumerations and object types.

    -

    Get enumeration

    This operation retrieves the specified enumeration as a JSON schema. The +

    Responses

    Request samples

    curl --request DELETE \
    +  --url https://metasys-server.example.com/api/v4/objects/streams/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/subscriptions/626e5ac3-506d-4017-bb8f-973f1c54ddb5 \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    schemas

    A collection of JSON schemas for describing enumerations and object types.

    +

    Get enumeration

    This operation retrieves the specified enumeration as a JSON schema. The path of this operation appears in several schemas of object payloads.

    To get a list of all enumerations fetch the enumerationSetNamesEnumSet:

    GET /schemas/enums/enumerationSetNamesEnumSet
    @@ -4207,7 +4217,15 @@ 

    Events

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    enumId
    required
    string
    Examples:
    • writePriorityEnumSet - The write priority enumeration
    • displayPrecisionEnumSet - The display precision enumeration
    • enumerationSetNamesEnumSet - The set of all sets
    metasysType: enum

    The enumeration to retrieve.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    enumId
    required
    string
    Examples:
    • writePriorityEnumSet - The write priority enumeration
    • displayPrecisionEnumSet - The display precision enumeration
    • enumerationSetNamesEnumSet - The set of all sets
    metasysType: enum

    The enumeration to retrieve.

    The acceptable values for this parameter come from the enumerationSetNamesEnumSet enumeration. It is acceptable to use the short name of the value (for example, writePriorityEnumSet instead of @@ -4215,14 +4233,27 @@

    Events

    enumeration set is known from context. Find the definition of enumerationSetNamesEnumSet at the relative URL of /schemas/enums/enumerationSetNamesEnumSet.

    -

    Responses

    Request samples

    curl --request GET \
    -  --url https:///%7Bhostname%7D/api/v4/schemas/enums/writePriorityEnumSet \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    Example
    {
    • "title": "Write Priority",
    • "setId": 1,
    • "oneOf": [
      ]
    }

    Get object type schema

    This endpoint retrieves a schema for a specific objectType. The schema +

    Responses

    Request samples

    curl --request GET \
    +  --url https://metasys-server.example.com/api/v4/schemas/enums/writePriorityEnumSet \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    Example
    {
    • "title": "Write Priority",
    • "setId": 1,
    • "oneOf": [
      ]
    }

    Get object type schema

    This endpoint retrieves a schema for a specific objectType. The schema describes the properties that can be set when creating an object of the specific type.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    objectType
    required
    string
    Examples:
    • objectTypeEnumSet.avClass - AV
    • objectTypeEnumSet.bvClass - BV
    • objectTypeEnumSet.mvClass - MV
    metasysEnum: objectTypeEnumSet

    The type of object

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    objectType
    required
    string
    Examples:
    • objectTypeEnumSet.avClass - AV
    • objectTypeEnumSet.bvClass - BV
    • objectTypeEnumSet.mvClass - MV
    metasysEnum: objectTypeEnumSet

    The type of object

    The acceptable values for this parameter come from the objectTypeEnumSet enumeration. It is acceptable to use the short name of the object type (for example, avClass instead of objectTypeEnumSet.avClass) because the enumeration set is known from context. Find the definition of objectTypeEnumSet at the relative URL of /schemas/enums/objectTypeEnumSet.

    @@ -4230,8 +4261,19 @@

    Events

    -
    query Parameters
    parentId
    required
    string
    Example: parentId=2993aed9-5765-5641-889c-40ec968c8a82

    The object under which this new object will be created.

    -
    extendedProperty
    string
    Examples:
    • extendedProperty=attributeEnumSet.presentValue - Present Value
    • extendedProperty=attributeEnumSet.reliability - Reliability
    metasysEnum: attributeEnumSet

    The attribute to extend.

    +
    query Parameters
    parentId
    required
    string
    Example: parentId=2993aed9-5765-5641-889c-40ec968c8a82

    The object under which this new object will be created.

    +
    extendedProperty
    string
    Examples:
    • extendedProperty=attributeEnumSet.presentValue - Present Value
    • extendedProperty=attributeEnumSet.reliability - Reliability
    metasysEnum: attributeEnumSet

    The attribute to extend.

    Indicates which attribute of the parent object the extension should be linked to. Used only for extension objects (like alarm extensions).

    The acceptable values for this parameter come from the attributeEnumSet enumeration. @@ -4241,34 +4283,63 @@

    Events

    -

    Responses

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v4/schemas/objectTypes/objectTypeEnumSet.avClass?parentId=2993aed9-5765-5641-889c-40ec968c8a82&extendedProperty=attributeEnumSet.presentValue' \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    Example

    This schema describes the properties that can be configured when creating an object of the type avClass.

    -
    {
    • "schema": {
      },
    • "views": [
      ]
    }

    spaces

    Operations on space-related resources.

    -

    Get spaces served by a network device

    Retrieves the collection of spaces served by the specified network device. A space is served by a network device when any equipment instance serving the space defines points that map to an attribute of any object contained on the network device.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    networkDeviceId
    required
    string
    Example: d9bf66bd-22f8-425b-82a4-44ba153d79c7

    The identifier of a network device.

    -
    query Parameters
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    -
    pageSize
    integer [ 1 .. 1000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    -
    sort
    string
    Default: "name"
    Enum: "itemReference" "-itemReference" "name" "-name" "typeId" "-typeId"
    Example: sort=name

    The criteria to use when sorting results (see rules).

    -

    Responses

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v4/networkDevices/d9bf66bd-22f8-425b-82a4-44ba153d79c7/spaces?page=1&pageSize=100&sort=name' \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    A page of spaces.

    -
    {}

    Get spaces served by an equipment instance

    Retrieves the collection of spaces served by the specified equipment instance.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    equipmentId
    required
    string
    Example: b78fa672-3ec9-4794-bd00-7aeafeb9cde0

    The identifier of the equipment instance.

    -
    query Parameters
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    -
    pageSize
    integer [ 1 .. 1000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    -
    sort
    string
    Default: "name"
    Enum: "itemReference" "-itemReference" "name" "-name" "typeId" "-typeId"
    Example: sort=name

    The criteria to use when sorting results (see rules).

    -

    Responses

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v4/equipment/b78fa672-3ec9-4794-bd00-7aeafeb9cde0/spaces?page=1&pageSize=100&sort=name' \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    A page of spaces.

    -
    {}

    Get spaces

    Retrieves a collection of spaces.

    -
    Authorizations:
    Bearer-Authentication
    query Parameters
    type
    string
    Example: type=spaceTypesEnumSet.building
    metasysType: enum
    metasysEnum: spaceTypesEnumSet

    Type of space to return.

    +

    Responses

    Request samples

    curl --request GET \
    +  --url 'https://metasys-server.example.com/api/v4/schemas/objectTypes/objectTypeEnumSet.avClass?parentId=2993aed9-5765-5641-889c-40ec968c8a82&extendedProperty=attributeEnumSet.presentValue' \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    Example

    This schema describes the properties that can be configured when creating an object of the type avClass.

    +
    {
    • "schema": {
      },
    • "views": [
      ]
    }

    spaces

    Operations on space-related resources.

    +

    Get spaces served by a network device

    Retrieves the collection of spaces served by the specified network device. A space is served by a network device when any equipment instance serving the space defines points that map to an attribute of any object contained on the network device.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    networkDeviceId
    required
    string
    Example: d9bf66bd-22f8-425b-82a4-44ba153d79c7

    The identifier of a network device.

    +
    query Parameters
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    +
    pageSize
    integer [ 1 .. 1000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    +
    sort
    string
    Default: "name"
    Enum: "itemReference" "-itemReference" "name" "-name" "typeId" "-typeId"
    Example: sort=name

    The criteria to use when sorting results (see rules).

    +

    Responses

    Request samples

    curl --request GET \
    +  --url 'https://metasys-server.example.com/api/v4/networkDevices/d9bf66bd-22f8-425b-82a4-44ba153d79c7/spaces?page=1&pageSize=100&sort=name' \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    A page of spaces.

    +
    {}

    Get spaces served by an equipment instance

    Retrieves the collection of spaces served by the specified equipment instance.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    equipmentId
    required
    string
    Example: b78fa672-3ec9-4794-bd00-7aeafeb9cde0

    The identifier of the equipment instance.

    +
    query Parameters
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    +
    pageSize
    integer [ 1 .. 1000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    +
    sort
    string
    Default: "name"
    Enum: "itemReference" "-itemReference" "name" "-name" "typeId" "-typeId"
    Example: sort=name

    The criteria to use when sorting results (see rules).

    +

    Responses

    Request samples

    curl --request GET \
    +  --url 'https://metasys-server.example.com/api/v4/equipment/b78fa672-3ec9-4794-bd00-7aeafeb9cde0/spaces?page=1&pageSize=100&sort=name' \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    A page of spaces.

    +
    {}

    Get spaces

    Retrieves a collection of spaces.

    +
    Authorizations:
    Bearer-Authentication
    query Parameters
    type
    string
    Example: type=spaceTypesEnumSet.building
    metasysType: enum
    metasysEnum: spaceTypesEnumSet

    Type of space to return.

    The acceptable values for this parameter come from the spaceTypesEnumSet enumeration. Only the long name of the space type (for example, spaceTypesEnumSet.building instead of building) is accepted. Find the definition of spaceTypesEnumSet at the relative URL of /schemas/enums/spaceTypesEnumSet.

    @@ -4276,32 +4347,92 @@

    Events

    -
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    -
    pageSize
    integer [ 1 .. 1000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    -
    sort
    string
    Default: "name"
    Enum: "itemReference" "-itemReference" "name" "-name" "typeId" "-typeId"
    Example: sort=name

    The criteria to use when sorting results (see rules).

    -

    Responses

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v4/spaces?type=spaceTypesEnumSet.building&page=1&pageSize=100&sort=name' \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    A page of spaces.

    -
    {}

    Get a single space

    Retrieves the specified space.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    spaceId
    required
    string
    Example: bf254f63-2cbb-4195-8c53-a1d6fcbe54f6

    The identifier of a space.

    -

    Responses

    Request samples

    curl --request GET \
    -  --url https:///%7Bhostname%7D/api/v4/spaces/bf254f63-2cbb-4195-8c53-a1d6fcbe54f6 \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    A page of spaces.

    -
    {}

    Get space children

    Retrieves the collection of spaces that are located within the specified space.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    spaceId
    required
    string
    Example: bf254f63-2cbb-4195-8c53-a1d6fcbe54f6

    The identifier of a space.

    -
    query Parameters
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    -
    pageSize
    integer [ 1 .. 1000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    -
    sort
    string
    Default: "name"
    Enum: "itemReference" "-itemReference" "name" "-name" "typeId" "-typeId"
    Example: sort=name

    The criteria to use when sorting results (see rules).

    -

    Responses

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v4/spaces/bf254f63-2cbb-4195-8c53-a1d6fcbe54f6/spaces?page=1&pageSize=100&sort=name' \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    A page of spaces.

    -

    streaming

    Your Metasys system works continuously: sensors report current conditions, +

    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    +
    pageSize
    integer [ 1 .. 1000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    +
    sort
    string
    Default: "name"
    Enum: "itemReference" "-itemReference" "name" "-name" "typeId" "-typeId"
    Example: sort=name

    The criteria to use when sorting results (see rules).

    +

    Responses

    Request samples

    curl --request GET \
    +  --url 'https://metasys-server.example.com/api/v4/spaces?type=spaceTypesEnumSet.building&page=1&pageSize=100&sort=name' \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    A page of spaces.

    +
    {}

    Get a single space

    Retrieves the specified space.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    spaceId
    required
    string
    Example: bf254f63-2cbb-4195-8c53-a1d6fcbe54f6

    The identifier of a space.

    +

    Responses

    Request samples

    curl --request GET \
    +  --url https://metasys-server.example.com/api/v4/spaces/bf254f63-2cbb-4195-8c53-a1d6fcbe54f6 \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    A page of spaces.

    +
    {}

    Get space children

    Retrieves the collection of spaces that are located within the specified space.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    spaceId
    required
    string
    Example: bf254f63-2cbb-4195-8c53-a1d6fcbe54f6

    The identifier of a space.

    +
    query Parameters
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    +
    pageSize
    integer [ 1 .. 1000 ]
    Default: 100
    Example: pageSize=100

    The maximum number of items to return in the response.

    +
    sort
    string
    Default: "name"
    Enum: "itemReference" "-itemReference" "name" "-name" "typeId" "-typeId"
    Example: sort=name

    The criteria to use when sorting results (see rules).

    +

    Responses

    Request samples

    curl --request GET \
    +  --url 'https://metasys-server.example.com/api/v4/spaces/bf254f63-2cbb-4195-8c53-a1d6fcbe54f6/spaces?page=1&pageSize=100&sort=name' \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json

    A page of spaces.

    +

    streaming

    Your Metasys system works continuously: sensors report current conditions, algorithms make adjustments, and alarms alert operators to potential issues. Streaming is how the Metasys API provides access to these events using the HTML standard @@ -4342,7 +4473,22 @@

    Events

    event: hello\n data: b6d184ee-e137-44aa-b9b1-14bc704cd25d\n\n -

    Getting Started

    To get started, you first need a client. There are SSE clients available in many +

    Getting Started

    To get started, you first need a client. There are SSE clients available in many languages.

    Begin by getting a stream. Only one stream is needed regardless of the number of subscriptions you later create. As explained in the @@ -4357,7 +4503,98 @@

    Events

    operation's description to understand its Streaming capability.

    Not all event data is currently exposed by Streaming. Future versions of the API will add further Streaming capabilities.

    -

    Streaming Connection Maintenance

    There are a few behaviors to be aware of if you want your stream to work beyond +

    Streaming Connection Maintenance

    There are a few behaviors to be aware of if you want your stream to work beyond the lifetime of the access token used to get your stream.

    Keep Events Flowing After Initial Access Token Expiration

    @@ -4401,11 +4638,14 @@

    Reco
    const eventSourceOptions = {
       headers: {
    -    Authorization = `Bearer ${accessToken}`
    -  }
    +    Authorization: `Bearer ${accessToken}`,
    +  },
     };
     
    -const eventSource = new $window.EventSourcePolyfill(streamingUrl, eventSourceOptions);
    +const eventSource = new $window.EventSourcePolyfill(
    +  streamingUrl,
    +  eventSourceOptions
    +);
     

    Before token expiration:

      @@ -4445,7 +4685,26 @@

      C# - LaunchDarkly EventSource

      the EventSource and then create a new instance, passing the the LastEventId from the last message and the URL to get a stream with a current access token embedded as a query string parameter.

      -

    Streaming Events

    The following are types of events sent by Streaming along with example data +

    Streaming Events

    The following are types of events sent by Streaming along with example data payloads for each:

    • hello - Indicates Streaming connection was successful.

      @@ -4464,9 +4723,32 @@

      C# - LaunchDarkly EventSource

    -

    Get a stream

    Opens or reconnects a Server Sent Event stream which is a prerequisite for subscribing to any dynamic updates

    -
    Authorizations:
    Bearer-AuthenticationAPI-Key-Authentication
    header Parameters
    Last-Event-Id
    string
    Example: b6d184ee-e137-44aa-b9b1-14bc704cd25d:5

    Providing the ID of the last event received enables a briefly broken stream to be resumed

    -

    Responses

    Get a stream

    Opens or reconnects a Server Sent Event stream which is a prerequisite for subscribing to any dynamic updates

    +
    Authorizations:
    Bearer-AuthenticationAPI-Key-Authentication
    header Parameters
    Last-Event-Id
    string
    Example: b6d184ee-e137-44aa-b9b1-14bc704cd25d:5

    Providing the ID of the last event received enables a briefly broken stream to be resumed

    +

    Responses

    Request samples

    curl --request GET \
    -  --url https:///%7Bhostname%7D/api/v4/stream \
    +

    Request samples

    curl --request GET \
    +  --url https://metasys-server.example.com/api/v4/stream \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
    -  --header 'Last-Event-Id: b6d184ee-e137-44aa-b9b1-14bc704cd25d:5'

    time series

    Operations to retrieve time series data.

    + --header 'Last-Event-Id: b6d184ee-e137-44aa-b9b1-14bc704cd25d:5'

    time series

    Operations to retrieve time series data.

    Time series data is located in two places: in buffers on devices and in an historical data repository (if your site has a repository).

    The buffers typically have relatively recent samples while the repository @@ -4512,19 +4816,37 @@

    C# - LaunchDarkly EventSource

    retrieve any historical data that is in the repository regardless of whether the associated object still exists or not. They never retrieve any samples from device buffers.

    -

    Get object attributes with samples

    Retrieves a collection of attributes under the specified object for which samples are available.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    objectId
    required
    string
    Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb

    The identifier of the object.

    -

    Responses

    Request samples

    curl --request GET \
    -  --url https:///%7Bhostname%7D/api/v4/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/trendedAttributes \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Get samples for an object attribute

    Retrieves a collection of samples for the specified object attribute +

    Get object attributes with samples

    Retrieves a collection of attributes under the specified object for which samples are available.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    objectId
    required
    string
    Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb

    The identifier of the object.

    +

    Responses

    Request samples

    curl --request GET \
    +  --url https://metasys-server.example.com/api/v4/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/trendedAttributes \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Get samples for an object attribute

    Retrieves a collection of samples for the specified object attribute during a particular date and time range.

    Note: The parent endpoint /objects/{objectId}/trendedAttributes/{attributeId} is not currently supported.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    objectId
    required
    string
    Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb

    The identifier of the object.

    -
    attributeId
    required
    string
    Example: presentValue
    metasysType: enum
    metasysEnum: attributeEnumSet

    The identifier of the attribute.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    objectId
    required
    string
    Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb

    The identifier of the object.

    +
    attributeId
    required
    string
    Example: presentValue
    metasysType: enum
    metasysEnum: attributeEnumSet

    The identifier of the attribute.

    The acceptable values for this parameter come from the attributeEnumSet enumeration. It is acceptable to use the short name of the attribute (for example, presentValue instead of attributeEnumSet.presentValue) because the enumeration set is known from context. Find the definition of attributeEnumSet at the relative URL of /schemas/enums/attributeEnumSet.

    @@ -4532,29 +4854,55 @@

    C# - LaunchDarkly EventSource

    -
    query Parameters
    startTime
    string <date-time>
    Example: startTime=2018-05-21T13:58:20.243Z

    Only include results generated on or after this date-time.

    -
    endTime
    string <date-time>
    Example: endTime=2018-05-21T13:58:20.243Z

    Only include results generated on or before this date-time.

    -
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    -
    pageSize
    integer [ 1 .. 10000 ]
    Default: 1000
    Example: pageSize=1000

    The maximum number of items to return in the response.

    -
    sort
    string
    Default: "timestamp"
    Enum: "timestamp" "-timestamp"
    Example: sort=timestamp

    The criteria to use when sorting results (see rules).

    -

    Responses

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v4/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/trendedAttributes/presentValue/samples?startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&page=1&pageSize=1000&sort=timestamp' \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    Example

    Single page get samples response containing only analog values.

    -

    Get network device attributes with samples

    Retrieves a collection of attributes under the specified network device for which samples are available.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    id
    required
    string
    Example: 6b092d2e-c795-4e90-95e8-5acafc74f19d

    The identifier of the network device.

    -

    Responses

    Request samples

    curl --request GET \
    -  --url https:///%7Bhostname%7D/api/v4/networkDevices/6b092d2e-c795-4e90-95e8-5acafc74f19d/trendedAttributes \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Get samples for a network device attribute

    Retrieves a collection of samples for the specified network device +

    query Parameters
    startTime
    string <date-time>
    Example: startTime=2018-05-21T13:58:20.243Z

    Only include results generated on or after this date-time.

    +
    endTime
    string <date-time>
    Example: endTime=2018-05-21T13:58:20.243Z

    Only include results generated on or before this date-time.

    +
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    +
    pageSize
    integer [ 1 .. 10000 ]
    Default: 1000
    Example: pageSize=1000

    The maximum number of items to return in the response.

    +
    sort
    string
    Default: "timestamp"
    Enum: "timestamp" "-timestamp"
    Example: sort=timestamp

    The criteria to use when sorting results (see rules).

    +

    Responses

    Request samples

    curl --request GET \
    +  --url 'https://metasys-server.example.com/api/v4/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/trendedAttributes/presentValue/samples?startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&page=1&pageSize=1000&sort=timestamp' \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    Example

    Single page get samples response containing only analog values.

    +

    Get network device attributes with samples

    Retrieves a collection of attributes under the specified network device for which samples are available.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    id
    required
    string
    Example: 6b092d2e-c795-4e90-95e8-5acafc74f19d

    The identifier of the network device.

    +

    Responses

    Request samples

    curl --request GET \
    +  --url https://metasys-server.example.com/api/v4/networkDevices/6b092d2e-c795-4e90-95e8-5acafc74f19d/trendedAttributes \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Get samples for a network device attribute

    Retrieves a collection of samples for the specified network device attribute during a particular date and time range.

    Note: The parent endpoint /networkDevices/{id}/trendedAttributes/{attributeId} is not currently supported.

    -
    Authorizations:
    Bearer-Authentication
    path Parameters
    id
    required
    string
    Example: c550095d-ee4c-4314-b415-b0577e383ee9

    The identifier of the network device.

    -
    attributeId
    required
    string
    Example: presentValue
    metasysType: enum
    metasysEnum: attributeEnumSet

    The identifier of the attribute.

    +
    Authorizations:
    Bearer-Authentication
    path Parameters
    id
    required
    string
    Example: c550095d-ee4c-4314-b415-b0577e383ee9

    The identifier of the network device.

    +
    attributeId
    required
    string
    Example: presentValue
    metasysType: enum
    metasysEnum: attributeEnumSet

    The identifier of the attribute.

    The acceptable values for this parameter come from the attributeEnumSet enumeration. It is acceptable to use the short name of the attribute (for example, presentValue instead of attributeEnumSet.presentValue) because the enumeration set is known from context. Find the definition of attributeEnumSet at the relative URL of /schemas/enums/attributeEnumSet.

    @@ -4562,24 +4910,32 @@

    C# - LaunchDarkly EventSource

    -
    query Parameters
    startTime
    string <date-time>
    Example: startTime=2018-05-21T13:58:20.243Z

    Only include results generated on or after this date-time.

    -
    endTime
    string <date-time>
    Example: endTime=2018-05-21T13:58:20.243Z

    Only include results generated on or before this date-time.

    -
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    -
    pageSize
    integer [ 1 .. 10000 ]
    Default: 1000
    Example: pageSize=1000

    The maximum number of items to return in the response.

    -
    sort
    string
    Default: "timestamp"
    Enum: "timestamp" "-timestamp"
    Example: sort=timestamp

    The criteria to use when sorting results (see rules).

    -

    Responses

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v4/networkDevices/c550095d-ee4c-4314-b415-b0577e383ee9/trendedAttributes/presentValue/samples?startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&page=1&pageSize=1000&sort=timestamp' \
    -  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    Example

    Single page get samples response containing only analog values.

    -
    - +
    query Parameters
    startTime
    string <date-time>
    Example: startTime=2018-05-21T13:58:20.243Z

    Only include results generated on or after this date-time.

    +
    endTime
    string <date-time>
    Example: endTime=2018-05-21T13:58:20.243Z

    Only include results generated on or before this date-time.

    +
    page
    integer >= 1
    Default: 1
    Example: page=1

    The page number of items to return.

    +
    pageSize
    integer [ 1 .. 10000 ]
    Default: 1000
    Example: pageSize=1000

    The maximum number of items to return in the response.

    +
    sort
    string
    Default: "timestamp"
    Enum: "timestamp" "-timestamp"
    Example: sort=timestamp

    The criteria to use when sorting results (see rules).

    +

    Responses

    Request samples

    curl --request GET \
    +  --url 'https://metasys-server.example.com/api/v4/networkDevices/c550095d-ee4c-4314-b415-b0577e383ee9/trendedAttributes/presentValue/samples?startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&page=1&pageSize=1000&sort=timestamp' \
    +  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v4+json
    Example

    Single page get samples response containing only analog values.

    +
    + - \ No newline at end of file + diff --git a/api/v5.html b/api/v5.html index 8b0d92e..c56e9f2 100644 --- a/api/v5.html +++ b/api/v5.html @@ -431,7 +431,7 @@ -

    Metasys REST API (5.369)

    Download OpenAPI specification:Download

    Introduction

    Metasys REST API (5.370)

    Download OpenAPI specification:Download

    Introduction

    The Metasys REST API is the exposed interface for accessing data from a Johnson Controls® Metasys system. This spec documents v5 of the API first released as part of Metasys 13.0. This documentation was last -updated on January 2, 2024 at 8:43 PM (UTC).

    +updated on June 25, 2024 at 2:12 PM (UTC).

    Note
    The Metasys REST API is only supported on the following Metasys products: ADS, ADX, and OAS. The REST API is not supported on Metasys for Validated Environments @@ -2074,7 +2074,7 @@

    Filter Behavior

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v5/activities?activityType=alarm&includeDiscarded=false&continuationToken=eyJhdWRpdCI6eyJpZCI6IjgOTQ2NjUzLTlmM...&sort=creationTime&startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&equipment=b7ed8b3e-cb95-410d-aaa7-37158852c398&object=06d77c63-6357-467a-a306-5e1ab3eb3aa7&space=214f52d1-0c56-4a29-a690-abe5656d1647&priorityRange=0%2C255&type=alarmValueEnumSet.avHighLimit&includeAcknowledged=false&includeAcknowledgementRequired=true&includeAcknowledgementNotRequired=true&category=objectCategoryEnumSet.hvacCategory&originApplication=auditOriginAppEnumSet.deviceManagerAuditOriginApp&classLevel=auditClassesEnumSet.userActionAuditClass&actionType=auditActionTypeEnumSet.writeAuditActionType&user=metasysuser' \
    +  --url 'https://metasys-server.example.com/api/v5/activities?activityType=alarm&includeDiscarded=false&continuationToken=eyJhdWRpdCI6eyJpZCI6IjgOTQ2NjUzLTlmM...&sort=creationTime&startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&equipment=b7ed8b3e-cb95-410d-aaa7-37158852c398&object=06d77c63-6357-467a-a306-5e1ab3eb3aa7&space=214f52d1-0c56-4a29-a690-abe5656d1647&priorityRange=0%2C255&type=alarmValueEnumSet.avHighLimit&includeAcknowledged=false&includeAcknowledgementRequired=true&includeAcknowledgementNotRequired=true&category=objectCategoryEnumSet.hvacCategory&originApplication=auditOriginAppEnumSet.deviceManagerAuditOriginApp&classLevel=auditClassesEnumSet.userActionAuditClass&actionType=auditActionTypeEnumSet.writeAuditActionType&user=metasysuser' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
       --header 'METASYS-SUBSCRIBE: 40e47e37-0f24-4101-8e1d-de96af4b648b'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json
    {}

    Batch operations

    Filter Behavior

    Request samples

    curl --request DELETE \
    -  --url https:///%7Bhostname%7D/api/v5/activities/streams/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/subscriptions/626e5ac3-506d-4017-bb8f-973f1c54ddb5 \
    +  --url https://metasys-server.example.com/api/v5/activities/streams/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/subscriptions/626e5ac3-506d-4017-bb8f-973f1c54ddb5 \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    alarms

    Alarms alert users to potential problems identified by a Metasys system, for example high zone temperatures. Use alarms operations to get object alarms, network device alarms, single alarms, alarm collections, and alarm annotations. Acknowledge or discard alarms with the edit patch operation. Filter the results with the query parameters time, priority, type, category, acknowledgement, and page. Sort the results by creation time and priority.

    Get alarms for an object

    Filter Behavior

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v5/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/alarms?startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&priorityRange=0%2C255&type=alarmValueEnumSet.avHighLimit&includeAcknowledged=false&includeDiscarded=false&includeAcknowledgementRequired=true&includeAcknowledgementNotRequired=true&category=objectCategoryEnumSet.hvacCategory&page=1&pageSize=100&sort=creationTime' \
    +  --url 'https://metasys-server.example.com/api/v5/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/alarms?startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&priorityRange=0%2C255&type=alarmValueEnumSet.avHighLimit&includeAcknowledged=false&includeDiscarded=false&includeAcknowledgementRequired=true&includeAcknowledgementNotRequired=true&category=objectCategoryEnumSet.hvacCategory&page=1&pageSize=100&sort=creationTime' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json
    {}

    Get alarms for a network device

    Retrieves a collection of alarms for the specified network device.

    Authorizations:
    Bearer-Authentication
    path Parameters
    networkDeviceId
    required
    string
    Example: d9bf66bd-22f8-425b-82a4-44ba153d79c7
    Filter Behavior

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v5/networkDevices/d9bf66bd-22f8-425b-82a4-44ba153d79c7/alarms?startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&priorityRange=0%2C255&type=alarmValueEnumSet.avHighLimit&includeAcknowledged=false&includeDiscarded=false&includeAcknowledgementRequired=true&includeAcknowledgementNotRequired=true&equipment=b7ed8b3e-cb95-410d-aaa7-37158852c398&object=06d77c63-6357-467a-a306-5e1ab3eb3aa7&space=214f52d1-0c56-4a29-a690-abe5656d1647&category=objectCategoryEnumSet.hvacCategory&page=1&pageSize=100&sort=creationTime' \
    +  --url 'https://metasys-server.example.com/api/v5/networkDevices/d9bf66bd-22f8-425b-82a4-44ba153d79c7/alarms?startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&priorityRange=0%2C255&type=alarmValueEnumSet.avHighLimit&includeAcknowledged=false&includeDiscarded=false&includeAcknowledgementRequired=true&includeAcknowledgementNotRequired=true&equipment=b7ed8b3e-cb95-410d-aaa7-37158852c398&object=06d77c63-6357-467a-a306-5e1ab3eb3aa7&space=214f52d1-0c56-4a29-a690-abe5656d1647&category=objectCategoryEnumSet.hvacCategory&page=1&pageSize=100&sort=creationTime' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json
    {}

    Get alarms Deprecated

    Filter Behavior

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v5/alarms?startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&priorityRange=0%2C255&type=alarmValueEnumSet.avHighLimit&includeAcknowledged=false&includeDiscarded=false&includeAcknowledgementRequired=true&includeAcknowledgementNotRequired=true&equipment=b7ed8b3e-cb95-410d-aaa7-37158852c398&object=06d77c63-6357-467a-a306-5e1ab3eb3aa7&space=214f52d1-0c56-4a29-a690-abe5656d1647&category=objectCategoryEnumSet.hvacCategory&page=1&pageSize=100&sort=creationTime' \
    +  --url 'https://metasys-server.example.com/api/v5/alarms?startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&priorityRange=0%2C255&type=alarmValueEnumSet.avHighLimit&includeAcknowledged=false&includeDiscarded=false&includeAcknowledgementRequired=true&includeAcknowledgementNotRequired=true&equipment=b7ed8b3e-cb95-410d-aaa7-37158852c398&object=06d77c63-6357-467a-a306-5e1ab3eb3aa7&space=214f52d1-0c56-4a29-a690-abe5656d1647&category=objectCategoryEnumSet.hvacCategory&page=1&pageSize=100&sort=creationTime' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json
    {}

    Get an alarm

    Retrieves the specified alarm.

    Authorizations:
    Bearer-Authentication
    path Parameters
    alarmId
    required
    string
    Example: 4d0598d4-2836-4efd-84b8-6f39754b1fc5
    Filter Behavior

    Request samples

    curl --request GET \
    -  --url https:///%7Bhostname%7D/api/v5/alarms/4d0598d4-2836-4efd-84b8-6f39754b1fc5 \
    +  --url https://metasys-server.example.com/api/v5/alarms/4d0598d4-2836-4efd-84b8-6f39754b1fc5 \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json

    An alarm for an analog value object.

    {}

    Edit an alarm

    Filter Behavior

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v5/alarms/4d0598d4-2836-4efd-84b8-6f39754b1fc5/annotations?startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&page=1&pageSize=100&sort=creationTime' \
    +  --url 'https://metasys-server.example.com/api/v5/alarms/4d0598d4-2836-4efd-84b8-6f39754b1fc5/annotations?startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&page=1&pageSize=100&sort=creationTime' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json
    {}

    audits

    Relationships

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v5/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/audits?startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&originApplication=auditOriginAppEnumSet.deviceManagerAuditOriginApp&classLevel=auditClassesEnumSet.userActionAuditClass&actionType=auditActionTypeEnumSet.writeAuditActionType&user=metasysuser&includeDiscarded=false&equipment=b7ed8b3e-cb95-410d-aaa7-37158852c398&space=214f52d1-0c56-4a29-a690-abe5656d1647&page=1&pageSize=100&sort=creationTime' \
    +  --url 'https://metasys-server.example.com/api/v5/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/audits?startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&originApplication=auditOriginAppEnumSet.deviceManagerAuditOriginApp&classLevel=auditClassesEnumSet.userActionAuditClass&actionType=auditActionTypeEnumSet.writeAuditActionType&user=metasysuser&includeDiscarded=false&equipment=b7ed8b3e-cb95-410d-aaa7-37158852c398&space=214f52d1-0c56-4a29-a690-abe5656d1647&page=1&pageSize=100&sort=creationTime' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json

    Gets the first 10 audits.

    {
    • "total": 400,
    • "previous": null,
    • "items": [
      ],
    • "effectivePermissions": [
      ],
    }

    Get audits Deprecated

    Relationships

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v5/audits?startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&originApplication=auditOriginAppEnumSet.deviceManagerAuditOriginApp&classLevel=auditClassesEnumSet.userActionAuditClass&actionType=auditActionTypeEnumSet.writeAuditActionType&user=metasysuser&includeDiscarded=false&equipment=b7ed8b3e-cb95-410d-aaa7-37158852c398&object=06d77c63-6357-467a-a306-5e1ab3eb3aa7&space=214f52d1-0c56-4a29-a690-abe5656d1647&page=1&pageSize=100&sort=creationTime' \
    +  --url 'https://metasys-server.example.com/api/v5/audits?startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&originApplication=auditOriginAppEnumSet.deviceManagerAuditOriginApp&classLevel=auditClassesEnumSet.userActionAuditClass&actionType=auditActionTypeEnumSet.writeAuditActionType&user=metasysuser&includeDiscarded=false&equipment=b7ed8b3e-cb95-410d-aaa7-37158852c398&object=06d77c63-6357-467a-a306-5e1ab3eb3aa7&space=214f52d1-0c56-4a29-a690-abe5656d1647&page=1&pageSize=100&sort=creationTime' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json

    Gets the first 10 audits.

    {
    • "total": 400,
    • "previous": null,
    • "items": [
      ],
    • "effectivePermissions": [
      ],
    }

    Get an audit

    Relationships

    Request samples

    curl --request GET \
    -  --url https:///%7Bhostname%7D/api/v5/audits/4990ee27-7a0a-4b2b-9b27-279e3f1a060c \
    +  --url https://metasys-server.example.com/api/v5/audits/4990ee27-7a0a-4b2b-9b27-279e3f1a060c \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json

    An audit for an analog value object.

    {
    • "id": "6c6ae3dd-c514-423d-bd22-0b48678c5384",
    • "creationTime": "2021-12-10T21:05:53Z",
    • "actionType": "auditActionTypeEnumSet.commandAuditActionType",
    • "activityManagementStatus": "pending",
    • "status": "statusEnumSet.ok",
    • "spaces": [ ],
    • "equipment": [ ],
    • "preData": {
      },
    • "postData": null,
    • "parameters": [
      ],
    • "errorString": null,
    • "user": null,
    • "signature": null,
    • "itemReference": "{hostname}:{deviceHostname}/AV1",
    • "objectName": "Interlock1/AV1",
    • "classLevel": "auditClassesEnumSet.applicationAuditClass",
    • "originApplication": "auditOriginAppEnumSet.interlockAuditOriginApp",
    • "description": "commandIdEnumSet.adjustCommand"
    }

    Edit an audit

    Relationships

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v5/audits/4990ee27-7a0a-4b2b-9b27-279e3f1a060c/annotations?startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&page=1&pageSize=100&sort=creationTime' \
    +  --url 'https://metasys-server.example.com/api/v5/audits/4990ee27-7a0a-4b2b-9b27-279e3f1a060c/annotations?startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&page=1&pageSize=100&sort=creationTime' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json
    {}

    Add audit annotation

    Adds an annotation to an audit.

    Authorizations:
    Bearer-Authentication
    path Parameters
    auditId
    required
    string
    Example: 4990ee27-7a0a-4b2b-9b27-279e3f1a060c
    Relationships

    Request samples

    curl --request GET \
    -  --url https:///%7Bhostname%7D/api/v5/audits/users \
    +  --url https://metasys-server.example.com/api/v5/audits/users \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json
    {}

    authentication

    Operations to get and refresh an access token.

    Request access token

    Relationships

    Request samples

    curl --request GET \
    -  --url https:///%7Bhostname%7D/api/v5/refreshToken \
    +  --url https://metasys-server.example.com/api/v5/refreshToken \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json

    The result includes the access token needed to make requests. (The token in this example has been truncated.)

    {
    • "accessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1...",
    • "expires": "2021-04-22T00:12:18Z"
    }

    equipment

    Relationships

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v5/networkDevices/d9bf66bd-22f8-425b-82a4-44ba153d79c7/equipment?page=1&pageSize=100&sort=name' \
    +  --url 'https://metasys-server.example.com/api/v5/networkDevices/d9bf66bd-22f8-425b-82a4-44ba153d79c7/equipment?page=1&pageSize=100&sort=name' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json

    Get equipment instances

    Relationships

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v5/equipment?page=1&pageSize=100&sort=name' \
    +  --url 'https://metasys-server.example.com/api/v5/equipment?page=1&pageSize=100&sort=name' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json

    A page of equipment instances.

    Get a single equipment instance

    Relationships

    Request samples

    curl --request GET \
    -  --url https:///%7Bhostname%7D/api/v5/equipment/b78fa672-3ec9-4794-bd00-7aeafeb9cde0 \
    +  --url https://metasys-server.example.com/api/v5/equipment/b78fa672-3ec9-4794-bd00-7aeafeb9cde0 \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json

    Get equipment served by an equipment instance

    Relationships

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v5/equipment/b78fa672-3ec9-4794-bd00-7aeafeb9cde0/equipment?page=1&pageSize=100&sort=name' \
    +  --url 'https://metasys-server.example.com/api/v5/equipment/b78fa672-3ec9-4794-bd00-7aeafeb9cde0/equipment?page=1&pageSize=100&sort=name' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json

    Get equipment that serve an equipment instance

    Relationships

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v5/equipment/04d68394-3415-4813-b5ec-43d840deee38/upstreamEquipment?page=1&pageSize=100&sort=name' \
    +  --url 'https://metasys-server.example.com/api/v5/equipment/04d68394-3415-4813-b5ec-43d840deee38/upstreamEquipment?page=1&pageSize=100&sort=name' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json

    List equipment points

    Relationships

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v5/equipment/b78fa672-3ec9-4794-bd00-7aeafeb9cde0/points?page=1&pageSize=100&sort=shortName' \
    +  --url 'https://metasys-server.example.com/api/v5/equipment/b78fa672-3ec9-4794-bd00-7aeafeb9cde0/points?page=1&pageSize=100&sort=shortName' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json

    A page of equipment points

    {}

    Get equipment serving a space

    Relationships

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v5/spaces/bf254f63-2cbb-4195-8c53-a1d6fcbe54f6/equipment?page=1&pageSize=100&sort=name' \
    +  --url 'https://metasys-server.example.com/api/v5/spaces/bf254f63-2cbb-4195-8c53-a1d6fcbe54f6/equipment?page=1&pageSize=100&sort=name' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json

    network-devices

    Relationships

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v5/networkDevices?objectType=bacnetIntegrationClass&page=1&pageSize=100&sort=name&classification=device&classification=server&classification=controller' \
    +  --url 'https://metasys-server.example.com/api/v5/networkDevices?objectType=bacnetIntegrationClass&page=1&pageSize=100&sort=name&classification=device&classification=server&classification=controller' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json

    A page of network devices.

    {}

    Get a single network device

    Relationships

    Request samples

    curl --request GET \
    -  --url https:///%7Bhostname%7D/api/v5/networkDevices/d9bf66bd-22f8-425b-82a4-44ba153d79c7 \
    +  --url https://metasys-server.example.com/api/v5/networkDevices/d9bf66bd-22f8-425b-82a4-44ba153d79c7 \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json

    A single network device.

    {}

    Deletes a network device

    Relationships

    Request samples

    curl --request DELETE \
    -  --url https:///%7Bhostname%7D/api/v5/networkDevices/d9bf66bd-22f8-425b-82a4-44ba153d79c7 \
    +  --url https://metasys-server.example.com/api/v5/networkDevices/d9bf66bd-22f8-425b-82a4-44ba153d79c7 \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    List network device children

    Retrieves the collection of network devices that are children of the specified network device.

    Authorizations:
    Bearer-Authentication
    path Parameters
    networkDeviceId
    required
    string
    Example: d9bf66bd-22f8-425b-82a4-44ba153d79c7
    Relationships

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v5/networkDevices/d9bf66bd-22f8-425b-82a4-44ba153d79c7/networkDevices?page=1&pageSize=100&sort=name' \
    +  --url 'https://metasys-server.example.com/api/v5/networkDevices/d9bf66bd-22f8-425b-82a4-44ba153d79c7/networkDevices?page=1&pageSize=100&sort=name' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json

    A page of network devices.

    {}

    List network devices hosting an equipment instance

    Relationships

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v5/equipment/b78fa672-3ec9-4794-bd00-7aeafeb9cde0/networkDevices?page=1&pageSize=100&sort=name' \
    +  --url 'https://metasys-server.example.com/api/v5/equipment/b78fa672-3ec9-4794-bd00-7aeafeb9cde0/networkDevices?page=1&pageSize=100&sort=name' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json

    A page of network devices.

    {}

    List network devices serving a space

    Relationships

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v5/spaces/bf254f63-2cbb-4195-8c53-a1d6fcbe54f6/networkDevices?page=1&pageSize=100&sort=name' \
    +  --url 'https://metasys-server.example.com/api/v5/spaces/bf254f63-2cbb-4195-8c53-a1d6fcbe54f6/networkDevices?page=1&pageSize=100&sort=name' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json

    A page of network devices.

    {}

    objects

    Events

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v5/objects?depth=1&flatten=false&includeExtensions=false&pathTo=a5885077-9dba-5923-a6d8-ae4aabdc6f0a&includeEffectivePermissions=true' \
    +  --url 'https://metasys-server.example.com/api/v5/objects?depth=1&flatten=false&includeExtensions=false&pathTo=a5885077-9dba-5923-a6d8-ae4aabdc6f0a&includeEffectivePermissions=true' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json
    Example

    The objects are returned in a tree structure. Child objects are nested under their parents.

    {}

    Create object

    Events

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v5/objects/767d8af0-163f-552c-ba37-a884466075f9/objects?depth=1&flatten=false&includeExtensions=false&pathTo=a5885077-9dba-5923-a6d8-ae4aabdc6f0a&objectType=objectTypeEnumSet.avClass&classification=object&includeEffectivePermissions=true' \
    +  --url 'https://metasys-server.example.com/api/v5/objects/767d8af0-163f-552c-ba37-a884466075f9/objects?depth=1&flatten=false&includeExtensions=false&pathTo=a5885077-9dba-5923-a6d8-ae4aabdc6f0a&objectType=objectTypeEnumSet.avClass&classification=object&includeEffectivePermissions=true' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json
    Example

    The objects are returned in a tree structure. Child objects are nested under their parents.

    {}

    Get object id Deprecated

    Events

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v5/objectIdentifiers?fqr=adx%3Aadx' \
    +  --url 'https://metasys-server.example.com/api/v5/objectIdentifiers?fqr=adx%3Aadx' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json
    "32cfddc0-411f-5b9e-9a6d-442cb62fecbb"

    Lookup object identifier

    Finds the object identifier (the id property of an object) for the object with the specified fully qualified reference (fqr).

    Authorizations:
    Bearer-Authentication
    query Parameters
    fqr
    required
    string
    Examples:
    • fqr=adx:adx - An example of a site director fqr
    • fqr=adx:nae23/Programming.AV1 - An example of an analog value object fqr
    format: fully-qualified-reference
    Events

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v5/objects/identifiers?fqr=adx%3Aadx' \
    +  --url 'https://metasys-server.example.com/api/v5/objects/identifiers?fqr=adx%3Aadx' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json
    "32cfddc0-411f-5b9e-9a6d-442cb62fecbb"

    Get an object

    Events

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v5/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb?viewId=viewNameEnumSet.focusView&includeSchema=false' \
    +  --url 'https://metasys-server.example.com/api/v5/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb?viewId=viewNameEnumSet.focusView&includeSchema=false' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json
    Example
    Events

    Request samples

    curl --request DELETE \
    -  --url https:///%7Bhostname%7D/api/v5/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb \
    +  --url https://metasys-server.example.com/api/v5/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    List the views of an object

    Events

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v5/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/views?includeSchema=false' \
    +  --url 'https://metasys-server.example.com/api/v5/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/views?includeSchema=false' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json
    Example

    List attributes of an object

    Events

    Request samples

    curl --request GET \
    -  --url https:///%7Bhostname%7D/api/v5/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/attributes \
    +  --url https://metasys-server.example.com/api/v5/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/attributes \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json
    Example
    {
    • "item": {
      },
    • "schema": {
      }
    }

    Get attribute value

    Events

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v5/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/attributes/presentValue?includeSchema=false' \
    +  --url 'https://metasys-server.example.com/api/v5/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/attributes/presentValue?includeSchema=false' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
       --header 'METASYS-SUBSCRIBE: 40e47e37-0f24-4101-8e1d-de96af4b648b'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json
    Example
    {
    • "item": {
      },
    • "condition": {
      },
    • "schema": {
      }
    }

    List commands

    Events

    Request samples

    curl --request GET \
    -  --url https:///%7Bhostname%7D/api/v5/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/commands \
    +  --url https://metasys-server.example.com/api/v5/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/commands \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json
    Example
    {
    • "items": [
      ],
    • "effectivePermissions": {
      }
    }

    Send command

    Events

    Request samples

    curl --request GET \
    -  --url https:///%7Bhostname%7D/api/v5/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/supportedChildTypes \
    +  --url https://metasys-server.example.com/api/v5/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/supportedChildTypes \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json
    Example

    The supported child types of a folder.

    [
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      }
    ]

    List object equipment points

    Events

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v5/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/points?page=1&pageSize=100&sort=shortName' \
    +  --url 'https://metasys-server.example.com/api/v5/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/points?page=1&pageSize=100&sort=shortName' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json
    {}

    Batch operations

    Events

    Request samples

    curl --request GET \
    -  --url https:///%7Bhostname%7D/api/v5/schemas/enums/writePriorityEnumSet \
    +  --url https://metasys-server.example.com/api/v5/schemas/enums/writePriorityEnumSet \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json
    Example
    {
    • "title": "Write Priority",
    • "setId": 1,
    • "oneOf": [
      ]
    }

    Get object type schema

    Events

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v5/schemas/objectTypes/objectTypeEnumSet.avClass?parentId=2993aed9-5765-5641-889c-40ec968c8a82&extendedProperty=attributeEnumSet.presentValue' \
    +  --url 'https://metasys-server.example.com/api/v5/schemas/objectTypes/objectTypeEnumSet.avClass?parentId=2993aed9-5765-5641-889c-40ec968c8a82&extendedProperty=attributeEnumSet.presentValue' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json
    Example

    This schema describes the properties that can be configured when creating an object of the type avClass.

    {
    • "schema": {
      },
    • "views": [
      ]
    }

    spaces

    Events

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v5/networkDevices/d9bf66bd-22f8-425b-82a4-44ba153d79c7/spaces?page=1&pageSize=100&sort=name' \
    +  --url 'https://metasys-server.example.com/api/v5/networkDevices/d9bf66bd-22f8-425b-82a4-44ba153d79c7/spaces?page=1&pageSize=100&sort=name' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json

    A page of spaces.

    {}

    Get spaces served by an equipment instance

    Events

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v5/equipment/b78fa672-3ec9-4794-bd00-7aeafeb9cde0/spaces?page=1&pageSize=100&sort=name' \
    +  --url 'https://metasys-server.example.com/api/v5/equipment/b78fa672-3ec9-4794-bd00-7aeafeb9cde0/spaces?page=1&pageSize=100&sort=name' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json

    A page of spaces.

    {}

    Get spaces

    Events

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v5/spaces?type=spaceTypesEnumSet.building&page=1&pageSize=100&sort=name' \
    +  --url 'https://metasys-server.example.com/api/v5/spaces?type=spaceTypesEnumSet.building&page=1&pageSize=100&sort=name' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json

    A page of spaces.

    {}

    Get a single space

    Events

    Request samples

    curl --request GET \
    -  --url https:///%7Bhostname%7D/api/v5/spaces/bf254f63-2cbb-4195-8c53-a1d6fcbe54f6 \
    +  --url https://metasys-server.example.com/api/v5/spaces/bf254f63-2cbb-4195-8c53-a1d6fcbe54f6 \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json

    A page of spaces.

    {}

    Get space children

    Events

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v5/spaces/bf254f63-2cbb-4195-8c53-a1d6fcbe54f6/spaces?page=1&pageSize=100&sort=name' \
    +  --url 'https://metasys-server.example.com/api/v5/spaces/bf254f63-2cbb-4195-8c53-a1d6fcbe54f6/spaces?page=1&pageSize=100&sort=name' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json

    A page of spaces.

    streaming

    C# - LaunchDarkly EventSource

    Request samples

    curl --request GET \
    -  --url https:///%7Bhostname%7D/api/v5/stream \
    +  --url https://metasys-server.example.com/api/v5/stream \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
       --header 'Last-Event-Id: b6d184ee-e137-44aa-b9b1-14bc704cd25d:5'

    time series

    Events

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v5/timeSeries?searchString=AV&page=1&pageSize=100&sort=itemReference' \
    +  --url 'https://metasys-server.example.com/api/v5/timeSeries?searchString=AV&page=1&pageSize=100&sort=itemReference' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json
    {}

    List trended attributes (buffer)

    Retrieves a collection of attributes under the specified object for which samples are available in their respective local sample buffers.

    Authorizations:
    Bearer-Authentication
    path Parameters
    objectId
    required
    string
    Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb
    Events

    Request samples

    curl --request GET \
    -  --url https:///%7Bhostname%7D/api/v5/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/trendedAttributes \
    +  --url https://metasys-server.example.com/api/v5/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/trendedAttributes \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json

    Get objects trended attributes response.

    {}

    List trended attributes (repository)

    Events

    Request samples

    curl --request GET \
    -  --url https:///%7Bhostname%7D/api/v5/timeSeries/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/trendedAttributes \
    +  --url https://metasys-server.example.com/api/v5/timeSeries/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/trendedAttributes \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json

    Get trended attributes from the trend repository response.

    Get attribute samples (buffer)

    Events

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v5/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/trendedAttributes/presentValue/samples?startSampleTime=2020-05-12T16%3A46%3A47Z&endSampleTime=2021-01-19T18%3A13%3A58.007Z&sort=sampleTime&sampledById=4cc1cb52-b2db-4129-ac93-0d4a5e6dd6d7&sampledById=4ffd6456-3d36-5e08-8efb-ba91d4a81126' \
    +  --url 'https://metasys-server.example.com/api/v5/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/trendedAttributes/presentValue/samples?startSampleTime=2020-05-12T16%3A46%3A47Z&endSampleTime=2021-01-19T18%3A13%3A58.007Z&sort=sampleTime&sampledById=4cc1cb52-b2db-4129-ac93-0d4a5e6dd6d7&sampledById=4ffd6456-3d36-5e08-8efb-ba91d4a81126' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
       --header 'METASYS-SUBSCRIBE: 40e47e37-0f24-4101-8e1d-de96af4b648b'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json
    Example

    Get samples from trend object response containing only analog values.

    @@ -5164,7 +5164,7 @@

    Events

    Request samples

    curl --request GET \
    -  --url 'https:///%7Bhostname%7D/api/v5/timeSeries/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/trendedAttributes/presentValue/samples?startSampleTime=2020-05-12T16%3A46%3A47Z&endSampleTime=2021-01-19T18%3A13%3A58.007Z&page=5&pageSize=500&sort=sampleTime' \
    +  --url 'https://metasys-server.example.com/api/v5/timeSeries/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/trendedAttributes/presentValue/samples?startSampleTime=2020-05-12T16%3A46%3A47Z&endSampleTime=2021-01-19T18%3A13%3A58.007Z&page=5&pageSize=500&sort=sampleTime' \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

    Response samples

    Content type
    application/vnd.metasysapi.v5+json
    Example

    Get samples from the trend repository response containing only analog values.

    {}

    Batch operations for time series (repository)

    Events

    Request samples

    curl --request DELETE \
    -  --url https:///%7Bhostname%7D/api/v5/timeSeries/streams/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/subscriptions/626e5ac3-506d-4017-bb8f-973f1c54ddb5 \
    +  --url https://metasys-server.example.com/api/v5/timeSeries/streams/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/subscriptions/626e5ac3-506d-4017-bb8f-973f1c54ddb5 \
       --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'