Deprecate a project ontology term

POST

/api/v1/projects/{projectId}/ontology/terms/{kind}/{name}/deprecate

curl --request POST \
  --url https://api.yggy.tech/api/v1/projects/example/ontology/terms/class/example/deprecate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "replacementTerm": "example" }'

• Production

Publishes a new immutable project ontology version that prevents new use of one project-owned term.

Authorizations

• bearerAuth
• apiKeyAuth

Parameters

Path Parameters

projectId

required

string

>= 1 characters

kind

required

string

Allowed values: class relation data-property

name

required

string

>= 1 characters <= 100 characters

Request Body

Media type application/json

object

replacementTerm

string

>= 1 characters <= 100 characters

Example ^generated

{
  "replacementTerm": "example"
}

Responses

200

Project ontology term deprecated

Media type application/json

object

version

required

string

term

required

object

kind

required

string

Allowed values: class relation data-property

name

required

string

state

required

string

Allowed values: DEPRECATED

replacementTerm

string

Example

{
  "term": {
    "kind": "class",
    "state": "DEPRECATED"
  }
}

400

Invalid request

Media type application/json

object

error

required

string

Example ^generated

{
  "error": "example"
}

401

Unauthorized

Media type application/json

object

error

required

string

Example ^generated

{
  "error": "example"
}

404

Not found

Media type application/json

object

error

required

string

Example ^generated

{
  "error": "example"
}

409

Conflict

Media type application/json

object

error

required

string

Example ^generated

{
  "error": "example"
}

500

Internal server error

Media type application/json

object

error

required

string

Example ^generated

{
  "error": "example"
}