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

Characters

Get characters

Returns a set of data items of type characters.

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

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-11-11T10:11:44.5233149Z",
    "PublicationDate": "2026-11-11T10:11:44.5233149Z",
    "DateCreated": "2026-11-11T10:11:44.5233149Z",
    "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-11-11T10:11:44.5233149+00:00",
      "ProfilePictureUrl": "sample string 4",
      "ProfilePictureThumbnailUrl": "sample string 5"
    }
  },
  {
    "LastModified": "2026-11-11T10:11:44.5233149Z",
    "PublicationDate": "2026-11-11T10:11:44.5233149Z",
    "DateCreated": "2026-11-11T10:11:44.5233149Z",
    "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-11-11T10:11:44.5233149+00:00",
      "ProfilePictureUrl": "sample string 4",
      "ProfilePictureThumbnailUrl": "sample string 5"
    }
  }
]

Get characters by key

Gets characters item by id.

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

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-11-11T10:11:44.5233149Z",
  "PublicationDate": "2026-11-11T10:11:44.5233149Z",
  "DateCreated": "2026-11-11T10:11:44.5233149Z",
  "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-11-11T10:11:44.5233149+00:00",
    "ProfilePictureUrl": "sample string 4",
    "ProfilePictureThumbnailUrl": "sample string 5"
  }
}

Get property

Gets Id property from characters item.

Copy GET /api/default/characters({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": "ad107264-4bc2-4e05-bd2f-8e36422937bf"
}

Post characters

Creates a characters item.

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

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

Request Formats
Copy
application/json
{
  "PublicationDate": "2026-11-11T10:11:44.5233149Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 3",
  "UrlName": "sample string 4",
  "Title": "sample string 5"
}
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

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-11-11T10:11:44.5233149Z",
  "PublicationDate": "2026-11-11T10:11:44.5233149Z",
  "DateCreated": "2026-11-11T10:11:44.5233149Z",
  "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-11-11T10:11:44.5233149+00:00",
    "ProfilePictureUrl": "sample string 4",
    "ProfilePictureThumbnailUrl": "sample string 5"
  }
}

Patch characters by key

Partial update for characters item.

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

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

Request Formats
Copy
application/json
{
  "PublicationDate": "2026-11-11T10:11:44.5233149Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 3",
  "UrlName": "sample string 4",
  "Title": "sample string 5"
}
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 characters by key

Full update for characters item.

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

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

Request Formats
Copy
application/json
{
  "PublicationDate": "2026-11-11T10:11:44.5233149Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 3",
  "UrlName": "sample string 4",
  "Title": "sample string 5"
}
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 characters by key

Deletes a characters item by Id.

Copy DELETE /api/default/characters({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 Image

Returns a set of related items of type Image from characters item.

Copy GET /api/default/characters({key})/Image
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-11-11T10:11:44.5233149Z",
    "PublicationDate": "2026-11-11T10:11:44.5233149Z",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "DateCreated": "2026-11-11T10:11:44.5233149Z",
    "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": "f9e9ef24-6b65-4f32-804e-3ce5637bad84",
    "publishingoffices": "da41fb1d-2253-4c00-8aff-65fd9d3eba1f",
    "events": "5439aced-8bed-4882-ac5d-0820e6756e12",
    "targets": "539f2863-03a4-493b-bd1d-4ec6b33bf25c",
    "Category": "49ae06fb-741c-472d-844f-bf0292b60a77",
    "imagetypes": "f962de47-7248-441e-85a5-fdc972899d07",
    "JoomlaArticleId": "sample string 21",
    "departmentaltargets": "783f53ca-1aaf-425b-a365-15836fa200ce",
    "stakeholders": "409c197f-54af-4e40-bc37-4a4fd4671d3d",
    "Tags": "a85c68a9-4d84-418f-a26d-10626e269964",
    "healthtopics": "6bc91876-687e-468d-ab45-da62365fc06e",
    "targetaudiences": "3f185810-f990-452d-9699-6572c1225767",
    "IsOptimized": true,
    "OptImgStatus": "sample string 28",
    "Width": 29,
    "Height": 30,
    "AlternativeText": "sample string 31",
    "FolderId": "d2a56bbc-1d4e-4d38-8c0b-347b0e496a72",
    "ParentId": "e5034f6f-fa68-4cbe-afb6-06ba71d007fb",
    "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-11-11T10:11:44.5233149Z",
    "PublicationDate": "2026-11-11T10:11:44.5233149Z",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "DateCreated": "2026-11-11T10:11:44.5233149Z",
    "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": "f9e9ef24-6b65-4f32-804e-3ce5637bad84",
    "publishingoffices": "da41fb1d-2253-4c00-8aff-65fd9d3eba1f",
    "events": "5439aced-8bed-4882-ac5d-0820e6756e12",
    "targets": "539f2863-03a4-493b-bd1d-4ec6b33bf25c",
    "Category": "49ae06fb-741c-472d-844f-bf0292b60a77",
    "imagetypes": "f962de47-7248-441e-85a5-fdc972899d07",
    "JoomlaArticleId": "sample string 21",
    "departmentaltargets": "783f53ca-1aaf-425b-a365-15836fa200ce",
    "stakeholders": "409c197f-54af-4e40-bc37-4a4fd4671d3d",
    "Tags": "a85c68a9-4d84-418f-a26d-10626e269964",
    "healthtopics": "6bc91876-687e-468d-ab45-da62365fc06e",
    "targetaudiences": "3f185810-f990-452d-9699-6572c1225767",
    "IsOptimized": true,
    "OptImgStatus": "sample string 28",
    "Width": 29,
    "Height": 30,
    "AlternativeText": "sample string 31",
    "FolderId": "d2a56bbc-1d4e-4d38-8c0b-347b0e496a72",
    "ParentId": "e5034f6f-fa68-4cbe-afb6-06ba71d007fb",
    "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 Image by relatedKey

Returns a related item of type Image from characters item.

Copy GET /api/default/characters({key})/Image({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-11-11T10:11:44.5233149Z",
  "PublicationDate": "2026-11-11T10:11:44.5233149Z",
  "Title": "sample string 3",
  "Description": "sample string 4",
  "DateCreated": "2026-11-11T10:11:44.5233149Z",
  "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": "41a1b7bc-a3ee-4c35-8dad-5a9620bf8031",
  "publishingoffices": "08b0706b-4dcb-4379-a986-a18e31ba6621",
  "events": "f1f8b0f3-2bee-4671-b5f8-46ed739fc5b6",
  "targets": "eda824d5-c4b7-4f24-b911-9215dcb4a97f",
  "Category": "29d2a704-a594-4c30-9254-120fc2298f71",
  "imagetypes": "3342c590-7310-468a-acc2-80be85885a82",
  "JoomlaArticleId": "sample string 21",
  "departmentaltargets": "227db209-c06a-44f4-af2a-2c549a817907",
  "stakeholders": "dfe3581f-09fb-4014-9bf7-aea1bb6fbe8c",
  "Tags": "2e345ecc-54fa-4c0e-a5fe-6918d67f1a32",
  "healthtopics": "75831de1-d339-47cb-b082-e2a4c1483ae9",
  "targetaudiences": "6bcc99f7-31eb-47d1-93e5-3ade8f262e07",
  "IsOptimized": true,
  "OptImgStatus": "sample string 28",
  "Width": 29,
  "Height": 30,
  "AlternativeText": "sample string 31",
  "FolderId": "462cfffa-fffa-420b-8dd7-91a423e89c22",
  "ParentId": "580d0f52-162d-4751-8c49-304df33c5da9",
  "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 Image

Add Image relation to characters item.

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

Delete set of related items of type Image from characters item.

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

Delete relation of type Image from characters item.

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