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 | |
| JoomlaArticleId | System.String | 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-10-17T09:40:29.9998434Z",
"PublicationDate": "2026-10-17T09:40:29.9998434Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-10-17T09:40:29.9998434Z",
"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": "31383985-bde8-4b45-8300-f52814231a2a",
"targets": "f3a29cd9-04e8-4a92-9cfa-400c617b5ea9",
"JoomlaArticleId": "sample string 17",
"regionscountries": "2cfdceb9-80a8-4083-b9e8-3430fd983da0",
"stakeholders": "34e2e4c3-6557-4ebf-8755-d9186f6d728f",
"targetaudiences": "68b33a8e-d181-43fd-accc-24d753992c18",
"Category": "25fbbb48-5e64-4b1d-a510-7d8fb41aaf76",
"Tags": "8ff1fbe6-6590-466a-93fc-ff29dc7e072e",
"departmentaltargets": "7957554a-6bd1-495b-9fd7-621765edd0fc",
"events": "0ffb92e0-c032-4113-a98d-fc00749cf74a",
"publishingoffices": "f038417c-ba8e-4d27-a001-5cc09cf2fe9f",
"Parts": "sample string 26",
"FolderId": "86def74c-56c4-403e-aee1-5b69e0655592",
"ParentId": "e07b1082-e29c-4207-ba4b-a2bd66764913",
"Provider": "sample string 29",
"Url": "sample string 30",
"ThumbnailUrl": "sample string 31",
"IsDamMedia": true
},
{
"LastModified": "2026-10-17T09:40:29.9998434Z",
"PublicationDate": "2026-10-17T09:40:29.9998434Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-10-17T09:40:29.9998434Z",
"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": "31383985-bde8-4b45-8300-f52814231a2a",
"targets": "f3a29cd9-04e8-4a92-9cfa-400c617b5ea9",
"JoomlaArticleId": "sample string 17",
"regionscountries": "2cfdceb9-80a8-4083-b9e8-3430fd983da0",
"stakeholders": "34e2e4c3-6557-4ebf-8755-d9186f6d728f",
"targetaudiences": "68b33a8e-d181-43fd-accc-24d753992c18",
"Category": "25fbbb48-5e64-4b1d-a510-7d8fb41aaf76",
"Tags": "8ff1fbe6-6590-466a-93fc-ff29dc7e072e",
"departmentaltargets": "7957554a-6bd1-495b-9fd7-621765edd0fc",
"events": "0ffb92e0-c032-4113-a98d-fc00749cf74a",
"publishingoffices": "f038417c-ba8e-4d27-a001-5cc09cf2fe9f",
"Parts": "sample string 26",
"FolderId": "86def74c-56c4-403e-aee1-5b69e0655592",
"ParentId": "e07b1082-e29c-4207-ba4b-a2bd66764913",
"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 | |
| JoomlaArticleId | System.String | 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-10-17T09:40:30.0008886Z",
"PublicationDate": "2026-10-17T09:40:30.0008886Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-10-17T09:40:30.0008886Z",
"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": "5569adc1-ee2a-4cd3-a5cd-9da7c189f68d",
"targets": "0f55545e-62eb-40fc-aac3-91d66afcf5e3",
"JoomlaArticleId": "sample string 17",
"regionscountries": "a8f94a12-7ec0-4000-a3ee-053b73e2becb",
"stakeholders": "fe8c7a10-13c7-431e-b6ab-427487730e57",
"targetaudiences": "9d72f94e-39f0-4301-b69e-9a50ae4bf3cf",
"Category": "0a7d4748-63dc-45ae-b9aa-95bf94b6ab07",
"Tags": "31e206e1-87bd-41d7-ab1b-8fb2f70f4481",
"departmentaltargets": "81632813-07d7-4ac8-96b7-1dcd7ae16f27",
"events": "689d44b9-20b1-4a84-ae22-e32d926d4fda",
"publishingoffices": "bb8101db-f791-4779-b5cd-9e9910ba53af",
"Parts": "sample string 26",
"FolderId": "9c5c65c5-0e4b-4957-9107-083c0ccf5699",
"ParentId": "99e01bbe-ac55-4d9e-b0e0-093ef079143f",
"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": "59db65e0-fc77-4ab7-a29c-1013d5a144ce"
}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 | |
| JoomlaArticleId | System.String | 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-10-17T09:40:30.0011253Z",
"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": "a49ca7af-230b-4200-94a3-a6064c6f703b",
"targets": "9ffe1b94-f1fd-440c-b935-8ab50dfdd0e8",
"JoomlaArticleId": "sample string 11",
"regionscountries": "24fc2872-43ea-4575-be90-8699c5a88178",
"stakeholders": "d71c96c6-b4dd-4012-9956-897341e52fa6",
"targetaudiences": "bef69c00-26ca-4d13-9052-af384ba0f52f",
"Category": "cc34e3ec-eadb-4fca-814a-cb14c4262291",
"Tags": "eca950f0-8dae-4b94-9a66-ba1a49f026bc",
"departmentaltargets": "b19b2faf-ac04-4708-926d-0b28134103b2",
"events": "ef564893-c915-4e82-a789-441af8bbad15",
"publishingoffices": "dfec8f68-fdfb-4bb4-ad84-fe5bb4561b1b",
"Parts": "sample string 20",
"FolderId": "61e6130f-2922-48e3-9bd7-fb3d289a3e49",
"ParentId": "8a6cd270-f698-4220-bc03-f891bdcda059"
}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 | |
| JoomlaArticleId | System.String | 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-10-17T09:40:30.0011253Z",
"PublicationDate": "2026-10-17T09:40:30.0011253Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-10-17T09:40:30.0011253Z",
"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": "834849d7-d098-4e7f-9fe7-cfd7c7b953d4",
"targets": "aba661d1-10c9-4c9d-a4ac-dd21a2250cbb",
"JoomlaArticleId": "sample string 17",
"regionscountries": "15934435-0be7-4645-9bd4-84346210e4aa",
"stakeholders": "8385bf4e-ed5d-4457-9ef2-b87eae9914aa",
"targetaudiences": "30913d3b-53a9-4e9b-bdca-44b5314f58fc",
"Category": "f174a597-b616-492b-8e5b-51b36dac231f",
"Tags": "4b7824f0-5918-4b20-bc7d-e4b4a14735c9",
"departmentaltargets": "041a92fa-27c2-47d8-b9ad-efda36dc9ce3",
"events": "41c4dd11-4f37-40e3-a254-3d8591f9a817",
"publishingoffices": "74d97dc0-23a5-4ebd-a248-843fed224fab",
"Parts": "sample string 26",
"FolderId": "dce7933e-d276-4143-a8aa-4adecfb87ce0",
"ParentId": "ebba19a1-55ad-4e4f-8bdc-e516666f7127",
"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 | |
| JoomlaArticleId | System.String | 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-10-17T09:40:30.0011253Z",
"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": "06ce1f7b-3b5f-4995-a0aa-1cdf637d9a62",
"targets": "a70d5c4e-2a60-4626-b7b9-afa76b402309",
"JoomlaArticleId": "sample string 11",
"regionscountries": "630cb99f-5280-4d11-8634-a99b36cd66e4",
"stakeholders": "608ceecc-975f-4832-85db-db9fd073c848",
"targetaudiences": "5c4cc7ee-2fe0-4cfc-bf48-e0fe1261ae9e",
"Category": "88c8663d-3707-48a9-8687-4f24ff5937ae",
"Tags": "681482e5-beac-4898-b6de-73abd150d8b9",
"departmentaltargets": "efd45a07-95d8-42fa-bb98-32a516c0506e",
"events": "b23cd787-25c9-4ae7-86a5-6f18104db1fa",
"publishingoffices": "ee120386-2369-4d44-ac00-496dc132c9a3",
"Parts": "sample string 20",
"FolderId": "5fbbfa23-f652-4762-a9bf-cdce5f47c584",
"ParentId": "502832bc-954c-43aa-b629-6a7500a366bc"
}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 | |
| JoomlaArticleId | System.String | 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-10-17T09:40:30.0011253Z",
"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": "69ed7991-20ee-409b-886a-7ac27bc91354",
"targets": "244ab2fc-49bb-41e2-a474-f431b485de53",
"JoomlaArticleId": "sample string 11",
"regionscountries": "5a56a879-d585-4eab-8fa5-702e85c8ad43",
"stakeholders": "4fb4619a-9dfb-47ba-857f-6e1900609044",
"targetaudiences": "0fd2590e-1251-4812-a515-ac0f6ce625a9",
"Category": "2b20282c-0ec2-4345-8131-312c7144321b",
"Tags": "16bac932-dc3d-43f4-9c62-0b574d2d07e9",
"departmentaltargets": "67d53cbf-7815-4cdc-a924-5ca0f49573b8",
"events": "b4abda7d-143e-4385-824f-1e0e672d6895",
"publishingoffices": "f589b52c-87cc-47bf-8dea-f2e4882a5a50",
"Parts": "sample string 20",
"FolderId": "d4aee20a-e25b-4ad6-a902-4a3fea48f6bc",
"ParentId": "73c5601c-22ea-4417-bae0-61ae5a697bf2"
}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.