GET api/v2/meta/getalltablesmetadata

Gets SAFE Table metadata for all tables user has access to

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of SafeTable
NameDescriptionTypeAdditional information
Name

string

Required

Columns

Collection of SafeColumn

Required

Indexes

Collection of SafeTableIndex

Required

Response Formats

application/json, text/json

Sample:
[
  {
    "Name": "sample string 1",
    "Columns": [
      {
        "Name": "sample string 1",
        "DataType": {
          "Name": "sample string 1",
          "MaximumLength": 1,
          "NumericScale": 1
        },
        "IsRequired": true,
        "SearchOptions": [
          {
            "SearchType": "FullSearch",
            "PartialSearchCharacters": 1
          },
          {
            "SearchType": "FullSearch",
            "PartialSearchCharacters": 1
          }
        ],
        "InputOutputFormats": [
          "sample string 1",
          "sample string 2"
        ],
        "DefaultOutputFormat": "sample string 4",
        "IsDataAnonymizationEnabled": true,
        "DefaultAnonymizationBehavior": "MaskedValue"
      },
      {
        "Name": "sample string 1",
        "DataType": {
          "Name": "sample string 1",
          "MaximumLength": 1,
          "NumericScale": 1
        },
        "IsRequired": true,
        "SearchOptions": [
          {
            "SearchType": "FullSearch",
            "PartialSearchCharacters": 1
          },
          {
            "SearchType": "FullSearch",
            "PartialSearchCharacters": 1
          }
        ],
        "InputOutputFormats": [
          "sample string 1",
          "sample string 2"
        ],
        "DefaultOutputFormat": "sample string 4",
        "IsDataAnonymizationEnabled": true,
        "DefaultAnonymizationBehavior": "MaskedValue"
      }
    ],
    "Indexes": [
      {
        "Name": "sample string 1",
        "Type": "PrimaryKey",
        "SubType": "Full",
        "Columns": [
          {
            "Name": "sample string 1",
            "Ordinal": 2,
            "Type": "FullValue",
            "Size": 3
          },
          {
            "Name": "sample string 1",
            "Ordinal": 2,
            "Type": "FullValue",
            "Size": 3
          }
        ]
      },
      {
        "Name": "sample string 1",
        "Type": "PrimaryKey",
        "SubType": "Full",
        "Columns": [
          {
            "Name": "sample string 1",
            "Ordinal": 2,
            "Type": "FullValue",
            "Size": 3
          },
          {
            "Name": "sample string 1",
            "Ordinal": 2,
            "Type": "FullValue",
            "Size": 3
          }
        ]
      }
    ]
  },
  {
    "Name": "sample string 1",
    "Columns": [
      {
        "Name": "sample string 1",
        "DataType": {
          "Name": "sample string 1",
          "MaximumLength": 1,
          "NumericScale": 1
        },
        "IsRequired": true,
        "SearchOptions": [
          {
            "SearchType": "FullSearch",
            "PartialSearchCharacters": 1
          },
          {
            "SearchType": "FullSearch",
            "PartialSearchCharacters": 1
          }
        ],
        "InputOutputFormats": [
          "sample string 1",
          "sample string 2"
        ],
        "DefaultOutputFormat": "sample string 4",
        "IsDataAnonymizationEnabled": true,
        "DefaultAnonymizationBehavior": "MaskedValue"
      },
      {
        "Name": "sample string 1",
        "DataType": {
          "Name": "sample string 1",
          "MaximumLength": 1,
          "NumericScale": 1
        },
        "IsRequired": true,
        "SearchOptions": [
          {
            "SearchType": "FullSearch",
            "PartialSearchCharacters": 1
          },
          {
            "SearchType": "FullSearch",
            "PartialSearchCharacters": 1
          }
        ],
        "InputOutputFormats": [
          "sample string 1",
          "sample string 2"
        ],
        "DefaultOutputFormat": "sample string 4",
        "IsDataAnonymizationEnabled": true,
        "DefaultAnonymizationBehavior": "MaskedValue"
      }
    ],
    "Indexes": [
      {
        "Name": "sample string 1",
        "Type": "PrimaryKey",
        "SubType": "Full",
        "Columns": [
          {
            "Name": "sample string 1",
            "Ordinal": 2,
            "Type": "FullValue",
            "Size": 3
          },
          {
            "Name": "sample string 1",
            "Ordinal": 2,
            "Type": "FullValue",
            "Size": 3
          }
        ]
      },
      {
        "Name": "sample string 1",
        "Type": "PrimaryKey",
        "SubType": "Full",
        "Columns": [
          {
            "Name": "sample string 1",
            "Ordinal": 2,
            "Type": "FullValue",
            "Size": 3
          },
          {
            "Name": "sample string 1",
            "Ordinal": 2,
            "Type": "FullValue",
            "Size": 3
          }
        ]
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfSafeTable xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Paperclip.IOTA.WebApi.Model">
  <SafeTable>
    <Columns>
      <SafeColumn>
        <DataType>
          <MaximumLength>1</MaximumLength>
          <Name>sample string 1</Name>
          <NumericScale>1</NumericScale>
        </DataType>
        <DefaultAnonymizationBehavior>MaskedValue</DefaultAnonymizationBehavior>
        <DefaultOutputFormat>sample string 4</DefaultOutputFormat>
        <InputOutputFormats xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </InputOutputFormats>
        <IsDataAnonymizationEnabled>true</IsDataAnonymizationEnabled>
        <IsRequired>true</IsRequired>
        <MinShreddingFactor>2</MinShreddingFactor>
        <Name>sample string 1</Name>
        <SearchOptions>
          <SafeSearchOption>
            <PartialSearchCharacters>1</PartialSearchCharacters>
            <SearchType>FullSearch</SearchType>
          </SafeSearchOption>
          <SafeSearchOption>
            <PartialSearchCharacters>1</PartialSearchCharacters>
            <SearchType>FullSearch</SearchType>
          </SafeSearchOption>
        </SearchOptions>
        <ShreddingDelimiterCharacters xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:char>65</d5p1:char>
          <d5p1:char>65</d5p1:char>
        </ShreddingDelimiterCharacters>
      </SafeColumn>
      <SafeColumn>
        <DataType>
          <MaximumLength>1</MaximumLength>
          <Name>sample string 1</Name>
          <NumericScale>1</NumericScale>
        </DataType>
        <DefaultAnonymizationBehavior>MaskedValue</DefaultAnonymizationBehavior>
        <DefaultOutputFormat>sample string 4</DefaultOutputFormat>
        <InputOutputFormats xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </InputOutputFormats>
        <IsDataAnonymizationEnabled>true</IsDataAnonymizationEnabled>
        <IsRequired>true</IsRequired>
        <MinShreddingFactor>2</MinShreddingFactor>
        <Name>sample string 1</Name>
        <SearchOptions>
          <SafeSearchOption>
            <PartialSearchCharacters>1</PartialSearchCharacters>
            <SearchType>FullSearch</SearchType>
          </SafeSearchOption>
          <SafeSearchOption>
            <PartialSearchCharacters>1</PartialSearchCharacters>
            <SearchType>FullSearch</SearchType>
          </SafeSearchOption>
        </SearchOptions>
        <ShreddingDelimiterCharacters xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:char>65</d5p1:char>
          <d5p1:char>65</d5p1:char>
        </ShreddingDelimiterCharacters>
      </SafeColumn>
    </Columns>
    <Indexes>
      <SafeTableIndex>
        <Columns>
          <SafeTableIndexColumn>
            <Name>sample string 1</Name>
            <Ordinal>2</Ordinal>
            <Size>3</Size>
            <Type>FullValue</Type>
          </SafeTableIndexColumn>
          <SafeTableIndexColumn>
            <Name>sample string 1</Name>
            <Ordinal>2</Ordinal>
            <Size>3</Size>
            <Type>FullValue</Type>
          </SafeTableIndexColumn>
        </Columns>
        <Name>sample string 1</Name>
        <SubType>Full</SubType>
        <Type>PrimaryKey</Type>
      </SafeTableIndex>
      <SafeTableIndex>
        <Columns>
          <SafeTableIndexColumn>
            <Name>sample string 1</Name>
            <Ordinal>2</Ordinal>
            <Size>3</Size>
            <Type>FullValue</Type>
          </SafeTableIndexColumn>
          <SafeTableIndexColumn>
            <Name>sample string 1</Name>
            <Ordinal>2</Ordinal>
            <Size>3</Size>
            <Type>FullValue</Type>
          </SafeTableIndexColumn>
        </Columns>
        <Name>sample string 1</Name>
        <SubType>Full</SubType>
        <Type>PrimaryKey</Type>
      </SafeTableIndex>
    </Indexes>
    <Name>sample string 1</Name>
  </SafeTable>
  <SafeTable>
    <Columns>
      <SafeColumn>
        <DataType>
          <MaximumLength>1</MaximumLength>
          <Name>sample string 1</Name>
          <NumericScale>1</NumericScale>
        </DataType>
        <DefaultAnonymizationBehavior>MaskedValue</DefaultAnonymizationBehavior>
        <DefaultOutputFormat>sample string 4</DefaultOutputFormat>
        <InputOutputFormats xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </InputOutputFormats>
        <IsDataAnonymizationEnabled>true</IsDataAnonymizationEnabled>
        <IsRequired>true</IsRequired>
        <MinShreddingFactor>2</MinShreddingFactor>
        <Name>sample string 1</Name>
        <SearchOptions>
          <SafeSearchOption>
            <PartialSearchCharacters>1</PartialSearchCharacters>
            <SearchType>FullSearch</SearchType>
          </SafeSearchOption>
          <SafeSearchOption>
            <PartialSearchCharacters>1</PartialSearchCharacters>
            <SearchType>FullSearch</SearchType>
          </SafeSearchOption>
        </SearchOptions>
        <ShreddingDelimiterCharacters xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:char>65</d5p1:char>
          <d5p1:char>65</d5p1:char>
        </ShreddingDelimiterCharacters>
      </SafeColumn>
      <SafeColumn>
        <DataType>
          <MaximumLength>1</MaximumLength>
          <Name>sample string 1</Name>
          <NumericScale>1</NumericScale>
        </DataType>
        <DefaultAnonymizationBehavior>MaskedValue</DefaultAnonymizationBehavior>
        <DefaultOutputFormat>sample string 4</DefaultOutputFormat>
        <InputOutputFormats xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </InputOutputFormats>
        <IsDataAnonymizationEnabled>true</IsDataAnonymizationEnabled>
        <IsRequired>true</IsRequired>
        <MinShreddingFactor>2</MinShreddingFactor>
        <Name>sample string 1</Name>
        <SearchOptions>
          <SafeSearchOption>
            <PartialSearchCharacters>1</PartialSearchCharacters>
            <SearchType>FullSearch</SearchType>
          </SafeSearchOption>
          <SafeSearchOption>
            <PartialSearchCharacters>1</PartialSearchCharacters>
            <SearchType>FullSearch</SearchType>
          </SafeSearchOption>
        </SearchOptions>
        <ShreddingDelimiterCharacters xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:char>65</d5p1:char>
          <d5p1:char>65</d5p1:char>
        </ShreddingDelimiterCharacters>
      </SafeColumn>
    </Columns>
    <Indexes>
      <SafeTableIndex>
        <Columns>
          <SafeTableIndexColumn>
            <Name>sample string 1</Name>
            <Ordinal>2</Ordinal>
            <Size>3</Size>
            <Type>FullValue</Type>
          </SafeTableIndexColumn>
          <SafeTableIndexColumn>
            <Name>sample string 1</Name>
            <Ordinal>2</Ordinal>
            <Size>3</Size>
            <Type>FullValue</Type>
          </SafeTableIndexColumn>
        </Columns>
        <Name>sample string 1</Name>
        <SubType>Full</SubType>
        <Type>PrimaryKey</Type>
      </SafeTableIndex>
      <SafeTableIndex>
        <Columns>
          <SafeTableIndexColumn>
            <Name>sample string 1</Name>
            <Ordinal>2</Ordinal>
            <Size>3</Size>
            <Type>FullValue</Type>
          </SafeTableIndexColumn>
          <SafeTableIndexColumn>
            <Name>sample string 1</Name>
            <Ordinal>2</Ordinal>
            <Size>3</Size>
            <Type>FullValue</Type>
          </SafeTableIndexColumn>
        </Columns>
        <Name>sample string 1</Name>
        <SubType>Full</SubType>
        <Type>PrimaryKey</Type>
      </SafeTableIndex>
    </Indexes>
    <Name>sample string 1</Name>
  </SafeTable>
</ArrayOfSafeTable>