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

PHC Indicators

Get phcindicators

Returns a set of data items of type phcindicators.

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

PreferredDataSource

System.String

Read only: False
Selected by default: True

DisplayMetadataDialog

System.Boolean

Read only: False
Selected by default: True

Numerator

System.String

Read only: False
Selected by default: True

phcindicatorconsiderations

System.Guid

Read only: False
Selected by default: False

ExistingDataCollectionTool

System.String

Read only: False
Selected by default: True

Disaggregations

System.String

Read only: False
Selected by default: True

phcindicatortypes

System.Guid

Read only: False
Selected by default: False

Denominator

System.String

Read only: False
Selected by default: True

LongName

System.String

Read only: False
Selected by default: True

phccomponents

System.Guid

Read only: False
Selected by default: False

IndicatorName

System.String

Read only: False
Selected by default: True

Rationale

System.String

Read only: False
Selected by default: True

ShortName

System.String

Read only: False
Selected by default: True

Order

System.Decimal

Read only: False
Selected by default: True

References

System.String

Read only: False
Selected by default: True

Definition

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-11-11T10:11:36.0773495Z",
    "PublicationDate": "2026-11-11T10:11:36.0773495Z",
    "DateCreated": "2026-11-11T10:11:36.0773495Z",
    "IncludeInSitemap": true,
    "SystemSourceKey": "sample string 5",
    "UrlName": "sample string 6",
    "ItemDefaultUrl": "sample string 7",
    "PreferredDataSource": "sample string 8",
    "DisplayMetadataDialog": true,
    "Numerator": "sample string 10",
    "phcindicatorconsiderations": "ad649d8b-6af1-4b7f-aa1b-2b73ae52e211",
    "ExistingDataCollectionTool": "sample string 12",
    "Disaggregations": "sample string 13",
    "phcindicatortypes": "456fac62-6857-42a0-b02d-c4da07042064",
    "Denominator": "sample string 15",
    "LongName": "sample string 16",
    "phccomponents": "2a7f4832-42d6-40fa-9a36-0e0e90f51369",
    "IndicatorName": "sample string 18",
    "Rationale": "sample string 19",
    "ShortName": "sample string 20",
    "Order": 21.0,
    "References": "sample string 22",
    "Definition": "sample string 23",
    "Provider": "sample string 24",
    "Comments": {
      "Name": "sample string 1",
      "Message": "sample string 2",
      "DateCreated": "2026-11-11T10:11:36.0773495+00:00",
      "ProfilePictureUrl": "sample string 4",
      "ProfilePictureThumbnailUrl": "sample string 5"
    }
  },
  {
    "LastModified": "2026-11-11T10:11:36.0773495Z",
    "PublicationDate": "2026-11-11T10:11:36.0773495Z",
    "DateCreated": "2026-11-11T10:11:36.0773495Z",
    "IncludeInSitemap": true,
    "SystemSourceKey": "sample string 5",
    "UrlName": "sample string 6",
    "ItemDefaultUrl": "sample string 7",
    "PreferredDataSource": "sample string 8",
    "DisplayMetadataDialog": true,
    "Numerator": "sample string 10",
    "phcindicatorconsiderations": "ad649d8b-6af1-4b7f-aa1b-2b73ae52e211",
    "ExistingDataCollectionTool": "sample string 12",
    "Disaggregations": "sample string 13",
    "phcindicatortypes": "456fac62-6857-42a0-b02d-c4da07042064",
    "Denominator": "sample string 15",
    "LongName": "sample string 16",
    "phccomponents": "2a7f4832-42d6-40fa-9a36-0e0e90f51369",
    "IndicatorName": "sample string 18",
    "Rationale": "sample string 19",
    "ShortName": "sample string 20",
    "Order": 21.0,
    "References": "sample string 22",
    "Definition": "sample string 23",
    "Provider": "sample string 24",
    "Comments": {
      "Name": "sample string 1",
      "Message": "sample string 2",
      "DateCreated": "2026-11-11T10:11:36.0773495+00:00",
      "ProfilePictureUrl": "sample string 4",
      "ProfilePictureThumbnailUrl": "sample string 5"
    }
  }
]

Get phcindicators by key

Gets phcindicators item by id.

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

PreferredDataSource

System.String

Read only: False
Selected by default: True

DisplayMetadataDialog

System.Boolean

Read only: False
Selected by default: True

Numerator

System.String

Read only: False
Selected by default: True

phcindicatorconsiderations

System.Guid

Read only: False
Selected by default: False

ExistingDataCollectionTool

System.String

Read only: False
Selected by default: True

Disaggregations

System.String

Read only: False
Selected by default: True

phcindicatortypes

System.Guid

Read only: False
Selected by default: False

Denominator

System.String

Read only: False
Selected by default: True

LongName

System.String

Read only: False
Selected by default: True

phccomponents

System.Guid

Read only: False
Selected by default: False

IndicatorName

System.String

Read only: False
Selected by default: True

Rationale

System.String

Read only: False
Selected by default: True

ShortName

System.String

Read only: False
Selected by default: True

Order

System.Decimal

Read only: False
Selected by default: True

References

System.String

Read only: False
Selected by default: True

Definition

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-11-11T10:11:36.0773495Z",
  "PublicationDate": "2026-11-11T10:11:36.0773495Z",
  "DateCreated": "2026-11-11T10:11:36.0773495Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 5",
  "UrlName": "sample string 6",
  "ItemDefaultUrl": "sample string 7",
  "PreferredDataSource": "sample string 8",
  "DisplayMetadataDialog": true,
  "Numerator": "sample string 10",
  "phcindicatorconsiderations": "1075a396-ddc9-4ff2-bd91-140beb9fc24b",
  "ExistingDataCollectionTool": "sample string 12",
  "Disaggregations": "sample string 13",
  "phcindicatortypes": "1a65a197-2aad-40d1-955c-b67e8b7eff5c",
  "Denominator": "sample string 15",
  "LongName": "sample string 16",
  "phccomponents": "fc98f763-aeea-4d10-b10d-1b3013e13008",
  "IndicatorName": "sample string 18",
  "Rationale": "sample string 19",
  "ShortName": "sample string 20",
  "Order": 21.0,
  "References": "sample string 22",
  "Definition": "sample string 23",
  "Provider": "sample string 24",
  "Comments": {
    "Name": "sample string 1",
    "Message": "sample string 2",
    "DateCreated": "2026-11-11T10:11:36.0773495+00:00",
    "ProfilePictureUrl": "sample string 4",
    "ProfilePictureThumbnailUrl": "sample string 5"
  }
}

Get property

Gets Id property from phcindicators item.

Copy GET /api/default/phcindicators({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": "5ba97edd-ed60-4f53-80dd-ba7d45023352"
}

Post phcindicators

Creates a phcindicators item.

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

PreferredDataSource

System.String

Read only: False
Selected by default: True

DisplayMetadataDialog

System.Boolean

Read only: False
Selected by default: True

Numerator

System.String

Read only: False
Selected by default: True

phcindicatorconsiderations

System.Guid

Read only: False
Selected by default: False

ExistingDataCollectionTool

System.String

Read only: False
Selected by default: True

Disaggregations

System.String

Read only: False
Selected by default: True

phcindicatortypes

System.Guid

Read only: False
Selected by default: False

Denominator

System.String

Read only: False
Selected by default: True

LongName

System.String

Read only: False
Selected by default: True

phccomponents

System.Guid

Read only: False
Selected by default: False

IndicatorName

System.String

Read only: False
Selected by default: True

Rationale

System.String

Read only: False
Selected by default: True

ShortName

System.String

Read only: False
Selected by default: True

Order

System.Decimal

Read only: False
Selected by default: True

References

System.String

Read only: False
Selected by default: True

Definition

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

Request Formats
Copy
application/json
{
  "PublicationDate": "2026-11-11T10:11:36.0773495Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 3",
  "UrlName": "sample string 4",
  "PreferredDataSource": "sample string 5",
  "DisplayMetadataDialog": true,
  "Numerator": "sample string 7",
  "phcindicatorconsiderations": "308200e1-2584-4930-9bd4-d12bb57ea7db",
  "ExistingDataCollectionTool": "sample string 9",
  "Disaggregations": "sample string 10",
  "phcindicatortypes": "02cd4020-63e9-4b79-b1fd-b474971f51fe",
  "Denominator": "sample string 12",
  "LongName": "sample string 13",
  "phccomponents": "2a067383-90dc-4975-a798-19047e075a45",
  "IndicatorName": "sample string 15",
  "Rationale": "sample string 16",
  "ShortName": "sample string 17",
  "Order": 18.0,
  "References": "sample string 19",
  "Definition": "sample string 20"
}
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

PreferredDataSource

System.String

Read only: False
Selected by default: True

DisplayMetadataDialog

System.Boolean

Read only: False
Selected by default: True

Numerator

System.String

Read only: False
Selected by default: True

phcindicatorconsiderations

System.Guid

Read only: False
Selected by default: False

ExistingDataCollectionTool

System.String

Read only: False
Selected by default: True

Disaggregations

System.String

Read only: False
Selected by default: True

phcindicatortypes

System.Guid

Read only: False
Selected by default: False

Denominator

System.String

Read only: False
Selected by default: True

LongName

System.String

Read only: False
Selected by default: True

phccomponents

System.Guid

Read only: False
Selected by default: False

IndicatorName

System.String

Read only: False
Selected by default: True

Rationale

System.String

Read only: False
Selected by default: True

ShortName

System.String

Read only: False
Selected by default: True

Order

System.Decimal

Read only: False
Selected by default: True

References

System.String

Read only: False
Selected by default: True

Definition

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-11-11T10:11:36.0773495Z",
  "PublicationDate": "2026-11-11T10:11:36.0773495Z",
  "DateCreated": "2026-11-11T10:11:36.0773495Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 5",
  "UrlName": "sample string 6",
  "ItemDefaultUrl": "sample string 7",
  "PreferredDataSource": "sample string 8",
  "DisplayMetadataDialog": true,
  "Numerator": "sample string 10",
  "phcindicatorconsiderations": "94e444df-eb9f-4e65-8f41-efd4425946e5",
  "ExistingDataCollectionTool": "sample string 12",
  "Disaggregations": "sample string 13",
  "phcindicatortypes": "ef4f1e1d-b995-4a6c-935a-fb615df88716",
  "Denominator": "sample string 15",
  "LongName": "sample string 16",
  "phccomponents": "1ec85250-bb6d-46a1-82dd-e2b83851e66c",
  "IndicatorName": "sample string 18",
  "Rationale": "sample string 19",
  "ShortName": "sample string 20",
  "Order": 21.0,
  "References": "sample string 22",
  "Definition": "sample string 23",
  "Provider": "sample string 24",
  "Comments": {
    "Name": "sample string 1",
    "Message": "sample string 2",
    "DateCreated": "2026-11-11T10:11:36.0773495+00:00",
    "ProfilePictureUrl": "sample string 4",
    "ProfilePictureThumbnailUrl": "sample string 5"
  }
}

Patch phcindicators by key

Partial update for phcindicators item.

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

PreferredDataSource

System.String

Read only: False
Selected by default: True

DisplayMetadataDialog

System.Boolean

Read only: False
Selected by default: True

Numerator

System.String

Read only: False
Selected by default: True

phcindicatorconsiderations

System.Guid

Read only: False
Selected by default: False

ExistingDataCollectionTool

System.String

Read only: False
Selected by default: True

Disaggregations

System.String

Read only: False
Selected by default: True

phcindicatortypes

System.Guid

Read only: False
Selected by default: False

Denominator

System.String

Read only: False
Selected by default: True

LongName

System.String

Read only: False
Selected by default: True

phccomponents

System.Guid

Read only: False
Selected by default: False

IndicatorName

System.String

Read only: False
Selected by default: True

Rationale

System.String

Read only: False
Selected by default: True

ShortName

System.String

Read only: False
Selected by default: True

Order

System.Decimal

Read only: False
Selected by default: True

References

System.String

Read only: False
Selected by default: True

Definition

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

Request Formats
Copy
application/json
{
  "PublicationDate": "2026-11-11T10:11:36.0773495Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 3",
  "UrlName": "sample string 4",
  "PreferredDataSource": "sample string 5",
  "DisplayMetadataDialog": true,
  "Numerator": "sample string 7",
  "phcindicatorconsiderations": "74211410-f14b-4d1a-9b10-aad46813e795",
  "ExistingDataCollectionTool": "sample string 9",
  "Disaggregations": "sample string 10",
  "phcindicatortypes": "beb89176-7774-4ec4-bf0c-679fd885039e",
  "Denominator": "sample string 12",
  "LongName": "sample string 13",
  "phccomponents": "100101dc-3612-4a24-98ed-4fa5debae24d",
  "IndicatorName": "sample string 15",
  "Rationale": "sample string 16",
  "ShortName": "sample string 17",
  "Order": 18.0,
  "References": "sample string 19",
  "Definition": "sample string 20"
}
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 phcindicators by key

Full update for phcindicators item.

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

PreferredDataSource

System.String

Read only: False
Selected by default: True

DisplayMetadataDialog

System.Boolean

Read only: False
Selected by default: True

Numerator

System.String

Read only: False
Selected by default: True

phcindicatorconsiderations

System.Guid

Read only: False
Selected by default: False

ExistingDataCollectionTool

System.String

Read only: False
Selected by default: True

Disaggregations

System.String

Read only: False
Selected by default: True

phcindicatortypes

System.Guid

Read only: False
Selected by default: False

Denominator

System.String

Read only: False
Selected by default: True

LongName

System.String

Read only: False
Selected by default: True

phccomponents

System.Guid

Read only: False
Selected by default: False

IndicatorName

System.String

Read only: False
Selected by default: True

Rationale

System.String

Read only: False
Selected by default: True

ShortName

System.String

Read only: False
Selected by default: True

Order

System.Decimal

Read only: False
Selected by default: True

References

System.String

Read only: False
Selected by default: True

Definition

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

Request Formats
Copy
application/json
{
  "PublicationDate": "2026-11-11T10:11:36.0773495Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 3",
  "UrlName": "sample string 4",
  "PreferredDataSource": "sample string 5",
  "DisplayMetadataDialog": true,
  "Numerator": "sample string 7",
  "phcindicatorconsiderations": "074d40e1-f2a1-4bfc-832e-d1dc692f2e2d",
  "ExistingDataCollectionTool": "sample string 9",
  "Disaggregations": "sample string 10",
  "phcindicatortypes": "5d4bcf4d-dc10-4fec-8646-a2bb07fc05dc",
  "Denominator": "sample string 12",
  "LongName": "sample string 13",
  "phccomponents": "4fdbd65d-d267-47fa-ab88-b1f2b9089617",
  "IndicatorName": "sample string 15",
  "Rationale": "sample string 16",
  "ShortName": "sample string 17",
  "Order": 18.0,
  "References": "sample string 19",
  "Definition": "sample string 20"
}
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 phcindicators by key

Deletes a phcindicators item by Id.

Copy DELETE /api/default/phcindicators({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 Subindicators

Returns a set of related items of type Subindicators from phcindicators item.

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

PreferredDataSource

System.String

Read only: False
Selected by default: True

DisplayMetadataDialog

System.Boolean

Read only: False
Selected by default: True

Numerator

System.String

Read only: False
Selected by default: True

phcindicatorconsiderations

System.Guid

Read only: False
Selected by default: False

ExistingDataCollectionTool

System.String

Read only: False
Selected by default: True

Disaggregations

System.String

Read only: False
Selected by default: True

phcindicatortypes

System.Guid

Read only: False
Selected by default: False

Denominator

System.String

Read only: False
Selected by default: True

LongName

System.String

Read only: False
Selected by default: True

phccomponents

System.Guid

Read only: False
Selected by default: False

IndicatorName

System.String

Read only: False
Selected by default: True

Rationale

System.String

Read only: False
Selected by default: True

ShortName

System.String

Read only: False
Selected by default: True

Order

System.Decimal

Read only: False
Selected by default: True

References

System.String

Read only: False
Selected by default: True

Definition

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-11-11T10:11:36.0773495Z",
    "PublicationDate": "2026-11-11T10:11:36.0773495Z",
    "DateCreated": "2026-11-11T10:11:36.0773495Z",
    "IncludeInSitemap": true,
    "SystemSourceKey": "sample string 5",
    "UrlName": "sample string 6",
    "ItemDefaultUrl": "sample string 7",
    "PreferredDataSource": "sample string 8",
    "DisplayMetadataDialog": true,
    "Numerator": "sample string 10",
    "phcindicatorconsiderations": "d0dd539b-8601-4c24-b1b6-c7fe19581978",
    "ExistingDataCollectionTool": "sample string 12",
    "Disaggregations": "sample string 13",
    "phcindicatortypes": "799ce8ce-916d-446e-9c18-9590db36183f",
    "Denominator": "sample string 15",
    "LongName": "sample string 16",
    "phccomponents": "342a0f10-0fb2-4327-b5d7-5e18758d9741",
    "IndicatorName": "sample string 18",
    "Rationale": "sample string 19",
    "ShortName": "sample string 20",
    "Order": 21.0,
    "References": "sample string 22",
    "Definition": "sample string 23",
    "Provider": "sample string 24",
    "Comments": {
      "Name": "sample string 1",
      "Message": "sample string 2",
      "DateCreated": "2026-11-11T10:11:36.0773495+00:00",
      "ProfilePictureUrl": "sample string 4",
      "ProfilePictureThumbnailUrl": "sample string 5"
    }
  },
  {
    "LastModified": "2026-11-11T10:11:36.0773495Z",
    "PublicationDate": "2026-11-11T10:11:36.0773495Z",
    "DateCreated": "2026-11-11T10:11:36.0773495Z",
    "IncludeInSitemap": true,
    "SystemSourceKey": "sample string 5",
    "UrlName": "sample string 6",
    "ItemDefaultUrl": "sample string 7",
    "PreferredDataSource": "sample string 8",
    "DisplayMetadataDialog": true,
    "Numerator": "sample string 10",
    "phcindicatorconsiderations": "d0dd539b-8601-4c24-b1b6-c7fe19581978",
    "ExistingDataCollectionTool": "sample string 12",
    "Disaggregations": "sample string 13",
    "phcindicatortypes": "799ce8ce-916d-446e-9c18-9590db36183f",
    "Denominator": "sample string 15",
    "LongName": "sample string 16",
    "phccomponents": "342a0f10-0fb2-4327-b5d7-5e18758d9741",
    "IndicatorName": "sample string 18",
    "Rationale": "sample string 19",
    "ShortName": "sample string 20",
    "Order": 21.0,
    "References": "sample string 22",
    "Definition": "sample string 23",
    "Provider": "sample string 24",
    "Comments": {
      "Name": "sample string 1",
      "Message": "sample string 2",
      "DateCreated": "2026-11-11T10:11:36.0773495+00:00",
      "ProfilePictureUrl": "sample string 4",
      "ProfilePictureThumbnailUrl": "sample string 5"
    }
  }
]

Get Subindicators by relatedKey

Returns a related item of type Subindicators from phcindicators item.

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

PreferredDataSource

System.String

Read only: False
Selected by default: True

DisplayMetadataDialog

System.Boolean

Read only: False
Selected by default: True

Numerator

System.String

Read only: False
Selected by default: True

phcindicatorconsiderations

System.Guid

Read only: False
Selected by default: False

ExistingDataCollectionTool

System.String

Read only: False
Selected by default: True

Disaggregations

System.String

Read only: False
Selected by default: True

phcindicatortypes

System.Guid

Read only: False
Selected by default: False

Denominator

System.String

Read only: False
Selected by default: True

LongName

System.String

Read only: False
Selected by default: True

phccomponents

System.Guid

Read only: False
Selected by default: False

IndicatorName

System.String

Read only: False
Selected by default: True

Rationale

System.String

Read only: False
Selected by default: True

ShortName

System.String

Read only: False
Selected by default: True

Order

System.Decimal

Read only: False
Selected by default: True

References

System.String

Read only: False
Selected by default: True

Definition

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-11-11T10:11:36.0773495Z",
  "PublicationDate": "2026-11-11T10:11:36.0773495Z",
  "DateCreated": "2026-11-11T10:11:36.0773495Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 5",
  "UrlName": "sample string 6",
  "ItemDefaultUrl": "sample string 7",
  "PreferredDataSource": "sample string 8",
  "DisplayMetadataDialog": true,
  "Numerator": "sample string 10",
  "phcindicatorconsiderations": "fa6c37ee-9d3d-4cc1-bf69-fcce28c8c4df",
  "ExistingDataCollectionTool": "sample string 12",
  "Disaggregations": "sample string 13",
  "phcindicatortypes": "6c6ab4d0-5710-45a3-af9c-76d2a6a897e1",
  "Denominator": "sample string 15",
  "LongName": "sample string 16",
  "phccomponents": "bde2b70e-071c-4961-bb64-cf33f525a3f8",
  "IndicatorName": "sample string 18",
  "Rationale": "sample string 19",
  "ShortName": "sample string 20",
  "Order": 21.0,
  "References": "sample string 22",
  "Definition": "sample string 23",
  "Provider": "sample string 24",
  "Comments": {
    "Name": "sample string 1",
    "Message": "sample string 2",
    "DateCreated": "2026-11-11T10:11:36.0773495+00:00",
    "ProfilePictureUrl": "sample string 4",
    "ProfilePictureThumbnailUrl": "sample string 5"
  }
}

Post Subindicators

Add Subindicators relation to phcindicators item.

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

Delete set of related items of type Subindicators from phcindicators item.

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

Delete relation of type Subindicators from phcindicators item.

Copy DELETE /api/default/phcindicators({key})/Subindicators({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 MetadataFile

Returns a set of related items of type MetadataFile from phcindicators item.

Copy GET /api/default/phcindicators({key})/MetadataFile
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-11-11T10:11:36.0773495Z",
    "PublicationDate": "2026-11-11T10:11:36.0773495Z",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "DateCreated": "2026-11-11T10:11:36.0773495Z",
    "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": "408f5462-052f-4387-9428-1ab75795640d",
    "targets": "2fb9ad77-d733-408d-99a5-034466d5a1ca",
    "regionscountries": "53a817fb-1119-476d-a9c3-0f3f4672d425",
    "stakeholders": "c0dd4a22-12e9-48ab-bbad-9125d2a129e4",
    "targetaudiences": "ae6c6daf-f225-42cc-9c35-1603fa23f5e5",
    "JoomlaArticleId": "sample string 20",
    "Category": "c5e995c5-4812-45fe-9bea-713782945218",
    "Tags": "bd5b571e-03dd-4fec-b5ea-e4f667488edf",
    "departmentaltargets": "f8a2788f-3c91-4042-bd9a-34b34cc556aa",
    "events": "813d79a9-e4c7-428c-b288-9400ee45ba63",
    "publishingoffices": "569989f8-7892-41e7-b110-4248452e461d",
    "Parts": "sample string 26",
    "FolderId": "32fe5791-1f85-4fec-b8a1-456bdf89ac4b",
    "ParentId": "f1b3626d-2559-4a2f-b9ca-7d275fd08be6",
    "Provider": "sample string 29",
    "Url": "sample string 30",
    "ThumbnailUrl": "sample string 31",
    "IsDamMedia": true
  },
  {
    "LastModified": "2026-11-11T10:11:36.0773495Z",
    "PublicationDate": "2026-11-11T10:11:36.0773495Z",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "DateCreated": "2026-11-11T10:11:36.0773495Z",
    "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": "408f5462-052f-4387-9428-1ab75795640d",
    "targets": "2fb9ad77-d733-408d-99a5-034466d5a1ca",
    "regionscountries": "53a817fb-1119-476d-a9c3-0f3f4672d425",
    "stakeholders": "c0dd4a22-12e9-48ab-bbad-9125d2a129e4",
    "targetaudiences": "ae6c6daf-f225-42cc-9c35-1603fa23f5e5",
    "JoomlaArticleId": "sample string 20",
    "Category": "c5e995c5-4812-45fe-9bea-713782945218",
    "Tags": "bd5b571e-03dd-4fec-b5ea-e4f667488edf",
    "departmentaltargets": "f8a2788f-3c91-4042-bd9a-34b34cc556aa",
    "events": "813d79a9-e4c7-428c-b288-9400ee45ba63",
    "publishingoffices": "569989f8-7892-41e7-b110-4248452e461d",
    "Parts": "sample string 26",
    "FolderId": "32fe5791-1f85-4fec-b8a1-456bdf89ac4b",
    "ParentId": "f1b3626d-2559-4a2f-b9ca-7d275fd08be6",
    "Provider": "sample string 29",
    "Url": "sample string 30",
    "ThumbnailUrl": "sample string 31",
    "IsDamMedia": true
  }
]

Get MetadataFile by relatedKey

Returns a related item of type MetadataFile from phcindicators item.

Copy GET /api/default/phcindicators({key})/MetadataFile({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-11-11T10:11:36.0799486Z",
  "PublicationDate": "2026-11-11T10:11:36.0799486Z",
  "Title": "sample string 3",
  "Description": "sample string 4",
  "DateCreated": "2026-11-11T10:11:36.0799486Z",
  "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": "3458e048-b648-4b3a-9e23-9df90a44c447",
  "targets": "0d5b3047-cc07-4425-b628-61c48705f07d",
  "regionscountries": "0019a0ad-7849-45a7-83e5-46fb18517c36",
  "stakeholders": "cf253b7c-7f2a-4dac-ac1a-47fa056bd459",
  "targetaudiences": "e3dc23cb-8c8a-47d6-80ba-ad4c22e9fda3",
  "JoomlaArticleId": "sample string 20",
  "Category": "a6dcde12-8af0-405c-933d-3420aeb08480",
  "Tags": "794cf397-2590-4205-aa71-ccd8473c3e17",
  "departmentaltargets": "d9217677-0cb1-4085-962e-cd49ec208f27",
  "events": "25bc454e-2292-4ca4-8770-cbd9c0b52169",
  "publishingoffices": "00b8261e-a1f3-413a-987c-8fc054697a59",
  "Parts": "sample string 26",
  "FolderId": "77ee29a2-1825-4d66-9e27-34cd1b80b783",
  "ParentId": "88ab9585-1267-4e98-9a23-1890eb82fd78",
  "Provider": "sample string 29",
  "Url": "sample string 30",
  "ThumbnailUrl": "sample string 31",
  "IsDamMedia": true
}

Post MetadataFile

Add MetadataFile relation to phcindicators item.

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

Delete set of related items of type MetadataFile from phcindicators item.

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

Delete relation of type MetadataFile from phcindicators item.

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