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

GET

const url = 'https://api.yggy.tech/api/v1/projects/example/ontology/proposals?limit=100&offset=0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

curl --request GET \
  --url 'https://api.yggy.tech/api/v1/projects/example/ontology/proposals?limit=100&offset=0' \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth
apiKeyAuth

Parameters

Path Parameters

projectId

required

string

>= 1 characters

Query Parameters

documentId

string

>= 1 characters <= 128 characters

limit

integer

default: 100 >= 1 <= 100

offset

integer | null

Responses

200

Project ontology proposals

application/json

object

proposals

required

Array<object>

object

required

string

reviewId

required

string

projectExternalId

required

string

extractionId

required

string

mappingId

required

string

documentId

required

string

documentTitle

required

string

status

required

string

Allowed values: PROPOSED 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_-]*)?$/

createdBy

required

string | null

createdByUser

object

required

string

name

required

string | null

email

required

string | null

reviewerId

required

string | null

reviewer

object

required

string

name

required

string | null

email

required

string | null

mappedTerm

required

string | null

ontologyVersion

required

string | null

supersedesProposalId

required

string | null

affectedCandidateFacts

required

Array

One of:

object

kind

required

string

Allowed values: relation

term

required

string

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

subject

required

object

text

required

string

>= 1 characters <= 500 characters

type

required

string

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

identity

object

namespaceUri

required

string format: uri

<= 2048 characters

sourceField

required

string

>= 1 characters <= 256 characters

value

required

string

>= 1 characters <= 512 characters

object

required

object

text

required

string

>= 1 characters <= 500 characters

type

required

string

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

identity

object

namespaceUri

required

string format: uri

<= 2048 characters

sourceField

required

string

>= 1 characters <= 256 characters

value

required

string

>= 1 characters <= 512 characters

evidence

string

<= 1000 characters

extractionSource

string

Allowed values: STRUCTURED_SGSE UNSTRUCTURED

createdAt

required

string | null format: date-time

reviewedAt

required

string | null format: date-time

fit

required

string

Allowed values: strong close_match weak

score

required

number

<= 1

suggestedMap

required

string | null

Example

{
  "proposals": [
    {
      "status": "PROPOSED",
      "draft": {
        "kind": "class"
      },
      "affectedCandidateFacts": [
        {
          "kind": "relation",
          "extractionSource": "STRUCTURED_SGSE"
        }
      ],
      "fit": "strong"
    }
  ]
}