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-13T15:20:49.3121528Z",
"PublicationDate": "2026-01-13T15:20:49.3121528Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-01-13T15:20:49.3121528Z",
"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": "d2128cfa-2ae3-4823-9c40-1765750adb52",
"targets": "cdc33de5-3e41-43ea-8804-023360b5a98a",
"regionscountries": "2f959c8d-3121-4f89-b67e-00b112c69cae",
"stakeholders": "17aad601-f013-43aa-8ebd-7c949ffd51d8",
"targetaudiences": "032f9628-f527-4eb7-bc3c-087ead0bbec7",
"Category": "80bf084d-ff65-49fc-97f7-f1f51f1657ba",
"Tags": "feff462c-79c7-45f7-b1e2-9b9b369c6164",
"departmentaltargets": "b0a4ee18-0567-4164-a881-019b23d50834",
"events": "1ed2446b-3326-4939-8748-6441621ce891",
"publishingoffices": "138f0e19-c556-4dcb-8387-963f6b7d0930",
"Parts": "sample string 25",
"FolderId": "2f424cdb-75ca-46fe-882d-006408641abd",
"ParentId": "68b93094-d2b2-4f9a-912f-0e2596afb18d",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"IsDamMedia": true
},
{
"LastModified": "2026-01-13T15:20:49.3121528Z",
"PublicationDate": "2026-01-13T15:20:49.3121528Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-01-13T15:20:49.3121528Z",
"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": "d2128cfa-2ae3-4823-9c40-1765750adb52",
"targets": "cdc33de5-3e41-43ea-8804-023360b5a98a",
"regionscountries": "2f959c8d-3121-4f89-b67e-00b112c69cae",
"stakeholders": "17aad601-f013-43aa-8ebd-7c949ffd51d8",
"targetaudiences": "032f9628-f527-4eb7-bc3c-087ead0bbec7",
"Category": "80bf084d-ff65-49fc-97f7-f1f51f1657ba",
"Tags": "feff462c-79c7-45f7-b1e2-9b9b369c6164",
"departmentaltargets": "b0a4ee18-0567-4164-a881-019b23d50834",
"events": "1ed2446b-3326-4939-8748-6441621ce891",
"publishingoffices": "138f0e19-c556-4dcb-8387-963f6b7d0930",
"Parts": "sample string 25",
"FolderId": "2f424cdb-75ca-46fe-882d-006408641abd",
"ParentId": "68b93094-d2b2-4f9a-912f-0e2596afb18d",
"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-13T15:20:49.3121528Z",
"PublicationDate": "2026-01-13T15:20:49.3121528Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-01-13T15:20:49.3121528Z",
"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": "792b6771-f1bd-481f-9285-d236f2c79933",
"targets": "7633cc5f-2865-4573-85aa-65bb3e9fb15b",
"regionscountries": "6e15ceed-bb59-4591-99aa-d0ff27e16f9a",
"stakeholders": "ec39b01f-8a24-4b33-95e2-bbbb000fcb2d",
"targetaudiences": "c7106527-0916-4170-8370-b7b272e9a010",
"Category": "dbfb2eda-fcb8-4626-980c-fe60f6d82650",
"Tags": "f118f33a-f614-42d9-8160-9b9ca044388a",
"departmentaltargets": "65d748b0-01d6-4dbc-8c1f-47f2261ce39f",
"events": "ac05d7e4-1d03-4aea-9244-29f3b2e7ca4c",
"publishingoffices": "84b21219-8778-4218-a4d1-f27d1ec9f4a0",
"Parts": "sample string 25",
"FolderId": "cec41f8b-b8a4-49ba-9bc2-60cbdce09b0a",
"ParentId": "f4befdf8-8672-4b77-8862-e74f3b9270b7",
"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": "9b6423ca-971d-4e47-9be2-f9399692197f"
}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-13T15:20:49.3121528Z",
"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": "7df305cc-f64f-4aff-a315-695bb2d270ed",
"targets": "f851cdfa-3053-4d1f-852b-c2b931ad7830",
"regionscountries": "04e9197f-444c-4d71-840f-da9395a91ea9",
"stakeholders": "9902bb35-bb9f-4421-a95e-b0e9850fa34b",
"targetaudiences": "e846073a-0f79-4c75-b45c-1c67858a5d4b",
"Category": "0d45540d-4635-46f4-8a83-6f6dd972d455",
"Tags": "cdeaf1b2-d9f4-4076-b748-f7818706048c",
"departmentaltargets": "5a3b273c-b6df-4db3-9334-a6892e4b8a4c",
"events": "55488858-7607-4522-92ae-0c3809087871",
"publishingoffices": "f7795ceb-7715-45ba-bb10-19c023c4c86f",
"Parts": "sample string 19",
"FolderId": "d5c5ea01-8c8c-44b8-b8e6-621ca45f1ec3",
"ParentId": "4ca972fe-2e07-4764-ae26-9d1aeee0ccf5"
}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-13T15:20:49.3121528Z",
"PublicationDate": "2026-01-13T15:20:49.3121528Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-01-13T15:20:49.3121528Z",
"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": "681190c1-aa1c-4cb7-bb39-aca801194cfa",
"targets": "3f752d88-914b-49de-882b-52c38edcea38",
"regionscountries": "6ef72aca-1790-4f6d-bcdc-76ccf520f098",
"stakeholders": "eb439340-a430-4074-a7bb-92f593ca7d4a",
"targetaudiences": "76b2ed9b-d363-496f-a9eb-9a1006dcd947",
"Category": "1850e3e0-1a8a-4fb0-8ba3-ab4619b15531",
"Tags": "281e2981-e94b-412c-a081-a90c8732a623",
"departmentaltargets": "2d68a924-5d9c-4711-858e-e1655a9962bb",
"events": "052573e9-914f-41d5-902e-b9471ddf21d0",
"publishingoffices": "2ff2d881-89cf-4bdb-8a49-3257e3dc0893",
"Parts": "sample string 25",
"FolderId": "65114ecc-855d-4320-a3dc-9e9ac0932a1f",
"ParentId": "f48172be-6174-4634-ad14-c10bb508ba77",
"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-13T15:20:49.3121528Z",
"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": "04c6cd4b-25ed-4227-aa7c-fc109e151743",
"targets": "60082d5e-54f0-4a30-9e7c-fc2af9b507af",
"regionscountries": "f8e9bb7a-6847-43c4-9a8d-71f13adae94a",
"stakeholders": "400975d2-93c1-46a9-81da-54d77a34940b",
"targetaudiences": "1189c93c-9bb3-42fc-a444-ce001f549c33",
"Category": "e2bfa2bc-53a8-4a31-8b8d-12c80e3a6a62",
"Tags": "d20471f0-b37b-43eb-ab0b-83a921c44bd1",
"departmentaltargets": "610431bf-4aaf-4880-ae73-7cf32f3ab011",
"events": "a6a3bc20-0f9d-437e-9c4c-29b610537d59",
"publishingoffices": "d6e33ff1-e8bc-41f2-b22b-469d99ae3fb4",
"Parts": "sample string 19",
"FolderId": "8cfd37d2-0148-465b-a352-66e7c5ac9d10",
"ParentId": "2b3dbfe0-9936-46ad-be2d-c2340d3302b9"
}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-13T15:20:49.3121528Z",
"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": "7d93415d-c8c6-4d05-80bb-723db554a49b",
"targets": "f863c0ad-5a33-461f-8de7-07794b17fd27",
"regionscountries": "cb89516a-e60d-4f14-956d-18de75b901f0",
"stakeholders": "3c1d33b0-55a2-4e92-8626-5ac7ada8c87c",
"targetaudiences": "1c309270-039c-464b-b97b-189fe3338dc0",
"Category": "481176bb-2a16-4771-a10e-eb17210a179b",
"Tags": "a3e062a2-de25-467a-9324-835a7af8023e",
"departmentaltargets": "df77c179-9a75-4e0d-b81f-b609af8824d4",
"events": "5227c184-3090-42c9-8242-9d4c45d93400",
"publishingoffices": "0bdd1534-23e0-4eb8-b196-6a5a9cac9d02",
"Parts": "sample string 19",
"FolderId": "ed3bdeff-a2a4-4a57-b299-f6553a43e6fa",
"ParentId": "dcf52de0-5c73-43d3-95ff-e0a49c108a6c"
}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.