POST v1/Topic/Update

Updates the Topic

Roles Allowed

admin, editor

Request Information

URI Parameters

None.

Body Parameters

Topic
NameDescriptionTypeAdditional information
TopicId

integer

None.

Name

string

None.

Description

string

None.

TopicTypeId

integer

None.

ImageUrl

string

None.

Updated

date

None.

UpdatedBy

integer

None.

Slug

string

None.

TopicModules

Collection of TopicModule

None.

TopicRelationships

Collection of TopicRelationship

None.

TopicType

TopicType

None.

Request Formats

application/json, text/json

Sample:
{
  "TopicId": 1,
  "Name": "sample string 2",
  "Description": "sample string 3",
  "TopicTypeId": 4,
  "ImageUrl": "sample string 5",
  "Updated": "2024-10-31T10:38:07.8803668+00:00",
  "UpdatedBy": 7,
  "Slug": "sample string 8",
  "TopicModules": [
    {
      "TopicModuleId": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "TopicId": 4,
      "LayoutType": 1,
      "MaxSize": 1,
      "Active": true,
      "Sequence": 1,
      "Updated": "2024-10-31T10:38:07.8803668+00:00",
      "UpdatedBy": 6,
      "TopicModuleArticles": [
        {
          "TopicModuleId": 1,
          "ArticleKey": 2,
          "Sequence": 1,
          "Updated": "2024-10-31T10:38:07.8803668+00:00",
          "UpdatedBy": 4,
          "IssueKey": 5,
          "CoverDate": "2024-10-31T10:38:07.8803668+00:00",
          "Title": "sample string 7",
          "StartingPageName": "sample string 8",
          "NewSequence": 1
        },
        {
          "TopicModuleId": 1,
          "ArticleKey": 2,
          "Sequence": 1,
          "Updated": "2024-10-31T10:38:07.8803668+00:00",
          "UpdatedBy": 4,
          "IssueKey": 5,
          "CoverDate": "2024-10-31T10:38:07.8803668+00:00",
          "Title": "sample string 7",
          "StartingPageName": "sample string 8",
          "NewSequence": 1
        }
      ]
    },
    {
      "TopicModuleId": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "TopicId": 4,
      "LayoutType": 1,
      "MaxSize": 1,
      "Active": true,
      "Sequence": 1,
      "Updated": "2024-10-31T10:38:07.8803668+00:00",
      "UpdatedBy": 6,
      "TopicModuleArticles": [
        {
          "TopicModuleId": 1,
          "ArticleKey": 2,
          "Sequence": 1,
          "Updated": "2024-10-31T10:38:07.8803668+00:00",
          "UpdatedBy": 4,
          "IssueKey": 5,
          "CoverDate": "2024-10-31T10:38:07.8803668+00:00",
          "Title": "sample string 7",
          "StartingPageName": "sample string 8",
          "NewSequence": 1
        },
        {
          "TopicModuleId": 1,
          "ArticleKey": 2,
          "Sequence": 1,
          "Updated": "2024-10-31T10:38:07.8803668+00:00",
          "UpdatedBy": 4,
          "IssueKey": 5,
          "CoverDate": "2024-10-31T10:38:07.8803668+00:00",
          "Title": "sample string 7",
          "StartingPageName": "sample string 8",
          "NewSequence": 1
        }
      ]
    }
  ],
  "TopicRelationships": [
    {
      "TopicRelationshipId": 1,
      "TopicId": 2,
      "ObjectKey": 3,
      "ObjectTypeId": 4,
      "Updated": "2024-10-31T10:38:07.8803668+00:00",
      "UpdatedBy": 6,
      "TopicObjectType": {
        "ObjectTypeId": 1,
        "Name": "sample string 2",
        "Description": "sample string 3",
        "TopicRelationships": []
      }
    },
    {
      "TopicRelationshipId": 1,
      "TopicId": 2,
      "ObjectKey": 3,
      "ObjectTypeId": 4,
      "Updated": "2024-10-31T10:38:07.8803668+00:00",
      "UpdatedBy": 6,
      "TopicObjectType": {
        "ObjectTypeId": 1,
        "Name": "sample string 2",
        "Description": "sample string 3",
        "TopicRelationships": []
      }
    }
  ],
  "TopicType": {
    "TopicTypeId": 1,
    "Name": "sample string 2",
    "Description": "sample string 3",
    "Updated": "2024-10-31T10:38:07.8803668+00:00",
    "UpdatedBy": 5,
    "Topics": []
  }
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HTTP 200 with the topic if it is found, HTTP 404 if topic is not found

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.