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-30T02:06:01.9339154Z",
"PublicationDate": "2026-08-30T02:06:01.9339154Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-08-30T02:06:01.9339154Z",
"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": "444a1a56-f2b1-4b4c-8743-d0915c6bf26c",
"targets": "e14da4e4-7359-4ba8-a4c8-f9f60e3c5323",
"regionscountries": "06b2ace4-a60a-4ad7-a17d-57adb9d4d2c8",
"stakeholders": "c84eb95a-3bed-41de-908f-3e7d3aee135e",
"targetaudiences": "553f3607-8504-4825-8157-53c9f89cfe9e",
"JoomlaArticleId": "sample string 20",
"Category": "8da4b04e-62a0-4685-b883-ad12539c55b0",
"Tags": "f9dcdead-9cc8-4c0d-81de-5d3bc507d06d",
"departmentaltargets": "0a5df986-0b44-4a9d-935e-88a4bac2cba6",
"events": "65a8b270-46aa-41ea-a107-3296c3fed4f2",
"publishingoffices": "4d61b8b5-dd0a-4e48-b454-43f9c018d3ab",
"Parts": "sample string 26",
"FolderId": "b9758f2d-7188-4617-9a1f-ebc1399965d8",
"ParentId": "ebfc87bc-3ec2-4565-9541-af763148922d",
"Provider": "sample string 29",
"Url": "sample string 30",
"ThumbnailUrl": "sample string 31",
"IsDamMedia": true
},
{
"LastModified": "2026-08-30T02:06:01.9339154Z",
"PublicationDate": "2026-08-30T02:06:01.9339154Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-08-30T02:06:01.9339154Z",
"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": "444a1a56-f2b1-4b4c-8743-d0915c6bf26c",
"targets": "e14da4e4-7359-4ba8-a4c8-f9f60e3c5323",
"regionscountries": "06b2ace4-a60a-4ad7-a17d-57adb9d4d2c8",
"stakeholders": "c84eb95a-3bed-41de-908f-3e7d3aee135e",
"targetaudiences": "553f3607-8504-4825-8157-53c9f89cfe9e",
"JoomlaArticleId": "sample string 20",
"Category": "8da4b04e-62a0-4685-b883-ad12539c55b0",
"Tags": "f9dcdead-9cc8-4c0d-81de-5d3bc507d06d",
"departmentaltargets": "0a5df986-0b44-4a9d-935e-88a4bac2cba6",
"events": "65a8b270-46aa-41ea-a107-3296c3fed4f2",
"publishingoffices": "4d61b8b5-dd0a-4e48-b454-43f9c018d3ab",
"Parts": "sample string 26",
"FolderId": "b9758f2d-7188-4617-9a1f-ebc1399965d8",
"ParentId": "ebfc87bc-3ec2-4565-9541-af763148922d",
"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-30T02:06:01.9339154Z",
"PublicationDate": "2026-08-30T02:06:01.9339154Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-08-30T02:06:01.9339154Z",
"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": "d3c0a6e8-f05a-4c9a-ad38-c430426767c6",
"targets": "d9df9ed1-30cd-4a37-b7d5-98f13f56f191",
"regionscountries": "b3d99435-fc58-4106-8fd5-fc8daf399e38",
"stakeholders": "a038f6ec-5a2e-4df3-8063-d2324e69690f",
"targetaudiences": "e8dafec2-cb42-4462-97cd-09086ccf1a50",
"JoomlaArticleId": "sample string 20",
"Category": "a724efbe-247d-4368-8678-bcda16f7a7cd",
"Tags": "de9268df-1143-4187-834e-d977c2194e96",
"departmentaltargets": "944848c3-90ac-4d6d-9286-ddb3a90003e5",
"events": "5492350b-037f-4587-9597-24f3ded59680",
"publishingoffices": "111183f2-f84e-4d1c-8dbd-40b627c846f5",
"Parts": "sample string 26",
"FolderId": "d77a614c-1a8d-4376-a470-35098abb0ca6",
"ParentId": "a5cd8439-8b12-42b5-bc76-7917ea1785c7",
"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": "4424f09c-a8eb-49d4-a8cf-35e7a2584301"
}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-30T02:06:01.9339154Z",
"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": "b89b6fed-ca55-4053-a877-afcd1e52eb25",
"targets": "5424eaf4-2819-4b19-818f-3e301154cb3a",
"regionscountries": "27d92eff-e216-4420-b36d-4da4813fbfe9",
"stakeholders": "8278ba84-df30-4a3e-ab68-3232f82ef8c5",
"targetaudiences": "cd09bde7-eac1-44df-97dc-4da380fbb47e",
"JoomlaArticleId": "sample string 14",
"Category": "e17c97d2-09db-4424-bb76-ff2b10096343",
"Tags": "d774ed62-4cd0-4eb2-9038-9d7f3781490b",
"departmentaltargets": "e7b72565-e0b6-4e3a-b8bd-6e8456d6e477",
"events": "26460761-0ded-45aa-9ae8-73353c2d0e0e",
"publishingoffices": "8d13f62e-aa54-49d9-bb24-9263dd62b62f",
"Parts": "sample string 20",
"FolderId": "97d93885-ab17-4e2e-bd96-f0bf16fdf41d",
"ParentId": "5f34940f-71a5-4a69-b1fd-818304562725"
}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-30T02:06:01.9339154Z",
"PublicationDate": "2026-08-30T02:06:01.9339154Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-08-30T02:06:01.9339154Z",
"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": "b133bde4-de73-4316-ba55-a45729c044e4",
"targets": "edc08b43-2486-451e-b52d-14fce38e2ee2",
"regionscountries": "99180c7e-029f-42fd-81df-550f33404d2b",
"stakeholders": "72e07ecc-3139-4672-93dc-ee4bb520488d",
"targetaudiences": "8648b608-1970-4c1f-877b-9808a6f83383",
"JoomlaArticleId": "sample string 20",
"Category": "06a95fd0-dc7b-4df2-bd93-8e836f1cb4c6",
"Tags": "efd26f25-4a1c-4670-80e3-496791b8682f",
"departmentaltargets": "291ac27a-e3a8-4fb2-bcaa-ef0a64e75ee7",
"events": "b0da9fad-0966-42ab-a470-dc236464dd9d",
"publishingoffices": "bdd7ff0d-f3b2-4034-aca3-c3d224a5b076",
"Parts": "sample string 26",
"FolderId": "c4fb4677-56ff-447c-9dce-70c064e4d222",
"ParentId": "1cbcce29-5eba-4690-af3f-2d6b98b2acce",
"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-30T02:06:01.9339154Z",
"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": "40358e41-9b76-4011-a245-3f38a29a2b96",
"targets": "2b6b3288-eeb3-426e-80be-c75d94d39934",
"regionscountries": "720140ef-0921-4b61-a4d6-5af3c8772801",
"stakeholders": "969a0da5-bf82-46a0-a800-b1550ad7ad57",
"targetaudiences": "563de7ab-ab21-4fae-a363-20536207bee1",
"JoomlaArticleId": "sample string 14",
"Category": "fc8a1974-106b-42dd-95cd-91845b9ee39e",
"Tags": "b84dd8df-d41e-4358-bbb9-71f36537fac3",
"departmentaltargets": "c62970ca-df72-4273-8391-70781b11b6fc",
"events": "3403f316-e929-478f-8de3-4a6a7d3eeb25",
"publishingoffices": "86a0e196-fed7-4e34-8d2f-747445a90305",
"Parts": "sample string 20",
"FolderId": "6176a3c8-6388-41d0-a608-48307e8462e7",
"ParentId": "cd7d2b96-3dce-4ae5-b1e1-b0ee49fb5646"
}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-30T02:06:01.9339154Z",
"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": "67c91408-441a-4e67-81d5-1be845b5122d",
"targets": "9c2de94d-41b0-40b6-a3ac-c0eab24e087a",
"regionscountries": "c53b2d48-c344-41d0-ab0c-8a15755ce276",
"stakeholders": "819d1b60-5f27-4b47-b4c8-23d59a9e3167",
"targetaudiences": "dbc7f524-ee5c-427b-8db8-b6e5da645a19",
"JoomlaArticleId": "sample string 14",
"Category": "a7b216b2-ba4d-41d8-89ea-3ddb20bfaa0e",
"Tags": "6869b0a9-6a9c-40a7-b745-ed6b8abfe377",
"departmentaltargets": "2662fdb7-69b2-4282-94d9-d263e6a941e3",
"events": "3bdc0f65-0475-4703-ba9e-6cc62f77eae6",
"publishingoffices": "95e1ff1f-b5a7-4943-aa99-db76b6a565fc",
"Parts": "sample string 20",
"FolderId": "18d71c57-489e-4d51-80ee-77ec04de3f77",
"ParentId": "7d048ada-ab9b-4708-ab60-94de29a8fc67"
}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.