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-08-07T23:49:23.5478455Z",
"PublicationDate": "2026-08-07T23:49:23.5478455Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-08-07T23:49:23.5478455Z",
"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": "e0c0cd09-087d-4493-9fb6-d38fce0f8f5f",
"targets": "6f954d03-adfd-4f77-973c-596dba26e02d",
"regionscountries": "eb6c43e7-c454-49c7-8b39-f3a4377d2196",
"stakeholders": "595ce366-9e68-46d3-a5b4-da7f8ea08c25",
"targetaudiences": "f50d3e36-9e91-4c92-8fca-17954bac4973",
"JoomlaArticleId": "sample string 20",
"Category": "4f77bcb1-f7b8-46c5-9efb-747c21acd7e6",
"Tags": "2bb6c0db-0f13-4a53-a5d0-1a513ebaf8f6",
"departmentaltargets": "93d71f27-4687-41ec-8de8-0d86554b9ffc",
"events": "d3555791-6b36-47a6-9543-5df5e8265aa3",
"publishingoffices": "bf528b81-7a3e-40f3-b4a7-855b6fcadf98",
"Parts": "sample string 26",
"FolderId": "48cc33b7-0a00-453f-9a29-ef631ddcb388",
"ParentId": "ec0654bd-048b-4d62-b353-760fedbe5a1a",
"Provider": "sample string 29",
"Url": "sample string 30",
"ThumbnailUrl": "sample string 31",
"IsDamMedia": true
},
{
"LastModified": "2026-08-07T23:49:23.5478455Z",
"PublicationDate": "2026-08-07T23:49:23.5478455Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-08-07T23:49:23.5478455Z",
"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": "e0c0cd09-087d-4493-9fb6-d38fce0f8f5f",
"targets": "6f954d03-adfd-4f77-973c-596dba26e02d",
"regionscountries": "eb6c43e7-c454-49c7-8b39-f3a4377d2196",
"stakeholders": "595ce366-9e68-46d3-a5b4-da7f8ea08c25",
"targetaudiences": "f50d3e36-9e91-4c92-8fca-17954bac4973",
"JoomlaArticleId": "sample string 20",
"Category": "4f77bcb1-f7b8-46c5-9efb-747c21acd7e6",
"Tags": "2bb6c0db-0f13-4a53-a5d0-1a513ebaf8f6",
"departmentaltargets": "93d71f27-4687-41ec-8de8-0d86554b9ffc",
"events": "d3555791-6b36-47a6-9543-5df5e8265aa3",
"publishingoffices": "bf528b81-7a3e-40f3-b4a7-855b6fcadf98",
"Parts": "sample string 26",
"FolderId": "48cc33b7-0a00-453f-9a29-ef631ddcb388",
"ParentId": "ec0654bd-048b-4d62-b353-760fedbe5a1a",
"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-08-07T23:49:23.5478455Z",
"PublicationDate": "2026-08-07T23:49:23.5478455Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-08-07T23:49:23.5478455Z",
"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": "62399c3d-e2eb-46b2-8572-5efdf6933134",
"targets": "914bc429-ad26-4748-8d96-28ff3dd8361e",
"regionscountries": "68253aa9-c5ab-4720-813a-230f6c4ae5c0",
"stakeholders": "503a544d-dcbe-4ed2-8d74-f68e48f0bae9",
"targetaudiences": "56fb914c-0646-42d1-85eb-640f30a93056",
"JoomlaArticleId": "sample string 20",
"Category": "3f431998-e265-43c8-af9e-84c45f09f09c",
"Tags": "c9b3d4c2-3c73-4e9e-a112-310e43f1a1fd",
"departmentaltargets": "10aa9f3d-0f6a-460a-8237-91fe8e3a06b1",
"events": "82186d7f-e9ed-49ea-a67e-efb5b5cfef66",
"publishingoffices": "0c543401-9014-4c14-9553-5ad886191b15",
"Parts": "sample string 26",
"FolderId": "5e8c5b39-f057-4c10-aa5b-04be61b56a19",
"ParentId": "4285d0fb-33e7-46d6-8c51-edf403f8cfbc",
"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": "ff7b5614-02da-42e8-897e-f797a1a7de2a"
}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-08-07T23:49:23.5478455Z",
"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": "7ee7a53c-41be-4b27-a4e4-29e3967efe0a",
"targets": "fa83424e-d142-4223-b96f-1cb6c6edfcd5",
"regionscountries": "e14e6d3b-16c4-4914-a944-e44ca054edd4",
"stakeholders": "5512d9eb-1d1b-4e9a-a528-384f4a786462",
"targetaudiences": "5d80affe-e680-400b-96ff-ef0714e3db3d",
"JoomlaArticleId": "sample string 14",
"Category": "46d65cdc-64ff-4696-bdcf-dd40d7389df3",
"Tags": "a0e32cd7-ba1e-4a7c-a3fa-667519a24dd0",
"departmentaltargets": "e6e1c582-bc0d-4ce5-82d0-eba8ccb67997",
"events": "b5684779-a5a4-47cf-9fea-ecee1142e208",
"publishingoffices": "5b8ac62e-1837-45de-bd1c-7fab57593b92",
"Parts": "sample string 20",
"FolderId": "8596bda4-6d4a-40ee-9c10-596186140071",
"ParentId": "81f98410-7569-47cf-9dd9-a839a182302f"
}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-08-07T23:49:23.5478455Z",
"PublicationDate": "2026-08-07T23:49:23.5478455Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-08-07T23:49:23.5478455Z",
"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": "652026b8-18d6-41b8-a6cc-ad2f1cdfb194",
"targets": "dd163c75-52fb-4ccc-bd94-43459ae61ab7",
"regionscountries": "12e37ec5-6a99-488f-8b57-60877df5375e",
"stakeholders": "bd3a1d6d-7190-4856-9171-e8529630e9d9",
"targetaudiences": "fe1e2944-f767-4074-a639-061aca9c3f60",
"JoomlaArticleId": "sample string 20",
"Category": "03ea9cbe-c148-4856-bc69-0253f270f1e9",
"Tags": "1217b70d-351e-40bd-9c2d-37d36d13fc62",
"departmentaltargets": "37a045f0-d809-4b6c-a7e8-49abf6d0ad8a",
"events": "e433b183-9b13-4e7b-9b6f-15546a698021",
"publishingoffices": "f7b3f377-5a10-46d9-92c5-02d8f2ef0b87",
"Parts": "sample string 26",
"FolderId": "e57b9fb0-6dac-4f08-91aa-b1f5d70c4908",
"ParentId": "b2863230-bb2e-468f-b3cd-0609eef2a842",
"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-08-07T23:49:23.5478455Z",
"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": "07a6a23f-d3be-477b-a01c-4b819fc8ac58",
"targets": "f487a419-5e76-4865-9b1e-151ad2b76ef6",
"regionscountries": "a4cd1d64-d4dc-45bf-a40c-1b947437fa07",
"stakeholders": "dd780841-9c43-4a0f-ab08-daf9da33a588",
"targetaudiences": "c66f0312-85ad-4fd4-a576-765e5d4a2489",
"JoomlaArticleId": "sample string 14",
"Category": "6520a36b-b639-48c8-a321-f271a9dbb7c4",
"Tags": "3bca1c8f-9a25-4c2d-aa7b-01347b1d588e",
"departmentaltargets": "3f6446d0-7f0f-4fe7-a5cf-41f10e164ecf",
"events": "52ddd8c5-4c47-4324-b991-58e84affef88",
"publishingoffices": "1f76a7a3-15b5-4198-822a-b4988bb3eff8",
"Parts": "sample string 20",
"FolderId": "bf10b511-2617-470a-9c12-6e10a2001566",
"ParentId": "c1668faf-fee9-4854-ac3a-dd9962a6f506"
}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-08-07T23:49:23.5478455Z",
"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": "926915e0-35c2-4a6f-8fc1-154993ea5175",
"targets": "eb3452f3-9c5f-4e37-8a78-396d03eee8a0",
"regionscountries": "cc1fd4aa-bc2c-473e-a272-43f81f5c439a",
"stakeholders": "11c2bc24-ffbf-465d-bcfe-87bf28ba6949",
"targetaudiences": "c7d877d6-30aa-4f52-b421-fdd0f0b43a31",
"JoomlaArticleId": "sample string 14",
"Category": "b16a15ed-2fc2-4a87-9726-2f718320b2e6",
"Tags": "232d6c92-532a-444a-ac58-5c08152b155d",
"departmentaltargets": "0905f6c7-256e-44b1-8fe4-9dff921ce877",
"events": "8469d2c1-ee30-4af8-8020-a00abed92051",
"publishingoffices": "8eb0527d-9dfd-479b-aedb-c960d87d84b1",
"Parts": "sample string 20",
"FolderId": "2af6c372-3697-4ed5-a83d-42492214cd65",
"ParentId": "8b1b7318-f3fc-448c-9d96-1fce4a84c35b"
}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.