FastAPI (0.1.0)

Download OpenAPI specification:

Status

Get a status report for PyST server

Responses

Response samples

Content type
application/json
{
  • "version": "string",
  • "search": true
}

Concept

Search for `Concept` objects

query Parameters
query
required
string (Query)
language
required
string (Language)
semantic
boolean (Semantic)
Default: true

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Suggestion search for `Concept` objects

query Parameters
query
required
string (Query)
language
required
string (Language)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a list of concept objects with optional filters.

Retrieve a list of Concept objects.

The list can be filtered to a given concept scheme by using the URL parameter concept_scheme_iri=<iri>.

The list can be further filtered to only be top concepts of the given concept scheme (if concept_scheme_iri is specified) with the URL parameter top_concepts_only=<bool>. If concept_scheme_iri is not specified, top_concepts_only has no effect.

query Parameters
Concept Scheme Iri (string) or Concept Scheme Iri (null) (Concept Scheme Iri)
top_concepts_only
boolean (Top Concepts Only)
Default: false

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a `Concept` object

path Parameters
iri
required
string (Iri)

Responses

Response samples

Content type
application/json
{
  • "http://www.w3.org/2004/02/skos/core#prefLabel": [
    ],
  • "http://purl.org/ontology/bibo/status": [],
  • "http://www.w3.org/2004/02/skos/core#definition": [
    ],
  • "http://www.w3.org/2004/02/skos/core#notation": [],
  • "http://www.w3.org/2004/02/skos/core#changeNote": [
    ],
  • "http://www.w3.org/2004/02/skos/core#historyNote": [
    ],
  • "http://www.w3.org/2004/02/skos/core#editorialNote": [
    ],
  • "http://www.w3.org/2004/02/skos/core#inScheme": [],
  • "http://www.w3.org/2004/02/skos/core#altLabel": {
    },
  • "http://www.w3.org/2004/02/skos/core#hiddenLabel": [
    ],
  • "http://www.w3.org/2004/02/skos/core#topConceptOf": []
}

Create a `Concept` object

header Parameters
x-pyst-auth-token
string (X-Pyst-Auth-Token)
Default:
Request Body schema: application/json
required
@id
required
@type
required
Array of strings (Object `@type`)
required
Array of objects (SKOS preferred labels (one per language)) non-empty
required
Array of objects (BIBO status (accepted/draft/rejected)) non-empty
Array of objects (SKOS notation (typed literal))
Default: []
Array of objects (SKOS change note with additional required fields)
Default: []
Array of objects (SKOS history note with additional required fields)
Default: []
Array of objects (SKOS editorial note with additional required fields)
Default: []
required
Array of objects (SKOS concept scheme (normally only one)) non-empty
Array of objects (SKOS alternative labels. Can be more than one per language.)
Default: []
Array of objects (SKOS hidden labels)
Default: []
Array of objects (SKOS definition (one per language))
Default: []
Array of objects (SKOS concept scheme if this concept is at top of hierarchy (maximum 1)) <= 1 items
Default: []
Array of objects (SKOS broader)
Default: []
Array of objects (SKOS narrower (use of `broader` is preferred; see docs))
Default: []
property name*
additional property
any

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "http://www.w3.org/2004/02/skos/core#prefLabel": [
    ],
  • "http://purl.org/ontology/bibo/status": [],
  • "http://www.w3.org/2004/02/skos/core#definition": [
    ],
  • "http://www.w3.org/2004/02/skos/core#notation": [],
  • "http://www.w3.org/2004/02/skos/core#changeNote": [
    ],
  • "http://www.w3.org/2004/02/skos/core#historyNote": [
    ],
  • "http://www.w3.org/2004/02/skos/core#editorialNote": [
    ],
  • "http://www.w3.org/2004/02/skos/core#inScheme": [],
  • "http://www.w3.org/2004/02/skos/core#altLabel": {
    },
  • "http://www.w3.org/2004/02/skos/core#hiddenLabel": [
    ],
  • "http://www.w3.org/2004/02/skos/core#topConceptOf": []
}

Update a `Concept` object

header Parameters
x-pyst-auth-token
string (X-Pyst-Auth-Token)
Default:
Request Body schema: application/json
required
@id
required
@type
required
Array of strings (Object `@type`)
required
Array of objects (SKOS preferred labels (one per language)) non-empty
required
Array of objects (BIBO status (accepted/draft/rejected)) non-empty
Array of objects (SKOS notation (typed literal))
Default: []
Array of objects (SKOS change note with additional required fields)
Default: []
Array of objects (SKOS history note with additional required fields)
Default: []
Array of objects (SKOS editorial note with additional required fields)
Default: []
required
Array of objects (SKOS concept scheme (normally only one)) non-empty
Array of objects (SKOS alternative labels. Can be more than one per language.)
Default: []
Array of objects (SKOS hidden labels)
Default: []
Array of objects (SKOS definition (one per language))
Default: []
Array of objects (SKOS concept scheme if this concept is at top of hierarchy (maximum 1)) <= 1 items
Default: []
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "http://www.w3.org/2004/02/skos/core#prefLabel": [
    ],
  • "http://purl.org/ontology/bibo/status": [],
  • "http://www.w3.org/2004/02/skos/core#notation": [],
  • "http://www.w3.org/2004/02/skos/core#changeNote": [
    ],
  • "http://www.w3.org/2004/02/skos/core#historyNote": [
    ],
  • "http://www.w3.org/2004/02/skos/core#editorialNote": [
    ],
  • "http://www.w3.org/2004/02/skos/core#inScheme": [],
  • "http://www.w3.org/2004/02/skos/core#altLabel": [
    ],
  • "http://www.w3.org/2004/02/skos/core#hiddenLabel": [
    ],
  • "http://www.w3.org/2004/02/skos/core#definition": [
    ],
  • "http://www.w3.org/2004/02/skos/core#topConceptOf": []
}

Response samples

Content type
application/json
{
  • "http://www.w3.org/2004/02/skos/core#prefLabel": [
    ],
  • "http://purl.org/ontology/bibo/status": [],
  • "http://www.w3.org/2004/02/skos/core#definition": [
    ],
  • "http://www.w3.org/2004/02/skos/core#notation": [],
  • "http://www.w3.org/2004/02/skos/core#changeNote": [
    ],
  • "http://www.w3.org/2004/02/skos/core#historyNote": [
    ],
  • "http://www.w3.org/2004/02/skos/core#editorialNote": [
    ],
  • "http://www.w3.org/2004/02/skos/core#inScheme": [],
  • "http://www.w3.org/2004/02/skos/core#altLabel": {
    },
  • "http://www.w3.org/2004/02/skos/core#hiddenLabel": [
    ],
  • "http://www.w3.org/2004/02/skos/core#topConceptOf": []
}

Delete a `Concept` object

path Parameters
iri
required
string (Iri)
header Parameters
x-pyst-auth-token
string (X-Pyst-Auth-Token)
Default:

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Get a list of `Concept` relationships

query Parameters
iri
required
string (Iri)
source
boolean (Source)
Default: true
target
boolean (Target)
Default: false

Responses

Response samples

Content type
application/json
[]

Create a list of `Concept` relationships

header Parameters
x-pyst-auth-token
string (X-Pyst-Auth-Token)
Default:
Request Body schema: application/json
required
Array
@id
required
Array of objects (SKOS broader)
Default: []
Array of objects (SKOS narrower (use of `broader` is preferred; see docs))
Default: []
Array of objects (SKOS exact match)
Default: []
Array of objects (SKOS close match)
Default: []
Array of objects (SKOS broad match)
Default: []
Array of objects (SKOS narrow match)
Default: []
Array of objects (SKOS related match)
Default: []

Responses

Request samples

Content type
application/json
[]

Response samples

Content type
application/json
[]

Delete a list of `Concept` relationships

header Parameters
x-pyst-auth-token
string (X-Pyst-Auth-Token)
Default:
Request Body schema: application/json
required
Array
@id
required
Array of objects (SKOS broader)
Default: []
Array of objects (SKOS narrower (use of `broader` is preferred; see docs))
Default: []
Array of objects (SKOS exact match)
Default: []
Array of objects (SKOS close match)
Default: []
Array of objects (SKOS broad match)
Default: []
Array of objects (SKOS narrow match)
Default: []
Array of objects (SKOS related match)
Default: []

Responses

Request samples

Content type
application/json
[]

Response samples

Content type
application/json
null

ConceptScheme

Get all concept schemes

Responses

Response samples

Content type
application/json
[]

Get a `ConceptScheme` object

path Parameters
iri
required
string (Iri)

Responses

Response samples

Content type
application/json
{}

Create a `ConceptScheme` object

query Parameters
responses
any (Responses)
Default: "409=[object Object]"
header Parameters
x-pyst-auth-token
string (X-Pyst-Auth-Token)
Default:
Request Body schema: application/json
required
@id
required
@type
required
Array of strings (Object `@type`)
required
Array of objects (SKOS preferred labels (one per language)) non-empty
required
Array of objects (BIBO status (accepted/draft/rejected)) non-empty
Array of objects (SKOS notation (typed literal))
Default: []
Array of objects (SKOS change note with additional required fields)
Default: []
Array of objects (SKOS history note with additional required fields)
Default: []
Array of objects (SKOS editorial note with additional required fields)
Default: []
required
required
required
Array of objects (OWL version info) = 1 items
required
Array of objects (SKOS definition (one per language)) non-empty
property name*
additional property
any

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Update a `ConceptScheme` object

query Parameters
responses
any (Responses)
Default: "404=[object Object]"
header Parameters
x-pyst-auth-token
string (X-Pyst-Auth-Token)
Default:
Request Body schema: application/json
required
@id
required
@type
required
Array of strings (Object `@type`)
required
Array of objects (SKOS preferred labels (one per language)) non-empty
required
Array of objects (BIBO status (accepted/draft/rejected)) non-empty
Array of objects (SKOS notation (typed literal))
Default: []
Array of objects (SKOS change note with additional required fields)
Default: []
Array of objects (SKOS history note with additional required fields)
Default: []
Array of objects (SKOS editorial note with additional required fields)
Default: []
required
required
required
Array of objects (OWL version info) = 1 items
required
Array of objects (SKOS definition (one per language)) non-empty
property name*
additional property
any

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Delete a `ConceptScheme` object

path Parameters
iri
required
string (Iri)
header Parameters
x-pyst-auth-token
string (X-Pyst-Auth-Token)
Default:

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Correspondence

Get all `Correspondence` objects

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a `Correspondence` object

path Parameters
iri
required
string (Iri)

Responses

Response samples

Content type
application/json
{
  • "http://www.w3.org/2004/02/skos/core#prefLabel": [
    ],
  • "http://purl.org/ontology/bibo/status": [],
  • "http://www.w3.org/2004/02/skos/core#definition": [
    ],
  • "http://www.w3.org/2004/02/skos/core#notation": [],
  • "http://www.w3.org/2004/02/skos/core#changeNote": [
    ],
  • "http://www.w3.org/2004/02/skos/core#historyNote": [
    ],
  • "http://www.w3.org/2004/02/skos/core#editorialNote": [
    ],
  • "http://purl.org/dc/terms/created": [],
  • "http://purl.org/dc/terms/creator": [],
  • "http://www.w3.org/2002/07/owl#versionInfo": [
    ],
  • "http://rdf-vocabulary.ddialliance.org/xkos#compares": [],
  • "http://rdf-vocabulary.ddialliance.org/xkos#madeOf": [
    ]
}

Create a `Correspondence` object

header Parameters
x-pyst-auth-token
string (X-Pyst-Auth-Token)
Default:
Request Body schema: application/json
required
@id
required
@type
required
Array of strings (Object `@type`)
required
Array of objects (SKOS preferred labels (one per language)) non-empty
required
Array of objects (BIBO status (accepted/draft/rejected)) non-empty
Array of objects (SKOS notation (typed literal))
Default: []
Array of objects (SKOS change note with additional required fields)
Default: []
Array of objects (SKOS history note with additional required fields)
Default: []
Array of objects (SKOS editorial note with additional required fields)
Default: []
required
required
required
Array of objects (OWL version info) = 1 items
Array of objects (SKOS definition (one per language))
Default: []
required
Array of objects (List of `ConceptScheme` objects being compared) non-empty
property name*
additional property
any

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "http://www.w3.org/2004/02/skos/core#prefLabel": [
    ],
  • "http://purl.org/ontology/bibo/status": [],
  • "http://www.w3.org/2004/02/skos/core#definition": [
    ],
  • "http://www.w3.org/2004/02/skos/core#notation": [],
  • "http://www.w3.org/2004/02/skos/core#changeNote": [
    ],
  • "http://www.w3.org/2004/02/skos/core#historyNote": [
    ],
  • "http://www.w3.org/2004/02/skos/core#editorialNote": [
    ],
  • "http://purl.org/dc/terms/created": [],
  • "http://purl.org/dc/terms/creator": [],
  • "http://www.w3.org/2002/07/owl#versionInfo": [
    ],
  • "http://rdf-vocabulary.ddialliance.org/xkos#compares": [],
  • "http://rdf-vocabulary.ddialliance.org/xkos#madeOf": [
    ]
}

Update a `Correspondence` object

header Parameters
x-pyst-auth-token
string (X-Pyst-Auth-Token)
Default:
Request Body schema: application/json
required
@id
required
@type
required
Array of strings (Object `@type`)
required
Array of objects (SKOS preferred labels (one per language)) non-empty
required
Array of objects (BIBO status (accepted/draft/rejected)) non-empty
Array of objects (SKOS notation (typed literal))
Default: []
Array of objects (SKOS change note with additional required fields)
Default: []
Array of objects (SKOS history note with additional required fields)
Default: []
Array of objects (SKOS editorial note with additional required fields)
Default: []
required
required
required
Array of objects (OWL version info) = 1 items
Array of objects (SKOS definition (one per language))
Default: []
required
Array of objects (List of `ConceptScheme` objects being compared) non-empty
property name*
additional property
any

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "http://www.w3.org/2004/02/skos/core#prefLabel": [
    ],
  • "http://purl.org/ontology/bibo/status": [],
  • "http://www.w3.org/2004/02/skos/core#definition": [
    ],
  • "http://www.w3.org/2004/02/skos/core#notation": [],
  • "http://www.w3.org/2004/02/skos/core#changeNote": [
    ],
  • "http://www.w3.org/2004/02/skos/core#historyNote": [
    ],
  • "http://www.w3.org/2004/02/skos/core#editorialNote": [
    ],
  • "http://purl.org/dc/terms/created": [],
  • "http://purl.org/dc/terms/creator": [],
  • "http://www.w3.org/2002/07/owl#versionInfo": [
    ],
  • "http://rdf-vocabulary.ddialliance.org/xkos#compares": [],
  • "http://rdf-vocabulary.ddialliance.org/xkos#madeOf": [
    ]
}

Delete a `Correspondence` object

path Parameters
iri
required
string (Iri)
header Parameters
x-pyst-auth-token
string (X-Pyst-Auth-Token)
Default:

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Add some `Correspondence` `madeOf` links

header Parameters
x-pyst-auth-token
string (X-Pyst-Auth-Token)
Default:
Request Body schema: application/json
required
@id
required
required
Array of objects (List of `ConceptAssociation` objects in a `Correspondence`)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "http://www.w3.org/2004/02/skos/core#prefLabel": [
    ],
  • "http://purl.org/ontology/bibo/status": [],
  • "http://www.w3.org/2004/02/skos/core#definition": [
    ],
  • "http://www.w3.org/2004/02/skos/core#notation": [],
  • "http://www.w3.org/2004/02/skos/core#changeNote": [
    ],
  • "http://www.w3.org/2004/02/skos/core#historyNote": [
    ],
  • "http://www.w3.org/2004/02/skos/core#editorialNote": [
    ],
  • "http://purl.org/dc/terms/created": [],
  • "http://purl.org/dc/terms/creator": [],
  • "http://www.w3.org/2002/07/owl#versionInfo": [
    ],
  • "http://rdf-vocabulary.ddialliance.org/xkos#compares": [],
  • "http://rdf-vocabulary.ddialliance.org/xkos#madeOf": [
    ]
}

Remove some `Correspondence` `madeOf` links

header Parameters
x-pyst-auth-token
string (X-Pyst-Auth-Token)
Default:
Request Body schema: application/json
required
@id
required
required
Array of objects (List of `ConceptAssociation` objects in a `Correspondence`)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "http://www.w3.org/2004/02/skos/core#prefLabel": [
    ],
  • "http://purl.org/ontology/bibo/status": [],
  • "http://www.w3.org/2004/02/skos/core#definition": [
    ],
  • "http://www.w3.org/2004/02/skos/core#notation": [],
  • "http://www.w3.org/2004/02/skos/core#changeNote": [
    ],
  • "http://www.w3.org/2004/02/skos/core#historyNote": [
    ],
  • "http://www.w3.org/2004/02/skos/core#editorialNote": [
    ],
  • "http://purl.org/dc/terms/created": [],
  • "http://purl.org/dc/terms/creator": [],
  • "http://www.w3.org/2002/07/owl#versionInfo": [
    ],
  • "http://rdf-vocabulary.ddialliance.org/xkos#compares": [],
  • "http://rdf-vocabulary.ddialliance.org/xkos#madeOf": [
    ]
}

ConceptAssociation

Get an `Association` object

query Parameters
Correspondence Iri (string) or Correspondence Iri (null) (Correspondence Iri)
Source Concept Iri (string) or Source Concept Iri (null) (Source Concept Iri)
Target Concept Iri (string) or Target Concept Iri (null) (Target Concept Iri)
AssociationKind (string) or Kind (null) (Kind)

Responses

Response samples

Content type
application/json
[]

Get an `Association` object

path Parameters
iri
required
string (Iri)

Responses

Response samples

Content type
application/json
{}

Create an `Association` object

header Parameters
x-pyst-auth-token
string (X-Pyst-Auth-Token)
Default:
Request Body schema: application/json
required
@id
required
@type
required
Array of strings (Object `@type`)
required
Array of objects (List of source `Concept` objects) non-empty
required
Array of objects (List of target `Concept` objects) non-empty
property name*
additional property
any

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Delete an `Association` object

path Parameters
iri
required
string (Iri)
header Parameters
x-pyst-auth-token
string (X-Pyst-Auth-Token)
Default:

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}