Field Squared API Services

<back to all web services

Catalog

Contains the data for a catalog within the system.

The following routes are available for this service:
GET,POST,PUT,DELETE/{Workspace}/Catalog/{ObjectId}
GET/{Workspace}/Catalog
import Foundation
import ServiceStack

/**
* Contains the data for a catalog within the system.
*/
public class Catalog : Codable
{
    public var workspace:String
    public var assignedWorkspace:String
    public var objectId:String
    public var versionId:String
    public var basedOn:String
    public var externalId:String
    public var created:String
    public var lastUpdated:String
    public var name:String
    public var type:String
    public var parent:String
    public var ancestors:[String] = []
    public var items:[String:[String:String]] = [:]
    public var enabled:Bool

    required public init(){}
}


Swift Catalog 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.

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

<Catalog xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Catalogs">
  <Ancestors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Ancestors>
  <AssignedWorkspace>String</AssignedWorkspace>
  <BasedOn>String</BasedOn>
  <Created>String</Created>
  <Enabled>false</Enabled>
  <ExternalId>String</ExternalId>
  <Items xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringArrayOfKeyValueOfstringstringty7Ep6D1>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>
        <d2p1:KeyValueOfstringstring>
          <d2p1:Key>String</d2p1:Key>
          <d2p1:Value>String</d2p1:Value>
        </d2p1:KeyValueOfstringstring>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfKeyValueOfstringstringty7Ep6D1>
  </Items>
  <LastUpdated>String</LastUpdated>
  <Name>String</Name>
  <ObjectId>String</ObjectId>
  <Parent>String</Parent>
  <Type>String</Type>
  <VersionId>String</VersionId>
  <Workspace>String</Workspace>
</Catalog>