Agent

Definition: agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. .

An agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. MUST perform the following tasks:

  • Collect data from manufacturing equipment.
  • Generate response documentselectronic document published by an MTConnect Agent in response to a probe request, current request, sample request or asset request..
  • Provide a REST interface using HTTP.

In addition to XML and HTTP, An agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. MAY provide additional protocols and representations. Some representations MAY have companion specifications.

Version Info

IntroducedDeprecatedUpdated
1.0  

Properties

NameTypeIntDepMultiplicityDescription
instanceId uint321.01

identifier for an instancedescribes a set of streaming data in an agent. Each time an agent is restarted with an empty buffer, data placed in the buffer represents a new instance of the agent. of the agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. .

Header::instanceId MUST be changed to a different unique number each time the buffersection of an agent that provides storage for information published from pieces of equipment. is cleared and a new set of data begins to be collected.

sequenceNumber uint641.01 sequence numberprimary key identifier used to manage and locate a specific piece of streaming data in an agent..
bufferSize uint321.01 maximum number of Observationsobservation that provides telemetry data for a DataItem. that MAY be retained in the agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. that published the response documentelectronic document published by an MTConnect Agent in response to a probe request, current request, sample request or asset request. at any point in time.
maxAssets uint321.21 maximum number of Assetsasset that is used by the manufacturing process to perform tasks. > Note 1 to entry: An Asset relies upon an Device to provide observations and information about itself and the Device revises the information to reflect changes to the Asset during their interaction. Examples of Assets are cutting tools, Part Information, Manufacturing Processes, Fixtures, and Files. > Note 2 to entry: A singular Asset::assetId uniquely identifies an Asset throughout its lifecycle and is used to track and relate the Asset to other Devices and entities. > Note 3 to entry: Assets are temporally associated with a device and can be removed from the device without damage or alteration to its primary functions. that MAY be retained in the agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. that published the response documentelectronic document published by an MTConnect Agent in response to a probe request, current request, sample request or asset request. at any point in time.
assetCount uint321.21 current number of Assetsasset that is used by the manufacturing process to perform tasks. > Note 1 to entry: An Asset relies upon an Device to provide observations and information about itself and the Device revises the information to reflect changes to the Asset during their interaction. Examples of Assets are cutting tools, Part Information, Manufacturing Processes, Fixtures, and Files. > Note 2 to entry: A singular Asset::assetId uniquely identifies an Asset throughout its lifecycle and is used to track and relate the Asset to other Devices and entities. > Note 3 to entry: Assets are temporally associated with a device and can be removed from the device without damage or alteration to its primary functions. that are currently stored in the agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. as of the Header::creationTime that the agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. published the response documentelectronic document published by an MTConnect Agent in response to a probe request, current request, sample request or asset request..

Relations

NameTypeIntDepMultiplicityDescription
hasObservation Observation1.00..*
hasAsset Asset1.20..*

Operations

probe

Description

agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. MUST respond to a successful probe requestrequest to an agent to produce an MTConnectDevices Response Document containing the Device Information Model. with an MTConnectDevices entity containing either one, when a Device name or uuid is given, or all known Device entries.

When successful, an MTConnectDevices entity is returned and status code of 200. Otherwise an MTConnectError and an associated status code.”

Version Info

IntroducedDeprecatedUpdated
1.0   

Parameters:

NameIntDepTypeMultiplicityDefault ValueDescription
device1.0 string0..1

if present, specifies that only the Device for the given name or uuid will be returned.

If not present, all associated Device for the Agent will be returned.

deviceType2.3 string0..1

type of Device.

If present, Agent::probe::deviceType MUST have a value of Device or Agent. See Device Information Model.

Results:

NameTypeDescription
status integer

HTTP Status Code3-digit integer result code of the attempt to understand and satisfy the request. IETF:RFC-2616.

The following HTTP Status Codes3-digit integer result code of the attempt to understand and satisfy the request. IETF:RFC-2616 MUST be supported as possible responses to a probe requestrequest to an agent to produce an MTConnectDevices Response Document containing the Device Information Model.:

  • Status Code: 200, Code Name: OK:

    The requestcommunications method where a client transmits a message to an agent. That message instructs the agent to respond with specific information. succeeded.

  • Status Code: 400, Code Name: Bad Request:

    The requestcommunications method where a client transmits a message to an agent. That message instructs the agent to respond with specific information. was invalid. The responseresponse interface which responds to a request. MUST have an MTConnectErrors Response Documentresponse document published by an MTConnect Agent whenever it encounters an error while interpreting an MTConnect Request..

  • Status Code: 404, Code Name: Not Found:

    The device name or uuid could not be located. The responseresponse interface which responds to a request. MUST have an MTConnectErrors Response Documentresponse document published by an MTConnect Agent whenever it encounters an error while interpreting an MTConnect Request..

  • Status Code: 405, Code Name: Method Not Allowed:

    The requestcommunications method where a client transmits a message to an agent. That message instructs the agent to respond with specific information. specified a method other than GET

  • Status Code: 406, Code Name: Not Acceptable:

    The HTTP Accept Header in the requestcommunications method where a client transmits a message to an agent. That message instructs the agent to respond with specific information. was not one of the supported representations.

  • Status Code: 431, Code Name: Request Header Fields Too Large:

    The fields in the HTTP Requestrequest message from a client to a server includes, within the first line of that message, the method to be applied to the resource, the identifier of the resource, and the protocol version in use. IETF:RFC-2616 > Note: In MTConnect Standard, a request issued by a client to an agent requesting information defined in the HTTP Request Line. exceed the limit of the implementation of the agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. .

  • Status Code: 500, Code Name: Internal Server Error:

    There was an unexpected error in the agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. while responding to a requestcommunications method where a client transmits a message to an agent. That message instructs the agent to respond with specific information..

Result MTConnectDevices

agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. MUST respond to a successful probe requestrequest to an agent to produce an MTConnectDevices Response Document containing the Device Information Model. with an HTTP Status Code3-digit integer result code of the attempt to understand and satisfy the request. IETF:RFC-2616 200 (OK) and an MTConnectDevices Response Documentresponse document published by an MTConnect Agent in response to a probe request.. If the requestcommunications method where a client transmits a message to an agent. That message instructs the agent to respond with specific information. fails, the agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. MUST respond with an MTConnectErrors Response Documentresponse document published by an MTConnect Agent whenever it encounters an error while interpreting an MTConnect Request. an HTTP Status Code3-digit integer result code of the attempt to understand and satisfy the request. IETF:RFC-2616 other than 200.

MTConnectDevices if successful, MTConnectError otherwise.

current

Description

agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. MUST respond to a successful current requestrequest to an agent to produce an MTConnectStreams Response Document containing the Observation Information Model for a snapshot of the latest observations at the moment of the request or at a given sequence number. with an MTConnectStreams block containing the latest values for the selected observationsobserved value of a property at a point in time.. If the at parameter is given, the values for the observationsobserved value of a property at a point in time. are a snapshot taken when the lastSequence number was equal to the value of the at parameter.

When successful, an MTConnectStreams entity is returned and status code of 200. Otherwise an MTConnectError and an associated status code.”

Version Info

IntroducedDeprecatedUpdated
1.0   

Parameters:

NameIntDepTypeMultiplicityDefault ValueDescription
device1.0 string0..1 optional Device name or uuid. If not given, all devices are returned.
path1.0 string0..1

XPath evaluated against the Device Information Modelinformation model that describes the physical and logical configuration for a piece of equipment and the data that may be reported by that equipment. that references the Componentsengineered system part of a Device composed of zero or more Components and DataItemsobservable observed by a Component that may make Observations to include in the MTConnectStreams Response Documentresponse document published by an MTConnect Agent in response to a current request or a sample request..

When a Component element is referenced by the XPath, all observationsobserved value of a property at a point in time. for its DataItemsobservable observed by a Component that may make Observations and related Componentsengineered system part of a Device composed of zero or more Components MUST be included in the MTConnectStreams Response Documentresponse document published by an MTConnect Agent in response to a current request or a sample request..

frequency1.01.2 int320..1

agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. MUST stream samples and events to the client application pausing for frequency milliseconds between each part.

DEPRECATED Version 1.2, replace by Agent::current::interval

at1.1 uint640..1<last>

response documentselectronic document published by an MTConnect Agent in response to a probe request, current request, sample request or asset request. MUST include observationsobserved value of a property at a point in time. consistent with a specific sequence numberprimary key identifier used to manage and locate a specific piece of streaming data in an agent. given by the value of the at parameter.

If the value is either less than the firstSequence or greater than the lastSequence, the requestcommunications method where a client transmits a message to an agent. That message instructs the agent to respond with specific information. MUST return a 404 HTTP Status Code3-digit integer result code of the attempt to understand and satisfy the request. IETF:RFC-2616 and the agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. MUST return an MTConnectErrors Response Documentresponse document published by an MTConnect Agent whenever it encounters an error while interpreting an MTConnect Request. with an OUT_OF_RANGE Error::errorCode.

The at parameter MUST NOT be used in conjunction with the interval parameter.

interval1.2 integer0..1null

agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. MUST continuously publish response documentselectronic document published by an MTConnect Agent in response to a probe request, current request, sample request or asset request. pausing for the number of milliseconds given as the value.

The interval value MUST be in milliseconds, and MUST be a positive integer greater than zero (0).

The interval parameter MUST NOT be used in conjunction with the at parameter.

deviceType2.3 string0..1

type of Device.

If present, Agent::current::deviceType MUST have a value of Device or Agent. See Device Information Model.

Results:

NameTypeDescription
status integer

HTTP Status Code3-digit integer result code of the attempt to understand and satisfy the request. IETF:RFC-2616.

The following HTTP Status Codes3-digit integer result code of the attempt to understand and satisfy the request. IETF:RFC-2616 MUST be supported as possible responses to a current requestrequest to an agent to produce an MTConnectStreams Response Document containing the Observation Information Model for a snapshot of the latest observations at the moment of the request or at a given sequence number.:

  • Status Code: 200, Code Name: OK:

    The requestcommunications method where a client transmits a message to an agent. That message instructs the agent to respond with specific information. succeeded.

  • Status Code: 400, Code Name: Bad Request:

    The requestcommunications method where a client transmits a message to an agent. That message instructs the agent to respond with specific information. was invalid. The responseresponse interface which responds to a request. MUST have an MTConnectErrors Response Documentresponse document published by an MTConnect Agent whenever it encounters an error while interpreting an MTConnect Request..

  • Status Code: 404, Code Name: Not Found:

    One of the following conditions apply:

    • The device name or uuid could not be located.
    • The at was OUT_OF_RANGE range.

    The responseresponse interface which responds to a request. MUST have an MTConnectErrors Response Documentresponse document published by an MTConnect Agent whenever it encounters an error while interpreting an MTConnect Request..

  • Status Code: 405, Code Name: Method Not Allowed:

    The requestcommunications method where a client transmits a message to an agent. That message instructs the agent to respond with specific information. specified a method other than GET

  • Status Code: 406, Code Name: Not Acceptable:

    The HTTP Accept Header in the requestcommunications method where a client transmits a message to an agent. That message instructs the agent to respond with specific information. was not one of the supported representations.

  • Status Code: 431, Code Name: Request Header Fields Too Large:

    The fields in the HTTP Requestrequest message from a client to a server includes, within the first line of that message, the method to be applied to the resource, the identifier of the resource, and the protocol version in use. IETF:RFC-2616 > Note: In MTConnect Standard, a request issued by a client to an agent requesting information defined in the HTTP Request Line. exceed the limit of the implementation of the agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. .

  • Status Code: 500, Code Name: Internal Server Error:

    There was an unexpected error in the agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. while responding to a requestcommunications method where a client transmits a message to an agent. That message instructs the agent to respond with specific information..

Result MTConnectStreams

agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. responds to a current requestrequest to an agent to produce an MTConnectStreams Response Document containing the Observation Information Model for a snapshot of the latest observations at the moment of the request or at a given sequence number. with an MTConnectStreams Response Documentresponse document published by an MTConnect Agent in response to a current request or a sample request. that contains the current value of Observationsobservation that provides telemetry data for a DataItem. associated with each piece of streaming dataobservations published by a piece of equipment defined by the equipment metadata. available from the agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. , subject to any filtering defined in the requestcommunications method where a client transmits a message to an agent. That message instructs the agent to respond with specific information..

sample

Description

agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. MUST respond to a successful sample requestrequest to an agent to produce an MTConnectStreams Response Document containing the Observation Information Model for a set of timestamped observations made by Components. with an MTConnectStreams entity containing the values for the selected observationsobserved value of a property at a point in time. according to the parameters provided.

When successful, an MTConnectStreams entity is returned and status code of 200. Otherwise an MTConnectError and an associated status code.”

Version Info

IntroducedDeprecatedUpdated
1.0   

Parameters:

NameIntDepTypeMultiplicityDefault ValueDescription
device1.0 string0..1 optional Device name or uuid. If not given, all devices are returned.
path1.0 string0..1

XPath evaluated against the Device Information Modelinformation model that describes the physical and logical configuration for a piece of equipment and the data that may be reported by that equipment. that references the Componentsengineered system part of a Device composed of zero or more Components and DataItemsobservable observed by a Component that may make Observations to include in the MTConnectStreams Response Documentresponse document published by an MTConnect Agent in response to a current request or a sample request..

When a Component element is referenced by the XPath, all observationsobserved value of a property at a point in time. for its DataItemsobservable observed by a Component that may make Observations and related Componentsengineered system part of a Device composed of zero or more Components MUST be included in the MTConnectStreams Response Documentresponse document published by an MTConnect Agent in response to a current request or a sample request..

from1.0 uint640..1<first>

designates the sequence numberprimary key identifier used to manage and locate a specific piece of streaming data in an agent. of the first observationobserved value of a property at a point in time. in the buffersection of an agent that provides storage for information published from pieces of equipment. the agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. MUST consider publishing in the response documentelectronic document published by an MTConnect Agent in response to a probe request, current request, sample request or asset request..

If from is zero (0), it MUST be set to the firstSequence, the oldest observationobserved value of a property at a point in time. in the buffersection of an agent that provides storage for information published from pieces of equipment..

If from and count parameters are not given, from MUST default to the firstSequence.

If the from parameter is less than the firstSequence or greater than lastSequence, the agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. MUST return a 404 HTTP Status Code3-digit integer result code of the attempt to understand and satisfy the request. IETF:RFC-2616 and MUST publish an MTConnectErrors Response Documentresponse document published by an MTConnect Agent whenever it encounters an error while interpreting an MTConnect Request. with an OUT_OF_RANGE Error::errorCode.

count1.0 integer0..1

designates the maximum number of observationsobserved value of a property at a point in time. the agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. MUST publish in the response documentelectronic document published by an MTConnect Agent in response to a probe request, current request, sample request or asset request..

The count MUST NOT be zero (0).

When the count is greater than zero (0), the from parameter MUST default to the firstSequence. The evaluation of observationsobserved value of a property at a point in time. starts at from and moves forward accumulating newer observationsobserved value of a property at a point in time. until the number of observationsobserved value of a property at a point in time. equals the count or the observationobserved value of a property at a point in time. at lastSequence is considered.

When the count is less than zero (0), the from parameter MUST default to the lastSequence. The evaluation of observationsobserved value of a property at a point in time. starts at from and moves backward accumulating older observationsobserved value of a property at a point in time. until the number of observationsobserved value of a property at a point in time. equals the absolute value of count or the observationobserved value of a property at a point in time. at firstSequence is considered.

count MUST NOT be less than zero (0) when an interval parameter is given.

If count is not provided, it MUST default to 100.

If the absolute value of count is greater than the size of the buffersection of an agent that provides storage for information published from pieces of equipment. or equal to zero (0), the agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. MUST return a 404 HTTP Status Code3-digit integer result code of the attempt to understand and satisfy the request. IETF:RFC-2616 and MUST publish an MTConnectErrors Response Documentresponse document published by an MTConnect Agent whenever it encounters an error while interpreting an MTConnect Request. with an OUT_OF_RANGE Error::errorCode.

If the count parameter is not a numeric value, the agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. MUST return a 400 HTTP Status Code3-digit integer result code of the attempt to understand and satisfy the request. IETF:RFC-2616 and MUST publish an MTConnectErrors Response Documentresponse document published by an MTConnect Agent whenever it encounters an error while interpreting an MTConnect Request. with an INVALID_REQUEST Error::errorCode.

frequency1.01.2 uint320..1

agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. MUST stream samples and events to the client application pausing for frequency milliseconds between each part. Each part will contain a maximum Agent::sample::count of events or samples and Agent::sample::from will be used to indicate the beginning of the stream.

DEPRECATED Version 1.2, replace by Agent::sample::interval

heartbeat1.4 uint320..1

sets the time period for the heartbeatfunction that indicates to a client that the communications connection to an agent is still viable during times when there is no new data available to report often referred to as a “keep alive” message. function in an agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. .

The value for heartbeat represents the amount of time after a response documentelectronic document published by an MTConnect Agent in response to a probe request, current request, sample request or asset request. has been published until a new response documentelectronic document published by an MTConnect Agent in response to a probe request, current request, sample request or asset request. MUST be published, even when no new data is available.

The value for heartbeat is defined in milliseconds.

If no value is defined for heartbeat, the value MUST default to 10 seconds.

heartbeat MUST only be specified if interval is also specified.

interval1.2 integer0..1null

agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. MUST continuously publish response documentselectronic document published by an MTConnect Agent in response to a probe request, current request, sample request or asset request. when the query parameters include interval using the value as the minimum period between adjacent publications.

The interval value MUST be in milliseconds, and MUST be a positive integer greater than or equal to zero (0).

If the value for the interval parameter is zero (0), the agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. MUST publish response documentselectronic document published by an MTConnect Agent in response to a probe request, current request, sample request or asset request. when any observationsobserved value of a property at a point in time. become available.

If the period between the publication of a response documentelectronic document published by an MTConnect Agent in response to a probe request, current request, sample request or asset request. and reception of observationsobserved value of a property at a point in time. exceeds the interval, the agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. MUST wait for a maximum of heartbeat milliseconds for observationsobserved value of a property at a point in time.. Upon the arrival of observationsobserved value of a property at a point in time., the agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. MUST immediately publish a response documentelectronic document published by an MTConnect Agent in response to a probe request, current request, sample request or asset request.. When the period equals or exceeds the heartbeat, the agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. MUST publish an empty response documentelectronic document published by an MTConnect Agent in response to a probe request, current request, sample request or asset request..

to1.7 uint640..1

specifies the sequence numberprimary key identifier used to manage and locate a specific piece of streaming data in an agent. of the observationobserved value of a property at a point in time. in the buffersection of an agent that provides storage for information published from pieces of equipment. that will be the upper bound of the observationsobserved value of a property at a point in time. in the response documentelectronic document published by an MTConnect Agent in response to a probe request, current request, sample request or asset request..

Rules for to are as follows:

  • The value of to MUST be an unsigned 64-bit integer.
  • The value of to MUST be greater than the firstSequence.
  • The value of to MUST be less than or equal to the lastSequence.
  • The value of to MUST be greater than from.
  • If to and count are given, the count parameter MUST be greater than zero.
  • If to and count are given, the maximum number of observationsobserved value of a property at a point in time. published in the response documentelectronic document published by an MTConnect Agent in response to a probe request, current request, sample request or asset request. MUST NOT be greater than the value of count.
  • If to is not given, see the from parameter for default behavior.
  • If the to parameter is less than the firstSequence or greater than lastSequence, the agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. MUST return a 404 HTTP Status Code3-digit integer result code of the attempt to understand and satisfy the request. IETF:RFC-2616 and MUST publish an MTConnectErrors Response Documentresponse document published by an MTConnect Agent whenever it encounters an error while interpreting an MTConnect Request. with an OUT_OF_RANGE errorCode.
  • If the to parameter is not a positive numeric value, the agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. MUST return a 400 HTTP Status Code3-digit integer result code of the attempt to understand and satisfy the request. IETF:RFC-2616 and MUST publish an MTConnectErrors Response Documentresponse document published by an MTConnect Agent whenever it encounters an error while interpreting an MTConnect Request. with an INVALID_REQUEST errorCode.
  • If the to parameter is less than the from parameter, the agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. MUST return a 400 HTTP Status Code3-digit integer result code of the attempt to understand and satisfy the request. IETF:RFC-2616 and MUST publish an MTConnectErrors Response Documentresponse document published by an MTConnect Agent whenever it encounters an error while interpreting an MTConnect Request. with an INVALID_REQUEST errorCode.
  • If the to parameter is given and the count parameter is less than zero, the agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. MUST return a 400 HTTP Status Code3-digit integer result code of the attempt to understand and satisfy the request. IETF:RFC-2616 and MUST publish an MTConnectErrors Response Documentresponse document published by an MTConnect Agent whenever it encounters an error while interpreting an MTConnect Request. with an INVALID_REQUEST errorCode.
deviceType2.3 string0..1

type of Device.

If present, Agent::sample::deviceType MUST have a value of Device or Agent. See Device Information Model.

Results:

NameTypeDescription
status integer

HTTP Status Code3-digit integer result code of the attempt to understand and satisfy the request. IETF:RFC-2616.

The following HTTP Status Codes3-digit integer result code of the attempt to understand and satisfy the request. IETF:RFC-2616 MUST be supported as possible responses to a current requestrequest to an agent to produce an MTConnectStreams Response Document containing the Observation Information Model for a snapshot of the latest observations at the moment of the request or at a given sequence number.:

  • Status Code: 200, Code Name: OK:

    The requestcommunications method where a client transmits a message to an agent. That message instructs the agent to respond with specific information. succeeded.

  • Status Code: 400, Code Name: Bad Request:

    The requestcommunications method where a client transmits a message to an agent. That message instructs the agent to respond with specific information. was invalid. The responseresponse interface which responds to a request. MUST have an MTConnectErrors Response Documentresponse document published by an MTConnect Agent whenever it encounters an error while interpreting an MTConnect Request..

  • Status Code: 404, Code Name: Not Found:

    One of the following conditions apply:

    • The device name or UUID could not be located.
    • One of the asset_ids could not be found.

    The responseresponse interface which responds to a request. MUST have an MTConnectErrors Response Documentresponse document published by an MTConnect Agent whenever it encounters an error while interpreting an MTConnect Request..

  • Status Code: 405, Code Name: Method Not Allowed:

    The requestcommunications method where a client transmits a message to an agent. That message instructs the agent to respond with specific information. specified a method other than GET

  • Status Code: 406, Code Name: Not Acceptable:

    The HTTP Accept Header in the requestcommunications method where a client transmits a message to an agent. That message instructs the agent to respond with specific information. was not one of the supported representations.

  • Status Code: 431, Code Name: Request Header Fields Too Large:

    The fields in the HTTP Requestrequest message from a client to a server includes, within the first line of that message, the method to be applied to the resource, the identifier of the resource, and the protocol version in use. IETF:RFC-2616 > Note: In MTConnect Standard, a request issued by a client to an agent requesting information defined in the HTTP Request Line. exceed the limit of the implementation of the agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. .

  • Status Code: 500, Code Name: Internal Server Error:

There was an unexpected error in the agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. while responding to a requestcommunications method where a client transmits a message to an agent. That message instructs the agent to respond with specific information..

Result MTConnectStreams

agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. MUST respond to a successful sample requestrequest to an agent to produce an MTConnectStreams Response Document containing the Observation Information Model for a set of timestamped observations made by Components. with an HTTP Status Code3-digit integer result code of the attempt to understand and satisfy the request. IETF:RFC-2616 200 (OK) and an MTConnectStreams Response Documentresponse document published by an MTConnect Agent in response to a current request or a sample request.. If the requestcommunications method where a client transmits a message to an agent. That message instructs the agent to respond with specific information. fails, the agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. MUST respond with an MTConnectErrors Response Documentresponse document published by an MTConnect Agent whenever it encounters an error while interpreting an MTConnect Request. an HTTP Status Code3-digit integer result code of the attempt to understand and satisfy the request. IETF:RFC-2616 other than 200.

asset

Description

agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. MUST respond to a successful asset requestHTTP Request to the agent regarding Assets. with an MTConnectAssets entity with the selected assetitem, thing or entity that has potential or actual value to an organization. ISO 55000:2014 > Note 1 to entry: Value can be tangible or intangible, financial or non-financial, and includes consideration of risks and liabilities. It can be positive or negative at different stages of the asset life. > Note 2 to entry: Physical assets usually refer to equipment, inventory and properties owned by the organization. Physical assets are the opposite of intangible assets, which are non-physical assets such as leases, brands, digital assets, use rights, licences, intellectual property rights, reputation or agreements. > Note 3 to entry: A grouping of assets referred to as an asset system could also be considered as an asset. entities according to the parameters provided.

When successful, an MTConnectAssets entity is returned and status code of 200. Otherwise an MTConnectError and an associated status code.”

Version Info

IntroducedDeprecatedUpdated
1.2   

Parameters:

NameIntDepTypeMultiplicityDefault ValueDescription
device2.0 string0..1 optional Device name or uuid. If not given, all devices are returned.
assetIds1.2 string0..*

path portion is a list of (asset_id) for specific MTConnectAssets Response Documentsresponse document published by an MTConnect Agent in response to an asset request..

In response, the agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. returns an MTConnectAssets Response Documentresponse document published by an MTConnect Agent in response to an asset request. that contains information for the specific assetsitem, thing or entity that has potential or actual value to an organization. ISO 55000:2014 > Note 1 to entry: Value can be tangible or intangible, financial or non-financial, and includes consideration of risks and liabilities. It can be positive or negative at different stages of the asset life. > Note 2 to entry: Physical assets usually refer to equipment, inventory and properties owned by the organization. Physical assets are the opposite of intangible assets, which are non-physical assets such as leases, brands, digital assets, use rights, licences, intellectual property rights, reputation or agreements. > Note 3 to entry: A grouping of assets referred to as an asset system could also be considered as an asset. for each of the asset_id values provided in the requestcommunications method where a client transmits a message to an agent. That message instructs the agent to respond with specific information.. Each asset_id is separated by a “;”.

count1.5 integer0..1

specifies the maximum number of MTConnectAssets Response Documentsresponse document published by an MTConnect Agent in response to an asset request. returned in an MTConnectAssets Response Documentresponse document published by an MTConnect Agent in response to an asset request..

If count is not given, the default value MUST be 100.

type1.5 string0..1 type of Assetasset that is used by the manufacturing process to perform tasks. > Note 1 to entry: An Asset relies upon an Device to provide observations and information about itself and the Device revises the information to reflect changes to the Asset during their interaction. Examples of Assets are cutting tools, Part Information, Manufacturing Processes, Fixtures, and Files. > Note 2 to entry: A singular Asset::assetId uniquely identifies an Asset throughout its lifecycle and is used to track and relate the Asset to other Devices and entities. > Note 3 to entry: Assets are temporally associated with a device and can be removed from the device without damage or alteration to its primary functions. . See Asset Information Model.
removed1.5 boolean0..1

value for Agent::asset::removed MUST be true or false and interpreted as follows:

  • true: MTConnectAssets Response Documentsresponse document published by an MTConnect Agent in response to an asset request. for assetsitem, thing or entity that has potential or actual value to an organization. ISO 55000:2014 > Note 1 to entry: Value can be tangible or intangible, financial or non-financial, and includes consideration of risks and liabilities. It can be positive or negative at different stages of the asset life. > Note 2 to entry: Physical assets usually refer to equipment, inventory and properties owned by the organization. Physical assets are the opposite of intangible assets, which are non-physical assets such as leases, brands, digital assets, use rights, licences, intellectual property rights, reputation or agreements. > Note 3 to entry: A grouping of assets referred to as an asset system could also be considered as an asset. marked as removed MUST be included in the response documentelectronic document published by an MTConnect Agent in response to a probe request, current request, sample request or asset request..

  • false: MTConnectAssets Response Documentsresponse document published by an MTConnect Agent in response to an asset request. for assetsitem, thing or entity that has potential or actual value to an organization. ISO 55000:2014 > Note 1 to entry: Value can be tangible or intangible, financial or non-financial, and includes consideration of risks and liabilities. It can be positive or negative at different stages of the asset life. > Note 2 to entry: Physical assets usually refer to equipment, inventory and properties owned by the organization. Physical assets are the opposite of intangible assets, which are non-physical assets such as leases, brands, digital assets, use rights, licences, intellectual property rights, reputation or agreements. > Note 3 to entry: A grouping of assets referred to as an asset system could also be considered as an asset. marked as removed MUST NOT be included in the response documentelectronic document published by an MTConnect Agent in response to a probe request, current request, sample request or asset request..

If Agent::asset::removed is not given, the default value MUST be false.

Results:

NameTypeDescription
status integer

HTTP Status Code3-digit integer result code of the attempt to understand and satisfy the request. IETF:RFC-2616.

The following HTTP Status Codes3-digit integer result code of the attempt to understand and satisfy the request. IETF:RFC-2616 MUST be supported as possible responses to a asset requestHTTP Request to the agent regarding Assets.:

  • Status Code: 200, Code Name: OK:

    The requestcommunications method where a client transmits a message to an agent. That message instructs the agent to respond with specific information. succeeded.

  • Status Code: 400, Code Name: Bad Request:

    The requestcommunications method where a client transmits a message to an agent. That message instructs the agent to respond with specific information. was invalid. The responseresponse interface which responds to a request. MUST have an MTConnectErrors Response Documentresponse document published by an MTConnect Agent whenever it encounters an error while interpreting an MTConnect Request..

  • Status Code: 404, Code Name: Not Found:

    One of the following conditions apply:

    • The device name or uuid could not be located.
    • The from or to was OUT_OF_RANGE.

    The responseresponse interface which responds to a request. MUST have an MTConnectErrors Response Documentresponse document published by an MTConnect Agent whenever it encounters an error while interpreting an MTConnect Request..

  • Status Code: 405, Code Name: Method Not Allowed:

    The requestcommunications method where a client transmits a message to an agent. That message instructs the agent to respond with specific information. specified a method other than GET

  • Status Code: 406, Code Name: Not Acceptable:

    The HTTP Accept Header in the requestcommunications method where a client transmits a message to an agent. That message instructs the agent to respond with specific information. was not one of the supported representations.

  • Status Code: 431, Code Name: Request Header Fields Too Large:

    The fields in the HTTP Requestrequest message from a client to a server includes, within the first line of that message, the method to be applied to the resource, the identifier of the resource, and the protocol version in use. IETF:RFC-2616 > Note: In MTConnect Standard, a request issued by a client to an agent requesting information defined in the HTTP Request Line. exceed the limit of the implementation of the agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. .

  • Status Code: 500, Code Name: Internal Server Error:

    There was an unexpected error in the agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. while responding to a requestcommunications method where a client transmits a message to an agent. That message instructs the agent to respond with specific information..

Result MTConnectAssets MTConnectAssets Response Documentsresponse document published by an MTConnect Agent in response to an asset request. provided in the MTConnectAssets Response Documentresponse document published by an MTConnect Agent in response to an asset request. will be limited to those specified in the combination of the path segment of the asset requestHTTP Request to the agent regarding Assets. and the parameters provided in the query segment of that requestcommunications method where a client transmits a message to an agent. That message instructs the agent to respond with specific information..

Constraints

Error MessageOCL Expression
Sufficient Observation Space
val:SufficientObservationSpace
    a sh:NodeShape ;
    sh:message "Observation buffer length **MUST** be strictly less than Agent's buffer size." ;
    sh:targetClass mt:Agent ;
    sh:sparql [
        a sh:SPARQLConstraint ;
        sh:select """
            SELECT $this
            WHERE {
                $this mt:observationBuffer ?buffer .
                $this mt:bufferSize ?maxSize .
                ?buffer mt:length ?bufferLen .
                FILTER (xsd:integer(?bufferLen) >= xsd:integer(?maxSize))
            }
        """ ;
    ] .

Sufficient Asset Space
val:SufficientAssetSpace
    a sh:NodeShape ;
    sh:message "Asset buffer length **MUST** be less than Agent's max assets." ;
    sh:targetClass mt:Agent ;
    sh:sparql [
        a sh:SPARQLConstraint ;
        sh:select """
            SELECT $this
            WHERE {
                $this mt:assetBuffer ?buffer .
                $this mt:maxAssets ?maxAssets .
                ?buffer mt:length ?bufferLen .
                FILTER (xsd:integer(?bufferLen) >= xsd:integer(?maxAssets))
            }
        """ ;
    ] .


Back to top

Copyright © 2017-2026 Association for Manufacturing Technology (AMT). All rights reserved. MTConnect® is a trademark of AMT. Terms of Use.

MTConnect SysML Model V2.6