Create a discovery

Create a discovery

Request Body — REQUIRED
title string — REQUIRED Title of the discovery
description string Description of the discovery. Accepts markdown, plain text or HTML — markdown is rendered, plain text keeps its line breaks, and the result is sanitized before storage.
parentId string — REQUIRED Identifier of the parent: a component, or a discovery that is itself directly under a component. A discovery cannot be created at the root.
discoveryStateId string Identifier of the discovery state. Defaults to the project's default state.
createdAt string Creation date as an ISO-8601 string. Defaults to the current date.
tagIds string[] Tags to link, named by id, client id or name. A tag that does not resolve rejects the request.
assigneeIds string[] Identifiers of the assignees. Only a collaborator can own a discovery; anything else rejects the request.
fieldsValues object[] Values for the project's user-defined discovery fields. Any invalid entry rejects the whole request. fieldId string — REQUIRED Identifier of the discovery field (id or client id) value Value for a scalar field. Its JSON type must match the field type: a number for NUMERICAL, an integer for RATING, a boolean for BOOLEAN, a non-empty string for STRING and URL. Mutually exclusive with optionIds. optionIds string[] Identifiers of the options to link, for a SELECT_SINGLE or SELECT_MULTI field. Options are linked, never created — list the available ones with GET /v1/discovery-fields. Mutually exclusive with value.

Responses
201 Create a discovery. Every reference in the body must resolve — an unknown parent, state, tag, assignee, field or option rejects the whole request. The response always carries fieldsValues as stored: this operation takes no select parameter. Schema — OPTIONAL discovery object The created discovery id string Unique identifier of the discovery clientId string Client identifier createdAt date-time Creation date of the discovery updatedAt date-time Last update date of the discovery title string Title of the discovery description string — OPTIONAL Description of the discovery discoveryStateId string Identifier of the discovery state parentId string Identifier of the parent (component or discovery) parentType string Possible values: [COMPONENT, DISCOVERY, NONE] Type of the parent entity assigneeId string — OPTIONAL Identifier of the first assignee (ordered by name). Deprecated: use assignees. assignees string[] Identifiers of all assignees tags string[] Tags associated with this discovery lastDiscoverystateUpdatedAt date-time Date when the discovery state was last updated lastFeedback date-time Date of the last feedback fieldsValues object[] — OPTIONAL Field values for this discovery. Always returned by POST /v1/discovery; on the read endpoints only when select=discoveryfields is passed. field object The discovery field definition id string Unique identifier of the discovery field clientId string Client identifier name string Name of the discovery field value string Value of the field jiraIssueUrls string[] — OPTIONAL URLs of Jira issues linked to this discovery. Only included when select=issues is specified in query parameters. githubIssueUrls string[] — OPTIONAL URLs of GitHub issues linked to this discovery. Only included when select=issues is specified in query parameters. gitlabIssueUrls string[] — OPTIONAL URLs of GitLab issues linked to this discovery. Only included when select=issues is specified in query parameters. linearIssueUrls string[] — OPTIONAL URLs of Linear issues linked to this discovery. Only included when select=issues is specified in query parameters. trelloCardUrls string[] — OPTIONAL URLs of Trello cards linked to this discovery. Only included when select=issues is specified in query parameters.
400 A reference in the body did not resolve — parent, state, tag, assignee, field or option — or a field value did not match the type of its field.
403 The project reached the discovery limit of its plan. Delete discoveries or upgrade the plan.