Skip to content

Realm Resource

Introduction

A job in the Open Publishing ecosystem is a group of imprints/products/business partners to which a contractual partner of Open Publishing has access. (In the Microsoft world it would be referred as a tenant).

Example URL

https://api.openpublishing.com/resource/v3/realm/[ID]

Allowed methods: GET, PUT.

Search Filters

List jobs (if logged in with the scope of your customer, you will only see your own realm):

https://api.openpublishing.com/resource/v3/realm

Filter by external identifiers:

https://api.openpublishing.com/resource/v3/realms?external_identifier_type=klopotek&external_identifier_value=503107

external_identifier_type / external_identifier_value : Search for realms with an external identifier set. The external identifier type is the category of the realm, e.g. "gln" whereas the value is the id itself. If only external_identifier_type is specified, all realms with the external identifier type set are returned. If you search for only external_identifier_value - the system will return all identifiers with the value, where the type is not set.

Fields

Name

The name field contains the internal name of a realm. Name may only contain lowercase alphanumeric characters of which at least one character must be alphabetic.

Screen name

screenname contains the name displayed on the user interface.

External Identifiers

external_identifiers: List of external/foreign identifiers, e.g. the id of the business partner within other systems. The listed objects are dicts with the values type for the type of the identifier and value for the identifier itself.

Example JSON

{
    "_id": 1399,
    "_links": {
        "self": "https://api.openpublishing.com/resource/v3/realms/1399"
    },
    "external_identifiers": [
        {
            "type": "gln",
            "value": "4321432143212"
        }
    ],
    "name": "seriouspublishing",
    "screenname": "Serious Publishing Inc"
}