Skip to content
Test And Accept Docs
Navigation

Create user story

Create a new user story with optional initial steps

POST
https://api.testandaccept.com/api/rest/user-stories

Authorization

  • bearerAuth
    HTTP Bearer (tnda_ token)
    required

Request body JSON required

  • projectId
    string
    required
    format: uuid · pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$
  • title
    string
    required
    maxLength: 200 · minLength: 1
  • description
    string
    required
    minLength: 1
  • orderIndex
    optional
    integer
    maximum: 9007199254740991 · minimum: 0
  • steps
    optional
    array of
    object
    • title
      string
      required
      maxLength: 200 · minLength: 1
    • description
      optional
      string
    • acceptanceCriteria
      optional
      string

Returns

200

Successful response

JSON
  • id
    string
    required
    format: uuid · pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$
  • projectId
    string
    required
    format: uuid · pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$
  • title
    string
    required
  • description
    required

    Any of the following:

    • string
    • null
  • ownerUserId
    string
    required
  • status
    draft
    or
    refined
    or
    assessed
    required
  • orderIndex
    number
    required
  • createdAt
    string
    required
  • updatedAt
    string
    required

400

Invalid input data
JSON
  • message
    string
    required

    The error message

  • code
    string
    required

    The error code

  • issues
    optional
    array of
    object

    An array of issues that were responsible for the error

    • message
      string
      required

401

Authorization not provided
JSON
  • message
    string
    required

    The error message

  • code
    string
    required

    The error code

  • issues
    optional
    array of
    object

    An array of issues that were responsible for the error

    • message
      string
      required

403

Insufficient access
JSON
  • message
    string
    required

    The error message

  • code
    string
    required

    The error code

  • issues
    optional
    array of
    object

    An array of issues that were responsible for the error

    • message
      string
      required

500

Internal server error
JSON
  • message
    string
    required

    The error message

  • code
    string
    required

    The error code

  • issues
    optional
    array of
    object

    An array of issues that were responsible for the error

    • message
      string
      required

Type to search…

↑↓ navigate↵ selectEsc close