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 OCLC APIs > Get Started.
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 APIs, view OCLC API documentation, and participate in the OCLC APIs community.
Paths
GET /management/entities/{ids}
GET /management/entities/{id}/references
GET /management/entities/{id}/history
POST /management/entities
PATCH /management/entities/{id}
POST /management/entities/{id}/flag
Examples
Create entity - Key Information only:
https://entities.api.oclc.org/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:
https://entities.api.oclc.org/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" } ] } ] }, "history": { "agent": "ADMIN" } }