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-07T14:21:09.9944529Z",
"PublicationDate": "2026-02-07T14:21:09.9944529Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-02-07T14:21:09.9944529Z",
"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": "feeaa431-51cb-40f1-a34c-822e7ce77c0e",
"targets": "e6e1bd22-d6ab-4a64-9e1c-06eebd393cdb",
"regionscountries": "0c53debd-d550-4747-9bd5-a364519201b9",
"stakeholders": "1af5ff7e-8cc0-4db0-8155-03b494d67990",
"targetaudiences": "3cd698f2-df2d-47c2-8f73-75ee43c2de2d",
"Category": "f15a75cb-8f77-46bb-b008-cdb300d4fc98",
"Tags": "9713928d-3dbf-47e8-9a80-fac0f1499d0c",
"departmentaltargets": "50737fc9-6f3f-4496-b6a9-29d52c35232a",
"events": "d1aa4a7f-e5d2-492e-81fe-4ed5fe334001",
"publishingoffices": "39b140c0-b1b4-4a0a-a54e-df5ac9949b57",
"Parts": "sample string 25",
"FolderId": "b8659fa3-07ac-4de9-91dd-cc3c92323581",
"ParentId": "ebe46eb4-5879-41da-b5de-b744a75d0c3e",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"IsDamMedia": true
},
{
"LastModified": "2026-02-07T14:21:09.9944529Z",
"PublicationDate": "2026-02-07T14:21:09.9944529Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-02-07T14:21:09.9944529Z",
"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": "feeaa431-51cb-40f1-a34c-822e7ce77c0e",
"targets": "e6e1bd22-d6ab-4a64-9e1c-06eebd393cdb",
"regionscountries": "0c53debd-d550-4747-9bd5-a364519201b9",
"stakeholders": "1af5ff7e-8cc0-4db0-8155-03b494d67990",
"targetaudiences": "3cd698f2-df2d-47c2-8f73-75ee43c2de2d",
"Category": "f15a75cb-8f77-46bb-b008-cdb300d4fc98",
"Tags": "9713928d-3dbf-47e8-9a80-fac0f1499d0c",
"departmentaltargets": "50737fc9-6f3f-4496-b6a9-29d52c35232a",
"events": "d1aa4a7f-e5d2-492e-81fe-4ed5fe334001",
"publishingoffices": "39b140c0-b1b4-4a0a-a54e-df5ac9949b57",
"Parts": "sample string 25",
"FolderId": "b8659fa3-07ac-4de9-91dd-cc3c92323581",
"ParentId": "ebe46eb4-5879-41da-b5de-b744a75d0c3e",
"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-07T14:21:09.9944529Z",
"PublicationDate": "2026-02-07T14:21:09.9944529Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-02-07T14:21:09.9944529Z",
"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": "3ea4a78d-efdb-4598-b5ff-3122c7898c95",
"targets": "1188b5ae-f5a3-4e80-90b5-45e8ac7f98be",
"regionscountries": "6b79a9be-0d7f-488d-bbc3-f81866e061e5",
"stakeholders": "6fa4b75e-7f95-4542-8617-77ee6e815cbf",
"targetaudiences": "e3c2cd7f-16cc-4d56-981e-091511fcfd0d",
"Category": "e9e915a9-cbb6-4613-8d0d-ece16a6ca644",
"Tags": "e6f26781-2586-434f-ab9a-8f309268ec51",
"departmentaltargets": "688269c0-8ebd-4b42-9076-5cf7288cb98f",
"events": "4e0d2847-3ff5-4701-8c34-9d65531cd10a",
"publishingoffices": "5bb84b86-42a3-4a0e-8cd9-bb75baa50487",
"Parts": "sample string 25",
"FolderId": "970cd485-bb25-44be-9fe7-f59e645f0bc3",
"ParentId": "677b1c19-2dce-4f27-a3c8-d0d10270c17e",
"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": "0045d839-0990-420c-889e-82f3d187244e"
}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-07T14:21:09.9944529Z",
"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": "e074c54c-b543-4278-87dc-649dba9b08e4",
"targets": "23324891-ead1-47f8-9b2a-ddfa994d653e",
"regionscountries": "ae4f189d-d340-4f1d-8355-c8522927ffd4",
"stakeholders": "c0483860-e4d2-4e37-bbde-798613d74415",
"targetaudiences": "a9679911-86c9-48d1-b307-f88e28cf0cb0",
"Category": "d0539caf-4564-4c29-be23-52ce26681bb9",
"Tags": "d0ebe82a-7c8a-4815-8c46-43ef26dfb9f0",
"departmentaltargets": "91ade039-b75d-4db6-96b6-1f85e64a16d6",
"events": "0ede41f7-e45b-4f99-a4b7-e88644b42854",
"publishingoffices": "d25204a1-c9e6-4f52-9ade-e007fa3bc016",
"Parts": "sample string 19",
"FolderId": "6e845a15-5738-4b91-a81f-a63a78ed7a93",
"ParentId": "e20caf19-8d65-463f-9112-432c24e39552"
}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-07T14:21:09.9944529Z",
"PublicationDate": "2026-02-07T14:21:09.9944529Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-02-07T14:21:09.9944529Z",
"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": "e6b35ba5-a18b-41ca-a96d-ee3206dc39c2",
"targets": "01864e6e-cf8a-4ba9-91e5-1c1ccdb42d13",
"regionscountries": "d750f885-9555-4b4b-916f-0453e8a254ee",
"stakeholders": "8eda61a7-095a-4aac-946a-ca81fe6043c8",
"targetaudiences": "92457009-228a-43e2-93a5-dfd0f5f02c92",
"Category": "e3892e25-70fc-441c-80f8-13d1950405c4",
"Tags": "6b4692c5-0c9d-462d-8fca-3b8b81afac34",
"departmentaltargets": "f434a96b-845d-48d4-9991-07d0107262c7",
"events": "1cc378a9-c004-45f6-bedb-6820188dcf34",
"publishingoffices": "ebd54643-62c7-479a-bb94-6ed4f6500175",
"Parts": "sample string 25",
"FolderId": "e8e3ba4f-9240-4ae1-af53-1bdf7723489a",
"ParentId": "c817bb31-e371-4fca-9ee8-e7e021b94ad0",
"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-07T14:21:09.9944529Z",
"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": "cdc98ba9-8afa-40c7-bdf7-4a2eac606338",
"targets": "b12fed78-69cd-46e8-8bdc-023552bbf76f",
"regionscountries": "6b8faa20-e886-4372-a082-f2eefb6ad64f",
"stakeholders": "afaba277-9c3d-4671-aeb7-25ff78547cfb",
"targetaudiences": "dc7451c5-f248-4b1a-95b8-a1690cfb5856",
"Category": "fdfa392b-8d8a-46ee-a2ad-de0b2b8236e9",
"Tags": "26b75626-4cce-4f61-a683-09fe42401c73",
"departmentaltargets": "12ac8240-c352-4874-8b82-c57e739f4fa3",
"events": "2bef4c7a-b8f5-4d9e-95c0-137cb10a44d2",
"publishingoffices": "4e6fce4c-4150-44f9-a0bd-233797cae992",
"Parts": "sample string 19",
"FolderId": "222346f0-62e2-4458-bd63-b564f4fca9ee",
"ParentId": "3872a2c6-c957-4a52-ae71-ab8ff5227b27"
}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-07T14:21:09.9944529Z",
"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": "2a96edf4-8759-45d1-94a2-b57e465a5ddb",
"targets": "4f536bf1-37d7-4f40-91d5-c923d9a7b3b4",
"regionscountries": "7704b0f3-2a45-4855-b167-c4edef9818c7",
"stakeholders": "417f3d44-7e7f-4e3d-ac16-7d9b57ff08cd",
"targetaudiences": "c641bd23-554f-40e3-9add-f7bd41cb9182",
"Category": "2e1d51ff-b263-4b2e-bc51-39950bd6bba8",
"Tags": "85173962-ac3d-4c49-97b3-2366907d9f66",
"departmentaltargets": "1bd22680-fafe-4940-8560-28aca89d2b0c",
"events": "81eac5b5-6536-48f6-b0fe-193b19faf75d",
"publishingoffices": "77f8f65a-2702-4c06-bbf2-3014c3b103e1",
"Parts": "sample string 19",
"FolderId": "ae39589b-21c7-4fc2-925a-ead2811df576",
"ParentId": "373c12f1-a0a6-4a09-b6b7-313a8531ab35"
}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.