ddc0c86b by Michael B. Mathews

ILP-374 Moved ApiBase from ILP to Tensor/V1.0.0 to encourage reuse and standardization.

1 parent 8b201d37
1 <?xml version="1.0" encoding="UTF-8" ?>
2
3 <specification xmlns="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
4 xmlns:xid="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
5 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6 xsi:schemaLocation="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd XtensibleInterfaceDefinition.xsd"
7 identity="ApiBase.xid.xml">
8
9 <title>Tensor Microservices API Base Definitions</title>
10 <comment>
11 This document defines the common types API service interface (input and output base structures) for the Tensor microservices definitions.
12 </comment>
13 <import ref="https://xid.location.studio/Tensor/V1.0.0/Common.xid.xml" local="Common.xid.xml" />
14
15 <namespace name="Tensor">
16 <using namespace="HPE"/>
17 <using namespace="Tensor"/>
18
19
20 <!--
21 *******************************
22 *InputBase Type Definition
23 *******************************
24 -->
25 <struct name="InputBase" >
26 <comment>Base input fields for operations supporting asynchronous transaction information.</comment>
27 <elem name="devid" multiplicity="0..1" type="string" ord="64">
28 <comment>
29 Optional device identifier, that provides a consistent multi-transaction identifier
30 for a device or equivalent (e.g. service identifier) providing the data. Any errors or issues resulting from processing the data will include this identifier
31 in the system logs, providing traceability. Identifier should be unique.
32 </comment>
33 </elem>
34 <elem name="etid" multiplicity="0..1" type="string" ord="65">
35 <comment>
36 Optional external transaction identifier for the caller to uniquely identify and track
37 the transaction and corresponding results. These identifiers will appear in the
38 service logs for traceability analysis. The format of the transaction identifier is up to the caller
39 and can be anything: e.g. [uuid], [id1.subid0], [numerical], etc. This data is never interpreted by
40 the service.
41 </comment>
42 </elem>
43 <elem name="directive" multiplicity="0..*" type="NameValue" ord="66">
44 <comment>
45 A set of directives to influence processing.
46 </comment>
47 </elem>
48 </struct>
49
50
51 <!--
52 *******************************
53 *OutputBase Type Definition
54 *******************************
55 -->
56 <struct name="OutputBase" >
57 <comment>Base output fields common to operations supporting asynchronous returning transaction information.</comment>
58 <elem name="devid" multiplicity="0..1" type="string" ord="64">
59 <comment>
60 Device identifier provided at operation input, provides a consistent identifier
61 for a device or equivalent (e.g. service identifier) providing the data. Any errors or issues resulting from processing the data will include this identifier
62 in the service logs, providing traceability.
63 </comment>
64 </elem>
65
66 <elem name="etid" multiplicity="0..1" type="string" ord="65">
67 <comment>
68 Optional external transaction identifier for the caller to uniquely identify and track
69 the transaction and corresponding results. These identifiers appear in the
70 ILP system logs for traceability analysis. The format of the transaction identifier is up to the caller
71 and can be anything: e.g. [uuid], [id1.subid0], [numerical], etc. This data is never interpreted by
72 the ILP system.
73 </comment>
74
75 </elem>
76
77 <elem name="resultcode" type="ResultCode" multiplicity="1" ord="66">
78 <comment>Result of the operation.</comment>
79 </elem>
80
81 <elem name="errinfo" type="Tensor.string" multiplicity="0..1" ord="67">
82 <comment>Error information if result was not success.</comment>
83 </elem>
84
85 </struct>
86
87 </namespace>
88 </specification>
Styling with Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!