GraphQL API Documentation

Entity Queries

This section describes the available GraphQL API queries related to entity operations, their usage, required parameters, and example responses.

API Calls

Query Name	Description
getAuthorities	Fetches All Authorities
getAuthorityById	Fetches an Authority by Id
getAuthorityByPage	Fetches a paginated list of Authorities
getIdentifierById	Fetches an Identifier by Id
getIdentifiers	Fetches All Identifiers
getIdentifiersByPage	Fetches a paginated list of identifiers
getMPAById	Fetches a MPA by Id
getMPAs	Get All MPA
getMPAsByPage	Fetches a paginated list of MPA
getManagerById	Fetches a Manager by Id
getManagerByPage	Fetches a paginated list of Managers
getManagers	Get All Managers
getProviderById	Fetches a Provider by Id
getProviders	Get All Providers
getProvidersByPage	Fetches a paginated list of identifiers
getSchemeById	Fetches a Scheme by Id
getSchemes	Get All Schemes
getStandardBodyById	Fetches a StandardBody by Id
getStandardById	Fetches a Standard by Id
getStandardByPage	Fetches a paginated list of Scheme
getStandards	Get All Standards
getStandardsBody	Get All StandardsBodies
getStandardsBodyByPage	Fetches a paginated list of StandardsBodies

[POST]: getAuthorities

Description

📌 Fetches All Authorities

Input

query getAuthorities()

Headers

{
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

Query

query {
  getAuthorities {
    descAuthority
    idAuthority
    labelAuthority
    lastTouch
    lodAUT
    nameAuthority
    populatedBy
  }
}

Response

Headers

Status: 200 OK

Response Type: Authority

Field Name	Type	Description
descAuthority	String	The description of the Authority
idAuthority	Int	The identifier of the Authority
labelAuthority	String	The label of the Authority
lastTouch	String	lastTouch
lodAUT	String	Unique identifier for the Authority
nameAuthority	String	The name of the Authority
populatedBy	String	populatedBy

Response body:

{
    "data": {
        "getAuthorities": [
            {
                "descAuthority": "Hosted by International ISBN Agency",
                "idAuthority": null,
                "labelAuthority": "International ISBN Agency",
                "lastTouch": "2025-02-04",
                "lodAUT": "pid_graph:00C7B7CF",
                "nameAuthority": "ISBN",
                "populatedBy": "0000-0002-0255-5101"
            },
            {
                "descAuthority": "Hosted by OCLC (Online Computer Library Center)",
                "idAuthority": null,
                "labelAuthority": "OCLC (Online Computer Library Center)",
                "lastTouch": "2025-02-04",
                "lodAUT": "pid_graph:00F7B08C",
                "nameAuthority": "OCLC",
                "populatedBy": "0000-0002-0255-5101"
            },
            {
                "descAuthority": "National or Regional Tax Authorities",
                "idAuthority": null,
                "labelAuthority": "National or Regional Tax Authorities",
                "lastTouch": "2025-02-04",
                "lodAUT": "pid_graph:0217054B",
                "nameAuthority": "National or Regional Tax Authorities",
                "populatedBy": "0000-0002-0255-5101"
            }
        ]
    }
}

[POST]: getAuthorityById

Description

📌 Fetches an Authority by Id

Input

query getAuthorityById(id: String)

Headers

{
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

Query

query {
  getAuthorityById(id: String) {
    descAuthority
    idAuthority
    labelAuthority
    lastTouch
    lodAUT
    nameAuthority
    populatedBy
  }
}

Response

Headers

Status: 200 OK

Response Type: Authority

Field Name	Type	Description
descAuthority	String	The description of the Authority
idAuthority	Int	The identifier of the Authority
labelAuthority	String	The label of the Authority
lastTouch	String	lastTouch
lodAUT	String	Unique identifier for the Authority
nameAuthority	String	The name of the Authority
populatedBy	String	populatedBy

Response body:

{
    "data": {
        "getAuthorityById": {
            "descAuthority": "Hosted by International ISBN Agency",
            "idAuthority": null,
            "labelAuthority": "International ISBN Agency",
            "lastTouch": "2025-02-04",
            "lodAUT": "pid_graph:00C7B7CF",
            "nameAuthority": "ISBN",
            "populatedBy": "0000-0002-0255-5101"
        }
    }
}

[POST]: getAuthorityByPage

Description

📌 Fetches a paginated list of Authorities

Input

query getAuthorityByPage(page: Int, size: Int)

Headers

{
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

Query

query {
  getAuthorityByPage(page: Int, size: Int) {
    descAuthority
    idAuthority
    labelAuthority
    lastTouch
    lodAUT
    nameAuthority
    populatedBy
  }
}

Response

Headers

Status: 200 OK

Response Type: Authority

Field Name	Type	Description
descAuthority	String	The description of the Authority
idAuthority	Int	The identifier of the Authority
labelAuthority	String	The label of the Authority
lastTouch	String	lastTouch
lodAUT	String	Unique identifier for the Authority
nameAuthority	String	The name of the Authority
populatedBy	String	populatedBy

Response body:

{
    "data": {
        "getAuthorityByPage": [
            {
                "descAuthority": "Hosted by International ISBN Agency",
                "idAuthority": null,
                "labelAuthority": "International ISBN Agency",
                "lastTouch": "2025-02-04",
                "lodAUT": "pid_graph:00C7B7CF",
                "nameAuthority": "ISBN",
                "populatedBy": "0000-0002-0255-5101"
            },
            {
                "descAuthority": "Hosted by OCLC (Online Computer Library Center)",
                "idAuthority": null,
                "labelAuthority": "OCLC (Online Computer Library Center)",
                "lastTouch": "2025-02-04",
                "lodAUT": "pid_graph:00F7B08C",
                "nameAuthority": "OCLC",
                "populatedBy": "0000-0002-0255-5101"
            },
            {
                "descAuthority": "National or Regional Tax Authorities",
                "idAuthority": null,
                "labelAuthority": "National or Regional Tax Authorities",
                "lastTouch": "2025-02-04",
                "lodAUT": "pid_graph:0217054B",
                "nameAuthority": "National or Regional Tax Authorities",
                "populatedBy": "0000-0002-0255-5101"
            }
        ]
    }
}

[POST]: getIdentifierById

Description

📌 Fetches an Identifier by Id

Input

query getIdentifierById(id: String)

Headers

{
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

Query

query {
  getIdentifierById(id: String) {
    descIdentifier
    idIdentifier
    labelIdentifier
    lastTouch
    lodIDN
    nameIdentifier
    populatedBy
    startDate
    version
  }
}

Response

Headers

Status: 200 OK

Response Type: Identifier

Field Name	Type	Description
descIdentifier	String	The description for the identifier
idIdentifier	Int	The identifier of the Identifier
labelIdentifier	String	The label for the Identifier
lastTouch	String	lastTouch
lodIDN	String	Unique identifier for the entry
nameIdentifier	String	The name of the Identifier
populatedBy	String	populatedBy
startDate	DateTime	startDate (ISO-8601)
version	String	The version of the Identifier

Response body:

{
    "data": {
        "getIdentifierById": {
            "descIdentifier": "Bibliographic reference code for a journal, maintained by Harvard",
            "idIdentifier": null,
            "labelIdentifier": "BibCode",
            "lastTouch": "30/01/2024",
            "lodIDN": "pid_graph:03A715EA1",
            "nameIdentifier": "BibCode",
            "populatedBy": "0000-0002-0255-5101",
            "startDate": null,
            "version": null
        }
    }
}

[POST]: getIdentifiers

Description

📌 Fetches All Identifiers

Input

query getIdentifiers()

Headers

{
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

Query

query {
  getIdentifiers {
    descIdentifier
    idIdentifier
    labelIdentifier
    lastTouch
    lodIDN
    nameIdentifier
    populatedBy
    startDate
    version
  }
}

Response

Headers

Status: 200 OK

Response Type: Identifier

Field Name	Type	Description
descIdentifier	String	The description for the identifier
idIdentifier	Int	The identifier of the Identifier
labelIdentifier	String	The label for the Identifier
lastTouch	String	lastTouch
lodIDN	String	Unique identifier for the entry
nameIdentifier	String	The name of the Identifier
populatedBy	String	populatedBy
startDate	DateTime	startDate (ISO-8601)
version	String	The version of the Identifier

Response body:

{
    "data": {
        "getIdentifiers": [
            {
                "descIdentifier": null,
                "idIdentifier": null,
                "labelIdentifier": "Book ID",
                "lastTouch": "30/01/2024",
                "lodIDN": "pid_graph:55673516",
                "nameIdentifier": "Book ID",
                "populatedBy": "0000-0002-0255-5101",
                "startDate": null,
                "version": null
            },
            {
                "descIdentifier": "No Identifier has been selected or indicated in relation to recommended use, or in other relationships in the Knowledge Base",
                "idIdentifier": null,
                "labelIdentifier": "Not Applicable",
                "lastTouch": "30/01/2024",
                "lodIDN": "pid_graph:075D8338X",
                "nameIdentifier": "Not Applicable",
                "populatedBy": "0000-0002-0255-5101",
                "startDate": null,
                "version": null
            },
            {
                "descIdentifier": "PubChem BioAssay contains small-molecule and RNAi screening data along with associated annotation information from contributing organizations. BioAssay contains a collection of bioactivity and toxicity data that has greatly supported research in fields such as medicinal chemistry, drug discovery, pharmaceutical genomics and informatics research. As a primary archive, the provenance of all records belongs to the submitter.",
                "idIdentifier": null,
                "labelIdentifier": "AID",
                "lastTouch": "30/01/2024",
                "lodIDN": "pid_graph:075D8338",
                "nameIdentifier": "AID",
                "populatedBy": "0000-0002-0255-5101",
                "startDate": null,
                "version": null
            }
        ]
    }
}

[POST]: getIdentifiersByPage

Description

📌 Fetches a paginated list of identifiers

Input

query getIdentifiersByPage(page: Int, size: Int)

Headers

{
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

Query

query {
  getIdentifiersByPage(page: Int, size: Int) {
    descIdentifier
    idIdentifier
    labelIdentifier
    lastTouch
    lodIDN
    nameIdentifier
    populatedBy
    startDate
    version
  }
}

Response

Headers

Status: 200 OK

Response Type: Identifier

Field Name	Type	Description
descIdentifier	String	The description for the identifier
idIdentifier	Int	The identifier of the Identifier
labelIdentifier	String	The label for the Identifier
lastTouch	String	lastTouch
lodIDN	String	Unique identifier for the entry
nameIdentifier	String	The name of the Identifier
populatedBy	String	populatedBy
startDate	DateTime	startDate (ISO-8601)
version	String	The version of the Identifier

Response body:

{
    "data": {
        "getIdentifiersByPage": [
            {
                "descIdentifier": null,
                "idIdentifier": null,
                "labelIdentifier": "Book ID",
                "lastTouch": "30/01/2024",
                "lodIDN": "pid_graph:55673516",
                "nameIdentifier": "Book ID",
                "populatedBy": "0000-0002-0255-5101",
                "startDate": null,
                "version": null
            },
            {
                "descIdentifier": "No Identifier has been selected or indicated in relation to recommended use, or in other relationships in the Knowledge Base",
                "idIdentifier": null,
                "labelIdentifier": "Not Applicable",
                "lastTouch": "30/01/2024",
                "lodIDN": "pid_graph:075D8338X",
                "nameIdentifier": "Not Applicable",
                "populatedBy": "0000-0002-0255-5101",
                "startDate": null,
                "version": null
            },
            {
                "descIdentifier": "PubChem BioAssay contains small-molecule and RNAi screening data along with associated annotation information from contributing organizations. BioAssay contains a collection of bioactivity and toxicity data that has greatly supported research in fields such as medicinal chemistry, drug discovery, pharmaceutical genomics and informatics research. As a primary archive, the provenance of all records belongs to the submitter.",
                "idIdentifier": null,
                "labelIdentifier": "AID",
                "lastTouch": "30/01/2024",
                "lodIDN": "pid_graph:075D8338",
                "nameIdentifier": "AID",
                "populatedBy": "0000-0002-0255-5101",
                "startDate": null,
                "version": null
            }
        ]
    }
}

[POST]: getMPAById

Description

📌 Fetches a MPA by Id

Input

query getMPAById(id: String)

Headers

{
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

Query

query {
  getMPAById(id: String) {
    descMPA
    idMPA
    labelMPA
    lastTouch
    lodMPA
    nameMPA
    populatedBy
    startDate
  }
}

Response

Headers

Status: 200 OK

Response Type: MPA

Field Name	Type	Description
descMPA	String	The description of the Multi-Provider-Agency (MPA)
idMPA	Int	The identifier code
labelMPA	String	The label of the Multi-Provider-Agency (MPA)
lastTouch	String	lastTouch
lodMPA	String	Unique identifier for the Multi-Provider-Agency (MPA)
nameMPA	String	The name of the Multi-Provider-Agency (MPA)
populatedBy	String	populatedBy
startDate	DateTime	startDate (ISO-8601)

Response body:

{
    "data": {
        "getMPAById": {
            "descMPA": "Corporation for National Research Initiatives (CNRI) is a not-for-profit organization formed in 1986 to undertake, foster, and promote research in the public interest. Activities center around strategic development of network-based information technologies, providing leadership and funding for information infrastructure research and development.",
            "idMPA": null,
            "labelMPA": "Corporation for National Research Initiatives (CNRI)",
            "lastTouch": "20-08-2024",
            "lodMPA": "pid_graph:70E2C260",
            "nameMPA": "CNRI",
            "populatedBy": "0000-0002-0255-5101",
            "startDate": null
        }
    }
}

[POST]: getMPAs

Description

📌 Get All MPA

Input

query getMPAs()

Headers

{
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

Query

query {
  getMPAs {
    descMPA
    idMPA
    labelMPA
    lastTouch
    lodMPA
    nameMPA
    populatedBy
    startDate
  }
}

Response

Headers

Status: 200 OK

Response Type: MPA

Field Name	Type	Description
descMPA	String	The description of the Multi-Provider-Agency (MPA)
idMPA	Int	The identifier code
labelMPA	String	The label of the Multi-Provider-Agency (MPA)
lastTouch	String	lastTouch
lodMPA	String	Unique identifier for the Multi-Provider-Agency (MPA)
nameMPA	String	The name of the Multi-Provider-Agency (MPA)
populatedBy	String	populatedBy
startDate	DateTime	startDate (ISO-8601)

Response body:

{
    "data": {
        "getMPAs": [
            {
                "descMPA": "Multi-Provider Agencies are only applicable for some Providers linked to DONA.",
                "idMPA": null,
                "labelMPA": "Not Applicable",
                "lastTouch": "22-01-2025",
                "lodMPA": "pid_graph:98714B4C1",
                "nameMPA": "N/A",
                "populatedBy": "0000-0002-0255-5101",
                "startDate": null
            },
            {
                "descMPA": "Corporation for National Research Initiatives (CNRI) is a not-for-profit organization formed in 1986 to undertake, foster, and promote research in the public interest. Activities center around strategic development of network-based information technologies, providing leadership and funding for information infrastructure research and development.",
                "idMPA": null,
                "labelMPA": "Corporation for National Research Initiatives (CNRI)",
                "lastTouch": "20-08-2024",
                "lodMPA": "pid_graph:70E2C260",
                "nameMPA": "CNRI",
                "populatedBy": "0000-0002-0255-5101",
                "startDate": null
            },
            {
                "descMPA": "ePIC was founded in 2009 by a consortium of European partners in order to provide PID services for the European Research Community, based on the handle system",
                "idMPA": null,
                "labelMPA": "PID Consortium",
                "lastTouch": "20-08-2024",
                "lodMPA": "pid_graph:28A16295",
                "nameMPA": "ePIC",
                "populatedBy": "0000-0002-0255-5101",
                "startDate": null
            }
        ]
    }
}

[POST]: getMPAsByPage

Description

📌 Fetches a paginated list of MPA

Input

query getMPAsByPage(page: Int, size: Int)

Headers

{
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

Query

query {
  getMPAsByPage(page: Int, size: Int) {
    descMPA
    idMPA
    labelMPA
    lastTouch
    lodMPA
    nameMPA
    populatedBy
    startDate
  }
}

Response

Headers

Status: 200 OK

Response Type: MPA

Field Name	Type	Description
descMPA	String	The description of the Multi-Provider-Agency (MPA)
idMPA	Int	The identifier code
labelMPA	String	The label of the Multi-Provider-Agency (MPA)
lastTouch	String	lastTouch
lodMPA	String	Unique identifier for the Multi-Provider-Agency (MPA)
nameMPA	String	The name of the Multi-Provider-Agency (MPA)
populatedBy	String	populatedBy
startDate	DateTime	startDate (ISO-8601)

Response body:

{
    "data": {
        "getMPAsByPage": [
            {
                "descMPA": "Multi-Provider Agencies are only applicable for some Providers linked to DONA.",
                "idMPA": null,
                "labelMPA": "Not Applicable",
                "lastTouch": "22-01-2025",
                "lodMPA": "pid_graph:98714B4C1",
                "nameMPA": "N/A",
                "populatedBy": "0000-0002-0255-5101",
                "startDate": null
            },
            {
                "descMPA": "Corporation for National Research Initiatives (CNRI) is a not-for-profit organization formed in 1986 to undertake, foster, and promote research in the public interest. Activities center around strategic development of network-based information technologies, providing leadership and funding for information infrastructure research and development.",
                "idMPA": null,
                "labelMPA": "Corporation for National Research Initiatives (CNRI)",
                "lastTouch": "20-08-2024",
                "lodMPA": "pid_graph:70E2C260",
                "nameMPA": "CNRI",
                "populatedBy": "0000-0002-0255-5101",
                "startDate": null
            },
            {
                "descMPA": "ePIC was founded in 2009 by a consortium of European partners in order to provide PID services for the European Research Community, based on the handle system",
                "idMPA": null,
                "labelMPA": "PID Consortium",
                "lastTouch": "20-08-2024",
                "lodMPA": "pid_graph:28A16295",
                "nameMPA": "ePIC",
                "populatedBy": "0000-0002-0255-5101",
                "startDate": null
            }
        ]
    }
}

[POST]: getManagerById

Description

📌 Fetches a Manager by Id

Input

query getManagerById(id: String)

Headers

{
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

Query

query {
  getManagerById(id: String) {
    certification
    country
    descManager
    labelManager
    lastTouch
    lodMAN
    nameManager
    populatedBy
    startDate
    version
  }
}

Response

Headers

Status: 200 OK

Response Type: Manager

Field Name	Type	Description
certification	String	The certification of the Manager
country	String	The country of the Manager
descManager	String	The description of the Manager
labelManager	String	The label of the Manager
lastTouch	String	lastTouch
lodMAN	String	Unique identifier for the Manager
nameManager	String	The name of the Manager
populatedBy	String	populatedBy
startDate	DateTime	startDate (ISO-8601)
version	String	The version of the Manager

Response body:

{
    "data": {
        "getManagerById": {
            "certification": null,
            "country": null,
            "descManager": null,
            "labelManager": "<intR>²Dok[§]",
            "lastTouch": "14-01-2025",
            "lodMAN": "pid_graph:2FBC5B5F",
            "nameManager": null,
            "populatedBy": "0009-0006-1756-5317",
            "startDate": null,
            "version": null
        }
    }
}

[POST]: getManagerByPage

Description

📌 Fetches a paginated list of Managers

Input

query getManagerByPage(page: Int, size: Int)

Headers

{
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

Query

query {
  getManagerByPage(page: Int, size: Int) {
    certification
    country
    descManager
    labelManager
    lastTouch
    lodMAN
    nameManager
    populatedBy
    startDate
    version
  }
}

Response

Headers

Status: 200 OK

Response Type: Manager

Field Name	Type	Description
certification	String	The certification of the Manager
country	String	The country of the Manager
descManager	String	The description of the Manager
labelManager	String	The label of the Manager
lastTouch	String	lastTouch
lodMAN	String	Unique identifier for the Manager
nameManager	String	The name of the Manager
populatedBy	String	populatedBy
startDate	DateTime	startDate (ISO-8601)
version	String	The version of the Manager

Response body:

{
    "data": {
        "getManagerByPage": [
            {
                "certification": null,
                "country": null,
                "descManager": null,
                "labelManager": "]a[repository",
                "lastTouch": "30-08-2024",
                "lodMAN": "pid_graph: 2FBE5E8A3",
                "nameManager": null,
                "populatedBy": "0009-0006-1756-5317",
                "startDate": "2018-12-31T23:00:00Z",
                "version": null
            },
            {
                "certification": null,
                "country": null,
                "descManager": null,
                "labelManager": "<intR>²Dok[§]",
                "lastTouch": "14-01-2025",
                "lodMAN": "pid_graph:2FBC5B5F",
                "nameManager": null,
                "populatedBy": "0009-0006-1756-5317",
                "startDate": null,
                "version": null
            },
            {
                "certification": null,
                "country": null,
                "descManager": null,
                "labelManager": "<odesi>",
                "lastTouch": "14-01-2025",
                "lodMAN": "pid_graph:C49FF22D",
                "nameManager": null,
                "populatedBy": "0009-0006-1756-5317",
                "startDate": null,
                "version": null
            }
        ]
    }
}

[POST]: getManagers

Description

📌 Get All Managers

Input

query getManagers()

Headers

{
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

Query

query {
  getManagers {
    certification
    country
    descManager
    labelManager
    lastTouch
    lodMAN
    nameManager
    populatedBy
    startDate
    version
  }
}

Response

Headers

Status: 200 OK

Response Type: Manager

Field Name	Type	Description
certification	String	The certification of the Manager
country	String	The country of the Manager
descManager	String	The description of the Manager
labelManager	String	The label of the Manager
lastTouch	String	lastTouch
lodMAN	String	Unique identifier for the Manager
nameManager	String	The name of the Manager
populatedBy	String	populatedBy
startDate	DateTime	startDate (ISO-8601)
version	String	The version of the Manager

Response body:

{
    "data": {
        "getManagers": [
            {
                "certification": null,
                "country": null,
                "descManager": null,
                "labelManager": "]a[repository",
                "lastTouch": "30-08-2024",
                "lodMAN": "pid_graph: 2FBE5E8A3",
                "nameManager": null,
                "populatedBy": "0009-0006-1756-5317",
                "startDate": "2018-12-31T23:00:00Z",
                "version": null
            },
            {
                "certification": null,
                "country": null,
                "descManager": null,
                "labelManager": "<intR>²Dok[§]",
                "lastTouch": "14-01-2025",
                "lodMAN": "pid_graph:2FBC5B5F",
                "nameManager": null,
                "populatedBy": "0009-0006-1756-5317",
                "startDate": null,
                "version": null
            },
            {
                "certification": null,
                "country": null,
                "descManager": null,
                "labelManager": "<odesi>",
                "lastTouch": "14-01-2025",
                "lodMAN": "pid_graph:C49FF22D",
                "nameManager": null,
                "populatedBy": "0009-0006-1756-5317",
                "startDate": null,
                "version": null
            }
        ]
    }
}

[POST]: getProviderById

Description

📌 Fetches a Provider by Id

Input

query getProviderById(id: String)

Headers

{
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

Query

query {
  getProviderById(id: String) {
    country
    descProvider
    idPRV
    labelProvider
    lastTouch
    lodPRV
    lodTPR
    nameProvider
    populatedBy
    startDate
    version
  }
}

Response

Headers

Status: 200 OK

Response Type: Provider

Field Name	Type	Description
country	String	The country of the Provider
descProvider	String	The description of the Provider
idPRV	Int	No description
labelProvider	String	The label of the Provider
lastTouch	Date	lastTouch (ISO-8601)
lodPRV	String	Unique identifier for the Provider
lodTPR	String	The unique identifier of the Type Provider
nameProvider	String	The identifier of the Provider
populatedBy	String	populatedBy
startDate	DateTime	startDate (ISO-8601)
version	String	The version of the Provider

Response body:

{
    "data": {
        "getProviderById": {
            "country": "AUS",
            "descProvider": "Sample holders and curators affiliated with Australian research organisations that do not offer their own IGSN minting service",
            "idPRV": null,
            "labelProvider": "Australian Research Data Commons (ARDC)",
            "lastTouch": "2024-08-18",
            "lodPRV": "pid_graph:3C391CE0",
            "lodTPR": "pid_graph:DB893DE8",
            "nameProvider": null,
            "populatedBy": "0000-0002-0255-5101",
            "startDate": null,
            "version": null
        }
    }
}

[POST]: getProviders

Description

📌 Get All Providers

Input

query getProviders()

Headers

{
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

Query

query {
  getProviders {
    country
    descProvider
    idPRV
    labelProvider
    lastTouch
    lodPRV
    lodTPR
    nameProvider
    populatedBy
    startDate
    version
  }
}

Response

Headers

Status: 200 OK

Response Type: Provider

Field Name	Type	Description
country	String	The country of the Provider
descProvider	String	The description of the Provider
idPRV	Int	No description
labelProvider	String	The label of the Provider
lastTouch	Date	lastTouch (ISO-8601)
lodPRV	String	Unique identifier for the Provider
lodTPR	String	The unique identifier of the Type Provider
nameProvider	String	The identifier of the Provider
populatedBy	String	populatedBy
startDate	DateTime	startDate (ISO-8601)
version	String	The version of the Provider

Response body:

{
    "data": {
        "getProviders": [
            {
                "country": "AUS",
                "descProvider": null,
                "idPRV": null,
                "labelProvider": "RAID Australia",
                "lastTouch": "2025-01-19",
                "lodPRV": "pid_graph:6AA27949",
                "lodTPR": "pid_graph:DB893DE8",
                "nameProvider": null,
                "populatedBy": "0009-0006-1756-5317",
                "startDate": null,
                "version": null
            },
            {
                "country": "AUS",
                "descProvider": "Sample holders and curators affiliated with Australian research organisations that do not offer their own IGSN minting service",
                "idPRV": null,
                "labelProvider": "Australian Research Data Commons (ARDC)",
                "lastTouch": "2024-08-18",
                "lodPRV": "pid_graph:3C391CE0",
                "lodTPR": "pid_graph:DB893DE8",
                "nameProvider": null,
                "populatedBy": "0000-0002-0255-5101",
                "startDate": null,
                "version": null
            },
            {
                "country": "AUS",
                "descProvider": "Organization facilities and staff",
                "idPRV": null,
                "labelProvider": "Commonwealth Scientific and Industrial Research Organisation (CSIRO)",
                "lastTouch": "2024-08-18",
                "lodPRV": "pid_graph:F46811F9",
                "lodTPR": "pid_graph:DB893DE8",
                "nameProvider": null,
                "populatedBy": "0000-0002-0255-5101",
                "startDate": null,
                "version": null
            }
        ]
    }
}

[POST]: getProvidersByPage

Description

📌 Fetches a paginated list of identifiers

Input

query getProvidersByPage(page: Int, size: Int)

Headers

{
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

Query

query {
  getProvidersByPage(page: Int, size: Int) {
    country
    descProvider
    idPRV
    labelProvider
    lastTouch
    lodPRV
    lodTPR
    nameProvider
    populatedBy
    startDate
    version
  }
}

Response

Headers

Status: 200 OK

Response Type: Provider

Field Name	Type	Description
country	String	The country of the Provider
descProvider	String	The description of the Provider
idPRV	Int	No description
labelProvider	String	The label of the Provider
lastTouch	Date	lastTouch (ISO-8601)
lodPRV	String	Unique identifier for the Provider
lodTPR	String	The unique identifier of the Type Provider
nameProvider	String	The identifier of the Provider
populatedBy	String	populatedBy
startDate	DateTime	startDate (ISO-8601)
version	String	The version of the Provider

Response body:

{
    "data": {
        "getProvidersByPage": [
            {
                "country": "AUS",
                "descProvider": null,
                "idPRV": null,
                "labelProvider": "RAID Australia",
                "lastTouch": "2025-01-19",
                "lodPRV": "pid_graph:6AA27949",
                "lodTPR": "pid_graph:DB893DE8",
                "nameProvider": null,
                "populatedBy": "0009-0006-1756-5317",
                "startDate": null,
                "version": null
            },
            {
                "country": "AUS",
                "descProvider": "Sample holders and curators affiliated with Australian research organisations that do not offer their own IGSN minting service",
                "idPRV": null,
                "labelProvider": "Australian Research Data Commons (ARDC)",
                "lastTouch": "2024-08-18",
                "lodPRV": "pid_graph:3C391CE0",
                "lodTPR": "pid_graph:DB893DE8",
                "nameProvider": null,
                "populatedBy": "0000-0002-0255-5101",
                "startDate": null,
                "version": null
            },
            {
                "country": "AUS",
                "descProvider": "Organization facilities and staff",
                "idPRV": null,
                "labelProvider": "Commonwealth Scientific and Industrial Research Organisation (CSIRO)",
                "lastTouch": "2024-08-18",
                "lodPRV": "pid_graph:F46811F9",
                "lodTPR": "pid_graph:DB893DE8",
                "nameProvider": null,
                "populatedBy": "0000-0002-0255-5101",
                "startDate": null,
                "version": null
            }
        ]
    }
}

[POST]: getSchemeById

Description

📌 Fetches a Scheme by Id

Input

query getSchemeById(id: String)

Headers

{
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

Query

query {
  getSchemeById(id: String) {
    descScheme
    idSCH
    labelScheme
    lastTouch
    lodSCH
    lodTSC
    nameSCH
    populatedBy
    startDate
    version
  }
}

Response

Headers

Status: 200 OK

Response Type: Scheme

Field Name	Type	Description
descScheme	String	The description of the Scheme
idSCH	Int	The identifier of the Scheme
labelScheme	String	The label of the Scheme
lastTouch	String	lastTouch
lodSCH	String	Unique identifier for the Scheme
lodTSC	String	The unique identifier of the Type Scheme
nameSCH	String	The name of the Scheme
populatedBy	String	populatedBy
startDate	DateTime	startDate (ISO-8601)
version	String	The version of the Scheme

Response body:

{
    "data": {
        "getSchemeById": {
            "descScheme": "The dbGaP ID (Database of Genotypes and Phenotypes Identifier) is a unique alphanumeric identifier assigned to studies, datasets, and other entities within the NCBI’s dbGaP database. The dbGaP ID scheme typically consists of a prefix followed by a numeric",
            "idSCH": null,
            "labelScheme": "dbGaP Scheme",
            "lastTouch": "12/12/2024",
            "lodSCH": "pid_graph:466E3789",
            "lodTSC": "Internal",
            "nameSCH": null,
            "populatedBy": "0000-0002-0255-5101",
            "startDate": null,
            "version": null
        }
    }
}

[POST]: getSchemes

Description

📌 Get All Schemes

Input

query getSchemes()

Headers

{
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

Query

query {
  getSchemes {
    descScheme
    idSCH
    labelScheme
    lastTouch
    lodSCH
    lodTSC
    nameSCH
    populatedBy
    startDate
    version
  }
}

Response

Headers

Status: 200 OK

Response Type: Scheme

Field Name	Type	Description
descScheme	String	The description of the Scheme
idSCH	Int	The identifier of the Scheme
labelScheme	String	The label of the Scheme
lastTouch	String	lastTouch
lodSCH	String	Unique identifier for the Scheme
lodTSC	String	The unique identifier of the Type Scheme
nameSCH	String	The name of the Scheme
populatedBy	String	populatedBy
startDate	DateTime	startDate (ISO-8601)
version	String	The version of the Scheme

Response body:

{
    "data": {
        "getSchemes": [
            {
                "descScheme": "The AID is an internal scheme specific to the PubChem database.",
                "idSCH": null,
                "labelScheme": "AID Scheme",
                "lastTouch": "12/12/2024",
                "lodSCH": "pid_graph:30823C63",
                "lodTSC": "Internal",
                "nameSCH": null,
                "populatedBy": "0000-0002-0255-5101",
                "startDate": null,
                "version": null
            },
            {
                "descScheme": "Unique number used to identify archival collection locations within the UK and key global repositories holding collections relating to British history",
                "idSCH": null,
                "labelScheme": "ARCHON Code",
                "lastTouch": "12/12/2024",
                "lodSCH": "pid_graph:4472D271",
                "lodTSC": "Internal",
                "nameSCH": null,
                "populatedBy": "0000-0002-0255-5101",
                "startDate": null,
                "version": null
            },
            {
                "descScheme": "ARK Identifier Scheme",
                "idSCH": null,
                "labelScheme": "ARK Scheme",
                "lastTouch": "12/12/2024",
                "lodSCH": "pid_graph:D662BC92",
                "lodTSC": "Published",
                "nameSCH": null,
                "populatedBy": "0000-0002-0255-5101",
                "startDate": null,
                "version": null
            }
        ]
    }
}

[POST]: getStandardBodyById

Description

📌 Fetches a StandardBody by Id

Input

query getStandardBodyById(id: String)

Headers

{
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

Query

query {
  getStandardBodyById(id: String) {
    descStandardsBody
    idSTB
    labelStandardsBody
    lastTouch
    lodSTB
    nameSTB
    populatedBy
    version
  }
}

Response

Headers

Status: 200 OK

Response Type: StandardsBody

Field Name	Type	Description
descStandardsBody	String	The description of the StandardsBody
idSTB	Int	The identifier of the StandardsBody
labelStandardsBody	String	The label of the StandardsBody
lastTouch	String	lastTouch
lodSTB	String	The unique identifier of the StandardsBody
nameSTB	String	The name of the StandardsBody
populatedBy	String	populatedBy
version	String	The version of the StandardsBody

Response body:

{
    "data": {
        "getStandardBodyById": null
    }
}

[POST]: getStandardById

Description

📌 Fetches a Standard by Id

Input

query getStandardById(id: String)

Headers

{
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

Query

query {
  getStandardById(id: String) {
    descStandard
    idSTD
    labelStandard
    lastTouch
    lodSTD
    lodSTD_V
    lodTST
    nameSTD
    populatedBy
    startDate
  }
}

Response

Headers

Status: 200 OK

Response Type: Standard

Field Name	Type	Description
descStandard	String	The description of the Standard
idSTD	Int	The identifier of the Standard
labelStandard	String	The label of the Standard
lastTouch	String	lastTouch
lodSTD	String	The identifier of the Standard
lodSTD_V	String	The version of the Standard
lodTST	String	The unique identifier of the Type Standard
nameSTD	String	The name of the Standard
populatedBy	String	populatedBy
startDate	DateTime	startDate (ISO-8601)

Response body:

{
    "data": {
        "getStandardById": {
            "descStandard": "The arXiv identifier does not conform to the DOI standard or any other ISO standards for unique identifiers. It is a custom system developed specifically for the arXiv repository.",
            "idSTD": null,
            "labelStandard": "arXiv Internal Standard",
            "lastTouch": "12/12/2024",
            "lodSTD": "pid_graph:FCDAACDB",
            "lodSTD_V": null,
            "lodTST": "Internal",
            "nameSTD": null,
            "populatedBy": "0000-0002-0255-5101",
            "startDate": null
        }
    }
}

[POST]: getStandardByPage

Description

📌 Fetches a paginated list of Scheme

Input

query getStandardByPage(page: Int, size: Int)

Headers

{
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

Query

query {
  getStandardByPage(page: Int, size: Int) {
    descScheme
    idSCH
    labelScheme
    lastTouch
    lodSCH
    lodTSC
    nameSCH
    populatedBy
    startDate
    version
  }
}

Response

Headers

Status: 200 OK

Response Type: Scheme

Field Name	Type	Description
descScheme	String	The description of the Scheme
idSCH	Int	The identifier of the Scheme
labelScheme	String	The label of the Scheme
lastTouch	String	lastTouch
lodSCH	String	Unique identifier for the Scheme
lodTSC	String	The unique identifier of the Type Scheme
nameSCH	String	The name of the Scheme
populatedBy	String	populatedBy
startDate	DateTime	startDate (ISO-8601)
version	String	The version of the Scheme

Response body:

 Example not provided

[POST]: getStandards

Description

📌 Get All Standards

Input

query getStandards()

Headers

{
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

Query

query {
  getStandards {
    descStandard
    idSTD
    labelStandard
    lastTouch
    lodSTD
    lodSTD_V
    lodTST
    nameSTD
    populatedBy
    startDate
  }
}

Response

Headers

Status: 200 OK

Response Type: Standard

Field Name	Type	Description
descStandard	String	The description of the Standard
idSTD	Int	The identifier of the Standard
labelStandard	String	The label of the Standard
lastTouch	String	lastTouch
lodSTD	String	The identifier of the Standard
lodSTD_V	String	The version of the Standard
lodTST	String	The unique identifier of the Type Standard
nameSTD	String	The name of the Standard
populatedBy	String	populatedBy
startDate	DateTime	startDate (ISO-8601)

Response body:

{
    "data": {
        "getStandards": [
            {
                "descStandard": "The SRA accession system is part of the larger Bioinformatics Data Management Systems used by the NCBI to manage, archive, and share genomic sequence data.",
                "idSTD": null,
                "labelStandard": "SRA Scheme Internal Standard",
                "lastTouch": "12/12/2024",
                "lodSTD": "pid_graph:03C5D7F5",
                "lodSTD_V": null,
                "lodTST": "Internal",
                "nameSTD": null,
                "populatedBy": "0000-0002-0255-5101",
                "startDate": null
            },
            {
                "descStandard": "No specific standard is known for this identifier. If yiou have information on the standard, please contact us via the helpdesk button (bottom right)",
                "idSTD": null,
                "labelStandard": "None",
                "lastTouch": "12/12/2024",
                "lodSTD": "pid_graph:03C5D7F5X",
                "lodSTD_V": null,
                "lodTST": "None",
                "nameSTD": null,
                "populatedBy": "0000-0002-0255-5101",
                "startDate": null
            },
            {
                "descStandard": "The Genome ID is  an internal identifier specific to the database or system in which it is used, such as NCBI’s Genome Database. The system for assigning GI numbers was developed by NCBI to manage the large amount of sequence data in its repositories, and",
                "idSTD": null,
                "labelStandard": "Genome ID Standard",
                "lastTouch": "12/12/2024",
                "lodSTD": "pid_graph:08650BA9",
                "lodSTD_V": null,
                "lodTST": "Internal",
                "nameSTD": null,
                "populatedBy": "0000-0002-0255-5101",
                "startDate": null
            }
        ]
    }
}

[POST]: getStandardsBody

Description

📌 Get All StandardsBodies

Input

query getStandardsBody()

Headers

{
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

Query

query {
  getStandardsBody {
    descStandardsBody
    idSTB
    labelStandardsBody
    lastTouch
    lodSTB
    nameSTB
    populatedBy
    version
  }
}

Response

Headers

Status: 200 OK

Response Type: StandardsBody

Field Name	Type	Description
descStandardsBody	String	The description of the StandardsBody
idSTB	Int	The identifier of the StandardsBody
labelStandardsBody	String	The label of the StandardsBody
lastTouch	String	lastTouch
lodSTB	String	The unique identifier of the StandardsBody
nameSTB	String	The name of the StandardsBody
populatedBy	String	populatedBy
version	String	The version of the StandardsBody

Response body:

{
    "data": {
        "getStandardsBody": [
            {
                "descStandardsBody": "GS1 is a not-for-profit, international organization developing and maintaining its own standards for barcodes and the corresponding issue company prefixes.",
                "idSTB": null,
                "labelStandardsBody": "GS1",
                "lastTouch": "12/12/2024",
                "lodSTB": "pid_graph:00503110",
                "nameSTB": null,
                "populatedBy": "0000-0002-0255-5101",
                "version": null
            },
            {
                "descStandardsBody": "Online database of information related to films, television series, and video games",
                "idSTB": null,
                "labelStandardsBody": "iMDB - Internet Movie Database",
                "lastTouch": "12/12/2024",
                "lodSTB": "pid_graph:054361CE",
                "nameSTB": null,
                "populatedBy": "0000-0002-0255-5101",
                "version": null
            },
            {
                "descStandardsBody": "The administration and maintenance of the GEPRIS Historisch IDs are managed by the DFG.",
                "idSTB": null,
                "labelStandardsBody": "Deutsche Forschungsgemeinschaft (DFG)",
                "lastTouch": "12/12/2024",
                "lodSTB": "pid_graph:0C19BBEE",
                "nameSTB": null,
                "populatedBy": "0000-0002-0255-5101",
                "version": null
            }
        ]
    }
}

[POST]: getStandardsBodyByPage

Description

📌 Fetches a paginated list of StandardsBodies

Input

query getStandardsBodyByPage(page: Int, size: Int)

Headers

{
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

Query

query {
  getStandardsBodyByPage(page: Int, size: Int) {
    descStandardsBody
    idSTB
    labelStandardsBody
    lastTouch
    lodSTB
    nameSTB
    populatedBy
    version
  }
}

Response

Headers

Status: 200 OK

Response Type: StandardsBody

Field Name	Type	Description
descStandardsBody	String	The description of the StandardsBody
idSTB	Int	The identifier of the StandardsBody
labelStandardsBody	String	The label of the StandardsBody
lastTouch	String	lastTouch
lodSTB	String	The unique identifier of the StandardsBody
nameSTB	String	The name of the StandardsBody
populatedBy	String	populatedBy
version	String	The version of the StandardsBody

Response body:

{
    "data": {
        "getStandardsBodyByPage": [
            {
                "descStandardsBody": "GS1 is a not-for-profit, international organization developing and maintaining its own standards for barcodes and the corresponding issue company prefixes.",
                "idSTB": null,
                "labelStandardsBody": "GS1",
                "lastTouch": "12/12/2024",
                "lodSTB": "pid_graph:00503110",
                "nameSTB": null,
                "populatedBy": "0000-0002-0255-5101",
                "version": null
            },
            {
                "descStandardsBody": "Online database of information related to films, television series, and video games",
                "idSTB": null,
                "labelStandardsBody": "iMDB - Internet Movie Database",
                "lastTouch": "12/12/2024",
                "lodSTB": "pid_graph:054361CE",
                "nameSTB": null,
                "populatedBy": "0000-0002-0255-5101",
                "version": null
            },
            {
                "descStandardsBody": "The administration and maintenance of the GEPRIS Historisch IDs are managed by the DFG.",
                "idSTB": null,
                "labelStandardsBody": "Deutsche Forschungsgemeinschaft (DFG)",
                "lastTouch": "12/12/2024",
                "lodSTB": "pid_graph:0C19BBEE",
                "nameSTB": null,
                "populatedBy": "0000-0002-0255-5101",
                "version": null
            }
        ]
    }
}

Entity Queries​

API Calls​

[POST]: getAuthorities​

Description​

Input​

Headers​

Query​

Response​

Headers​

Response Type: Authority​

Response body:​

[POST]: getAuthorityById​

Description​

Input​

Headers​

Query​

Response​

Headers​

Response Type: Authority​

Response body:​

[POST]: getAuthorityByPage​

Description​

Input​

Headers​

Query​

Response​

Headers​

Response Type: Authority​

Response body:​

[POST]: getIdentifierById​

Description​

Input​

Headers​

Query​

Response​

Headers​

Response Type: Identifier​

Response body:​

[POST]: getIdentifiers​

Description​

Input​

Headers​

Query​

Response​

Headers​

Response Type: Identifier​

Response body:​

[POST]: getIdentifiersByPage​

Description​

Input​

Headers​

Query​

Response​

Headers​

Response Type: Identifier​

Response body:​

[POST]: getMPAById​

Description​

Input​

Headers​

Query​

Response​

Headers​

Response Type: MPA​

Response body:​

[POST]: getMPAs​

Description​

Input​

Headers​

Query​

Response​

Headers​

Response Type: MPA​

Response body:​

[POST]: getMPAsByPage​

Description​

Input​

Headers​

Query​

Response​

Entity Queries

API Calls

[POST]: getAuthorities

Description

Input

Headers

Query

Response

Headers

Response Type: Authority

Response body:

[POST]: getAuthorityById

Description

Input

Headers

Query

Response

Headers

Response Type: Authority

Response body:

[POST]: getAuthorityByPage

Description

Input

Headers

Query

Response

Headers

Response Type: Authority

Response body:

[POST]: getIdentifierById

Description

Input

Headers

Query

Response

Headers

Response Type: Identifier

Response body:

[POST]: getIdentifiers

Description

Input

Headers

Query

Response

Headers

Response Type: Identifier

Response body:

[POST]: getIdentifiersByPage

Description

Input

Headers

Query

Response

Headers

Response Type: Identifier

Response body:

[POST]: getMPAById

Description

Input

Headers

Query

Response

Headers

Response Type: MPA

Response body:

[POST]: getMPAs

Description

Input

Headers

Query

Response

Headers

Response Type: MPA

Response body:

[POST]: getMPAsByPage

Description

Input

Headers

Query

Response