Skip to content

Commit f6f9c62

Browse files
authored
Merge pull request cesmii#36 from cesmii/Documentation-Changes-from-01-14-WG
Documentation changes from 01 14 wg
2 parents 2d358a1 + 9bdc6ad commit f6f9c62

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

RFC for Contextualized Manufacturing Information API.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -135,29 +135,29 @@ When invoked as a Query, MUST return a JSON structure defining a Type registered
135135

136136
When invoked as a Query, MAY accept an array of JSON structures defining Types for the requested ElementIds to reduce round-trips where multiple Type definitions are required by an application, in which case, the return payload MUST be an array of arrays.
137137

138-
#### 3.4.3 ObjectsByType
138+
#### 3.3.4 ObjectsByType
139139

140140
When invoked as a Query, MUST return an array of instance objects that are of the requested Type's ElementId. The returned value payload MUST include the metadata indicated in [section 4.1.1](#411-required-object-metadata) and, if indicated by an optional query parameter, MAY include the metadata indicated in [section 4.1.2](#412-optional-object-metadata).
141141

142-
#### 3.4.4 ObjectByElementId
142+
#### 3.3.5 ObjectByElementId
143143

144144
When invoked as a Query, if the ElementId exists as an instance object, MUST return the instance object, conforming to the Type definition the instance object derives from, and including the current value, if present, of any attribute. The returned value payload MUST include the metadata indicated in [section 4.1.1](#411-required-object-metadata) and, if indicated by an optional query parameter, MAY include the metadata indicated in [section 4.1.2](#412-optional-object-metadata).
145145

146146
When invoked as a Query, MAY accept an array of JSON structures defining Types for the requested ElementIds to reduce round-trips where multiple instance object definitions are required by an application, in which case, the return payload MUST be an array of arrays.
147147

148148
Recognizing that some systems allow some Type tolerance or looseness, when invoked as a Query, MAY accept a target Type, which would allow the CMIP to attempt Type casting or coercion on behalf of the invoking application.
149149

150-
#### 3.4.5 RelationshipTypes
150+
#### 3.3.6 RelationshipTypes
151151

152-
##### 3.4.5.1 HierarchicalRelationshipTypes
152+
##### 3.3.6.1 HierarchicalRelationshipTypes
153153

154154
When invoked as a Query, MUST return the relationship types HasChildren, HasParent. MAY return additional hierarchical relationship types. These relationship type names SHALL be treated as keywords for follow-up queries.
155155

156-
##### 3.4.5.2 NonHierarchicalRelationshipTypes
156+
##### 3.3.6.2 NonHierarchicalRelationshipTypes
157157

158158
When invoked as a Query, MAY return any graph-style relationship types the contextualized manufacturing information platform supports, excluding the HierarchicalRelationshipTypes. These relationship type names SHALL be treated as keywords for follow-up queries.
159159

160-
##### 3.4.6 ObjectsWithRelationshipsOfType
160+
#### 3.3.7 ObjectsWithRelationshipsOfType
161161

162162
When invoked as a Query, MUST return an array of objects related to the requested ElementId by the Type name of relationship specified in the query. Implementations MAY support a timestamp as a query parameter, which would allow for the exploration of historical relationships.
163163

0 commit comments

Comments
 (0)