/api/v1/projects/{projectId}/ontology/proposals/{proposalId}/supersede

POST

/api/v1/projects/{projectId}/ontology/proposals/{proposalId}/supersede

curl --request POST \
  --url https://api.yggy.tech/api/v1/projects/example/ontology/proposals/example/supersede \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "replacement": { "name": "example", "description": "example", "evidence": { "sourceField": "example", "sampleValues": [ "example" ] }, "explanation": "example", "alternatives": [ "example" ], "kind": "class", "parentClass": "example" } }'

• Production

Authorizations

• bearerAuth
• apiKeyAuth

Parameters

Path Parameters

projectId

required

string

>= 1 characters

proposalId

required

string

>= 1 characters

Request Body

Media type application/json

object

replacement

required

One of:

object

object

name

required

string

>= 1 characters <= 100 characters /^[a-z][a-z0-9_-]*(?::[a-z][a-z0-9_-]*)?$/

description

required

string

<= 500 characters /^[^\r\n]*$/

evidence

required

object

sourceField

required

string

>= 1 characters <= 256 characters

sampleValues

required

Array<string>

>= 1 items <= 20 items

explanation

required

string

>= 1 characters <= 1000 characters

alternatives

required

Array<string>

<= 10 items

kind

required

string

Allowed values: class

parentClass

string

>= 1 characters <= 100 characters /^[a-z][a-z0-9_-]*(?::[a-z][a-z0-9_-]*)?$/

object

object

name

required

string

>= 1 characters <= 100 characters /^[a-z][a-z0-9_-]*(?::[a-z][a-z0-9_-]*)?$/

description

required

string

<= 500 characters /^[^\r\n]*$/

evidence

required

object

sourceField

required

string

>= 1 characters <= 256 characters

sampleValues

required

Array<string>

>= 1 items <= 20 items

explanation

required

string

>= 1 characters <= 1000 characters

alternatives

required

Array<string>

<= 10 items

kind

required

string

Allowed values: relation

parentRelation

string

>= 1 characters <= 100 characters /^[a-z][a-z0-9_-]*(?::[a-z][a-z0-9_-]*)?$/

domain

required

Array

>= 1 items <= 20 items

range

required

Array

>= 1 items <= 20 items

object

object

name

required

string

>= 1 characters <= 100 characters /^[a-z][a-z0-9_-]*(?::[a-z][a-z0-9_-]*)?$/

description

required

string

<= 500 characters /^[^\r\n]*$/

evidence

required

object

sourceField

required

string

>= 1 characters <= 256 characters

sampleValues

required

Array<string>

>= 1 items <= 20 items

explanation

required

string

>= 1 characters <= 1000 characters

alternatives

required

Array<string>

<= 10 items

kind

required

string

Allowed values: data-property

domain

required

Array

>= 1 items <= 20 items

datatype

required

string

Allowed values: string boolean integer decimal date dateTime

Responses

200

Ontology proposal superseded by an approved correction

Media type application/json

object

id

required

string

reviewId

required

string

projectId

required

string

projectExternalId

required

string

status

required

string

Allowed values: APPROVED MAPPED_TO_EXISTING DISMISSED SUPERSEDED

draft

required

One of:

object

object

name

required

string

>= 1 characters <= 100 characters /^[a-z][a-z0-9_-]*(?::[a-z][a-z0-9_-]*)?$/

description

required

string

<= 500 characters /^[^\r\n]*$/

evidence

required

object

sourceField

required

string

>= 1 characters <= 256 characters

sampleValues

required

Array<string>

>= 1 items <= 20 items

explanation

required

string

>= 1 characters <= 1000 characters

alternatives

required

Array<string>

<= 10 items

kind

required

string

Allowed values: class

parentClass

string

>= 1 characters <= 100 characters /^[a-z][a-z0-9_-]*(?::[a-z][a-z0-9_-]*)?$/

object

object

name

required

string

>= 1 characters <= 100 characters /^[a-z][a-z0-9_-]*(?::[a-z][a-z0-9_-]*)?$/

description

required

string

<= 500 characters /^[^\r\n]*$/

evidence

required

object

sourceField

required

string

>= 1 characters <= 256 characters

sampleValues

required

Array<string>

>= 1 items <= 20 items

explanation

required

string

>= 1 characters <= 1000 characters

alternatives

required

Array<string>

<= 10 items

kind

required

string

Allowed values: relation

parentRelation

string

>= 1 characters <= 100 characters /^[a-z][a-z0-9_-]*(?::[a-z][a-z0-9_-]*)?$/

domain

required

Array

>= 1 items <= 20 items

range

required

Array

>= 1 items <= 20 items

object

object

name

required

string

>= 1 characters <= 100 characters /^[a-z][a-z0-9_-]*(?::[a-z][a-z0-9_-]*)?$/

description

required

string

<= 500 characters /^[^\r\n]*$/

evidence

required

object

sourceField

required

string

>= 1 characters <= 256 characters

sampleValues

required

Array<string>

>= 1 items <= 20 items

explanation

required

string

>= 1 characters <= 1000 characters

alternatives

required

Array<string>

<= 10 items

kind

required

string

Allowed values: data-property

domain

required

Array

>= 1 items <= 20 items

datatype

required

string

Allowed values: string boolean integer decimal date dateTime

mappedTerm

string | null

Example

{
  "status": "APPROVED",
  "draft": {
    "kind": "class"
  }
}