/topics/{id}

GET

Provides a high-level description of the topic and relevant links.

Parameters

Name Type Description
id path The ID of a topic.

Responses

200: JSON object containing information about the topic.

Example value
{
  "type": "object",
  "properties": {
    "description": {
      "description": "A description of the topic.",
      "type": "string"
    },
    "id": {
      "description": "The ID of the topic.",
      "type": "string"
    },
    "keywords": {
      "description": "List of keywords that relate to the topic.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "links": {
      "type": "object",
      "properties": {
        "content": {
          "description": "A link to the content for this topic.",
          "type": "object",
          "properties": {
            "href": {
              "description": "A URL to the content for this topic.",
              "type": "string"
            }
          }
        },
        "self": {
          "type": "object",
          "properties": {
            "href": {
              "description": "The URL to the resource.",
              "type": "string"
            },
            "id": {
              "description": "The ID of the resource.",
              "type": "string"
            }
          }
        },
        "subtopics": {
          "description": "A link to the subtopics of this topic.",
          "type": "object",
          "properties": {
            "href": {
              "description": "A URL to the subtopics of this topic.",
              "type": "string"
            }
          }
        }
      }
    },
    "slug": {
      "description": "The slug of the topic.",
      "type": "string",
      "example": "businessindustryandtrade"
    },
    "state": {
      "description": "The state of the resource.",
      "type": "string",
      "enum": [
        "created",
        "published",
        "completed"
      ]
    },
    "subtopics_ids": {
      "description": "Array of subtopic IDs.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "title": {
      "description": "The title of the topic.",
      "type": "string",
      "example": "Business, Industry and Trade"
    }
  }
}

404: The specified resource was not found.

Example value
null

500: Failed to process the request due to an internal error.

Example value
null