Returns a set of data items of type documents.
GET /api/resultsreport/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 | |
| 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 | |
| JoomlaArticleId | System.String | 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-08-29T18:04:05.3530222Z",
"PublicationDate": "2026-08-29T18:04:05.3530222Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-08-29T18:04:05.3530222Z",
"IncludeInSitemap": true,
"SystemSourceKey": "sample string 7",
"Ordinal": 8.1,
"UrlName": "sample string 9",
"ItemDefaultUrl": "sample string 10",
"Author": "sample string 11",
"Extension": "sample string 12",
"MimeType": "sample string 13",
"TotalSize": 14,
"healthtopics": "f01bf0b6-7062-4a2c-9821-1ed32f2e6ea4",
"targets": "74db0b21-ec89-4995-ba69-3fb46b612ca0",
"regionscountries": "edde0547-f75e-428c-9e63-606cf77b7677",
"stakeholders": "5807ba8d-9968-46d8-a122-820bb68b68fc",
"targetaudiences": "28939e19-39a7-4132-9269-16d174c87770",
"JoomlaArticleId": "sample string 20",
"Category": "89e22802-99f3-4283-bd36-f34d8eb4040c",
"Tags": "0a9d922e-c42e-4edf-a87a-1731c331ef11",
"departmentaltargets": "2671ec98-e762-4fd9-a2b3-a2c3d3345702",
"events": "d6c53ac4-336c-407a-9a57-ab21897e41fd",
"publishingoffices": "595878a7-5df1-4cc6-8ed9-e728785df548",
"Parts": "sample string 26",
"FolderId": "9285bcd2-a82d-43f1-aa23-b88a18494a99",
"ParentId": "2270d133-4cfd-4c21-90bb-971f18873bfe",
"Provider": "sample string 29",
"Url": "sample string 30",
"ThumbnailUrl": "sample string 31",
"IsDamMedia": true
},
{
"LastModified": "2026-08-29T18:04:05.3530222Z",
"PublicationDate": "2026-08-29T18:04:05.3530222Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-08-29T18:04:05.3530222Z",
"IncludeInSitemap": true,
"SystemSourceKey": "sample string 7",
"Ordinal": 8.1,
"UrlName": "sample string 9",
"ItemDefaultUrl": "sample string 10",
"Author": "sample string 11",
"Extension": "sample string 12",
"MimeType": "sample string 13",
"TotalSize": 14,
"healthtopics": "f01bf0b6-7062-4a2c-9821-1ed32f2e6ea4",
"targets": "74db0b21-ec89-4995-ba69-3fb46b612ca0",
"regionscountries": "edde0547-f75e-428c-9e63-606cf77b7677",
"stakeholders": "5807ba8d-9968-46d8-a122-820bb68b68fc",
"targetaudiences": "28939e19-39a7-4132-9269-16d174c87770",
"JoomlaArticleId": "sample string 20",
"Category": "89e22802-99f3-4283-bd36-f34d8eb4040c",
"Tags": "0a9d922e-c42e-4edf-a87a-1731c331ef11",
"departmentaltargets": "2671ec98-e762-4fd9-a2b3-a2c3d3345702",
"events": "d6c53ac4-336c-407a-9a57-ab21897e41fd",
"publishingoffices": "595878a7-5df1-4cc6-8ed9-e728785df548",
"Parts": "sample string 26",
"FolderId": "9285bcd2-a82d-43f1-aa23-b88a18494a99",
"ParentId": "2270d133-4cfd-4c21-90bb-971f18873bfe",
"Provider": "sample string 29",
"Url": "sample string 30",
"ThumbnailUrl": "sample string 31",
"IsDamMedia": true
}
]Gets documents item by id.
GET /api/resultsreport/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 | |
| 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 | |
| JoomlaArticleId | System.String | 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-08-29T18:04:05.3530222Z",
"PublicationDate": "2026-08-29T18:04:05.3530222Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-08-29T18:04:05.3530222Z",
"IncludeInSitemap": true,
"SystemSourceKey": "sample string 7",
"Ordinal": 8.1,
"UrlName": "sample string 9",
"ItemDefaultUrl": "sample string 10",
"Author": "sample string 11",
"Extension": "sample string 12",
"MimeType": "sample string 13",
"TotalSize": 14,
"healthtopics": "3accc5c3-6ae6-4cf1-a66f-381d97469c68",
"targets": "6411d957-d4d6-4764-9ee0-f4fdf975015b",
"regionscountries": "d5acc135-1949-43f0-ba30-2ee8c3e87bc0",
"stakeholders": "fa77f0a6-00dc-48d8-9863-1e378173a5f2",
"targetaudiences": "a4594116-ae34-46ae-91b3-127af7d58605",
"JoomlaArticleId": "sample string 20",
"Category": "40c1e163-2a40-49e3-a589-48c0612ad531",
"Tags": "c65b17fa-8f0f-4ea7-9b21-e24c92e973b1",
"departmentaltargets": "db43573e-3188-4659-8de3-2d31aaa568d8",
"events": "c0bddac0-2717-424a-b194-c927f40c262f",
"publishingoffices": "84379617-6db7-406a-9ae9-ead1ba8e6cb7",
"Parts": "sample string 26",
"FolderId": "01db1eb5-7990-4df5-afdc-8723bdff9479",
"ParentId": "efb56c71-f467-4876-9d30-8ed55c8488a2",
"Provider": "sample string 29",
"Url": "sample string 30",
"ThumbnailUrl": "sample string 31",
"IsDamMedia": true
}Gets Id property from documents item.
GET /api/resultsreport/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": "c02a2bdd-6d12-48ce-af28-218bb0b3fe00"
}Creates a documents item.
POST /api/resultsreport/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 | |
| 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 | |
| JoomlaArticleId | System.String | 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-08-29T18:04:05.3530222Z",
"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": "fffada86-6d46-468b-85a6-63496a313f5a",
"targets": "5f239682-4dd2-43da-8812-60c555162f22",
"regionscountries": "e91b521f-5cd0-4761-a5ae-7c2fd7f920e9",
"stakeholders": "4ad9ddfc-3f20-4844-9c99-d8db59346a54",
"targetaudiences": "bece15e1-0b79-401e-9e4d-825244d579d4",
"JoomlaArticleId": "sample string 14",
"Category": "ebfc6a51-325d-4e5f-9eeb-77e460a46d08",
"Tags": "2bd69845-f916-454a-8fbb-4397fcfc7726",
"departmentaltargets": "44f2cacc-4f0d-4e13-9765-0c9d518d5e6f",
"events": "c43ee89f-9a0a-4a2d-8d80-db0afecb2523",
"publishingoffices": "a1f1d0fc-a376-4adb-bf4d-67391eca69a8",
"Parts": "sample string 20",
"FolderId": "494719b7-2aa9-4027-a1d7-e40d24ee7963",
"ParentId": "d4ec9efa-7cee-4ac9-ae5d-f6ff910e9368"
}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 | |
| 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 | |
| JoomlaArticleId | System.String | 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-08-29T18:04:05.3530222Z",
"PublicationDate": "2026-08-29T18:04:05.3530222Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-08-29T18:04:05.3530222Z",
"IncludeInSitemap": true,
"SystemSourceKey": "sample string 7",
"Ordinal": 8.1,
"UrlName": "sample string 9",
"ItemDefaultUrl": "sample string 10",
"Author": "sample string 11",
"Extension": "sample string 12",
"MimeType": "sample string 13",
"TotalSize": 14,
"healthtopics": "e4392246-a10f-4a16-b3e6-ec921def2fe2",
"targets": "afc49c3d-f382-49c9-bb0f-57e8def84424",
"regionscountries": "940a980e-b308-4ad1-8702-bb6e88819290",
"stakeholders": "3a289706-ebc6-4218-9792-2ccec193ddff",
"targetaudiences": "1f46c823-4805-49ec-a258-381e4b7781f7",
"JoomlaArticleId": "sample string 20",
"Category": "23e2e972-34e4-4d3c-9375-7b0eede65b39",
"Tags": "278b19e2-b63f-4016-a389-7ef5a09813e0",
"departmentaltargets": "889faebd-1cc6-4f29-b49e-4967df81e825",
"events": "d3bd82fe-2a65-4ca6-b0be-511e962bd43f",
"publishingoffices": "eec5ba7b-dd52-404a-8755-01d192202009",
"Parts": "sample string 26",
"FolderId": "0ef15303-a7b4-4f8b-9759-fe8af88fc22f",
"ParentId": "864f8427-8f96-4c00-965b-7f00ee8d8627",
"Provider": "sample string 29",
"Url": "sample string 30",
"ThumbnailUrl": "sample string 31",
"IsDamMedia": true
}Partial update for documents item.
PATCH /api/resultsreport/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 | |
| 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 | |
| JoomlaArticleId | System.String | 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-08-29T18:04:05.3530222Z",
"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": "640ffa9c-418c-4bb6-93d1-806f257ccfce",
"targets": "221e52c4-bf78-4677-9cfd-576786ca9e21",
"regionscountries": "fb529007-2285-47fe-b795-2801a7426690",
"stakeholders": "b589ea0e-a0ec-464a-a2f5-865eae503fa8",
"targetaudiences": "493473c6-692a-475b-b681-e4a31917e5bf",
"JoomlaArticleId": "sample string 14",
"Category": "c6c316c6-d845-4a6b-a302-27652bd2ebe9",
"Tags": "b3690e5e-6794-4d90-8330-825424b5b87b",
"departmentaltargets": "d4991059-b05b-4bae-9066-dd2bcc9b1619",
"events": "700b8e78-2d4a-4b0b-b908-b96d11058c20",
"publishingoffices": "9c4ceb49-bad2-4ed1-8236-82623582b2c7",
"Parts": "sample string 20",
"FolderId": "d815629e-f12e-4adb-8e88-f5ed8281b08e",
"ParentId": "da6676a3-3f64-49e5-aa8c-df8bc256d2d7"
}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/resultsreport/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 | |
| 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 | |
| JoomlaArticleId | System.String | 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-08-29T18:04:05.3530222Z",
"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": "73353b66-ab13-432e-bbe2-1014607ed1e6",
"targets": "dedb5150-d684-421f-afc2-fdb8315b20f4",
"regionscountries": "1f7cb607-3f22-4244-82d5-0e33f58173a4",
"stakeholders": "0f03a05e-f381-4603-ab2c-ea9fd0e75378",
"targetaudiences": "ba12aaf3-d9b1-4340-af66-8c143ffafb35",
"JoomlaArticleId": "sample string 14",
"Category": "c906e1d9-d888-47c1-9fb0-500bc396046a",
"Tags": "6642bd36-943d-4dda-8981-f7ba2fa3c101",
"departmentaltargets": "eb54fc7c-efaa-4d83-8bfe-370768df6583",
"events": "3e086420-19c4-447e-abcd-1b8d58ca45c2",
"publishingoffices": "080e1cec-f0a0-4094-85c0-ef1ac20e478a",
"Parts": "sample string 20",
"FolderId": "a450ba93-5286-4989-874e-66ff15bb5e9e",
"ParentId": "114c44fe-1723-478d-8cb4-ea91dd83a0a3"
}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/resultsreport/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.