REST Configuration XML Schema

Showing:

Attributes

Facets

Instances

Properties

Source

Used by

Index of all elements of the REST Configuration XML Schema

Element: Documentation
Element: ConnectionManager
Element: Service
Element: ErrorHandling
Element: Authentication
Complex Type: RestRequest
Complex Type: TestRequest
Complex Type: TokenAuthentication
Complex Type: AuthorizedAuthentication
Complex Type: TokenRefresh
Complex Type: UserParameters
Complex Type: UserParameter
Simple Type: UserParameterType
Complex Type: External
Complex Type: ExternalResource
Complex Type: ExternalField
Element: Resources
Element: Template
Element: Fields
Complex Type: Field
Complex Type: Composition
Complex Type: RestParameters
Simple Type: RestParameterType
Complex Type: RestParameter
Element: Get
Element: Input
Complex Type: Case
Complex Type: SetRequest
Complex Type: Set
Complex Type: Iterator
Complex Type: IteratorNext
Complex Type: IteratorInitialization
Element: Resource
Element: Read
Element: Create
Element: Update
Element: Delete
Element: Upsert
Simple Type: methodType
Complex Type: Action
Element: FileManager
Complex Type: FileManagerRoot
Complex Type: FileManagerListing
Complex Type: FileManagerItem
Element: Script
Element: Module

Example

The demo RCM configuration below includes some of the most often used XML elements. Click on them to navigate to their detailed specification.

[ top ]

Element config:Documentation

Type

xs:string

Properties

content

simple

Used by

Elements

config:Authentication, config:Create, config:Delete, config:ErrorHandling, config:Fields, config:Get, config:Read, config:Resource, config:Update, config:Upsert

Complex Types

config:Action, config:AuthorizedAuthentication, config:Case, config:Composition, config:External, config:ExternalField, config:ExternalResource, config:Field, config:IteratorInitialization, config:RestParameter, config:RestRequest, config:Set, config:SetRequest, config:TestRequest, config:TokenAuthentication, config:TokenRefresh, config:UserParameter

Source

<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>

[ top ]

Element config:ConnectionManager

Properties

content

complex

Children

config:Authentication, config:FileManager, config:Resources, config:Script, config:Service

Instance

<config:ConnectionManager Help="" Name="" RuntimeVersion="" xmlns:config="http://www.cozyroc.com/schema/rcm-config-1.0.xsd">
  <config:Service EndPoint="">{1,1}</config:Service>
  <config:Authentication Cached="true" Name="">{0,unbounded}</config:Authentication>
  <config:Resources>{0,1}</config:Resources>
  <config:FileManager>{0,1}</config:FileManager>
  <config:Script>{0,1}</config:Script>
</config:ConnectionManager>

Attributes

QName

Type

Use

Annotation

Help

xs:string

optional

Specifies URL of help topic.

Name

xs:string

required

Specifies connection manager name.

RuntimeVersion

xs:string

required

Specifies the required COZYROC SSIS+ runtime version.

Source

<xs:element name="ConnectionManager">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="config:Service"/>
      <xs:element ref="config:Authentication" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element ref="config:Resources" minOccurs="0"/>
      <xs:element ref="config:FileManager" minOccurs="0"/>
      <xs:element ref="config:Script" minOccurs="0"/>
      <xs:element ref="dsig:Signature"  minOccurs="0" maxOccurs="1"/>
    </xs:sequence>
    <xs:attribute name="Name" type="xs:string" use="required">
      <xs:annotation>
        <xs:documentation>Specifies connection manager name.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="RuntimeVersion" type="xs:string" use="required">
      <xs:annotation>
        <xs:documentation>Specifies the required COZYROC SSIS+ runtime version.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="Help" type="xs:string">
      <xs:annotation>
        <xs:documentation>Specifies URL of help topic.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
  </xs:complexType>
</xs:element>

[ top ]

Element config:Service

Properties

content

complex

Used by

Elements

config:ConnectionManager, config:Resource

Children

config:ErrorHandling

Instance

<config:Service EndPoint="" xmlns:config="http://www.cozyroc.com/schema/rcm-config-1.0.xsd">
  <config:ErrorHandling Code="" ErrorMessage="" List="" Status="" SuccessMessage="">{0,1}</config:ErrorHandling>
</config:Service>

Attributes

QName

Type

Use

Annotation

EndPoint

xs:string

required

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>

[ top ]

Element config:ErrorHandling

Properties

content

complex

Used by

Elements	config:Create, config:Delete, config:Service, config:Update, config:Upsert
Complex Type	config:Action

Children

config:Documentation

Instance

<config:ErrorHandling Code="" ErrorMessage="" List="" Status="" SuccessMessage="" xmlns:config="http://www.cozyroc.com/schema/rcm-config-1.0.xsd">
  <config:Documentation>{0,1}</config:Documentation>
</config:ErrorHandling>

Attributes

QName

Type

Use

Annotation

Code

xs:string

optional

Specifies error code extraction expression.

ErrorMessage

xs:string

required

Specifies error message extraction expression.

List

xs:string

required

Specifies error list extraction expression.

Status

xs:string

optional

Specifies error status extraction expression.

SuccessMessage

xs:string

optional

Specifies success message extraction expression.

Source

<xs:element name="ErrorHandling">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="config:Documentation" minOccurs="0"/>
    </xs:sequence>
    <xs:attribute name="Status" type="xs:string" use="optional">
      <xs:annotation>
        <xs:documentation>Specifies error status extraction expression.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="List" type="xs:string" use="required">
      <xs:annotation>
        <xs:documentation>Specifies error list extraction expression.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="Code" type="xs:string" use="optional">
      <xs:annotation>
        <xs:documentation>Specifies error code extraction expression.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="ErrorMessage" type="xs:string" use="required">
      <xs:annotation>
        <xs:documentation>Specifies error message extraction expression.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="SuccessMessage" type="xs:string" use="optional">
      <xs:annotation>
        <xs:documentation>Specifies success message extraction expression.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
  </xs:complexType>
</xs:element>

[ top ]

Element config:Authentication

Properties

content

complex

Used by

Element

config:ConnectionManager

Children

config:Documentation, config:RestParameters, config:TestRequest, config:TokenAuthentication, config:UserParameters

Instance

<config:Authentication Cached="true" Name="" xmlns:config="http://www.cozyroc.com/schema/rcm-config-1.0.xsd">
  <config:Documentation>{0,1}</config:Documentation>
  <config:User>{0,1}</config:User>
  <config:Test Method="" Result="" Url="">{0,1}</config:Test>
  <config:Token Method="" Result="" Url="">{0,1}</config:Token>
  <config:Parameters>{0,1}</config:Parameters>
</config:Authentication>

Attributes

QName

Type

Default

Use

Annotation

Cached

xs:boolean

true

optional

Specifies whether the authentication is cached (i.e. whether or not subsequent HTTP requests can reuse authentication parameters).

Name

xs:string

optional

Specifies authentication name/identifier. Required if the service supports multiple authentication methods.

Source

<xs:element name="Authentication">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="config:Documentation" minOccurs="0"/>
      <xs:element name="User" type="config:UserParameters" minOccurs="0"/>
      <xs:element name="Test" type="config:TestRequest" minOccurs="0"/>
      <xs:element name="Token" type="config:TokenAuthentication" minOccurs="0"/>
      <xs:element name="Parameters" type="config:RestParameters" minOccurs="0"/>
    </xs:sequence>
    <xs:attribute name="Name" type="xs:string" use="optional">
      <xs:annotation>
        <xs:documentation>Specifies authentication name/identifier. Required if the service supports multiple authentication methods.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="Cached" type="xs:boolean" default="true">
      <xs:annotation>
        <xs:documentation>Specifies whether the authentication is cached (i.e. whether or not subsequent HTTP requests can reuse authentication parameters).</xs:documentation>
      </xs:annotation>
    </xs:attribute>
  </xs:complexType>
</xs:element>

[ top ]

Complex Type config:RestRequest

Used by

Complex Types	config:Action, config:Case, config:External, config:IteratorInitialization, config:SetRequest, config:TestRequest, config:TokenAuthentication, config:TokenRefresh
Elements	config:Get, config:Read

Children

config:Documentation, config:RestParameters

Attributes

QName

Type

Use

Annotation

Method

config:methodType

optional

Specifies HTTP request method.

Url

xs:string

optional

Specifies request URL.

Source

<xs:complexType name="RestRequest">
  <xs:sequence>
    <xs:element ref="config:Documentation" minOccurs="0"/>
    <xs:element name="Parameters" type="config:RestParameters" minOccurs="0"/>
  </xs:sequence>
  <xs:attribute name="Url" type="xs:string" use="optional">
    <xs:annotation>
      <xs:documentation>Specifies request URL.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="Method" type="config:methodType" use="optional">
    <xs:annotation>
      <xs:documentation>Specifies HTTP request method.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
</xs:complexType>

[ top ]

Complex Type config:TestRequest

Type

extension of config:RestRequest

Type hierarchy

config:RestRequest
- config:TestRequest

Children

config:Documentation, config:RestParameters

Attributes

QName

Type

Use

Annotation

Method

config:methodType

optional

Specifies HTTP request method.

Result

xs:string

optional

Specifies test response evaluation. Available template variables: response.

Url

xs:string

optional

Specifies request URL.

Source

<xs:complexType name="TestRequest">
  <xs:complexContent>
    <xs:extension base="config:RestRequest">
      <xs:attribute name="Result" type="xs:string" use="optional">
        <xs:annotation>
          <xs:documentation>Specifies test response evaluation. Available template variables: response.</xs:documentation>
        </xs:annotation>
      </xs:attribute>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

[ top ]

Complex Type config:TokenAuthentication

Type

extension of config:RestRequest

Type hierarchy

config:RestRequest
- config:TokenAuthentication

Children

config:AuthorizedAuthentication, config:Documentation, config:RestParameters, config:TokenRefresh

Attributes

QName

Type

Use

Annotation

Method

config:methodType

optional

Specifies HTTP request method.

Result

xs:string

required

Specifies access token extraction expression. Available template variables: response.

Url

xs:string

optional

Specifies request URL.

Source

<xs:complexType name="TokenAuthentication">
  <xs:complexContent>
    <xs:extension base="config:RestRequest">
      <xs:sequence>
        <xs:element name="Authorized" type="config:AuthorizedAuthentication" minOccurs="0"/>
        <xs:element name="Refresh" type="config:TokenRefresh" minOccurs="0"/>
      </xs:sequence>
      <xs:attribute name="Result" type="xs:string" use="required">
        <xs:annotation>
          <xs:documentation>Specifies access token extraction expression. Available template variables: response.</xs:documentation>
        </xs:annotation>
      </xs:attribute>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

[ top ]

Complex Type config:AuthorizedAuthentication

Children

config:Documentation

Attributes

QName

Type

Use

Annotation

xs:string

required

Specifies authorization identifier. Available template variables: connection.

LocalListenUrl

xs:string

optional

Specifies URL of local listener for token verification.

Result

xs:string

optional

Specifies token extraction expression. Available template variables: response.

Source

<xs:complexType name="AuthorizedAuthentication">
  <xs:sequence>
    <xs:element ref="config:Documentation" minOccurs="0"/>
  </xs:sequence>
  <xs:attribute name="Id" type="xs:string" use="required">
    <xs:annotation>
      <xs:documentation>Specifies authorization identifier. Available template variables: connection.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="LocalListenUrl" type="xs:string" use="optional">
    <xs:annotation>
      <xs:documentation>Specifies URL of local listener for token verification.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="Result" type="xs:string" use="optional">
    <xs:annotation>
      <xs:documentation>Specifies token extraction expression. Available template variables: response.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
</xs:complexType>

[ top ]

Complex Type config:TokenRefresh

Type

extension of config:RestRequest

Type hierarchy

config:RestRequest
- config:TokenRefresh

Children

config:Documentation, config:RestParameters

Attributes

QName

Type

Use

Annotation

Expiration

xs:string

required

Specifies token expiration expression.

Method

config:methodType

optional

Specifies HTTP request method.

Result

xs:string

required

Specifies refresh token extraction expression.

Url

xs:string

optional

Specifies request URL.

Source

<xs:complexType name="TokenRefresh">
  <xs:complexContent>
    <xs:extension base="config:RestRequest">
      <xs:attribute name="Result" type="xs:string" use="required">
        <xs:annotation>
          <xs:documentation>Specifies refresh token extraction expression.</xs:documentation>
        </xs:annotation>
      </xs:attribute>
      <xs:attribute name="Expiration" type="xs:string" use="required">
        <xs:annotation>
          <xs:documentation>Specifies token expiration expression.</xs:documentation>
        </xs:annotation>
      </xs:attribute>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

[ top ]

Complex Type config:UserParameters

Children

config:UserParameters

Source

<xs:complexType name="UserParameters">
  <xs:sequence>
    <xs:element name="Parameter" type="config:UserParameter" maxOccurs="unbounded"/>
  </xs:sequence>
</xs:complexType>

[ top ]

Complex Type config:UserParameter

Children

config:Documentation

Attributes

QName

Type

Default

Use

Annotation

Default

xs:string

optional

Specifies default parameter value.

Enumerable

xs:boolean

optional

Set if parameter is enumerable.

Name

xs:string

required

Specifies parameter name.

Type

config:UserParameterType

regular

optional

Specifies parameter type.

Source

<xs:complexType name="UserParameter">
  <xs:sequence>
    <xs:element ref="config:Documentation" minOccurs="0"/>
  </xs:sequence>
  <xs:attribute name="Name" type="xs:string" use="required">
    <xs:annotation>
      <xs:documentation>Specifies parameter name.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="Default" type="xs:string" use="optional">
    <xs:annotation>
      <xs:documentation>Specifies default parameter value.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="Type" type="config:UserParameterType" default="regular">
    <xs:annotation>
      <xs:documentation>Specifies parameter type.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="Enumerable" type="xs:boolean">
    <xs:annotation>
      <xs:documentation>Set if parameter is enumerable.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
</xs:complexType>

[ top ]

Simple Type config:UserParameterType

Type

restriction of xs:string

Properties

final

restriction

Facets

enumeration	regular
enumeration	password
enumeration	file

Source

<xs:simpleType name="UserParameterType" final="restriction">
  <xs:restriction base="xs:string">
    <xs:enumeration value="regular"/>
    <xs:enumeration value="password"/>
    <xs:enumeration value="file"/>
  </xs:restriction>
</xs:simpleType>

[ top ]

Complex Type config:External

Type

extension of config:RestRequest

Type hierarchy

config:RestRequest
- config:External

Used by

Complex Types

config:ExternalField, config:ExternalResource

Children

config:Documentation, config:RestParameters

Attributes

QName

Type

Use

Annotation

List

xs:string

optional

Specifies list extraction expression.

Method

config:methodType

optional

Specifies HTTP request method.

Url

xs:string

optional

Specifies request URL.

Source

<xs:complexType name="External">
  <xs:complexContent>
    <xs:extension base="config:RestRequest">
      <xs:attribute name="List" type="xs:string" use="optional">
        <xs:annotation>
          <xs:documentation>Specifies list extraction expression.</xs:documentation>
        </xs:annotation>
      </xs:attribute>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

[ top ]

Complex Type config:ExternalResource

Type

extension of config:External

Type hierarchy

config:RestRequest
- config:External
  - config:ExternalResource

Children

config:Documentation, config:RestParameters, config:Resource

Attributes

QName

Type

Use

Annotation

List

xs:string

optional

Specifies list extraction expression.

Method

config:methodType

optional

Specifies HTTP request method.

Url

xs:string

optional

Specifies request URL.

Source

<xs:complexType name="ExternalResource">
  <xs:complexContent>
    <xs:extension base="config:External">
      <xs:sequence>
        <xs:element ref="config:Resource" minOccurs="0"/>
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

[ top ]

Complex Type config:ExternalField

Type

extension of config:External

Type hierarchy

config:RestRequest
- config:External
  - config:ExternalField

Children

config:Documentation, config:Field, config:RestParameters

Attributes

QName

Type

Use

Annotation

List

xs:string

optional

Specifies list extraction expression.

Method

config:methodType

optional

Specifies HTTP request method.

Url

xs:string

optional

Specifies request URL.

Source

<xs:complexType name="ExternalField">
  <xs:complexContent>
    <xs:extension base="config:External">
      <xs:sequence>
        <xs:element name="Field" type="config:Field" minOccurs="0"/>
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

[ top ]

Element config:Resources

Properties

content

complex

Used by

Element

config:ConnectionManager

Children

config:External, config:Resource, config:Template

Instance

<config:Resources xmlns:config="http://www.cozyroc.com/schema/rcm-config-1.0.xsd">
  <config:Template>{0,1}</config:Template>
  <config:Resource CanCreate="true" CanDelete="true" CanRead="true" CanUpdate="true" CanUpsert="true" Name="" Properties="" Template="">{0,unbounded}</config:Resource>
  <config:External List="" Method="" Url="">{0,unbounded}</config:External>
</config:Resources>

Source

<xs:element name="Resources">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="config:Template" minOccurs="0"/>
      <xs:element ref="config:Resource" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element name="External" type="config:ExternalResource" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
  </xs:complexType>
</xs:element>

[ top ]

Element config:Template

Properties

content

complex

Used by

Element

config:Resources

Children

config:Field, config:Resource

Instance

<config:Template xmlns:config="http://www.cozyroc.com/schema/rcm-config-1.0.xsd">
  <config:Field Composite="" DataType="" Default="" Id="" IsArray="" IsKey="" Length="" Name="" Precision="" ReadOnly="" Scale="" Template="">{0,unbounded}</config:Field>
  <config:Resource CanCreate="true" CanDelete="true" CanRead="true" CanUpdate="true" CanUpsert="true" Name="" Properties="" Template="">{0,unbounded}</config:Resource>
</config:Template>

Source

<xs:element name="Template">
  <xs:complexType>
    <xs:sequence>
      <xs:element name="Field" type="config:Field" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element ref="config:Resource" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
  </xs:complexType>
</xs:element>

[ top ]

Element config:Fields

Properties

content

complex

Used by

Element

config:Resource

Children

config:Composition, config:Documentation, config:External, config:Field

Instance

<config:Fields CacheKey="" Sort="" Template="" xmlns:config="http://www.cozyroc.com/schema/rcm-config-1.0.xsd">
  <config:Documentation>{0,1}</config:Documentation>
  <config:Field Composite="" DataType="" Default="" Id="" IsArray="" IsKey="" Length="" Name="" Precision="" ReadOnly="" Scale="" Template="">{0,unbounded}</config:Field>
  <config:Composition>{0,unbounded}</config:Composition>
  <config:External List="" Method="" Url="">{0,unbounded}</config:External>
</config:Fields>

Attributes

QName

Type

Use

Annotation

CacheKey

xs:string

optional

Specifies fields caching key. Required if fields depend on user specified parameters.

Sort

xs:string

optional

Specifies fields sort expression. If not specified, fields will be alphabetically sorted.

Template

xs:string

optional

Specifies fields template.

Source

<xs:element name="Fields">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="config:Documentation" minOccurs="0"/>
      <xs:element name="Field" type="config:Field" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element name="Composition" type="config:Composition" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element name="External" type="config:ExternalField" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
    <xs:attribute name="Template" type="xs:string" use="optional">
      <xs:annotation>
        <xs:documentation>Specifies fields template.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="CacheKey" type="xs:string" use="optional">
      <xs:annotation>
        <xs:documentation>Specifies fields caching key. Required if fields depend on user specified parameters.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="Sort" type="xs:string" use="optional">
      <xs:annotation>
        <xs:documentation>Specifies fields sort expression. If not specified, fields will be alphabetically sorted.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
  </xs:complexType>
</xs:element>

[ top ]

Complex Type config:Field

Children

config:Component, config:Composition, config:Create, config:Documentation, config:Get, config:Set, config:Update, config:Upsert

Attributes

QName

Type

Use

Annotation

Composite

xs:string

optional

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).

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>

[ top ]

Complex Type config:Composition

Children

config:Component, config:Documentation, config:Get, config:Set

Source

<xs:complexType name="Composition">
  <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="Component" type="config:Field" minOccurs="0" maxOccurs="unbounded"/>
  </xs:sequence>
</xs:complexType>

[ top ]

Complex Type config:RestParameters

Children

config:RestParameter

Source

<xs:complexType name="RestParameters">
  <xs:sequence>
    <xs:element name="Parameter" type="config:RestParameter" maxOccurs="unbounded"/>
  </xs:sequence>
</xs:complexType>

[ top ]

Simple Type config:RestParameterType

Type

restriction of xs:string

Properties

final

restriction

Facets

enumeration	GetOrPost
enumeration	QueryString
enumeration	HttpHeader
enumeration	Body
enumeration	File

Source

<xs:simpleType name="RestParameterType" final="restriction">
  <xs:restriction base="xs:string">
    <xs:enumeration value="GetOrPost"/>
    <xs:enumeration value="QueryString"/>
    <xs:enumeration value="HttpHeader"/>
    <xs:enumeration value="Body"/>
    <xs:enumeration value="File"/>
  </xs:restriction>
</xs:simpleType>

[ top ]

Complex Type config:RestParameter

Children

config:Documentation

Attributes

QName

Type

Default

Use

Annotation

Default

xs:string

optional

Specifies default parameter value.

FileName

xs:string

optional

Specifies file name parameter for file parameter type.

MimeType

xs:string

optional

Specifies MIME type parameter for file parameter type.

Name

xs:string

required

Specifies parameter name.

Type

config:RestParameterType

GetOrPost

optional

Specifies parameter type.

Value

xs:string

optional

Specifies parameter value.

Source

<xs:complexType name="RestParameter">
  <xs:sequence>
    <xs:element ref="config:Documentation" minOccurs="0"/>
  </xs:sequence>
  <xs:attribute name="Name" type="xs:string" use="required">
    <xs:annotation>
      <xs:documentation>Specifies parameter name.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="Value" type="xs:string" use="optional">
    <xs:annotation>
      <xs:documentation>Specifies parameter value.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="Type" type="config:RestParameterType" default="GetOrPost">
    <xs:annotation>
      <xs:documentation>Specifies parameter type.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="Default" type="xs:string" use="optional">
    <xs:annotation>
      <xs:documentation>Specifies default parameter value.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="FileName" type="xs:string" use="optional">
    <xs:annotation>
      <xs:documentation>Specifies file name parameter for file parameter type.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="MimeType" type="xs:string" use="optional">
    <xs:annotation>
      <xs:documentation>Specifies MIME type parameter for file parameter type.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
</xs:complexType>

[ top ]

Element config:Get

Type

extension of config:RestRequest

Type hierarchy

config:RestRequest

Properties

content

complex

Used by

Complex Types

config:Composition, config:Field

Children

config:Documentation, config:RestParameters

Instance

<config:Get Item="" Method="" Url="" Value="" xmlns:config="http://www.cozyroc.com/schema/rcm-config-1.0.xsd">
  <config:Documentation>{0,1}</config:Documentation>
  <config:Parameters>{0,1}</config:Parameters>
</config:Get>

Attributes

QName

Type

Use

Annotation

Item

xs:string

optional

Specifies item extraction expression. Available template variables: item, response.

Method

config:methodType

optional

Specifies HTTP request method.

Url

xs:string

optional

Specifies request URL.

Value

xs:string

optional

Specifies value extraction expression. Available template variables: item, field, value, response.

Source

<xs:element name="Get">
  <xs:complexType>
    <xs:complexContent>
      <xs:extension base="config:RestRequest">
        <xs:attribute name="Item" type="xs:string" use="optional">
          <xs:annotation>
            <xs:documentation>Specifies item extraction expression. Available template variables: item, response.</xs:documentation>
          </xs:annotation>
        </xs:attribute>
        <xs:attribute name="Value" type="xs:string" use="optional">
          <xs:annotation>
            <xs:documentation>Specifies value extraction expression. Available template variables: item, field, value, response.</xs:documentation>
          </xs:annotation>
        </xs:attribute>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
</xs:element>

[ top ]

Element config:Input

Properties

content

complex

Used by

Complex Type

config:Set

Children

config:Case

Instance

<config:Input xmlns:config="http://www.cozyroc.com/schema/rcm-config-1.0.xsd">
  <config:Case For="" Method="" Result="" Url="">{1,unbounded}</config:Case>
</config:Input>

Source

<xs:element name="Input">
  <xs:complexType>
    <xs:sequence>
      <xs:element name="Case" type="config:Case" maxOccurs="unbounded"/>
    </xs:sequence>
  </xs:complexType>
</xs:element>

[ top ]

Complex Type config:Case

Type

extension of config:RestRequest

Type hierarchy

config:RestRequest
- config:Case

Children

config:Documentation, config:RestParameters

Attributes

QName

Type

Use

Annotation

For

xs:string

required

Specifies the value for which the Case applies to.

Method

config:methodType

optional

Specifies HTTP request method.

Result

xs:string

optional

Specifies result extraction expression.

Url

xs:string

optional

Specifies request URL.

Source

<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>

[ top ]

Complex Type config:SetRequest

Type

restriction of config:RestRequest

Type hierarchy

config:RestRequest
- config:SetRequest

Used by

Complex Type

config:Set

Children

config:Documentation, config:RestParameters

Attributes

QName

Type

Default

Use

Annotation

Method

config:methodType

POST

optional

Specifies HTTP request method.

Url

xs:string

optional

Specifies request URL.

Source

<xs:complexType name="SetRequest">
  <xs:complexContent>
    <xs:restriction base="config:RestRequest">
      <xs:sequence>
        <xs:element ref="config:Documentation" minOccurs="0"/>
        <xs:element name="Parameters" type="config:RestParameters" minOccurs="0"/>
      </xs:sequence>
      <xs:attribute name="Url" type="xs:string" use="optional">
        <xs:annotation>
          <xs:documentation>Specifies request URL.</xs:documentation>
        </xs:annotation>
      </xs:attribute>
      <xs:attribute name="Method" type="config:methodType" default="POST">
        <xs:annotation>
          <xs:documentation>Specifies HTTP request method.</xs:documentation>
        </xs:annotation>
      </xs:attribute>
    </xs:restriction>
  </xs:complexContent>
</xs:complexType>

[ top ]

Complex Type config:Set

Type

extension of config:SetRequest

Type hierarchy

config:RestRequest
- config:SetRequest
  - config:Set

Children

config:Documentation, config:Input, config:RestParameters

Attributes

QName

Type

Default

Use

Annotation

Item

xs:string

optional

Specifies item setup expression. Available template variables: item.

Method

config:methodType

POST

optional

Specifies HTTP request method.

Regular

xs:boolean

true

optional

Specifies whether regular set is used.

Url

xs:string

optional

Specifies request URL.

Value

xs:string

optional

Specifies value setup expression.

Source

<xs:complexType name="Set">
  <xs:complexContent>
    <xs:extension base="config:SetRequest">
      <xs:sequence>
        <xs:element ref="config:Input" minOccurs="0"/>
      </xs:sequence>
      <xs:attribute name="Item" type="xs:string" use="optional">
        <xs:annotation>
          <xs:documentation>Specifies item setup expression. Available template variables: item.</xs:documentation>
        </xs:annotation>
      </xs:attribute>
      <xs:attribute name="Value" type="xs:string" use="optional">
        <xs:annotation>
          <xs:documentation>Specifies value setup expression.</xs:documentation>
        </xs:annotation>
      </xs:attribute>
      <xs:attribute name="Regular" type="xs:boolean" default="true">
        <xs:annotation>
          <xs:documentation>Specifies whether regular set is used.</xs:documentation>
        </xs:annotation>
      </xs:attribute>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

[ top ]

Complex Type config:Iterator

Children

config:IteratorNext

Source

<xs:complexType name="Iterator">
  <xs:sequence>
    <xs:element name="Next" type="config:IteratorNext"/>
  </xs:sequence>
</xs:complexType>

[ top ]

Complex Type config:IteratorNext

Children

config:IteratorInitialization

Attributes

QName

Type

Use

Annotation

Value

xs:string

required

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>

[ top ]

Complex Type config:IteratorInitialization

Type

extension of config:RestRequest

Type hierarchy

config:RestRequest
- config:IteratorInitialization

Children

config:Documentation, config:RestParameters

Attributes

QName

Type

Use

Annotation

Method

config:methodType

optional

Specifies HTTP request method.

Result

xs:string

required

Specifies result extraction expression.

Url

xs:string

optional

Specifies request URL.

Source

<xs:complexType name="IteratorInitialization">
  <xs:complexContent>
    <xs:extension base="config:RestRequest">
      <xs:attribute name="Result" type="xs:string" use="required">
        <xs:annotation>
          <xs:documentation>Specifies result extraction expression.</xs:documentation>
        </xs:annotation>
      </xs:attribute>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

[ top ]

Element config:Resource

Properties

content

complex

Used by

Elements	config:Resources, config:Template
Complex Type	config:ExternalResource

Children

config:Create, config:Delete, config:Documentation, config:Fields, config:Read, config:Service, config:Update, config:Upsert

Instance

<config:Resource CanCreate="true" CanDelete="true" CanRead="true" CanUpdate="true" CanUpsert="true" Name="" Properties="" Template="" xmlns:config="http://www.cozyroc.com/schema/rcm-config-1.0.xsd">
  <config:Documentation>{0,1}</config:Documentation>
  <config:Service EndPoint="">{0,1}</config:Service>
  <config:Fields CacheKey="" Sort="" Template="">{0,1}</config:Fields>
  <config:Read Id="" Label="" Method="" Result="" Url="">{0,unbounded}</config:Read>
  <config:Create BatchLimit="" Method="" Result="" ResultId="" Url="">{0,1}</config:Create>
  <config:Update BatchLimit="" Method="" Result="" ResultId="" Url="">{0,1}</config:Update>
  <config:Delete BatchLimit="" Method="" Result="" ResultId="" Url="">{0,1}</config:Delete>
  <config:Upsert BatchLimit="" Method="" Result="" ResultId="" Url="">{0,1}</config:Upsert>
</config:Resource>

Attributes

QName

Type

Default

Use

Annotation

CanCreate

xs:string

true

optional

Specifies if resource supports Create.

CanDelete

xs:string

true

optional

Specifies if resource supports Delete.

CanRead

xs:string

true

optional

Specifies if resource supports Read.

CanUpdate

xs:string

true

optional

Specifies if resource supports Update.

CanUpsert

xs:string

true

optional

Specifies if resource supports Upsert.

Name

xs:string

required

Specifies resource name. Available template variables: resource.

Properties

xs:string

optional

Specifies additional resource properties.

Template

xs:string

optional

Specifies resource template.

Source

<xs:element name="Resource">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="config:Documentation" minOccurs="0"/>
      <xs:element ref="config:Service" minOccurs="0"/>
      <xs:element ref="config:Fields" minOccurs="0"/>
      <xs:element ref="config:Read" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element ref="config:Create" minOccurs="0"/>
      <xs:element ref="config:Update" minOccurs="0"/>
      <xs:element ref="config:Delete" minOccurs="0"/>
      <xs:element ref="config:Upsert" minOccurs="0"/>
    </xs:sequence>
    <xs:attribute name="Name" type="xs:string" use="required">
      <xs:annotation>
        <xs:documentation>Specifies resource name. Available template variables: resource.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="Properties" type="xs:string" use="optional">
      <xs:annotation>
        <xs:documentation>Specifies additional resource properties.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="Template" type="xs:string" use="optional">
      <xs:annotation>
        <xs:documentation>Specifies resource template.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="CanRead" type="xs:string" use="optional" default="true">
      <xs:annotation>
        <xs:documentation>Specifies if resource supports Read.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="CanCreate" type="xs:string" use="optional" default="true">
      <xs:annotation>
        <xs:documentation>Specifies if resource supports Create.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="CanUpdate" type="xs:string" use="optional" default="true">
      <xs:annotation>
        <xs:documentation>Specifies if resource supports Update.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="CanDelete" type="xs:string" use="optional" default="true">
      <xs:annotation>
        <xs:documentation>Specifies if resource supports Delete.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="CanUpsert" type="xs:string" use="optional" default="true">
      <xs:annotation>
        <xs:documentation>Specifies if resource supports Upsert.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
  </xs:complexType>
</xs:element>

[ top ]

Element config:Read

Type

extension of config:RestRequest

Type hierarchy

config:RestRequest

Properties

content

complex

Used by

Element

config:Resource

Children

config:Documentation, config:Iterator, config:RestParameters, config:UserParameters

Instance

<config:Read Id="" Label="" Method="" Result="" Url="" xmlns:config="http://www.cozyroc.com/schema/rcm-config-1.0.xsd">
  <config:Documentation>{0,1}</config:Documentation>
  <config:Parameters>{0,1}</config:Parameters>
  <config:Iterator>{0,1}</config:Iterator>
  <config:User>{0,1}</config:User>
</config:Read>

Attributes

QName

Type

Use

Annotation

xs:string

optional

Specifies a unique id of the API endpoint. Required, if there are multiple GET endpoints for the resource.

Label

xs:string

optional

Specifies a display name for the API endpoint.

Method

config:methodType

optional

Specifies HTTP request method.

Result

xs:string

optional

Specifies result extraction expression.

Url

xs:string

optional

Specifies request URL.

Source

<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>

[ top ]

Element config:Create

Type

extension of config:Action

Type hierarchy

config:RestRequest
- config:Action

Properties

content

complex

Used by

Element

config:Resource

Children

config:Documentation, config:ErrorHandling, config:RestParameters, config:UserParameters

Instance

<config:Create BatchLimit="" Method="" Result="" ResultId="" Url="" xmlns:config="http://www.cozyroc.com/schema/rcm-config-1.0.xsd">
  <config:Documentation>{0,1}</config:Documentation>
  <config:Parameters>{0,1}</config:Parameters>
  <config:ErrorHandling Code="" ErrorMessage="" List="" Status="" SuccessMessage="">{0,1}</config:ErrorHandling>
  <config:User>{0,1}</config:User>
</config:Create>

Attributes

QName

Type

Use

Annotation

BatchLimit

xs:int

optional

Specifies maximum number of records which can be processed in one batch.

Method

config:methodType

optional

Specifies HTTP request method.

Result

xs:string

optional

Specifies result extraction expression.

ResultId

xs:string

optional

Specifies identifier element in result. Available template variables: resource.

Url

xs:string

optional

Specifies request URL.

Source

<xs:element name="Create">
  <xs:complexType>
    <xs:complexContent>
      <xs:extension base="config:Action"/>
    </xs:complexContent>
  </xs:complexType>
</xs:element>

[ top ]

Element config:Update

Type

extension of config:Action

Type hierarchy

config:RestRequest
- config:Action

Properties

content

complex

Used by

Element

config:Resource

Children

config:Documentation, config:ErrorHandling, config:RestParameters, config:UserParameters

Instance

<config:Update BatchLimit="" Method="" Result="" ResultId="" Url="" xmlns:config="http://www.cozyroc.com/schema/rcm-config-1.0.xsd">
  <config:Documentation>{0,1}</config:Documentation>
  <config:Parameters>{0,1}</config:Parameters>
  <config:ErrorHandling Code="" ErrorMessage="" List="" Status="" SuccessMessage="">{0,1}</config:ErrorHandling>
  <config:User>{0,1}</config:User>
</config:Update>

Attributes

QName

Type

Use

Annotation

BatchLimit

xs:int

optional

Specifies maximum number of records which can be processed in one batch.

Method

config:methodType

optional

Specifies HTTP request method.

Result

xs:string

optional

Specifies result extraction expression.

ResultId

xs:string

optional

Specifies identifier element in result. Available template variables: resource.

Url

xs:string

optional

Specifies request URL.

Source

<xs:element name="Update">
  <xs:complexType>
    <xs:complexContent>
      <xs:extension base="config:Action"/>
    </xs:complexContent>
  </xs:complexType>
</xs:element>

[ top ]

Element config:Delete

Type

extension of config:Action

Type hierarchy

config:RestRequest
- config:Action

Properties

content

complex

Used by

Element

config:Resource

Children

config:Documentation, config:ErrorHandling, config:RestParameters, config:UserParameters

Instance

<config:Delete BatchLimit="" Method="" Result="" ResultId="" Url="" xmlns:config="http://www.cozyroc.com/schema/rcm-config-1.0.xsd">
  <config:Documentation>{0,1}</config:Documentation>
  <config:Parameters>{0,1}</config:Parameters>
  <config:ErrorHandling Code="" ErrorMessage="" List="" Status="" SuccessMessage="">{0,1}</config:ErrorHandling>
  <config:User>{0,1}</config:User>
</config:Delete>

Attributes

QName

Type

Use

Annotation

BatchLimit

xs:int

optional

Specifies maximum number of records which can be processed in one batch.

Method

config:methodType

optional

Specifies HTTP request method.

Result

xs:string

optional

Specifies result extraction expression.

ResultId

xs:string

optional

Specifies identifier element in result. Available template variables: resource.

Url

xs:string

optional

Specifies request URL.

Source

<xs:element name="Delete">
  <xs:complexType>
    <xs:complexContent>
      <xs:extension base="config:Action"/>
    </xs:complexContent>
  </xs:complexType>
</xs:element>

[ top ]

Element config:Upsert

Type

extension of config:Action

Type hierarchy

config:RestRequest
- config:Action

Properties

content

complex

Used by

Element

config:Resource

Children

config:Documentation, config:ErrorHandling, config:RestParameters, config:UserParameters

Instance

<config:Upsert BatchLimit="" Method="" Result="" ResultId="" Url="" xmlns:config="http://www.cozyroc.com/schema/rcm-config-1.0.xsd">
  <config:Documentation>{0,1}</config:Documentation>
  <config:Parameters>{0,1}</config:Parameters>
  <config:ErrorHandling Code="" ErrorMessage="" List="" Status="" SuccessMessage="">{0,1}</config:ErrorHandling>
  <config:User>{0,1}</config:User>
</config:Upsert>

Attributes

QName

Type

Use

Annotation

BatchLimit

xs:int

optional

Specifies maximum number of records which can be processed in one batch.

Method

config:methodType

optional

Specifies HTTP request method.

Result

xs:string

optional

Specifies result extraction expression.

ResultId

xs:string

optional

Specifies identifier element in result. Available template variables: resource.

Url

xs:string

optional

Specifies request URL.

Source

<xs:element name="Upsert">
  <xs:complexType>
    <xs:complexContent>
      <xs:extension base="config:Action"/>
    </xs:complexContent>
  </xs:complexType>
</xs:element>

[ top ]

Simple Type config:methodType

Type

restriction of xs:string

Properties

final

restriction

Facets

enumeration	GET
enumeration	POST
enumeration	PUT
enumeration	DELETE
enumeration	PATCH

Source

<xs:simpleType name="methodType" final="restriction">
  <xs:restriction base="xs:string">
    <xs:enumeration value="GET"/>
    <xs:enumeration value="POST"/>
    <xs:enumeration value="PUT"/>
    <xs:enumeration value="DELETE"/>
    <xs:enumeration value="PATCH"/>
  </xs:restriction>
</xs:simpleType>

[ top ]

Complex Type config:Action

Type

extension of config:RestRequest

Type hierarchy

config:RestRequest
- config:Action

Used by

Elements

config:Create, config:Delete, config:Update, config:Upsert

Children

config:Documentation, config:ErrorHandling, config:RestParameters, config:UserParameters

Attributes

QName

Type

Use

Annotation

BatchLimit

xs:int

optional

Specifies maximum number of records which can be processed in one batch.

Method

config:methodType

optional

Specifies HTTP request method.

Result

xs:string

optional

Specifies result extraction expression.

ResultId

xs:string

optional

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>

[ top ]

Element config:FileManager

Properties

content

complex

Used by

Element

config:ConnectionManager

Children

config:FileManagerRoot

Instance

<config:FileManager xmlns:config="http://www.cozyroc.com/schema/rcm-config-1.0.xsd">
  <config:Root CreateDirectory="" DeleteDirectory="" DeleteFile="" DownloadFile="" GetListing="" GetPath="" Name="" RenameFile="" SetFileTime="" UploadFile="">{1,unbounded}</config:Root>
</config:FileManager>

Source

<xs:element name="FileManager">
  <xs:complexType>
    <xs:sequence>
      <xs:element name="Root" type="config:FileManagerRoot" minOccurs="1" maxOccurs="unbounded"/>
    </xs:sequence>
  </xs:complexType>
</xs:element>

[ top ]

Complex Type config:FileManagerRoot

Used by

Element

config:FileManager

Children

config:FileManagerListing

Attributes

QName

Type

Use

Annotation

CreateDirectory

xs:string

optional

Specifies function implementing create directory. Available template variables: path.

DeleteDirectory

xs:string

optional

Specifies function implementing delete directory. Available template variables: path.

DeleteFile

xs:string

optional

Specifies function implementing delete file. Available template variables: path.

DownloadFile

xs:string

optional

Specifies function implementing download file. Available template variables: path.

GetListing

xs:string

optional

Specifies function implementing get file and folder listing. Available template variables: path.

GetPath

xs:string

optional

Specifies path transform expression. Available template variables: path.

Name

xs:string

optional

Specifies root name.

RenameFile

xs:string

optional

Specifies function implementing rename file. Available template variables: oldPath, newPath.

SetFileTime

xs:string

optional

Specifies function setting modified file time.  Available template variables: path, time.

UploadFile

xs:string

optional

Specifies function implementing upload file. Available template variables: fromStream, toPath.

Source

<xs:complexType name="FileManagerRoot">
  <xs:sequence>
    <xs:element name="Listing" type="config:FileManagerListing" minOccurs="0" maxOccurs="unbounded"/>
  </xs:sequence>
  <xs:attribute name="Name" type="xs:string" use="optional">
    <xs:annotation>
      <xs:documentation>Specifies root name.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="GetPath" type="xs:string" use="optional">
    <xs:annotation>
      <xs:documentation>Specifies path transform expression. Available template variables: path.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="UploadFile" type="xs:string" use="optional">
    <xs:annotation>
      <xs:documentation>Specifies function implementing upload file. Available template variables: fromStream, toPath.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="DownloadFile" type="xs:string" use="optional">
    <xs:annotation>
      <xs:documentation>Specifies function implementing download file. Available template variables: path.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="SetFileTime" type="xs:string" use="optional">
    <xs:annotation>
      <xs:documentation>Specifies function setting modified file time. Available template variables: path, time.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="CreateDirectory" type="xs:string" use="optional">
    <xs:annotation>
      <xs:documentation>Specifies function implementing create directory. Available template variables: path.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="DeleteDirectory" type="xs:string" use="optional">
    <xs:annotation>
      <xs:documentation>Specifies function implementing delete directory. Available template variables: path.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="DeleteFile" type="xs:string" use="optional">
    <xs:annotation>
      <xs:documentation>Specifies function implementing delete file. Available template variables: path.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="RenameFile" type="xs:string" use="optional">
    <xs:annotation>
      <xs:documentation>Specifies function implementing rename file. Available template variables: oldPath, newPath.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="GetListing" type="xs:string" use="optional">
    <xs:annotation>
      <xs:documentation>Specifies function implementing get file and folder listing. Available template variables: path.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
</xs:complexType>

[ top ]

Complex Type config:FileManagerListing

Children

config:FileManagerItem

Attributes

QName

Type

Use

Annotation

Query

xs:string

required

Specifies listing retrieve query.

Resource

xs:string

required

Specifies resource for this listing.

Source

<xs:complexType name="FileManagerListing">
  <xs:sequence>
    <xs:element name="Item" type="config:FileManagerItem"/>
  </xs:sequence>
  <xs:attribute name="Resource" type="xs:string" use="required">
    <xs:annotation>
      <xs:documentation>Specifies resource for this listing.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="Query" type="xs:string" use="required">
    <xs:annotation>
      <xs:documentation>Specifies listing retrieve query.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
</xs:complexType>

[ top ]

Complex Type config:FileManagerItem

Attributes

QName

Type

Use

Annotation

FullName

xs:string

required

Specifies expression to extract item full name.

IsDirectory

xs:string

optional

Specifies expression to extract if item is directory.

ModifiedTime

xs:string

optional

Specifies expression to extract item modified time.

Size

xs:string

optional

Specifies expression to extract item size.

Source

<xs:complexType name="FileManagerItem">
  <xs:attribute name="FullName" type="xs:string" use="required">
    <xs:annotation>
      <xs:documentation>Specifies expression to extract item full name.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="Size" type="xs:string" use="optional">
    <xs:annotation>
      <xs:documentation>Specifies expression to extract item size.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="ModifiedTime" type="xs:string" use="optional">
    <xs:annotation>
      <xs:documentation>Specifies expression to extract item modified time.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="IsDirectory" type="xs:string" use="optional">
    <xs:annotation>
      <xs:documentation>Specifies expression to extract if item is directory.</xs:documentation>
    </xs:annotation>
  </xs:attribute>
</xs:complexType>

[ top ]

Element config:Script

Properties

content

complex

Used by

Element

config:ConnectionManager

Children

config:Module

Instance

<config:Script xmlns:config="http://www.cozyroc.com/schema/rcm-config-1.0.xsd">
  <config:Module Name="">{1,unbounded}</config:Module>
</config:Script>

Source

<xs:element name="Script">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="config:Module" maxOccurs="unbounded"/>
    </xs:sequence>
  </xs:complexType>
</xs:element>

[ top ]

Element config:Module

Type

extension of xs:string

Properties

content

complex

Used by

Element

config:Script

Attributes

QName

Type

Use

Annotation

Name

xs:string

optional

Specifies module name.

Source

<xs:element name="Module">
  <xs:complexType>
    <xs:simpleContent>
      <xs:extension base="xs:string">
        <xs:attribute name="Name" type="xs:string" use="optional">
          <xs:annotation>
            <xs:documentation>Specifies module name.</xs:documentation>
          </xs:annotation>
        </xs:attribute>
      </xs:extension>
    </xs:simpleContent>
  </xs:complexType>
</xs:element>

[ top ]

SSIS+ Components Suite

SSIS NoW

Excel Add-in for SAS

Showing:

Table of Contents

Example

Knowledge Base

Newsletter

Contact Us

Follow Us

Support