Click or drag to resize
dyostem api documentation

ThirdPartySystemGetInterpretations Method

[This is preliminary documentation and is subject to change.]

Return a list of interpretations. This list can be filtered on blocks, interpretation types and timestamp.

Namespace:  Dyostem.Services
Assembly:  Dyostem (in Dyostem.dll) Version: 5.3
Syntax
public InterpretationsResult GetInterpretations(
	string sessionId,
	List<Guid> blockIds,
	List<Guid> interpretationTypeIds,
	Nullable<DateTime> fromTimestamp,
	Nullable<DateTime> toTimestamp
)

Parameters

sessionId
Type: SystemString
The SessionId returned by the OpenSession(String, String) command.
blockIds
Type: System.Collections.GenericListGuid
A list of block unique identifiers (Set to null to get interpretations from all customer's active blocks.) A list of available unique identifiers could be retrieved using the GetBlocks(String, ListGuid, ListGuid, ListGuid) command.
interpretationTypeIds
Type: System.Collections.GenericListGuid
A list of interpretation type unique identifier (Set to null to retrieve every kind of interpretation.) A list of available unique identifiers could be retrieved using the GetInterpretationTypes(String) command.
fromTimestamp
Type: SystemNullableDateTime
The minimum interpretation timestamp to return (Set to null to get interpretations from all vintages.)
toTimestamp
Type: SystemNullableDateTime
The maximum interpretation timestamp to retun. (Set to null to get interpretation to last one.)

Return Value

Type: InterpretationsResult
An instance of InterpretationsResult compound with a Message indicating that the command succeeded or not, and the requested list, grouped by block.
Examples
Query for the following interpretations for all blocks
  • Behaviour - 255c7850-93ab-4702-8483-ebe8847660ab
  • Characterization at D-Day - 0f3ac1cf-5b77-4621-af48-117bab664ffd
  • Ending date - 07c719fe-dce0-4f1d-9107-a6f9882a710d
  • Profile - 236da131-b75c-4c4c-b9cc-97995da528e4
Request
1POST /Services/ThirdPartySystem.svc/GetInterpretations HTTP/1.1
2Content-Type: application/json
3Host: www.dyostem.com
4Content-Length: 293
5Expect: 100-continue
6Connection: Keep-Alive
7
8{"sessionId":"d291a5c8-60ab-429a-a167-1a97d15c91b3","interpretationTypeIds":["255c7850-93ab-4702-8483-ebe8847660ab","0f3ac1cf-5b77-4621-af48-117bab664ffd","07c719fe-dce0-4f1d-9107-a6f9882a710d","236da131-b75c-4c4c-b9cc-97995da528e4"],"fromTimestamp":"/Date(1451602800000)/","toTimestamp":null}
Response
 1HTTP/1.1 200 OK
 2Cache-Control: private
 3Content-Type: application/json; charset=utf-8
 4Server: Microsoft-IIS/7.5
 5Set-Cookie: ASP.NET_SessionId=smh3sx0qxy3dembsktncv5dx; path=/; HttpOnly
 6X-AspNet-Version: 4.0.30319
 7X-Powered-By: ASP.NET
 8Date: Tue, 10 Jul 2018 09:45:18 GMT
 9Transfer-Encoding: chunked
10
112e26
12{"d":{"__type":"InterpretationsResult:#Dyostem.Services.Data","Blocks":[{"__type":"BlockInterpretations:#Dyostem.Services.Data","Block
132e26
14"vegetal"},{"__type":"Interpretation:#Dyostem.Services.Data","ConfidenceIndex":5,"InterpretationTypeId":"255c7850-93ab-4702-8483-ebe88
152e26
16lockName":"012017","Interpretations":[{"Key":"\/Date(1453158000000+0100)\/","Value":[{"__type":"Interpretation:#Dyostem.Services.Data"
172e26
1819\/2016 12:00:00 AM"}]},{"Key":"\/Date(1456786800000+0100)\/","Value":[{"__type":"Interpretation:#Dyostem.Services.Data","ConfidenceI
192e26
20n:#Dyostem.Services.Data","ConfidenceIndex":5,"InterpretationTypeId":"255c7850-93ab-4702-8483-ebe8847660ab","InterpretationTypeName":"
212e26
22","ConfidenceIndex":5,"InterpretationTypeId":"255c7850-93ab-4702-8483-ebe8847660ab","InterpretationTypeName":"Behaviour","RawValue":"8
232e26
242-8483-ebe8847660ab","InterpretationTypeName":"Behaviour","RawValue":"DCD06D30-FEB1-4737-9538-F923A6AC846A","Value":"End of sugar load
252e26
26-ebe8847660ab","InterpretationTypeName":"Behaviour","RawValue":"86F2ED0A-8766-4E63-ABD0-FF202FC920C0","Value":"Loading"}]},{"Key":"\/D
272e26
28vices.Data","ConfidenceIndex":5,"InterpretationTypeId":"236da131-b75c-4c4c-b9cc-97995da528e4","InterpretationTypeName":"Profile","RawV
292e26
30__type":"Interpretation:#Dyostem.Services.Data","ConfidenceIndex":5,"InterpretationTypeId":"236da131-b75c-4c4c-b9cc-97995da528e4","Int
312e26
32pretationTypeId":"07c719fe-dce0-4f1d-9107-a6f9882a710d","InterpretationTypeName":"Ending date","RawValue":"2016-02-03 00:00:00","Value
332e26
34tation:#Dyostem.Services.Data","ConfidenceIndex":5,"InterpretationTypeId":"07c719fe-dce0-4f1d-9107-a6f9882a710d","InterpretationTypeNa
352e26
36eIndex":5,"InterpretationTypeId":"07c719fe-dce0-4f1d-9107-a6f9882a710d","InterpretationTypeName":"Ending date","RawValue":"2016-02-17 
372e26
38nTypeName":"Behaviour","RawValue":"86F2ED0A-8766-4E63-ABD0-FF202FC920C0","Value":"Loading"}]},{"Key":"\/Date(1454367600000+0100)\/","V
392e27
40Interpretation:#Dyostem.Services.Data","ConfidenceIndex":5,"InterpretationTypeId":"07c719fe-dce0-4f1d-9107-a6f9882a710d","Interpretati
410
Formated Json Response
  1{
  2    "d": {
  3        "__type": "InterpretationsResult:#Dyostem.Services.Data",
  4        "Blocks": [{
  5            "__type": "BlockInterpretations:#Dyostem.Services.Data",
  6            "BlockId": "b2bc675c-63c5-4110-88ca-1aa9bf299989",
  7            "BlockName": "0120197",
  8            "Interpretations": [{
  9                "Key": "\/Date(1453158000000+0100)\/",
 10                "Value": [{
 11                    "__type": "Interpretation:#Dyostem.Services.Data",
 12                    "ConfidenceIndex": 5,
 13                    "InterpretationTypeId": "255c7850-93ab-4702-8483-ebe8847660ab",
 14                    "InterpretationTypeName": "Behaviour",
 15                    "RawValue": "86F2ED0A-8766-4E63-ABD0-FF202FC920C0",
 16                    "Value": "Loading"
 17                },
 18                {
 19                    "__type": "Interpretation:#Dyostem.Services.Data",
 20                    "ConfidenceIndex": 5,
 21                    "InterpretationTypeId": "236da131-b75c-4c4c-b9cc-97995da528e4",
 22                    "InterpretationTypeName": "Profile",
 23                    "RawValue": "6CEC53D5-9468-427B-A4C0-026FD1556151",
 24                    "Value": "thiol"
 25                }]
 26            },
 27            {
 28                "Key": "\/Date(1453762800000+0100)\/",
 29                "Value": [{
 30                    "__type": "Interpretation:#Dyostem.Services.Data",
 31                    "ConfidenceIndex": 5,
 32                    "InterpretationTypeId": "236da131-b75c-4c4c-b9cc-97995da528e4",
 33                    "InterpretationTypeName": "Profile",
 34                    "RawValue": "6CEC53D5-9468-427B-A4C0-026FD1556151",
 35                    "Value": "thiol"
 36                },
 37                {
 38                    "__type": "Interpretation:#Dyostem.Services.Data",
 39                    "ConfidenceIndex": 5,
 40                    "InterpretationTypeId": "255c7850-93ab-4702-8483-ebe8847660ab",
 41                    "InterpretationTypeName": "Behaviour",
 42                    "RawValue": "86F2ED0A-8766-4E63-ABD0-FF202FC920C0",
 43                    "Value": "Loading"
 44                }]
 45            }]
 46        },
 47        {
 48            "__type": "BlockInterpretations:#Dyostem.Services.Data",
 49            "BlockId": "1a5ccef2-5661-4a79-8ba0-76b0c26dfcc4",
 50            "BlockName": "012073",
 51            "Interpretations": [{
 52                "Key": "\/Date(1454454000000+0100)\/",
 53                "Value": [{
 54                    "__type": "Interpretation:#Dyostem.Services.Data",
 55                    "ConfidenceIndex": 5,
 56                    "InterpretationTypeId": "255c7850-93ab-4702-8483-ebe8847660ab",
 57                    "InterpretationTypeName": "Behaviour",
 58                    "RawValue": "86F2ED0A-8766-4E63-ABD0-FF202FC920C0",
 59                    "Value": "Loading"
 60                },
 61                {
 62                    "__type": "Interpretation:#Dyostem.Services.Data",
 63                    "ConfidenceIndex": 5,
 64                    "InterpretationTypeId": "236da131-b75c-4c4c-b9cc-97995da528e4",
 65                    "InterpretationTypeName": "Profile",
 66                    "RawValue": "41C248EB-67BA-485D-9663-D705605E94D7",
 67                    "Value": "vegetal"
 68                }]
 69            },
 70            {
 71                "Key": "\/Date(1455058800000+0100)\/",
 72                "Value": [{
 73                    "__type": "Interpretation:#Dyostem.Services.Data",
 74                    "ConfidenceIndex": 5,
 75                    "InterpretationTypeId": "236da131-b75c-4c4c-b9cc-97995da528e4",
 76                    "InterpretationTypeName": "Profile",
 77                    "RawValue": "41C248EB-67BA-485D-9663-D705605E94D7",
 78                    "Value": "vegetal"
 79                },
 80                {
 81                    "__type": "Interpretation:#Dyostem.Services.Data",
 82                    "ConfidenceIndex": 5,
 83                    "InterpretationTypeId": "255c7850-93ab-4702-8483-ebe8847660ab",
 84                    "InterpretationTypeName": "Behaviour",
 85                    "RawValue": "86F2ED0A-8766-4E63-ABD0-FF202FC920C0",
 86                    "Value": "Loading"
 87                }]
 88            },
 89            {
 90                "Key": "\/Date(1455663600000+0100)\/",
 91                "Value": [{
 92                    "__type": "Interpretation:#Dyostem.Services.Data",
 93                    "ConfidenceIndex": 5,
 94                    "InterpretationTypeId": "236da131-b75c-4c4c-b9cc-97995da528e4",
 95                    "InterpretationTypeName": "Profile",
 96                    "RawValue": "41C248EB-67BA-485D-9663-D705605E94D7",
 97                    "Value": "vegetal"
 98                },
 99                {
100                    "__type": "Interpretation:#Dyostem.Services.Data",
101                    "ConfidenceIndex": 5,
102                    "InterpretationTypeId": "255c7850-93ab-4702-8483-ebe8847660ab",
103                    "InterpretationTypeName": "Behaviour",
104                    "RawValue": "86F2ED0A-8766-4E63-ABD0-FF202FC920C0",
105                    "Value": "Loading"
106                }]
107            },
108            {
109                "Key": "\/Date(1455836400000+0100)\/",
110                "Value": [{
111                    "__type": "Interpretation:#Dyostem.Services.Data",
112                    "ConfidenceIndex": 5,
113                    "InterpretationTypeId": "07c719fe-dce0-4f1d-9107-a6f9882a710d",
114                    "InterpretationTypeName": "Ending date",
115                    "RawValue": "2016-02-17 00:00:00",
116                    "Value": "2\/17\/2016 12:00:00 AM"
117                },
118                {
119                    "__type": "Interpretation:#Dyostem.Services.Data",
120                    "ConfidenceIndex": 5,
121                    "InterpretationTypeId": "255c7850-93ab-4702-8483-ebe8847660ab",
122                    "InterpretationTypeName": "Behaviour",
123                    "RawValue": "E6ACE376-FCD7-4897-B180-589B5BA2C487",
124                    "Value": "End of sugar loading"
125                },
126                {
127                    "__type": "Interpretation:#Dyostem.Services.Data",
128                    "ConfidenceIndex": 5,
129                    "InterpretationTypeId": "236da131-b75c-4c4c-b9cc-97995da528e4",
130                    "InterpretationTypeName": "Profile",
131                    "RawValue": "41C248EB-67BA-485D-9663-D705605E94D7",
132                    "Value": "vegetal"
133                }]
134            },
135            {
136                "Key": "\/Date(1456268400000+0100)\/",
137                "Value": [{
138                    "__type": "Interpretation:#Dyostem.Services.Data",
139                    "ConfidenceIndex": 5,
140                    "InterpretationTypeId": "255c7850-93ab-4702-8483-ebe8847660ab",
141                    "InterpretationTypeName": "Behaviour",
142                    "RawValue": "E6ACE376-FCD7-4897-B180-589B5BA2C487",
143                    "Value": "End of sugar loading"
144                },
145                {
146                    "__type": "Interpretation:#Dyostem.Services.Data",
147                    "ConfidenceIndex": 5,
148                    "InterpretationTypeId": "236da131-b75c-4c4c-b9cc-97995da528e4",
149                    "InterpretationTypeName": "Profile",
150                    "RawValue": "41C248EB-67BA-485D-9663-D705605E94D7",
151                    "Value": "vegetal"
152                },
153                {
154                    "__type": "Interpretation:#Dyostem.Services.Data",
155                    "ConfidenceIndex": 5,
156                    "InterpretationTypeId": "07c719fe-dce0-4f1d-9107-a6f9882a710d",
157                    "InterpretationTypeName": "Ending date",
158                    "RawValue": "2016-02-17 00:00:00",
159                    "Value": "2\/17\/2016 12:00:00 AM"
160                }]
161            },
162            {
163                "Key": "\/Date(1456786800000+0100)\/",
164                "Value": [{
165                    "__type": "Interpretation:#Dyostem.Services.Data",
166                    "ConfidenceIndex": 5,
167                    "InterpretationTypeId": "255c7850-93ab-4702-8483-ebe8847660ab",
168                    "InterpretationTypeName": "Behaviour",
169                    "RawValue": "86F2ED0A-8766-4E63-ABD0-FF202FC920C0",
170                    "Value": "Loading"
171                },
172                {
173                    "__type": "Interpretation:#Dyostem.Services.Data",
174                    "ConfidenceIndex": 5,
175                    "InterpretationTypeId": "236da131-b75c-4c4c-b9cc-97995da528e4",
176                    "InterpretationTypeName": "Profile",
177                    "RawValue": "41C248EB-67BA-485D-9663-D705605E94D7",
178                    "Value": "vegetal"
179                }]
180            }]
181        },
182        {
183            "__type": "BlockInterpretations:#Dyostem.Services.Data",
184            "BlockId": "25581f0a-9717-435a-965d-f06cc825677e",
185            "BlockName": "61112",
186            "Interpretations": [{
187                "Key": "\/Date(1453935600000+0100)\/",
188                "Value": [{
189                    "__type": "Interpretation:#Dyostem.Services.Data",
190                    "ConfidenceIndex": 4.642946406255585,
191                    "InterpretationTypeId": "236da131-b75c-4c4c-b9cc-97995da528e4",
192                    "InterpretationTypeName": "Profile",
193                    "RawValue": "41C248EB-67BA-485D-9663-D705605E94D7",
194                    "Value": "vegetal"
195                },
196                {
197                    "__type": "Interpretation:#Dyostem.Services.Data",
198                    "ConfidenceIndex": 4.642946406255585,
199                    "InterpretationTypeId": "255c7850-93ab-4702-8483-ebe8847660ab",
200                    "InterpretationTypeName": "Behaviour",
201                    "RawValue": "86F2ED0A-8766-4E63-ABD0-FF202FC920C0",
202                    "Value": "Loading"
203                }]
204            },
205            {
206                "Key": "\/Date(1454454000000+0100)\/",
207                "Value": [{
208                    "__type": "Interpretation:#Dyostem.Services.Data",
209                    "ConfidenceIndex": 4.642946406255585,
210                    "InterpretationTypeId": "255c7850-93ab-4702-8483-ebe8847660ab",
211                    "InterpretationTypeName": "Behaviour",
212                    "RawValue": "86F2ED0A-8766-4E63-ABD0-FF202FC920C0",
213                    "Value": "Loading"
214                },
215                {
216                    "__type": "Interpretation:#Dyostem.Services.Data",
217                    "ConfidenceIndex": 4.642946406255585,
218                    "InterpretationTypeId": "236da131-b75c-4c4c-b9cc-97995da528e4",
219                    "InterpretationTypeName": "Profile",
220                    "RawValue": "41C248EB-67BA-485D-9663-D705605E94D7",
221                    "Value": "vegetal"
222                }]
223            },
224            {
225                "Key": "\/Date(1455058800000+0100)\/",
226                "Value": [{
227                    "__type": "Interpretation:#Dyostem.Services.Data",
228                    "ConfidenceIndex": 4.642946406255585,
229                    "InterpretationTypeId": "255c7850-93ab-4702-8483-ebe8847660ab",
230                    "InterpretationTypeName": "Behaviour",
231                    "RawValue": "86F2ED0A-8766-4E63-ABD0-FF202FC920C0",
232                    "Value": "Loading"
233                },
234                {
235                    "__type": "Interpretation:#Dyostem.Services.Data",
236                    "ConfidenceIndex": 4.642946406255585,
237                    "InterpretationTypeId": "236da131-b75c-4c4c-b9cc-97995da528e4",
238                    "InterpretationTypeName": "Profile",
239                    "RawValue": "41C248EB-67BA-485D-9663-D705605E94D7",
240                    "Value": "vegetal"
241                }]
242            },
243            {
244                "Key": "\/Date(1455663600000+0100)\/",
245                "Value": [{
246                    "__type": "Interpretation:#Dyostem.Services.Data",
247                    "ConfidenceIndex": 3.5705359374442152,
248                    "InterpretationTypeId": "255c7850-93ab-4702-8483-ebe8847660ab",
249                    "InterpretationTypeName": "Behaviour",
250                    "RawValue": "DCD06D30-FEB1-4737-9538-F923A6AC846A",
251                    "Value": "End of sugar loading to be confirmed"
252                },
253                {
254                    "__type": "Interpretation:#Dyostem.Services.Data",
255                    "ConfidenceIndex": 3.5705359374442152,
256                    "InterpretationTypeId": "236da131-b75c-4c4c-b9cc-97995da528e4",
257                    "InterpretationTypeName": "Profile",
258                    "RawValue": "41C248EB-67BA-485D-9663-D705605E94D7",
259                    "Value": "vegetal"
260                },
261                {
262                    "__type": "Interpretation:#Dyostem.Services.Data",
263                    "ConfidenceIndex": 5,
264                    "InterpretationTypeId": "07c719fe-dce0-4f1d-9107-a6f9882a710d",
265                    "InterpretationTypeName": "Ending date",
266                    "RawValue": "2016-02-10 00:00:00",
267                    "Value": "2\/10\/2016 12:00:00 AM"
268                }]
269            },
270            {
271                "Key": "\/Date(1456095600000+0100)\/",
272                "Value": [{
273                    "__type": "Interpretation:#Dyostem.Services.Data",
274                    "ConfidenceIndex": 3.5705359374442152,
275                    "InterpretationTypeId": "236da131-b75c-4c4c-b9cc-97995da528e4",
276                    "InterpretationTypeName": "Profile",
277                    "RawValue": "41C248EB-67BA-485D-9663-D705605E94D7",
278                    "Value": "vegetal"
279                },
280                {
281                    "__type": "Interpretation:#Dyostem.Services.Data",
282                    "ConfidenceIndex": 3.5705359374442152,
283                    "InterpretationTypeId": "255c7850-93ab-4702-8483-ebe8847660ab",
284                    "InterpretationTypeName": "Behaviour",
285                    "RawValue": "E6ACE376-FCD7-4897-B180-589B5BA2C487",
286                    "Value": "End of sugar loading"
287                },
288                {
289                    "__type": "Interpretation:#Dyostem.Services.Data",
290                    "ConfidenceIndex": 5,
291                    "InterpretationTypeId": "07c719fe-dce0-4f1d-9107-a6f9882a710d",
292                    "InterpretationTypeName": "Ending date",
293                    "RawValue": "2016-02-10 00:00:00",
294                    "Value": "2\/10\/2016 12:00:00 AM"
295                }]
296            }]
297        }],
298        "Message": "OK"
299    }
300}
See Also