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 | |
| 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-02-10T13:35:59.4203424Z",
"PublicationDate": "2026-02-10T13:35:59.4203424Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-02-10T13:35:59.4203424Z",
"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": "8a542415-0cef-4512-b20c-9906255248ef",
"targets": "e27de463-8033-4f91-b07d-e4c9aaa62fd9",
"regionscountries": "28d3f2e3-3bfe-464d-a41a-882f8764f45f",
"stakeholders": "6c5ec5e2-2e2e-4e0e-83fe-dac6dd30cae0",
"targetaudiences": "e46e1ec0-e4dc-4646-b0ef-8719a418b330",
"Category": "379cf2ae-b78d-47ed-9b55-16dfc9eba72b",
"Tags": "c8b999de-5335-4918-b98d-5c6a17213999",
"departmentaltargets": "dc34c6fb-6fd7-44ba-b3ab-6daa9a38e81e",
"events": "eff1ce0c-bfa4-4d28-b77a-fed495b38526",
"publishingoffices": "b7997db9-8849-42d1-8154-6b32459bca55",
"Parts": "sample string 25",
"FolderId": "aa380f47-c3ff-4f15-a2d5-7247fd507b8c",
"ParentId": "5704c5ff-b350-4152-b101-e045e68794e2",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"IsDamMedia": true
},
{
"LastModified": "2026-02-10T13:35:59.4203424Z",
"PublicationDate": "2026-02-10T13:35:59.4203424Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-02-10T13:35:59.4203424Z",
"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": "8a542415-0cef-4512-b20c-9906255248ef",
"targets": "e27de463-8033-4f91-b07d-e4c9aaa62fd9",
"regionscountries": "28d3f2e3-3bfe-464d-a41a-882f8764f45f",
"stakeholders": "6c5ec5e2-2e2e-4e0e-83fe-dac6dd30cae0",
"targetaudiences": "e46e1ec0-e4dc-4646-b0ef-8719a418b330",
"Category": "379cf2ae-b78d-47ed-9b55-16dfc9eba72b",
"Tags": "c8b999de-5335-4918-b98d-5c6a17213999",
"departmentaltargets": "dc34c6fb-6fd7-44ba-b3ab-6daa9a38e81e",
"events": "eff1ce0c-bfa4-4d28-b77a-fed495b38526",
"publishingoffices": "b7997db9-8849-42d1-8154-6b32459bca55",
"Parts": "sample string 25",
"FolderId": "aa380f47-c3ff-4f15-a2d5-7247fd507b8c",
"ParentId": "5704c5ff-b350-4152-b101-e045e68794e2",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"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 | |
| 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-02-10T13:35:59.4203424Z",
"PublicationDate": "2026-02-10T13:35:59.4203424Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-02-10T13:35:59.4203424Z",
"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": "d8a101f0-9ca2-4f4c-8021-2a9893b21df5",
"targets": "7ff9dbc7-5f7b-482e-aac0-4bd986c79961",
"regionscountries": "5ea26e30-ea3c-4c74-ae31-66103ad73014",
"stakeholders": "0a3bab32-4a9c-47ed-8689-2413923c1dcc",
"targetaudiences": "8a122b23-8775-47e3-8a73-b4bd2f989f28",
"Category": "086ab6f3-28fa-44c6-8c7b-4e7ece972baa",
"Tags": "9e69d5f5-8ba1-4977-a1b3-8076fdd8ce39",
"departmentaltargets": "c817b9cd-5d66-4df5-898a-c70fc976de54",
"events": "3eec6af8-578b-4698-9189-da41f7aae0f5",
"publishingoffices": "e39ec4bf-ad36-47b8-b129-e50bfe51b9c6",
"Parts": "sample string 25",
"FolderId": "b1ecccdd-a325-4e14-b102-80d060890a5d",
"ParentId": "395ecc04-6431-49ae-804b-9227b0e56da9",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"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": "655f0e88-ad53-4a5b-bb33-0c1ddf15549f"
}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 | |
| 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-02-10T13:35:59.4203424Z",
"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": "7e93e0f6-a15c-4b88-9c2a-1461f3373b7f",
"targets": "2bde2015-7574-417d-826f-c4a07594c204",
"regionscountries": "16ef7c09-d367-4359-a537-b81e9de427d3",
"stakeholders": "61c95bea-4468-45b0-b2cc-ce65e1bfb53f",
"targetaudiences": "99d6f6c3-0581-41f4-a708-b790d8eab645",
"Category": "45d8fa6c-2645-40ca-94ae-fdb5ef859380",
"Tags": "38e7d7c3-6832-4d7e-8b4e-7104b1c6dd05",
"departmentaltargets": "c4396f8d-f14c-4b69-9743-5bd411bf52d4",
"events": "c8655b08-aa00-4ae1-a11a-82c5c4949132",
"publishingoffices": "2804980e-514f-4c2c-9a69-1b4a44c04f86",
"Parts": "sample string 19",
"FolderId": "991419c9-7515-4998-bd62-7a6528218c94",
"ParentId": "c86f024b-5749-4acf-94b6-1c6950d292be"
}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 | |
| 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-02-10T13:35:59.4203424Z",
"PublicationDate": "2026-02-10T13:35:59.4203424Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-02-10T13:35:59.4203424Z",
"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": "1bb04440-a983-4e03-8df7-8ec39a3e4cac",
"targets": "d22e6db9-7225-40d9-b6f9-2d7fc94c7c4d",
"regionscountries": "04d82ee2-8934-401d-9e52-83a90b6dc6f4",
"stakeholders": "70b592d5-76b4-4578-a0b3-619a11ab9618",
"targetaudiences": "656b7206-1704-415c-95d6-9f7cf8ecc772",
"Category": "d6091ddb-1d2d-4eff-970c-d4b6b74c2297",
"Tags": "642ac77e-d2f9-42c9-9d85-757d8059b373",
"departmentaltargets": "e3a5b1f4-df86-421a-b1fc-09f86b88b59d",
"events": "469464a2-60a1-4fd5-8b50-32f40a57b80d",
"publishingoffices": "338e51ec-2d41-4094-97c6-3a8f4b116fdc",
"Parts": "sample string 25",
"FolderId": "232ee81e-c602-477e-a95c-d1086f4331d3",
"ParentId": "a081fdce-a9c6-445d-a92a-466f0d961034",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"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 | |
| 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-02-10T13:35:59.4203424Z",
"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": "9fa41562-757c-4740-a9fd-5d30aed0d42a",
"targets": "a64b7fa2-1d94-49dc-8055-feef33a401b6",
"regionscountries": "650c2fd3-c115-4040-9ad6-5bf62e1312e4",
"stakeholders": "845bf766-6dca-4ff9-9d45-2bf5b467decc",
"targetaudiences": "c6cfdb1d-9a3f-448c-87b9-e6204ed02f5b",
"Category": "86e57c4a-72a6-4d0b-a8b7-cfb7daa9ae53",
"Tags": "e2bf797d-9e3d-45cf-ab50-f74c75b81420",
"departmentaltargets": "43935e94-df02-41d7-b090-202ee14abcc0",
"events": "192c5642-5e93-4319-9ae8-ea95b06fe511",
"publishingoffices": "6bd136e4-1e07-4b6a-b91d-e3ec02ae8808",
"Parts": "sample string 19",
"FolderId": "b3d5d422-dfd7-485a-adba-0dab5b331400",
"ParentId": "377e5773-9264-468b-ad62-bab493beeed8"
}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 | |
| 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-02-10T13:35:59.4203424Z",
"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": "2cf404db-cae4-412a-8b53-29ebf69a257a",
"targets": "49390971-8f25-4e3f-b241-87dc971b77d8",
"regionscountries": "b20b938e-e70b-4e5e-8587-d356fddbc4cb",
"stakeholders": "0d25114f-5a6b-4848-9835-6137384531e6",
"targetaudiences": "aa6f1767-9a9a-429b-95b8-ef4dc41b0375",
"Category": "0eaad521-c769-4145-85ee-06d4b8e45c25",
"Tags": "38ed7099-45f1-4a4f-8577-278b4b8974f6",
"departmentaltargets": "54c339a2-01ab-436e-8b24-8e22d263cfaf",
"events": "1a8f2ee6-395e-412c-9edd-4ed79b2dae89",
"publishingoffices": "05794273-c8f7-48bf-a3fb-9eab15604dc8",
"Parts": "sample string 19",
"FolderId": "a660be1d-8d96-47cf-a5ef-3d2e02129d4a",
"ParentId": "0e330b58-201e-4fde-8141-a1d3498f7e06"
}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.