Inventory REST API

Auto-generated swagger documentation

Overview

Media Type

The API uses JSON to communicate with clients.

You should add the following accept header to your requests:

Accept: application/json

When you send JSON data with a POST or PUT request, you must add the following content type header:

Content-Type: application/json

API Endpoints

Since the version 0.17.0.Final, Hawkular inventory has a new REST API.

There is a more detailed, generated, information about the endpoints further down in this document. The following sub-chapters give an overview of the endpoints available and examples of their usage.

The old API has been kept so that clients can gradually move to the new API, but the old API has moved from /hawkular/inventory to /hawkular/inventory/deprecated. The clients using the old API will have to be modified to use the new endpoint but are otherwise unaffected. We’ve decided to not keep the old API on its original place and actually remove in some future version (but before 1.0.0.Final) because Inventory is not yet deemed stable and we don’t want to spoil the first stable version with an API that is not fulfilling its purpose.

Working With Entities

The endpoint /hawkular/inventory/entity provides full read-write access to individual entities (and relationships).

Single entities are addressed by their canonical paths. To learn more about the canonical paths, consult the documentation.

Read

To access some entity, simply append its canonical path as is (with or without the tenant id) to the endpoint URL.

I.e. to access a resource with id myApp which is in prod environment, use the following GET HTTP request:

GET /hawkular/inventory/entity/e;prod/r;myApp

or

GET /hawkular/inventory/entity/t;my-tenant/e;prod/r;myApp

if you want to include the tenant in the URL (i.e. use the canonical path as is). N. B. you still need to include the tenant in the Hawkular-Tenant header though.

Create

To create a new entity, simply use the URL of its parent (an empty path if the entity is placed directly under a tenant) and add a path segment with the type of the entity you are adding. As the body of the request, use the appropriate blueprint type.

  1. g. to create a new resource "myResource" under a feed "myFeed", issue:

    POST /hawkular/inventory/entity/f;myFeed/resource
    {
  "id" : "myResource",
  "resourceTypePath": "myResourceTypeUnderMyFeed"
}

The paths in the payload of the post request are resolved against the parent under which the entity is being created. I.e. in the example above the value of the "resourceTypePath" key is a relative path and is resolved against /t;myTenant/f;myFeed (if myTenant is the current tenant) and thus is resolved as /t;myTenant/f;myFeed/rt;myResourceTypeUnderMyFeed). Of course, you can also use the full canonical paths if you wish. E.g. the following request would result in the same resource being created:

POST /hawkular/inventory/entity/f;myFeed/resource
{
  "id" : "myResource",
  "resourceTypePath": "/t;myTenant/f;myFeed/rt;myResourceTypeUnderMyFeed"
}

Please consult the detailed documentation for the list of properties supported/required for the individual types of entities.

Update

To update an entity, send a PUT request to the /entity/…​ endpoint with the update object for given entity type. E.g.

PUT /hawkular/inventory/entity/f;My%20Feed/r;RootResource/r;child-resource
{
  "properties": {
    "admin's personal notes": "Seems to have stabilized in the new version..."
  }
}

This will update the resource with ID "child-resource" contained within a "RootResource" resource under a feed with ID "My Feed" (under the current tenant specified by the header) to have the above specified properties.

Delete

To delete a resource, send a DELETE request to its /entity/…​ endpoint. Deleting an entity will also recursively delete all the child entities contained within it (i.e. deleting a feed will delete all resources, metrics, resource types and metric types defined by it). It will NOT delete the entities otherwise associated with it. I.e. if a resource incorporates a metric and the resource is deleted, the metric still exists.

Retrieving Tree Hash

The identity hash of entities that support it is based on the Merkle tree hash of their child entities. To retrieve this tree hash (for example to quickly check if your local entity tree is the same), you can use:

/hawkular/inventory/entity/f;feedId/treeHash

Traversing Many Entities

Inventory data forms a graph. Using the /hawkular/inventory/traversal endpoint one can compose traversals of this graph that can search for certain entities. The traversals that can be expressed using the URL do not have the full strength of general purpose graph-traversal language like Gremlin but many things can be achieved with them.

In the future, there is a plan to support full Gremlin-based access to inventory.

The URL traversal of the inventory is an extension of the format of canonical path. E.g.

/hawkular/inventory/traversal/f;feedId/r;resourceId

is a valid URL traversal, because /f;feedId/r;resourceId is a valid (tenantless) canonical path.

To be able to formulate efficient traversals, it is good to understand the inventory organization. Please consult the documentation for its details.

Now to a more formal definition of the URL traversal (for the technically inclined, the traversal is described using an Antlr4 grammar).

Filtering Entities

Each path segment in the URL traversal expresses a filter on the "current" set of entities. The filtering is performed within a single URL path segment using a notation similar to HTTP matrix parameters.

Given an example traversal /hawkular/inventory/traversal/type=feed;name=My%20Feed/r;resourceId we’ll be talking about a single path segment, e.g. type=feed;name=My%20Feed or r;resourceId.

Given the example type=feed;name=My%20Feed you can spot two things:

  • multiple filters can be used, separated by a semi-colon,

  • within a single path segment everything must be percent-encoded (i.e. above we’re looking for feeds with name My Feed). Again this is in accordance with canonical path format which requires percent-encoding for IDs, too.

Canonical path segment as filter

r;resourceId or mt;AwesomeMetricType are valid filters. The (one or two) letters perceding the first semicolon specify the type of the sought-after entities (for the full list, check canonical path format description).

Other Filters

  • type — only allows entities of the specified type. The type can be specified either as the segment type as in the canonical path segments (type=d) or by their full name (no spaces, first letter lower-case, camel-case afterwards, e.g. type=resource, type=resourceType, etc.). Multiple occurences of the type filter are or-ed together, i.e. the sought-after entities must have one of the types specified.

  • id — only allows entities with the specified id. Multiple occurences of the filter are or-ed together, i.e. the entities must have only one of the provided ids.

  • name — only allows entities with the specified name. Again, multiple occurences are or-ed together.

  • cp — only allows entities with the given canonical path. Note that you have to percent-encode the value so that it can appear as a filter, e.g. …​/cp=%2Ft%3BtenantId%2Ff%3BfeedId/…​

  • propertyName — only allows entities which have a property of specified name (regardless of its value).

  • propertyName & propertyValue — if the URL traversal segment contains both propertyName and propertyValue then they are matched together to compose a filter for entities having a particular property with a particular value. It is possible to specify such pair more than once with the same property name, which will construct a filter for the entities having a property with given name having one of the provided values. To illustrate the behavior, let’s consider the following examples:

    • …​/propertyName=a;propertyName=b — filters for entities that have both properties a and b with any value,

    • …​/propertyName=a;propertyValue=aa;propertyName=b — filters for entities that have both properties a and b. The property a must in addition have the value of aa, while property b is free to have any value.

    • …​/propertyName=a;propertyValue=aa;propertyName=a;propertyValue=aaa;propertyValue=b — property a needs to have the value aa or aaa and there must be a property b with any value.

    • it is not possible to express "an entity with a property a or a property b)

    • unmatched propertyValue filters are illegal, e.g. …​/propertyName=a;propertyValue=aa;propertyValue=aaa

  • relatedBy & relatedTo — these two filters again come in pairs. One can filter for entities that are related to some other entity by some relationship. The name of the relationship is defined by the value of relatedBy filter and the canonical path (possibly tenant-less) of the entity is the value of relatedTo. E.g.

    /hawkular/inventory/traversal/type=e;relatedTo=%2Ff%3BfeedId;relatedBy=incorporates

    will return an environment that incorporates a feed with id feedId.

  • relatedBy & relatedWith — these are similar to relatedBy and relatedTo but the difference is in the understood direction of the relationship. While relatedTo assumes and outgoing relationship, relatedWith assumes an incoming relationship. E.g.

    /hawkular/inventory/traversal/type=f;relatedWith=%2Fe%3Benv;relatedBy=incorporates

    will return all feeds that are incorporated by the environment with id env. Note that this can be equally expressed as:

    /hawkular/inventory/traversal/e;id/rl;incorporates/type=f

    see the documentation about progressing the traversal on details about that type of traversal. relatedWith is nevertheless provided because sometimes such an equivalent traversal in the "progressing" form cannot be constructed.

  • definedBy — a short cut for relatedBy=defines;relatedWith=[PATH]

Filter without canonical path segment

It is valid to specify a filter without the canonical path segment. E.g.

/hawkular/inventory/traversal/type=environment/name=Guess%20Who%20I%20Am

which will look for all entities of any type which have a name "Guess Who I Am" and which are contained in any environment.

From the above, you can see that …​/traversal/f;feedId/r;resource is actually the same as …​/traversal/type=f;id=feedId/type=r;id=resource only more concise.
Progressing the Traversal

In the previous chapter you could spot examples where multiple URL path segments were used, each specifying a filter. That is actually an implicit type of progression, but other progressions are also possible.

Implicit Progression

If two filters specified as URL path segments, the implicit progression from the first set of entities (specified by the first filter) to the second set of entities is supposed to go over contains relationship. I.e. if we have the following graph:

+-----+             +-----+
|  A  |--contains-->|  B  |
+-----+             +-----+

The following URL will find the entity B:

/hawkular/inventory/traversal/id=A/id=B
Explicit Relationship Progression

It is possible to explicitly specify what relationship the progression should progress in the graph:

/hawkular/inventory/traversal/id=A/rl;defines/id=B

I.e. the first filter id=A establishes a set of "source" entities. From those, the rl;defines instructs the progression to go over the defines relationship (implicitly in the outgoing direction). The targets of those relationships are then filtered using the id=B filter.

The full definition of the explicit relationship progression can be expressed by the pseudo regular expression:

rl;<NAME>(;<DIRECTION>)?(;<FILTER>)*
<NAME>

Is the name of the relationship, e.g. contains, defines or other predefined relationships or indeed any user-defined relationship name.

<DIRECTION>

is the direction in which to follow the relationship. The possible values are in or out (with out being the default). The in direction means to go to the source entities of the relationships that target the current entity (the naming comes from the Gremlin traversal language and the logic is that the relationship points "in" the current entity).

<FILTER>

The relationships to follow can be filtered down using a number of relationship-specific filters. Those are: +

  • propertyName & propertyValue — with the same semantics as explained in the previous chapter,

  • name — is the name of the relationship, again with same semantics as for entity filters,

  • id — the id of the relationship,

  • sourceType — the type of the entity from which the relationship originates. This allows for the same values as the type filter for the entities (described above),

  • targetType — the type of the entity to which the relationship points. Again, this can have the same values as the type filter on entities.

Progressing To Identical Entities

Certain entities have their identity hash automatically computed. This makes it possible to find all other entities of the same type that appear identical to the current entity.

/hawkular/inventory/traversal/rt;Wildfly/identical/rl;defines/type=resource

The above query will first find a global resource type with ID "Wildfly", will then find all its identical resource types (i.e. if some feed defines the same resource type, it will be included) and then from all those resource types will follow the defines relationship and will output all the target entities of that relationship that are of type resource.

This type of progression doesn’t accept any filters.

Progressing Recursively

Sometimes it is useful to retrieve all child entities recursively. For example to find all metrics of all child resources, you can:

/hawkular/inventory/traversal/f;feed/r;rootResource/recursive;type=resource/rl;incorporates/type=metric

This will traverse to the rootResource resource, will find recursively all its child resources and from them follow the incorporates relationship. From the entities targetted by those relationships, it will pick the ones with type metric.

The full format of the recursive progression using a pseudo regular expression:

recursive(;over=<REL>)?(;<FILTER>)*
<REL>

is the name of the relationship to recursively progress over. Defaults to contains.

<FILTER>

is any entity filter as specified in the previous chapter. Note that these filters are applied to each of the entities recursed over, so if an entity recursed over doesn’t satisfy them, it will not be descended into.

Retrieving Relationships

If you know an ID of a specific relationship, you can access it directly using its canonical path using the single entity access endpoint:

/hawkular/inventory/entity/rl;<ID>

where <ID> is the id of the relationship.

If you want to find entities without knowing their exact ID, you can have a two of options:

Relationships Of Entities
/hawkular/inventory/traversal/f;feed/relationships;in

The relationships ending segment can be augmented in the same way as an explicit relationship progression specified above. I.e. you can specify the direction of the relationships returned (defaults to out) and you can limit the number of the relationships returned using the relationship-specific filters.

Relationships In Traversal

Using the rl;<NAME> progression you can "stay" at the relationships like so:

/hawkular/inventory/traversal/f;feedId/rl;myRelation/relationships

This ending segment doesn’t accept any filters but will return all the relationships called "myRelation" going out of the feed with id "feedId". If you want to obtain the incoming relationships this way, you can do:

/hawkular/inventory/traversal/f;feedId/rl;myRelation;in/relationship
Retrieving Entities Of Relationship

If you want to retrieve the "other ends" of a relationship during traversal and you don’t want to restrict them or continue your traversal using them, you can use the following idiom:

/hawkular/inventory/traversal/f;feedId/rl;myRelation/entities

This will return all the entities that relationships with name "myRelation" going out of the feed with id "feedId" are pointing to.

Examples

Access specific relationship
/hawkular/inventory/entity/rl;<ID>
Access all children of a resource
/hawkular/inventory/traversal/e;envId/r;rootResourceId/recursive;type=resource
Access direct contained child resources of a resource
/hawkular/inventory/traversal/e;envId/r;rootResourceId/type=resource
Access direct child resources of a resource
/hawkular/inventory/traversal/e;envId;/r;rootResourceId/rl;isParentOf/entities
Access metrics of a resource
/hawkular/inventory/traversal/e;envId/r;resourceId/rl;incorporates/type=metric

Access all resources identical to given one:

+ /hawkular/inventory/traversal/e;envId/r;resourceId/identical

Listening To Inventory Events

The /hawkular/inventory/ws/events endpoint enables you to listen to inventory events as they happen. The types of events you are interested in is specified using query parameters:

  • tenantId — because websockets cannot work with http headers, you need to supply the tenant for which you want to receive the events as a query parameter.

  • type — the type of entities you want to receive events about. This accepts the same values as the type filter in URL traversals.

  • action — the type of action you are interested in - can be created, updated, deleted, identity_hash_changed.

Paging

The /hawkular/inventory/traversal endpoint supports paging of the results. Paging is controlled using query parameters:

  • page — the number of the page to retrieve

  • per_page — the number results per page

  • sort — the name of the property to sort by. No sorting is applied if not specified, which is not recommended because sorting then is data storage specific and can differ between requests. The properties available are the keys in the returned JSON objects, e.g. "id", "path", "unit", "myCustomProperty"…​

  • order — asc or desc for ascending or descending ordering of the results.

Base Path

/hawkular/inventory

REST APIs

API Info

  1. List Endpoints

Endpoint GET /

List Endpoints
Lists all the REST API endpoints available

Response

Status codes

Status Code Reason Response Model

default

successful operation

-

Bulk Create

  1. Bulk creation of new entities.

Endpoint POST /bulk

Bulk creation of new entities.
The response body contains details about results of creation of individual entities. The return value is a map where keys are types of entities created and values are again maps where keys are the canonical paths of the entities to be created and values are HTTP status codes - 201 OK, 400 if invalid path is supplied, 409 if the entity already exists on given path or 500 in case of internal error.

Query parameters

Parameter Required Description Type Format Allowable Values

at

No

Specifies the time to mark the entity as having been created. Either a Unix epoch timestamp in milliseconds, or an ISO-8601 formatted date and time in UTC timezone.

null

-

-

Body

Required Description Data Type

Yes

This is a map where keys are paths to the parents under which entities should be created. The values are again maps where keys are one of [environment, resourceType, metricType, operationType, feed, resource, metric, dataEntity, relationship] and values are arrays of blueprints of entities of the corresponding types.

object

No

This is a map where keys are paths to the parents under which entities should be created. The values are again maps where keys are one of [environment, resourceType, metricType, operationType, feed, resource, metric, dataEntity, relationship] and values are arrays of blueprints of entities of the corresponding types.

object

Response

Status codes

Status Code Reason Response Model

201

Entities successfully created

-

Deprecated

  1. List Endpoints

  2. Bulk creation of new entities.

  3. Returns all environments under given tenant. Accepts paging query parameters.

  4. Creates a new environment in given tenant.

  5. Deletes the environment from the tenant

  6. Retrieves a single environment

  7. Updates properties of the environment

  8. Listen on stream of the events

  9. Return all the feeds registered with the inventory

  10. Registers a feed with the inventory, giving it a unique ID.

  11. Deletes a feed

  12. Return a single feed by its ID.

  13. Updates a feed

  14. Retrieves all metric types under feed. Accepts paging query parameters.

  15. Creates a new metric type under feed

  16. Deletes a metric type under feed

  17. Retrieves a single metric type under feed

  18. Updates a metric type under feed

  19. Retrieves all metrics in a feed

  20. Creates a new metric in given feed

  21. Deletes a metric

  22. Retrieves a single metric

  23. Updates a metric

  24. Retrieves all metric types associated with the resource type. Accepts paging query params.

  25. Creates a new resource type

  26. Deletes a resource type

  27. Retrieves all metric types associated with the resource type. Accepts paging query params.

  28. Update a resource type

  29. Updates the configuration of a resource type

  30. Retrieves a single resource type

  31. Creates the configuration for pre-existing resource type

  32. Updates the configuration of a resource type

  33. Retrieves all metric types associated with the resource type. Accepts paging query params.

  34. Associates a pre-existing metric type with a resource type

  35. Disassociates the given resource type from the given metric type

  36. Retrieves the given metric type associated with the given resource type.

  37. Retrieves operation types

  38. Creates a new operation type under a pre-existing resource type

  39. Updates the configuration of a resource type

  40. Updates the configuration of a resource type

  41. Updates the configuration of a resource type

  42. Retrieves a single resource type

  43. Creates the configuration for pre-existing resource type

  44. Updates the configuration of a resource type

  45. Retrieves all metric types associated with the resource type. Accepts paging query params.

  46. Retrieves resources in the feed, optionally filtering by resource type

  47. Creates a new resource

  48. Creates a new resource

  49. Retrieves a single resource

  50. Retrieves a single resource

  51. Update a resource

  52. Retrieves child resources of a resource. This can be paged.

  53. Associates given resources as children of a given resource.

  54. Disassociates given child resource from given resource. The the resource doesn’t own the child, the child will no longer be considered a child of the resource, otherwise an error will be returned.

  55. Deletes the configuration of a resource

  56. Retrieves the configuration of a resource

  57. Creates the configuration for pre-existing resource

  58. Updates the configuration of a resource

  59. Retrieves all metrics associated with a resource. Accepts paging query parameters.

  60. Either creates a new metric owned by the resource or associates a pre-existing metric with the resource. This depends on what you pass as the the body of the request. A JSON array of strings is understood as a list of pre-existing metric paths that are associated with the resource. If the body is a JSON object or an array of JSON objects, the new metric or metrics are created "underneath" the resource.

  61. Disassociates the given resource from the given metric. If the metric is contained within the resource, it is also deleted.

  62. Retrieves a single resource

  63. Retrieves the parent resources that contains the given resource. Such parent resource will not exist for resources directly contained in an environment or a feed.

  64. Retrieves parent resources of a resource. This can be paged.

  65. Recursively retrieves child resources of a resource of given type. Can be paged.

  66. Retrieves all metadata packs.

  67. Create a metadata pack

  68. Deletes a metadata pack.

  69. Get a single metadata pack by id.

  70. Update a metadata pack.

  71. Retrieve all the metric types of the metadata pack.

  72. Retrieve all the resource types of the metadata pack.

  73. Retrieves all metric types. Accepts paging query parameters

  74. Creates a new metric type

  75. Deletes a metric type

  76. Retrieves a single metric type

  77. Updates a metric type

  78. Return an entity with the provided canonical path

  79. Return an entity with the provided canonical path

  80. A dummy operation returning the current date on the server.

  81. Retrieves relationship info

  82. Retrieves all resource types. Accepts paging query parameters.

  83. Creates a new resource type

  84. Deletes a resource type

  85. Retrieves a single resource type

  86. Update a resource type

  87. Updates the configuration of a resource type

  88. Retrieves a single resource type

  89. Creates the configuration for pre-existing resource type

  90. Updates the configuration of a resource type

  91. Retrieves all metric types associated with the resource type. Accepts paging query params.

  92. Associates a pre-existing metric type with a resource type

  93. Disassociates the given resource type from the given metric type

  94. Retrieves the given metric type associated with the given resource type.

  95. Retrieves operation types

  96. Creates a new operation type under a pre-existing resource type

  97. Deletes the operation type

  98. Retrieves the operation type

  99. Updates the operation type

  100. Updates the configuration of a resource type

  101. Retrieves a single resource type

  102. Creates the configuration for pre-existing resource type

  103. Updates the configuration of a resource type

  104. Retrieves all resources with given resource types. Accepts paging query parameters.

  105. Make the inventory under given path match the provided inventory structure. Note that the relationships specified in the provided entities will be ignored and will not be applied.

  106. Deletes the tenant and all its data. Be careful!

  107. Retrieves the tenant of the currently logged in persona

  108. Updates properties of the current tenant

  109. Retrieves tenant’s relationships

  110. Retrieves all feeds associated with an environment. Accepts paging query parameters.

  111. Associates a pre-existing feed with an environment

  112. Disassociates the given resource from the given metric

  113. Retrieves a single feed associated with an environment

  114. Retrieves all metrics in an environment. Accepts paging query parameters.

  115. Creates a new metric in given environment

  116. Deletes a metric

  117. Retrieves a single metric

  118. Updates a metric

  119. Retrieves resources in the environment, optionally filtering by resource type. Accepts paging query parameters.

  120. Creates a new resource

  121. Creates a new resource

  122. Deletes a single resource

  123. Retrieves a single resource

  124. Update a resource

  125. Retrieves child resources of a resource. This can be paged.

  126. Associates given resources as children of a given resource.

  127. Disassociates given child resource from given resource. The the resource doesn’t own the child, the child will no longer be considered a child of the resource, otherwise an error will be returned.

  128. Deletes the configuration of a resource

  129. Retrieves the configuration of a resource

  130. Creates the configuration for pre-existing resource

  131. Updates the configuration of a resource

  132. Retrieves all metrics associated with a resource. Accepts paging query parameters.

  133. Either creates a new metric owned by the resource or associates a pre-existing metric with the resource. This depends on what you pass as the the body of the request. A JSON array of strings is understood as a list of pre-existing metric paths that are associated with the resource. If the body is a JSON object or an array of JSON objects, the new metric or metrics are created "underneath" the resource.

  134. Disassociates the given resource from the given metric. If the metric is contained within the resource, it is also deleted.

  135. Retrieves a single metric associated with a resource

  136. Retrieves the parent resources that contains the given resource. Such parent resource will not exist for resources directly contained in an environment or a feed.

  137. Retrieves parents resources of the resource. This can be paged.

  138. Recursively retrieves child resources of a resource of given type. Can be paged.

  139. Deletes a relationship

  140. Retrieves relationships

  141. Creates a relationship

  142. Updates a relationship

Endpoint GET /deprecated

List Endpoints
Lists all the REST API endpoints available

Response

Status codes

Status Code Reason Response Model

default

successful operation

-

Endpoint POST /deprecated/bulk

Bulk creation of new entities.
The response body contains details about results of creation of individual entities. The return value is a map where keys are types of entities created and values are again maps where keys are the canonical paths of the entities to be created and values are HTTP status codes - 201 OK, 400 if invalid path is supplied, 409 if the entity already exists on given path or 500 in case of internal error.

Body

Required Description Data Type

No

This is a map where keys are paths to the parents under which entities should be created. The values are again maps where keys are one of [environment, resourceType, metricType, operationType, feed, resource, metric, dataEntity, relationship] and values are arrays of blueprints of entities of the corresponding types.

object

Response

Status codes

Status Code Reason Response Model

201

Entities successfully created

-

Endpoint GET /deprecated/environments

Returns all environments under given tenant. Accepts paging query parameters.

Response

Status codes

Status Code Reason Response Model

200

OK

-

401

Unauthorized access

-

404

Tenant not found

ApiError

500

Server error

ApiError

Endpoint POST /deprecated/environments

Creates a new environment in given tenant.

Body

Required Description Data Type

Yes

-

EnvironmentBlueprint

Response

Status codes

Status Code Reason Response Model

201

Environment created

-

401

Unauthorized access

-

409

Environment already exists

ApiError

500

Server error

ApiError

Endpoint DELETE /deprecated/environments/{environmentId}

Deletes the environment from the tenant

Path parameters

Parameter Required Description Type Format Allowable Values

environmentId

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

204

Environment successfully deleted

-

400

Delete failed because it would leave inventory in invalid state

ApiError

401

Unauthorized access

-

404

Tenant or environment not found

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/environments/{environmentId}

Retrieves a single environment

Path parameters

Parameter Required Description Type Format Allowable Values

environmentId

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

OK

-

401

Unauthorized access

-

404

Environment doesn’t exist

ApiError

500

Server error

ApiError

Endpoint PUT /deprecated/environments/{environmentId}

Updates properties of the environment

Path parameters

Parameter Required Description Type Format Allowable Values

environmentId

Yes

-

string

-

-

Body

Required Description Data Type

Yes

-

EnvironmentUpdate

Response

Status codes

Status Code Reason Response Model

204

The properties of the environment successfully updated

-

400

Properties invalid

ApiError

401

Unauthorized access

-

404

Tenant or environment not found

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/events

Listen on stream of the events

Query parameters

Parameter Required Description Type Format Allowable Values

type

No

-

string

-

-

action

No

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

OK

-

401

Unauthorized access

-

404

Tenant doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/feeds

Return all the feeds registered with the inventory

Response

Status codes

Status Code Reason Response Model

200

OK

-

400

Invalid inputs

ApiError

401

Unauthorized access

-

404

Environment doesn’t exist

ApiError

500

Server error

ApiError

Endpoint POST /deprecated/feeds

Registers a feed with the inventory, giving it a unique ID.

Response

Status codes

Status Code Reason Response Model

201

OK

Feed

400

Invalid inputs

ApiError

401

Unauthorized access

-

500

Server error

ApiError

Endpoint DELETE /deprecated/feeds/{feedId}

Deletes a feed

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

204

OK

-

400

The delete failed because it would make inventory invalid

-

401

Unauthorized access

-

404

Environment or the feed doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/feeds/{feedId}

Return a single feed by its ID.

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

OK

-

400

Invalid inputs

ApiError

401

Unauthorized access

-

404

Environment or feed doesn’t exist

ApiError

500

Server error

ApiError

Endpoint PUT /deprecated/feeds/{feedId}

Updates a feed

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

204

OK

-

400

The update failed because of invalid data

-

401

Unauthorized access

-

404

Environment or the feed doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/feeds/{feedId}/metricTypes

Retrieves all metric types under feed. Accepts paging query parameters.

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

OK

-

404

Metric type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint POST /deprecated/feeds/{feedId}/metricTypes

Creates a new metric type under feed

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

Body

Required Description Data Type

Yes

-

MetricTypeBlueprint

Response

Status codes

Status Code Reason Response Model

201

Metric type successfully created

-

400

Invalid input data

ApiError

404

Tenant doesn’t exist

ApiError

409

Metric type already exists

ApiError

500

Server error

ApiError

Endpoint DELETE /deprecated/feeds/{feedId}/metricTypes/{metricTypeId}

Deletes a metric type under feed

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

metricTypeId

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

204

Metric type successfully deleted

-

400

Metric type cannot be deleted because of constraints on it

ApiError

404

Tenant or metric type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/feeds/{feedId}/metricTypes/{metricTypeId}

Retrieves a single metric type under feed

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

metricTypeId

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

OK

MetricType

404

Metric type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint PUT /deprecated/feeds/{feedId}/metricTypes/{metricTypeId}

Updates a metric type under feed

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

metricTypeId

Yes

-

string

-

-

Body

Required Description Data Type

Yes

-

MetricTypeUpdate

Response

Status codes

Status Code Reason Response Model

204

Metric type successfully updated

-

400

Invalid input data

ApiError

404

Tenant doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/feeds/{feedId}/metrics

Retrieves all metrics in a feed

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

OK

-

401

Unauthorized access

-

404

Tenant, environment or feed doesn’t exist

ApiError

500

Server error

ApiError

Endpoint POST /deprecated/feeds/{feedId}/metrics

Creates a new metric in given feed

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

Body

Required Description Data Type

Yes

-

MetricBlueprint

Response

Status codes

Status Code Reason Response Model

201

Metric created

-

400

Invalid inputs

ApiError

401

Unauthorized access

-

409

Metric already exists

ApiError

500

Server error

ApiError

Endpoint DELETE /deprecated/feeds/{feedId}/metrics/{metricId}

Deletes a metric

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

metricId

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

204

OK

-

400

The delete failed because it would make inventory invalid

-

404

Tenant, feed or the metric doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/feeds/{feedId}/metrics/{metricId}

Retrieves a single metric

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

metricId

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

OK

Metric

401

Unauthorized access

-

404

Environment, feed or metric doesn’t exist

ApiError

500

Server error

ApiError

Endpoint PUT /deprecated/feeds/{feedId}/metrics/{metricId}

Updates a metric

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

metricId

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

204

OK

-

400

The update failed because of invalid data

-

401

Unauthorized access

-

404

Tenant, feed or the metric doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/feeds/{feedId}/resourceTypes

Retrieves all metric types associated with the resource type. Accepts paging query params.

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

the list of metric types associated with the resource type

-

404

Tenant or resource type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint POST /deprecated/feeds/{feedId}/resourceTypes

Creates a new resource type

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

201

OK

-

400

Invalid input data

ApiError

404

Tenant doesn’t exist

ApiError

409

Resource type already exists

ApiError

500

Server error

ApiError

Endpoint DELETE /deprecated/feeds/{feedId}/resourceTypes/{resourceTypeId}

Deletes a resource type

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourceTypeId

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

204

OK

-

404

Tenant or resource type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/feeds/{feedId}/resourceTypes/{resourceTypeId}

Retrieves all metric types associated with the resource type. Accepts paging query params.

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourceTypeId

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

the list of metric types associated with the resource type

ResourceType

404

Tenant or resource type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint PUT /deprecated/feeds/{feedId}/resourceTypes/{resourceTypeId}

Update a resource type

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourceTypeId

Yes

-

string

-

-

Body

Required Description Data Type

Yes

-

ResourceTypeUpdate

Response

Status codes

Status Code Reason Response Model

204

OK

-

400

Invalid input data

ApiError

404

Resource type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint DELETE /deprecated/feeds/{feedId}/resourceTypes/{resourceTypeId}/data

Updates the configuration of a resource type

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourceTypeId

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

dataType

No

-

string

-

configurationSchema, connectionConfigurationSchema

Response

Status codes

Status Code Reason Response Model

204

OK

-

404

Tenant, environment, feed or resource type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/feeds/{feedId}/resourceTypes/{resourceTypeId}/data

Retrieves a single resource type

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourceTypeId

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

dataType

No

-

string

-

configurationSchema, connectionConfigurationSchema

Response

Status codes

Status Code Reason Response Model

200

the resource type

DataEntity

404

Tenant or resource type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint POST /deprecated/feeds/{feedId}/resourceTypes/{resourceTypeId}/data

Creates the configuration for pre-existing resource type

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourceTypeId

Yes

-

string

-

-

Body

Required Description Data Type

Yes

-

[DataEntityBlueprintResourceType]

Response

Status codes

Status Code Reason Response Model

204

OK Created

-

404

Tenant, environment, resource type or feed doesn’t exist

ApiError

500

Server error

ApiError

Endpoint PUT /deprecated/feeds/{feedId}/resourceTypes/{resourceTypeId}/data

Updates the configuration of a resource type

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourceTypeId

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

dataType

No

-

string

-

configurationSchema, connectionConfigurationSchema

Body

Required Description Data Type

Yes

-

DataEntityUpdate

Response

Status codes

Status Code Reason Response Model

204

OK

-

404

Tenant, environment, feed or resource type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/feeds/{feedId}/resourceTypes/{resourceTypeId}/metricTypes

Retrieves all metric types associated with the resource type. Accepts paging query params.

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourceTypeId

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

the list of metric types associated with the resource type

-

404

Tenant or resource type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint POST /deprecated/feeds/{feedId}/resourceTypes/{resourceTypeId}/metricTypes

Associates a pre-existing metric type with a resource type

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourceTypeId

Yes

-

string

-

-

Body

Required Description Data Type

No

A list of paths to metric types to be associated with the resource type. They can either be canonical or relative to the resource type.

array of string

Response

Status codes

Status Code Reason Response Model

204

OK

-

404

Tenant, resource type or metric type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint DELETE /deprecated/feeds/{feedId}/resourceTypes/{resourceTypeId}/metricTypes/{metricTypePath}

Disassociates the given resource type from the given metric type

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourceTypeId

Yes

-

string

-

-

metricTypePath

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

canonical

No

True if metric path should be considered canonical, false by default.

boolean

-

-

Response

Status codes

Status Code Reason Response Model

204

OK

-

404

Tenant or resource type does not exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/feeds/{feedId}/resourceTypes/{resourceTypeId}/metricTypes/{metricTypePath}

Retrieves the given metric type associated with the given resource type.

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourceTypeId

Yes

-

string

-

-

metricTypePath

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

canonical

No

True if metric type path should be considered canonical, false by default.

boolean

-

-

Response

Status codes

Status Code Reason Response Model

200

The list of metric types

MetricType

404

Tenant or resource type does not exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/feeds/{feedId}/resourceTypes/{resourceTypeId}/operationTypes

Retrieves operation types

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourceTypeId

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

the resource type

-

404

Tenant or resource type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint POST /deprecated/feeds/{feedId}/resourceTypes/{resourceTypeId}/operationTypes

Creates a new operation type under a pre-existing resource type

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourceTypeId

Yes

-

string

-

-

Body

Required Description Data Type

Yes

-

OperationTypeBlueprint

Response

Status codes

Status Code Reason Response Model

204

OK Created

-

404

Tenant, environment, resource type or feed doesn’t exist

ApiError

500

Server error

ApiError

Endpoint DELETE /deprecated/feeds/{feedId}/resourceTypes/{resourceTypeId}/operationTypes/{operationTypeId}

Updates the configuration of a resource type

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourceTypeId

Yes

-

string

-

-

operationTypeId

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

204

OK

-

404

Tenant, environment, feed or resource type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint PUT /deprecated/feeds/{feedId}/resourceTypes/{resourceTypeId}/operationTypes/{operationTypeId}

Updates the configuration of a resource type

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourceTypeId

Yes

-

string

-

-

operationTypeId

Yes

-

string

-

-

Body

Required Description Data Type

Yes

-

OperationTypeUpdate

Response

Status codes

Status Code Reason Response Model

204

OK

-

404

Tenant, environment, feed or resource type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint DELETE /deprecated/feeds/{feedId}/resourceTypes/{resourceTypeId}/operationTypes/{operationTypeId}/data

Updates the configuration of a resource type

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourceTypeId

Yes

-

string

-

-

operationTypeId

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

dataType

No

-

string

-

returnType, parameterTypes

Response

Status codes

Status Code Reason Response Model

204

OK

-

404

Tenant, environment, feed or resource type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/feeds/{feedId}/resourceTypes/{resourceTypeId}/operationTypes/{operationTypeId}/data

Retrieves a single resource type

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourceTypeId

Yes

-

string

-

-

operationTypeId

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

dataType

No

-

string

-

returnType, parameterTypes

Response

Status codes

Status Code Reason Response Model

200

the resource type

DataEntity

404

Tenant or resource type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint POST /deprecated/feeds/{feedId}/resourceTypes/{resourceTypeId}/operationTypes/{operationTypeId}/data

Creates the configuration for pre-existing resource type

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourceTypeId

Yes

-

string

-

-

operationTypeId

Yes

-

string

-

-

Body

Required Description Data Type

Yes

-

[DataEntityBlueprintOperationType]

Response

Status codes

Status Code Reason Response Model

204

OK Created

-

404

Tenant, environment, resource type or feed doesn’t exist

ApiError

500

Server error

ApiError

Endpoint PUT /deprecated/feeds/{feedId}/resourceTypes/{resourceTypeId}/operationTypes/{operationTypeId}/data

Updates the configuration of a resource type

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourceTypeId

Yes

-

string

-

-

operationTypeId

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

dataType

No

-

string

-

returnType, parameterTypes

Body

Required Description Data Type

Yes

-

DataEntityUpdate

Response

Status codes

Status Code Reason Response Model

204

OK

-

404

Tenant, environment, feed or resource type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/feeds/{feedId}/resourceTypes/{resourceTypeId}/resources

Retrieves all metric types associated with the resource type. Accepts paging query params.

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourceTypeId

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

the list of metric types associated with the resource type

-

404

Tenant or resource type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/feeds/{feedId}/resources

Retrieves resources in the feed, optionally filtering by resource type

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

OK

-

404

Tenant, environment or feed doesn’t exist

ApiError

500

Server error

ApiError

Endpoint POST /deprecated/feeds/{feedId}/resources

Creates a new resource

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

Body

Required Description Data Type

Yes

-

ResourceBlueprint

Response

Status codes

Status Code Reason Response Model

201

Resource successfully created

-

400

Invalid input data

ApiError

404

Tenant or feed doesn’t exist

ApiError

409

Resource already exists

ApiError

500

Server error

ApiError

Endpoint POST /deprecated/feeds/{feedId}/resources/{parentPath}

Creates a new resource

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

parentPath

Yes

-

string

-

-

Body

Required Description Data Type

Yes

-

ResourceBlueprint

Response

Status codes

Status Code Reason Response Model

201

Resource successfully created

-

400

Invalid input data

ApiError

404

Tenant or feed doesn’t exist

ApiError

409

Resource already exists

ApiError

500

Server error

ApiError

Endpoint DELETE /deprecated/feeds/{feedId}/resources/{resourcePath}

Retrieves a single resource

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourcePath

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

204

OK

-

404

Tenant, environment, feed or resource doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/feeds/{feedId}/resources/{resourcePath}

Retrieves a single resource

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourcePath

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

OK

Resource

404

Tenant, environment, feed or resource doesn’t exist

ApiError

500

Server error

ApiError

Endpoint PUT /deprecated/feeds/{feedId}/resources/{resourcePath}

Update a resource

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourcePath

Yes

-

string

-

-

Body

Required Description Data Type

Yes

-

ResourceUpdate

Response

Status codes

Status Code Reason Response Model

204

OK

-

400

Invalid input data

ApiError

404

Resource doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/feeds/{feedId}/resources/{resourcePath}/children

Retrieves child resources of a resource. This can be paged.

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourcePath

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

A list of child resources

-

404

environment or the parent resource not found

-

500

Internal server error

ApiError

Endpoint POST /deprecated/feeds/{feedId}/resources/{resourcePath}/children

Associates given resources as children of a given resource.

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourcePath

Yes

-

string

-

-

Body

Required Description Data Type

No

resources

array of string

Response

Status codes

Status Code Reason Response Model

204

OK

-

404

environment or the parent resource not found

-

500

Internal server error

ApiError

Endpoint DELETE /deprecated/feeds/{feedId}/resources/{resourcePath}/children/{childPath}

Disassociates given child resource from given resource. The the resource doesn’t own the child, the child will no longer be considered a child of the resource, otherwise an error will be returned.

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourcePath

Yes

-

string

-

-

childPath

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

canonical

No

-

boolean

-

-

Response

Status codes

Status Code Reason Response Model

204

OK

-

404

feed, the parent resource or the child resource not found

-

500

Internal server error

ApiError

Endpoint DELETE /deprecated/feeds/{feedId}/resources/{resourcePath}/data

Deletes the configuration of a resource

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourcePath

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

dataType

No

-

string

-

configuration, connectionConfiguration

Response

Status codes

Status Code Reason Response Model

204

OK

-

404

Tenant, environment, resource or feed doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/feeds/{feedId}/resources/{resourcePath}/data

Retrieves the configuration of a resource

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourcePath

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

dataType

No

-

string

-

configuration, connectionConfiguration

Response

Status codes

Status Code Reason Response Model

204

OK

-

404

Tenant, environment, resource or feed doesn’t exist

ApiError

500

Server error

ApiError

Endpoint POST /deprecated/feeds/{feedId}/resources/{resourcePath}/data

Creates the configuration for pre-existing resource

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourcePath

Yes

-

string

-

-

Body

Required Description Data Type

Yes

-

[DataEntityBlueprintResource]

Response

Status codes

Status Code Reason Response Model

204

OK Created

-

404

Tenant, environment, resource or feed doesn’t exist

ApiError

500

Server error

ApiError

Endpoint PUT /deprecated/feeds/{feedId}/resources/{resourcePath}/data

Updates the configuration of a resource

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourcePath

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

dataType

No

-

string

-

configuration, connectionConfiguration

Body

Required Description Data Type

Yes

-

DataEntityUpdate

Response

Status codes

Status Code Reason Response Model

204

OK

-

404

Tenant, environment, resource or feed doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/feeds/{feedId}/resources/{resourcePath}/metrics

Retrieves all metrics associated with a resource. Accepts paging query parameters.

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourcePath

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

The list of metrics

-

404

Tenant, environment, feed or resource doesn’t exist

ApiError

500

Server error

ApiError

Endpoint POST /deprecated/feeds/{feedId}/resources/{resourcePath}/metrics

Either creates a new metric owned by the resource or associates a pre-existing metric with the resource. This depends on what you pass as the the body of the request. A JSON array of strings is understood as a list of pre-existing metric paths that are associated with the resource. If the body is a JSON object or an array of JSON objects, the new metric or metrics are created "underneath" the resource.

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourcePath

Yes

-

string

-

-

Body

Required Description Data Type

No

This is either a metric blueprint or a list of paths to metrics to be associated with the resource. They can either be canonical or relative to the resource.

object

Response

Status codes

Status Code Reason Response Model

201

New metric created under the resource

-

204

Existing metric successfully associated

-

404

Tenant, environment, resource doesn’t exist. Also when an array of strings is supplied and one of the metrics in that array doesn’t exist.

ApiError

500

Server error

ApiError

Endpoint DELETE /deprecated/feeds/{feedId}/resources/{resourcePath}/metrics/{metricPath}

Disassociates the given resource from the given metric. If the metric is contained within the resource, it is also deleted.

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourcePath

Yes

-

string

-

-

metricPath

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

canonical

No

True if metric path should be considered canonical, false by default.

boolean

-

-

Response

Status codes

Status Code Reason Response Model

204

OK

-

404

Tenant, environment, feed, resource or metric does not exist or the metric is not associated with the resource

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/feeds/{feedId}/resources/{resourcePath}/metrics/{metricPath}

Retrieves a single resource

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourcePath

Yes

-

string

-

-

metricPath

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

canonical

No

True if metric path should be considered canonical, false by default.

boolean

-

-

Response

Status codes

Status Code Reason Response Model

200

The resource

-

404

Tenant, environment, feed, resource or metric doesn’t exist or if the metric is not associated with the resource

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/feeds/{feedId}/resources/{resourcePath}/parent

Retrieves the parent resources that contains the given resource. Such parent resource will not exist for resources directly contained in an environment or a feed.

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourcePath

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

A list of child resources

Resource

404

environment, feed or the resource not found

-

500

Internal server error

ApiError

Endpoint GET /deprecated/feeds/{feedId}/resources/{resourcePath}/parents

Retrieves parent resources of a resource. This can be paged.

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourcePath

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

A list of child resources

-

404

environment or the parent resource not found

-

500

Internal server error

ApiError

Endpoint GET /deprecated/feeds/{feedId}/resources/{resourcePath}/recursiveChildren

Recursively retrieves child resources of a resource of given type. Can be paged.

Path parameters

Parameter Required Description Type Format Allowable Values

feedId

Yes

-

string

-

-

resourcePath

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

typeId

No

-

string

-

-

feedlessType

No

-

boolean

-

-

Response

Status codes

Status Code Reason Response Model

200

A list of child resources

-

404

environment or the parent resource not found

-

500

Internal server error

ApiError

Endpoint GET /deprecated/metadatapacks

Retrieves all metadata packs.

Response

Status codes

Status Code Reason Response Model

200

OK

Feed

401

Unauthorized access

-

500

Server error

ApiError

Endpoint POST /deprecated/metadatapacks

Create a metadata pack

Body

Required Description Data Type

Yes

-

MetadataPackBlueprint

Response

Status codes

Status Code Reason Response Model

default

successful operation

-

Endpoint DELETE /deprecated/metadatapacks/{id}

Deletes a metadata pack.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

default

successful operation

-

Endpoint GET /deprecated/metadatapacks/{id}

Get a single metadata pack by id.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

successful operation

MetadataPack

Endpoint PUT /deprecated/metadatapacks/{id}

Update a metadata pack.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Body

Required Description Data Type

Yes

-

MetadataPackUpdate

Response

Status codes

Status Code Reason Response Model

default

successful operation

-

Endpoint GET /deprecated/metadatapacks/{id}/metricTypes

Retrieve all the metric types of the metadata pack.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

default

successful operation

-

Endpoint GET /deprecated/metadatapacks/{id}/resourceTypes

Retrieve all the resource types of the metadata pack.

Path parameters

Parameter Required Description Type Format Allowable Values

id

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

default

successful operation

-

Endpoint GET /deprecated/metricTypes

Retrieves all metric types. Accepts paging query parameters

Query parameters

Parameter Required Description Type Format Allowable Values

feedless

No

-

boolean

-

-

Response

Status codes

Status Code Reason Response Model

200

OK

-

500

Server error

ApiError

Endpoint POST /deprecated/metricTypes

Creates a new metric type

Body

Required Description Data Type

Yes

-

MetricTypeBlueprint

Response

Status codes

Status Code Reason Response Model

201

Metric type successfully created

-

400

Invalid input data

ApiError

404

Tenant doesn’t exist

ApiError

409

Metric type already exists

ApiError

500

Server error

ApiError

Endpoint DELETE /deprecated/metricTypes/{metricTypeId}

Deletes a metric type

Path parameters

Parameter Required Description Type Format Allowable Values

metricTypeId

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

204

Metric type successfully deleted

-

400

Metric type cannot be deleted because of constraints on it

ApiError

404

Tenant or metric type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/metricTypes/{metricTypeId}

Retrieves a single metric type

Path parameters

Parameter Required Description Type Format Allowable Values

metricTypeId

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

OK

MetricType

404

Metric type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint PUT /deprecated/metricTypes/{metricTypeId}

Updates a metric type

Path parameters

Parameter Required Description Type Format Allowable Values

metricTypeId

Yes

-

string

-

-

Body

Required Description Data Type

Yes

-

MetricTypeUpdate

Response

Status codes

Status Code Reason Response Model

204

Metric type successfully updated

-

400

Invalid input data

ApiError

404

Tenant doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/path/{entityPath}

Return an entity with the provided canonical path

Path parameters

Parameter Required Description Type Format Allowable Values

entityPath

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

The entity

Entity

401

Unauthorized access

-

404

The entity doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/path/{entityPath}/relationships

Return an entity with the provided canonical path

Path parameters

Parameter Required Description Type Format Allowable Values

entityPath

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

direction

No

-

string

-

-

property

No

-

string

-

-

propertyValue

No

-

string

-

-

named

No

-

string

-

-

sourceType

No

-

string

-

-

targetType

No

-

string

-

-

jsonld

No

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

The entity

Entity

401

Unauthorized access

-

404

The entity doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/ping

A dummy operation returning the current date on the server.

Response

Status codes

Status Code Reason Response Model

default

successful operation

-

Endpoint GET /deprecated/relationships/{relationshipId}

Retrieves relationship info

Path parameters

Parameter Required Description Type Format Allowable Values

relationshipId

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

jsonld

No

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

The details of relationship

-

404

Accompanying entity doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/resourceTypes

Retrieves all resource types. Accepts paging query parameters.

Query parameters

Parameter Required Description Type Format Allowable Values

feedless

No

-

boolean

-

-

Response

Status codes

Status Code Reason Response Model

200

the list of resource types

-

404

Tenant doesn’t exist

ApiError

500

Server error

ApiError

Endpoint POST /deprecated/resourceTypes

Creates a new resource type

Response

Status codes

Status Code Reason Response Model

201

OK

-

400

Invalid input data

ApiError

404

Tenant doesn’t exist

ApiError

409

Resource type already exists

ApiError

500

Server error

ApiError

Endpoint DELETE /deprecated/resourceTypes/{resourceTypeId}

Deletes a resource type

Path parameters

Parameter Required Description Type Format Allowable Values

resourceTypeId

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

204

OK

-

404

Tenant or resource type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/resourceTypes/{resourceTypeId}

Retrieves a single resource type

Path parameters

Parameter Required Description Type Format Allowable Values

resourceTypeId

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

the resource type

ResourceType

404

Tenant or resource type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint PUT /deprecated/resourceTypes/{resourceTypeId}

Update a resource type

Path parameters

Parameter Required Description Type Format Allowable Values

resourceTypeId

Yes

-

string

-

-

Body

Required Description Data Type

Yes

-

ResourceTypeUpdate

Response

Status codes

Status Code Reason Response Model

204

OK

-

400

Invalid input data

ApiError

404

Resource type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint DELETE /deprecated/resourceTypes/{resourceTypeId}/data

Updates the configuration of a resource type

Path parameters

Parameter Required Description Type Format Allowable Values

resourceTypeId

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

dataType

No

-

string

-

configurationSchema, connectionConfigurationSchema

Response

Status codes

Status Code Reason Response Model

204

OK

-

404

Tenant, or resource type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/resourceTypes/{resourceTypeId}/data

Retrieves a single resource type

Path parameters

Parameter Required Description Type Format Allowable Values

resourceTypeId

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

dataType

No

-

string

-

configurationSchema, connectionConfigurationSchema

Response

Status codes

Status Code Reason Response Model

200

the resource type

DataEntity

404

Tenant or resource type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint POST /deprecated/resourceTypes/{resourceTypeId}/data

Creates the configuration for pre-existing resource type

Path parameters

Parameter Required Description Type Format Allowable Values

resourceTypeId

Yes

-

string

-

-

Body

Required Description Data Type

Yes

-

[DataEntityBlueprintResourceType]

Response

Status codes

Status Code Reason Response Model

204

OK Created

-

404

Tenant or resource type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint PUT /deprecated/resourceTypes/{resourceTypeId}/data

Updates the configuration of a resource type

Path parameters

Parameter Required Description Type Format Allowable Values

resourceTypeId

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

dataType

No

-

string

-

configurationSchema, connectionConfigurationSchema

Body

Required Description Data Type

Yes

-

DataEntityUpdate

Response

Status codes

Status Code Reason Response Model

204

OK

-

404

Tenant, or resource type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/resourceTypes/{resourceTypeId}/metricTypes

Retrieves all metric types associated with the resource type. Accepts paging query params.

Path parameters

Parameter Required Description Type Format Allowable Values

resourceTypeId

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

the list of metric types associated with the resource type

-

404

Tenant or resource type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint POST /deprecated/resourceTypes/{resourceTypeId}/metricTypes

Associates a pre-existing metric type with a resource type

Path parameters

Parameter Required Description Type Format Allowable Values

resourceTypeId

Yes

-

string

-

-

Body

Required Description Data Type

No

A list of paths to metric types to be associated with the resource type. They can either be canonical or relative to the resource type.

array of string

Response

Status codes

Status Code Reason Response Model

204

OK

-

404

Tenant, resource type or metric type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint DELETE /deprecated/resourceTypes/{resourceTypeId}/metricTypes/{metricTypePath}

Disassociates the given resource type from the given metric type

Path parameters

Parameter Required Description Type Format Allowable Values

resourceTypeId

Yes

-

string

-

-

metricTypePath

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

canonical

No

True if metric path should be considered canonical, false by default.

boolean

-

-

Response

Status codes

Status Code Reason Response Model

204

OK

-

404

Tenant or resource type does not exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/resourceTypes/{resourceTypeId}/metricTypes/{metricTypePath}

Retrieves the given metric type associated with the given resource type.

Path parameters

Parameter Required Description Type Format Allowable Values

resourceTypeId

Yes

-

string

-

-

metricTypePath

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

canonical

No

True if metric type path should be considered canonical, false by default.

boolean

-

-

Response

Status codes

Status Code Reason Response Model

200

The list of metric types

MetricType

404

Tenant or resource type does not exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/resourceTypes/{resourceTypeId}/operationTypes

Retrieves operation types

Path parameters

Parameter Required Description Type Format Allowable Values

resourceTypeId

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

the resource type

-

404

Tenant or resource type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint POST /deprecated/resourceTypes/{resourceTypeId}/operationTypes

Creates a new operation type under a pre-existing resource type

Path parameters

Parameter Required Description Type Format Allowable Values

resourceTypeId

Yes

-

string

-

-

Body

Required Description Data Type

Yes

-

OperationTypeBlueprint

Response

Status codes

Status Code Reason Response Model

204

OK Created

-

404

Tenant or resource type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint DELETE /deprecated/resourceTypes/{resourceTypeId}/operationTypes/{operationTypeId}

Deletes the operation type

Path parameters

Parameter Required Description Type Format Allowable Values

resourceTypeId

Yes

-

string

-

-

operationTypeId

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

204

OK

-

404

Tenant, or resource type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/resourceTypes/{resourceTypeId}/operationTypes/{operationTypeId}

Retrieves the operation type

Path parameters

Parameter Required Description Type Format Allowable Values

resourceTypeId

Yes

-

string

-

-

operationTypeId

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

the resource type

OperationType

404

Tenant or resource type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint PUT /deprecated/resourceTypes/{resourceTypeId}/operationTypes/{operationTypeId}

Updates the operation type

Path parameters

Parameter Required Description Type Format Allowable Values

resourceTypeId

Yes

-

string

-

-

operationTypeId

Yes

-

string

-

-

Body

Required Description Data Type

Yes

-

OperationTypeUpdate

Response

Status codes

Status Code Reason Response Model

204

OK

-

404

Tenant, or resource type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint DELETE /deprecated/resourceTypes/{resourceTypeId}/operationTypes/{operationTypeId}/data

Updates the configuration of a resource type

Path parameters

Parameter Required Description Type Format Allowable Values

resourceTypeId

Yes

-

string

-

-

operationTypeId

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

dataType

No

-

string

-

returnType, parameterTypes

Response

Status codes

Status Code Reason Response Model

204

OK

-

404

Tenant, or resource type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/resourceTypes/{resourceTypeId}/operationTypes/{operationTypeId}/data

Retrieves a single resource type

Path parameters

Parameter Required Description Type Format Allowable Values

resourceTypeId

Yes

-

string

-

-

operationTypeId

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

dataType

No

-

string

-

returnType, parameterTypes

Response

Status codes

Status Code Reason Response Model

200

the resource type

DataEntity

404

Tenant or resource type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint POST /deprecated/resourceTypes/{resourceTypeId}/operationTypes/{operationTypeId}/data

Creates the configuration for pre-existing resource type

Path parameters

Parameter Required Description Type Format Allowable Values

resourceTypeId

Yes

-

string

-

-

operationTypeId

Yes

-

string

-

-

Body

Required Description Data Type

Yes

-

[DataEntityBlueprintOperationType]

Response

Status codes

Status Code Reason Response Model

204

OK Created

-

404

Tenant or resource type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint PUT /deprecated/resourceTypes/{resourceTypeId}/operationTypes/{operationTypeId}/data

Updates the configuration of a resource type

Path parameters

Parameter Required Description Type Format Allowable Values

resourceTypeId

Yes

-

string

-

-

operationTypeId

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

dataType

No

-

string

-

returnType, parameterTypes

Body

Required Description Data Type

Yes

-

DataEntityUpdate

Response

Status codes

Status Code Reason Response Model

204

OK

-

404

Tenant, or resource type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/resourceTypes/{resourceTypeId}/resources

Retrieves all resources with given resource types. Accepts paging query parameters.

Path parameters

Parameter Required Description Type Format Allowable Values

resourceTypeId

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

the list of resources

-

404

Tenant or resource type doesn’t exist

ApiError

500

Server error

ApiError

Endpoint POST /deprecated/sync/{path}

Make the inventory under given path match the provided inventory structure. Note that the relationships specified in the provided entities will be ignored and will not be applied.

Path parameters

Parameter Required Description Type Format Allowable Values

path

Yes

-

array

-

-

Response

Status codes

Status Code Reason Response Model

204

Synchronization success

-

400

If the entity to be synchronized doesn’t support synchronization

ApiError

404

Authorization problem

ApiError

500

Internal server error

ApiError

Endpoint DELETE /deprecated/tenant

Deletes the tenant and all its data. Be careful!

Response

Status codes

Status Code Reason Response Model

204

OK

-

401

Unauthorized access

-

404

Tenant doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/tenant

Retrieves the tenant of the currently logged in persona

Response

Status codes

Status Code Reason Response Model

200

OK

-

401

Unauthorized access

-

404

Tenant doesn’t exist

ApiError

500

Server error

ApiError

Endpoint PUT /deprecated/tenant

Updates properties of the current tenant

Body

Required Description Data Type

Yes

-

TenantUpdate

Response

Status codes

Status Code Reason Response Model

204

OK

-

400

Invalid input data

ApiError

401

Unauthorized access

-

404

Tenant doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/tenant/relationships

Retrieves tenant’s relationships

Query parameters

Parameter Required Description Type Format Allowable Values

direction

No

-

string

-

-

property

No

-

string

-

-

propertyValue

No

-

string

-

-

named

No

-

string

-

-

sourceType

No

-

string

-

-

targetType

No

-

string

-

-

jsonld

No

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

OK

-

401

Unauthorized access

-

404

Tenant doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/{environmentId}/feeds

Retrieves all feeds associated with an environment. Accepts paging query parameters.

Path parameters

Parameter Required Description Type Format Allowable Values

environmentId

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

The list of feeds

-

404

Tenant or environment doesn’t exist

ApiError

500

Server error

ApiError

Endpoint POST /deprecated/{environmentId}/feeds

Associates a pre-existing feed with an environment

Path parameters

Parameter Required Description Type Format Allowable Values

environmentId

Yes

-

string

-

-

Body

Required Description Data Type

No

A list of paths to feeds to be associated with the environment. They can either be canonical or relative to the environment.

array of string

Response

Status codes

Status Code Reason Response Model

204

OK

-

400

Feed is already associated with another environment

ApiError

404

Tenant, environment or one of the feeds doesn’t exist

ApiError

500

Server error

ApiError

Endpoint DELETE /deprecated/{environmentId}/feeds/{feedPath}

Disassociates the given resource from the given metric

Path parameters

Parameter Required Description Type Format Allowable Values

environmentId

Yes

-

string

-

-

feedPath

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

canonical

No

True if metric path should be considered canonical, false by default.

boolean

-

-

Response

Status codes

Status Code Reason Response Model

204

OK

-

404

Tenant, environment, resource or metric does not exist or the metric is not associated with the resource

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/{environmentId}/feeds/{feedPath}

Retrieves a single feed associated with an environment

Path parameters

Parameter Required Description Type Format Allowable Values

environmentId

Yes

-

string

-

-

feedPath

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

canonical

No

True if feed path should be considered canonical, false by default.

boolean

-

-

Response

Status codes

Status Code Reason Response Model

200

The feed

-

404

Tenant, environment or feed does not exist or the feed is not associated with the environment

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/{environmentId}/metrics

Retrieves all metrics in an environment. Accepts paging query parameters.

Path parameters

Parameter Required Description Type Format Allowable Values

environmentId

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

feedless

No

-

boolean

-

-

Response

Status codes

Status Code Reason Response Model

200

OK

-

401

Unauthorized access

-

404

Tenant or environment doesn’t exist

ApiError

500

Server error

ApiError

Endpoint POST /deprecated/{environmentId}/metrics

Creates a new metric in given environment

Path parameters

Parameter Required Description Type Format Allowable Values

environmentId

Yes

-

string

-

-

Body

Required Description Data Type

Yes

-

MetricBlueprint

Response

Status codes

Status Code Reason Response Model

201

Metric created

-

400

Invalid inputs

ApiError

401

Unauthorized access

-

409

Metric already exists

ApiError

500

Server error

ApiError

Endpoint DELETE /deprecated/{environmentId}/metrics/{metricId}

Deletes a metric

Path parameters

Parameter Required Description Type Format Allowable Values

environmentId

Yes

-

string

-

-

metricId

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

204

OK

-

400

The delete failed because it would make inventory invalid

-

401

Unauthorized access

-

404

Tenant, environment or the metric doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/{environmentId}/metrics/{metricId}

Retrieves a single metric

Path parameters

Parameter Required Description Type Format Allowable Values

environmentId

Yes

-

string

-

-

metricId

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

OK

Metric

401

Unauthorized access

-

404

Rnvironment or metrics doesn’t exist

ApiError

500

Server error

ApiError

Endpoint PUT /deprecated/{environmentId}/metrics/{metricId}

Updates a metric

Path parameters

Parameter Required Description Type Format Allowable Values

environmentId

Yes

-

string

-

-

metricId

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

204

OK

-

400

The update failed because of invalid data

-

401

Unauthorized access

-

404

Tenant, environment or the metric doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/{environmentId}/resources

Retrieves resources in the environment, optionally filtering by resource type. Accepts paging query parameters.

Path parameters

Parameter Required Description Type Format Allowable Values

environmentId

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

type

No

-

string

-

-

feedless

No

-

boolean

-

-

Response

Status codes

Status Code Reason Response Model

200

OK

-

404

Tenant or environment doesn’t exist

ApiError

500

Server error

ApiError

Endpoint POST /deprecated/{environmentId}/resources

Creates a new resource

Path parameters

Parameter Required Description Type Format Allowable Values

environmentId

Yes

-

string

-

-

Body

Required Description Data Type

Yes

-

ResourceBlueprint

Response

Status codes

Status Code Reason Response Model

201

Resource successfully created

-

400

Invalid input data

ApiError

404

Tenant or environment doesn’t exist

ApiError

409

Resource already exists

ApiError

500

Server error

ApiError

Endpoint POST /deprecated/{environmentId}/resources/{parentPath}

Creates a new resource

Path parameters

Parameter Required Description Type Format Allowable Values

environmentId

Yes

-

string

-

-

parentPath

Yes

-

string

-

-

Body

Required Description Data Type

Yes

-

ResourceBlueprint

Response

Status codes

Status Code Reason Response Model

201

Resource successfully created

-

400

Invalid input data

ApiError

404

Tenant or environment doesn’t exist

ApiError

409

Resource already exists

ApiError

500

Server error

ApiError

Endpoint DELETE /deprecated/{environmentId}/resources/{resourcePath}

Deletes a single resource

Path parameters

Parameter Required Description Type Format Allowable Values

environmentId

Yes

-

string

-

-

resourcePath

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

204

OK

-

404

Tenant, environment or resource doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/{environmentId}/resources/{resourcePath}

Retrieves a single resource

Path parameters

Parameter Required Description Type Format Allowable Values

environmentId

Yes

-

string

-

-

resourcePath

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

OK

Resource

404

Tenant, environment or resource doesn’t exist

ApiError

500

Server error

ApiError

Endpoint PUT /deprecated/{environmentId}/resources/{resourcePath}

Update a resource

Path parameters

Parameter Required Description Type Format Allowable Values

environmentId

Yes

-

string

-

-

resourcePath

Yes

-

string

-

-

Body

Required Description Data Type

Yes

-

ResourceUpdate

Response

Status codes

Status Code Reason Response Model

204

OK

-

400

Invalid input data

ApiError

404

Resource doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/{environmentId}/resources/{resourcePath}/children

Retrieves child resources of a resource. This can be paged.

Path parameters

Parameter Required Description Type Format Allowable Values

environmentId

Yes

-

string

-

-

resourcePath

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

A list of child resources

-

404

environment or the parent resource not found

-

500

Internal server error

ApiError

Endpoint POST /deprecated/{environmentId}/resources/{resourcePath}/children

Associates given resources as children of a given resource.

Path parameters

Parameter Required Description Type Format Allowable Values

environmentId

Yes

-

string

-

-

resourcePath

Yes

-

string

-

-

Body

Required Description Data Type

No

resources

array of string

Response

Status codes

Status Code Reason Response Model

204

OK

-

404

environment or the parent resource not found

-

500

Internal server error

ApiError

Endpoint DELETE /deprecated/{environmentId}/resources/{resourcePath}/children/{childPath}

Disassociates given child resource from given resource. The the resource doesn’t own the child, the child will no longer be considered a child of the resource, otherwise an error will be returned.

Path parameters

Parameter Required Description Type Format Allowable Values

environmentId

Yes

-

string

-

-

resourcePath

Yes

-

string

-

-

childPath

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

canonical

No

-

boolean

-

-

Response

Status codes

Status Code Reason Response Model

204

OK

-

404

environment, the parent resource or the child resource not found

ApiError

500

Internal server error

ApiError

Endpoint DELETE /deprecated/{environmentId}/resources/{resourcePath}/data

Deletes the configuration of a resource

Path parameters

Parameter Required Description Type Format Allowable Values

environmentId

Yes

-

string

-

-

resourcePath

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

dataType

No

-

string

-

configuration, connectionConfiguration

Response

Status codes

Status Code Reason Response Model

204

OK

-

404

Tenant, environment or resource doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/{environmentId}/resources/{resourcePath}/data

Retrieves the configuration of a resource

Path parameters

Parameter Required Description Type Format Allowable Values

environmentId

Yes

-

string

-

-

resourcePath

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

dataType

No

-

string

-

configuration, connectionConfiguration

Response

Status codes

Status Code Reason Response Model

204

OK

-

404

Tenant, environment or resource doesn’t exist

ApiError

500

Server error

ApiError

Endpoint POST /deprecated/{environmentId}/resources/{resourcePath}/data

Creates the configuration for pre-existing resource

Path parameters

Parameter Required Description Type Format Allowable Values

environmentId

Yes

-

string

-

-

resourcePath

Yes

-

string

-

-

Body

Required Description Data Type

Yes

-

[DataEntityBlueprintResource]

Response

Status codes

Status Code Reason Response Model

204

OK Created

-

404

Tenant, environment or resource doesn’t exist

ApiError

500

Server error

ApiError

Endpoint PUT /deprecated/{environmentId}/resources/{resourcePath}/data

Updates the configuration of a resource

Path parameters

Parameter Required Description Type Format Allowable Values

environmentId

Yes

-

string

-

-

resourcePath

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

dataType

No

-

string

-

configuration, connectionConfiguration

Body

Required Description Data Type

Yes

-

DataEntityUpdate

Response

Status codes

Status Code Reason Response Model

204

OK

-

404

Tenant, environment or resource doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/{environmentId}/resources/{resourcePath}/metrics

Retrieves all metrics associated with a resource. Accepts paging query parameters.

Path parameters

Parameter Required Description Type Format Allowable Values

environmentId

Yes

-

string

-

-

resourcePath

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

The list of metrics

-

404

Tenant, environment or resource doesn’t exist

ApiError

500

Server error

ApiError

Endpoint POST /deprecated/{environmentId}/resources/{resourcePath}/metrics

Either creates a new metric owned by the resource or associates a pre-existing metric with the resource. This depends on what you pass as the the body of the request. A JSON array of strings is understood as a list of pre-existing metric paths that are associated with the resource. If the body is a JSON object or an array of JSON objects, the new metric or metrics are created "underneath" the resource.

Path parameters

Parameter Required Description Type Format Allowable Values

environmentId

Yes

-

string

-

-

resourcePath

Yes

-

string

-

-

Body

Required Description Data Type

No

This is either a metric blueprint or a list of paths to metrics to be associated with the resource. They can either be canonical or relative to the resource.

object

Response

Status codes

Status Code Reason Response Model

201

New metric created under the resource

-

204

Existing metric successfully associated

-

404

Tenant, environment, resource doesn’t exist. Also when an array of strings is supplied and one of the metrics in that array doesn’t exist.

ApiError

500

Server error

ApiError

Endpoint DELETE /deprecated/{environmentId}/resources/{resourcePath}/metrics/{metricPath}

Disassociates the given resource from the given metric. If the metric is contained within the resource, it is also deleted.

Path parameters

Parameter Required Description Type Format Allowable Values

environmentId

Yes

-

string

-

-

resourcePath

Yes

-

string

-

-

metricPath

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

canonical

No

True if metric path should be considered canonical, false by default.

boolean

-

-

Response

Status codes

Status Code Reason Response Model

204

OK

-

404

Tenant, environment, resource or metric does not exist or the metric is not associated with the resource

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/{environmentId}/resources/{resourcePath}/metrics/{metricPath}

Retrieves a single metric associated with a resource

Path parameters

Parameter Required Description Type Format Allowable Values

environmentId

Yes

-

string

-

-

resourcePath

Yes

-

string

-

-

metricPath

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

canonical

No

True if metric path should be considered canonical, false by default.

boolean

-

-

Response

Status codes

Status Code Reason Response Model

200

The resource

-

404

Tenant, environment, resource or metric does not exist or the metric is not associated with the resource

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/{environmentId}/resources/{resourcePath}/parent

Retrieves the parent resources that contains the given resource. Such parent resource will not exist for resources directly contained in an environment or a feed.

Path parameters

Parameter Required Description Type Format Allowable Values

environmentId

Yes

-

string

-

-

resourcePath

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

A list of child resources

Resource

404

environment or the resource not found

-

500

Internal server error

ApiError

Endpoint GET /deprecated/{environmentId}/resources/{resourcePath}/parents

Retrieves parents resources of the resource. This can be paged.

Path parameters

Parameter Required Description Type Format Allowable Values

environmentId

Yes

-

string

-

-

resourcePath

Yes

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

A list of child resources

-

404

environment or the parent resource not found

-

500

Internal server error

ApiError

Endpoint GET /deprecated/{environmentId}/resources/{resourcePath}/recursiveChildren

Recursively retrieves child resources of a resource of given type. Can be paged.

Path parameters

Parameter Required Description Type Format Allowable Values

environmentId

Yes

-

string

-

-

resourcePath

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

typeId

No

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

A list of child resources

-

404

environment or the parent resource not found

-

500

Internal server error

ApiError

Endpoint DELETE /deprecated/{path}/relationships

Deletes a relationship

Path parameters

Parameter Required Description Type Format Allowable Values

path

Yes

-

string

-

-

Body

Required Description Data Type

Yes

-

Relationship

Response

Status codes

Status Code Reason Response Model

200

The list of relationships

-

404

Accompanying entity doesn’t exist

ApiError

500

Server error

ApiError

Endpoint GET /deprecated/{path}/relationships

Retrieves relationships

Path parameters

Parameter Required Description Type Format Allowable Values

path

Yes

-

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

direction

No

-

string

-

-

property

No

-

string

-

-

propertyValue

No

-

string

-

-

named

No

-

string

-

-

sourceType

No

-

string

-

-

targetType

No

-

string

-

-

jsonld

No

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

The list of relationships

-

404

Accompanying entity doesn’t exist

ApiError

500

Server error

ApiError

Endpoint POST /deprecated/{path}/relationships

Creates a relationship

Path parameters

Parameter Required Description Type Format Allowable Values

path

Yes

-

string

-

-

Body

Required Description Data Type

Yes

-

Relationship

Response

Status codes

Status Code Reason Response Model

201

OK

-

400

Invalid input data

ApiError

404

Accompanying entity doesn’t exist

ApiError

409

Relationship already exists

ApiError

500

Server error

ApiError

Endpoint PUT /deprecated/{path}/relationships

Updates a relationship

Path parameters

Parameter Required Description Type Format Allowable Values

path

Yes

-

string

-

-

Body

Required Description Data Type

Yes

-

Relationship

Response

Status codes

Status Code Reason Response Model

204

OK

-

400

Invalid input data

ApiError

404

Accompanying entity doesn’t exist

ApiError

500

Server error

ApiError

Entity Graph Traversal

  1. Retrieves a list of entities

Endpoint GET /traversal/{traversal}

Retrieves a list of entities
Given the traversal of inventory expressed in the URL, this will return a (possibly empty) list of entities that the traversal found. The results can be paged. See above for a thorough description of the format of the URL. The type of the returned elements is determined by the URL.

Path parameters

Parameter Required Description Type Format Allowable Values

traversal

Yes

See the documentation above for the format of the traversal.

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

at

No

Look at the entities and relationships as they existed at the provided time. Either a Unix epoch timestamp in milliseconds, or an ISO-8601 formatted date and time in UTC timezone.

null

-

-

Response

Status codes

Status Code Reason Response Model

200

Traversal finished successfully.

AbstractElement

Events

  1. Listen on stream of the events

Endpoint GET /events

Listen on stream of the events

Query parameters

Parameter Required Description Type Format Allowable Values

type

No

-

string

-

-

action

No

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

OK

-

401

Unauthorized access

-

404

Tenant doesn’t exist

ApiError

500

Server error

ApiError

Events

  1. Listen on stream of the events

Endpoint GET /events

Listen on stream of the events

Query parameters

Parameter Required Description Type Format Allowable Values

type

No

-

string

-

-

action

No

-

string

-

-

Response

Status codes

Status Code Reason Response Model

200

OK

-

401

Unauthorized access

-

404

Tenant doesn’t exist

ApiError

500

Server error

ApiError

Graph

  1. Gets the graph.

Endpoint GET /graph

Gets the graph.

Response

Status codes

Status Code Reason Response Model

200

OK

-

401

Unauthorized access

-

404

Tenant doesn’t exist

ApiError

500

Server error

ApiError

Graph

  1. Gets the graph.

Endpoint GET /graph

Gets the graph.

Response

Status codes

Status Code Reason Response Model

200

OK

-

401

Unauthorized access

-

404

Tenant doesn’t exist

ApiError

500

Server error

ApiError

Single Entity

  1. Deletes an inventory entity on the given location.

  2. Reads an inventory entity on the given location.

  3. Updates an entity. The path is actually a canonical path. The format of the accepted JSON object is governed by the type of the entity being updated. If you’re updating an environment, look for EnvironmentUpdate type, etc.

  4. Obtains the history of the entity.

  5. Obtains the identity tree hash of the entity.

  6. Creates a new entity

Endpoint DELETE /entity/{path}

Deletes an inventory entity on the given location.

Path parameters

Parameter Required Description Type Format Allowable Values

path

Yes

See the documentation above for the format of the path.

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

at

No

Specifies the time to mark the entity as having been deleted. Either a Unix epoch timestamp in milliseconds, or an ISO-8601 formatted date and time in UTC timezone.

null

-

-

Response

Status codes

Status Code Reason Response Model

204

Entity deleted.

-

400

There has been an update to the entity since the time it is requested to be deleted.

-

404

No entity found on given traversal URI.

-

500

Internal server error

-

Endpoint GET /entity/{path}

Reads an inventory entity on the given location.

Path parameters

Parameter Required Description Type Format Allowable Values

path

Yes

See the documentation above for the format of the path.

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

at

No

Look at the entity as it looked at the provided time. Either a Unix epoch timestamp in milliseconds, or an ISO-8601 formatted date and time in UTC timezone.

null

-

-

Response

Status codes

Status Code Reason Response Model

200

A single entity found and returned.

AbstractElement

404

No entity found on given path.

-

500

Internal server error

-

Endpoint PUT /entity/{path}

Updates an entity. The path is actually a canonical path. The format of the accepted JSON object is governed by the type of the entity being updated. If you’re updating an environment, look for EnvironmentUpdate type, etc.

Path parameters

Parameter Required Description Type Format Allowable Values

path

Yes

See the documentation above for the format of the path.

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

at

No

Specifies the time to mark the entity as having been updated. Either a Unix epoch timestamp in milliseconds, or an ISO-8601 formatted date and time in UTC timezone.

null

-

-

Body

Required Description Data Type

Yes

-

AbstractElementUpdate

Response

Status codes

Status Code Reason Response Model

204

Entity updated.

-

400

Data in wrong format or update requested at a time, after which the entity was already changed

-

403

Unauthorized access

-

404

Entity not found.

-

500

Server error.

-

Endpoint GET /entity/{path}/history

Obtains the history of the entity.

Path parameters

Parameter Required Description Type Format Allowable Values

path

Yes

See the documentation above for the format of the path.

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

from

No

Either a Unix epoch timestamp in milliseconds, or an ISO-8601 formatted date and time in UTC timezone.

null

-

-

to

No

Either a Unix epoch timestamp in milliseconds, or an ISO-8601 formatted date and time in UTC timezone.

null

-

-

Response

Status codes

Status Code Reason Response Model

200

History returned.

History

404

No entity found on given traversal URI.

-

500

Internal server error

-

Endpoint GET /entity/{path}/treeHash

Obtains the identity tree hash of the entity.

Path parameters

Parameter Required Description Type Format Allowable Values

path

Yes

See the documentation above for the format of the path.

string

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

at

No

Look at the entity as it looked at the provided time. Either a Unix epoch timestamp in milliseconds, or an ISO-8601 formatted date and time in UTC timezone.

null

-

-

Response

Status codes

Status Code Reason Response Model

200

Tree hash returned.

IdentityHashTree

400

The entity doesn’t support identity hashing.

-

404

No entity found on given traversal URI.

-

500

Internal server error

-

Endpoint POST /entity/{path}/{type}

Creates a new entity
As all POSTs, this can also accept an array of blueprints to create more than 1 entity at a time.

Path parameters

Parameter Required Description Type Format Allowable Values

path

Yes

See the documentation above for the format of the path.

string

-

-

type

Yes

The type is either a camel-cased full name of the entity type or its short identifier as used in canonical path.

string

-

environment, e, resourceType, rt, metricType, mt, operationType, ot, metadataPack, mp, feed, f, resource, r, metric, m, data, d

Query parameters

Parameter Required Description Type Format Allowable Values

at

No

Specifies the time to mark the entity as having been created at. Either a Unix epoch timestamp in milliseconds, or an ISO-8601 formatted date and time in UTC timezone.

null

-

-

Body

Required Description Data Type

Yes

-

AbstractElementBlueprint

Response

Status codes

Status Code Reason Response Model

201

Entity(ies) created.

AbstractElement

400

Data in wrong format

-

403

Unauthorized access

-

404

One of the related entities doesn’t exist.

-

500

Server error.

-

Sync

  1. Make the inventory under given path match the provided inventory structure. Note that the relationships specified in the provided entities will be ignored and will not be applied.

Endpoint POST /sync/{path}

Make the inventory under given path match the provided inventory structure. Note that the relationships specified in the provided entities will be ignored and will not be applied.

Path parameters

Parameter Required Description Type Format Allowable Values

path

Yes

The canonical path to the synced root entity. This does not have to exist in inventory prior to the request.

string

-

-

path

Yes

-

array

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

at

No

The time at which to mark the creates/updates/deletes as having occured. Either a Unix epoch timestamp in milliseconds, or an ISO-8601 formatted date and time in UTC timezone.

null

-

-

Body

Required Description Data Type

Yes

-

SyncRequest

Response

Status codes

Status Code Reason Response Model

204

Synchronization success

-

400

If the entity to be synchronized doesn’t support synchronization

ApiError

404

Authorization problem

ApiError

500

Internal server error

ApiError

Sync

  1. Make the inventory under given path match the provided inventory structure. Note that the relationships specified in the provided entities will be ignored and will not be applied.

Endpoint POST /sync/{path}

Make the inventory under given path match the provided inventory structure. Note that the relationships specified in the provided entities will be ignored and will not be applied.

Path parameters

Parameter Required Description Type Format Allowable Values

path

Yes

The canonical path to the synced root entity. This does not have to exist in inventory prior to the request.

string

-

-

path

Yes

-

array

-

-

Query parameters

Parameter Required Description Type Format Allowable Values

at

No

The time at which to mark the creates/updates/deletes as having occured. Either a Unix epoch timestamp in milliseconds, or an ISO-8601 formatted date and time in UTC timezone.

null

-

-

Body

Required Description Data Type

Yes

-

SyncRequest

Response

Status codes

Status Code Reason Response Model

204

Synchronization success

-

400

If the entity to be synchronized doesn’t support synchronization

ApiError

404

Authorization problem

ApiError

500

Internal server error

ApiError

Tenant Information

  1. Retrieves the details of the current tenant.

  2. Updates the properties of the tenant

  3. Creates new relationship(s) on a tenant

  4. Retrieves tenant’s relationships

Endpoint GET /tenant

Retrieves the details of the current tenant.

Query parameters

Parameter Required Description Type Format Allowable Values

at

No

Look at the tenant as it looked at the provided time. Either a Unix epoch timestamp in milliseconds, or an ISO-8601 formatted date and time in UTC timezone.

null

-

-

Response

Status codes

Status Code Reason Response Model

200

Tenant obtained

Tenant

403

Authorization error

ApiError

500

Server error

ApiError

Endpoint PUT /tenant

Updates the properties of the tenant

Query parameters

Parameter Required Description Type Format Allowable Values

at

No

The time to mark the update as having occured at. Either a Unix epoch timestamp in milliseconds, or an ISO-8601 formatted date and time in UTC timezone.

null

-

-

Body

Required Description Data Type

Yes

-

TenantUpdate

Response

Status codes

Status Code Reason Response Model

204

Tenant updated

-

403

Authorization error

ApiError

500

Server error

ApiError

Endpoint POST /tenant/relationship

Creates new relationship(s) on a tenant
As all POSTs, this can also accept an array of blueprints to create more than 1 relationship at a time.

Query parameters

Parameter Required Description Type Format Allowable Values

at

No

The time to mark the relationship as having been created at. Either a Unix epoch timestamp in milliseconds, or an ISO-8601 formatted date and time in UTC timezone.

null

-

-

Response

Status codes

Status Code Reason Response Model

201

Relationship(s) created.

Relationship

400

Data in wrong format

-

403

Unauthorized access

-

404

One of the related entities doesn’t exist.

-

500

Server error.

-

[[GET__tenant_relationships.]] *Endpoint GET /tenant/relationships.*

Retrieves tenant’s relationships
By default, all the outgoing relationships are returned. This can be modified using the same techniques as in the entity graph traversal.

Query parameters

Parameter Required Description Type Format Allowable Values

at

No

Look at the relationships as they were at the provided time. Either a Unix epoch timestamp in milliseconds, or an ISO-8601 formatted date and time in UTC timezone.

null

-

-

Response

Status codes

Status Code Reason Response Model

200

Relationships returned

array of Relationship

403

Authorization error

ApiError

500

Server error

ApiError

Data Types

AbstractElement

Name Required Description Type Format Allowable Values

id

No

-

string

-

-

path

Yes

-

CanonicalPath

-

-

properties

No

-

object

-

-

AbstractElementBlueprint

Name Required Description Type Format Allowable Values

properties

No

-

object

-

-

AbstractElementUpdate

Name Required Description Type Format Allowable Values

properties

No

-

object

-

-

ActionUpdate

Name Required Description Type Format Allowable Values

originalEntity

No

-

Entity

-

-

update

No

-

EntityUpdate

-

-

ApiError

If REST-call returns other than success, detailed error is returned.

Name Required Description Type Format Allowable Values

details

No

Optional details about the error beyond what’s provided in the error message.

object

-

-

errorMsg

No

Detailed error message of what happened

string

-

-

CanonicalPath

A canonical path is slash-separated list of path segments that uniquely identity an entity in the Hawkular Inventory graph. The path follows the "contains" relationships in inventory (which form a tree structure). Each segment specifies the type of the element on that position in the tree, followed by semicolon and the ID of the element. An example of a canonical path would be "/t;tenant/f;my-feed/r;my-resource". The type is one of 't' (tenant), 'e' (environment), 'rt' (resource type), 'mt' (metric type), 'ot' (operation type), 'mp' (metadata pack), 'r' (resource), 'm' (metric), 'd' (data) or 'rl' (relationship). Please consult Hawkular Inventory documentation for a more thorough discussion of the different types of entities and their places in the model.

Change

Name Required Description Type Format Allowable Values

action

No

-

string

-

created, updated, deleted

context

No

-

null

-

-

time

No

A Unix epoch timestamp in milliseconds.

integer

-

-

DataEntity

Inherits: IdentityHashedEntity

Name Required Description Type Format Allowable Values

value

No

-

object

-

-

DataEntityBlueprint

Inherits: EntityBlueprint

Name Required Description Type Format Allowable Values

value

Yes

-

JSON

-

-

DataEntityUpdate

Inherits: EntityUpdate

Name Required Description Type Format Allowable Values

value

Yes

-

object

-

-

Entity

Inherits: AbstractElement

Name Required Description Type Format Allowable Values

name

No

-

string

-

-

EntityBlueprint

Inherits: AbstractElementBlueprint

Name Required Description Type Format Allowable Values

id

Yes

-

string

-

-

incomingRelationships

No

This is an object where keys are the names of the relationships and values are arrays of canonical paths.

object

-

-

name

No

-

string

-

-

outgoingRelationships

No

This is an object where keys are the names of the relationships and values are arrays of canonical paths.

object

-

-

EntityUpdate

Inherits: AbstractElementUpdate

Name Required Description Type Format Allowable Values

name

No

-

string

-

-

Environment

Inherits: Entity

EnvironmentBlueprint

Inherits: EntityBlueprint

EnvironmentUpdate

Inherits: EntityUpdate

Feed

Inherits: IdentityHashedEntity

FeedBlueprint

Inherits: EntityBlueprint

FeedUpdate

Inherits: EntityUpdate

History

IdentityHashTree

Name Required Description Type Format Allowable Values

children

No

-

array of IdentityHashTree

-

-

hash

Yes

-

string

-

-

path

Yes

-

RelativePath

-

-

IdentityHashedEntity

Inherits: Entity

Name Required Description Type Format Allowable Values

identityHash

Yes

-

string

-

-

InventoryStructure

Name Required Description Type Format Allowable Values

children

No

-

array of InventoryStructureMap

-

-

data

Yes

-

EntityBlueprint

-

-

type

Yes

-

string

-

feed, resourceType, metricType, operationType, metric, resource, dataEntity

InventoryStructureChild

Name Required Description Type Format Allowable Values

children

No

-

array of InventoryStructureMap

-

-

data

Yes

-

EntityBlueprint

-

-

InventoryStructureMap

Name Required Description Type Format Allowable Values

dataEntity

No

-

array of InventoryStructureChild

-

-

feed

No

-

array of InventoryStructureChild

-

-

metric

No

-

array of InventoryStructureChild

-

-

metricType

No

-

array of InventoryStructureChild

-

-

operationType

No

-

array of InventoryStructureChild

-

-

resource

No

-

array of InventoryStructureChild

-

-

resourceType

No

-

array of InventoryStructureChild

-

-

JSON

Just a free form JSON.

MetadataPack

Inherits: Entity

MetadataPackBlueprint

Inherits: AbstractElementBlueprint

Name Required Description Type Format Allowable Values

members

Yes

-

array of CanonicalPath

-

-

name

No

-

string

-

-

MetadataPackUpdate

Inherits: EntityUpdate

Metric

Inherits: IdentityHashedEntity

Name Required Description Type Format Allowable Values

collectionInterval

Yes

-

integer

int64

-

type

Yes

-

MetricType

-

-

MetricBlueprint

Inherits: EntityBlueprint

Name Required Description Type Format Allowable Values

collectionInterval

Yes

-

integer

int64

-

metricTypePath

Yes

-

string

-

-

MetricType

Inherits: IdentityHashedEntity

Name Required Description Type Format Allowable Values

collectionInterval

Yes

-

integer

int64

-

type

Yes

-

string

-

GAUGE, AVAILABILITY, COUNTER, COUNTER_RATE

unit

Yes

-

string

-

NONE, PERCENTAGE, BYTES, KILOBYTES, MEGABYTES, GIGABYTES, TERABYTES, PETABYTES, BITS, KILOBITS, MEGABITS, GIGABITS, TERABITS, PETABITS, EPOCH_MILLISECONDS, EPOCH_SECONDS, JIFFYS, NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS, PER_JIFFY, PER_NANOSECOND, PER_MICROSECOND, PER_MILLISECOND, PER_SECOND, PER_MINUTE, PER_HOUR, PER_DAY, CELSIUS, KELVIN, FAHRENHEIGHT

MetricTypeBlueprint

Inherits: EntityBlueprint

Name Required Description Type Format Allowable Values

collectionInterval

Yes

-

integer

int64

-

type

Yes

-

string

-

GAUGE, AVAILABILITY, COUNTER, COUNTER_RATE

unit

Yes

-

string

-

NONE, PERCENTAGE, BYTES, KILOBYTES, MEGABYTES, GIGABYTES, TERABYTES, PETABYTES, BITS, KILOBITS, MEGABITS, GIGABITS, TERABITS, PETABITS, EPOCH_MILLISECONDS, EPOCH_SECONDS, JIFFYS, NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS, PER_JIFFY, PER_NANOSECOND, PER_MICROSECOND, PER_MILLISECOND, PER_SECOND, PER_MINUTE, PER_HOUR, PER_DAY, CELSIUS, KELVIN, FAHRENHEIGHT

MetricTypeUpdate

Inherits: EntityUpdate

Name Required Description Type Format Allowable Values

collectionInterval

No

-

integer

int64

-

unit

No

-

string

-

NONE, PERCENTAGE, BYTES, KILOBYTES, MEGABYTES, GIGABYTES, TERABYTES, PETABYTES, BITS, KILOBITS, MEGABITS, GIGABITS, TERABITS, PETABITS, EPOCH_MILLISECONDS, EPOCH_SECONDS, JIFFYS, NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS, PER_JIFFY, PER_NANOSECOND, PER_MICROSECOND, PER_MILLISECOND, PER_SECOND, PER_MINUTE, PER_HOUR, PER_DAY, CELSIUS, KELVIN, FAHRENHEIGHT

MetricUpdate

Inherits: EntityUpdate

Name Required Description Type Format Allowable Values

collectionInterval

No

-

integer

int64

-

OperationType

Inherits: IdentityHashedEntity

OperationTypeBlueprint

Inherits: EntityBlueprint

OperationTypeUpdate

Inherits: EntityBlueprint

Path

Relationship

Inherits: AbstractElement

Name Required Description Type Format Allowable Values

id

Yes

-

string

-

-

name

No

-

string

-

-

source

Yes

-

CanonicalPath

-

-

target

Yes

-

CanonicalPath

-

-

RelationshipBlueprint

Inherits: AbstractElementUpdate

Name Required Description Type Format Allowable Values

direction

Yes

-

string

-

outgoing, incoming, both

name

Yes

-

string

-

-

otherEnd

Yes

-

Path

-

-

RelationshipUpdate

Inherits: AbstractElementUpdate

RelativePath

Resource

Inherits: IdentityHashedEntity

Name Required Description Type Format Allowable Values

type

No

-

ResourceType

-

-

ResourceBlueprint

Inherits: EntityBlueprint

Name Required Description Type Format Allowable Values

resourceTypePath

Yes

-

string

-

-

ResourceType

Inherits: IdentityHashedEntity

ResourceTypeBlueprint

Inherits: EntityBlueprint

ResourceTypeUpdate

Inherits: EntityUpdate

ResourceUpdate

Inherits: EntityUpdate

SyncConfiguration

Name Required Description Type Format Allowable Values

deepSearch

No

-

boolean

-

-

syncedTypes

No

The values can be one of: "f", "rt", "mt", "ot", "r", "m", "d" that represent the entity types to be synced.

array of string

-

-

SyncRequest

Name Required Description Type Format Allowable Values

configuration

No

-

SyncConfiguration

-

-

structure

Yes

-

InventoryStructure

-

-

Tenant

Inherits: Entity

TenantUpdate

Inherits: EntityUpdate

redhatlogo-white

© 2016 | Hawkular is released under Apache License v2.0