Milestone

Delete a 'Milestone' by id

If the entity type supports soft-deletion this operation only soft-deletes the entity.

delete/milestone/{id}

Request

Base URL
https://app.testiny.io/api/v1
Auth
API key in header X-Api-Key
TypeScript
https://skmtc.dev/testiny/apis/testiny-api/docs/milestone/:id/delete.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idinteger required

The id tof the object to delete

Response

Returns a single Milestone

idinteger

The unique entity id - must be a positive integer

titlestring

A descriptive title for this entity or mapping (1 to 200 characters)

tagsstring

A list of tags for this entity

is_deletedboolean

If the entity has been soft-deleted this value is true

created_atstring date-time

The creation time for this entity or mapping value

created_bynumber

The creator user id of this entity or mapping value - or zero if created by the system

modified_atstring date-time

The last modification time for this entity or mapping value

modified_bynumber

The id of the user who last modified or undeleted this entity or mapping value - or zero if modified by the system

deleted_atstring date-time

The soft-deletion time for this entity or mapping value

deleted_bynumber

The id of the user who deleted this entity or mapping value - or zero if deleted by the system

_etagstring required

A tag for detecting conflicting modifications - current value (may be empty) must be passed along in an update (or update must be forced)

project_idinteger

The project id this entity or mapping belongs to

closed_atstring date-time

The time this milestone was closed

closed_bynumber

The id of the user who closed this milestone

is_closedboolean

Whether the milestone is closed or not. While certain properties of a closed milestone may still be modified, some referenced entities (e.g. test cases, results, ...) before the 'closed_at' date cannot be removed or changed until it is reopened.

parent_idinteger

The optional id of the parent milestone

start_atstring date-time

The milestone start time

stop_atstring date-time

The milestone stop time/due time

descriptionstring nullable

An optional description for this milestone (can be a rich text document, i.e. markdown with header line  or Testiny JSON format)

Example response

{
  "title": "A Descriptive Title",
  "tags": "important,release,smoketest",
  "created_at": "1970-01-01T00:00:00.000Z",
  "modified_at": "1970-01-01T00:00:00.000Z",
  "deleted_at": "1970-01-01T00:00:00.000Z",
  "closed_at": "1970-01-01T00:00:00.000Z",
  "start_at": "1970-01-01T00:00:00.000Z",
  "stop_at": "1970-01-01T00:00:00.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.