Field Squared API Services

<back to all web services

InternalMetadata

Returns a standardized metadata for an internal object.

The following routes are available for this service:
GET/{Workspace}/InternalMetadata/{ObjectType}
GET/{Workspace}/InternalMetadata/{ObjectType}/{SubObjectType}
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Field2Office.API.Model.Integration

Namespace Global

    Namespace Field2Office.API.Model.Integration

        '''<Summary>
        '''Returns a standardized metadata for an internal object. 
        '''</Summary>
        Public Partial Class InternalMetadata
            Public Sub New()
                Items = New List(Of MetadataItem)
            End Sub

            Public Overridable Property Workspace As String
            Public Overridable Property ObjectType As String
            Public Overridable Property SubObjectType As String
            Public Overridable Property Items As List(Of MetadataItem)
        End Class

        Public Partial Class MetadataItem
            Public Overridable Property Name As String
            Public Overridable Property Datatype As String
            Public Overridable Property Length As String
            Public Overridable Property Label As String
        End Class
    End Namespace
End Namespace

VB.NET InternalMetadata DTOs

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.

GET /{Workspace}/InternalMetadata/{ObjectType} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/xml