Returns a set of data items of type documents.
GET /api/whoreference/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-03-27T02:42:58.4701469Z",
"PublicationDate": "2026-03-27T02:42:58.4701469Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-03-27T02:42:58.4701469Z",
"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": "be157e5f-ff15-4a68-9ca4-e36adf646c94",
"targets": "3571c76a-a341-4597-9c60-8b4210b8cbce",
"regionscountries": "48ce1d34-05d8-43fc-a5f6-3bd515c72ea9",
"stakeholders": "68d78de0-a479-4bf0-af0b-f250da48a92c",
"targetaudiences": "d79a2572-ce56-446f-b747-e343cb1bbfea",
"Category": "cadeead4-b96a-4768-a90e-beaaf2047d74",
"Tags": "6174634d-40a5-4ff4-b19a-c83a6cb46d72",
"departmentaltargets": "92061bb4-6327-4133-96b3-170343eb398c",
"events": "5858796d-682e-4a0b-adbd-e985c698a5f6",
"publishingoffices": "852ead49-bb57-4e71-a442-3d6b7abb6add",
"Parts": "sample string 25",
"FolderId": "712fac45-49fa-46a4-a7db-9c45f037bf26",
"ParentId": "8db72750-d6b3-4d8c-bf86-ade8e44c0a47",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"IsDamMedia": true
},
{
"LastModified": "2026-03-27T02:42:58.4701469Z",
"PublicationDate": "2026-03-27T02:42:58.4701469Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-03-27T02:42:58.4701469Z",
"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": "be157e5f-ff15-4a68-9ca4-e36adf646c94",
"targets": "3571c76a-a341-4597-9c60-8b4210b8cbce",
"regionscountries": "48ce1d34-05d8-43fc-a5f6-3bd515c72ea9",
"stakeholders": "68d78de0-a479-4bf0-af0b-f250da48a92c",
"targetaudiences": "d79a2572-ce56-446f-b747-e343cb1bbfea",
"Category": "cadeead4-b96a-4768-a90e-beaaf2047d74",
"Tags": "6174634d-40a5-4ff4-b19a-c83a6cb46d72",
"departmentaltargets": "92061bb4-6327-4133-96b3-170343eb398c",
"events": "5858796d-682e-4a0b-adbd-e985c698a5f6",
"publishingoffices": "852ead49-bb57-4e71-a442-3d6b7abb6add",
"Parts": "sample string 25",
"FolderId": "712fac45-49fa-46a4-a7db-9c45f037bf26",
"ParentId": "8db72750-d6b3-4d8c-bf86-ade8e44c0a47",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"IsDamMedia": true
}
]Gets documents item by id.
GET /api/whoreference/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-03-27T02:42:58.4701469Z",
"PublicationDate": "2026-03-27T02:42:58.4701469Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-03-27T02:42:58.4701469Z",
"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": "913e9de6-1c41-47e2-a748-96b239e2a833",
"targets": "068e481f-a98f-4cb2-a093-47f77c52babc",
"regionscountries": "212c0868-bc8b-4647-8388-1de849e9a888",
"stakeholders": "cb5b232e-5b0f-4be9-912b-87738673e99e",
"targetaudiences": "bd05afe6-cafb-4957-9e4b-61fcfd924465",
"Category": "5b2c431e-adef-4b2d-87a3-4ac0e47e4936",
"Tags": "0bcd8cc9-ac7d-43e7-9a4a-745fdfb2b11a",
"departmentaltargets": "6394ad4d-321c-4e25-ba4d-9dbda99e3363",
"events": "ce57aab3-39f1-4f5c-a857-1e4c7032ea34",
"publishingoffices": "f3be3685-7a92-442c-8135-519e58953c96",
"Parts": "sample string 25",
"FolderId": "f45a6650-8dc2-4b74-afb4-7fc991c83247",
"ParentId": "19b31c3b-af87-44d6-9ce9-4e852934e15e",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"IsDamMedia": true
}Gets Id property from documents item.
GET /api/whoreference/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": "540a7e57-832c-46d2-8be9-adaefa56fcab"
}Creates a documents item.
POST /api/whoreference/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-03-27T02:42:58.4701469Z",
"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": "cf7c3d82-7518-4c8f-880b-04f008a7c68d",
"targets": "2aa77331-98f1-44dc-9a6e-0216cdb3d873",
"regionscountries": "68922149-1461-498c-b994-8b7b14f6e7e1",
"stakeholders": "9d5665b1-23c3-4296-b7ca-fa67414ab810",
"targetaudiences": "c7c5dbd6-680b-457d-ac27-f29148e0e69f",
"Category": "cca10bd3-08de-43f7-bf0f-275d4e09c306",
"Tags": "532187f2-b0da-4d9b-9ba1-12b793858892",
"departmentaltargets": "8fb72e8e-8f73-4742-90b6-3127e877ed07",
"events": "0f534ee3-a828-4fb3-83d1-a04d7574646b",
"publishingoffices": "570631fe-027d-48b1-a4a3-31ab734dbfc2",
"Parts": "sample string 19",
"FolderId": "80769fcb-af02-4a85-b4ae-dcea9b8a4cdd",
"ParentId": "cbd4db8c-3aa6-4b58-89f3-cdb6b9f93a43"
}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-03-27T02:42:58.4701469Z",
"PublicationDate": "2026-03-27T02:42:58.4701469Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-03-27T02:42:58.4701469Z",
"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": "dca9fa5e-ec92-40c1-b8ad-8fe958460714",
"targets": "5f66beee-f0e3-4645-af53-55a3b76cf1a4",
"regionscountries": "39bcc0f9-9fe4-40df-ab91-10da8003117c",
"stakeholders": "fda101e3-27b7-4b10-b041-486a62373a5b",
"targetaudiences": "c33f9a93-7a12-4b4f-9533-231c480a73eb",
"Category": "4d1d7485-74f5-4578-ac1f-a732eb085ea8",
"Tags": "113e7300-76e6-4139-bc34-236a5304396e",
"departmentaltargets": "e7e000b0-2bfa-45a5-899c-cd7cb11853d5",
"events": "751bbf24-be3a-4be5-a745-e3dc521228fc",
"publishingoffices": "52c17f1c-819f-47b7-8d72-f5c2d578341a",
"Parts": "sample string 25",
"FolderId": "6bc1d438-1d2f-47d7-b41d-d18cc6da3482",
"ParentId": "4e085f60-661f-4a0c-b885-a28988f341e3",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"IsDamMedia": true
}Partial update for documents item.
PATCH /api/whoreference/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-03-27T02:42:58.4701469Z",
"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": "bb0f2f6b-804c-4c2e-8ce5-b7ad816960d0",
"targets": "418d4441-b650-429e-bddf-ab489c4bab48",
"regionscountries": "d726f17e-6ed6-4530-ae08-39e746b62547",
"stakeholders": "ee5170d4-a1a0-42fa-91ef-6441cb85f7a2",
"targetaudiences": "d4595a23-a209-4631-855f-0646b30085da",
"Category": "65fce19e-88d3-4d02-bb68-0f4db5ec2f97",
"Tags": "a1aa1a2f-630d-41c7-9861-dfebe15c4b4d",
"departmentaltargets": "9a12ef8a-65bd-46cd-905f-17ad7ab3b3be",
"events": "fd8e8e9f-ea69-43d2-97da-bda64b359d32",
"publishingoffices": "ffcf761f-f1df-495f-9224-22ccb8c10e2d",
"Parts": "sample string 19",
"FolderId": "23389aa2-6ac1-45f0-824f-c0b95114140b",
"ParentId": "3ba9f9e9-c070-41e7-b161-47660f2742dd"
}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/whoreference/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-03-27T02:42:58.4701469Z",
"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": "a41e962d-aef4-4961-a2fa-1263fcadb6b5",
"targets": "ea49160a-2015-4d1f-ba05-37ea3b603d6c",
"regionscountries": "4b20d65d-4a41-4b5d-8e0d-f8750adc5937",
"stakeholders": "41fed008-4aac-48ee-80b7-b6fc7f92973b",
"targetaudiences": "bfa236b9-eb3e-4734-a17e-85dc296c7405",
"Category": "a742d55f-64f3-4bdb-bf1e-ac59b99b1b25",
"Tags": "48e1db3f-2095-459e-b576-0d1185d802bc",
"departmentaltargets": "c61c7620-3b82-46d7-882a-ee92297296c6",
"events": "eedcbb1d-a656-4b90-ba93-75293e909c67",
"publishingoffices": "1ef4558d-905d-450f-be40-98995cc00e3b",
"Parts": "sample string 19",
"FolderId": "1b9dcc01-6ad8-4560-ba89-d43532b5d4d2",
"ParentId": "ccd1d6c7-c2a6-41d9-b4c9-35c978498524"
}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/whoreference/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.