Skip to content
Docs
Follow yggy on LinkedInFollow @yggy_tech on X

Get organization settings

GET
/api/v1/organizations/settings
 
curl --request GET \
  --url https://api.yggy.tech/api/v1/organizations/settings \
  --header 'Authorization: Bearer <token>'

Returns extraction and ontology settings for the current organization. Requires membership.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Organization settings

Media type application/json
object
mimirExtraction
required
boolean
sgseConsolidationPasses
required
integer
>= 1 <= 5
ontologyOverlay
object
organizationId
required
string
>= 1 characters <= 128 characters
version
required
string
>= 1 characters <= 64 characters /^[A-Za-z0-9._-]+$/
namespace
required
string format: uri
<= 2048 characters
classes
Array<object>
<= 200 items
object
name
required
string
>= 1 characters <= 100 characters /^[a-z][a-z0-9_-]*(?::[a-z][a-z0-9_-]*)?$/
description
string
<= 500 characters /^[^\r\n]*$/
parent
string
>= 1 characters <= 100 characters /^[a-z][a-z0-9_-]*(?::[a-z][a-z0-9_-]*)?$/
relations
required
Array<object>
<= 200 items
object
name
required
string
>= 1 characters <= 100 characters /^[a-z][a-z0-9_-]*(?::[a-z][a-z0-9_-]*)?$/
category
required
string
Allowed values: ownership creation location temporal hierarchy causation association supply_chain legal financial employment technology measurement
domain
required
Array
>= 1 items <= 20 items
range
required
Array
>= 1 items <= 20 items
inverse
string
>= 1 characters <= 100 characters /^[a-z][a-z0-9_-]*(?::[a-z][a-z0-9_-]*)?$/
parent
string
>= 1 characters <= 100 characters /^[a-z][a-z0-9_-]*(?::[a-z][a-z0-9_-]*)?$/
description
string
<= 500 characters /^[^\r\n]*$/
symmetric
boolean
transitive
boolean
functional
boolean
temporalClass
string
Allowed values: static state event
dataProperties
required
Array<object>
<= 200 items
object
name
required
string
>= 1 characters <= 100 characters /^[a-z][a-z0-9_-]*(?::[a-z][a-z0-9_-]*)?$/
datatype
required
string
Allowed values: string boolean integer decimal date dateTime
domain
required
Array
>= 1 items <= 20 items
description
required
string
<= 500 characters /^[^\r\n]*$/
range
required
string
/^http://www\.w3\.org/2001/XMLSchema#.*$/
accurateTierEnabled
required
boolean
showInWorkspace
required
boolean
careMode
required
string
Allowed values: off observe act
carePolicy
required
string
Allowed values: suggest-only auto-apply
careDailyRunCap
required
integer
>= 1
accurateTierAvailable
required
boolean
Example 
{
  "ontologyOverlay": {
    "relations": [
      {
        "category": "ownership",
        "domain": [
          "*"
        ],
        "range": [
          "*"
        ],
        "temporalClass": "static"
      }
    ],
    "dataProperties": [
      {
        "datatype": "string",
        "domain": [
          "*"
        ]
      }
    ]
  },
  "careMode": "off",
  "carePolicy": "suggest-only"
}