Test And Accept Docs

Open Test And Accept

Generate SOW from user stories

Use AI to generate a Statement of Work structure from selected user stories

POST

https://api.testandaccept.com/api/rest/user-stories/generate-sow

Authorization

bearerAuth
HTTP Bearer (tnda_ token)
required

Request body JSON required

storyIds
array of
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)$
generateTests
optional
boolean
default: true
organizationStyle
optional
hierarchical
or
flat
or
feature-based
default: "hierarchical"

Returns

200

Successful response

JSON

sowProposal
object
required
- title
  string
  required
- description
  string
  required
}
taskProposals
array of
object
required
- title
  string
  required
- description
  string
  required
- type
  requirement
  or
  task_item
  or
  milestone
  or
  deliverable
  required
- priority
  low
  or
  medium
  or
  high
  or
  critical
  required
- acceptanceCriteria
  optional
  array of
  string
- linkedStepIds
  optional
  array of
  string
}
stepMappings
array of
object
required
- stepId
  string
  required
- taskIndex
  number
  required
}
coverageAnalysis
object
required
- storiesCovered
  number
  required
- coveragePercentage
  number
  required
- gaps
  array of
  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
}

Generate SOW from user stories

curl --request POST \
  --url https://api.testandaccept.com/api/rest/user-stories/generate-sow \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "storyIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  "generateTests": true,
  "organizationStyle": "hierarchical"
}
'

const url = 'https://api.testandaccept.com/api/rest/user-stories/generate-sow';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({
    storyIds: ['497f6eca-6276-4993-bfeb-53cbbbba6f08'],
    projectId: '5a8591dd-4039-49df-9202-96385ba3eff8',
    generateTests: true,
    organizationStyle: 'hierarchical'
  })
};

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

import requests

url = "https://api.testandaccept.com/api/rest/user-stories/generate-sow"

payload = {
    "storyIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "generateTests": True,
    "organizationStyle": "hierarchical"
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "sowProposal": {
    "title": "string",
    "description": "string"
  },
  "taskProposals": [
    {
      "title": "string",
      "description": "string",
      "type": "requirement",
      "priority": "low",
      "acceptanceCriteria": [
        "string"
      ],
      "linkedStepIds": [
        "string"
      ]
    }
  ],
  "stepMappings": [
    {
      "stepId": "string",
      "taskIndex": 0
    }
  ],
  "coverageAnalysis": {
    "storiesCovered": 0,
    "coveragePercentage": 0,
    "gaps": [
      "string"
    ]
  }
}

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

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

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

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