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

Product profiles

Get productprofiles

Returns a set of data items of type productprofiles.

Copy GET /api/default/productprofiles
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

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

Indication

System.String

Read only: False
Selected by default: True

Comments

System.String

Read only: False
Selected by default: True

WHO

System.Boolean

Read only: False
Selected by default: True

Efficacy

System.String

Read only: False
Selected by default: True

UseSetting

System.String

Read only: False
Selected by default: True

healthtopics

System.Guid

Read only: False
Selected by default: False

ContactEmail

System.String

Read only: False
Selected by default: True

DocumentTitle

System.String

Read only: False
Selected by default: True

diseases

System.Guid

Read only: False
Selected by default: False

SampleTypeAndVolume

System.String

Read only: False
Selected by default: True

Published

System.DateTimeOffset

Read only: False
Selected by default: True

TargetPopulation

System.String

Read only: False
Selected by default: True

IntendedUse

System.String

Read only: False
Selected by default: True

IRISID

System.String

Read only: False
Selected by default: True

Safety

System.String

Read only: False
Selected by default: True

Performance

System.String

Read only: False
Selected by default: True

URL

System.String

Read only: False
Selected by default: True

statuses

System.Guid

Read only: False
Selected by default: False

producttypes

System.Guid

Read only: False
Selected by default: False

publishingoffices

System.Guid

Read only: False
Selected by default: False

authors

System.Guid

Read only: False
Selected by default: False

OrganizationalTitle

System.String

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Resource Format

Response Formats
Copy
application/json
[
  {
    "LastModified": "2026-09-20T23:00:50.4763079Z",
    "PublicationDate": "2026-09-20T23:00:50.4763079Z",
    "DateCreated": "2026-09-20T23:00:50.4763079Z",
    "IncludeInSitemap": true,
    "SystemSourceKey": "sample string 5",
    "UrlName": "sample string 6",
    "ItemDefaultUrl": "sample string 7",
    "Indication": "sample string 8",
    "Comments": "sample string 9",
    "WHO": true,
    "Efficacy": "sample string 11",
    "UseSetting": "sample string 12",
    "healthtopics": "77f0a5db-ed87-4b11-a6ca-0be2ee8f86df",
    "ContactEmail": "sample string 14",
    "DocumentTitle": "sample string 15",
    "diseases": "e1030170-cac5-4d07-9fd8-e546323de751",
    "SampleTypeAndVolume": "sample string 17",
    "Published": "2026-09-20T23:00:50.4763079Z",
    "TargetPopulation": "sample string 19",
    "IntendedUse": "sample string 20",
    "IRISID": "sample string 21",
    "Safety": "sample string 22",
    "Performance": "sample string 23",
    "URL": "sample string 24",
    "statuses": "5666cf8d-7dde-4d4c-85ef-76084c078d0c",
    "producttypes": "6e097d0a-1068-48ad-a788-2e85fe30035c",
    "publishingoffices": "486881fc-0155-486a-a792-befde033c56c",
    "authors": "d7b258ad-0986-4e7c-8803-253af7210980",
    "OrganizationalTitle": "sample string 29",
    "Provider": "sample string 30"
  },
  {
    "LastModified": "2026-09-20T23:00:50.4763079Z",
    "PublicationDate": "2026-09-20T23:00:50.4763079Z",
    "DateCreated": "2026-09-20T23:00:50.4763079Z",
    "IncludeInSitemap": true,
    "SystemSourceKey": "sample string 5",
    "UrlName": "sample string 6",
    "ItemDefaultUrl": "sample string 7",
    "Indication": "sample string 8",
    "Comments": "sample string 9",
    "WHO": true,
    "Efficacy": "sample string 11",
    "UseSetting": "sample string 12",
    "healthtopics": "77f0a5db-ed87-4b11-a6ca-0be2ee8f86df",
    "ContactEmail": "sample string 14",
    "DocumentTitle": "sample string 15",
    "diseases": "e1030170-cac5-4d07-9fd8-e546323de751",
    "SampleTypeAndVolume": "sample string 17",
    "Published": "2026-09-20T23:00:50.4763079Z",
    "TargetPopulation": "sample string 19",
    "IntendedUse": "sample string 20",
    "IRISID": "sample string 21",
    "Safety": "sample string 22",
    "Performance": "sample string 23",
    "URL": "sample string 24",
    "statuses": "5666cf8d-7dde-4d4c-85ef-76084c078d0c",
    "producttypes": "6e097d0a-1068-48ad-a788-2e85fe30035c",
    "publishingoffices": "486881fc-0155-486a-a792-befde033c56c",
    "authors": "d7b258ad-0986-4e7c-8803-253af7210980",
    "OrganizationalTitle": "sample string 29",
    "Provider": "sample string 30"
  }
]

Get productprofiles by key

Gets productprofiles item by id.

Copy GET /api/default/productprofiles({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

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

Indication

System.String

Read only: False
Selected by default: True

Comments

System.String

Read only: False
Selected by default: True

WHO

System.Boolean

Read only: False
Selected by default: True

Efficacy

System.String

Read only: False
Selected by default: True

UseSetting

System.String

Read only: False
Selected by default: True

healthtopics

System.Guid

Read only: False
Selected by default: False

ContactEmail

System.String

Read only: False
Selected by default: True

DocumentTitle

System.String

Read only: False
Selected by default: True

diseases

System.Guid

Read only: False
Selected by default: False

SampleTypeAndVolume

System.String

Read only: False
Selected by default: True

Published

System.DateTimeOffset

Read only: False
Selected by default: True

TargetPopulation

System.String

Read only: False
Selected by default: True

IntendedUse

System.String

Read only: False
Selected by default: True

IRISID

System.String

Read only: False
Selected by default: True

Safety

System.String

Read only: False
Selected by default: True

Performance

System.String

Read only: False
Selected by default: True

URL

System.String

Read only: False
Selected by default: True

statuses

System.Guid

Read only: False
Selected by default: False

producttypes

System.Guid

Read only: False
Selected by default: False

publishingoffices

System.Guid

Read only: False
Selected by default: False

authors

System.Guid

Read only: False
Selected by default: False

OrganizationalTitle

System.String

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Resource Format

Response Formats
Copy
application/json
{
  "LastModified": "2026-09-20T23:00:50.4763079Z",
  "PublicationDate": "2026-09-20T23:00:50.4763079Z",
  "DateCreated": "2026-09-20T23:00:50.4763079Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 5",
  "UrlName": "sample string 6",
  "ItemDefaultUrl": "sample string 7",
  "Indication": "sample string 8",
  "Comments": "sample string 9",
  "WHO": true,
  "Efficacy": "sample string 11",
  "UseSetting": "sample string 12",
  "healthtopics": "cb049a3c-ea86-4850-aeac-72c4ddd4df5a",
  "ContactEmail": "sample string 14",
  "DocumentTitle": "sample string 15",
  "diseases": "a70e161e-06a1-4a91-8777-7b3774323bb0",
  "SampleTypeAndVolume": "sample string 17",
  "Published": "2026-09-20T23:00:50.4763079Z",
  "TargetPopulation": "sample string 19",
  "IntendedUse": "sample string 20",
  "IRISID": "sample string 21",
  "Safety": "sample string 22",
  "Performance": "sample string 23",
  "URL": "sample string 24",
  "statuses": "7e634bdb-a8e8-44a1-9dd5-fc9a80d9fda2",
  "producttypes": "1fb39331-e89e-426f-819b-a45e4fda7ede",
  "publishingoffices": "c33eb650-96e3-40d0-a4fc-0cef74685a87",
  "authors": "e50b515f-35e2-489d-a4a6-10f3e15947cf",
  "OrganizationalTitle": "sample string 29",
  "Provider": "sample string 30"
}

Get property

Gets Id property from productprofiles item.

Copy GET /api/default/productprofiles({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": "9f78c6d5-33b9-49e4-bece-17abbd7cfec0"
}

Post productprofiles

Creates a productprofiles item.

Copy POST /api/default/productprofiles
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

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

Indication

System.String

Read only: False
Selected by default: True

Comments

System.String

Read only: False
Selected by default: True

WHO

System.Boolean

Read only: False
Selected by default: True

Efficacy

System.String

Read only: False
Selected by default: True

UseSetting

System.String

Read only: False
Selected by default: True

healthtopics

System.Guid

Read only: False
Selected by default: False

ContactEmail

System.String

Read only: False
Selected by default: True

DocumentTitle

System.String

Read only: False
Selected by default: True

diseases

System.Guid

Read only: False
Selected by default: False

SampleTypeAndVolume

System.String

Read only: False
Selected by default: True

Published

System.DateTimeOffset

Read only: False
Selected by default: True

TargetPopulation

System.String

Read only: False
Selected by default: True

IntendedUse

System.String

Read only: False
Selected by default: True

IRISID

System.String

Read only: False
Selected by default: True

Safety

System.String

Read only: False
Selected by default: True

Performance

System.String

Read only: False
Selected by default: True

URL

System.String

Read only: False
Selected by default: True

statuses

System.Guid

Read only: False
Selected by default: False

producttypes

System.Guid

Read only: False
Selected by default: False

publishingoffices

System.Guid

Read only: False
Selected by default: False

authors

System.Guid

Read only: False
Selected by default: False

OrganizationalTitle

System.String

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Request Formats
Copy
application/json
{
  "PublicationDate": "2026-09-20T23:00:50.4763079Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 3",
  "UrlName": "sample string 4",
  "Indication": "sample string 5",
  "Comments": "sample string 6",
  "WHO": true,
  "Efficacy": "sample string 8",
  "UseSetting": "sample string 9",
  "healthtopics": "ef249d26-65fe-4ca2-9a3f-c3c3e297d5a5",
  "ContactEmail": "sample string 11",
  "DocumentTitle": "sample string 12",
  "diseases": "0c059ec1-7232-4561-ab8e-d611dc717b1d",
  "SampleTypeAndVolume": "sample string 14",
  "Published": "2026-09-20T23:00:50.4763079Z",
  "TargetPopulation": "sample string 16",
  "IntendedUse": "sample string 17",
  "IRISID": "sample string 18",
  "Safety": "sample string 19",
  "Performance": "sample string 20",
  "URL": "sample string 21",
  "statuses": "3fe751e5-a753-4dde-a4dd-51b8bd7504b9",
  "producttypes": "f2b548e7-7ace-4c3e-af62-9067199deed2",
  "publishingoffices": "30084bd7-a2cb-49ad-95c4-30d9526c8f9d",
  "authors": "80915476-e37d-4bbd-a4ca-49d32c99c530",
  "OrganizationalTitle": "sample string 26"
}
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

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

Indication

System.String

Read only: False
Selected by default: True

Comments

System.String

Read only: False
Selected by default: True

WHO

System.Boolean

Read only: False
Selected by default: True

Efficacy

System.String

Read only: False
Selected by default: True

UseSetting

System.String

Read only: False
Selected by default: True

healthtopics

System.Guid

Read only: False
Selected by default: False

ContactEmail

System.String

Read only: False
Selected by default: True

DocumentTitle

System.String

Read only: False
Selected by default: True

diseases

System.Guid

Read only: False
Selected by default: False

SampleTypeAndVolume

System.String

Read only: False
Selected by default: True

Published

System.DateTimeOffset

Read only: False
Selected by default: True

TargetPopulation

System.String

Read only: False
Selected by default: True

IntendedUse

System.String

Read only: False
Selected by default: True

IRISID

System.String

Read only: False
Selected by default: True

Safety

System.String

Read only: False
Selected by default: True

Performance

System.String

Read only: False
Selected by default: True

URL

System.String

Read only: False
Selected by default: True

statuses

System.Guid

Read only: False
Selected by default: False

producttypes

System.Guid

Read only: False
Selected by default: False

publishingoffices

System.Guid

Read only: False
Selected by default: False

authors

System.Guid

Read only: False
Selected by default: False

OrganizationalTitle

System.String

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Resource Format

Response Formats
Copy
application/json
{
  "LastModified": "2026-09-20T23:00:50.4763079Z",
  "PublicationDate": "2026-09-20T23:00:50.4763079Z",
  "DateCreated": "2026-09-20T23:00:50.4763079Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 5",
  "UrlName": "sample string 6",
  "ItemDefaultUrl": "sample string 7",
  "Indication": "sample string 8",
  "Comments": "sample string 9",
  "WHO": true,
  "Efficacy": "sample string 11",
  "UseSetting": "sample string 12",
  "healthtopics": "ee8b0aa6-6a2e-4c17-8c3e-520c7c646a85",
  "ContactEmail": "sample string 14",
  "DocumentTitle": "sample string 15",
  "diseases": "1c830c7d-0666-4431-8653-61fc820ad2ab",
  "SampleTypeAndVolume": "sample string 17",
  "Published": "2026-09-20T23:00:50.4763079Z",
  "TargetPopulation": "sample string 19",
  "IntendedUse": "sample string 20",
  "IRISID": "sample string 21",
  "Safety": "sample string 22",
  "Performance": "sample string 23",
  "URL": "sample string 24",
  "statuses": "176a9481-3b07-4d74-a51b-48745b92bcf5",
  "producttypes": "5200c44e-efe5-4b13-afaf-050ae645aa2b",
  "publishingoffices": "79e0a75c-202b-47e5-88db-910735c28b1a",
  "authors": "61d50fb8-ff0f-4f4c-9b8a-3ee688e6d833",
  "OrganizationalTitle": "sample string 29",
  "Provider": "sample string 30"
}

Patch productprofiles by key

Partial update for productprofiles item.

Copy PATCH /api/default/productprofiles({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

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

Indication

System.String

Read only: False
Selected by default: True

Comments

System.String

Read only: False
Selected by default: True

WHO

System.Boolean

Read only: False
Selected by default: True

Efficacy

System.String

Read only: False
Selected by default: True

UseSetting

System.String

Read only: False
Selected by default: True

healthtopics

System.Guid

Read only: False
Selected by default: False

ContactEmail

System.String

Read only: False
Selected by default: True

DocumentTitle

System.String

Read only: False
Selected by default: True

diseases

System.Guid

Read only: False
Selected by default: False

SampleTypeAndVolume

System.String

Read only: False
Selected by default: True

Published

System.DateTimeOffset

Read only: False
Selected by default: True

TargetPopulation

System.String

Read only: False
Selected by default: True

IntendedUse

System.String

Read only: False
Selected by default: True

IRISID

System.String

Read only: False
Selected by default: True

Safety

System.String

Read only: False
Selected by default: True

Performance

System.String

Read only: False
Selected by default: True

URL

System.String

Read only: False
Selected by default: True

statuses

System.Guid

Read only: False
Selected by default: False

producttypes

System.Guid

Read only: False
Selected by default: False

publishingoffices

System.Guid

Read only: False
Selected by default: False

authors

System.Guid

Read only: False
Selected by default: False

OrganizationalTitle

System.String

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Request Formats
Copy
application/json
{
  "PublicationDate": "2026-09-20T23:00:50.4763079Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 3",
  "UrlName": "sample string 4",
  "Indication": "sample string 5",
  "Comments": "sample string 6",
  "WHO": true,
  "Efficacy": "sample string 8",
  "UseSetting": "sample string 9",
  "healthtopics": "50f9e88e-aa5b-4044-85e3-d37158803f53",
  "ContactEmail": "sample string 11",
  "DocumentTitle": "sample string 12",
  "diseases": "70cd63b7-fa6b-456e-a3c2-99b89676fe6f",
  "SampleTypeAndVolume": "sample string 14",
  "Published": "2026-09-20T23:00:50.4763079Z",
  "TargetPopulation": "sample string 16",
  "IntendedUse": "sample string 17",
  "IRISID": "sample string 18",
  "Safety": "sample string 19",
  "Performance": "sample string 20",
  "URL": "sample string 21",
  "statuses": "3dc02e86-0b19-454a-8d58-086e7c8b4033",
  "producttypes": "d799c5cb-4af0-42d6-a17a-4dbf09818d49",
  "publishingoffices": "140dd0a4-9b67-434d-8f74-efa082494d45",
  "authors": "34036b7f-2980-4f17-b095-c71106dfa6de",
  "OrganizationalTitle": "sample string 26"
}
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 productprofiles by key

Full update for productprofiles item.

Copy PUT /api/default/productprofiles({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

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

Indication

System.String

Read only: False
Selected by default: True

Comments

System.String

Read only: False
Selected by default: True

WHO

System.Boolean

Read only: False
Selected by default: True

Efficacy

System.String

Read only: False
Selected by default: True

UseSetting

System.String

Read only: False
Selected by default: True

healthtopics

System.Guid

Read only: False
Selected by default: False

ContactEmail

System.String

Read only: False
Selected by default: True

DocumentTitle

System.String

Read only: False
Selected by default: True

diseases

System.Guid

Read only: False
Selected by default: False

SampleTypeAndVolume

System.String

Read only: False
Selected by default: True

Published

System.DateTimeOffset

Read only: False
Selected by default: True

TargetPopulation

System.String

Read only: False
Selected by default: True

IntendedUse

System.String

Read only: False
Selected by default: True

IRISID

System.String

Read only: False
Selected by default: True

Safety

System.String

Read only: False
Selected by default: True

Performance

System.String

Read only: False
Selected by default: True

URL

System.String

Read only: False
Selected by default: True

statuses

System.Guid

Read only: False
Selected by default: False

producttypes

System.Guid

Read only: False
Selected by default: False

publishingoffices

System.Guid

Read only: False
Selected by default: False

authors

System.Guid

Read only: False
Selected by default: False

OrganizationalTitle

System.String

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Request Formats
Copy
application/json
{
  "PublicationDate": "2026-09-20T23:00:50.4763079Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 3",
  "UrlName": "sample string 4",
  "Indication": "sample string 5",
  "Comments": "sample string 6",
  "WHO": true,
  "Efficacy": "sample string 8",
  "UseSetting": "sample string 9",
  "healthtopics": "75d85635-7f86-48fd-9542-f1d867ad9a04",
  "ContactEmail": "sample string 11",
  "DocumentTitle": "sample string 12",
  "diseases": "c10547e4-e6e6-4dba-8f9b-0f0502542f0e",
  "SampleTypeAndVolume": "sample string 14",
  "Published": "2026-09-20T23:00:50.4763079Z",
  "TargetPopulation": "sample string 16",
  "IntendedUse": "sample string 17",
  "IRISID": "sample string 18",
  "Safety": "sample string 19",
  "Performance": "sample string 20",
  "URL": "sample string 21",
  "statuses": "f14bafdf-1217-4b77-8bcf-748bad7efaea",
  "producttypes": "7e9cf695-c847-4e19-8a78-744bf71f674e",
  "publishingoffices": "bae04b4f-3b65-4f13-8061-1ac5d1bf7f0d",
  "authors": "8500fe81-a373-4b32-970c-87c2e9a50a19",
  "OrganizationalTitle": "sample string 26"
}
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 productprofiles by key

Deletes a productprofiles item by Id.

Copy DELETE /api/default/productprofiles({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 Thumbnail

Returns a set of related items of type Thumbnail from productprofiles item.

Copy GET /api/default/productprofiles({key})/Thumbnail
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

regionscountries

System.Guid

Read only: False
Selected by default: False

publishingoffices

System.Guid

Read only: False
Selected by default: False

events

System.Guid

Read only: False
Selected by default: False

targets

System.Guid

Read only: False
Selected by default: False

Category

System.Guid

Read only: False
Selected by default: False

imagetypes

System.Guid

Read only: False
Selected by default: False

JoomlaArticleId

System.String

Read only: False
Selected by default: True

departmentaltargets

System.Guid

Read only: False
Selected by default: False

stakeholders

System.Guid

Read only: False
Selected by default: False

Tags

System.Guid

Read only: False
Selected by default: False

healthtopics

System.Guid

Read only: False
Selected by default: False

targetaudiences

System.Guid

Read only: False
Selected by default: False

IsOptimized

System.Boolean

Read only: False
Selected by default: True

OptImgStatus

System.String

Read only: False
Selected by default: True

Width

System.Int32

Read only: True
Selected by default: True

Height

System.Int32

Read only: True
Selected by default: True

AlternativeText

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

Thumbnails

Telerik.Sitefinity.Modules.Libraries.Web.Services.Extensibility.ThumbnailModel

Read only: True
Selected by default: False

IsDamMedia

System.Boolean

Read only: True
Selected by default: False

Resource Format

Response Formats
Copy
application/json
[
  {
    "LastModified": "2026-09-20T23:00:50.4763079Z",
    "PublicationDate": "2026-09-20T23:00:50.4763079Z",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "DateCreated": "2026-09-20T23:00:50.4763079Z",
    "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,
    "regionscountries": "db5a1fb5-123d-4248-8bd8-680fa1eb79eb",
    "publishingoffices": "7c23ea83-bd4f-471f-9e54-2765a7e4db83",
    "events": "28e07c45-0704-4cec-a7bd-9f8f6b4cf443",
    "targets": "19f5a11c-2c3c-42d3-ae46-cfe7e7e771b2",
    "Category": "80b1b9f9-8ff5-4381-a52f-dbbc8fa90e29",
    "imagetypes": "9bfee753-623c-4bf2-bc88-957be60362f6",
    "JoomlaArticleId": "sample string 21",
    "departmentaltargets": "e33a5b7e-ea57-4499-a3fa-8c07dd4be96f",
    "stakeholders": "951d035f-71d5-4fdd-9f5e-066120a0f1e8",
    "Tags": "686abecf-2ca5-4d31-b61a-65d682786f32",
    "healthtopics": "fa5bb695-b08a-4abf-9253-88b9f6fa9bf6",
    "targetaudiences": "a72668ef-9ef1-4dac-b4f6-c2f8611263d1",
    "IsOptimized": true,
    "OptImgStatus": "sample string 28",
    "Width": 29,
    "Height": 30,
    "AlternativeText": "sample string 31",
    "FolderId": "b118e601-af1a-4402-818a-26e630b68787",
    "ParentId": "3134e11b-2aec-47d2-9d45-d16f3caa61d4",
    "Provider": "sample string 34",
    "Url": "sample string 35",
    "ThumbnailUrl": "sample string 36",
    "Thumbnails": {
      "Title": "sample string 1",
      "Url": "sample string 2",
      "Width": 3,
      "Height": 4,
      "MimeType": "sample string 5"
    },
    "IsDamMedia": true
  },
  {
    "LastModified": "2026-09-20T23:00:50.4763079Z",
    "PublicationDate": "2026-09-20T23:00:50.4763079Z",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "DateCreated": "2026-09-20T23:00:50.4763079Z",
    "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,
    "regionscountries": "db5a1fb5-123d-4248-8bd8-680fa1eb79eb",
    "publishingoffices": "7c23ea83-bd4f-471f-9e54-2765a7e4db83",
    "events": "28e07c45-0704-4cec-a7bd-9f8f6b4cf443",
    "targets": "19f5a11c-2c3c-42d3-ae46-cfe7e7e771b2",
    "Category": "80b1b9f9-8ff5-4381-a52f-dbbc8fa90e29",
    "imagetypes": "9bfee753-623c-4bf2-bc88-957be60362f6",
    "JoomlaArticleId": "sample string 21",
    "departmentaltargets": "e33a5b7e-ea57-4499-a3fa-8c07dd4be96f",
    "stakeholders": "951d035f-71d5-4fdd-9f5e-066120a0f1e8",
    "Tags": "686abecf-2ca5-4d31-b61a-65d682786f32",
    "healthtopics": "fa5bb695-b08a-4abf-9253-88b9f6fa9bf6",
    "targetaudiences": "a72668ef-9ef1-4dac-b4f6-c2f8611263d1",
    "IsOptimized": true,
    "OptImgStatus": "sample string 28",
    "Width": 29,
    "Height": 30,
    "AlternativeText": "sample string 31",
    "FolderId": "b118e601-af1a-4402-818a-26e630b68787",
    "ParentId": "3134e11b-2aec-47d2-9d45-d16f3caa61d4",
    "Provider": "sample string 34",
    "Url": "sample string 35",
    "ThumbnailUrl": "sample string 36",
    "Thumbnails": {
      "Title": "sample string 1",
      "Url": "sample string 2",
      "Width": 3,
      "Height": 4,
      "MimeType": "sample string 5"
    },
    "IsDamMedia": true
  }
]

Get Thumbnail by relatedKey

Returns a related item of type Thumbnail from productprofiles item.

Copy GET /api/default/productprofiles({key})/Thumbnail({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

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

regionscountries

System.Guid

Read only: False
Selected by default: False

publishingoffices

System.Guid

Read only: False
Selected by default: False

events

System.Guid

Read only: False
Selected by default: False

targets

System.Guid

Read only: False
Selected by default: False

Category

System.Guid

Read only: False
Selected by default: False

imagetypes

System.Guid

Read only: False
Selected by default: False

JoomlaArticleId

System.String

Read only: False
Selected by default: True

departmentaltargets

System.Guid

Read only: False
Selected by default: False

stakeholders

System.Guid

Read only: False
Selected by default: False

Tags

System.Guid

Read only: False
Selected by default: False

healthtopics

System.Guid

Read only: False
Selected by default: False

targetaudiences

System.Guid

Read only: False
Selected by default: False

IsOptimized

System.Boolean

Read only: False
Selected by default: True

OptImgStatus

System.String

Read only: False
Selected by default: True

Width

System.Int32

Read only: True
Selected by default: True

Height

System.Int32

Read only: True
Selected by default: True

AlternativeText

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

Thumbnails

Telerik.Sitefinity.Modules.Libraries.Web.Services.Extensibility.ThumbnailModel

Read only: True
Selected by default: False

IsDamMedia

System.Boolean

Read only: True
Selected by default: False

Resource Format

Response Formats
Copy
application/json
{
  "LastModified": "2026-09-20T23:00:50.4763079Z",
  "PublicationDate": "2026-09-20T23:00:50.4763079Z",
  "Title": "sample string 3",
  "Description": "sample string 4",
  "DateCreated": "2026-09-20T23:00:50.4763079Z",
  "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,
  "regionscountries": "43d96e83-6c02-40e9-b11e-f8b5dda460ef",
  "publishingoffices": "ebeecf88-7103-4922-bca8-7acdcba1f325",
  "events": "13e6018d-9ef1-46a7-bcaf-3f8875243383",
  "targets": "4b9a008c-58ff-41e9-8f39-3ff45486f996",
  "Category": "0810db0b-45d9-4bf9-bbfc-79db3e0cbc3b",
  "imagetypes": "6f265740-3371-4453-b36a-9142d205a54d",
  "JoomlaArticleId": "sample string 21",
  "departmentaltargets": "c8d9f8a4-f1f5-4c49-adb0-73b812669879",
  "stakeholders": "f4af0211-5601-4bef-aa4c-c504de5b6c7c",
  "Tags": "7140761a-cf63-476a-8747-9d605fa9dd1d",
  "healthtopics": "b5bcbac4-1da3-42ba-924d-b9d5ed18a9f9",
  "targetaudiences": "6839c383-0984-4cab-8f33-8a5ffa6f224f",
  "IsOptimized": true,
  "OptImgStatus": "sample string 28",
  "Width": 29,
  "Height": 30,
  "AlternativeText": "sample string 31",
  "FolderId": "593be84f-e4f5-4dd1-8a81-c0ca7aa194ef",
  "ParentId": "35e7a3cf-b910-474e-8fa1-71bdbba99598",
  "Provider": "sample string 34",
  "Url": "sample string 35",
  "ThumbnailUrl": "sample string 36",
  "Thumbnails": {
    "Title": "sample string 1",
    "Url": "sample string 2",
    "Width": 3,
    "Height": 4,
    "MimeType": "sample string 5"
  },
  "IsDamMedia": true
}

Post Thumbnail

Add Thumbnail relation to productprofiles item.

Copy POST /api/default/productprofiles({key})/Thumbnail/$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 Thumbnail

Delete set of related items of type Thumbnail from productprofiles item.

Copy DELETE /api/default/productprofiles({key})/Thumbnail/$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 Thumbnail by relatedKey

Delete relation of type Thumbnail from productprofiles item.

Copy DELETE /api/default/productprofiles({key})/Thumbnail({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.

Get TppAuthors

Returns a set of related items of type TppAuthors from productprofiles item.

Copy GET /api/default/productprofiles({key})/TppAuthors
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

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

SortOrder

System.Decimal

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Resource Format

Response Formats
Copy
application/json
[
  {
    "LastModified": "2026-09-20T23:00:50.4763079Z",
    "PublicationDate": "2026-09-20T23:00:50.4763079Z",
    "DateCreated": "2026-09-20T23:00:50.4763079Z",
    "IncludeInSitemap": true,
    "SystemSourceKey": "sample string 5",
    "UrlName": "sample string 6",
    "ItemDefaultUrl": "sample string 7",
    "SortOrder": 8.0,
    "Title": "sample string 9",
    "Provider": "sample string 10",
    "Comments": {
      "Name": "sample string 1",
      "Message": "sample string 2",
      "DateCreated": "2026-09-20T23:00:50.4763079+00:00",
      "ProfilePictureUrl": "sample string 4",
      "ProfilePictureThumbnailUrl": "sample string 5"
    }
  },
  {
    "LastModified": "2026-09-20T23:00:50.4763079Z",
    "PublicationDate": "2026-09-20T23:00:50.4763079Z",
    "DateCreated": "2026-09-20T23:00:50.4763079Z",
    "IncludeInSitemap": true,
    "SystemSourceKey": "sample string 5",
    "UrlName": "sample string 6",
    "ItemDefaultUrl": "sample string 7",
    "SortOrder": 8.0,
    "Title": "sample string 9",
    "Provider": "sample string 10",
    "Comments": {
      "Name": "sample string 1",
      "Message": "sample string 2",
      "DateCreated": "2026-09-20T23:00:50.4763079+00:00",
      "ProfilePictureUrl": "sample string 4",
      "ProfilePictureThumbnailUrl": "sample string 5"
    }
  }
]

Get TppAuthors by relatedKey

Returns a related item of type TppAuthors from productprofiles item.

Copy GET /api/default/productprofiles({key})/TppAuthors({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

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

SortOrder

System.Decimal

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Resource Format

Response Formats
Copy
application/json
{
  "LastModified": "2026-09-20T23:00:50.4763079Z",
  "PublicationDate": "2026-09-20T23:00:50.4763079Z",
  "DateCreated": "2026-09-20T23:00:50.4763079Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 5",
  "UrlName": "sample string 6",
  "ItemDefaultUrl": "sample string 7",
  "SortOrder": 8.0,
  "Title": "sample string 9",
  "Provider": "sample string 10",
  "Comments": {
    "Name": "sample string 1",
    "Message": "sample string 2",
    "DateCreated": "2026-09-20T23:00:50.4763079+00:00",
    "ProfilePictureUrl": "sample string 4",
    "ProfilePictureThumbnailUrl": "sample string 5"
  }
}

Post TppAuthors

Add TppAuthors relation to productprofiles item.

Copy POST /api/default/productprofiles({key})/TppAuthors/$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 TppAuthors

Delete set of related items of type TppAuthors from productprofiles item.

Copy DELETE /api/default/productprofiles({key})/TppAuthors/$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 TppAuthors by relatedKey

Delete relation of type TppAuthors from productprofiles item.

Copy DELETE /api/default/productprofiles({key})/TppAuthors({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.

Get Document

Returns a set of related items of type Document from productprofiles item.

Copy GET /api/default/productprofiles({key})/Document
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-09-20T23:00:50.4763079Z",
    "PublicationDate": "2026-09-20T23:00:50.4763079Z",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "DateCreated": "2026-09-20T23:00:50.4763079Z",
    "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": "e5b57b16-1b77-4cb8-a18b-d5154ca6516e",
    "targets": "384bf80e-1bd2-4cae-b1ee-1b82a2922c55",
    "regionscountries": "812ed10f-7646-4f26-b3a5-293f1b7701c3",
    "stakeholders": "538817f3-aea6-486c-bcf7-bde5916fbcc6",
    "targetaudiences": "7531db37-caef-4f5e-9b32-9a9be6c90ec9",
    "JoomlaArticleId": "sample string 20",
    "Category": "da25d038-144d-4a80-bfdd-c7d582970316",
    "Tags": "6621b0e2-372c-4696-8251-e9b4a4876f80",
    "departmentaltargets": "fb0c453b-aaab-4f8c-bbab-10fe8f68e606",
    "events": "a39d5ecd-e3f6-4ae4-8b0e-c7d557dcc89b",
    "publishingoffices": "d5bb96ee-809f-45d4-9e91-a895a42728f5",
    "Parts": "sample string 26",
    "FolderId": "78df2103-bfc0-43cd-ba3e-517edd7562a3",
    "ParentId": "4fdff175-2637-4e98-b871-955817df399f",
    "Provider": "sample string 29",
    "Url": "sample string 30",
    "ThumbnailUrl": "sample string 31",
    "IsDamMedia": true
  },
  {
    "LastModified": "2026-09-20T23:00:50.4763079Z",
    "PublicationDate": "2026-09-20T23:00:50.4763079Z",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "DateCreated": "2026-09-20T23:00:50.4763079Z",
    "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": "e5b57b16-1b77-4cb8-a18b-d5154ca6516e",
    "targets": "384bf80e-1bd2-4cae-b1ee-1b82a2922c55",
    "regionscountries": "812ed10f-7646-4f26-b3a5-293f1b7701c3",
    "stakeholders": "538817f3-aea6-486c-bcf7-bde5916fbcc6",
    "targetaudiences": "7531db37-caef-4f5e-9b32-9a9be6c90ec9",
    "JoomlaArticleId": "sample string 20",
    "Category": "da25d038-144d-4a80-bfdd-c7d582970316",
    "Tags": "6621b0e2-372c-4696-8251-e9b4a4876f80",
    "departmentaltargets": "fb0c453b-aaab-4f8c-bbab-10fe8f68e606",
    "events": "a39d5ecd-e3f6-4ae4-8b0e-c7d557dcc89b",
    "publishingoffices": "d5bb96ee-809f-45d4-9e91-a895a42728f5",
    "Parts": "sample string 26",
    "FolderId": "78df2103-bfc0-43cd-ba3e-517edd7562a3",
    "ParentId": "4fdff175-2637-4e98-b871-955817df399f",
    "Provider": "sample string 29",
    "Url": "sample string 30",
    "ThumbnailUrl": "sample string 31",
    "IsDamMedia": true
  }
]

Get Document by relatedKey

Returns a related item of type Document from productprofiles item.

Copy GET /api/default/productprofiles({key})/Document({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

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-09-20T23:00:50.4763079Z",
  "PublicationDate": "2026-09-20T23:00:50.4763079Z",
  "Title": "sample string 3",
  "Description": "sample string 4",
  "DateCreated": "2026-09-20T23:00:50.4763079Z",
  "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": "2051992e-e7e0-4b08-8d71-69ebe3d97496",
  "targets": "e0cff9c4-faaa-449f-bc32-0ce34d952af9",
  "regionscountries": "3f802894-1256-43d5-b831-53c37c4c8d3e",
  "stakeholders": "fb28344f-0a05-4eb6-a387-00f66a0f3e2e",
  "targetaudiences": "c090825a-08a3-47f0-bd4e-31bc7b435310",
  "JoomlaArticleId": "sample string 20",
  "Category": "dd4a2803-5463-41a4-aaf2-3223aed1a45e",
  "Tags": "44a90244-b3d1-40a4-9930-d68534ebb6ec",
  "departmentaltargets": "68372c36-18d1-40fb-ab81-6ce2fde1f6ad",
  "events": "9f405b9e-5cae-4faa-9ba7-523131bc08cf",
  "publishingoffices": "65622620-4185-48f2-a046-4d0a10d1ad67",
  "Parts": "sample string 26",
  "FolderId": "5d8730f4-045f-4fce-bc39-5cb8739c6873",
  "ParentId": "881f8900-cc33-43c8-babf-282cf26823e8",
  "Provider": "sample string 29",
  "Url": "sample string 30",
  "ThumbnailUrl": "sample string 31",
  "IsDamMedia": true
}

Post Document

Add Document relation to productprofiles item.

Copy POST /api/default/productprofiles({key})/Document/$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 Document

Delete set of related items of type Document from productprofiles item.

Copy DELETE /api/default/productprofiles({key})/Document/$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 Document by relatedKey

Delete relation of type Document from productprofiles item.

Copy DELETE /api/default/productprofiles({key})/Document({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.

Get TppDiseases

Returns a set of related items of type TppDiseases from productprofiles item.

Copy GET /api/default/productprofiles({key})/TppDiseases
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

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

Title

System.String

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Resource Format

Response Formats
Copy
application/json
[
  {
    "LastModified": "2026-09-20T23:00:50.4763079Z",
    "PublicationDate": "2026-09-20T23:00:50.4763079Z",
    "DateCreated": "2026-09-20T23:00:50.4763079Z",
    "IncludeInSitemap": true,
    "SystemSourceKey": "sample string 5",
    "UrlName": "sample string 6",
    "ItemDefaultUrl": "sample string 7",
    "Title": "sample string 8",
    "Provider": "sample string 9",
    "Comments": {
      "Name": "sample string 1",
      "Message": "sample string 2",
      "DateCreated": "2026-09-20T23:00:50.4763079+00:00",
      "ProfilePictureUrl": "sample string 4",
      "ProfilePictureThumbnailUrl": "sample string 5"
    }
  },
  {
    "LastModified": "2026-09-20T23:00:50.4763079Z",
    "PublicationDate": "2026-09-20T23:00:50.4763079Z",
    "DateCreated": "2026-09-20T23:00:50.4763079Z",
    "IncludeInSitemap": true,
    "SystemSourceKey": "sample string 5",
    "UrlName": "sample string 6",
    "ItemDefaultUrl": "sample string 7",
    "Title": "sample string 8",
    "Provider": "sample string 9",
    "Comments": {
      "Name": "sample string 1",
      "Message": "sample string 2",
      "DateCreated": "2026-09-20T23:00:50.4763079+00:00",
      "ProfilePictureUrl": "sample string 4",
      "ProfilePictureThumbnailUrl": "sample string 5"
    }
  }
]

Get TppDiseases by relatedKey

Returns a related item of type TppDiseases from productprofiles item.

Copy GET /api/default/productprofiles({key})/TppDiseases({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

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

Title

System.String

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Resource Format

Response Formats
Copy
application/json
{
  "LastModified": "2026-09-20T23:00:50.4763079Z",
  "PublicationDate": "2026-09-20T23:00:50.4763079Z",
  "DateCreated": "2026-09-20T23:00:50.4763079Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 5",
  "UrlName": "sample string 6",
  "ItemDefaultUrl": "sample string 7",
  "Title": "sample string 8",
  "Provider": "sample string 9",
  "Comments": {
    "Name": "sample string 1",
    "Message": "sample string 2",
    "DateCreated": "2026-09-20T23:00:50.4763079+00:00",
    "ProfilePictureUrl": "sample string 4",
    "ProfilePictureThumbnailUrl": "sample string 5"
  }
}

Post TppDiseases

Add TppDiseases relation to productprofiles item.

Copy POST /api/default/productprofiles({key})/TppDiseases/$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 TppDiseases

Delete set of related items of type TppDiseases from productprofiles item.

Copy DELETE /api/default/productprofiles({key})/TppDiseases/$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 TppDiseases by relatedKey

Delete relation of type TppDiseases from productprofiles item.

Copy DELETE /api/default/productprofiles({key})/TppDiseases({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.