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-27T04:05:29.5239336Z",
"PublicationDate": "2025-10-27T04:05:29.5239336Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-10-27T04:05:29.5239336Z",
"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": "df014fc4-959c-4e62-826b-54b3075e0276",
"targets": "84fb8ff2-68ce-455a-a05a-1b4274af8d74",
"regionscountries": "ef530f3b-9323-4f55-b6cc-f23af05befe4",
"stakeholders": "7f49eb74-dcb0-4961-ba1e-86e4311a109a",
"targetaudiences": "16cc5a9c-8db4-45d0-8b29-7b4eff2b4bc9",
"Category": "b490c7ff-262a-467d-a3bd-e3e592662795",
"Tags": "9f8382b2-6bd3-4c5a-a6ec-24893d5e263e",
"departmentaltargets": "511e30a5-fd68-4fb7-af0c-aea52612d32b",
"events": "06440d8f-6f74-4268-89c0-40b88c3040e5",
"publishingoffices": "58549666-fa27-4931-ad96-4ac755407f12",
"Parts": "sample string 25",
"FolderId": "a01f44ef-d4ee-486a-bf57-47fdf343c12c",
"ParentId": "1d585920-ccc4-49de-b568-d3c81ba173d7",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"IsDamMedia": true
},
{
"LastModified": "2025-10-27T04:05:29.5239336Z",
"PublicationDate": "2025-10-27T04:05:29.5239336Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-10-27T04:05:29.5239336Z",
"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": "df014fc4-959c-4e62-826b-54b3075e0276",
"targets": "84fb8ff2-68ce-455a-a05a-1b4274af8d74",
"regionscountries": "ef530f3b-9323-4f55-b6cc-f23af05befe4",
"stakeholders": "7f49eb74-dcb0-4961-ba1e-86e4311a109a",
"targetaudiences": "16cc5a9c-8db4-45d0-8b29-7b4eff2b4bc9",
"Category": "b490c7ff-262a-467d-a3bd-e3e592662795",
"Tags": "9f8382b2-6bd3-4c5a-a6ec-24893d5e263e",
"departmentaltargets": "511e30a5-fd68-4fb7-af0c-aea52612d32b",
"events": "06440d8f-6f74-4268-89c0-40b88c3040e5",
"publishingoffices": "58549666-fa27-4931-ad96-4ac755407f12",
"Parts": "sample string 25",
"FolderId": "a01f44ef-d4ee-486a-bf57-47fdf343c12c",
"ParentId": "1d585920-ccc4-49de-b568-d3c81ba173d7",
"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-27T04:05:29.5239336Z",
"PublicationDate": "2025-10-27T04:05:29.5239336Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-10-27T04:05:29.5239336Z",
"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": "ff311944-c507-478b-b178-588d57066eaf",
"targets": "d8284d22-02fd-4d2f-a03e-0fb762ef6cd1",
"regionscountries": "c5612d33-6de8-42c3-bfe8-0c94765d98c1",
"stakeholders": "e6f88f8f-eaee-4f54-9c80-e7f611f76eb1",
"targetaudiences": "1447be01-92df-453a-8a26-ad09b72f76b2",
"Category": "f3229f29-0570-4c87-ae53-72ac76e82204",
"Tags": "0d42c4c1-24ad-4247-b3e8-f2e1c075c7f8",
"departmentaltargets": "95329a30-f4fb-43c6-aa69-f4ac5e68a872",
"events": "e75489b3-4f65-42cd-95bd-a3ccf43547c4",
"publishingoffices": "37b7a01a-9283-49ed-bac1-a69c3fa855b1",
"Parts": "sample string 25",
"FolderId": "15e38ef4-20ac-42bf-afa0-38ce5bfe8952",
"ParentId": "6f6ea4d8-0f9f-48c9-be57-1ec1de2b5775",
"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": "f34fd037-5fd0-4955-9bb6-5f787c67f4c9"
}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-27T04:05:29.5239336Z",
"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": "dd71bbfa-ba6f-4bbe-81eb-045fa9df3375",
"targets": "8db707ba-5133-49c0-9c24-13ba953df3a3",
"regionscountries": "9fad3162-3ef4-4913-aaff-492e644bd954",
"stakeholders": "d8bb149b-2c20-48db-8626-51a8e2ac7e4b",
"targetaudiences": "1eb3c783-24fd-4c34-8cfa-73efb7d0d93c",
"Category": "8a8f821b-e549-40de-a23a-9546cd3a85b6",
"Tags": "65388460-fa5f-4427-b969-75c915adff33",
"departmentaltargets": "b9957110-f5cc-4623-abdf-4a072af15a2b",
"events": "b2b87ccd-4731-400d-8c59-4ee5f2ae799e",
"publishingoffices": "1684728e-b56a-46a1-b9c0-082dc9125b0b",
"Parts": "sample string 19",
"FolderId": "a1e72864-62a0-4f57-a144-ee0e3be6adf9",
"ParentId": "1880e51b-865e-40d1-80d1-853341fe989f"
}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-27T04:05:29.5239336Z",
"PublicationDate": "2025-10-27T04:05:29.5239336Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-10-27T04:05:29.5239336Z",
"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": "b30e1ea4-d41f-4dda-93e8-a61aa441cff5",
"targets": "989d8f10-7104-4732-b640-d8d656c14f71",
"regionscountries": "51184a51-ae67-4f83-b104-5bdf936e3ce4",
"stakeholders": "0130d88c-346e-4871-9acb-979f9a7cd61a",
"targetaudiences": "9d1ef259-f3b4-4436-8fe2-9d057846cbc4",
"Category": "845a636a-e9e1-4091-95d7-77f17ed7bff5",
"Tags": "955aeb2b-92c3-4d23-98fd-99f3ef6df466",
"departmentaltargets": "e11b6070-c764-499a-b766-c6949ec07850",
"events": "b24ba5b2-6705-4a28-a0bd-13fd5c97b2b5",
"publishingoffices": "ef0966d9-68f7-4330-9389-b2f2daeb4def",
"Parts": "sample string 25",
"FolderId": "2ae7056d-4abc-4493-b51f-71ae6f5cd202",
"ParentId": "7f26fb4f-7cd7-490d-b9b0-24c7a6d14e87",
"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-27T04:05:29.5239336Z",
"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": "5522d43c-7269-4fba-ba8a-1d10c423f0b2",
"targets": "9945c2c7-fc90-4cee-b2b8-d9c43010b962",
"regionscountries": "66434adf-0cea-4f44-82f4-54d66d89681b",
"stakeholders": "7d203574-80e6-4b1f-96cd-5c2f36a886af",
"targetaudiences": "8e3b7f21-80e2-4b21-9abb-4227754f4efb",
"Category": "203722a2-2e68-417f-a3c9-8eaca9be5a98",
"Tags": "c3f962d2-1255-48b8-b4a5-32070e07f122",
"departmentaltargets": "2635ad27-18c1-4e7a-b32f-288d78d15c05",
"events": "0ca9e1a3-f7a0-40c7-adc4-d8317b669061",
"publishingoffices": "3d6be3da-a13f-4bcf-abbb-9e11c6f9dcd1",
"Parts": "sample string 19",
"FolderId": "95eebc34-0cfb-49d2-acec-933939e03729",
"ParentId": "92e8847a-7ad1-421e-a419-ee88cb37f0aa"
}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-27T04:05:29.5239336Z",
"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": "516938ec-40e4-4670-b3dc-80753da738dc",
"targets": "7c3194a5-5475-41c7-a155-9e34fa4f389a",
"regionscountries": "b5b04465-1686-468e-bc85-d09f0966bb77",
"stakeholders": "a198bacf-a07c-4cc0-9f0e-1c43e30bfafb",
"targetaudiences": "9a232607-54f2-4b92-bf0e-e2cdf35ed624",
"Category": "b5aaa49b-df33-47af-a79d-e50a23280638",
"Tags": "5a6d1117-f7df-49a9-87a0-5cc950ef305c",
"departmentaltargets": "53ca7d39-f26c-4d59-b3e9-196795f90a9e",
"events": "b712ae20-dc43-4bfd-bc7d-de1d28089bb9",
"publishingoffices": "c436eff2-c4aa-44a2-ba28-e55de4ad9ec0",
"Parts": "sample string 19",
"FolderId": "785d4df9-378c-45c8-ab87-ddb3298b04be",
"ParentId": "0a0f59a8-6983-4a30-be36-adb7537069e7"
}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.