Update test case attachments

PUT/testcases/{id}/updateAttachments

Test Case to update

Example

Use resource IDs from your own project. Keep the API token in your server or CI environment.

TypeScript SDK

example.ts

import { createConfiguration, TestCasesApi } from '@testcollab/sdk';

const config = createConfiguration(process.env.TESTCOLLAB_TOKEN!);
const api = new TestCasesApi(config);

const result = await api.updateAttachments({
  "id": 123,
  "updateAttachmentPayload": {
    "attachments": []
  }
});
console.log(result);

HTTP

curl --request PUT \
  "https://api.testcollab.io/testcases/123/updateAttachments?token=$TESTCOLLAB_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
  "project": 123,
  "attachments": []
}'

Parameters

Name	Location	Type	Required	Description
id	path	number	Yes	Test Case ID

Request body

Field	Type	Required	Description
project	number	No	—
attachments	Array of string	Yes	Array of file ids

Response

200 — Updated Test Case

Field	Type	Required	Description
id	number	Yes	—
display_number	number	No	Per-company human-readable business number (shown as TC-204). Distinct from the internal id.
title	string	Yes	—
suite	Suite	No	—
suite.id	number	Yes	—
suite.title	string	Yes	—
suite.description	string	No	—
suite.parent_id	number	No	—
suite.order	number	No	—
suite.created_by	number	No	—
suite.is_bdd_managed	boolean	No	True when the suite is managed by BDD sync from a feature file in Git.
suite.is_reference	boolean	No	Will be true only for links
suite.source_id	number	No	Only for links - source entity ID
suite.source_project	number	No	Only for links - source Project ID
suite.is_main_link	boolean	No	Will be true only for top level link suite
description	string	Yes	Test case description (generated by rich text editor)
steps	Step Collection	No	—
steps[].step	string	Yes	(can contain HTML)
steps[].expected_result	string	Yes	(can contain HTML)
steps[].reusable_step_id	number	Yes	Reusable Step ID
steps_parsed	Step Parsed Collection	No	—
steps_parsed[].step	string	Yes	(can contain HTML)
steps_parsed[].step_id	number	No	—
steps_parsed[].expected_result	string	Yes	(can contain HTML)
steps_parsed[].step_index	number	No	—
steps_parsed[].parsed_reusable_step_id	number	No	—
priority	number	Yes	Priority, 0 - Low, 1- Normal, 2 - High Values: 0, 1, 2.
tags	Tag Collection	No	—
tags[].id	number	Yes	—
tags[].name	string	Yes	—
tags[].test_case_count	number	No	—
requirements	Requirement Collection	No	—
requirements[].id	number	No	—
requirements[].title	string	Yes	—
requirements[].requirementManager	string	No	—
requirements[].requirement_id	string	Yes	—
requirements[].requirement_key	string	No	—
requirements[].requirement_url	string	No	—
requirements[].project	number	Yes	—
requirements[].status	number	No	—
requirements[].req_info	string	No	Stringified JSON object
requirements[].testcase_count	number	No	—
requirements[].link_sync	Requirement Link Sync	No	Azure DevOps reciprocal-link state for the requested test-case relation.
requirements[].link_sync.id	number	Yes	—
requirements[].link_sync.desired_state	string	Yes	Values: linked, unlinked.
requirements[].link_sync.sync_status	string	Yes	Values: pending, synced, failed.
requirements[].link_sync.attempts	number	Yes	—
requirements[].link_sync.last_error	string	No	—
requirements[].link_sync.last_synced_at	string	No	—
requirements[].link_sync.next_retry_at	string	No	—
requirements[].custom_fields	Array of Custom Field Collection Output	No	Array of custom fields - applicable only for inbuilt
requirements[].requirement_folder	Generic Folder	No	Requirement folder - applicable only for inbuilt
requirements[].requirement_folder.id	number	Yes	—
requirements[].requirement_folder.project	number	Yes	—
requirements[].requirement_folder.title	string	Yes	—
requirements[].requirement_folder.parent_id	number	Yes	—
requirements[].requirement_folder.sort_order	number	No	—
requirements[].requirement_folder.folderitemcount	number	No	—
requirements[].requirement_folder.created_by	number	No	—
requirements[].requirement_folder.description	string	No	—
requirements[].requirement_folder.created_at	string	Yes	—
requirements[].requirement_folder.updated_at	string	Yes	—
requirements[].attachments	Upload Collection	No	Requirement attachments - applicable only for inbuilt
requirements[].attachments[].id	number	Yes	—
requirements[].attachments[].name	string	Yes	—
requirements[].attachments[].hash	string	Yes	—
requirements[].attachments[].ext	string	Yes	—
requirements[].attachments[].mime	string	Yes	—
requirements[].attachments[].size	string	Yes	—
requirements[].attachments[].url	string	Yes	—
requirements[].attachments[].created_by	number	No	—
requirements[].attachments[].created_at	string	Yes	—
requirements[].attachments[].updated_at	string	Yes	—
requirements[].description	string	No	Requirement description - applicable only for inbuilt
requirements[].created_at	string	No	—
requirements[].updated_at	string	No	—
requirements[].created_by	User Minified	No	—
requirements[].created_by.id	number	Yes	—
requirements[].created_by.username	string	No	—
requirements[].created_by.name	string	Yes	—
requirements[].created_by.avatar	Upload	No	—
requirements[].created_by.is_guest	number	No	—
attachments	Upload Collection	No	—
attachments[].id	number	Yes	—
attachments[].name	string	Yes	—
attachments[].hash	string	Yes	—
attachments[].ext	string	Yes	—
attachments[].mime	string	Yes	—
attachments[].size	string	Yes	—
attachments[].url	string	Yes	—
attachments[].created_by	number	No	—
attachments[].created_at	string	Yes	—
attachments[].updated_at	string	Yes	—

Illustrative response

{
  "id": 123,
  "display_number": 123,
  "title": "example",
  "suite": {
    "id": 123,
    "title": "example",
    "description": "example",
    "parent_id": 123,
    "order": 123,
    "created_by": 123,
    "is_bdd_managed": true,
    "is_reference": true,
    "source_id": 123
  },
  "description": "example",
  "steps": [],
  "steps_parsed": [],
  "priority": 0,
  "tags": []
}

Errors

Status	Meaning
403	Forbidden

Next steps

• Browse cases and suites
• Authentication
• Handle errors