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-01-12T18:09:51.2592793Z",
"PublicationDate": "2026-01-12T18:09:51.2592793Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-01-12T18:09:51.2592793Z",
"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": "d4c15481-68c7-4f6e-a270-29ce94d19497",
"targets": "82823ea0-b5a4-4eef-8938-0dfdc5dab057",
"regionscountries": "c50ccb25-73d6-4c82-a458-eead821f9afb",
"stakeholders": "06d4be21-567c-4386-9118-b1d778ad23dd",
"targetaudiences": "8038e8ba-a899-463c-9f3e-61b23f9877a7",
"Category": "719779c2-ce06-4362-baff-61c9cf97a617",
"Tags": "9550ebe9-da07-4e5f-9d4e-87644092efd5",
"departmentaltargets": "0e6d92d6-83ec-44ba-82eb-cb985dc07257",
"events": "6e471ad7-3f50-4520-8e88-347bd003958d",
"publishingoffices": "7de79e82-032a-4708-bb64-46e5b16fbefc",
"Parts": "sample string 25",
"FolderId": "448ef804-ac54-441b-b4e3-7c7c5b5a9971",
"ParentId": "0b477cdb-6d0f-4831-8a1e-c3cfb2d85f9d",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"IsDamMedia": true
},
{
"LastModified": "2026-01-12T18:09:51.2592793Z",
"PublicationDate": "2026-01-12T18:09:51.2592793Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-01-12T18:09:51.2592793Z",
"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": "d4c15481-68c7-4f6e-a270-29ce94d19497",
"targets": "82823ea0-b5a4-4eef-8938-0dfdc5dab057",
"regionscountries": "c50ccb25-73d6-4c82-a458-eead821f9afb",
"stakeholders": "06d4be21-567c-4386-9118-b1d778ad23dd",
"targetaudiences": "8038e8ba-a899-463c-9f3e-61b23f9877a7",
"Category": "719779c2-ce06-4362-baff-61c9cf97a617",
"Tags": "9550ebe9-da07-4e5f-9d4e-87644092efd5",
"departmentaltargets": "0e6d92d6-83ec-44ba-82eb-cb985dc07257",
"events": "6e471ad7-3f50-4520-8e88-347bd003958d",
"publishingoffices": "7de79e82-032a-4708-bb64-46e5b16fbefc",
"Parts": "sample string 25",
"FolderId": "448ef804-ac54-441b-b4e3-7c7c5b5a9971",
"ParentId": "0b477cdb-6d0f-4831-8a1e-c3cfb2d85f9d",
"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-01-12T18:09:51.2592793Z",
"PublicationDate": "2026-01-12T18:09:51.2592793Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-01-12T18:09:51.2592793Z",
"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": "bc646dc5-01f4-4479-a45b-1b6f3c4feeb9",
"targets": "bdaa5b48-4d93-43ed-9cae-fda123397cb5",
"regionscountries": "5c5b1242-4d20-4543-83ba-d69b6638e8dc",
"stakeholders": "81041254-cef7-4359-b95b-1928d5ee7f4b",
"targetaudiences": "08b79a76-cb90-4575-8db3-73ea9dd31d14",
"Category": "6052424e-0cfc-4100-a531-0ca8dfa0c085",
"Tags": "2fdb8cbd-1849-4546-9e31-d48b81823238",
"departmentaltargets": "1bf45cb8-6ea7-4b57-9999-8fcd2fef53b0",
"events": "10e816cc-c366-4520-b097-a51e26e2e9c2",
"publishingoffices": "6de69c07-4471-429f-8fc3-ef35eb82b96e",
"Parts": "sample string 25",
"FolderId": "b5c2e673-9d8b-4c9e-b07a-35fb6c10dcc2",
"ParentId": "8b8fad11-2f92-407b-9cc5-d9873e227da7",
"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": "9b3f337f-e131-4ef6-a3be-641483086019"
}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-01-12T18:09:51.2592793Z",
"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": "3792bf08-6a7b-468c-8cd8-daa0756a7080",
"targets": "01395b9d-3482-4e18-8df0-65ca4bb6b562",
"regionscountries": "bb91bed0-fee0-43a0-b71f-6f08a78486d4",
"stakeholders": "9b020b0c-d6a7-4632-80ae-c75c9103bb34",
"targetaudiences": "105b4fea-f664-4ca8-8f78-ceca01a4ed71",
"Category": "86aebbad-d661-45be-9c47-fa98e7fb2fcb",
"Tags": "617d0ac8-fd49-44fe-aef8-f5af2a3545df",
"departmentaltargets": "934df50c-7b07-4047-908f-bb1d5f6946d8",
"events": "7d717740-b481-45b1-8469-8c21d76ffbcc",
"publishingoffices": "42fee7a8-3332-434e-bca5-aec553348f6d",
"Parts": "sample string 19",
"FolderId": "72ba42c2-ae36-4456-8aef-3ef807291402",
"ParentId": "c71e86d3-9a57-4f3b-a97f-eae2e4ae9dee"
}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-01-12T18:09:51.2592793Z",
"PublicationDate": "2026-01-12T18:09:51.2592793Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-01-12T18:09:51.2592793Z",
"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": "55d42ff9-0719-47ce-a2bd-1a1df667e416",
"targets": "47304e19-ec04-4c21-a010-0a8b0e6de27c",
"regionscountries": "18e69090-860b-41ac-926e-1f8cef27a254",
"stakeholders": "10f3cce5-cd66-44e1-ab7a-c97b6c16fbd5",
"targetaudiences": "a31e2160-9e61-429e-9b89-f378e38e3e9c",
"Category": "d6f421f7-d620-46bc-81c7-7c9497a5ab2b",
"Tags": "40816c4a-ef1a-4834-80e5-c752111480ce",
"departmentaltargets": "e9f5bf88-6c3b-4206-a529-9682cd20074d",
"events": "665426d1-1354-431d-90c4-2e4a97a13706",
"publishingoffices": "a76b152b-e693-4e65-81cb-4612ad036ebe",
"Parts": "sample string 25",
"FolderId": "73a0dde1-cef9-4bb4-80e3-f35d23c7d81a",
"ParentId": "1893d1b4-0ec9-4317-b024-2072ddd21635",
"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-01-12T18:09:51.2592793Z",
"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": "d7973942-42dd-471a-b771-9e83fbc4b0d3",
"targets": "11629127-ee68-4296-b9b7-8aed46f62b1b",
"regionscountries": "a1754a05-dd32-414c-baf9-97fa0c21ce94",
"stakeholders": "74bdac8e-906d-4b4c-bcb7-9393fd849850",
"targetaudiences": "4b561387-59d4-4ce7-b0a4-6441770eaec4",
"Category": "e2caf3fb-ab0e-4548-ae19-cd29137016fe",
"Tags": "42aa15cd-ae91-4f0f-80d8-2e9e06952ef9",
"departmentaltargets": "ed2ac278-c7af-43b2-91f5-06d70a7192a9",
"events": "9808bac2-f01d-40d4-a3b4-b9d059015b52",
"publishingoffices": "30ac013f-5993-40d0-a04a-7e71dbdee991",
"Parts": "sample string 19",
"FolderId": "64af1619-47a3-4d85-ab7f-785b89b1e909",
"ParentId": "5bb25fdc-ce87-4dc1-9029-e2717c3d5acb"
}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-01-12T18:09:51.2592793Z",
"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": "70763bf0-dd5c-4176-9156-9868595f21ce",
"targets": "1795386c-943e-4a4a-b4c3-d8be7ca94357",
"regionscountries": "c0d25750-48f0-44a1-9942-e4f138ecd6e2",
"stakeholders": "af9ae319-1926-4158-8f2f-e2407f9f25f1",
"targetaudiences": "6ba35dd3-189c-4069-9083-7047e8bf9ddf",
"Category": "c1f51032-31bf-4681-a233-0fd002d0aa6f",
"Tags": "f1b4f2de-c82f-4719-8bc4-b6728a53db2d",
"departmentaltargets": "23aab431-2411-44b1-87fe-9f1f7484b19a",
"events": "c1b603bc-b0b8-4d1e-ad0a-ad0307f84a4f",
"publishingoffices": "55ada663-406e-40c8-b6fa-8071bf740442",
"Parts": "sample string 19",
"FolderId": "3014ba5c-5055-41fc-8063-dc4650067b45",
"ParentId": "61b30300-2d34-468f-9d18-e34f58bc4ecc"
}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.