API: Help texts

Linked Properties

Link Description Type Constraints Supported operations
self This help text HelpText not null READ
editText Edit the help text entry text/htm Admin READ

Local Properties

Property Description Type Constraints Supported operations
id Help text id Integer x > 0 READ
attribute Attribute name String   READ
attributeCaption Attribute caption String   READ
helpText Help text content Formattable   READ

Methods

List all help texts

No parameters

200

OK

{
  "_embedded": {
    "elements": [
      {
        "_links": {
          "self": {
            "href": "/api/v3/help_texts/1"
          }
        },
        "_type": "HelpText",
        "attribute": "id",
        "attributeCaption": "ID",
        "helpText": {
          "format": "markdown",
          "html": "<p>Help text for id attribute.</p>",
          "raw": "Help text for id attribute."
        },
        "id": 1,
        "scope": "WorkPackage"
      },
      {
        "_links": {
          "self": {
            "href": "/api/v3/help_texts/2"
          }
        },
        "_type": "HelpText",
        "attribute": "status",
        "attributeCaption": "Status",
        "helpText": {
          "format": "markdown",
          "html": "<p>Help text for status attribute.</p>",
          "raw": "Help text for status attribute."
        },
        "id": 2,
        "scope": "WorkPackage"
      }
    ]
  },
  "_links": {
    "self": {
      "href": "/api/v3/help_texts"
    }
  },
  "_type": "Collection",
  "count": 2,
  "total": 2
}

Help_textsModel

{
  "type": "object",
  "example": {
    "_links": {
      "self": {
        "href": "/api/v3/help_texts"
      }
    },
    "total": 2,
    "count": 2,
    "_type": "Collection",
    "_embedded": {
      "elements": [
        {
          "_type": "HelpText",
          "_links": {
            "self": {
              "href": "/api/v3/help_texts/1"
            }
          },
          "id": 1,
          "attribute": "id",
          "attributeCaption": "ID",
          "scope": "WorkPackage",
          "helpText": {
            "format": "markdown",
            "raw": "Help text for id attribute.",
            "html": "<p>Help text for id attribute.</p>"
          }
        },
        {
          "_type": "HelpText",
          "_links": {
            "self": {
              "href": "/api/v3/help_texts/2"
            }
          },
          "id": 2,
          "attribute": "status",
          "attributeCaption": "Status",
          "scope": "WorkPackage",
          "helpText": {
            "format": "markdown",
            "raw": "Help text for status attribute.",
            "html": "<p>Help text for status attribute.</p>"
          }
        }
      ]
    }
  }
}

View help text

id
integer

required path

Help text id

Example:
1

200

OK

{
  "_links": {
    "editText": {
      "href": "/admin/attribute_help_texts/1/edit",
      "type": "text/html"
    },
    "self": {
      "href": "/api/v3/help_texts/1"
    }
  },
  "_type": "HelpText",
  "attribute": "id",
  "attributeCaption": "ID",
  "helpText": {
    "format": "markdown",
    "html": "<p>Help text for id attribute.</p>",
    "raw": "Help text for id attribute."
  },
  "id": 1,
  "scope": "WorkPackage"
}

Help_textModel

{
  "type": "object",
  "example": {
    "_type": "HelpText",
    "_links": {
      "self": {
        "href": "/api/v3/help_texts/1"
      },
      "editText": {
        "type": "text/html",
        "href": "/admin/attribute_help_texts/1/edit"
      }
    },
    "id": 1,
    "attribute": "id",
    "attributeCaption": "ID",
    "scope": "WorkPackage",
    "helpText": {
      "format": "markdown",
      "raw": "Help text for id attribute.",
      "html": "<p>Help text for id attribute.</p>"
    }
  }
}