Label Resource

Introduction

Labels may be assigned to various objects like business partners, products or orders.

Whenever a new label is assigend to one of above mentioned objects, a corresponding label object is created if not existent yet.

Example URL

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

Allowed methods: GET, POST, PUT.

List labels:

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

Search for labels by keyword:

https://api.openpublishing.com/resource/v3/labels?q=test

Search for labels by name:

https://api.openpublishing.com/resource/v3/labels?name=test

Fields

Name

name of the label. May be an arbitrary sting.

Color

color of the label in the interface.

Realm

realm is the Open Publishing terminology for tenant. It contains a dict with _id and name and screenname.

Example JSON

{
   "_id": "translation_original",
   "color": null,
   "name": "translation_Original",
   "realm": {
      "_id": 23,
      "name": "testpublisher",
      "screenname": "Test Publisher"
   }
}