Subjects v3
CRUD operations subjects. Subjects are customer/publisher specific classifications of products. For academic publishers these are typically academic subjects (e.g. economic science or MINT).
Endpoints
GET /resource/v3/subjects
Retrieve a list of subjects
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
identifier |
querystring | string | No | Filter by identifier. Supports equal-operator (exact match) only. | |
name |
querystring | string | No | Filter by subject name. Supports equal-operator (exact match) only. | |
q |
querystring | string | No | Perform a full-text search across multiple fields. |
Response 200 OK
{
"links": {},
"items": [
{
"_id": 1,
"_links": {
"self": "https://api.openpublishing.com/resource/v3/subjects/23"
},
"realm": {
"_id": 23,
"_links": {
"self": "https://api.openpublishing.com/resource/v3/realms/0e1b578b-b998-427d-8a0c-6c09eeba91d6"
},
"name": "xyzpublishing",
"screenname": "XYZ Publishing"
},
"bisac": [
"SOC026000"
],
"description": "Test description",
"identifier": null,
"labels": [
"Society"
],
"name": [
{
"language": "ger",
"text": "Soziologie"
}
],
"vlb": [
"720"
]
}
]
}
Schema of the response body
{
"type": "object",
"properties": {
"links": {
"type": "object"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"_id": {
"type": "integer",
"example": 1
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "Link to the subject resource",
"example": "https://api.openpublishing.com/resource/v3/subjects/23"
}
}
},
"realm": {
"type": "object",
"description": "Reference to realm which owns this object",
"properties": {
"_id": {
"type": "int",
"description": "Realm ID",
"example": 23
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "Link to the realm resource",
"example": "https://api.openpublishing.com/resource/v3/realms/0e1b578b-b998-427d-8a0c-6c09eeba91d6"
}
}
},
"name": {
"type": "string",
"description": "Name of the realm",
"example": "xyzpublishing"
},
"screenname": {
"type": "string",
"description": "Screenname of the realm",
"example": "XYZ Publishing"
}
}
},
"bisac": {
"type": "array",
"description": "BISAC codes associated with the subject.",
"items": {
"type": "string"
},
"example": [
"SOC026000"
]
},
"description": {
"type": "string",
"description": "A brief description of the subject.",
"example": "Test description"
},
"identifier": {
"type": "string",
"description": "External identifier for the subject.",
"nullable": true,
"example": null
},
"labels": {
"type": "array",
"description": "List of labels categorizing the subject.",
"items": {
"type": "string"
},
"example": [
"Society"
]
},
"name": {
"type": "array",
"description": "Multi-language representation of the subject (s. [Multi-language Representation Format](../structured-fields/#multi-language-representation-format)).",
"items": {
"type": "object",
"properties": {
"language": {
"type": "string",
"example": "ger"
},
"text": {
"type": "string",
"example": "Soziologie"
}
}
}
},
"vlb": {
"type": "array",
"description": "VLB (German book trade) subject codes.",
"items": {
"type": "string"
},
"example": [
"720"
]
}
}
}
}
}
}
POST /resource/v3/subjects
Create a new subject
Request body
{
"_id": 1,
"_links": {
"self": "https://api.openpublishing.com/resource/v3/subjects/23"
},
"realm": {
"_id": 23,
"_links": {
"self": "https://api.openpublishing.com/resource/v3/realms/0e1b578b-b998-427d-8a0c-6c09eeba91d6"
},
"name": "xyzpublishing",
"screenname": "XYZ Publishing"
},
"bisac": [
"SOC026000"
],
"description": "Test description",
"identifier": null,
"labels": [
"Society"
],
"name": [
{
"language": "ger",
"text": "Soziologie"
}
],
"vlb": [
"720"
]
}
Schema of the request body
{
"type": "object",
"properties": {
"_id": {
"type": "integer",
"example": 1
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "Link to the subject resource",
"example": "https://api.openpublishing.com/resource/v3/subjects/23"
}
}
},
"realm": {
"type": "object",
"description": "Reference to realm which owns this object",
"properties": {
"_id": {
"type": "int",
"description": "Realm ID",
"example": 23
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "Link to the realm resource",
"example": "https://api.openpublishing.com/resource/v3/realms/0e1b578b-b998-427d-8a0c-6c09eeba91d6"
}
}
},
"name": {
"type": "string",
"description": "Name of the realm",
"example": "xyzpublishing"
},
"screenname": {
"type": "string",
"description": "Screenname of the realm",
"example": "XYZ Publishing"
}
}
},
"bisac": {
"type": "array",
"description": "BISAC codes associated with the subject.",
"items": {
"type": "string"
},
"example": [
"SOC026000"
]
},
"description": {
"type": "string",
"description": "A brief description of the subject.",
"example": "Test description"
},
"identifier": {
"type": "string",
"description": "External identifier for the subject.",
"nullable": true,
"example": null
},
"labels": {
"type": "array",
"description": "List of labels categorizing the subject.",
"items": {
"type": "string"
},
"example": [
"Society"
]
},
"name": {
"type": "array",
"description": "Multi-language representation of the subject (s. [Multi-language Representation Format](../structured-fields/#multi-language-representation-format)).",
"items": {
"type": "object",
"properties": {
"language": {
"type": "string",
"example": "ger"
},
"text": {
"type": "string",
"example": "Soziologie"
}
}
}
},
"vlb": {
"type": "array",
"description": "VLB (German book trade) subject codes.",
"items": {
"type": "string"
},
"example": [
"720"
]
}
}
}
Response 201 Created
{
"_id": 1,
"_links": {
"self": "https://api.openpublishing.com/resource/v3/subjects/23"
},
"realm": {
"_id": 23,
"_links": {
"self": "https://api.openpublishing.com/resource/v3/realms/0e1b578b-b998-427d-8a0c-6c09eeba91d6"
},
"name": "xyzpublishing",
"screenname": "XYZ Publishing"
},
"bisac": [
"SOC026000"
],
"description": "Test description",
"identifier": null,
"labels": [
"Society"
],
"name": [
{
"language": "ger",
"text": "Soziologie"
}
],
"vlb": [
"720"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"_id": {
"type": "integer",
"example": 1
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "Link to the subject resource",
"example": "https://api.openpublishing.com/resource/v3/subjects/23"
}
}
},
"realm": {
"type": "object",
"description": "Reference to realm which owns this object",
"properties": {
"_id": {
"type": "int",
"description": "Realm ID",
"example": 23
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "Link to the realm resource",
"example": "https://api.openpublishing.com/resource/v3/realms/0e1b578b-b998-427d-8a0c-6c09eeba91d6"
}
}
},
"name": {
"type": "string",
"description": "Name of the realm",
"example": "xyzpublishing"
},
"screenname": {
"type": "string",
"description": "Screenname of the realm",
"example": "XYZ Publishing"
}
}
},
"bisac": {
"type": "array",
"description": "BISAC codes associated with the subject.",
"items": {
"type": "string"
},
"example": [
"SOC026000"
]
},
"description": {
"type": "string",
"description": "A brief description of the subject.",
"example": "Test description"
},
"identifier": {
"type": "string",
"description": "External identifier for the subject.",
"nullable": true,
"example": null
},
"labels": {
"type": "array",
"description": "List of labels categorizing the subject.",
"items": {
"type": "string"
},
"example": [
"Society"
]
},
"name": {
"type": "array",
"description": "Multi-language representation of the subject (s. [Multi-language Representation Format](../structured-fields/#multi-language-representation-format)).",
"items": {
"type": "object",
"properties": {
"language": {
"type": "string",
"example": "ger"
},
"text": {
"type": "string",
"example": "Soziologie"
}
}
}
},
"vlb": {
"type": "array",
"description": "VLB (German book trade) subject codes.",
"items": {
"type": "string"
},
"example": [
"720"
]
}
}
}
GET /resource/v3/subjects/{id}
Retrieve a single subject by ID
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | string | No | The unique identifier of the subject |
Response 200 OK
{
"_id": 1,
"_links": {
"self": "https://api.openpublishing.com/resource/v3/subjects/23"
},
"realm": {
"_id": 23,
"_links": {
"self": "https://api.openpublishing.com/resource/v3/realms/0e1b578b-b998-427d-8a0c-6c09eeba91d6"
},
"name": "xyzpublishing",
"screenname": "XYZ Publishing"
},
"bisac": [
"SOC026000"
],
"description": "Test description",
"identifier": null,
"labels": [
"Society"
],
"name": [
{
"language": "ger",
"text": "Soziologie"
}
],
"vlb": [
"720"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"_id": {
"type": "integer",
"example": 1
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "Link to the subject resource",
"example": "https://api.openpublishing.com/resource/v3/subjects/23"
}
}
},
"realm": {
"type": "object",
"description": "Reference to realm which owns this object",
"properties": {
"_id": {
"type": "int",
"description": "Realm ID",
"example": 23
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "Link to the realm resource",
"example": "https://api.openpublishing.com/resource/v3/realms/0e1b578b-b998-427d-8a0c-6c09eeba91d6"
}
}
},
"name": {
"type": "string",
"description": "Name of the realm",
"example": "xyzpublishing"
},
"screenname": {
"type": "string",
"description": "Screenname of the realm",
"example": "XYZ Publishing"
}
}
},
"bisac": {
"type": "array",
"description": "BISAC codes associated with the subject.",
"items": {
"type": "string"
},
"example": [
"SOC026000"
]
},
"description": {
"type": "string",
"description": "A brief description of the subject.",
"example": "Test description"
},
"identifier": {
"type": "string",
"description": "External identifier for the subject.",
"nullable": true,
"example": null
},
"labels": {
"type": "array",
"description": "List of labels categorizing the subject.",
"items": {
"type": "string"
},
"example": [
"Society"
]
},
"name": {
"type": "array",
"description": "Multi-language representation of the subject (s. [Multi-language Representation Format](../structured-fields/#multi-language-representation-format)).",
"items": {
"type": "object",
"properties": {
"language": {
"type": "string",
"example": "ger"
},
"text": {
"type": "string",
"example": "Soziologie"
}
}
}
},
"vlb": {
"type": "array",
"description": "VLB (German book trade) subject codes.",
"items": {
"type": "string"
},
"example": [
"720"
]
}
}
}
PUT /resource/v3/subjects/{id}
Update subject
Request body
{
"_id": 1,
"_links": {
"self": "https://api.openpublishing.com/resource/v3/subjects/23"
},
"realm": {
"_id": 23,
"_links": {
"self": "https://api.openpublishing.com/resource/v3/realms/0e1b578b-b998-427d-8a0c-6c09eeba91d6"
},
"name": "xyzpublishing",
"screenname": "XYZ Publishing"
},
"bisac": [
"SOC026000"
],
"description": "Test description",
"identifier": null,
"labels": [
"Society"
],
"name": [
{
"language": "ger",
"text": "Soziologie"
}
],
"vlb": [
"720"
]
}
Schema of the request body
{
"type": "object",
"properties": {
"_id": {
"type": "integer",
"example": 1
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "Link to the subject resource",
"example": "https://api.openpublishing.com/resource/v3/subjects/23"
}
}
},
"realm": {
"type": "object",
"description": "Reference to realm which owns this object",
"properties": {
"_id": {
"type": "int",
"description": "Realm ID",
"example": 23
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "Link to the realm resource",
"example": "https://api.openpublishing.com/resource/v3/realms/0e1b578b-b998-427d-8a0c-6c09eeba91d6"
}
}
},
"name": {
"type": "string",
"description": "Name of the realm",
"example": "xyzpublishing"
},
"screenname": {
"type": "string",
"description": "Screenname of the realm",
"example": "XYZ Publishing"
}
}
},
"bisac": {
"type": "array",
"description": "BISAC codes associated with the subject.",
"items": {
"type": "string"
},
"example": [
"SOC026000"
]
},
"description": {
"type": "string",
"description": "A brief description of the subject.",
"example": "Test description"
},
"identifier": {
"type": "string",
"description": "External identifier for the subject.",
"nullable": true,
"example": null
},
"labels": {
"type": "array",
"description": "List of labels categorizing the subject.",
"items": {
"type": "string"
},
"example": [
"Society"
]
},
"name": {
"type": "array",
"description": "Multi-language representation of the subject (s. [Multi-language Representation Format](../structured-fields/#multi-language-representation-format)).",
"items": {
"type": "object",
"properties": {
"language": {
"type": "string",
"example": "ger"
},
"text": {
"type": "string",
"example": "Soziologie"
}
}
}
},
"vlb": {
"type": "array",
"description": "VLB (German book trade) subject codes.",
"items": {
"type": "string"
},
"example": [
"720"
]
}
}
}
Response 200 OK
{
"_id": 1,
"_links": {
"self": "https://api.openpublishing.com/resource/v3/subjects/23"
},
"realm": {
"_id": 23,
"_links": {
"self": "https://api.openpublishing.com/resource/v3/realms/0e1b578b-b998-427d-8a0c-6c09eeba91d6"
},
"name": "xyzpublishing",
"screenname": "XYZ Publishing"
},
"bisac": [
"SOC026000"
],
"description": "Test description",
"identifier": null,
"labels": [
"Society"
],
"name": [
{
"language": "ger",
"text": "Soziologie"
}
],
"vlb": [
"720"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"_id": {
"type": "integer",
"example": 1
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "Link to the subject resource",
"example": "https://api.openpublishing.com/resource/v3/subjects/23"
}
}
},
"realm": {
"type": "object",
"description": "Reference to realm which owns this object",
"properties": {
"_id": {
"type": "int",
"description": "Realm ID",
"example": 23
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "Link to the realm resource",
"example": "https://api.openpublishing.com/resource/v3/realms/0e1b578b-b998-427d-8a0c-6c09eeba91d6"
}
}
},
"name": {
"type": "string",
"description": "Name of the realm",
"example": "xyzpublishing"
},
"screenname": {
"type": "string",
"description": "Screenname of the realm",
"example": "XYZ Publishing"
}
}
},
"bisac": {
"type": "array",
"description": "BISAC codes associated with the subject.",
"items": {
"type": "string"
},
"example": [
"SOC026000"
]
},
"description": {
"type": "string",
"description": "A brief description of the subject.",
"example": "Test description"
},
"identifier": {
"type": "string",
"description": "External identifier for the subject.",
"nullable": true,
"example": null
},
"labels": {
"type": "array",
"description": "List of labels categorizing the subject.",
"items": {
"type": "string"
},
"example": [
"Society"
]
},
"name": {
"type": "array",
"description": "Multi-language representation of the subject (s. [Multi-language Representation Format](../structured-fields/#multi-language-representation-format)).",
"items": {
"type": "object",
"properties": {
"language": {
"type": "string",
"example": "ger"
},
"text": {
"type": "string",
"example": "Soziologie"
}
}
}
},
"vlb": {
"type": "array",
"description": "VLB (German book trade) subject codes.",
"items": {
"type": "string"
},
"example": [
"720"
]
}
}
}
DELETE /resource/v3/subjects/{id}
Delete subject
Response 204 No Content
GET /resource/v3/subjects/{subject_id}/texts
Retrieve a list of subject texts of subject
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
subject_id |
path | string | No | The unique identifier of the subject |
Response 200 OK
{
"links": {},
"items": [
{
"_id": "4cb7d96c-6f72-470e-884c-6b96bb99a22e",
"_links": {
"self": "https://api.openpublishing.com/resource/v3/subjects/ed7eaaa5-699a-491b-a5da-29e2d49caa46/texts/4cb7d96c-6f72-470e-884c-6b96bb99a22e"
},
"language": "eng",
"mime_type": "text/plain",
"text": "long-text-lorem-ipsom",
"timestamp": 1743391587,
"type": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua."
}
]
}
Schema of the response body
{
"type": "object",
"properties": {
"links": {
"type": "object"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"_id": {
"type": "string",
"description": "Unique identifier for the subject",
"example": "4cb7d96c-6f72-470e-884c-6b96bb99a22e"
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "string",
"example": "https://api.openpublishing.com/resource/v3/subjects/ed7eaaa5-699a-491b-a5da-29e2d49caa46/texts/4cb7d96c-6f72-470e-884c-6b96bb99a22e"
}
}
},
"language": {
"type": "string",
"description": "anguage code in ISO 639-2 format indicating the language of the text.",
"example": "eng"
},
"mime_type": {
"type": "string",
"description": "MIME type of the text content.",
"example": "text/plain"
},
"text": {
"type": "string",
"example": "long-text-lorem-ipsom",
"description": "The type of text, such as a description or title."
},
"timestamp": {
"type": "integer",
"desciption": "Unix timestamp representing creation or modification time.",
"example": 1743391587
},
"type": {
"type": "string",
"description": "The actual text content.",
"example": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua."
}
}
}
}
}
}
POST /resource/v3/subjects/{subject_id}/texts
Create a new subject text
Request body
{
"_id": "4cb7d96c-6f72-470e-884c-6b96bb99a22e",
"_links": {
"self": "https://api.openpublishing.com/resource/v3/subjects/ed7eaaa5-699a-491b-a5da-29e2d49caa46/texts/4cb7d96c-6f72-470e-884c-6b96bb99a22e"
},
"language": "eng",
"mime_type": "text/plain",
"text": "long-text-lorem-ipsom",
"timestamp": 1743391587,
"type": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua."
}
Schema of the request body
{
"type": "object",
"properties": {
"_id": {
"type": "string",
"description": "Unique identifier for the subject",
"example": "4cb7d96c-6f72-470e-884c-6b96bb99a22e"
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "string",
"example": "https://api.openpublishing.com/resource/v3/subjects/ed7eaaa5-699a-491b-a5da-29e2d49caa46/texts/4cb7d96c-6f72-470e-884c-6b96bb99a22e"
}
}
},
"language": {
"type": "string",
"description": "anguage code in ISO 639-2 format indicating the language of the text.",
"example": "eng"
},
"mime_type": {
"type": "string",
"description": "MIME type of the text content.",
"example": "text/plain"
},
"text": {
"type": "string",
"example": "long-text-lorem-ipsom",
"description": "The type of text, such as a description or title."
},
"timestamp": {
"type": "integer",
"desciption": "Unix timestamp representing creation or modification time.",
"example": 1743391587
},
"type": {
"type": "string",
"description": "The actual text content.",
"example": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua."
}
}
}
Response 201 Created
{
"_id": "4cb7d96c-6f72-470e-884c-6b96bb99a22e",
"_links": {
"self": "https://api.openpublishing.com/resource/v3/subjects/ed7eaaa5-699a-491b-a5da-29e2d49caa46/texts/4cb7d96c-6f72-470e-884c-6b96bb99a22e"
},
"language": "eng",
"mime_type": "text/plain",
"text": "long-text-lorem-ipsom",
"timestamp": 1743391587,
"type": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua."
}
Schema of the response body
{
"type": "object",
"properties": {
"_id": {
"type": "string",
"description": "Unique identifier for the subject",
"example": "4cb7d96c-6f72-470e-884c-6b96bb99a22e"
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "string",
"example": "https://api.openpublishing.com/resource/v3/subjects/ed7eaaa5-699a-491b-a5da-29e2d49caa46/texts/4cb7d96c-6f72-470e-884c-6b96bb99a22e"
}
}
},
"language": {
"type": "string",
"description": "anguage code in ISO 639-2 format indicating the language of the text.",
"example": "eng"
},
"mime_type": {
"type": "string",
"description": "MIME type of the text content.",
"example": "text/plain"
},
"text": {
"type": "string",
"example": "long-text-lorem-ipsom",
"description": "The type of text, such as a description or title."
},
"timestamp": {
"type": "integer",
"desciption": "Unix timestamp representing creation or modification time.",
"example": 1743391587
},
"type": {
"type": "string",
"description": "The actual text content.",
"example": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua."
}
}
}
GET /resource/v3/subjects/{subject_id}/texts/{id}
Retrieve a single subject text by ID
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | string | No | The unique identifier of the subject text | |
subject_id |
path | string | No | The unique identifier of the subject |
Response 200 OK
{
"_id": "4cb7d96c-6f72-470e-884c-6b96bb99a22e",
"_links": {
"self": "https://api.openpublishing.com/resource/v3/subjects/ed7eaaa5-699a-491b-a5da-29e2d49caa46/texts/4cb7d96c-6f72-470e-884c-6b96bb99a22e"
},
"language": "eng",
"mime_type": "text/plain",
"text": "long-text-lorem-ipsom",
"timestamp": 1743391587,
"type": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua."
}
Schema of the response body
{
"type": "object",
"properties": {
"_id": {
"type": "string",
"description": "Unique identifier for the subject",
"example": "4cb7d96c-6f72-470e-884c-6b96bb99a22e"
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "string",
"example": "https://api.openpublishing.com/resource/v3/subjects/ed7eaaa5-699a-491b-a5da-29e2d49caa46/texts/4cb7d96c-6f72-470e-884c-6b96bb99a22e"
}
}
},
"language": {
"type": "string",
"description": "anguage code in ISO 639-2 format indicating the language of the text.",
"example": "eng"
},
"mime_type": {
"type": "string",
"description": "MIME type of the text content.",
"example": "text/plain"
},
"text": {
"type": "string",
"example": "long-text-lorem-ipsom",
"description": "The type of text, such as a description or title."
},
"timestamp": {
"type": "integer",
"desciption": "Unix timestamp representing creation or modification time.",
"example": 1743391587
},
"type": {
"type": "string",
"description": "The actual text content.",
"example": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua."
}
}
}
PUT /resource/v3/subjects/{subject_id}/texts/{id}
Update subject text
Request body
{
"_id": "4cb7d96c-6f72-470e-884c-6b96bb99a22e",
"_links": {
"self": "https://api.openpublishing.com/resource/v3/subjects/ed7eaaa5-699a-491b-a5da-29e2d49caa46/texts/4cb7d96c-6f72-470e-884c-6b96bb99a22e"
},
"language": "eng",
"mime_type": "text/plain",
"text": "long-text-lorem-ipsom",
"timestamp": 1743391587,
"type": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua."
}
Schema of the request body
{
"type": "object",
"properties": {
"_id": {
"type": "string",
"description": "Unique identifier for the subject",
"example": "4cb7d96c-6f72-470e-884c-6b96bb99a22e"
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "string",
"example": "https://api.openpublishing.com/resource/v3/subjects/ed7eaaa5-699a-491b-a5da-29e2d49caa46/texts/4cb7d96c-6f72-470e-884c-6b96bb99a22e"
}
}
},
"language": {
"type": "string",
"description": "anguage code in ISO 639-2 format indicating the language of the text.",
"example": "eng"
},
"mime_type": {
"type": "string",
"description": "MIME type of the text content.",
"example": "text/plain"
},
"text": {
"type": "string",
"example": "long-text-lorem-ipsom",
"description": "The type of text, such as a description or title."
},
"timestamp": {
"type": "integer",
"desciption": "Unix timestamp representing creation or modification time.",
"example": 1743391587
},
"type": {
"type": "string",
"description": "The actual text content.",
"example": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua."
}
}
}
Response 200 OK
{
"_id": "4cb7d96c-6f72-470e-884c-6b96bb99a22e",
"_links": {
"self": "https://api.openpublishing.com/resource/v3/subjects/ed7eaaa5-699a-491b-a5da-29e2d49caa46/texts/4cb7d96c-6f72-470e-884c-6b96bb99a22e"
},
"language": "eng",
"mime_type": "text/plain",
"text": "long-text-lorem-ipsom",
"timestamp": 1743391587,
"type": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua."
}
Schema of the response body
{
"type": "object",
"properties": {
"_id": {
"type": "string",
"description": "Unique identifier for the subject",
"example": "4cb7d96c-6f72-470e-884c-6b96bb99a22e"
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "string",
"example": "https://api.openpublishing.com/resource/v3/subjects/ed7eaaa5-699a-491b-a5da-29e2d49caa46/texts/4cb7d96c-6f72-470e-884c-6b96bb99a22e"
}
}
},
"language": {
"type": "string",
"description": "anguage code in ISO 639-2 format indicating the language of the text.",
"example": "eng"
},
"mime_type": {
"type": "string",
"description": "MIME type of the text content.",
"example": "text/plain"
},
"text": {
"type": "string",
"example": "long-text-lorem-ipsom",
"description": "The type of text, such as a description or title."
},
"timestamp": {
"type": "integer",
"desciption": "Unix timestamp representing creation or modification time.",
"example": 1743391587
},
"type": {
"type": "string",
"description": "The actual text content.",
"example": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua."
}
}
}
DELETE /resource/v3/subjects/{subject_id}/texts/{id}
Delete subject text
Response 204 No Content
Schemas
Subject
| Name | Type |
|---|---|
_id |
integer
Example: |
_links |
Properties: self |
bisac |
Array<string> |
description |
string A brief description of the subject.
Example: |
identifier |
string| null External identifier for the subject. |
labels |
Array<string> |
name |
Array<Properties: language, text> |
realm |
Properties: _id, _links, name, screennameReference to realm which owns this object |
vlb |
Array<string> |
Subject Text
| Name | Type |
|---|---|
_id |
string Unique identifier for the subject
Example: |
_links |
Properties: self |
language |
string anguage code in ISO 639-2 format indicating the language of the text.
Example: |
mime_type |
string MIME type of the text content.
Example: |
text |
string The type of text, such as a description or title.
Example: |
timestamp |
integer
Example: |
type |
string The actual text content.
Example: |