stories

Get a story by the story ID

Returns success

get/projects/{appId}/stories/{storyId}

Request

  • Base URL
    https://epics-api.mendix.com/v1
  • Auth
    API key in header Authorization

Path parameters

appIdstring uuid required

The ID of the app

storyIdstring required

The readable ID of the story

Response

Successful operation

uuidstring uuid
storyIdstring
sortIdinteger
titlestring
descriptionHTMLstring html
descriptionPlainstring
storyPointsinteger
storyType'Bug' | 'Feature'
storyLevel'Active' | 'NextSprint' | 'InRefinement' | 'Backlog'
numberOfTasksinteger
statusstring

Example response

{
  "uuid": "346a2cad-6b96-477a-9225-3957b73ctest",
  "storyId": "TEST-1",
  "title": "Users need to have a homepage that gives them access to pages where information can be seen.",
  "descriptionHTML": "<p>Add buttons to the existing homepage which give users access to other pages.</p>",
  "descriptionPlain": "Add buttons to the existing homepage which give users access to other pages.",
  "storyPoints": 5,
  "storyType": "Feature",
  "storyLevel": "Active",
  "numberOfTasks": 1,
  "status": "Done"
}

Changes

No recorded changes to this operation across all 1 revision of this API.