Using the Management API with Contentful and .NET

1
var httpClient = new HttpClient();
2
var client = new ContentfulManagementClient(httpClient, "<content_management_api_key>", "<space_id>")

1
var space = await client.CreateSpace("<space_name>", "<default_locale>", "<organization_id>");
2
Console.WriteLine(space.Name); // => <space_name>

1
var space = await client.DeleteSpace("<space_id>");

1
var space = await client.UpdateSpaceName("<space_id>", "<new_space_name>", "<space_version>", "<organization_id>");

1
var space = await client.GetSpace("<space_id>")
2
var version = space.SystemProperties.Version; // Nullable int
3
await client.UpdateSpaceName("<space_id>", "<new_space_name>", version.Value);

1
var contentType = new ContentType();
2
contentType.SystemProperties = new SystemProperties();
3
contentType.SystemProperties.Id = "<content_type_id>";
4
contentType.Name = "Product";
5
contentType.Description = "";

1
contentType.Fields = new List<Field>()
2
{
3
    new Field()
4
    {
5
        Name = "Product name",
6
        Id = "productName",
7
        Type = "Text",
8
        Required = true,
9
        Localized = false,
10
        Disabled = false,
11
        Omitted = false,
12
    },
13
    new Field()
14
    {
15
        Name = "Slug",
16
        Id = "slug",
17
        Type = "Symbol",
18
        Required = false,
19
        Localized = true,
20
        Disabled = false,
21
        Omitted = false
22
    },
23
    new Field()
24
    {
25
        Name = "Description",
26
        Id = "productDescription",
27
        Type = "Text",
28
        Required = false,
29
        Localized = false,
30
        Disabled = true,
31
        Omitted = false
32
    },
33
    new Field()
34
    {
35
        Name = "Size/Type/Color",
36
        Id = "sizetypecolor",
37
        Type = "Symbol",
38
        Required = false,
39
        Localized = false,
40
        Disabled = false,
41
        Omitted = false
42
    },
43
    new Field()
44
    {
45
        Name = "Image",
46
        Id = "image",
47
        Type = "Asset",
48
        Required = false,
49
        Localized = false,
50
        Disabled = false,
51
        Omitted = false,
52
        LinkType = "Asset",
53
        Validations = new List<IFieldValidator>() {
54
            new MimeTypeValidator(MimeTypeRestriction.Image, "My custom validation message")
55
        }
56
    },
57
    new Field()
58
    {
59
        Name = "Tags",
60
        Id = "tags",
61
        Type = "Array",
62
        Required = false,
63
        Localized = false,
64
        Disabled = false,
65
        Omitted = false,
66
        Items = new Schema() {
67
            Type = "Symbol"
68
        },
69
    },
70
    new Field()
71
    {
72
        Name = "Categories",
73
        Id = "categories",
74
        Type = "Array",
75
        Required = false,
76
        Localized = false,
77
        Disabled = false,
78
        Omitted = false,
79
        Items = new Schema() {
80
          Type = "Link",
81
          LinkType = "Entry"
82
        },
83
    },
84
    new Field()
85
    {
86
        Name = "Price",
87
        Id = "price",
88
        Type = "Number",
89
        Required = false,
90
        Localized = false,
91
        Disabled = false,
92
        Omitted = false
93
    },
94
    new Field()
95
    {
96
        Name = "Brand",
97
        Id = "brand",
98
        Type = "Link",
99
        Required = false,
100
        Localized = false,
101
        Disabled = false,
102
        Omitted = false,
103
        LinkType = "Entry"
104
    },
105
    new Field()
106
    {
107
        Name = "Quantity",
108
        Id = "quantity",
109
        Type = "Integer",
110
        Required = false,
111
        Localized = false,
112
        Disabled = false,
113
        Omitted = false
114
    },
115
    new Field()
116
    {
117
        Name = "SKU",
118
        Id = "sku",
119
        Type = "Symbol",
120
        Required = false,
121
        Localized = false,
122
        Disabled = false,
123
        Omitted = false
124
    },
125
    new Field()
126
    {
127
        Name = "Available at",
128
        Id = "website",
129
        Type = "Symbol",
130
        Required = false,
131
        Localized = false,
132
        Disabled = false,
133
        Omitted = false,
134
        Validations = new List<IFieldValidator>() {
135
          // REGEX
136
        }
137
    },
138
};

1
contentType.DisplayField = "productName";
2
3
await _client.CreateOrUpdateContentType(contentType);

1
new Field()
2
{
3
    Name = "The name of the field", // The human readable name of the field e.g. "Top image" or "Main heading"
4
    Id = "field1", // The id for the field, must be between 2 and 60 characters long and only include alphanumerical characters, dashes, underscores or periods.
5
    Type = "Link", // The field type. This determines how the data is stored. E.g. "Date", "Text" or "Integer".
6
    Required = false, // Whether this field is mandatory for this content type.
7
    Localized = false, // Whether this field should be localized.
8
    Disabled = false, // Whether this field is disabled for editing.
9
    Omitted = false, // Whether this field should be omitted from the API response entirely
10
    LinkType = "Entry",  // Applicable if Type is "Link", whether this links to an Entry or an Asset
11
    Items = new Schema() {  // Applicable if the Type is "Array" and specifies allowed item types for the array
12
        Type = "Link", // The type this array field should contain, e.g. "Symbol" or "Link"
13
        LinkType = "Entry" // Applicable if the item type is Link, specifies whether the array contains Entry or Asset
14
    },
15
    Validations = new List<IFieldValidator>() // See validations section below
16
}

1
new Field()
2
{
3
    Name = "Product name",
4
    Id = "productName",
5
    Type = "Text",
6
}

1
new Field()
2
{
3
  Name = "Brand",
4
  Id = "brand",
5
  Type = "Link",
6
  Validations = new List<IFieldValidator>() {
7
      new LinkContentTypeValidator(message: "My custom validation message", "<content_type_id>", "<content_type_id>" ...)
8
  }
9
}

1
new Field()
2
{
3
  Name = "Tags",
4
  Id = "tags",
5
  Type = "Text",
6
  Validations = new List<IFieldValidator>() {
7
      new InValuesValidator(message: "This is not a valid tag", "<value1>", "<value2>" ...)
8
  }
9
}

1
new Field()
2
{
3
    Name = "Image",
4
    Id = "image",
5
    Type = "Text",
6
    Validations = new List<IFieldValidator>() {
7
        new MimeTypeValidator(MimeTypeRestriction.Image, "Not a valid image")
8
    }
9
}

1
new Field()
2
{
3
    Name = "Tags",
4
    Id = "tags",
5
    Type = "Array",
6
    Validations = new List<IFieldValidator>() {
7
        new SizeValidator(min: 2, max: 7, message: "Sorry, you must add between 2 and 7 tags.")
8
    }
9
}

1
// This SizeValidator allows a maximum of 5 items, but as it has no minimum value it can contain 0 items.
2
new SizeValidator(min: null, max: 5, message: "Sorry, you may add a maximum of 5 tags.")
3
4
// This SizeValidator specifies that the field must contain at least 4 items, but there is no upper bound.
5
new SizeValidator(min: 4, max: null, message: "Sorry, you must add at least 4 tags.")

1
new Field()
2
{
3
  Name = "Quantity",
4
  Id = "quantity",
5
  Type = "Number",
6
  Validations = new List<IFieldValidator>() {
7
      new RangeValidator(min: 10, max: 1000, message: "Quantities must be between 10 and 1000.")
8
  }
9
}

1
new Field()
2
  {
3
  Name = "Availabe at",
4
  Id = "website",
5
  Type = "Symbol",
6
  Validations = new List<IFieldValidator>() {
7
      new RegexValidator(expression: "\\b((?:[a-z][\\w-]+:(?:\\/{1,3}|[a-z0-9%])|www\\d{0,3}[.]|[a-z0-9.\\-]+[.][a-z]{2,4}\\/)(?:[^\\s()<>]+|\\(([^\\s()<>]+|(\\([^\\s()<>]+\\)))*\\))+(?:\\(([^\\s()<>]+|(\\([^\\s()<>]+\\)))*\\)|[^\\s`!()\\[\\]{};:'\".,<>?«»""'']))", flags: "i", message: "The value isn't a valid web address.")
8
  }
9
}

1
new Field()
2
{
3
  Name = "Name",
4
  Id = "productName",
5
  Type = "Text",
6
  Validations = new List<IFieldValidator>() {
7
      new UniqueValidator(message: "Sorry, product names must be unique.")
8
  }
9
}

1
var contentType = await client.ActivateContentType("<content_type_id>", version: 7);

1
var contentType = await client.DeactivateContentType("<content_type_id>");

1
var contentType = await client.DeleteContentType("<content_type_id>");

1
var contentTypes = await client.GetContentTypes(); // Gets all content types of the space
2
var contentType = await client.GetContentType("<content_type_id>"); // Gets a single content type
3
var activeContentTypes = await client.GetActivatedContentTypes(); // Gets the latest activated version of all content types

1
var editorInterface = await client.GetEditorInterface("<content_type_id>");

1
var editorInterface = await client.GetEditorInterface("<content_type_id>");
2
3
editorInterface.Controls.First(f => f.FieldId == "productName").WidgetId = SystemWidgetIds.SingleLine;
4
5
var boolField = editorInterface.Controls.First(f => f.FieldId == "preorder")
6
boolField.WidgetId = SystemWidgetIds.Boolean;
7
boolField.Settings = new BooleanEditorInterfaceControlSettings()
8
{
9
  HelpText = "Is the product available?",
10
  TrueLabel = "Yes",
11
  FalseLabel = "No"
12
}
13
await client.UpdateEditorInterface(editorInterface, "<content_type_id>", editorInterface.SystemProperties.Version.Value);

1
var editorInterfaceControl =  new EditorInterfaceControl()
2
{
3
  FieldId = "<field_id>",
4
  WidgetId = "<widget_id>",
5
  Settings = new EditorInterfaceControlSettings()
6
}

1
var boolEditorInterfaceControlSettings = new BooleanEditorInterfaceControlSettings()
2
{
3
  HelpText = "Is the product available?",
4
  TrueLabel = "Yes",
5
  FalseLabel = "No"
6
};
7
8
var ratingEditorInterfaceControlSettings = new RatingEditorInterfaceControlSettings()
9
{
10
  HelpText = "Rate the product",
11
  NumberOfStars = 7, // The number of stars to display in the rating widget, default is 5
12
};
13
14
var datepickerEditorInterfaceControlSettings = new DatePickerEditorInterfaceControlSettings()
15
{
16
  HelpText = "Set the date of release",
17
  DateFormat = EditorInterfaceDateFormat.time, // The format of the date, can be time, timeZ or dateonly
18
  ClockFormat = "24" // The format of the clock, can be 12 or 24
19
}

1
var entries = await client.GetEntriesCollection<Entry<dynamic>>();

1
var entry = await _client.GetEntry("<entry_id>");

1
var entry = new Entry<dynamic>();
2
entry.SystemProperties = new SystemProperties();
3
entry.SystemProperties.Id = "Accessories";
4
5
entry.Fields = new
6
{
7
    Title = new Dictionary<string, string>()
8
    {
9
        { "en-US", "Accessories" },
10
        { "sv-SE", "Tillbehör"}
11
    },
12
    Icon = new Dictionary<string, string>()
13
    {
14
        { "en-US", "Icon" }
15
    },
16
    Description = new Dictionary<string, int>()
17
    {
18
        { "en-US", "Small items to make you life or home complete." },
19
        { "sv-SE", "Små saker för att göra ditt liv eller hem komplett." }
20
    }
21
};
22
23
var newEntry = await _client.CreateOrUpdateEntry(entry, contentTypeId: "<category_content_type_id>");

1
var entry = new Entry<dynamic>();
2
entry.SystemProperties = new SystemProperties();
3
entry.SystemProperties.Id = "Accessories";
4
5
entry.Fields = new
6
{
7
    SingleAsset = new Dictionary<string, dynamic>()
8
    {
9
        { "en-US", new { sys = { type = "Link", linkType = "Asset", id = "<id_of_asset_reference>" } } },
10
        { "sv-SE", new { sys = { type = "Link", linkType = "Asset", id = "<id_of_asset_reference>" } } }
11
    },
12
    MultipleAssets = new Dictionary<string, List<dynamic>>()
13
    {
14
        { "en-US", new List<dynamic> { new { sys = { type = "Link", linkType = "Asset", id = "<id_of_asset_reference>" } } } }
15
    },
16
    SingleEntry = new Dictionary<string, dynamic>()
17
    {
18
        { "en-US", new { sys = { type = "Link", linkType = "Entry", id = "<id_of_entry_reference>" } } },
19
        { "sv-SE", new { sys = { type = "Link", linkType = "Entry", id = "<id_of_entry_reference>" } } }
20
    },
21
    MultipleEntries = new Dictionary<string, List<dynamic>>()
22
    {
23
        { "en-US", new List<dynamic> { new { sys = { type = "Link", linkType = "Entry", id = "<id_of_entry_reference>" } } } }
24
    }
25
};
26
27
var newEntry = await _client.CreateOrUpdateEntry(entry, contentTypeId: "<category_content_type_id>");

1
var entry = new Entry<dynamic>();
2
entry.SystemProperties = new SystemProperties();
3
entry.SystemProperties.Id = "Accessories";
4
5
entry.Fields = new
6
{
7
    SingleAsset = new Dictionary<string, Reference>()
8
    {
9
        { "en-US", new Reference (LinkType = SystemLinkTypes.Asset, Id = "<id_of_asset_reference>") },
10
        { "sv-SE", new Reference (LinkType = SystemLinkTypes.Asset, Id = "<id_of_asset_reference>") }
11
    },
12
    MultipleAssets = new Dictionary<string, List<Reference>>()
13
    {
14
        { "en-US", new List<Reference> { new Reference (LinkType = SystemLinkTypes.Asset, Id = "<id_of_asset_reference>") } }
15
    },
16
    SingleEntry = new Dictionary<string, Reference>()
17
    {
18
        { "en-US", new Reference (SystemLinkTypes.Entry, Id = "<id_of_entry_reference>") },
19
        { "sv-SE", new Reference (SystemLinkTypes.Entry, Id = "<id_of_entry_reference>") }
20
    },
21
    MultipleEntries = new Dictionary<string, List<Reference>>()
22
    {
23
        { "en-US", new List<Reference> { new Reference (LinkType = SystemLinkTypes.Entry, Id = "<id_of_entry_reference>") } }
24
    }
25
};
26
27
var newEntry = await _client.CreateOrUpdateEntry(entry, contentTypeId: "<category_content_type_id>");

1
var product = new Product();
2
product.Title = new Dictionary<string, string>() { { "en-US", "Bread" } };
3
4
await client.CreateEntry<Product>(product, contentTypeId:"product");

1
var product = new Product();
2
product.Title = new Dictionary<string, string>() { { "en-US", "Bread" } };
3
4
await client.CreateOrUpdateEntry<Product>(product, id:"abc123", version: 12);

1
var product = new Product();
2
product.Title = "Fidget spinner";
3
4
await client.UpdateEntryForLocale<Product>(product, id: "abc123", locale: "en-US");
5
//locale will default to the default locale of the space, which means you can omit it if you're setting values for the default locale.

1
client.PublishEntry("<entry_id>", version);

1
client.UnpublishEntry("<entry_id>", version);

1
client.ArchiveEntry("<entry_id>", version);

1
client.UnarchiveEntry("<entry_id>", version);

1
client.DeleteEntry("<entry_id>", version);

1
var assets = await client.GetAssetsCollection();
2
3
var publishedAssets = await client.GetPublishedAssetsCollection();
4
5
var asset = await client.GetAsset("<asset_id>");
6
var title = asset.Title["en-US"];
7
var swedishTitle = asset.Title["sv-SE"];
8
var englishAssetUrl = asset.Files["en-US"].Url;

1
var managementAsset = new ManagementAsset();
2
3
managementAsset.SystemProperties = new SystemProperties();
4
managementAsset.SystemProperties.Id = "<new_asset_id>";
5
6
managementAsset.Title = new Dictionary<string, string> {
7
    { "en-US", "New asset" },
8
    { "sv-SE", "Ny tillgång" }
9
};
10
11
managementAsset.Files = new Dictionary<string, File>
12
{
13
    { "en-US", new File() {
14
            ContentType = "image/png",
15
            FileName = "image.png",
16
            UploadUrl = "https://example.com/image.png"
17
        }
18
    },
19
    { "sv-SE", new File() {
20
            ContentType = "image/png",
21
            FileName = "image.png",
22
            UploadUrl = "https://example.com/image-SE.png"
23
        }
24
    }
25
};
26
27
await client.CreateOrUpdateAsset(managementAsset);

1
await client.ProcessAsset("<new_asset_id>", version, locale);

1
await client.PublishAsset("<new_asset_id>", version);

1
await client.UnpublishAsset("<new_asset_id>", version);

1
await client.ArchiveAsset("<new_asset_id>", version);

1
await client.UnarchiveAsset("<new_asset_id>", version);

1
await client.DeleteAsset("<new_asset_id>", version);

1
var binaryFileByteArray = File.ReadAllBytes("c:\example\yourfile.txt");
2
var uploadReference = await client.UploadFile("<new_asset_id>", version);

1
//Set the properties that are not allowed to null to make sure they're not serialized with the request.
2
uploadReference.SystemProperties.CreatedAt = null;
3
uploadReference.SystemProperties.CreatedBy = null;
4
uploadReference.SystemProperties.Space = null;
5
6
var managementAsset = new ManagementAsset();
7
8
managementAsset.SystemProperties = new SystemProperties();
9
managementAsset.SystemProperties.Id = "<new_asset_id>";
10
11
managementAsset.Title = new Dictionary<string, string> {
12
    { "en-US", "New asset" }
13
};
14
15
managementAsset.Files = new Dictionary<string, File>
16
{
17
    { "en-US", new File() {
18
            ContentType = "text/plain",
19
            FileName = "your-file.txt",
20
            UploadReference = uploadReference;
21
        }
22
    }
23
};
24
25
await client.CreateOrUpdateAsset(managementAsset);

1
var bytes = File.ReadAllBytes("c:\example\yourfile.txt");
2
3
var managementAsset = new ManagementAsset();
4
5
managementAsset.SystemProperties = new SystemProperties();
6
managementAsset.SystemProperties.Id = "<new_asset_id>";
7
8
managementAsset.Title = new Dictionary<string, string> {
9
    { "en-US", "New asset" }
10
};
11
12
managementAsset.Files = new Dictionary<string, File>
13
{
14
    { "en-US", new File() {
15
            ContentType = "text/plain",
16
            FileName = "your-file.txt"
17
        }
18
    }
19
};
20
21
await client.UploadFileAndCreateAsset(managementAsset, bytes);

1
await client.GetUpload("<upload_reference_id>");
2
3
await client.DeleteUpload("<upload_reference_id>");

1
var locales = await client.GetLocalesCollection(); // Fetches all locales for a space.
2
3
var locale = await client.GetLocale("<locale_id>"); // Note that this parameter is not the locale code or name, but the actual id.
4
locale.Code; // => "en-GB"
5
locale.Name; // => "British English"

1
var newLocale = new Local()
2
{
3
    Name = "Swenglish", // The name of the locale
4
    Code = "en-SV", // The code of the locale, can be an arbitrary string
5
    FallbackCode = "en-GB", // The code of the locale to fallback to if this locale is missing a translation for a given field
6
    Optional = true, // Whether this locale allows for empty required fields, this is important to allow a locale to fallback to another locale if missing
7
    ContentDeliveryApi = true, // Whether this locale should be enabled in the API response for the delivery api
8
    ContentManagementApi = true // Whether this locale should be visible in the management api
9
};
10
11
await client.CreateLocale(locale);

1
await client.DeleteLocale("<locale_id>");