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

/** @description Contains the data for a catalog within the system. */
export class Catalog
{
    public Workspace: string;
    public AssignedWorkspace: string;
    public ObjectId: string;
    public VersionId: string;
    public BasedOn: string;
    public ExternalId: string;
    public Created: string;
    public LastUpdated: string;
    public Name: string;
    public Type: string;
    public Parent: string;
    public Ancestors: string[];
    public Items: { [index: string]: { [index:string]: string; }; };
    public Enabled: boolean;

    public constructor(init?: Partial<Catalog>) { (Object as any).assign(this, init); }
}

TypeScript Catalog DTOs

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

HTTP + CSV

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

{"Workspace":"String","AssignedWorkspace":"String","ObjectId":"String","VersionId":"String","BasedOn":"String","ExternalId":"String","Created":"String","LastUpdated":"String","Name":"String","Type":"String","Parent":"String","Ancestors":["String"],"Items":{"String":{"String":"String"}},"Enabled":false}