<xs:element name="Documentation"><xs:simpleType><xs:restriction base="xs:string"><xs:annotation><xs:documentation>Specifies additional element documentation and reference material.</xs:documentation></xs:annotation></xs:restriction></xs:simpleType></xs:element>
Specifies the base address of the service endpoints.
Source
<xs:element name="Service"><xs:complexType><xs:sequence><xs:element ref="config:ErrorHandling" minOccurs="0"/></xs:sequence><xs:attribute name="EndPoint" type="xs:string" use="required"><xs:annotation><xs:documentation>Specifies the base address of the service endpoints.</xs:documentation></xs:annotation></xs:attribute></xs:complexType></xs:element>
Specifies if field contains composite data (i.e. an array or a composite object).
DataType
xs:string
optional
Specifies field data type.
Default
xs:string
optional
Specifies default field value (to be used during design-time).
Id
xs:string
optional
Specifies unique field identifier.
IsArray
xs:string
optional
Specifies if field contains array data. If "true", the data would be available for processing in a separate input/output.
IsKey
xs:string
optional
Specifies if field is key. Important for preparing HTTP requests that modify data.
Length
xs:string
optional
Specifies field length.
Name
xs:string
optional
Specifies JSON property name.
Precision
xs:string
optional
Specifies field precision.
ReadOnly
xs:string
optional
Specifies if field is read only. If "true", the field will be ignored in HTTP requests that modify data.
Scale
xs:string
optional
Specifies field scale.
Template
xs:string
optional
Specifies field template.
Source
<xs:complexType name="Field"><xs:sequence><xs:element ref="config:Documentation" minOccurs="0"/><xs:element ref="config:Get" minOccurs="0"/><xs:element name="Set" type="config:Set" minOccurs="0"/><xs:element name="Create" type="config:Set" minOccurs="0"/><xs:element name="Update" type="config:Set" minOccurs="0"/><xs:element name="Upsert" type="config:Set" minOccurs="0"/><xs:element name="Component" type="config:Field" minOccurs="0" maxOccurs="unbounded"/><xs:element name="Composition" type="config:Composition" minOccurs="0" maxOccurs="unbounded"/></xs:sequence><xs:attribute name="Id" type="xs:string" use="optional"><xs:annotation><xs:documentation>Specifies unique field identifier.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="Name" type="xs:string" use="optional"><xs:annotation><xs:documentation>Specifies JSON property name.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="Template" type="xs:string" use="optional"><xs:annotation><xs:documentation>Specifies field template.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="DataType" type="xs:string" use="optional"><xs:annotation><xs:documentation>Specifies field data type.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="Length" type="xs:string" use="optional"><xs:annotation><xs:documentation>Specifies field length.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="Precision" type="xs:string" use="optional"><xs:annotation><xs:documentation>Specifies field precision.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="Scale" type="xs:string" use="optional"><xs:annotation><xs:documentation>Specifies field scale.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="IsKey" type="xs:string" use="optional"><xs:annotation><xs:documentation>Specifies if field is key. Important for preparing HTTP requests that modify data.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="ReadOnly" type="xs:string" use="optional"><xs:annotation><xs:documentation>Specifies if field is read only. If "true", the field will be ignored in HTTP requests that modify data.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="Default" type="xs:string" use="optional"><xs:annotation><xs:documentation>Specifies default field value (to be used during design-time).</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="Composite" type="xs:string" use="optional"><xs:annotation><xs:documentation>Specifies if field contains composite data (i.e. an array or a composite object).</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="IsArray" type="xs:string" use="optional"><xs:annotation><xs:documentation>Specifies if field contains array data. If "true", the data would be available for processing in a separate input/output.</xs:documentation></xs:annotation></xs:attribute></xs:complexType>
<xs:complexType name="Case"><xs:complexContent><xs:extension base="config:RestRequest"><xs:attribute name="For" type="xs:string" use="required"><xs:annotation><xs:documentation>Specifies the value for which the Case applies to.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="Result" type="xs:string" use="optional"><xs:annotation><xs:documentation>Specifies result extraction expression.</xs:documentation></xs:annotation></xs:attribute></xs:extension></xs:complexContent></xs:complexType>
Specifies extraction expression for next iterator. Available template variables: parameter, parameter.fields, parameter.batchSize, parameter.iterator, response.
Source
<xs:complexType name="IteratorNext"><xs:sequence><xs:element name="Initialization" type="config:IteratorInitialization" minOccurs="0"/></xs:sequence><xs:attribute name="Value" type="xs:string" use="required"><xs:annotation><xs:documentation>Specifies extraction expression for next iterator. Available template variables: parameter, parameter.fields, parameter.batchSize, parameter.iterator, response.</xs:documentation></xs:annotation></xs:attribute></xs:complexType>
<xs:element name="Read"><xs:complexType><xs:complexContent><xs:extension base="config:RestRequest"><xs:sequence><xs:element name="Iterator" type="config:Iterator" minOccurs="0"/><xs:element name="User" type="config:UserParameters" minOccurs="0"/></xs:sequence><xs:attribute name="Id" type="xs:string" use="optional"><xs:annotation><xs:documentation>Specifies a unique id of the API endpoint. Required, if there are multiple GET endpoints for the resource.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="Label" type="xs:string" use="optional"><xs:annotation><xs:documentation>Specifies a display name for the API endpoint.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="Result" type="xs:string" use="optional"><xs:annotation><xs:documentation>Specifies result extraction expression.</xs:documentation></xs:annotation></xs:attribute></xs:extension></xs:complexContent></xs:complexType></xs:element>
Specifies identifier element in result. Available template variables: resource.
Url
xs:string
optional
Specifies request URL.
Source
<xs:complexType name="Action"><xs:complexContent><xs:extension base="config:RestRequest"><xs:sequence><xs:element ref="config:ErrorHandling" minOccurs="0"/><xs:element name="User" type="config:UserParameters" minOccurs="0"/></xs:sequence><xs:attribute name="BatchLimit" type="xs:int" use="optional"><xs:annotation><xs:documentation>Specifies maximum number of records which can be processed in one batch.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="Result" type="xs:string" use="optional"><xs:annotation><xs:documentation>Specifies result extraction expression.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="ResultId" type="xs:string" use="optional"><xs:annotation><xs:documentation>Specifies identifier element in result. Available template variables: resource.</xs:documentation></xs:annotation></xs:attribute></xs:extension></xs:complexContent></xs:complexType>