Transform Definition
The transform definition. Use to store, retrieve and edit pre-defined transforms within the API.
TransformDefinition [Schema]
Name | Type | Required | Description |
---|---|---|---|
Title | xsd:string
(
min: 3
max: 200)
Pattern: [A-Za-z0-9\- ]* |
yes | The transform definition title. Meta data only; not used during transform generation. |
Definition | xsd:string | yes | The transform definition content. Structured serialised description of how the tranformation should be performed. |
DefinitionType | xsd:string ( min: 3 max: 200) | yes | The transform definition title. Meta data only; not used during transform generation. |
ContentType | xsd:string ( min: 3 max: 200) | yes | The output type of the transformation, this should be a valid mime-type. |
SupportedReports | xsd:string ( min: 3 max: 300) | no | Optional list of supported reports to which the transformation defintion is relevent to. |
TaxYear | TaxYear | no | Optional tax year; used to filter the transformation definitions by tax year if appropriate. |
Readonly | xsd:boolean | yes | The transform definition read only status. Read only transform definitions cannot be altered or deleted. |
Example
<?xml version="1.0"?>
<TransformDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Title>string</Title>
<Definition>string</Definition>
<DefinitionType>string</DefinitionType>
<ContentType>string</ContentType>
<SupportedReports>string</SupportedReports>
<TaxYear>123</TaxYear>
<Readonly>true</Readonly>
</TransformDefinition>
{
"TransformDefinition": {
"Title": "string",
"Definition": "string",
"DefinitionType": "string",
"ContentType": "string",
"SupportedReports": "string",
"TaxYear": "123",
"Readonly": "true"
}
}