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 | |
| 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-05-07T14:29:34.9406545Z",
"PublicationDate": "2026-05-07T14:29:34.9406545Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-05-07T14:29:34.9406545Z",
"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": "b6ecbed1-8857-479c-811b-9e98406e2ec6",
"targets": "65e8b3ea-5204-4e1e-baff-cba7f597e9ba",
"regionscountries": "859471d1-c314-4e35-bd35-838a7fef119e",
"stakeholders": "e1a694fd-4cd2-46dc-b3c6-5ae662138972",
"targetaudiences": "c6f8d609-1b89-4467-9386-2e51f55ae211",
"Category": "5c93a5ae-0e21-4679-a288-084485c3b5fc",
"Tags": "5b261456-4e03-43a9-b6e6-d25b5a613be8",
"departmentaltargets": "a16fb77c-4322-4212-9a78-c64677f24f52",
"events": "62c712a0-206b-48a9-98dd-5838b5c79521",
"publishingoffices": "3c163c2a-eb6d-490d-94a0-00310a3d24e4",
"Parts": "sample string 25",
"FolderId": "49dd17f6-96a1-4946-b632-5fc6a7aa48b8",
"ParentId": "4e42f8cf-8817-43cf-8aa1-e17cc08d5c59",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"IsDamMedia": true
},
{
"LastModified": "2026-05-07T14:29:34.9406545Z",
"PublicationDate": "2026-05-07T14:29:34.9406545Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-05-07T14:29:34.9406545Z",
"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": "b6ecbed1-8857-479c-811b-9e98406e2ec6",
"targets": "65e8b3ea-5204-4e1e-baff-cba7f597e9ba",
"regionscountries": "859471d1-c314-4e35-bd35-838a7fef119e",
"stakeholders": "e1a694fd-4cd2-46dc-b3c6-5ae662138972",
"targetaudiences": "c6f8d609-1b89-4467-9386-2e51f55ae211",
"Category": "5c93a5ae-0e21-4679-a288-084485c3b5fc",
"Tags": "5b261456-4e03-43a9-b6e6-d25b5a613be8",
"departmentaltargets": "a16fb77c-4322-4212-9a78-c64677f24f52",
"events": "62c712a0-206b-48a9-98dd-5838b5c79521",
"publishingoffices": "3c163c2a-eb6d-490d-94a0-00310a3d24e4",
"Parts": "sample string 25",
"FolderId": "49dd17f6-96a1-4946-b632-5fc6a7aa48b8",
"ParentId": "4e42f8cf-8817-43cf-8aa1-e17cc08d5c59",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"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 | |
| 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-05-07T14:29:34.9406545Z",
"PublicationDate": "2026-05-07T14:29:34.9406545Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-05-07T14:29:34.9406545Z",
"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": "20fc911f-14dd-469b-80b1-2218e435a89b",
"targets": "821ac95c-709a-40d3-9ccf-9d680ce53ccc",
"regionscountries": "8b70d2f5-fa32-420c-94b5-b7c2d16b0a71",
"stakeholders": "6eff81a7-ce8d-4e00-a9f4-fea37d3d8511",
"targetaudiences": "0d9d0ea9-b1f8-46c9-9a21-db18f4823622",
"Category": "0c4f829d-8525-4198-b2f8-ef9f19bc236e",
"Tags": "2ae8617e-5b29-4627-acaa-16ee2a4061c5",
"departmentaltargets": "8da30e28-4904-4879-bfd6-d9689519f1dd",
"events": "983164dc-294f-4bc7-a0bd-a2e7536de457",
"publishingoffices": "a4af62fe-c99d-4470-a62d-1ebd8eb5ff28",
"Parts": "sample string 25",
"FolderId": "7a27aad2-c425-4de7-9890-e4dcfeecf926",
"ParentId": "98a550a1-3261-4da2-b593-4c081c7446c2",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"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": "dea7f81f-ed68-48de-9965-0b7462441be7"
}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 | |
| 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-05-07T14:29:34.9406545Z",
"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": "f36c10e4-2aaf-4739-8378-1cd2e1e72fac",
"targets": "97a1a331-4dea-4778-b19e-a6562cf985e5",
"regionscountries": "87954d50-f38f-4949-b9cb-a7fe2bd6b08f",
"stakeholders": "d4abbe77-9c7a-4659-85fd-2d120366decd",
"targetaudiences": "85744492-4a07-4d72-ae98-c80513aaa18a",
"Category": "794f411d-8766-49a6-ae4c-afb0f4f0fa44",
"Tags": "8883392e-6d93-4d95-9c0b-3f26e747e43c",
"departmentaltargets": "6cf48cb7-194d-496f-b444-4aca5de0bc07",
"events": "bb335f9f-63e9-4e06-a520-07fb7d92fb35",
"publishingoffices": "01ad42a4-7ad8-4a1a-9e17-19bb24424c23",
"Parts": "sample string 19",
"FolderId": "d158be87-16d0-4e41-bfc9-fd1e679e2239",
"ParentId": "81a883b7-8943-4d00-9f86-7e75b8bfce8e"
}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 | |
| 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-05-07T14:29:34.9406545Z",
"PublicationDate": "2026-05-07T14:29:34.9406545Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-05-07T14:29:34.9406545Z",
"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": "b037bc5d-3356-42b9-bb41-acc6dd7c8ce8",
"targets": "81100d13-f34e-42bb-9713-226980acef1f",
"regionscountries": "fc840b24-dba1-4d4d-bc02-a46e448d3260",
"stakeholders": "d75beebd-c2fc-4e52-bda1-c789766292af",
"targetaudiences": "18fb12b4-fb29-40bd-9293-696c3437eeb5",
"Category": "6786b4d7-70fb-480f-84ac-b78eafc29763",
"Tags": "b879a24b-ec07-465c-9369-0e17ede9f981",
"departmentaltargets": "f467831b-4f27-4fcb-adc3-c23a9eba914a",
"events": "2333d7f3-da50-452b-b7af-61ab4cb213ec",
"publishingoffices": "558f97dc-5d1c-4a5a-ac5d-417ae1d88fc0",
"Parts": "sample string 25",
"FolderId": "d31aea40-b968-4354-8093-b6e5eb83e4b8",
"ParentId": "c9133a23-3a36-46f9-bb4f-fe313f6e3f6c",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"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 | |
| 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-05-07T14:29:34.9406545Z",
"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": "f8988ff2-55c4-4270-84fb-5e89711a4740",
"targets": "24050c75-87b5-4205-b73f-2d7ea60f7977",
"regionscountries": "4c08c549-25d7-4dca-984a-8417e035b5c6",
"stakeholders": "b468b470-b925-4283-8e31-e568a0140cb3",
"targetaudiences": "16c2d949-afb0-482c-a53c-f5fe20d5d4b1",
"Category": "4c5f785c-cdf3-46fa-88b6-2cbb9d1ec668",
"Tags": "0d2eec4a-6594-452f-93ed-92d606973cfc",
"departmentaltargets": "ab91db87-bbd8-4a39-b3f6-9449a2f1ba2d",
"events": "ccf9625b-3796-4bbb-aadb-a334a2869ba0",
"publishingoffices": "175dfbc1-3d87-49e2-9c77-e84b3645ed3b",
"Parts": "sample string 19",
"FolderId": "8123acaf-8102-4509-9085-2cd71eb94c3a",
"ParentId": "b2b7041d-58c5-4a9a-a036-be91907c6841"
}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 | |
| 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-05-07T14:29:34.9406545Z",
"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": "b39ada60-a3e0-41e5-aaab-57bfe51a2823",
"targets": "dae4523f-e2ee-4c69-8b08-a856ee240d53",
"regionscountries": "3e3cc2d5-6e4a-4c6a-9ce6-703abb70dab3",
"stakeholders": "6139dab7-62ab-4b09-911c-612105023086",
"targetaudiences": "5f5e3ee0-bc07-4fa5-b728-044696888079",
"Category": "284e08d4-7643-4d1f-bd86-a231529de669",
"Tags": "593d0fc0-e37d-472f-89cd-b7705f3c9599",
"departmentaltargets": "edb4f785-6323-43cf-b816-25b8ddd01b28",
"events": "42e01e84-3e7d-4d3c-8a49-f3a87122a88d",
"publishingoffices": "cc309883-e30d-46aa-8efa-d6e5099af39b",
"Parts": "sample string 19",
"FolderId": "6c9ac1e0-d78a-43c0-a2b9-58c893f093c3",
"ParentId": "becabf9b-a89c-4c80-bb10-2bdbc56253de"
}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.