getProvideProductionTracking
getProvideProductionTracking
Path Parameters
- tenant-id uuid required
The ID of the tenant owning the requested Twin.
- 200
- 401
- 402
- 403
- 404
The request was successful.
- application/json
- Schema
- Example (from schema)
Schema
response object
Response data for the production tracking request
processStepIdentifierList object[]
List that contains a set of process steps, where each process step provides a list with the values of the requeste parameters
processStepId stringId of a concrete process step
processParameterValueList object[]
A set of process parameter for the corresponsing process step, that corresponds to the requested parameters
processParameterName stringName of a process parameter
semanticId stringReference to a global defined semantic that characterizes the process parameter. For eaxample an E-Class reference
processParameterValue stringThe concrete value of a process parameter. Becomes mandatory in case that the processParameterQuality property is not set to NoValue
processParameterQuality stringPossible values: [
ok
,inexact
,noValue
]Enumeration to provide additional information about the significance of the parameter.
version stringPossible values: Value must match regular expression
^(0|[1-9][0-9]*).(0|[1-9][0-9]*).(0|[1-9][0-9]*)(-(0|[1-9A-Za-z-][0-9A-Za-z-]*)(.[0-9A-Za-z-]+)*)?([0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?$
The unique identifier of the aspect model defining the structure and the semantics of the message's header. The version number should reflect the versioning schema of aspect models in Catena-X.
identifierType stringPossible values: [
partInstanceId
,batchId
,bomId
]Distinghuished between a bill of material, a part instanceId or a batchId to identify a product
identifierNumber stringIdentifier number of a product
catenaXId stringPossible values: Value must match regular expression
(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)
The fully anonymous Catena-X ID of the serialized part, valid for the Catena-X dataspace.
header object
Contains standardized attributes for message processing common across several use cases.
messageId stringPossible values: Value must match regular expression
(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)
Unique ID identifying the message. The purpose of the ID is to uniquely identify a single message, therefore it MUST not be reused.
context stringInformation about the context the message should be considered in. The value MUST consist of two parts: an identifier of the context (e.g. business domain, etc.) followed by a version number. Both the identifier and the version number MUST correspond to the content of the message. If the content of a message is described by an aspect model available in the Catena-X Semantic Hub, then the unique identifier of this semantic model (e.g. urn:samm:io.catenax.
:1.x.x) MUST be used as a value of the context field. This is considered the default case. In all other cases the value of the context field MUST follow the pattern - - sentDateTime stringPossible values: Value must match regular expression
-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?|(24:00:00(\.0+)?))(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
Time zone aware timestamp holding the date and the time the message was sent by the sending party. The value MUST be formatted according to the ISO 8601 standard
senderBpn stringPossible values: Value must match regular expression
^BPNL[0-9]{8}[a-zA-Z0-9]{4}$
The Business Partner Number of the sending party. The value MUST be a valid BPN. BPNA and BPNS are not allowed. Applicable constraints are defined in the corresponding standard
receiverBpn stringPossible values: Value must match regular expression
^BPNL[0-9]{8}[a-zA-Z0-9]{4}$
The Business Partner Number of the receiving party. The value MUST be a valid BPN. BPNA and BPNS are not allowed. Applicable constraints are defined in the corresponding standard.
expectedResponseBy stringPossible values: Value must match regular expression
-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?|(24:00:00(\.0+)?))(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
Time zone aware timestamp holding the date and time by which the sending party expects a certain type of response from the receiving party. The meaning and interpretation of the fields's value are context-bound and MUST therefore be defined by any business domain or platform capability making use of it. The value MUST be formatted according to the ISO 8601 standard
relatedMessageId stringPossible values: Value must match regular expression
(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)
Unique ID identifying a message somehow related to the current one
version stringPossible values: Value must match regular expression
^(0|[1-9][0-9]*).(0|[1-9][0-9]*).(0|[1-9][0-9]*)(-(0|[1-9A-Za-z-][0-9A-Za-z-]*)(.[0-9A-Za-z-]+)*)?([0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?$
The unique identifier of the aspect model defining the structure and the semantics of the message's header. The version number should reflect the versioning schema of aspect models in Catena-X.
{
"response": {
"processStepIdentifierList": [
{
"processStepId": "string",
"processParameterValueList": [
{
"processParameterName": "string",
"semanticId": "string",
"processParameterValue": "string",
"processParameterQuality": "ok"
}
]
}
],
"version": "string",
"identifierType": "partInstanceId",
"identifierNumber": "string",
"catenaXId": "string"
},
"header": {
"messageId": "string",
"context": "string",
"sentDateTime": "string",
"senderBpn": "string",
"receiverBpn": "string",
"expectedResponseBy": "string",
"relatedMessageId": "string",
"version": "string"
}
}
Payload or user input is invalid. See error details in the payload for more.
- application/json
- Schema
- Example (from schema)
Schema
error object
message stringPossible values:
non-empty
path stringPossible values:
non-empty
details object
Possible values:
non-empty
property name*
objectcode string
{
"error": {
"message": "string",
"path": "string",
"details": {},
"code": "string"
}
}
The requesting user or client is not authenticated.
The requesting user or client is not authorized to access resources for the given tenant.
The requested Twin has not been found.