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}
namespace Field2Office.API.Model.DiscreetDocument

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type DiscreetDocumentField() = 
        member val Key:String = null with get,set
        member val Name:String = null with get,set
        member val Description:String = null with get,set
        member val DataType:String = null with get,set
        member val Indexed:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type DiscreetDocumentSchema() = 
        member val Workspace:String = null with get,set
        member val Created:String = null with get,set
        member val LastUpdated:String = null with get,set
        member val Type:String = null with get,set
        member val Name:String = null with get,set
        member val Description:String = null with get,set
        member val FieldDefs:ResizeArray<DiscreetDocumentField> = new ResizeArray<DiscreetDocumentField>() with get,set
        member val Enabled:Nullable<Boolean> = new Nullable<Boolean>() with get,set

F# DiscreetDocumentSchema DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Workspace: String,
	Created: String,
	LastUpdated: String,
	Type: String,
	Name: String,
	Description: String,
	FieldDefs: 
	[
		{
			Key: String,
			Name: String,
			Description: String,
			DataType: String,
			Indexed: False
		}
	],
	Enabled: False
}