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-03-03T11:46:14.1675561Z",
"PublicationDate": "2026-03-03T11:46:14.1675561Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-03-03T11:46:14.1675561Z",
"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": "515566bf-fe30-4724-9d86-0194ae49db66",
"targets": "9571a526-2162-4218-9d8b-546bbf746648",
"regionscountries": "e5f44af3-8333-4b88-9243-0f399461c2a2",
"stakeholders": "a19369e6-30ba-4997-9851-7bdb29804b2b",
"targetaudiences": "307ac3ef-d6d2-4511-becf-d8e6c74fb168",
"Category": "d4c553af-0477-4b36-be7b-af3401e030e8",
"Tags": "c940ef4b-06cc-4c4a-8ee5-59b1621240ef",
"departmentaltargets": "43a43b87-6ce4-4cd4-adfd-d3687c1dbb55",
"events": "52b87467-ed6f-4d1f-b81f-8a3e7d4cbdd5",
"publishingoffices": "c478954b-bcdd-4a1f-af21-6b134020dbe4",
"Parts": "sample string 25",
"FolderId": "aa393adf-2355-43b4-a4d2-28a456ea580d",
"ParentId": "319d7633-d64c-4f80-9c58-0121f09fbacf",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"IsDamMedia": true
},
{
"LastModified": "2026-03-03T11:46:14.1675561Z",
"PublicationDate": "2026-03-03T11:46:14.1675561Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-03-03T11:46:14.1675561Z",
"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": "515566bf-fe30-4724-9d86-0194ae49db66",
"targets": "9571a526-2162-4218-9d8b-546bbf746648",
"regionscountries": "e5f44af3-8333-4b88-9243-0f399461c2a2",
"stakeholders": "a19369e6-30ba-4997-9851-7bdb29804b2b",
"targetaudiences": "307ac3ef-d6d2-4511-becf-d8e6c74fb168",
"Category": "d4c553af-0477-4b36-be7b-af3401e030e8",
"Tags": "c940ef4b-06cc-4c4a-8ee5-59b1621240ef",
"departmentaltargets": "43a43b87-6ce4-4cd4-adfd-d3687c1dbb55",
"events": "52b87467-ed6f-4d1f-b81f-8a3e7d4cbdd5",
"publishingoffices": "c478954b-bcdd-4a1f-af21-6b134020dbe4",
"Parts": "sample string 25",
"FolderId": "aa393adf-2355-43b4-a4d2-28a456ea580d",
"ParentId": "319d7633-d64c-4f80-9c58-0121f09fbacf",
"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-03-03T11:46:14.1675561Z",
"PublicationDate": "2026-03-03T11:46:14.1675561Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-03-03T11:46:14.1675561Z",
"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": "fd799e07-1f88-4b1d-aa2c-7c6be0420aff",
"targets": "e004dd71-7543-4d84-9b7f-e9c360edc810",
"regionscountries": "184eace1-02d2-4c0a-8888-fad10bdb9d48",
"stakeholders": "3ae68b43-1bd4-43f5-b2c0-16fcf91a12ca",
"targetaudiences": "6b376cd3-623c-4df7-9e46-891d0f7939d3",
"Category": "8ed541b5-4f41-465c-85b8-5dadc6f67c9e",
"Tags": "18f6bf9c-8170-4a77-a71e-1aa265c10f28",
"departmentaltargets": "85bdeafc-97bf-4a71-81bc-1ea3cebe2f7d",
"events": "b0562cd1-a451-450a-9945-d80876ee285f",
"publishingoffices": "99c3481e-cc01-4ec7-8072-84c93ea0d7b2",
"Parts": "sample string 25",
"FolderId": "158defde-81cd-499a-b13f-84d4f253feb2",
"ParentId": "29db4794-c421-45a7-afc6-45776dc6cb72",
"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": "78b3c116-cfbd-4541-a9b8-ff12bd4190ec"
}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-03-03T11:46:14.1675561Z",
"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": "7001a646-77a6-4648-b5ae-95b11b370ef0",
"targets": "4641aa8d-36ea-44ba-9e5e-d49e0b44c353",
"regionscountries": "93b90f42-7b02-4ff9-9258-adbcf0c930e9",
"stakeholders": "dd7f6456-a9a6-4a30-825a-f1c092181a55",
"targetaudiences": "77e1827b-f09d-468b-bbc8-b4edaa6e9bdb",
"Category": "e83c9117-6863-445b-a2de-921b4e5d534b",
"Tags": "e6ed351c-06b6-41ce-86f6-c0a941b9d592",
"departmentaltargets": "f7896d0e-fa48-4c8d-9a2e-18b2577e6e63",
"events": "88256f94-02d5-4a9d-9c56-94beb1f27506",
"publishingoffices": "8d3d5b34-2c05-43bb-bc62-4162b150d769",
"Parts": "sample string 19",
"FolderId": "ea035ecc-22bb-404f-b03b-04b10bbd328e",
"ParentId": "39b4225a-f10e-465e-b6e8-ec7c11b11001"
}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-03-03T11:46:14.1675561Z",
"PublicationDate": "2026-03-03T11:46:14.1675561Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-03-03T11:46:14.1675561Z",
"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": "a45cc9c5-3f31-4e03-8130-07283f419fde",
"targets": "4ac350ba-9682-42a1-b27a-57681c392b34",
"regionscountries": "a0ec84db-0925-46a0-aaad-a576539743bc",
"stakeholders": "d0d9ac33-86ac-4bbd-8af5-fc1b8c86250a",
"targetaudiences": "f2a90775-6733-40b9-a967-f533695fb397",
"Category": "a02c456c-8c5f-47a0-8f85-218646c027be",
"Tags": "2d7f99c0-3420-46b5-aab2-dda99a5bde35",
"departmentaltargets": "35ec8e8b-728a-4d61-8f86-8782d3cf1b88",
"events": "fc4ad6ec-9323-4b28-80d8-93ca70667ee2",
"publishingoffices": "dae2f1af-40c4-4837-852c-41b4d6050ae3",
"Parts": "sample string 25",
"FolderId": "932b71a0-5280-4c97-ae7d-910263c9df9f",
"ParentId": "9e3b87a4-ad90-4ac0-897d-51da5b75e101",
"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-03-03T11:46:14.1675561Z",
"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": "cf856735-6f1e-423f-a3f2-327a9c92a29a",
"targets": "2921448d-2109-410b-b3be-c31367970084",
"regionscountries": "4d256e58-2c82-4bd0-be02-0b072ee901a1",
"stakeholders": "531c8b04-e250-4b88-a7c6-c9000ec9f547",
"targetaudiences": "15f25ea1-1334-454a-b79e-beb925b09a3f",
"Category": "7b970256-12e8-4393-9cdf-d59d298f1101",
"Tags": "b2da63c1-c5f3-4f71-968b-fceb07f8f55a",
"departmentaltargets": "83ef6d91-0553-42ea-b659-585799539fbf",
"events": "c3c0cc21-aed0-4dff-b96b-1cbd8067673c",
"publishingoffices": "bb06812b-1e9f-4722-b492-b4a9945e9241",
"Parts": "sample string 19",
"FolderId": "4ba0cdc8-0368-4c04-9b5d-a3afd69556df",
"ParentId": "fb3a7731-6a31-4fee-886f-920101b9a72e"
}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-03-03T11:46:14.1675561Z",
"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": "71f3f8a7-bfc7-4f68-81d9-5f20a66fd9bb",
"targets": "3c2e648b-3596-45ee-ba6a-36a1f42f5858",
"regionscountries": "d089941e-c4dc-4068-a264-19238f93eaf8",
"stakeholders": "f67c8ea2-4329-4eec-a556-fadfc72cd327",
"targetaudiences": "60acf59d-0860-4ed3-9188-b2df50b3b173",
"Category": "dc82ae19-5d57-416d-b251-6edbf94649f3",
"Tags": "0354bd27-75ca-4cf8-b153-10681ce81337",
"departmentaltargets": "d4813ca5-5a57-4929-9495-61ab3f9f850d",
"events": "d7ced02e-a778-460b-b16c-574ef838e003",
"publishingoffices": "8887fd2f-2a1b-4e3f-a9fb-227e02d2a9d5",
"Parts": "sample string 19",
"FolderId": "18f2f34e-bfc9-4098-8c84-59c9176bcf59",
"ParentId": "a350cacd-7d3f-4ad6-ab1e-0789ed1f0ac7"
}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.