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": "2025-11-16T18:51:38.1951126Z",
"PublicationDate": "2025-11-16T18:51:38.1951126Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-11-16T18:51:38.1951126Z",
"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": "6b4a8c89-4d78-4f3d-ba62-7da383513481",
"targets": "0fceb36c-207e-4524-897f-bfa825d42cb5",
"regionscountries": "990db95e-189a-4c06-84f7-dd9cb84e2f1a",
"stakeholders": "eb7f9413-bf01-4fa0-9a2c-0890bf13bb6f",
"targetaudiences": "3d90c532-66cc-4e2f-b23a-eef3f542e2c2",
"Category": "33fbe5f1-99b2-4603-918d-26ad29bfd064",
"Tags": "e133aae9-f02d-451a-9fc8-0190829560ba",
"departmentaltargets": "980e983e-427b-473b-88fe-f6e65e1abc5b",
"events": "00072db1-3021-4355-af71-8132209af4ba",
"publishingoffices": "814c14fa-731d-4287-ae54-2b016a91a8e9",
"Parts": "sample string 25",
"FolderId": "0d1976f9-b713-46fc-beeb-707e68737275",
"ParentId": "195305d5-0db4-4cbb-9f41-b07c662956d6",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"IsDamMedia": true
},
{
"LastModified": "2025-11-16T18:51:38.1951126Z",
"PublicationDate": "2025-11-16T18:51:38.1951126Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-11-16T18:51:38.1951126Z",
"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": "6b4a8c89-4d78-4f3d-ba62-7da383513481",
"targets": "0fceb36c-207e-4524-897f-bfa825d42cb5",
"regionscountries": "990db95e-189a-4c06-84f7-dd9cb84e2f1a",
"stakeholders": "eb7f9413-bf01-4fa0-9a2c-0890bf13bb6f",
"targetaudiences": "3d90c532-66cc-4e2f-b23a-eef3f542e2c2",
"Category": "33fbe5f1-99b2-4603-918d-26ad29bfd064",
"Tags": "e133aae9-f02d-451a-9fc8-0190829560ba",
"departmentaltargets": "980e983e-427b-473b-88fe-f6e65e1abc5b",
"events": "00072db1-3021-4355-af71-8132209af4ba",
"publishingoffices": "814c14fa-731d-4287-ae54-2b016a91a8e9",
"Parts": "sample string 25",
"FolderId": "0d1976f9-b713-46fc-beeb-707e68737275",
"ParentId": "195305d5-0db4-4cbb-9f41-b07c662956d6",
"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": "2025-11-16T18:51:38.1951126Z",
"PublicationDate": "2025-11-16T18:51:38.1951126Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-11-16T18:51:38.1951126Z",
"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": "38863630-5b18-4024-ba48-dc03198315da",
"targets": "69d57961-a99c-42bb-a425-f255e5168603",
"regionscountries": "4645c624-d884-4a26-a842-bc149977b363",
"stakeholders": "5ffc4660-0f2a-423b-9c04-310bbffda5e8",
"targetaudiences": "cef43abf-410e-4cbc-b719-83b91fd332a4",
"Category": "fb10523d-db87-4d86-b4f8-37130800ca8d",
"Tags": "d3ba426a-b914-47f8-945d-556297a0deb3",
"departmentaltargets": "2cc0926a-bb0d-45b2-8b14-67b6160287c4",
"events": "e059d774-0b7e-4346-95a6-f8dd8252d7e0",
"publishingoffices": "35c46b74-f147-48e0-86b7-86e044abd810",
"Parts": "sample string 25",
"FolderId": "92280dad-0d9a-4d49-aec0-e1907c45149b",
"ParentId": "aa5fba13-1050-4522-8e5b-2dd4e52d5df5",
"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": "1738a8ba-87f6-4700-a8cd-a606c66bd237"
}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": "2025-11-16T18:51:38.1951126Z",
"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": "84959b4f-f6d6-4a7f-b4d5-efd24da47edc",
"targets": "d04d223c-46f0-4a33-b099-a124647c4e04",
"regionscountries": "d0e1153b-6db8-4739-bcd5-17beef82b8ec",
"stakeholders": "1bd97e8c-25a4-4872-b521-25141bce0b46",
"targetaudiences": "a4ee2e58-b289-41ca-af17-73295680caff",
"Category": "4774740a-3501-4b4a-9927-7abedc50c8f0",
"Tags": "5a6482bf-c50b-441f-81e8-e3680f2b72a3",
"departmentaltargets": "7f963b0b-86d2-4e9a-ab98-cd6fe7335982",
"events": "4043554c-a585-4f6d-aac2-d429d4af6fc9",
"publishingoffices": "cf71b93d-e0a9-46cb-b46c-8e616732a2f8",
"Parts": "sample string 19",
"FolderId": "c1a19f22-9be3-45b0-9ff1-4c83838e986e",
"ParentId": "7b08bb54-7787-484f-bb15-6ae4765ef9e8"
}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": "2025-11-16T18:51:38.1951126Z",
"PublicationDate": "2025-11-16T18:51:38.1951126Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-11-16T18:51:38.1951126Z",
"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": "adee2256-3a9c-44d6-afb5-3093d04981bc",
"targets": "abf8a72a-85fc-4fe1-ad21-98e41cc6b118",
"regionscountries": "0bba1488-c161-4bd6-9e8e-c4734f837b00",
"stakeholders": "b9a60165-7445-4116-b77b-60522d7f2601",
"targetaudiences": "50d7a61a-a707-43b7-ae5a-81f6295bb0b6",
"Category": "99907834-0f65-444a-b89a-85b8a7da43d7",
"Tags": "185f436e-dbf3-4cd1-bfaf-e0bb99dadf12",
"departmentaltargets": "d7ecb832-dca9-4382-bb35-be7bf20de698",
"events": "44f87b2c-b42f-4232-8d3b-8aeee5c4b6fa",
"publishingoffices": "6da1b3aa-1764-4705-8559-a4727e391207",
"Parts": "sample string 25",
"FolderId": "a6fce962-d0c9-492d-9989-6d0023483b4f",
"ParentId": "8897a236-813b-4ba7-bcaa-3004432d8454",
"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": "2025-11-16T18:51:38.1951126Z",
"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": "8a84ee4a-3e4b-495a-a293-804c09d212f9",
"targets": "9b076bb8-d619-418d-a4d9-36e92ddd0f56",
"regionscountries": "73252087-568b-4df1-ac39-a591c8200659",
"stakeholders": "e73df688-8d95-447d-b577-4a18a8dbb9bf",
"targetaudiences": "a6a870df-c5bd-41b6-bebe-684fadf8c63f",
"Category": "50b46578-af45-45dc-9f67-f6c0fea4a267",
"Tags": "5ab56487-291d-4a03-918f-5ca14df06b1d",
"departmentaltargets": "d7f0590e-c1ee-47b7-a870-6d78775a4aa6",
"events": "19f11c6d-4c0e-487d-b56b-47830e5ffec8",
"publishingoffices": "fb6c87e4-09d5-4d15-b361-a47c126149fc",
"Parts": "sample string 19",
"FolderId": "be3642c6-6c80-4eed-a31c-5bfa0b0fbad2",
"ParentId": "cd329f62-d0f3-4f13-ac83-b66feb359bcf"
}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": "2025-11-16T18:51:38.1951126Z",
"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": "5550e345-83bb-4cc5-8e9f-6ae53e32b354",
"targets": "a95e2593-9922-4b7f-a08e-32899cd04e4b",
"regionscountries": "181a01fe-953c-4c72-ba21-75ea7f1b17bd",
"stakeholders": "e5e99c5a-95d8-4675-a604-513d233dab09",
"targetaudiences": "a039f6a9-e17d-4ee6-bf35-544796582a58",
"Category": "314f13d5-2c26-4dd9-9700-7dae81b2b6b0",
"Tags": "0f57735b-84a8-47c4-8a67-4b0f35647e78",
"departmentaltargets": "20b7c80f-45e6-444b-85f7-b3a1743d4df5",
"events": "ec6f8994-e71c-412e-8adc-fc86072ee261",
"publishingoffices": "39746953-d219-4254-b330-4e7ad0dd4c1d",
"Parts": "sample string 19",
"FolderId": "b8fde6c0-cfbd-4ba7-aa17-e997f7db3b72",
"ParentId": "db52bae5-3068-43bc-bfcb-6c3665457b9a"
}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.