<back to all web services
PublicCatalog
The following routes are available for this service:| GET, PUT, POST, DELETE | /{Workspace}/API/Catalog/{CatalogType} | | |
|---|
| GET, PUT, POST, DELETE | /{Workspace}/API/Catalog | | |
|---|
| GET | /{Workspace}/API/Catalog/Schema/{CatalogType} | | |
|---|
PublicCatalog Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Workspace | path | string | No | |
| CatalogType | path | string | No | |
| Catalog | body | Catalog | No | |
| Catalogs | body | List<Catalog> | No | |
Catalog Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Workspace | form | string | No | |
| AssignedWorkspace | form | string | No | |
| ObjectId | form | string | No | |
| VersionId | form | string | No | |
| BasedOn | form | string | No | |
| ExternalId | form | string | No | |
| Created | form | string | No | |
| LastUpdated | form | string | No | |
| Name | form | string | No | |
| Type | form | string | No | |
| Parent | form | string | No | |
| Ancestors | form | List<string> | No | |
| Items | form | Dictionary<string, Dictionary<String,String>> | No | |
| Enabled | form | bool | No | |
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}/API/Catalog/{CatalogType} HTTP/1.1
Host: dev.fieldsquared.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<PublicCatalog xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.PublicApi.Catalogs">
<Catalog>
<CatalogType>String</CatalogType>
<Created>String</Created>
<Data xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringanyType>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value />
</d3p1:KeyValueOfstringanyType>
</Data>
<LastUpdated>String</LastUpdated>
</Catalog>
<CatalogType>String</CatalogType>
<Catalogs>
<Catalog>
<CatalogType>String</CatalogType>
<Created>String</Created>
<Data xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringanyType>
<d4p1:Key>String</d4p1:Key>
<d4p1:Value />
</d4p1:KeyValueOfstringanyType>
</Data>
<LastUpdated>String</LastUpdated>
</Catalog>
</Catalogs>
<Workspace>String</Workspace>
</PublicCatalog>