Test And Accept Docs

Open Test And Accept

Get user story

Get a single user story with steps and coverage summary

GET

https://api.testandaccept.com/api/rest/user-stories/{id}

Authorization

bearerAuth
HTTP Bearer (tnda_ token)
required

Path parameters

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)$

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
steps
array of
unknown
required
coverageSummary
unknown
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
}

404

Not found

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
}

Get user story

curl --request GET \
  --url 'https://api.testandaccept.com/api/rest/user-stories/<id>' \
  --header 'Authorization: Bearer <token>'

const url = 'https://api.testandaccept.com/api/rest/user-stories/<id>';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response example

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  "title": "string",
  "description": "string",
  "ownerUserId": "string",
  "status": "draft",
  "orderIndex": 0,
  "createdAt": "string",
  "updatedAt": "string",
  "steps": [
    null
  ],
  "coverageSummary": null
}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}