Returns a set of data items of type documents.
GET /api/default/documents
None
None
None.
Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.
| Name | Description | Type | Additional Information |
| LastModified | System.DateTimeOffset | Read only: True | |
| PublicationDate | System.DateTimeOffset | Read only: False | |
| Title | System.String | Read only: False | |
| Description | System.String | Read only: False | |
| DateCreated | System.DateTimeOffset | Read only: True | |
| IncludeInSitemap | System.Boolean | Read only: False | |
| SystemSourceKey | System.String | Read only: False | |
| Ordinal | System.Single | Read only: False | |
| UrlName | System.String | Read only: False | |
| ItemDefaultUrl | System.String | Read only: True | |
| EmbedUrl | System.String | Read only: True | |
| Author | System.String | Read only: False | |
| Extension | System.String | Read only: True | |
| MimeType | System.String | Read only: True | |
| TotalSize | System.Int64 | Read only: True | |
| healthtopics | System.Guid | Read only: False | |
| targets | System.Guid | Read only: False | |
| regionscountries | System.Guid | Read only: False | |
| stakeholders | System.Guid | Read only: False | |
| targetaudiences | System.Guid | Read only: False | |
| Category | System.Guid | Read only: False | |
| Tags | System.Guid | Read only: False | |
| departmentaltargets | System.Guid | Read only: False | |
| events | System.Guid | Read only: False | |
| publishingoffices | System.Guid | Read only: False | |
| Parts | System.String | Read only: False | |
| FolderId | System.Guid | Read only: False | |
| ParentId | System.Guid | Read only: False | |
| Provider | System.String | Read only: True | |
| Url | System.String | Read only: True | |
| ThumbnailUrl | System.String | Read only: True | |
| IsDamMedia | System.Boolean | Read only: True |
application/json
[
{
"LastModified": "2026-11-20T10:08:55.0733945Z",
"PublicationDate": "2026-11-20T10:08:55.0733945Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-11-20T10:08:55.0733945Z",
"IncludeInSitemap": true,
"SystemSourceKey": "sample string 7",
"Ordinal": 8.1,
"UrlName": "sample string 9",
"ItemDefaultUrl": "sample string 10",
"EmbedUrl": "sample string 11",
"Author": "sample string 12",
"Extension": "sample string 13",
"MimeType": "sample string 14",
"TotalSize": 15,
"healthtopics": "16854e5d-2a0b-4f4c-ab12-3746987435c9",
"targets": "c4a7ce88-ffc3-4a45-b1dd-eece195a7616",
"regionscountries": "38b9874f-408a-4d74-818f-7969522f3e2b",
"stakeholders": "f28bd8a6-3520-478e-9ccd-86971ad3ac08",
"targetaudiences": "edba4ec9-ed07-4c79-b236-20df432404c9",
"Category": "9fe910ca-3a66-4d8f-a4cd-e8392fca4b49",
"Tags": "ccf5af01-b314-4809-aa4e-7b750993c568",
"departmentaltargets": "baadc948-c0ea-477f-80e2-9b1cff08ad0b",
"events": "ee5c5578-0258-4fcd-90a6-c3e631f3f12c",
"publishingoffices": "d7a72a3c-711b-4949-8697-c0f4734beca0",
"Parts": "sample string 26",
"FolderId": "06417def-3fc1-4aec-b257-f330e33e1a42",
"ParentId": "984275a5-cd19-4627-86d8-54866fe7b5eb",
"Provider": "sample string 29",
"Url": "sample string 30",
"ThumbnailUrl": "sample string 31",
"IsDamMedia": true
},
{
"LastModified": "2026-11-20T10:08:55.0733945Z",
"PublicationDate": "2026-11-20T10:08:55.0733945Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-11-20T10:08:55.0733945Z",
"IncludeInSitemap": true,
"SystemSourceKey": "sample string 7",
"Ordinal": 8.1,
"UrlName": "sample string 9",
"ItemDefaultUrl": "sample string 10",
"EmbedUrl": "sample string 11",
"Author": "sample string 12",
"Extension": "sample string 13",
"MimeType": "sample string 14",
"TotalSize": 15,
"healthtopics": "16854e5d-2a0b-4f4c-ab12-3746987435c9",
"targets": "c4a7ce88-ffc3-4a45-b1dd-eece195a7616",
"regionscountries": "38b9874f-408a-4d74-818f-7969522f3e2b",
"stakeholders": "f28bd8a6-3520-478e-9ccd-86971ad3ac08",
"targetaudiences": "edba4ec9-ed07-4c79-b236-20df432404c9",
"Category": "9fe910ca-3a66-4d8f-a4cd-e8392fca4b49",
"Tags": "ccf5af01-b314-4809-aa4e-7b750993c568",
"departmentaltargets": "baadc948-c0ea-477f-80e2-9b1cff08ad0b",
"events": "ee5c5578-0258-4fcd-90a6-c3e631f3f12c",
"publishingoffices": "d7a72a3c-711b-4949-8697-c0f4734beca0",
"Parts": "sample string 26",
"FolderId": "06417def-3fc1-4aec-b257-f330e33e1a42",
"ParentId": "984275a5-cd19-4627-86d8-54866fe7b5eb",
"Provider": "sample string 29",
"Url": "sample string 30",
"ThumbnailUrl": "sample string 31",
"IsDamMedia": true
}
]Gets documents item by id.
GET /api/default/documents({key})
| Name | Description | Type | Additional Information |
| key | System.Guid | Required |
None
None.
Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.
| Name | Description | Type | Additional Information |
| LastModified | System.DateTimeOffset | Read only: True | |
| PublicationDate | System.DateTimeOffset | Read only: False | |
| Title | System.String | Read only: False | |
| Description | System.String | Read only: False | |
| DateCreated | System.DateTimeOffset | Read only: True | |
| IncludeInSitemap | System.Boolean | Read only: False | |
| SystemSourceKey | System.String | Read only: False | |
| Ordinal | System.Single | Read only: False | |
| UrlName | System.String | Read only: False | |
| ItemDefaultUrl | System.String | Read only: True | |
| EmbedUrl | System.String | Read only: True | |
| Author | System.String | Read only: False | |
| Extension | System.String | Read only: True | |
| MimeType | System.String | Read only: True | |
| TotalSize | System.Int64 | Read only: True | |
| healthtopics | System.Guid | Read only: False | |
| targets | System.Guid | Read only: False | |
| regionscountries | System.Guid | Read only: False | |
| stakeholders | System.Guid | Read only: False | |
| targetaudiences | System.Guid | Read only: False | |
| Category | System.Guid | Read only: False | |
| Tags | System.Guid | Read only: False | |
| departmentaltargets | System.Guid | Read only: False | |
| events | System.Guid | Read only: False | |
| publishingoffices | System.Guid | Read only: False | |
| Parts | System.String | Read only: False | |
| FolderId | System.Guid | Read only: False | |
| ParentId | System.Guid | Read only: False | |
| Provider | System.String | Read only: True | |
| Url | System.String | Read only: True | |
| ThumbnailUrl | System.String | Read only: True | |
| IsDamMedia | System.Boolean | Read only: True |
application/json
{
"LastModified": "2026-11-20T10:08:55.0733945Z",
"PublicationDate": "2026-11-20T10:08:55.0733945Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-11-20T10:08:55.0733945Z",
"IncludeInSitemap": true,
"SystemSourceKey": "sample string 7",
"Ordinal": 8.1,
"UrlName": "sample string 9",
"ItemDefaultUrl": "sample string 10",
"EmbedUrl": "sample string 11",
"Author": "sample string 12",
"Extension": "sample string 13",
"MimeType": "sample string 14",
"TotalSize": 15,
"healthtopics": "3e39480d-a2b2-443c-9bab-9156881ef2b9",
"targets": "1086def0-62fa-4b57-8cf2-3c2ff42b36cf",
"regionscountries": "0778eb97-3ae0-4e70-9d52-37fa8b4e991f",
"stakeholders": "0ce7a179-24cb-41ad-ae1d-e1b5fbf3b2e2",
"targetaudiences": "26650c84-43f1-4264-8a2c-1309a8e71536",
"Category": "5db21391-400f-43ce-b075-7fba8405111f",
"Tags": "9c6ded3f-b91b-4cf1-ba24-b3eda3a6b151",
"departmentaltargets": "8bbdb4b9-48ed-4bd2-908c-e3ed9dda73b4",
"events": "c4688a08-b980-45cf-96a9-bd942237c10b",
"publishingoffices": "ed9a0da6-28f7-4b04-b001-2d2c02967041",
"Parts": "sample string 26",
"FolderId": "f8e3d1f5-8fa7-4f6d-b757-826458a0c514",
"ParentId": "94f41711-c6f0-487f-a083-74defac266b9",
"Provider": "sample string 29",
"Url": "sample string 30",
"ThumbnailUrl": "sample string 31",
"IsDamMedia": true
}Gets Id property from documents item.
GET /api/default/documents({key})/property
| Name | Description | Type | Additional Information |
| key | System.Guid | Required | |
| property | System.String | Required |
None
None.
Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.
| Name | Description | Type | Additional Information |
| Id | System.Guid | Read only: False |
application/json
{
"Id": "da232a92-6af6-4759-af8e-55d0c6f9a3ac"
}Creates a documents item.
POST /api/default/documents
None
| Name | Description | Type | Additional Information |
| LastModified | System.DateTimeOffset | Read only: True | |
| PublicationDate | System.DateTimeOffset | Read only: False | |
| Title | System.String | Read only: False | |
| Description | System.String | Read only: False | |
| DateCreated | System.DateTimeOffset | Read only: True | |
| IncludeInSitemap | System.Boolean | Read only: False | |
| SystemSourceKey | System.String | Read only: False | |
| Ordinal | System.Single | Read only: False | |
| UrlName | System.String | Read only: False | |
| ItemDefaultUrl | System.String | Read only: True | |
| EmbedUrl | System.String | Read only: True | |
| Author | System.String | Read only: False | |
| Extension | System.String | Read only: True | |
| MimeType | System.String | Read only: True | |
| TotalSize | System.Int64 | Read only: True | |
| healthtopics | System.Guid | Read only: False | |
| targets | System.Guid | Read only: False | |
| regionscountries | System.Guid | Read only: False | |
| stakeholders | System.Guid | Read only: False | |
| targetaudiences | System.Guid | Read only: False | |
| Category | System.Guid | Read only: False | |
| Tags | System.Guid | Read only: False | |
| departmentaltargets | System.Guid | Read only: False | |
| events | System.Guid | Read only: False | |
| publishingoffices | System.Guid | Read only: False | |
| Parts | System.String | Read only: False | |
| FolderId | System.Guid | Read only: False | |
| ParentId | System.Guid | Read only: False | |
| Provider | System.String | Read only: True | |
| Url | System.String | Read only: True | |
| ThumbnailUrl | System.String | Read only: True | |
| IsDamMedia | System.Boolean | Read only: True |
application/json
{
"PublicationDate": "2026-11-20T10:08:55.0733945Z",
"Title": "sample string 2",
"Description": "sample string 3",
"IncludeInSitemap": true,
"SystemSourceKey": "sample string 5",
"Ordinal": 6.1,
"UrlName": "sample string 7",
"Author": "sample string 8",
"healthtopics": "e7170bfe-9726-4b54-a162-c8f5dfe61dee",
"targets": "6e2eddce-697b-4408-a091-7698c4debf6a",
"regionscountries": "6fbbad84-36d9-490b-9519-fb6809629a4c",
"stakeholders": "7ce061ff-3296-4c1f-a391-ec63f64709a9",
"targetaudiences": "8f5df695-417a-419c-861a-79ad8267847d",
"Category": "09d2c0e1-7c2d-41bd-82b8-4d7f431f6a52",
"Tags": "e40b342f-49eb-4656-ad54-6385c689960f",
"departmentaltargets": "9d35cb98-19a8-4af8-94b8-24cf1b52ad52",
"events": "85827bbe-ab3f-4e56-be64-5abf76afb293",
"publishingoffices": "4177a647-2098-4e65-9f95-b650e5624df7",
"Parts": "sample string 19",
"FolderId": "f2f9e0fe-bf37-4787-96a7-6d96ed3def10",
"ParentId": "f5001faa-21ab-478f-a992-82683e71979f"
}Method can return success code: Created - 201 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.
| Name | Description | Type | Additional Information |
| LastModified | System.DateTimeOffset | Read only: True | |
| PublicationDate | System.DateTimeOffset | Read only: False | |
| Title | System.String | Read only: False | |
| Description | System.String | Read only: False | |
| DateCreated | System.DateTimeOffset | Read only: True | |
| IncludeInSitemap | System.Boolean | Read only: False | |
| SystemSourceKey | System.String | Read only: False | |
| Ordinal | System.Single | Read only: False | |
| UrlName | System.String | Read only: False | |
| ItemDefaultUrl | System.String | Read only: True | |
| EmbedUrl | System.String | Read only: True | |
| Author | System.String | Read only: False | |
| Extension | System.String | Read only: True | |
| MimeType | System.String | Read only: True | |
| TotalSize | System.Int64 | Read only: True | |
| healthtopics | System.Guid | Read only: False | |
| targets | System.Guid | Read only: False | |
| regionscountries | System.Guid | Read only: False | |
| stakeholders | System.Guid | Read only: False | |
| targetaudiences | System.Guid | Read only: False | |
| Category | System.Guid | Read only: False | |
| Tags | System.Guid | Read only: False | |
| departmentaltargets | System.Guid | Read only: False | |
| events | System.Guid | Read only: False | |
| publishingoffices | System.Guid | Read only: False | |
| Parts | System.String | Read only: False | |
| FolderId | System.Guid | Read only: False | |
| ParentId | System.Guid | Read only: False | |
| Provider | System.String | Read only: True | |
| Url | System.String | Read only: True | |
| ThumbnailUrl | System.String | Read only: True | |
| IsDamMedia | System.Boolean | Read only: True |
application/json
{
"LastModified": "2026-11-20T10:08:55.0733945Z",
"PublicationDate": "2026-11-20T10:08:55.0733945Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-11-20T10:08:55.0733945Z",
"IncludeInSitemap": true,
"SystemSourceKey": "sample string 7",
"Ordinal": 8.1,
"UrlName": "sample string 9",
"ItemDefaultUrl": "sample string 10",
"EmbedUrl": "sample string 11",
"Author": "sample string 12",
"Extension": "sample string 13",
"MimeType": "sample string 14",
"TotalSize": 15,
"healthtopics": "f0ef08ac-08c1-4fb3-9364-52ed5eb6f693",
"targets": "202052f5-b068-4328-9615-cc79af9e72a1",
"regionscountries": "c6a4927b-c9b0-44dd-8947-e89d4ca855b6",
"stakeholders": "3a31fc8c-f508-41dc-aecd-445b4f5b322b",
"targetaudiences": "13c3d30c-39cc-4922-ac99-d09e63136cbc",
"Category": "4db56463-80fa-4b6f-9137-c43528f50ca2",
"Tags": "c200e9c1-c5b0-469a-a0b8-4fa24afd7873",
"departmentaltargets": "cf2a2757-0632-4783-8594-c35ecd48a1b9",
"events": "d4c6e03c-66e7-4d41-b748-f98d174fa67f",
"publishingoffices": "d475f4d3-6b83-4b6f-b2b9-2509fa65806e",
"Parts": "sample string 26",
"FolderId": "9040217e-18ec-4e1a-b115-bfc9ad4ca3f3",
"ParentId": "3be23c02-6007-4daa-a993-ae46f60f1944",
"Provider": "sample string 29",
"Url": "sample string 30",
"ThumbnailUrl": "sample string 31",
"IsDamMedia": true
}Partial update for documents item.
PATCH /api/default/documents({key})
| Name | Description | Type | Additional Information |
| key | System.Guid | Required |
| Name | Description | Type | Additional Information |
| LastModified | System.DateTimeOffset | Read only: True | |
| PublicationDate | System.DateTimeOffset | Read only: False | |
| Title | System.String | Read only: False | |
| Description | System.String | Read only: False | |
| DateCreated | System.DateTimeOffset | Read only: True | |
| IncludeInSitemap | System.Boolean | Read only: False | |
| SystemSourceKey | System.String | Read only: False | |
| Ordinal | System.Single | Read only: False | |
| UrlName | System.String | Read only: False | |
| ItemDefaultUrl | System.String | Read only: True | |
| EmbedUrl | System.String | Read only: True | |
| Author | System.String | Read only: False | |
| Extension | System.String | Read only: True | |
| MimeType | System.String | Read only: True | |
| TotalSize | System.Int64 | Read only: True | |
| healthtopics | System.Guid | Read only: False | |
| targets | System.Guid | Read only: False | |
| regionscountries | System.Guid | Read only: False | |
| stakeholders | System.Guid | Read only: False | |
| targetaudiences | System.Guid | Read only: False | |
| Category | System.Guid | Read only: False | |
| Tags | System.Guid | Read only: False | |
| departmentaltargets | System.Guid | Read only: False | |
| events | System.Guid | Read only: False | |
| publishingoffices | System.Guid | Read only: False | |
| Parts | System.String | Read only: False | |
| FolderId | System.Guid | Read only: False | |
| ParentId | System.Guid | Read only: False | |
| Provider | System.String | Read only: True | |
| Url | System.String | Read only: True | |
| ThumbnailUrl | System.String | Read only: True | |
| IsDamMedia | System.Boolean | Read only: True |
application/json
{
"PublicationDate": "2026-11-20T10:08:55.0733945Z",
"Title": "sample string 2",
"Description": "sample string 3",
"IncludeInSitemap": true,
"SystemSourceKey": "sample string 5",
"Ordinal": 6.1,
"UrlName": "sample string 7",
"Author": "sample string 8",
"healthtopics": "de92bb75-ec14-4fc4-a461-dd58fed81de6",
"targets": "257e46c0-bcd7-4036-bca3-2db9dc2e83eb",
"regionscountries": "79efb154-1cfd-4ca3-8706-c57a80bef59a",
"stakeholders": "4d941496-0a85-435b-81ef-d97ca86b769c",
"targetaudiences": "9a654a0e-3866-496c-b320-51e7d0f6b742",
"Category": "c52b6781-a737-43af-819c-521ae2a5490e",
"Tags": "07199888-6764-4fc7-8d9c-3ab7c84cf5ce",
"departmentaltargets": "182010e8-f930-430f-8556-7f0375c9c24c",
"events": "68604329-1804-482c-9a93-146b4f924423",
"publishingoffices": "9dfa3040-a982-41c2-9225-616adb8e9994",
"Parts": "sample string 19",
"FolderId": "62d973aa-c608-4a8c-be1c-c21a62e1f7d1",
"ParentId": "98579930-c272-4ec7-b695-bb559d54d67b"
}Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.
None.
Full update for documents item.
PUT /api/default/documents({key})
| Name | Description | Type | Additional Information |
| key | System.Guid | Required |
| Name | Description | Type | Additional Information |
| LastModified | System.DateTimeOffset | Read only: True | |
| PublicationDate | System.DateTimeOffset | Read only: False | |
| Title | System.String | Read only: False | |
| Description | System.String | Read only: False | |
| DateCreated | System.DateTimeOffset | Read only: True | |
| IncludeInSitemap | System.Boolean | Read only: False | |
| SystemSourceKey | System.String | Read only: False | |
| Ordinal | System.Single | Read only: False | |
| UrlName | System.String | Read only: False | |
| ItemDefaultUrl | System.String | Read only: True | |
| EmbedUrl | System.String | Read only: True | |
| Author | System.String | Read only: False | |
| Extension | System.String | Read only: True | |
| MimeType | System.String | Read only: True | |
| TotalSize | System.Int64 | Read only: True | |
| healthtopics | System.Guid | Read only: False | |
| targets | System.Guid | Read only: False | |
| regionscountries | System.Guid | Read only: False | |
| stakeholders | System.Guid | Read only: False | |
| targetaudiences | System.Guid | Read only: False | |
| Category | System.Guid | Read only: False | |
| Tags | System.Guid | Read only: False | |
| departmentaltargets | System.Guid | Read only: False | |
| events | System.Guid | Read only: False | |
| publishingoffices | System.Guid | Read only: False | |
| Parts | System.String | Read only: False | |
| FolderId | System.Guid | Read only: False | |
| ParentId | System.Guid | Read only: False | |
| Provider | System.String | Read only: True | |
| Url | System.String | Read only: True | |
| ThumbnailUrl | System.String | Read only: True | |
| IsDamMedia | System.Boolean | Read only: True |
application/json
{
"PublicationDate": "2026-11-20T10:08:55.0733945Z",
"Title": "sample string 2",
"Description": "sample string 3",
"IncludeInSitemap": true,
"SystemSourceKey": "sample string 5",
"Ordinal": 6.1,
"UrlName": "sample string 7",
"Author": "sample string 8",
"healthtopics": "01270eaf-e234-4c7d-81ac-6e2366cd56ee",
"targets": "279da71e-eff4-4f46-b9fa-e4808aa1f20c",
"regionscountries": "e0466f7c-b9ef-45fb-910b-97f76e4ed1cf",
"stakeholders": "a624122c-0e56-4749-bd37-acb6fe3304d4",
"targetaudiences": "7e11e3ec-085c-4679-a6f9-4702c2447b93",
"Category": "91ea8b4a-e4e6-4dec-921e-10a6497d4c09",
"Tags": "bd760a85-5bf6-4fbb-aeae-4de3b4222d70",
"departmentaltargets": "ce7cff37-ea95-4c70-a8ce-9fd68f8f1426",
"events": "1403d1b3-ec9b-4ee9-957e-d6a2d7c2f53c",
"publishingoffices": "1e5b0b96-5260-450d-b0c7-5f69b3604e26",
"Parts": "sample string 19",
"FolderId": "f45481f3-6bc2-4366-ac1b-782d7cb1c939",
"ParentId": "91768453-c8cc-4b80-8105-64780a93649e"
}Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.
None.
Deletes a documents item by Id.
DELETE /api/default/documents({key})
| Name | Description | Type | Additional Information |
| key | System.Guid | Required |
None
None.
Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.
None.
Returns a set of related items of type Parent from documents item.
GET /api/default/documents({key})/Parent
| Name | Description | Type | Additional Information |
| key | System.Guid | Required |
None
None.
Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.
| Name | Description | Type | Additional Information |
| LastModified | System.DateTimeOffset | Read only: True | |
| PublicationDate | System.DateTimeOffset | Read only: False | |
| Title | System.String | Read only: False | |
| Description | System.String | Read only: False | |
| DateCreated | System.DateTimeOffset | Read only: True | |
| IncludeInSitemap | System.Boolean | Read only: False | |
| SystemSourceKey | System.String | Read only: False | |
| UrlName | System.String | Read only: False | |
| ItemDefaultUrl | System.String | Read only: True | |
| MaxSize | System.Int64 | Read only: False | |
| MaxItemSize | System.Int64 | Read only: False | |
| BlobStorageProvider | System.String | Read only: False | |
| OutputCacheProfile | System.String | Read only: False | |
| ClientCacheProfile | System.String | Read only: False | |
| ExcludeFromSiteSearch | System.Boolean | Read only: False | |
| CoverId | System.Guid | Read only: False | |
| ThumbnailProfiles | System.String | Read only: False | |
| AllowComments | System.Boolean | Read only: False | |
| ParentId | System.Guid | Read only: False | |
| Provider | System.String | Read only: True | |
| ChildrenCount | System.Int32 | Read only: True | |
| Comments | Telerik.Sitefinity.Services.Comments.CommentContract | Read only: True | |
| Breadcrumb | Telerik.Sitefinity.Web.Services.Extensibility.BreadcrumbItem | Read only: True |
application/json
[
{
"LastModified": "2026-11-20T10:08:55.0733945Z",
"PublicationDate": "2026-11-20T10:08:55.0733945Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-11-20T10:08:55.0733945Z",
"IncludeInSitemap": true,
"SystemSourceKey": "sample string 7",
"UrlName": "sample string 8",
"ItemDefaultUrl": "sample string 9",
"MaxSize": 10,
"MaxItemSize": 11,
"BlobStorageProvider": "sample string 12",
"OutputCacheProfile": "sample string 13",
"ClientCacheProfile": "sample string 14",
"ExcludeFromSiteSearch": true,
"CoverId": "c70da944-89f5-4adc-aea8-0cfdf911e92b",
"ThumbnailProfiles": "sample string 17",
"AllowComments": true,
"ParentId": "385eb5f7-e51f-44bd-aba6-7f88b27b374c",
"Provider": "sample string 20",
"ChildrenCount": 21,
"Comments": {
"Name": "sample string 1",
"Message": "sample string 2",
"DateCreated": "2026-11-20T10:08:55.0733945+00:00",
"ProfilePictureUrl": "sample string 4",
"ProfilePictureThumbnailUrl": "sample string 5"
},
"Breadcrumb": null
},
{
"LastModified": "2026-11-20T10:08:55.0733945Z",
"PublicationDate": "2026-11-20T10:08:55.0733945Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-11-20T10:08:55.0733945Z",
"IncludeInSitemap": true,
"SystemSourceKey": "sample string 7",
"UrlName": "sample string 8",
"ItemDefaultUrl": "sample string 9",
"MaxSize": 10,
"MaxItemSize": 11,
"BlobStorageProvider": "sample string 12",
"OutputCacheProfile": "sample string 13",
"ClientCacheProfile": "sample string 14",
"ExcludeFromSiteSearch": true,
"CoverId": "c70da944-89f5-4adc-aea8-0cfdf911e92b",
"ThumbnailProfiles": "sample string 17",
"AllowComments": true,
"ParentId": "385eb5f7-e51f-44bd-aba6-7f88b27b374c",
"Provider": "sample string 20",
"ChildrenCount": 21,
"Comments": {
"Name": "sample string 1",
"Message": "sample string 2",
"DateCreated": "2026-11-20T10:08:55.0733945+00:00",
"ProfilePictureUrl": "sample string 4",
"ProfilePictureThumbnailUrl": "sample string 5"
},
"Breadcrumb": null
}
]Add Parent relation to documents item.
POST /api/default/documents({key})/Parent/$ref
| Name | Description | Type | Additional Information |
| key | System.Guid | Required |
None
application/json
{
"@odata.id": "http://host/route/service/type(key)"
}Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.
None.
Delete set of related items of type Parent from documents item.
DELETE /api/default/documents({key})/Parent/$ref
| Name | Description | Type | Additional Information |
| key | System.Guid | Required |
None
None.
Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.
None.