PUT restapi/personal/pages/{elementId}/contentblocks/images/{contentBlockId}/v1
Updates images content block.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| elementId |
The unique identifier of the page element. |
integer |
Required |
| contentBlockId |
The unique identifier of the content block. |
integer |
Required |
Body Parameters
The image content block update request.
Itsolutions.Itslearning.Web.RestApi.Personal.Page.Requests.UpdateContentBlockImagesRequestUI| Name | Description | Type | Additional information |
|---|---|---|---|
| NewImages |
Images to add to the content block. |
Collection of Itsolutions.Itslearning.Web.RestApi.Personal.Page.PageApiModels.Requests.ImageItem |
None. |
| DeletedImageIds |
Image IDs to delete from the content block. |
Collection of integer |
None. |
| UpdatedImages |
Images that should be updated in the content block. |
Collection of Itsolutions.Itslearning.Web.RestApi.Personal.Page.PageApiModels.ImageMetaData |
None. |
| ContentBlockId |
The unique identifier for the content block. |
integer |
None. |
| Type |
The type of the content block (e.g. "text", "image", "files", "rss", "poll"). Defaults to an empty string. |
string |
None. |
| Title |
The title of the content block. Defaults to an empty string. |
string |
None. |
| Order |
The display order of the content block within its Layout Zone. Lower values appear first. |
integer |
None. |
| LayoutZone |
The layout zone where the content block should be placed (e.g. "Left", "Right"). Determines the positioning within the page layout. |
string |
None. |
| Color |
The color of the content block. |
string |
None. |
Request Formats
application/json, text/json
{
"newImages": [
{
"imageFile": {
"fileRepoId": "e0d99d82-8880-491a-a8a6-7a39766f9272",
"signedFileRepoId": "sample string 2",
"name": "sample string 3",
"mimeType": "sample string 4"
},
"largeImageFile": {
"fileRepoId": "b9dcb39b-f787-48dc-b6d2-afd4ee06eb89",
"signedFileRepoId": "sample string 2",
"name": "sample string 3",
"mimeType": "sample string 4"
},
"mediumImageFile": {
"fileRepoId": "57323033-b190-45b8-ad14-b4c5bd7532bc",
"signedFileRepoId": "sample string 2",
"name": "sample string 3",
"mimeType": "sample string 4"
},
"smallImageFile": {
"fileRepoId": "4d8bdf84-db93-403f-91f5-82d091e5b2c0",
"signedFileRepoId": "sample string 2",
"name": "sample string 3",
"mimeType": "sample string 4"
},
"altText": "sample string 1",
"caption": "sample string 2"
},
{
"imageFile": {
"fileRepoId": "87ef44bc-1f95-41e5-83a5-358fd7561aee",
"signedFileRepoId": "sample string 2",
"name": "sample string 3",
"mimeType": "sample string 4"
},
"largeImageFile": {
"fileRepoId": "a6d98618-fc6d-4cba-909b-5e5a9d61ab4e",
"signedFileRepoId": "sample string 2",
"name": "sample string 3",
"mimeType": "sample string 4"
},
"mediumImageFile": {
"fileRepoId": "79c198d4-4bdf-40b9-a22d-52592e65b120",
"signedFileRepoId": "sample string 2",
"name": "sample string 3",
"mimeType": "sample string 4"
},
"smallImageFile": {
"fileRepoId": "542da8b8-d368-4d27-a842-30c8ced358c7",
"signedFileRepoId": "sample string 2",
"name": "sample string 3",
"mimeType": "sample string 4"
},
"altText": "sample string 1",
"caption": "sample string 2"
}
],
"deletedImageIds": [
1,
2
],
"updatedImages": [
{
"imageId": 1,
"altText": "sample string 2",
"caption": "sample string 3"
},
{
"imageId": 1,
"altText": "sample string 2",
"caption": "sample string 3"
}
],
"contentBlockId": 1,
"type": "sample string 2",
"title": "sample string 3",
"order": 4,
"layoutZone": "sample string 5",
"color": "sample string 6"
}
application/xml, text/xml
<UpdateContentBlockImagesRequestUI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Itsolutions.Itslearning.Web.RestApi.Personal.Page.Requests">
<Color>sample string 6</Color>
<ContentBlockId>1</ContentBlockId>
<LayoutZone>sample string 5</LayoutZone>
<Order>4</Order>
<Title>sample string 3</Title>
<Type>sample string 2</Type>
<DeletedImageIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</DeletedImageIds>
<NewImages xmlns:d2p1="http://schemas.datacontract.org/2004/07/Itsolutions.Itslearning.Web.RestApi.Personal.Page.PageApiModels.Requests">
<d2p1:ImageItem>
<d2p1:AltText>sample string 1</d2p1:AltText>
<d2p1:Caption>sample string 2</d2p1:Caption>
<d2p1:ImageFile>
<d2p1:FileRepoId>e0d99d82-8880-491a-a8a6-7a39766f9272</d2p1:FileRepoId>
<d2p1:MimeType>sample string 4</d2p1:MimeType>
<d2p1:Name>sample string 3</d2p1:Name>
<d2p1:SignedFileRepoId>sample string 2</d2p1:SignedFileRepoId>
</d2p1:ImageFile>
<d2p1:LargeImageFile>
<d2p1:FileRepoId>b9dcb39b-f787-48dc-b6d2-afd4ee06eb89</d2p1:FileRepoId>
<d2p1:MimeType>sample string 4</d2p1:MimeType>
<d2p1:Name>sample string 3</d2p1:Name>
<d2p1:SignedFileRepoId>sample string 2</d2p1:SignedFileRepoId>
</d2p1:LargeImageFile>
<d2p1:MediumImageFile>
<d2p1:FileRepoId>57323033-b190-45b8-ad14-b4c5bd7532bc</d2p1:FileRepoId>
<d2p1:MimeType>sample string 4</d2p1:MimeType>
<d2p1:Name>sample string 3</d2p1:Name>
<d2p1:SignedFileRepoId>sample string 2</d2p1:SignedFileRepoId>
</d2p1:MediumImageFile>
<d2p1:SmallImageFile>
<d2p1:FileRepoId>4d8bdf84-db93-403f-91f5-82d091e5b2c0</d2p1:FileRepoId>
<d2p1:MimeType>sample string 4</d2p1:MimeType>
<d2p1:Name>sample string 3</d2p1:Name>
<d2p1:SignedFileRepoId>sample string 2</d2p1:SignedFileRepoId>
</d2p1:SmallImageFile>
</d2p1:ImageItem>
<d2p1:ImageItem>
<d2p1:AltText>sample string 1</d2p1:AltText>
<d2p1:Caption>sample string 2</d2p1:Caption>
<d2p1:ImageFile>
<d2p1:FileRepoId>87ef44bc-1f95-41e5-83a5-358fd7561aee</d2p1:FileRepoId>
<d2p1:MimeType>sample string 4</d2p1:MimeType>
<d2p1:Name>sample string 3</d2p1:Name>
<d2p1:SignedFileRepoId>sample string 2</d2p1:SignedFileRepoId>
</d2p1:ImageFile>
<d2p1:LargeImageFile>
<d2p1:FileRepoId>a6d98618-fc6d-4cba-909b-5e5a9d61ab4e</d2p1:FileRepoId>
<d2p1:MimeType>sample string 4</d2p1:MimeType>
<d2p1:Name>sample string 3</d2p1:Name>
<d2p1:SignedFileRepoId>sample string 2</d2p1:SignedFileRepoId>
</d2p1:LargeImageFile>
<d2p1:MediumImageFile>
<d2p1:FileRepoId>79c198d4-4bdf-40b9-a22d-52592e65b120</d2p1:FileRepoId>
<d2p1:MimeType>sample string 4</d2p1:MimeType>
<d2p1:Name>sample string 3</d2p1:Name>
<d2p1:SignedFileRepoId>sample string 2</d2p1:SignedFileRepoId>
</d2p1:MediumImageFile>
<d2p1:SmallImageFile>
<d2p1:FileRepoId>542da8b8-d368-4d27-a842-30c8ced358c7</d2p1:FileRepoId>
<d2p1:MimeType>sample string 4</d2p1:MimeType>
<d2p1:Name>sample string 3</d2p1:Name>
<d2p1:SignedFileRepoId>sample string 2</d2p1:SignedFileRepoId>
</d2p1:SmallImageFile>
</d2p1:ImageItem>
</NewImages>
<UpdatedImages xmlns:d2p1="http://schemas.datacontract.org/2004/07/Itsolutions.Itslearning.Web.RestApi.Personal.Page.PageApiModels">
<d2p1:ImageMetaData>
<d2p1:AltText>sample string 2</d2p1:AltText>
<d2p1:Caption>sample string 3</d2p1:Caption>
<d2p1:ImageId>1</d2p1:ImageId>
</d2p1:ImageMetaData>
<d2p1:ImageMetaData>
<d2p1:AltText>sample string 2</d2p1:AltText>
<d2p1:Caption>sample string 3</d2p1:Caption>
<d2p1:ImageId>1</d2p1:ImageId>
</d2p1:ImageMetaData>
</UpdatedImages>
</UpdateContentBlockImagesRequestUI>
application/x-www-form-urlencoded
No sample available
Response Information
Resource Description
Updated image content block.
System.Web.Http.IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample not available.