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 | |
| JoomlaArticleId | System.String | 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-09-20T23:25:01.4460574Z",
"PublicationDate": "2026-09-20T23:25:01.4460574Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-09-20T23:25:01.4460574Z",
"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": "aa8ccf55-d681-4714-939b-3211e70b9fa0",
"targets": "6b241f71-9f0c-4d52-a157-60f2f1e47e8e",
"regionscountries": "c4fb4b25-47fe-4809-91be-e5b2ffab401f",
"stakeholders": "4f0744a6-57f1-4dcd-b119-f0abbc32d7df",
"targetaudiences": "c0dba602-5a2e-451a-9072-6b9423bbc610",
"JoomlaArticleId": "sample string 20",
"Category": "0537a59d-624f-462c-8de2-a296f647d8cd",
"Tags": "46928e7f-a57b-4b94-9138-2b7c91c609ae",
"departmentaltargets": "0abf4f41-f512-4385-a8b6-0549d90d1b63",
"events": "87aaa37a-9003-42ed-8b7c-6a946a2d96b0",
"publishingoffices": "f12ff6ce-4c3c-4955-907d-3ab4a5854371",
"Parts": "sample string 26",
"FolderId": "f0b6dbce-6f41-4eee-9626-65cd19df075f",
"ParentId": "d8dc3b55-ced8-43db-91c8-b7fc6d41999f",
"Provider": "sample string 29",
"Url": "sample string 30",
"ThumbnailUrl": "sample string 31",
"IsDamMedia": true
},
{
"LastModified": "2026-09-20T23:25:01.4460574Z",
"PublicationDate": "2026-09-20T23:25:01.4460574Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-09-20T23:25:01.4460574Z",
"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": "aa8ccf55-d681-4714-939b-3211e70b9fa0",
"targets": "6b241f71-9f0c-4d52-a157-60f2f1e47e8e",
"regionscountries": "c4fb4b25-47fe-4809-91be-e5b2ffab401f",
"stakeholders": "4f0744a6-57f1-4dcd-b119-f0abbc32d7df",
"targetaudiences": "c0dba602-5a2e-451a-9072-6b9423bbc610",
"JoomlaArticleId": "sample string 20",
"Category": "0537a59d-624f-462c-8de2-a296f647d8cd",
"Tags": "46928e7f-a57b-4b94-9138-2b7c91c609ae",
"departmentaltargets": "0abf4f41-f512-4385-a8b6-0549d90d1b63",
"events": "87aaa37a-9003-42ed-8b7c-6a946a2d96b0",
"publishingoffices": "f12ff6ce-4c3c-4955-907d-3ab4a5854371",
"Parts": "sample string 26",
"FolderId": "f0b6dbce-6f41-4eee-9626-65cd19df075f",
"ParentId": "d8dc3b55-ced8-43db-91c8-b7fc6d41999f",
"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 | |
| regionscountries | System.Guid | Read only: False | |
| stakeholders | System.Guid | Read only: False | |
| targetaudiences | System.Guid | Read only: False | |
| JoomlaArticleId | System.String | 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-09-20T23:25:01.4460574Z",
"PublicationDate": "2026-09-20T23:25:01.4460574Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-09-20T23:25:01.4460574Z",
"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": "1672d8b6-715c-4e19-b9a5-48bab9c1f6b9",
"targets": "5db9ae99-80e5-48d6-aae2-9b219793c296",
"regionscountries": "e0a3ff03-d0da-44bf-b8b2-e73e13f70a9a",
"stakeholders": "bad17e12-0362-481e-9625-9e0c607ba5d8",
"targetaudiences": "4cbaeafa-c87c-42e7-a982-4919641a5c02",
"JoomlaArticleId": "sample string 20",
"Category": "10b42fd5-e840-4737-8dca-b5da4e9c328d",
"Tags": "9fbd33cb-8160-44d8-8330-edc5979c987c",
"departmentaltargets": "5d302bec-dbf6-47c7-9202-4bdd6152853d",
"events": "a30617dd-3ba9-4eb4-89fb-c3829b019d8d",
"publishingoffices": "6a8ecb58-7151-4564-9d8a-2a2db887af79",
"Parts": "sample string 26",
"FolderId": "0d9511e8-6625-42d2-8631-a4731704b057",
"ParentId": "2f73a672-3f65-4ea2-91b9-79bcb9060f42",
"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": "0cf78e47-8959-4092-b5b3-30283c9a538f"
}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 | |
| JoomlaArticleId | System.String | 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-09-20T23:25:01.4460574Z",
"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": "63febe4b-2080-452f-bf65-a1d4e2f8502b",
"targets": "5dac3008-46af-4ec7-b26a-80868e6c95f3",
"regionscountries": "10e49d42-5b3c-47a3-b85b-d4bde82df346",
"stakeholders": "d58fd011-6e6e-4302-91b0-1940995871cc",
"targetaudiences": "9149f132-c2a7-4492-9944-a50c9e64e853",
"JoomlaArticleId": "sample string 14",
"Category": "bc57b397-b546-4bc1-a926-90613cec028f",
"Tags": "b0306b92-ebf5-4e0b-bddc-268a676fa4b2",
"departmentaltargets": "2eeaef68-c120-43a2-a8df-b909db68fd9c",
"events": "27bc4b8a-8343-416b-bbbf-82396510f630",
"publishingoffices": "35b9b65c-4754-4d9c-9b48-cf57b4c450b6",
"Parts": "sample string 20",
"FolderId": "0e5e8192-cc18-4038-ad54-fd8ebada2631",
"ParentId": "3b939cc4-d94a-4167-a9a1-a61199b470e9"
}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 | |
| JoomlaArticleId | System.String | 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-09-20T23:25:01.4460574Z",
"PublicationDate": "2026-09-20T23:25:01.4460574Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-09-20T23:25:01.4460574Z",
"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": "fa2ffe2f-dd08-4b66-88f1-56931321f5f5",
"targets": "12b83d2c-bf0a-4b5d-b4db-47c0e49b4126",
"regionscountries": "c2bf053b-8c77-475b-9a4b-0629ecd55e22",
"stakeholders": "e6789d9e-67b9-44ad-a487-bbd094d97fce",
"targetaudiences": "cbbb7786-7c07-40c5-b09a-88b116588a43",
"JoomlaArticleId": "sample string 20",
"Category": "d8cc81e5-ef0a-4d45-951e-4ed55dc5cc2f",
"Tags": "973c1684-1f1b-426b-9140-b566b6d33da1",
"departmentaltargets": "a66aae21-7350-45a1-b4ff-fa15bfe876ca",
"events": "cc3b319e-4840-4e91-87f2-168e3233805c",
"publishingoffices": "a118907e-e198-45d4-9bc5-03a140be059c",
"Parts": "sample string 26",
"FolderId": "b25b2bfa-c15a-4364-a33d-195960e70446",
"ParentId": "b9fb4d8a-1133-4729-b964-b598ac3255c3",
"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 | |
| regionscountries | System.Guid | Read only: False | |
| stakeholders | System.Guid | Read only: False | |
| targetaudiences | System.Guid | Read only: False | |
| JoomlaArticleId | System.String | 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-09-20T23:25:01.4460574Z",
"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": "9e17909b-5240-422f-9760-686bb0cd116d",
"targets": "19d53085-dead-4564-9d4f-da7602d3fa9a",
"regionscountries": "98a1b1bf-dae1-4cd6-8c92-89fbc1425b57",
"stakeholders": "62efd6a0-14d9-4f7a-a933-a85ad1420c65",
"targetaudiences": "aa0cfaac-aa8c-4d20-9c60-3d9cb4954567",
"JoomlaArticleId": "sample string 14",
"Category": "a226b799-2086-437d-9dd5-5ad925846b06",
"Tags": "87bfd26e-00f5-47d8-afa3-1afa02368b4a",
"departmentaltargets": "150f5043-d5dd-41e7-8baf-0650e43986fc",
"events": "75753733-03ca-41df-bf10-d4368906b0b5",
"publishingoffices": "b26c1279-5af3-42fe-96f5-649f5d566761",
"Parts": "sample string 20",
"FolderId": "28e39630-5e17-4de5-85a5-403b3c30a980",
"ParentId": "35211cb0-77b4-4f1a-b54c-138f441f8c95"
}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 | |
| JoomlaArticleId | System.String | 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-09-20T23:25:01.4460574Z",
"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": "798332e6-56bc-4d05-a957-e5eb68d864fd",
"targets": "63abebaf-0254-4b6e-bf3f-1b00994b6481",
"regionscountries": "798529c1-355f-4b5b-a225-f168dc845b36",
"stakeholders": "af91c0fc-940b-4ee6-b079-fe7230722d44",
"targetaudiences": "b24625a0-8107-4f6b-bb08-893099c5fc51",
"JoomlaArticleId": "sample string 14",
"Category": "9c2cf4e6-cf79-4e9a-874d-1696c7e8d034",
"Tags": "28680fc6-4326-404c-bdd8-54a0011e9de1",
"departmentaltargets": "41f05bd8-6600-45ff-90fc-f5c4aa058bef",
"events": "7a0c9883-1213-4802-8233-ad8721a326de",
"publishingoffices": "d54a3368-d3ca-4150-9af0-9f9ee4de8b7c",
"Parts": "sample string 20",
"FolderId": "f9c5f233-8159-41d1-a8a2-a0ebdc7def01",
"ParentId": "d2f27836-3dd9-4cfe-b51a-0f83bf8d7ae2"
}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.