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": "2025-10-27T00:37:37.4126311Z",
"PublicationDate": "2025-10-27T00:37:37.4126311Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-10-27T00:37:37.4126311Z",
"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": "72956dfe-6383-4307-ab97-5ee96ac8ef50",
"targets": "174c24c2-4afd-4452-9e93-6e3a056e5c30",
"regionscountries": "95fb82cd-c462-47b7-ae17-57d7c4bce52c",
"stakeholders": "00ab7302-52e1-414e-9b4f-eef68034b937",
"targetaudiences": "9bdc3c1f-2b45-45d8-acd0-0b01b17ed016",
"Category": "08cdd762-8715-4f5b-a5ec-0139dd8d5c94",
"Tags": "16c2f2b7-bdd6-4882-87fc-7409721ae1a4",
"departmentaltargets": "aae1d0fb-b0bc-49da-807c-6497fd1f90da",
"events": "c3ee9e1c-5c4e-4104-aafd-47e2852003aa",
"publishingoffices": "9b48d5c5-96aa-4d5f-8524-7df96d3a2924",
"Parts": "sample string 25",
"FolderId": "d3dafc5f-b3de-4638-9a71-46541419a1e7",
"ParentId": "18843ab5-19ab-4a85-acf1-43fb2ca22b28",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"IsDamMedia": true
},
{
"LastModified": "2025-10-27T00:37:37.4126311Z",
"PublicationDate": "2025-10-27T00:37:37.4126311Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-10-27T00:37:37.4126311Z",
"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": "72956dfe-6383-4307-ab97-5ee96ac8ef50",
"targets": "174c24c2-4afd-4452-9e93-6e3a056e5c30",
"regionscountries": "95fb82cd-c462-47b7-ae17-57d7c4bce52c",
"stakeholders": "00ab7302-52e1-414e-9b4f-eef68034b937",
"targetaudiences": "9bdc3c1f-2b45-45d8-acd0-0b01b17ed016",
"Category": "08cdd762-8715-4f5b-a5ec-0139dd8d5c94",
"Tags": "16c2f2b7-bdd6-4882-87fc-7409721ae1a4",
"departmentaltargets": "aae1d0fb-b0bc-49da-807c-6497fd1f90da",
"events": "c3ee9e1c-5c4e-4104-aafd-47e2852003aa",
"publishingoffices": "9b48d5c5-96aa-4d5f-8524-7df96d3a2924",
"Parts": "sample string 25",
"FolderId": "d3dafc5f-b3de-4638-9a71-46541419a1e7",
"ParentId": "18843ab5-19ab-4a85-acf1-43fb2ca22b28",
"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": "2025-10-27T00:37:37.4126311Z",
"PublicationDate": "2025-10-27T00:37:37.4126311Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-10-27T00:37:37.4126311Z",
"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": "ea7f0eb9-8140-4ee1-990e-cd493217e32c",
"targets": "407c0860-11e5-483b-b363-22e1b0709935",
"regionscountries": "502e687c-5e9f-47c8-9a72-1035b4ea9621",
"stakeholders": "d3cc1977-94d5-4ad7-bd5c-165f3424cf7b",
"targetaudiences": "892b183c-563d-46b7-9616-999ce8e027f1",
"Category": "0d84ff2b-7a32-450f-adfb-89600b8a30b1",
"Tags": "a38daa80-097f-476e-8bc9-05df31aff112",
"departmentaltargets": "015bd553-efbc-464c-84a8-9b5197832f3d",
"events": "cbc44e55-f761-492e-996c-ed7e803c0a78",
"publishingoffices": "586a5468-1ad8-4124-a878-cc2d37389c33",
"Parts": "sample string 25",
"FolderId": "4e7653c1-68b8-456d-9c53-8c0fd05ea9ed",
"ParentId": "326ed37e-3f1a-4d65-a3c1-3c124585a7b0",
"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": "8d6cf1a6-2d97-44b4-9e51-8d50f04728f1"
}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": "2025-10-27T00:37:37.4126311Z",
"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": "6c5665ff-24fe-4e5a-84c1-9a6fece56cbc",
"targets": "edd7d944-8a1a-4cca-93c1-b17f920e5626",
"regionscountries": "0caa7c4d-9ca0-43f6-867c-8d00aa33b38a",
"stakeholders": "0f1597ca-cd02-401f-8b9b-f6b09de77ca5",
"targetaudiences": "71b05f13-d64f-4f9e-ae23-cb983bc617f4",
"Category": "a1c69e86-b188-49aa-84d5-95ad9faeee36",
"Tags": "d1c097ed-3707-46a5-86c6-22a6fdb096b3",
"departmentaltargets": "6eeca3bd-fa4b-4023-a9b1-24db3ea927bc",
"events": "fb0eb629-5f27-479d-acd5-ffe36fe4f1dc",
"publishingoffices": "8d7dffe0-1a0a-4a20-a8c7-7c9da5bb2980",
"Parts": "sample string 19",
"FolderId": "e892b45a-a4d3-433b-8868-3e8dc454e3f4",
"ParentId": "85783a8c-68cc-450a-a559-e7d982bd1d69"
}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": "2025-10-27T00:37:37.4126311Z",
"PublicationDate": "2025-10-27T00:37:37.4126311Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-10-27T00:37:37.4126311Z",
"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": "48d53106-fb3c-41f8-89a7-4eef228d721b",
"targets": "74d6c86e-5e89-4f58-8ece-0f27b1284108",
"regionscountries": "239c48cc-9451-4bdc-87e2-5d450d2c7954",
"stakeholders": "4efbb945-6ea9-4567-9d33-187b22faa575",
"targetaudiences": "aeff6dfc-ff07-4ea8-a8e9-231214c4182d",
"Category": "296758d6-d8c4-45dd-991c-46bad2dc0d36",
"Tags": "072f1949-e8c1-4aab-8860-6be49f96e10d",
"departmentaltargets": "f399a14c-b413-4eb0-862d-137e20c0b609",
"events": "9aa696ca-7000-4efa-bb3c-1e1779b4c17d",
"publishingoffices": "05cfb744-0b47-48dc-af4f-fb508beab253",
"Parts": "sample string 25",
"FolderId": "afea08ce-3a7d-43c2-81c0-f8d1454639b2",
"ParentId": "8ede3c44-96dd-47e0-919d-900d32e127ea",
"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": "2025-10-27T00:37:37.4126311Z",
"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": "a5e98d95-960c-465e-85be-8c9d8609ffff",
"targets": "8e544aa7-0a3f-4e52-9070-169ff88ca417",
"regionscountries": "9359c0d4-7293-400e-b13c-2268e1a658ed",
"stakeholders": "9a9ce866-d712-43e2-ae80-3ca6c76a0560",
"targetaudiences": "1f9eb7d7-86a2-42ee-a264-9ff5fcacf800",
"Category": "1ff35b27-7081-4b9d-bcf5-c84b173b5d49",
"Tags": "7b1c20f1-9833-467c-8a2c-aa8859332323",
"departmentaltargets": "b5ae1406-ff26-4f0a-8f28-46d7c4ff8400",
"events": "5d5ffa44-4a94-4465-8cfd-189cd4f29530",
"publishingoffices": "0bbaa19f-e240-44ba-a5da-8607948827ac",
"Parts": "sample string 19",
"FolderId": "f7a0bc5d-1500-48f6-83c8-9ee15302736c",
"ParentId": "6437ee7c-d75e-4d75-853c-1555397bb29d"
}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": "2025-10-27T00:37:37.4126311Z",
"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": "785170dc-5523-479b-8ac7-d85c5c3fd3d5",
"targets": "b7825328-28de-4485-a4c5-78bd84de4273",
"regionscountries": "9622e919-2dd7-4320-93b1-d85b613102e5",
"stakeholders": "1a564df9-47d0-4038-9b28-1b94769f89dc",
"targetaudiences": "46970ab2-ef02-4cef-b5fa-4a558352b3ec",
"Category": "5db8ef62-b349-45d5-a660-36844f295756",
"Tags": "ec6c5199-3caa-4cbc-8b4e-c520f2641b4a",
"departmentaltargets": "d5d6ed76-3037-47c0-8ca2-9c4a47f23ab1",
"events": "67660b83-9809-4c99-8203-f77670357080",
"publishingoffices": "fafc145a-727e-4916-aa29-950d788cb792",
"Parts": "sample string 19",
"FolderId": "86bddd43-fe3d-4ad6-aa99-d7df12c8c670",
"ParentId": "16447c2a-0530-488e-a9a9-7373df32434a"
}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.