RESTful API
Default
Default news World Immunization Week GHO multimedias hubs documents WHOReference emergencies media newsroom ResultsReport IMR-sync

Documents

Get documents

Returns a set of data items of type documents.

Copy GET /api/default/documents
Request Informaion

URI Parameters

None

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

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
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

Description

System.String

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: True
Selected by default: True

IncludeInSitemap

System.Boolean

Read only: False
Selected by default: True

SystemSourceKey

System.String

Read only: False
Selected by default: True

Ordinal

System.Single

Read only: False
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

ItemDefaultUrl

System.String

Read only: True
Selected by default: True

Author

System.String

Read only: False
Selected by default: True

Extension

System.String

Read only: True
Selected by default: True

MimeType

System.String

Read only: True
Selected by default: True

TotalSize

System.Int64

Read only: True
Selected by default: True

healthtopics

System.Guid

Read only: False
Selected by default: False

targets

System.Guid

Read only: False
Selected by default: False

regionscountries

System.Guid

Read only: False
Selected by default: False

stakeholders

System.Guid

Read only: False
Selected by default: False

targetaudiences

System.Guid

Read only: False
Selected by default: False

JoomlaArticleId

System.String

Read only: False
Selected by default: True

Category

System.Guid

Read only: False
Selected by default: False

Tags

System.Guid

Read only: False
Selected by default: False

departmentaltargets

System.Guid

Read only: False
Selected by default: False

events

System.Guid

Read only: False
Selected by default: False

publishingoffices

System.Guid

Read only: False
Selected by default: False

Parts

System.String

Read only: False
Selected by default: True

FolderId

System.Guid

Read only: False
Selected by default: True

ParentId

System.Guid

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Url

System.String

Read only: True
Selected by default: True

ThumbnailUrl

System.String

Read only: True
Selected by default: True

IsDamMedia

System.Boolean

Read only: True
Selected by default: False

Resource Format

Response Formats
Copy
application/json
[
  {
    "LastModified": "2026-10-13T16:29:17.8563128Z",
    "PublicationDate": "2026-10-13T16:29:17.8563128Z",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "DateCreated": "2026-10-13T16:29:17.8563128Z",
    "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": "c2547c81-b5ad-4ddc-914d-b3a64fef229e",
    "targets": "54b4bb92-67d6-42ea-adf4-817197a99d3a",
    "regionscountries": "68c4d53b-3bfa-4765-9326-26ffcf875919",
    "stakeholders": "6cf5338a-945b-4afd-8804-f901dd0bf6a3",
    "targetaudiences": "ad543c53-46e0-4ab0-bf1a-6011b78bccd2",
    "JoomlaArticleId": "sample string 20",
    "Category": "5ad98094-6843-4c7d-a785-82dc395d06e4",
    "Tags": "646ee6dc-7224-4f9c-b25d-26df4b8993ef",
    "departmentaltargets": "7c142759-3203-442b-87f1-2942bfcaed2f",
    "events": "7ac53b29-d165-40a8-b720-be64fe3e9e73",
    "publishingoffices": "fb85cad0-1d8b-4588-aa23-d7ba6922f4a8",
    "Parts": "sample string 26",
    "FolderId": "ab930159-517b-4184-a146-181db5e57222",
    "ParentId": "e2b88936-a845-400d-b046-bd1147474cad",
    "Provider": "sample string 29",
    "Url": "sample string 30",
    "ThumbnailUrl": "sample string 31",
    "IsDamMedia": true
  },
  {
    "LastModified": "2026-10-13T16:29:17.8563128Z",
    "PublicationDate": "2026-10-13T16:29:17.8563128Z",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "DateCreated": "2026-10-13T16:29:17.8563128Z",
    "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": "c2547c81-b5ad-4ddc-914d-b3a64fef229e",
    "targets": "54b4bb92-67d6-42ea-adf4-817197a99d3a",
    "regionscountries": "68c4d53b-3bfa-4765-9326-26ffcf875919",
    "stakeholders": "6cf5338a-945b-4afd-8804-f901dd0bf6a3",
    "targetaudiences": "ad543c53-46e0-4ab0-bf1a-6011b78bccd2",
    "JoomlaArticleId": "sample string 20",
    "Category": "5ad98094-6843-4c7d-a785-82dc395d06e4",
    "Tags": "646ee6dc-7224-4f9c-b25d-26df4b8993ef",
    "departmentaltargets": "7c142759-3203-442b-87f1-2942bfcaed2f",
    "events": "7ac53b29-d165-40a8-b720-be64fe3e9e73",
    "publishingoffices": "fb85cad0-1d8b-4588-aa23-d7ba6922f4a8",
    "Parts": "sample string 26",
    "FolderId": "ab930159-517b-4184-a146-181db5e57222",
    "ParentId": "e2b88936-a845-400d-b046-bd1147474cad",
    "Provider": "sample string 29",
    "Url": "sample string 30",
    "ThumbnailUrl": "sample string 31",
    "IsDamMedia": true
  }
]

Get documents by key

Gets documents item by id.

Copy GET /api/default/documents({key})
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

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
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

Description

System.String

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: True
Selected by default: True

IncludeInSitemap

System.Boolean

Read only: False
Selected by default: True

SystemSourceKey

System.String

Read only: False
Selected by default: True

Ordinal

System.Single

Read only: False
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

ItemDefaultUrl

System.String

Read only: True
Selected by default: True

Author

System.String

Read only: False
Selected by default: True

Extension

System.String

Read only: True
Selected by default: True

MimeType

System.String

Read only: True
Selected by default: True

TotalSize

System.Int64

Read only: True
Selected by default: True

healthtopics

System.Guid

Read only: False
Selected by default: False

targets

System.Guid

Read only: False
Selected by default: False

regionscountries

System.Guid

Read only: False
Selected by default: False

stakeholders

System.Guid

Read only: False
Selected by default: False

targetaudiences

System.Guid

Read only: False
Selected by default: False

JoomlaArticleId

System.String

Read only: False
Selected by default: True

Category

System.Guid

Read only: False
Selected by default: False

Tags

System.Guid

Read only: False
Selected by default: False

departmentaltargets

System.Guid

Read only: False
Selected by default: False

events

System.Guid

Read only: False
Selected by default: False

publishingoffices

System.Guid

Read only: False
Selected by default: False

Parts

System.String

Read only: False
Selected by default: True

FolderId

System.Guid

Read only: False
Selected by default: True

ParentId

System.Guid

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Url

System.String

Read only: True
Selected by default: True

ThumbnailUrl

System.String

Read only: True
Selected by default: True

IsDamMedia

System.Boolean

Read only: True
Selected by default: False

Resource Format

Response Formats
Copy
application/json
{
  "LastModified": "2026-10-13T16:29:17.8563128Z",
  "PublicationDate": "2026-10-13T16:29:17.8563128Z",
  "Title": "sample string 3",
  "Description": "sample string 4",
  "DateCreated": "2026-10-13T16:29:17.8563128Z",
  "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": "805b3313-7645-4436-89e3-13a8647312b5",
  "targets": "d55e6120-0f1d-40e8-ac44-50c049dd163d",
  "regionscountries": "a4bfca5f-220d-4051-aaa3-ee4c62bb4a8f",
  "stakeholders": "be1fec18-b90b-45fd-9a9a-a750b8d4d1cc",
  "targetaudiences": "0412b956-78e3-443f-9536-71895efa3b7b",
  "JoomlaArticleId": "sample string 20",
  "Category": "1bb7a759-f009-48bc-8401-df176cdf6f20",
  "Tags": "dfe9b10f-dd99-4720-bb90-59a6e2328f74",
  "departmentaltargets": "49d79701-2a68-491d-ba7b-c2e0492d05b9",
  "events": "363fe0a9-6374-42f7-8a66-56239b3ba587",
  "publishingoffices": "df28bb5e-d6d9-4bf8-a0b9-83cb0ace862d",
  "Parts": "sample string 26",
  "FolderId": "5bcd987a-2132-428b-8477-65158704560d",
  "ParentId": "386606f6-01c0-4a7e-aaf6-0c12d124da95",
  "Provider": "sample string 29",
  "Url": "sample string 30",
  "ThumbnailUrl": "sample string 31",
  "IsDamMedia": true
}

Get property

Gets Id property from documents item.

Copy GET /api/default/documents({key})/property
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

property

System.String

Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

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

Resource Format

Response Formats
Copy
application/json
{
  "Id": "8dd14b1e-017d-4996-a523-ff44d2d5af2b"
}

Post documents

Creates a documents item.

Copy POST /api/default/documents
Request Informaion

URI Parameters

None

Body Parameters

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

Description

System.String

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: True
Selected by default: True

IncludeInSitemap

System.Boolean

Read only: False
Selected by default: True

SystemSourceKey

System.String

Read only: False
Selected by default: True

Ordinal

System.Single

Read only: False
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

ItemDefaultUrl

System.String

Read only: True
Selected by default: True

Author

System.String

Read only: False
Selected by default: True

Extension

System.String

Read only: True
Selected by default: True

MimeType

System.String

Read only: True
Selected by default: True

TotalSize

System.Int64

Read only: True
Selected by default: True

healthtopics

System.Guid

Read only: False
Selected by default: False

targets

System.Guid

Read only: False
Selected by default: False

regionscountries

System.Guid

Read only: False
Selected by default: False

stakeholders

System.Guid

Read only: False
Selected by default: False

targetaudiences

System.Guid

Read only: False
Selected by default: False

JoomlaArticleId

System.String

Read only: False
Selected by default: True

Category

System.Guid

Read only: False
Selected by default: False

Tags

System.Guid

Read only: False
Selected by default: False

departmentaltargets

System.Guid

Read only: False
Selected by default: False

events

System.Guid

Read only: False
Selected by default: False

publishingoffices

System.Guid

Read only: False
Selected by default: False

Parts

System.String

Read only: False
Selected by default: True

FolderId

System.Guid

Read only: False
Selected by default: True

ParentId

System.Guid

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Url

System.String

Read only: True
Selected by default: True

ThumbnailUrl

System.String

Read only: True
Selected by default: True

IsDamMedia

System.Boolean

Read only: True
Selected by default: False

Request Formats
Copy
application/json
{
  "PublicationDate": "2026-10-13T16:29:17.8563128Z",
  "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": "80f76da8-ab53-47bd-8a76-15bdfb45acb6",
  "targets": "b79628da-be2d-4b8f-9b15-49482fe61e98",
  "regionscountries": "d252269a-27b9-495c-aa2b-c3e8165f7d38",
  "stakeholders": "3e022d91-a9ca-43b1-848f-bfb69b247534",
  "targetaudiences": "8bec2543-727c-40a8-84bc-ae005c8ab5d8",
  "JoomlaArticleId": "sample string 14",
  "Category": "abeee014-fa08-423d-af4d-d2dbbd62d3aa",
  "Tags": "54c8fd7a-c9c1-43b9-a124-2f4271f64260",
  "departmentaltargets": "c66ad7e7-8c0e-4d54-84f2-1c239112dd11",
  "events": "5bee33fb-35b6-4f56-9a65-dfa9879dda50",
  "publishingoffices": "8c6fa56b-b370-4c41-9342-a5e041585644",
  "Parts": "sample string 20",
  "FolderId": "d4c62af1-0011-41d8-905d-6b1381ebf246",
  "ParentId": "4d55334e-ebe8-40c0-858a-749170873683"
}
Response Informaion

Resource Description

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
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

Description

System.String

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: True
Selected by default: True

IncludeInSitemap

System.Boolean

Read only: False
Selected by default: True

SystemSourceKey

System.String

Read only: False
Selected by default: True

Ordinal

System.Single

Read only: False
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

ItemDefaultUrl

System.String

Read only: True
Selected by default: True

Author

System.String

Read only: False
Selected by default: True

Extension

System.String

Read only: True
Selected by default: True

MimeType

System.String

Read only: True
Selected by default: True

TotalSize

System.Int64

Read only: True
Selected by default: True

healthtopics

System.Guid

Read only: False
Selected by default: False

targets

System.Guid

Read only: False
Selected by default: False

regionscountries

System.Guid

Read only: False
Selected by default: False

stakeholders

System.Guid

Read only: False
Selected by default: False

targetaudiences

System.Guid

Read only: False
Selected by default: False

JoomlaArticleId

System.String

Read only: False
Selected by default: True

Category

System.Guid

Read only: False
Selected by default: False

Tags

System.Guid

Read only: False
Selected by default: False

departmentaltargets

System.Guid

Read only: False
Selected by default: False

events

System.Guid

Read only: False
Selected by default: False

publishingoffices

System.Guid

Read only: False
Selected by default: False

Parts

System.String

Read only: False
Selected by default: True

FolderId

System.Guid

Read only: False
Selected by default: True

ParentId

System.Guid

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Url

System.String

Read only: True
Selected by default: True

ThumbnailUrl

System.String

Read only: True
Selected by default: True

IsDamMedia

System.Boolean

Read only: True
Selected by default: False

Resource Format

Response Formats
Copy
application/json
{
  "LastModified": "2026-10-13T16:29:17.8563128Z",
  "PublicationDate": "2026-10-13T16:29:17.8563128Z",
  "Title": "sample string 3",
  "Description": "sample string 4",
  "DateCreated": "2026-10-13T16:29:17.8563128Z",
  "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": "6d480130-6869-42b3-8558-13bc6b846eed",
  "targets": "733ef35f-de75-44ee-8ac9-be86b384bb2f",
  "regionscountries": "32820225-2660-4e0a-bb6e-61fd1205faf5",
  "stakeholders": "ae65d636-46cf-4f84-b844-6d91d0f4defa",
  "targetaudiences": "b2138cf1-4d86-4d39-b578-0da3cad18eba",
  "JoomlaArticleId": "sample string 20",
  "Category": "7f62249b-0941-4f35-9fa8-f16eb73d1ea4",
  "Tags": "e3e6d744-331f-41ac-b31b-6502f69c64f0",
  "departmentaltargets": "58bd99fd-9382-48b3-b7f8-975109ba070f",
  "events": "0a2c7127-ea80-4de8-b6d8-229b2bed3d3f",
  "publishingoffices": "42c43cb7-2564-4053-adc5-5ee26f9706c2",
  "Parts": "sample string 26",
  "FolderId": "6176c2d5-e4ad-4b9b-981b-4b16b60b0703",
  "ParentId": "20971778-c79c-42cc-97e9-86e27091fe09",
  "Provider": "sample string 29",
  "Url": "sample string 30",
  "ThumbnailUrl": "sample string 31",
  "IsDamMedia": true
}

Patch documents by key

Partial update for documents item.

Copy PATCH /api/default/documents({key})
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

Description

System.String

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: True
Selected by default: True

IncludeInSitemap

System.Boolean

Read only: False
Selected by default: True

SystemSourceKey

System.String

Read only: False
Selected by default: True

Ordinal

System.Single

Read only: False
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

ItemDefaultUrl

System.String

Read only: True
Selected by default: True

Author

System.String

Read only: False
Selected by default: True

Extension

System.String

Read only: True
Selected by default: True

MimeType

System.String

Read only: True
Selected by default: True

TotalSize

System.Int64

Read only: True
Selected by default: True

healthtopics

System.Guid

Read only: False
Selected by default: False

targets

System.Guid

Read only: False
Selected by default: False

regionscountries

System.Guid

Read only: False
Selected by default: False

stakeholders

System.Guid

Read only: False
Selected by default: False

targetaudiences

System.Guid

Read only: False
Selected by default: False

JoomlaArticleId

System.String

Read only: False
Selected by default: True

Category

System.Guid

Read only: False
Selected by default: False

Tags

System.Guid

Read only: False
Selected by default: False

departmentaltargets

System.Guid

Read only: False
Selected by default: False

events

System.Guid

Read only: False
Selected by default: False

publishingoffices

System.Guid

Read only: False
Selected by default: False

Parts

System.String

Read only: False
Selected by default: True

FolderId

System.Guid

Read only: False
Selected by default: True

ParentId

System.Guid

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Url

System.String

Read only: True
Selected by default: True

ThumbnailUrl

System.String

Read only: True
Selected by default: True

IsDamMedia

System.Boolean

Read only: True
Selected by default: False

Request Formats
Copy
application/json
{
  "PublicationDate": "2026-10-13T16:29:17.8563128Z",
  "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": "1730d52a-d5ee-4101-a66f-a5e7f6fdeaa6",
  "targets": "fc125fe5-c3dd-4525-885e-de6020cb7cd1",
  "regionscountries": "4c80bab3-c1b0-4fe1-903b-40107308af62",
  "stakeholders": "f58fbea8-02ee-47c1-9034-cec1db1e9afb",
  "targetaudiences": "4851a6d8-03a6-4133-a100-aca3a20b8ce8",
  "JoomlaArticleId": "sample string 14",
  "Category": "4d3c5e01-0931-4586-8f2c-604e18398fde",
  "Tags": "96c7d29f-ba7f-4576-b89a-06936ca4efe1",
  "departmentaltargets": "1b5d4cb2-8907-41f9-bf72-d85c11e1f2e7",
  "events": "98667220-7427-4a2a-a798-84eb986c387c",
  "publishingoffices": "38c9fec1-b556-4b6e-b2bc-2e664b575e7d",
  "Parts": "sample string 20",
  "FolderId": "2caac087-9b06-41bb-906f-873c9c3ce513",
  "ParentId": "fd5c6237-11a9-4818-aacb-833480b80010"
}
Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.

Put documents by key

Full update for documents item.

Copy PUT /api/default/documents({key})
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

Description

System.String

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: True
Selected by default: True

IncludeInSitemap

System.Boolean

Read only: False
Selected by default: True

SystemSourceKey

System.String

Read only: False
Selected by default: True

Ordinal

System.Single

Read only: False
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

ItemDefaultUrl

System.String

Read only: True
Selected by default: True

Author

System.String

Read only: False
Selected by default: True

Extension

System.String

Read only: True
Selected by default: True

MimeType

System.String

Read only: True
Selected by default: True

TotalSize

System.Int64

Read only: True
Selected by default: True

healthtopics

System.Guid

Read only: False
Selected by default: False

targets

System.Guid

Read only: False
Selected by default: False

regionscountries

System.Guid

Read only: False
Selected by default: False

stakeholders

System.Guid

Read only: False
Selected by default: False

targetaudiences

System.Guid

Read only: False
Selected by default: False

JoomlaArticleId

System.String

Read only: False
Selected by default: True

Category

System.Guid

Read only: False
Selected by default: False

Tags

System.Guid

Read only: False
Selected by default: False

departmentaltargets

System.Guid

Read only: False
Selected by default: False

events

System.Guid

Read only: False
Selected by default: False

publishingoffices

System.Guid

Read only: False
Selected by default: False

Parts

System.String

Read only: False
Selected by default: True

FolderId

System.Guid

Read only: False
Selected by default: True

ParentId

System.Guid

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Url

System.String

Read only: True
Selected by default: True

ThumbnailUrl

System.String

Read only: True
Selected by default: True

IsDamMedia

System.Boolean

Read only: True
Selected by default: False

Request Formats
Copy
application/json
{
  "PublicationDate": "2026-10-13T16:29:17.8678488Z",
  "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": "d5f152f1-a704-4656-82ba-857fe04ba61a",
  "targets": "912b54d6-05d2-4f5f-a1f6-f23137e4af96",
  "regionscountries": "dfe23ae6-581f-4eec-b95e-2659f9c9f4d7",
  "stakeholders": "e56f75c2-2050-453a-8f81-c11035432923",
  "targetaudiences": "fb258cd0-5da2-427d-96ed-0c062d5edfef",
  "JoomlaArticleId": "sample string 14",
  "Category": "8b94015d-d3d0-451b-95df-0f9a4b7b5eaf",
  "Tags": "0c468897-f75d-427e-ad39-0d0d85e0d7db",
  "departmentaltargets": "a5edb063-4a29-46c0-996f-a4a31637849e",
  "events": "1d9c8ee6-5af2-4552-84f3-68dbd6c22727",
  "publishingoffices": "ebc09186-01f9-473d-a31f-807dca956671",
  "Parts": "sample string 20",
  "FolderId": "e33f4a65-0ec6-49da-87ea-ed855dbb75aa",
  "ParentId": "8b214fd7-2452-40a2-871f-81e91fd0c57f"
}
Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.

Delete documents by key

Deletes a documents item by Id.

Copy DELETE /api/default/documents({key})
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.

Get Parent

Returns a set of related items of type Parent from documents item.

Copy GET /api/default/documents({key})/Parent
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

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
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

Description

System.String

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: True
Selected by default: True

IncludeInSitemap

System.Boolean

Read only: False
Selected by default: True

SystemSourceKey

System.String

Read only: False
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

ItemDefaultUrl

System.String

Read only: True
Selected by default: True

MaxSize

System.Int64

Read only: False
Selected by default: True

MaxItemSize

System.Int64

Read only: False
Selected by default: True

BlobStorageProvider

System.String

Read only: False
Selected by default: True

OutputCacheProfile

System.String

Read only: False
Selected by default: True

ClientCacheProfile

System.String

Read only: False
Selected by default: True

ExcludeFromSiteSearch

System.Boolean

Read only: False
Selected by default: True

CoverId

System.Guid

Read only: False
Selected by default: True

ThumbnailProfiles

System.String

Read only: False
Selected by default: False

AllowComments

System.Boolean

Read only: False
Selected by default: True

ParentId

System.Guid

Read only: False
Selected by default: False

Provider

System.String

Read only: True
Selected by default: True

ChildrenCount

System.Int32

Read only: True
Selected by default: True

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Breadcrumb

Telerik.Sitefinity.Web.Services.Extensibility.BreadcrumbItem

Read only: True
Selected by default: True

Resource Format

Response Formats
Copy
application/json
[
  {
    "LastModified": "2026-10-13T16:29:17.8679559Z",
    "PublicationDate": "2026-10-13T16:29:17.8679559Z",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "DateCreated": "2026-10-13T16:29:17.8679559Z",
    "IncludeInSitemap": true,
    "SystemSourceKey": "sample string 7",
    "UrlName": "sample string 8",
    "ItemDefaultUrl": "sample string 9",
    "MaxSize": 10,
    "MaxItemSize": 11,
    "BlobStorageProvider": "sample string 12",
    "OutputCacheProfile": "sample string 13",
    "ClientCacheProfile": "sample string 14",
    "ExcludeFromSiteSearch": true,
    "CoverId": "a81ac512-a5a9-4dff-bd2d-434243ea9a31",
    "ThumbnailProfiles": "sample string 17",
    "AllowComments": true,
    "ParentId": "fa873840-76ed-4cbb-9638-95ac0588a960",
    "Provider": "sample string 20",
    "ChildrenCount": 21,
    "Comments": {
      "Name": "sample string 1",
      "Message": "sample string 2",
      "DateCreated": "2026-10-13T16:29:17.8679559+00:00",
      "ProfilePictureUrl": "sample string 4",
      "ProfilePictureThumbnailUrl": "sample string 5"
    },
    "Breadcrumb": null
  },
  {
    "LastModified": "2026-10-13T16:29:17.8679559Z",
    "PublicationDate": "2026-10-13T16:29:17.8679559Z",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "DateCreated": "2026-10-13T16:29:17.8679559Z",
    "IncludeInSitemap": true,
    "SystemSourceKey": "sample string 7",
    "UrlName": "sample string 8",
    "ItemDefaultUrl": "sample string 9",
    "MaxSize": 10,
    "MaxItemSize": 11,
    "BlobStorageProvider": "sample string 12",
    "OutputCacheProfile": "sample string 13",
    "ClientCacheProfile": "sample string 14",
    "ExcludeFromSiteSearch": true,
    "CoverId": "a81ac512-a5a9-4dff-bd2d-434243ea9a31",
    "ThumbnailProfiles": "sample string 17",
    "AllowComments": true,
    "ParentId": "fa873840-76ed-4cbb-9638-95ac0588a960",
    "Provider": "sample string 20",
    "ChildrenCount": 21,
    "Comments": {
      "Name": "sample string 1",
      "Message": "sample string 2",
      "DateCreated": "2026-10-13T16:29:17.8679559+00:00",
      "ProfilePictureUrl": "sample string 4",
      "ProfilePictureThumbnailUrl": "sample string 5"
    },
    "Breadcrumb": null
  }
]

Get Parent by relatedKey

Returns a related item of type Parent from documents item.

Copy GET /api/default/documents({key})/Parent({relatedKey})
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

relatedKey

System.Guid

Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

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
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

Description

System.String

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: True
Selected by default: True

IncludeInSitemap

System.Boolean

Read only: False
Selected by default: True

SystemSourceKey

System.String

Read only: False
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

ItemDefaultUrl

System.String

Read only: True
Selected by default: True

MaxSize

System.Int64

Read only: False
Selected by default: True

MaxItemSize

System.Int64

Read only: False
Selected by default: True

BlobStorageProvider

System.String

Read only: False
Selected by default: True

OutputCacheProfile

System.String

Read only: False
Selected by default: True

ClientCacheProfile

System.String

Read only: False
Selected by default: True

ExcludeFromSiteSearch

System.Boolean

Read only: False
Selected by default: True

CoverId

System.Guid

Read only: False
Selected by default: True

ThumbnailProfiles

System.String

Read only: False
Selected by default: False

AllowComments

System.Boolean

Read only: False
Selected by default: True

ParentId

System.Guid

Read only: False
Selected by default: False

Provider

System.String

Read only: True
Selected by default: True

ChildrenCount

System.Int32

Read only: True
Selected by default: True

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Breadcrumb

Telerik.Sitefinity.Web.Services.Extensibility.BreadcrumbItem

Read only: True
Selected by default: True

Resource Format

Response Formats
Copy
application/json
{
  "LastModified": "2026-10-13T16:29:17.8679559Z",
  "PublicationDate": "2026-10-13T16:29:17.8679559Z",
  "Title": "sample string 3",
  "Description": "sample string 4",
  "DateCreated": "2026-10-13T16:29:17.8679559Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 7",
  "UrlName": "sample string 8",
  "ItemDefaultUrl": "sample string 9",
  "MaxSize": 10,
  "MaxItemSize": 11,
  "BlobStorageProvider": "sample string 12",
  "OutputCacheProfile": "sample string 13",
  "ClientCacheProfile": "sample string 14",
  "ExcludeFromSiteSearch": true,
  "CoverId": "c98010b6-06d6-4c91-9942-5dcb38fd5478",
  "ThumbnailProfiles": "sample string 17",
  "AllowComments": true,
  "ParentId": "f983917a-8edb-4793-9020-9e03ad0cde4d",
  "Provider": "sample string 20",
  "ChildrenCount": 21,
  "Comments": {
    "Name": "sample string 1",
    "Message": "sample string 2",
    "DateCreated": "2026-10-13T16:29:17.8679559+00:00",
    "ProfilePictureUrl": "sample string 4",
    "ProfilePictureThumbnailUrl": "sample string 5"
  },
  "Breadcrumb": null
}

Post Parent

Add Parent relation to documents item.

Copy POST /api/default/documents({key})/Parent/$ref
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

None

Request Formats
Copy
application/json
{
  "@odata.id": "http://host/route/service/type(key)"
}
Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.

Delete Parent

Delete set of related items of type Parent from documents item.

Copy DELETE /api/default/documents({key})/Parent/$ref
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.

Delete Parent by relatedKey

Delete relation of type Parent from documents item.

Copy DELETE /api/default/documents({key})/Parent({relatedKey})/$ref
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

relatedKey

System.Guid

Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.