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-02-06T22:57:25.6847975Z",
"PublicationDate": "2026-02-06T22:57:25.6847975Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-02-06T22:57:25.6847975Z",
"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": "540566ca-b590-4cca-8ef1-59bccb75b4f8",
"targets": "f0658481-ba81-46d3-8048-401546b3e6e7",
"regionscountries": "598fd43e-eb98-4e24-bb49-c33b5965af50",
"stakeholders": "ff21eeb0-75a9-4852-9c62-f81e2ba07e00",
"targetaudiences": "36e65682-3a60-4a6c-8f69-47416faf4290",
"Category": "5edbc61b-0c55-4d66-a7d3-d0e6e4d65e76",
"Tags": "ce65b2f7-ec10-4b78-960e-9a01811ad8fb",
"departmentaltargets": "f4fe3997-8044-4213-8b0a-4ac022b9b3a9",
"events": "4ca8362f-b730-4ca1-9a51-d5a06e515c48",
"publishingoffices": "89d142ab-d64c-4c19-9a69-09f607581e23",
"Parts": "sample string 25",
"FolderId": "a037be08-ede5-4536-95d4-efc4c7487d2f",
"ParentId": "4f6e744d-3e34-42f7-92a4-87b40a2445c6",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"IsDamMedia": true
},
{
"LastModified": "2026-02-06T22:57:25.6847975Z",
"PublicationDate": "2026-02-06T22:57:25.6847975Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-02-06T22:57:25.6847975Z",
"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": "540566ca-b590-4cca-8ef1-59bccb75b4f8",
"targets": "f0658481-ba81-46d3-8048-401546b3e6e7",
"regionscountries": "598fd43e-eb98-4e24-bb49-c33b5965af50",
"stakeholders": "ff21eeb0-75a9-4852-9c62-f81e2ba07e00",
"targetaudiences": "36e65682-3a60-4a6c-8f69-47416faf4290",
"Category": "5edbc61b-0c55-4d66-a7d3-d0e6e4d65e76",
"Tags": "ce65b2f7-ec10-4b78-960e-9a01811ad8fb",
"departmentaltargets": "f4fe3997-8044-4213-8b0a-4ac022b9b3a9",
"events": "4ca8362f-b730-4ca1-9a51-d5a06e515c48",
"publishingoffices": "89d142ab-d64c-4c19-9a69-09f607581e23",
"Parts": "sample string 25",
"FolderId": "a037be08-ede5-4536-95d4-efc4c7487d2f",
"ParentId": "4f6e744d-3e34-42f7-92a4-87b40a2445c6",
"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-02-06T22:57:25.6847975Z",
"PublicationDate": "2026-02-06T22:57:25.6847975Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-02-06T22:57:25.6847975Z",
"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": "556573f2-ab3c-492d-85ee-5c8b9d467d5e",
"targets": "6e2f53a9-be94-49ae-ad5f-69eb60cfd5ac",
"regionscountries": "06c6a460-4325-4f66-aee0-bb8afd57fe19",
"stakeholders": "eb6d51ee-bfec-4850-9d96-ff5afdd3a687",
"targetaudiences": "41c92a9b-5ecb-4f9e-a847-45770fe123ac",
"Category": "5eb3855e-b771-445c-8a71-08eb68b29efb",
"Tags": "47f29e09-967d-4c35-bd64-5935580c6278",
"departmentaltargets": "37a3ace2-1e72-4b27-a39a-37c3a9e99a06",
"events": "f4568276-d817-415a-8d37-e875c867f11c",
"publishingoffices": "53eab2f3-da22-4402-bae6-0260b9c7840b",
"Parts": "sample string 25",
"FolderId": "b74e9c62-7a27-4229-9283-97065a4bfd3e",
"ParentId": "a74885aa-7f66-4cf2-a8c7-f6e8c0962f3a",
"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": "64fd3030-0417-4fa9-af40-788038da3103"
}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-02-06T22:57:25.6847975Z",
"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": "5170ebc5-1a8c-4fb4-9c26-ab3c0219461d",
"targets": "40d5ff97-517a-4809-b36a-121258a00783",
"regionscountries": "6029d0a8-358e-49e5-b354-cd0c3d59e9d3",
"stakeholders": "704241e3-11b0-4f6b-bf56-18731027618b",
"targetaudiences": "ac326084-a7aa-45d7-9fad-906976c1955f",
"Category": "9f869657-7476-4231-b755-9053eab78a77",
"Tags": "fa882c3e-e7df-49e7-8c00-83ccaa8571f3",
"departmentaltargets": "1a719990-5a30-4820-8596-bf6ab0c6c526",
"events": "aaa982b2-114a-4d78-b879-7728292676ac",
"publishingoffices": "e2899be5-2714-409a-a83c-fa90e6b71300",
"Parts": "sample string 19",
"FolderId": "63ec128d-7e94-4f69-99c2-10e84365c869",
"ParentId": "fdde9b26-c009-4a71-8bea-e8276eec79ec"
}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-02-06T22:57:25.6847975Z",
"PublicationDate": "2026-02-06T22:57:25.6847975Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-02-06T22:57:25.6847975Z",
"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": "9d9d6864-abdc-4fef-9a39-b8951ecf656f",
"targets": "bf923e3c-12b4-4905-9d1d-dd753e064e74",
"regionscountries": "3531c7f5-07e7-46b2-96a9-f352561aa10e",
"stakeholders": "b7320b44-0913-484d-987d-db170376dac2",
"targetaudiences": "1c47769f-ebc3-4c6e-b24c-bbd1e4535038",
"Category": "697b8405-2fa2-4c6d-8088-9d18b7be93c3",
"Tags": "a9a7c7e6-c23d-468f-8577-093be1d020e4",
"departmentaltargets": "d2338a3d-6a65-41d9-9291-e088d6651fb0",
"events": "0fafc8e2-2ff0-4ded-bb3c-f5d1f2052c67",
"publishingoffices": "886d7539-fa15-484f-819b-418474a31017",
"Parts": "sample string 25",
"FolderId": "25fe808a-ea49-4c2c-9081-0e0ad30d5c61",
"ParentId": "21f241a0-fba8-4d4d-8907-b583f49c76c3",
"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-02-06T22:57:25.6847975Z",
"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": "ae4aa362-4496-4a1d-a7f2-7fdb3c297bac",
"targets": "0ce95756-c630-484b-b840-4ba8ae9c5557",
"regionscountries": "9b81d24a-7d8a-459e-b01c-fbbe430026c4",
"stakeholders": "f3c3a959-6161-4c08-94b6-5a0b26314f1d",
"targetaudiences": "54ce9213-7273-4c28-a829-112eaeb9804d",
"Category": "74997483-9684-49b9-84b9-2d2415f7ec83",
"Tags": "7d40df83-cb2a-4335-8b29-318b3d5e9f6b",
"departmentaltargets": "c3224866-9458-4c4a-bba7-9a7a6ae74eda",
"events": "13e1a0fa-b598-4ee6-a120-c924cacc059e",
"publishingoffices": "1f0add3a-1a22-4c44-af68-7b994ac1257f",
"Parts": "sample string 19",
"FolderId": "30420c6b-9ee2-49dd-bcd8-c67c6ea6184c",
"ParentId": "d9b265d2-e104-4002-b922-9eacc78266f9"
}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-02-06T22:57:25.6847975Z",
"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": "9c61ca01-16b6-4ecd-a236-91b587283469",
"targets": "695b6770-90f4-493d-bef1-7faa15fa8475",
"regionscountries": "bfab72cf-5c92-4b14-8a71-9457aead6c37",
"stakeholders": "a85ac3c3-69f7-4746-a746-8c276989aa59",
"targetaudiences": "230c7b86-a9f8-4b45-befc-3b1e11c8a997",
"Category": "e5772924-fc37-41ea-9059-32fd6f774473",
"Tags": "40965886-389b-4788-bcbe-151dc18d27e0",
"departmentaltargets": "71f162de-7a19-4d9b-94c0-00bab1ce156c",
"events": "cb7e8387-0251-4f31-a956-8831f9b0b86d",
"publishingoffices": "5b216859-3613-4ec1-9718-0e7e691afef1",
"Parts": "sample string 19",
"FolderId": "1322e075-a1a2-414d-9ed5-5b030dfc3226",
"ParentId": "8f0b5ddc-6c7f-4e0e-96e0-d69fffb46fdc"
}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.