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-06T16:57:18.1650001Z",
"PublicationDate": "2025-10-06T16:57:18.1650001Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-10-06T16:57:18.1650001Z",
"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": "65e01bcf-8a73-4d8d-b389-028a40373cd8",
"targets": "a5383c9a-2632-44a4-b48f-a9c5caa6b087",
"regionscountries": "70c7f830-848e-4651-992f-70cc92b6a903",
"stakeholders": "1eadaefe-7f56-4b77-bc43-900fe922701f",
"targetaudiences": "5c7854fb-8f1a-4355-a90e-9362e81406c0",
"Category": "592b3396-4aaa-4938-80a3-e317382b28af",
"Tags": "d9c1568a-5e60-4e91-8080-145423a161ab",
"departmentaltargets": "ad68bf49-73fb-4cb0-bc6d-3e9dcc1439f2",
"events": "ea48ed68-b6bb-4869-bc1a-872c44d45a05",
"publishingoffices": "286ced4a-df9a-4a9a-a9a7-48a5fda1142e",
"Parts": "sample string 25",
"FolderId": "8b214a60-9e45-4c5b-bc14-5ecfece1dcca",
"ParentId": "de964680-38ab-4d01-87f0-ec05110c0a73",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"IsDamMedia": true
},
{
"LastModified": "2025-10-06T16:57:18.1650001Z",
"PublicationDate": "2025-10-06T16:57:18.1650001Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-10-06T16:57:18.1650001Z",
"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": "65e01bcf-8a73-4d8d-b389-028a40373cd8",
"targets": "a5383c9a-2632-44a4-b48f-a9c5caa6b087",
"regionscountries": "70c7f830-848e-4651-992f-70cc92b6a903",
"stakeholders": "1eadaefe-7f56-4b77-bc43-900fe922701f",
"targetaudiences": "5c7854fb-8f1a-4355-a90e-9362e81406c0",
"Category": "592b3396-4aaa-4938-80a3-e317382b28af",
"Tags": "d9c1568a-5e60-4e91-8080-145423a161ab",
"departmentaltargets": "ad68bf49-73fb-4cb0-bc6d-3e9dcc1439f2",
"events": "ea48ed68-b6bb-4869-bc1a-872c44d45a05",
"publishingoffices": "286ced4a-df9a-4a9a-a9a7-48a5fda1142e",
"Parts": "sample string 25",
"FolderId": "8b214a60-9e45-4c5b-bc14-5ecfece1dcca",
"ParentId": "de964680-38ab-4d01-87f0-ec05110c0a73",
"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-06T16:57:18.1650001Z",
"PublicationDate": "2025-10-06T16:57:18.1650001Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-10-06T16:57:18.1650001Z",
"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": "de2f3638-e7fc-4833-a998-b13e793c090f",
"targets": "0a80e3d9-179d-488d-bfcd-4051f30701d5",
"regionscountries": "8a0b90ab-5ee3-4952-a50a-d600924bcb69",
"stakeholders": "10a3b17b-f080-42f5-ae93-7048ce9eb532",
"targetaudiences": "3511b9a4-b84d-437d-a1dd-d70344a64766",
"Category": "e35a0683-7df4-4d98-a20e-8655b1faffe0",
"Tags": "c523fbcb-bfac-4109-9944-0847e6fb0b5b",
"departmentaltargets": "20e19374-e509-40e8-96c5-f15e6a292987",
"events": "d36d9ab6-a2ee-418b-a803-7f6c89102b51",
"publishingoffices": "4840774c-7de7-4346-81a7-edca6b6ba39e",
"Parts": "sample string 25",
"FolderId": "8a9e6bbc-1065-4bf0-9f8a-e6704e5d0431",
"ParentId": "cb2d9be5-472b-4a94-b099-d54e4b48de94",
"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": "8c5a08da-5f43-43a1-a10b-ced767c2d246"
}
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-06T16:57:18.1650001Z",
"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": "d113af85-b717-48e9-ae9b-1ae36b2a895e",
"targets": "d6cd0091-0abb-4d4a-8a6c-4b257f9f201c",
"regionscountries": "5ca57490-8224-450b-9601-00475e5112bd",
"stakeholders": "10fede41-99f3-49f5-86ba-3cc910560d1c",
"targetaudiences": "c89750ed-566a-4e7b-9bf6-c2debbd1d89b",
"Category": "eaa763eb-3871-4d8d-97b6-0b20c25240f5",
"Tags": "9aa5e0ee-31a3-479a-ae29-00e48e17ca16",
"departmentaltargets": "0f52d530-88f5-4795-8eac-36b734760ea5",
"events": "7160ea89-35e9-401a-ac4b-36fe3895ac9c",
"publishingoffices": "d066be1a-04f5-4ea2-8bb9-fb160a57a281",
"Parts": "sample string 19",
"FolderId": "61ab4ed1-1631-4144-a83f-2d89f61dd3da",
"ParentId": "08771be5-3155-4c74-9586-f67a2568f8c7"
}
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-06T16:57:18.1650001Z",
"PublicationDate": "2025-10-06T16:57:18.1650001Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-10-06T16:57:18.1650001Z",
"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": "4615b03e-3912-43c3-8d90-f7a802f90598",
"targets": "450dec86-c719-474d-8686-2901d160e6a6",
"regionscountries": "2034eeaf-06c3-4f5a-9527-a62958f46557",
"stakeholders": "055ab919-3f08-4a0b-9688-3f83b9670179",
"targetaudiences": "1194e84b-2154-4ee4-ab16-e7dcf419e7ef",
"Category": "b46a09dd-ee5a-4033-8c46-5879b4225fde",
"Tags": "393a7d55-f087-4fc4-96fe-c0b560f0e4ac",
"departmentaltargets": "8d47fcdc-195b-494e-b771-a8600666416f",
"events": "07e99256-1b16-4227-b7ce-284f8f118fb1",
"publishingoffices": "5f23912a-5c5e-482b-8e77-d169b23d1cbe",
"Parts": "sample string 25",
"FolderId": "c24b0ec9-cae7-4a58-83d3-ef49320767d5",
"ParentId": "030d4fc1-1b7a-4fe6-aacc-579507e7600d",
"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-06T16:57:18.1650001Z",
"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": "dffa2957-9ac6-450b-b4bd-34d0af239eb8",
"targets": "6445b5f3-0101-4fe8-a2e0-64edf8d9e6ac",
"regionscountries": "d3c7549d-e26f-4ea9-ab75-033e4c4f9e91",
"stakeholders": "5e3411cd-fe28-4822-a0d0-3b7e48e2938b",
"targetaudiences": "fb198473-9e05-401a-8161-a0fdfd2c1cb1",
"Category": "e422f2af-2f4e-4f3d-8b2a-c4a0be0cb371",
"Tags": "64577126-0943-4ae7-856b-edb13c5e7a1e",
"departmentaltargets": "f4416d24-7aef-443b-8233-bb5f62401b58",
"events": "481b8d03-e7eb-46be-8f1b-3a2ec99cc684",
"publishingoffices": "2ad0ce2e-bc01-4b91-99a8-20fc6b9a6ede",
"Parts": "sample string 19",
"FolderId": "2bcd97fc-03c3-419f-aabb-88aec2013293",
"ParentId": "ba79f3d4-5e1b-402a-b555-9b25f12cbc6a"
}
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-06T16:57:18.1650001Z",
"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": "40c500a1-00bc-44a9-b288-abf89ac74afc",
"targets": "0ff5eb2e-8cfc-4a32-bc73-f7eecf9af423",
"regionscountries": "b09ce2ab-b169-4547-af30-a58b071d8514",
"stakeholders": "953f685c-6ff2-4df3-9650-0c0aea8cb98b",
"targetaudiences": "3197a647-13a2-4b0b-9816-adc3a62948a9",
"Category": "b5b82010-44ca-4984-8307-d8a6e1cbb507",
"Tags": "77884cce-5519-40e2-a49b-9e30836ac504",
"departmentaltargets": "f52a50f2-92bb-4e92-a81d-c60a4e47cbcd",
"events": "8c1692fc-b26e-4eb4-87a0-7544d4830611",
"publishingoffices": "a5349315-3416-414f-a256-16a8a61b48ea",
"Parts": "sample string 19",
"FolderId": "496b8421-7c61-4009-8052-f2f3ef6c8f98",
"ParentId": "ec623073-86d6-4aa5-95df-dc413a3d31aa"
}
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.