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-11-11T17:30:44.0309968Z",
"PublicationDate": "2026-11-11T17:30:44.0309968Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-11-11T17:30:44.0309968Z",
"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": "e9d6c7d0-40c0-4b0f-a6d3-f6c713ffbbf4",
"targets": "673a8ced-35c6-4049-a548-ee93893aec4e",
"regionscountries": "e0eeb0c5-142f-46ea-b00a-7cb5695eff4c",
"stakeholders": "5c5293e1-e10e-416c-a35d-b5b972226422",
"targetaudiences": "e2f60716-6da1-4d26-90e3-c0d03153fc7b",
"JoomlaArticleId": "sample string 20",
"Category": "c36bfb43-0f4e-4cdc-b83a-6ffdef2e0975",
"Tags": "18588b43-d7b0-4398-aa51-1b9cb01222d7",
"departmentaltargets": "0d44d22b-1b16-45c8-af03-c2c5d7742d3f",
"events": "af6ebcb3-7856-442a-896a-f69a18ba5886",
"publishingoffices": "45931613-9ada-4d0d-b595-005cfbdb751f",
"Parts": "sample string 26",
"FolderId": "4dead7ed-78e4-4559-88b2-b71b7c1188b7",
"ParentId": "b26fe837-b44a-4698-b3a1-1491dec36f78",
"Provider": "sample string 29",
"Url": "sample string 30",
"ThumbnailUrl": "sample string 31",
"IsDamMedia": true
},
{
"LastModified": "2026-11-11T17:30:44.0309968Z",
"PublicationDate": "2026-11-11T17:30:44.0309968Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-11-11T17:30:44.0309968Z",
"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": "e9d6c7d0-40c0-4b0f-a6d3-f6c713ffbbf4",
"targets": "673a8ced-35c6-4049-a548-ee93893aec4e",
"regionscountries": "e0eeb0c5-142f-46ea-b00a-7cb5695eff4c",
"stakeholders": "5c5293e1-e10e-416c-a35d-b5b972226422",
"targetaudiences": "e2f60716-6da1-4d26-90e3-c0d03153fc7b",
"JoomlaArticleId": "sample string 20",
"Category": "c36bfb43-0f4e-4cdc-b83a-6ffdef2e0975",
"Tags": "18588b43-d7b0-4398-aa51-1b9cb01222d7",
"departmentaltargets": "0d44d22b-1b16-45c8-af03-c2c5d7742d3f",
"events": "af6ebcb3-7856-442a-896a-f69a18ba5886",
"publishingoffices": "45931613-9ada-4d0d-b595-005cfbdb751f",
"Parts": "sample string 26",
"FolderId": "4dead7ed-78e4-4559-88b2-b71b7c1188b7",
"ParentId": "b26fe837-b44a-4698-b3a1-1491dec36f78",
"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-11-11T17:30:44.0309968Z",
"PublicationDate": "2026-11-11T17:30:44.0309968Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-11-11T17:30:44.0309968Z",
"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": "e5ae52ac-d7f7-4081-9f89-c6a6e0ec72c0",
"targets": "4cf7189c-063f-4872-806b-b7cc87f59099",
"regionscountries": "d7eae173-b6f8-40e1-adf6-dd74b2994b47",
"stakeholders": "3b1b5f3c-e86c-45fc-b956-7e1cc3dc749d",
"targetaudiences": "6553f40e-0d81-404a-a6cf-3ab20c076ce6",
"JoomlaArticleId": "sample string 20",
"Category": "e69bde4c-1319-4162-97c1-bf918609b8d9",
"Tags": "79d27465-3806-41d7-b5b8-356f9569407e",
"departmentaltargets": "37c12b73-aa0c-4960-af83-686cd16d1503",
"events": "3731a16e-83c8-4c33-b60f-5db98dbba2b0",
"publishingoffices": "5e37935c-1d77-4dae-8ec8-423ed6ffc0ed",
"Parts": "sample string 26",
"FolderId": "40fc4d9d-8c7c-46ce-9350-6f0f3bd0b0bf",
"ParentId": "90dd6665-e09f-43a5-b3b2-b349393bba30",
"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": "10c0851e-1d29-4381-be0b-6096d99063fb"
}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-11-11T17:30:44.0309968Z",
"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": "8e37f6eb-5c34-46ae-b3fe-50ef09bab1f1",
"targets": "2e35bba0-1fb9-4d50-9347-e64315bbd163",
"regionscountries": "407824b4-53ea-4ed1-ac9f-ef0a3a662cfd",
"stakeholders": "6cbf609c-23a5-44ef-b87d-c513656d23a2",
"targetaudiences": "dde393dd-b2ea-4a40-854c-da828a7ca8ad",
"JoomlaArticleId": "sample string 14",
"Category": "34717366-65e4-4375-b6a2-3c1f3aa7881e",
"Tags": "29ef2fde-e923-43b1-8cae-f06aaa080c3d",
"departmentaltargets": "0acdee8d-1ee9-4511-a928-4fcea9c527c6",
"events": "d88ba3b3-3c21-40e2-b98e-4be665736821",
"publishingoffices": "bde3d9a9-ecb3-46f0-899b-a1784ae0ffb0",
"Parts": "sample string 20",
"FolderId": "443ff20b-26c3-4c25-82d4-8926a5ccd80b",
"ParentId": "175d7592-a242-4b3a-896a-afddc0538c2f"
}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-11-11T17:30:44.0309968Z",
"PublicationDate": "2026-11-11T17:30:44.0309968Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-11-11T17:30:44.0309968Z",
"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": "9679e20d-8a39-4bed-92e3-c21307034cb9",
"targets": "85158636-fe47-4099-a2c0-99e73669c607",
"regionscountries": "cabf3859-9f6c-44db-89e7-4e4294862b5f",
"stakeholders": "4288a17d-dc1b-4a38-a85a-eef48b66fa62",
"targetaudiences": "b84e3b66-85d2-4bce-9609-ecac0cd9e07b",
"JoomlaArticleId": "sample string 20",
"Category": "17a7f3c1-635f-4ac1-b53a-82a21c212023",
"Tags": "67c9a7b3-f6e0-4619-a3a5-db701b825bc9",
"departmentaltargets": "3cb9b823-0fff-49c3-9bcb-0791fcdd446c",
"events": "e43b1ef3-73ea-45de-858a-572d8d344990",
"publishingoffices": "55241cb1-eadb-4da1-9e47-30a1a27efacb",
"Parts": "sample string 26",
"FolderId": "d8c95324-4555-4a15-9d85-53b6bee3784f",
"ParentId": "ea5a3c18-e3e2-464c-822d-b11f9fa7524b",
"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-11-11T17:30:44.0309968Z",
"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": "08f6ccd2-322f-44c0-9e56-2f78a4deefd8",
"targets": "fa8b7839-f44c-4384-8de1-8436a99ed03d",
"regionscountries": "f4a8139f-bd83-4b2f-afa1-0b5194177a81",
"stakeholders": "8dfe09db-ff85-4c4b-9e3b-eed81b694aaa",
"targetaudiences": "58d61c82-a9b4-4179-9305-b6cfc1b1a1b2",
"JoomlaArticleId": "sample string 14",
"Category": "e9b5ad05-ebc0-44fc-8442-a9ea1c0bdda3",
"Tags": "dd8c8817-ce94-4ac1-965a-4f5b1f4e2c62",
"departmentaltargets": "66bc857d-f39f-4a34-af11-ad0691dceacd",
"events": "ca5a4422-0878-40d7-8293-9efe1902512d",
"publishingoffices": "4a17405d-7b3e-40e0-ba53-d89f98f99bec",
"Parts": "sample string 20",
"FolderId": "3794fcad-9c26-4916-bc54-2de65e7d4a5c",
"ParentId": "c84beea3-40dd-49b9-84f6-d9024ece4684"
}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-11-11T17:30:44.0309968Z",
"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": "390e549f-8513-49f3-85a0-c30ccc0d39b4",
"targets": "1a1be033-8948-4352-9998-405cc87aebfd",
"regionscountries": "9d42f7f1-6b3a-4db4-b441-f1a18f2dfddd",
"stakeholders": "a6f1e215-dda8-4682-bd63-d8d6c1a9fc93",
"targetaudiences": "553e1ead-7932-42da-945d-46eaf83d5fb2",
"JoomlaArticleId": "sample string 14",
"Category": "84e857f2-8228-410b-a722-6f38905d667e",
"Tags": "65da8ecb-2bc5-4d3f-90ae-d9f2451a8f78",
"departmentaltargets": "645c6299-97a8-49f9-aea6-a9a0d6dd553e",
"events": "c397c657-7b99-432d-b132-b2773e599689",
"publishingoffices": "f3b776a2-d637-4c7e-a40d-b297ce2dba39",
"Parts": "sample string 20",
"FolderId": "afff0346-b008-4b54-a0ce-005c15ac52c8",
"ParentId": "a3ab0802-9e6b-40bc-b5c6-eea2383766b5"
}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.