Entity Management API

Discover the details of the Entity Management API.

Overview

Through the Entity Management API users can create and edit WorldCat Entity data.

 Note: Included with OCLC Meridian Subscription.

To learn about OCLC APIs and get started with the Entity Management API, see:

If you're ready to start using the Entity Management API, the OCLC Developer Network can help you learn more. The OCLC Developer Network allows you to learn about OCLC APIsview OCLC API documentation, and participate in the OCLC APIs community.

Paths

GET v1/management/entities/{id}
GET v1/management/entities/{id}/references
GET v1/management/entities/{id}/history
POST v1/management/entities
PATCH v1/management/entities/{id}
POST v1/management/entities/{id}/flag

Authorization Scopes

Ejemplos

GET v1/management/entities/{id}

Scope - entity-management:read_entities

Examplehttps://entities.api.oclc.org/v1/management/entities/E39PBJjCPhTpKwkW7gjMkpjBfq

Example code
{
    "sameAs": [
        "http://www.wikidata.org/entity/Q38453",
        "http://id.worldcat.org/fast/1206785",
        "http://id.loc.gov/authorities/names/n79126460",
        "http://viaf.org/viaf/168448485",
        "http://sws.geonames.org/4575352"
    ],
    "administrativelyPartOf": [
        "https://id.oclc.org/worldcat/entity/E39QbtfRBC8KgYHtHkT8CBKfhB"
    ],
    "@context": "https://id.oclc.org/api/context.json",
    "id": "https://id.oclc.org/worldcat/entity/E39PBJjCPhTpKwkW7gjMkpjBfq",
    "prefLabel": {
        "ar": "كولومبيا",
        "be": "Горад Калумбія",
        "bg": "Колумбия",
        "bn": "কলাম্বিয়া",
        "da": "Columbia",
        "de": "Columbia",
        "el": "Κολούμπια",
        "en": "Columbia",
        "eo": "Columbia",
        "es": "Columbia",
        "fa": "کلمبیا، کارولینای جنوبی",
        "fi": "Columbia",
        "fr": "Columbia",
        "fy": "Kolumbia",
        "gu": "કોલંબિયા",
        "he": "קולומביה",
        "hi": "कोलंबिया",
        "hy": "Կոլումբիա",
        "id": "Columbia",
        "io": "Columbia",
        "it": "Columbia",
        "ja": "コロンビア",
        "ka": "კოლუმბია",
        "ko": "컬럼비아",
        "ky": "Колумбия",
        "lt": "Kolumbija",
        "lv": "Kolumbija",
        "mk": "Колумбија",
        "mr": "कोलंबिया",
        "nl": "Columbia",
        "nn": "Columbia i Sør-Carolina",
        "no": "Columbia",
        "oc": "Columbia",
        "os": "Колумби",
        "pi": "कोलम्बिया",
        "pl": "Columbia",
        "pt": "Colúmbia",
        "ru": "Колумбия",
        "sa": "कोलम्बिया",
        "sc": "Colùmbia",
        "sk": "Columbia",
        "sr": "Коламбија",
        "sv": "Columbia",
        "ta": "கொலம்பியா",
        "te": "కొలంబియా",
        "uk": "Колумбія",
        "ur": "کولمبیا، جنوبی کیرولائنا",
        "yi": "קאלאמביע",
        "zh": "哥伦比亚",
        "mrj": "Колумби",
        "sgs": "Kuolumbėjė"
    },
    "altLabel": {
        "en": [
            "South Carolina--Columbia"
        ]
    },
    "elevation": [
        {
            "type": [
                "Measurement"
            ],
            "unit": {
                "type": [
                    "Concept"
                ],
                "prefLabel": {
                    "en": "feet"
                }
            },
            "hasValue": "89"
        }
    ],
    "population": [
        {
            "type": [
                "Measurement"
            ],
            "hasValue": "133803"
        }
    ],
    "type": [
        "AdministrativeArea"
    ],
    "typeDetail": [
        "http://id.worldcat.org/fast/861748"
    ],
    "geographicCoordinates": [
        "Point(-81.03481 34.00071)"
    ],
    "description": {
        "en": "seat of a first-order administrative division in Richland County, South Carolina, United States, North America"
    }
}

GET v1/mangement/entities/{id}/references

Scope - entity-management:read_references

Examplehttps://entities.api.oclc.org/v1/management/entities/E39PBJjCPhTpKwkW7gjMkpjBfq/references

Example code

[
    {
        "digId": null,
        "version": 1,
        "agent": "127950",
        "entity_type": "AdministrativeArea",
        "change_type": "add",
        "change_date": "2024-06-03T17:39:14.2Z",
        "change_data": {
            "spatialArea": {
                "type": [
                    "Measurement"
                ],
                "unit": {
                    "type": [
                        "Concept"
                    ],
                    "prefLabel": {
                        "en": "sq mi"
                    }
                },
                "hasValue": "45.00"
            }
        },
        "count": 0
    },
    {
        "digId": null,
        "version": 2,
        "agent": "127950",
        "entity_type": "AdministrativeArea",
        "change_type": "remove",
        "change_date": "2024-06-03T17:39:20.65Z",
        "change_data": {
            "spatialArea": {
                "type": [
                    "Measurement"
                ],
                "unit": {
                    "type": [
                        "Concept"
                    ],
                    "prefLabel": {
                        "en": "sq mi"
                    }
                },
                "hasValue": "45.00"
            }
        },
        "count": 0
    }
]

GET v1/management/entities/{id}/history

Scope - entity-management:read_history

Example: https://entities.api.oclc.org/v1/management/entities/E39PBJdCvPcj33MDBF4HDyf6rq/history

Example code
[
    {
        "property": "elevation",
        "reference_id": "E39PBJjCPhTpKwkW7gjMkpjBfq$9141ec9c-1173-4846-a198-1dfbfe50fd72",
        "reference_url": "http://sws.geonames.org/4575352",
        "claim_data": {
            "elevation": {
                "type": [
                    "Measurement"
                ],
                "unit": {
                    "type": [
                        "Concept"
                    ],
                    "prefLabel": {
                        "en": "feet"
                    }
                },
                "hasValue": "89"
            }
        }
    },
    {
        "property": "administrativelyPartOf",
        "reference_id": "E39PBJjCPhTpKwkW7gjMkpjBfq$be9bd68f-8afb-4d6e-b273-e9153bfe1abe",
        "reference_url": "http://sws.geonames.org/4575352",
        "claim_data": {
            "administrativelyPartOf": "https://id.oclc.org/worldcat/entity/E39QbtfRBC8KgYHtHkT8CBKfhB"
        }
    },
    {
        "property": "geographicCoordinates",
        "reference_id": "E39PBJjCPhTpKwkW7gjMkpjBfq$975e69c2-1504-4f60-a6a3-37df452aa422",
        "reference_url": "http://sws.geonames.org/4575352",
        "claim_data": {
            "geographicCoordinates": "Point(-81.03481 34.00071)"
        }
    },
    {
        "property": "population",
        "reference_id": "E39PBJjCPhTpKwkW7gjMkpjBfq$fe6f7019-7ac5-45e9-984d-ebe0803ebd9c",
        "reference_url": "http://sws.geonames.org/4575352",
        "claim_data": {
            "population": {
                "type": [
                    "Measurement"
                ],
                "hasValue": "133803"
            }
        }
    }
]

Create entity - Key Information only

Examplehttps://entities.api.oclc.org/v1/entity-management/entity

POST 

JSON body
{
    "entity_data": {
        "prefLabel": [
            {
                "language": "en",
                "value": " Douglas E. Johnston"
            }
        ],
        "description": [
            {
                "language": "en",
                "value": "Houston, Texas-area stockbroker specializing in oil & gas and natural resources"
            }
        ],
        "type": [
            "Person"
        ],
        "properties": [
            {"property": "residence",
            "values": [
                {
                    "id": "https://id.oclc.org/worldcat/entity/E39PBJcwwHg6ftwJRtD4b43G73"
                }
            ]
        },
        {
            "property": "spouse",
            "values": [
                {
                    "id": "https://id.oclc.org/worldcat/entity/E39QHJ8CVrFPdwhHGhmDhQyBd9"
                }
            ]
        },
        {
            "property": "language",
            "values": [
                {
                    "id": "https://entities.oclc.org/worldcat/entity/English"
                }
            ]
        }
    ]
}
}

Create entity - All Key Information and properties

Examplehttps://entities.api.oclc.org/v1/entity-management/entity

POST

JSON body
{
  "entity_data": {
    "prefLabel": [
      {
        "language": "en",
        "value": "English Label"
      },
      {
        "language": "de",
        "value": "German Label"
      },
      {
        "language": "es",
        "value": "Spanish Label"
      }
    ],
    "description": [
      {
        "language": "fr",
        "value": "French Description"
      }
    ],
    "type": [
      "Person"
    ],
    "properties": [
      {
        "property": "dateOfBirth",
        "values": [
          {
            "type": "Duration",
            "startDate": {
              "value": "1999-12-31",
              "precision": "Day"
            },
            "endDate": {
              "value": "1900-08",
              "precision": "Month"
            }
          }
        ]
      },
      {
        "property": "activeEndDate",
        "values": [
          {
            "type": "Instant",
            "date": {
              "value": "2009",
              "precision": "Year"
            }
          },
          {
            "type": "Instant",
            "date": {
              "value": "2009-08",
              "precision": "Month"
            }
          }
        ]
      },
      {
        "property": "activeStartDate",
        "values": [
          {
            "type": "Instant",
            "date": {
              "value": "2001-12-31",
              "precision": "Day"
            }
          },
          {
            "type": "Instant",
            "date": {
              "value": "2001-08",
              "precision": "Month"
            }
          }
        ]
      },
      {
        "property": "dateOfDeath",
        "values": [
          {
            "type": "Duration",
            "startDate": {
              "value": "1881-11-30",
              "precision": "Day"
            },
            "endDate": {
              "value": "1889-12",
              "precision": "Month"
            }
          }
        ]
      },
      {
        "property": "child",
        "values": [
          {
            "id": "https://entities.api.oclc.org/worldcat/entity/E39PBJqqBbF87HwVKrr47767pP"
          }
        ]
      },
      {
        "property": "educatedAt",
        "values": [
          {
            "id": "https://entities.api.oclc.org/worldcat/entity/E39PBJg4r3TCfqyp68WTMRDH4q"
          }
        ]
      },
      {
        "property": "parent",
        "values": [
          {
            "id": "https://entities.api.oclc.org/worldcat/entity/E39PBJjXhP9Wm7Bc6WqFrQBHG3"
          }
        ]
      },
      {
        "property": "placeOfBirth",
        "values": [
          {
            "id": "https://entities.api.oclc.org/worldcat/entity/E39PBJg4r3TCfqyp68WTMRDH4q"
          }
        ]
      },
      {
        "property": "placeOfDeath",
        "values": [
          {
            "id": "https://entities.api.oclc.org/worldcat/entity/E39PBJg4r3TCfqyp68WTMRDH4q"
          }
        ]
      },
      {
        "property": "residence",
        "values": [
          {
            "id": "https://entities.api.oclc.org/worldcat/entity/E39PBJg4r3TCfqyp68WTMRDH4q"
          }
        ]
      },
      {
        "property": "sibling",
        "values": [
          {
            "id": "https://entities.api.oclc.org/worldcat/entity/E39PBJdmg96Y7mBKhWB69pwKVC"
          }
        ]
      },
      {
        "property": "studentOf",
        "values": [
          {
            "id": "https://entities.api.oclc.org/worldcat/entity/E39Qhp4vB94Rq9k6fYrBP8hvGb"
          }
        ]
      },
      {
        "property": "ghostwriterFor",
        "values": [
          {
            "id": "https://entities.api.oclc.org/worldcat/entity/E39PBJhd96JcGqWmt9v3GtPRKd"
          }
        ]
      },
      {
        "property": "influencedBy",
        "values": [
          {
            "id": "https://entities.api.oclc.org/worldcat/entity/E39PBJxx96qPfyhwWrJChP9kXd"
          }
        ]
      },
      {
        "property": "language",
        "values": [
          {
            "id": "https://entities.api.oclc.org/worldcat/entity/English"
          }
        ]
      },
      {
        "property": "memberOf",
        "values": [
          {
            "id": "https://entities.api.oclc.org/worldcat/entity/E39PCGkfmpmf39btxvYpFHCxXd"
          }
        ]
      },
      {
        "property": "owner",
        "values": [
          {
            "id": "https://entities.api.oclc.org/worldcat/entity/E39PD3hVpJXmmjFQk3kqbbxCPP"
          }
        ]
      },
      {
        "property": "pseudonym",
        "values": [
          {
            "id": "https://entities.api.oclc.org/worldcat/entity/E39PD3hVpJXmmjFQk3kqbbxCPP"
          }
        ]
      },
      {
        "property": "acquired",
        "values": [
          {
            "value": "https://entities.api.oclc.org/worldcat/entity/E39PBJg4r3TCfqyp68WTMRDH4q"
          }
        ]
      },
      {
        "property": "enslaved",
        "values": [
          {
            "value": "https://entities.api.oclc.org/worldcat/entity/E39PBJhd96JcGqWmt9v3GtPRKd"
          }
        ]
      },
      {
        "property": "enslavedBy",
        "values": [
          {
            "value": "https://entities.api.oclc.org/worldcat/entity/E39PBJhd96JcGqWmt9v3GtPRKd"
          }
        ]
      }
    ]