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 | |
| EmbedUrl | 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-11-21T14:07:17.7677267Z",
"PublicationDate": "2026-11-21T14:07:17.7677267Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-11-21T14:07:17.7677267Z",
"IncludeInSitemap": true,
"SystemSourceKey": "sample string 7",
"Ordinal": 8.1,
"UrlName": "sample string 9",
"ItemDefaultUrl": "sample string 10",
"EmbedUrl": "sample string 11",
"Author": "sample string 12",
"Extension": "sample string 13",
"MimeType": "sample string 14",
"TotalSize": 15,
"healthtopics": "8c56f30b-7554-4598-a1b5-c271c69ab8a3",
"targets": "6f16b8ac-d714-4785-ab29-99852530addc",
"regionscountries": "d6d37d74-4918-4b87-a7f9-726907538679",
"stakeholders": "64a14165-729a-4a94-86b3-70315d1cd83b",
"targetaudiences": "68ce18b5-56b3-47b0-9f98-d3bccfbfd9ca",
"Category": "6c68d534-307e-4f10-8fe3-aca0ca5c4167",
"Tags": "48db37f2-f0eb-43de-bc78-9db88d959755",
"departmentaltargets": "8662fbfa-1894-48a9-a8b8-979cd40556e5",
"events": "dbd77764-2063-4801-b10d-cd57a5337f61",
"publishingoffices": "fb812036-0e3f-4057-bf09-2308b9441949",
"Parts": "sample string 26",
"FolderId": "dd9973ce-6265-4c9c-82cc-e5a6a82b4237",
"ParentId": "b858bc1e-f564-43b4-ab1a-06fc7bd34912",
"Provider": "sample string 29",
"Url": "sample string 30",
"ThumbnailUrl": "sample string 31",
"IsDamMedia": true
},
{
"LastModified": "2026-11-21T14:07:17.7677267Z",
"PublicationDate": "2026-11-21T14:07:17.7677267Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-11-21T14:07:17.7677267Z",
"IncludeInSitemap": true,
"SystemSourceKey": "sample string 7",
"Ordinal": 8.1,
"UrlName": "sample string 9",
"ItemDefaultUrl": "sample string 10",
"EmbedUrl": "sample string 11",
"Author": "sample string 12",
"Extension": "sample string 13",
"MimeType": "sample string 14",
"TotalSize": 15,
"healthtopics": "8c56f30b-7554-4598-a1b5-c271c69ab8a3",
"targets": "6f16b8ac-d714-4785-ab29-99852530addc",
"regionscountries": "d6d37d74-4918-4b87-a7f9-726907538679",
"stakeholders": "64a14165-729a-4a94-86b3-70315d1cd83b",
"targetaudiences": "68ce18b5-56b3-47b0-9f98-d3bccfbfd9ca",
"Category": "6c68d534-307e-4f10-8fe3-aca0ca5c4167",
"Tags": "48db37f2-f0eb-43de-bc78-9db88d959755",
"departmentaltargets": "8662fbfa-1894-48a9-a8b8-979cd40556e5",
"events": "dbd77764-2063-4801-b10d-cd57a5337f61",
"publishingoffices": "fb812036-0e3f-4057-bf09-2308b9441949",
"Parts": "sample string 26",
"FolderId": "dd9973ce-6265-4c9c-82cc-e5a6a82b4237",
"ParentId": "b858bc1e-f564-43b4-ab1a-06fc7bd34912",
"Provider": "sample string 29",
"Url": "sample string 30",
"ThumbnailUrl": "sample string 31",
"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 | |
| EmbedUrl | 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-11-21T14:07:17.7677267Z",
"PublicationDate": "2026-11-21T14:07:17.7677267Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-11-21T14:07:17.7677267Z",
"IncludeInSitemap": true,
"SystemSourceKey": "sample string 7",
"Ordinal": 8.1,
"UrlName": "sample string 9",
"ItemDefaultUrl": "sample string 10",
"EmbedUrl": "sample string 11",
"Author": "sample string 12",
"Extension": "sample string 13",
"MimeType": "sample string 14",
"TotalSize": 15,
"healthtopics": "63c189e4-a83c-4372-aa98-a69faa2a2beb",
"targets": "4cdeaa89-fe00-4d74-a458-cfa726517497",
"regionscountries": "7fa39195-740e-4aa9-9d4c-92c2bc4ceef7",
"stakeholders": "0d463171-6978-4af2-946d-ddeb523a3032",
"targetaudiences": "0919e8ac-384b-4ce7-9aea-0ba36e4160b0",
"Category": "21dca86f-de98-40a1-a2fe-e151fc4d9f38",
"Tags": "7e4f2ad6-ba9c-495b-96ba-0a9a3d386e3a",
"departmentaltargets": "27ac2496-c8fe-4f5b-9582-f6e7783396ed",
"events": "10eb9a8f-c6ed-4141-bb8a-4d1d99f688db",
"publishingoffices": "c3ed8af0-3244-4ab4-b670-d27ee7902173",
"Parts": "sample string 26",
"FolderId": "91655e1e-566c-4197-a5e9-9b479f3bc6ae",
"ParentId": "48376019-bd72-40d4-bef4-7c8ffab1099e",
"Provider": "sample string 29",
"Url": "sample string 30",
"ThumbnailUrl": "sample string 31",
"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": "a2eeba97-bae1-4ea5-b62d-3decbb94a2fb"
}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 | |
| EmbedUrl | 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-11-21T14:07:17.7677267Z",
"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": "a358fee3-2f6f-4dd7-bb38-e84ca402d177",
"targets": "ff42f25c-a2da-4035-8c7d-d47778987f03",
"regionscountries": "1b012531-46dc-4f19-a81f-7accc80dd384",
"stakeholders": "2a319662-0919-4273-852f-e27ab4291d19",
"targetaudiences": "6580a5dc-b55d-49af-9490-d5bbb9f13a23",
"Category": "5df96537-8f8b-46fb-bd59-4344d8447c54",
"Tags": "3b258b70-7736-45d9-bebc-eec37c6bcc11",
"departmentaltargets": "b0f1ce5a-3412-4f5c-883c-6730eccc9071",
"events": "dcfa654e-0df6-4b28-80b1-91ce9cfd6fd3",
"publishingoffices": "78b70839-4022-4ca3-9c58-3ad2a7feef14",
"Parts": "sample string 19",
"FolderId": "f168abc5-8bf1-40a9-a3cb-493190b50e9b",
"ParentId": "aaa32761-b64f-427f-a83a-60aa909d6274"
}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 | |
| EmbedUrl | 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-11-21T14:07:17.7677267Z",
"PublicationDate": "2026-11-21T14:07:17.7677267Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-11-21T14:07:17.7677267Z",
"IncludeInSitemap": true,
"SystemSourceKey": "sample string 7",
"Ordinal": 8.1,
"UrlName": "sample string 9",
"ItemDefaultUrl": "sample string 10",
"EmbedUrl": "sample string 11",
"Author": "sample string 12",
"Extension": "sample string 13",
"MimeType": "sample string 14",
"TotalSize": 15,
"healthtopics": "080d311d-e041-484e-9140-e6f74ff6c1ad",
"targets": "82ca07d5-c69e-4ca6-a966-cdf8f7d7dfa8",
"regionscountries": "1854ce18-ccda-46f0-8769-1b8aa9ff6038",
"stakeholders": "257a2e2b-c686-4631-8433-af2a8cd7bdb1",
"targetaudiences": "9815a207-635e-4fe9-88d5-865767a53dab",
"Category": "6a32c65b-b483-4458-a602-e9f98a404062",
"Tags": "089dcbf1-075e-4d84-8d56-0d0399c54176",
"departmentaltargets": "84f42ca0-b798-4038-bf5d-695b81de5f9d",
"events": "8e86ae43-256f-4640-b0cd-742659500ecb",
"publishingoffices": "12fc6cec-8c6b-4011-af13-91b5ade2ef44",
"Parts": "sample string 26",
"FolderId": "8e88c08b-5d22-493a-a228-1f87f2f0e7b8",
"ParentId": "2b980601-8823-4d08-8d56-8e5aae16d538",
"Provider": "sample string 29",
"Url": "sample string 30",
"ThumbnailUrl": "sample string 31",
"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 | |
| EmbedUrl | 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-11-21T14:07:17.7677267Z",
"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": "53f29338-c974-4b36-a7d7-a68b792bf8c4",
"targets": "c0a024c1-cdae-4d37-a4ee-55902a69f0fc",
"regionscountries": "c598d265-a583-42a0-8b4a-e8247ace2c63",
"stakeholders": "c75a2ee6-9deb-45cb-92c2-6a3c78ce6281",
"targetaudiences": "ae735f6e-c26d-40fb-97f9-35881251f369",
"Category": "df9b6cd9-cd36-41dd-8e81-83401d40f8d8",
"Tags": "7644f317-d03b-48af-a45b-0c7356555053",
"departmentaltargets": "e275b1af-2e48-4548-bf66-c1493a00ba8c",
"events": "0ccb6433-858b-4239-a767-7aa3e8ff93d1",
"publishingoffices": "c81a424d-1f22-4b34-85bb-3edd9f46ceb8",
"Parts": "sample string 19",
"FolderId": "a368e03b-323a-439a-b3e0-270bc63b20f1",
"ParentId": "129d5b43-ca2c-4fe5-996e-d77f058143dd"
}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 | |
| EmbedUrl | 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-11-21T14:07:17.7677267Z",
"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": "9fe9d23e-da6b-4825-9c30-ead9fed0ffb3",
"targets": "278f0539-d4a9-4ef0-adfb-1c8ae389f75c",
"regionscountries": "82fd14ef-d24f-4bcd-86d2-a4e54266267e",
"stakeholders": "5c00525f-874b-4ff8-aa8f-0728c0bad1d1",
"targetaudiences": "f577eb47-db56-4ed0-9f95-576397be194f",
"Category": "90729edb-413a-4bc0-9cc0-c2542f1d2744",
"Tags": "9a147ebd-76b6-4cf0-943f-030bef2c4189",
"departmentaltargets": "4ce8eec8-d159-4bde-9884-cd3df37d7ce4",
"events": "046ebbe9-2755-463a-b224-3a4de5db7630",
"publishingoffices": "8ff722ae-8667-44d4-a8df-50955c0a36f7",
"Parts": "sample string 19",
"FolderId": "871ca97f-3110-4c77-bc7d-0b6452bd2e44",
"ParentId": "edb8f99a-41f9-41ee-a87f-e8b7ea166555"
}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.