Field Squared API Services

<back to all web services

DiscreetDocumentSchema

The following routes are available for this service:
GET, PUT, POST, DELETE/{Workspace}/DiscreetDocumentSchema
GET, PUT POST, DELETE/{Workspace}/DiscreetDocumentSchema/{Type}
DiscreetDocumentSchema Parameters:
NameParameterData TypeRequiredDescription
WorkspacepathstringNo
CreatedbodystringNo
LastUpdatedbodystringNo
TypepathstringNo
NamebodystringNo
DescriptionbodystringNo
FieldDefsbodyList<DiscreetDocumentField>No
Enabledbodybool?No
DiscreetDocumentField Parameters:
NameParameterData TypeRequiredDescription
KeyformstringNo
NameformstringNo
DescriptionformstringNo
DataTypeformstringNo
IndexedformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /{Workspace}/DiscreetDocumentSchema HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DiscreetDocumentSchema xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.DiscreetDocument">
  <Created>String</Created>
  <Description>String</Description>
  <Enabled>false</Enabled>
  <FieldDefs>
    <DiscreetDocumentField>
      <DataType>String</DataType>
      <Description>String</Description>
      <Indexed>false</Indexed>
      <Key>String</Key>
      <Name>String</Name>
    </DiscreetDocumentField>
  </FieldDefs>
  <LastUpdated>String</LastUpdated>
  <Name>String</Name>
  <Type>String</Type>
  <Workspace>String</Workspace>
</DiscreetDocumentSchema>