Which references name a case or a suite
GET
/v1/refs
const url = 'https://beta-api.plune.ai/v1/refs?ref=example';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://beta-api.plune.ai/v1/refs?ref=example' \ --header 'Authorization: Bearer <token>'A reference is @T (a case) or @S (a suite) and the first eight characters of the id, e.g. @T1a2b3c4d; the app shows one in a description as a link. Ask with ref repeated (up to 50). Only the references that name a live case or suite of the project come back; a reference nothing answers to, one in the bin, another project’s, or one that two ids start with is left out, and the screen shows it as an error.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ” ref
required
Array<string>
Responses
Section titled “ Responses ”The references that resolve
Media type application/json
object
refs
required
Array<object>
object
ref
required
The reference as it was asked for.
string
kind
required
string
id
required
string format: uuid
title
required
The case’s title, or the suite’s name.
string
Example
{ "refs": [ { "ref": "@T1a2b3c4d", "kind": "case", "id": "1a2b3c4d-0000-4000-8000-000000000001", "title": "Pay with a saved card" } ]}No ref, more than 50, or one that is not a reference
Media type application/json
object
error
required
string
Example generated
{ "error": "example"}No / invalid token or session