-
Notifications
You must be signed in to change notification settings - Fork 95
Swagger REST API Documentation
MTConnect REST API
Contact information:
will@metalogi.io
License: Apache 2.0
For information related to MTConnect
MTConnect probe request
Provides metadata service for the MTConnect Devices information model for all devices.
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| deviceType | query | Values are 'Device' or 'Agent'. Selects only devices of that type. | No | string (string) |
| format | query | The format of the response document: 'xml' or 'json' | No | string (string) |
| pretty | query | Instructs the result to be pretty printed | No | boolean (bool) |
| Code | Description |
|---|---|
| 200 | OK |
MTConnect asset request
Returns up to count assets
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| count | query | Maximum number of entities to include in results | No | long |
| device | query | Device UUID or name | No | string (string) |
| format | query | The format of the response document: 'xml' or 'json' | No | string (string) |
| pretty | query | Instructs the result to be pretty printed | No | boolean (bool) |
| removed | query | Boolean indicating if removed assets are included in results | No | boolean (bool) |
| type | query | Only include assets of type type in the results |
No | string (string) |
| Code | Description |
|---|---|
| 200 | OK |
MTConnect asset request
Returns a set of assets identified by asset ids asset separated by semi-colon (;)
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| assetIds | path | Semi-colon (;) separated list of assetIds | Yes | string (string) |
| Code | Description |
|---|---|
| 200 | OK |
MTConnect assets request
Returns up to count assets
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| count | query | Maximum number of entities to include in results | No | long |
| device | query | Device UUID or name | No | string (string) |
| format | query | The format of the response document: 'xml' or 'json' | No | string (string) |
| pretty | query | Instructs the result to be pretty printed | No | boolean (bool) |
| removed | query | Boolean indicating if removed assets are included in results | No | boolean (bool) |
| type | query | Only include assets of type type in the results |
No | string (string) |
| Code | Description |
|---|---|
| 200 | OK |
MTConnect assets request
Returns a set assets identified by asset ids asset separated by semi-colon (;)
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| assetIds | path | Semi-colon (;) separated list of assetIds | Yes | string (string) |
| Code | Description |
|---|---|
| 200 | OK |
MTConnect WebServices Cancel Stream
Cancels a streaming sample request
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| string | path | Yes | string (string) |
| Code | Description |
|---|---|
| 200 | OK |
MTConnect current request
Gets a stapshot of the state of all the observations for all devices optionally filtered by the path
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| at | query | Sequence number at which the observation snapshot is taken | No | integer (uint64) |
| deviceType | query | Values are 'Device' or 'Agent'. Selects only devices of that type. | No | string (string) |
| format | query | The format of the response document: 'xml' or 'json' | No | string (string) |
| interval | query | Time in ms between publishing data–starts streaming | No | long |
| path | query | XPath to filter DataItems matched against the probe document | No | string (string) |
| pretty | query | Instructs the result to be pretty printed | No | boolean (bool) |
| Code | Description |
|---|---|
| 200 | OK |
MTConnect probe request
Provides metadata service for the MTConnect Devices information model for all devices.
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| deviceType | query | Values are 'Device' or 'Agent'. Selects only devices of that type. | No | string (string) |
| format | query | The format of the response document: 'xml' or 'json' | No | string (string) |
| pretty | query | Instructs the result to be pretty printed | No | boolean (bool) |
| Code | Description |
|---|---|
| 200 | OK |
MTConnect sample request
Gets a time series of at maximum count observations for all devices optionally filtered by the path and starting at from. By default, from is the first available observation known to the agent
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| count | query | Maximum number of entities to include in results | No | long |
| deviceType | query | Values are 'Device' or 'Agent'. Selects only devices of that type. | No | string (string) |
| format | query | The format of the response document: 'xml' or 'json' | No | string (string) |
| from | query | Sequence number at to start reporting observations | No | integer (uint64) |
| heartbeat | query | Time in ms between publishing a empty document when no data has changed | No | long |
| interval | query | Time in ms between publishing data–starts streaming | No | long |
| path | query | XPath to filter DataItems matched against the probe document | No | string (string) |
| pretty | query | Instructs the result to be pretty printed | No | boolean (bool) |
| to | query | Sequence number at to stop reporting observations | No | integer (uint64) |
| Code | Description |
|---|---|
| 200 | OK |
MTConnect probe request
Provides metadata service for the MTConnect Devices information model for device identified by device matching name or uuid.
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| device | path | Device UUID or name | Yes | string (string) |
| deviceType | query | Values are 'Device' or 'Agent'. Selects only devices of that type. | No | string (string) |
| format | query | The format of the response document: 'xml' or 'json' | No | string (string) |
| pretty | query | Instructs the result to be pretty printed | No | boolean (bool) |
| Code | Description |
|---|---|
| 200 | OK |
MTConnect asset request
Returns up to count assets for deivce device
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| device | path | Device UUID or name | Yes | string (string) |
| count | query | Maximum number of entities to include in results | No | long |
| device | query | Device UUID or name | No | string (string) |
| format | query | The format of the response document: 'xml' or 'json' | No | string (string) |
| pretty | query | Instructs the result to be pretty printed | No | boolean (bool) |
| removed | query | Boolean indicating if removed assets are included in results | No | boolean (bool) |
| type | query | Only include assets of type type in the results |
No | string (string) |
| Code | Description |
|---|---|
| 200 | OK |
MTConnect assets request
Returns up to count assets for deivce device
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| device | path | Device UUID or name | Yes | string (string) |
| count | query | Maximum number of entities to include in results | No | long |
| device | query | Device UUID or name | No | string (string) |
| format | query | The format of the response document: 'xml' or 'json' | No | string (string) |
| pretty | query | Instructs the result to be pretty printed | No | boolean (bool) |
| removed | query | Boolean indicating if removed assets are included in results | No | boolean (bool) |
| type | query | Only include assets of type type in the results |
No | string (string) |
| Code | Description |
|---|---|
| 200 | OK |
MTConnect current request
Gets a stapshot of the state of all the observations for device device optionally filtered by the path
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| device | path | Device UUID or name | Yes | string (string) |
| at | query | Sequence number at which the observation snapshot is taken | No | integer (uint64) |
| deviceType | query | Values are 'Device' or 'Agent'. Selects only devices of that type. | No | string (string) |
| format | query | The format of the response document: 'xml' or 'json' | No | string (string) |
| interval | query | Time in ms between publishing data–starts streaming | No | long |
| path | query | XPath to filter DataItems matched against the probe document | No | string (string) |
| pretty | query | Instructs the result to be pretty printed | No | boolean (bool) |
| Code | Description |
|---|---|
| 200 | OK |
MTConnect probe request
Provides metadata service for the MTConnect Devices information model for device identified by device matching name or uuid.
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| device | path | Device UUID or name | Yes | string (string) |
| deviceType | query | Values are 'Device' or 'Agent'. Selects only devices of that type. | No | string (string) |
| format | query | The format of the response document: 'xml' or 'json' | No | string (string) |
| pretty | query | Instructs the result to be pretty printed | No | boolean (bool) |
| Code | Description |
|---|---|
| 200 | OK |
MTConnect sample request
Gets a time series of at maximum count observations for device device optionally filtered by the path and starting at from. By default, from is the first available observation known to the agent
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| device | path | Device UUID or name | Yes | string (string) |
| count | query | Maximum number of entities to include in results | No | long |
| deviceType | query | Values are 'Device' or 'Agent'. Selects only devices of that type. | No | string (string) |
| format | query | The format of the response document: 'xml' or 'json' | No | string (string) |
| from | query | Sequence number at to start reporting observations | No | integer (uint64) |
| heartbeat | query | Time in ms between publishing a empty document when no data has changed | No | long |
| interval | query | Time in ms between publishing data–starts streaming | No | long |
| path | query | XPath to filter DataItems matched against the probe document | No | string (string) |
| pretty | query | Instructs the result to be pretty printed | No | boolean (bool) |
| to | query | Sequence number at to stop reporting observations | No | integer (uint64) |
| Code | Description |
|---|---|
| 200 | OK |