foliolib.folio.api.consortia.Publications

class foliolib.folio.api.consortia.Publications(tenant: str, okapi: Optional[foliolib.okapi.okapiClient.OkapiClient] = None)

Bases: foliolib.folio.FolioApi

Publish coordinator API

Publish coordinator API

Parameters

• tenant (str) – Tenant id

• okapi (OkapiClient, optional) – Instance of OkapiClient. Defaults to None.

Methods

getpublicationdetails(consortiumId, ...)	GET /consortia/{consortiumId}/publications/{publicationId}
publishrequests(consortiumId, publicationRequest)	POST /consortia/{consortiumId}/publications

getpublicationdetails(consortiumId, publicationId)

GET /consortia/{consortiumId}/publications/{publicationId}

Parameters

• consortiumId (str) –

• publicationId (str) –

Returns

See Schema below.

Return type

dict

Raises

• OkapiRequestError – Bad request

• OkapiFatalError – Internal server error

Schema

{
    "type": "object",
    "title": "Publication details response",
    "properties": {
        "id": {
            "description": "id of publication record",
            "$ref": "common.yaml#/uuid"
        },
        "status": {
            "type": "string",
            "$ref": "publication_schema.yaml#/PublicationStatus"
        },
        "dateTime": {
            "description": "the date of publication was created",
            "type": "string"
        },
        "request": {
            "description": "tenant request payload",
            "type": "string"
        },
        "errors": {
            "description": "List of errors",
            "type": "array",
            "items": {
                "type": "object",
                "$ref": "publication_schema.yaml#/PublicationStatusError"
            }
        }
    },
    "additionalProperties": false
}

publishrequests(consortiumId, publicationRequest)

POST /consortia/{consortiumId}/publications

Parameters

• consortiumId (str) –

• publicationRequest (dict) – See Schema below.

Returns

See Schema below.

Return type

dict

Raises

• OkapiRequestError – Bad request

• OkapiRequestConflict – Validation errors

• OkapiFatalError – Internal server error

Schema

{
    "type": "object",
    "title": "Publication request",
    "properties": {
        "url": {
            "description": "URL for publishing requests for consortia tenants",
            "type": "string"
        },
        "method": {
            "description": "HTTP method",
            "type": "string"
        },
        "tenants": {
            "description": "Set of tenants to be requested",
            "type": "array",
            "uniqueItems": true,
            "items": {
                "type": "string"
            }
        },
        "payload": {
            "description": "Http request body",
            "type": "object"
        }
    },
    "additionalProperties": false
}

{
    "type": "object",
    "title": "Publication response",
    "properties": {
        "id": {
            "description": "id of publication record",
            "$ref": "common.yaml#/uuid"
        },
        "status": {
            "type": "string",
            "$ref": "publication_schema.yaml#/PublicationStatus"
        }
    },
    "additionalProperties": false
}