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

POST

const url = 'https://api.yggy.tech/api/v1/projects/example/ontology/proposals/example/decision';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"action":"approve","description":"example","parentRelation":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.yggy.tech/api/v1/projects/example/ontology/proposals/example/decision \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "action": "approve", "description": "example", "parentRelation": "example" }'

Authorizations

bearerAuth
apiKeyAuth

Parameters

Path Parameters

projectId

required

string

>= 1 characters

proposalId

required

string

>= 1 characters

Request Body

application/json

One of:

object

action

required

string

Allowed values: approve

description

string

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

parentRelation

string | null

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

Responses

200

Ontology proposal resolved

application/json

object

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

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_-]*)?$/

mappedTerm

string | null

Example

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