| GET, PUT, POST, DELETE | /{Workspace}/API/Catalog/{CatalogType} | ||
|---|---|---|---|
| GET, PUT, POST, DELETE | /{Workspace}/API/Catalog | ||
| GET | /{Workspace}/API/Catalog/Schema/{CatalogType} |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Workspace | path | string | No | |
| CatalogType | path | string | No | |
| Catalog | body | Catalog | No | |
| Catalogs | body | List<Catalog> | No |
| 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 .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Workspace: String,
CatalogType: String,
Catalog:
{
CatalogType: String,
LastUpdated: String,
Created: String,
Data:
{
String: {}
}
},
Catalogs:
[
{
CatalogType: String,
LastUpdated: String,
Created: String,
Data:
{
String: {}
}
}
]
}