foliolib.folio.api.consortiaKeycloak.SharingInstances

class foliolib.folio.api.consortiaKeycloak.SharingInstances(tenant: str)

Bases: foliolib.folio.FolioApi

Sharing instance and setting integration API

Sharing instance and setting integration API

Base class of the Folio API

Parameters

tenant (str) – Tenant id

Methods

getsharinginstancebyid(consortiumId, actionId)	GET /consortia/{consortiumId}/sharing/instances/{actionId}
getsharinginstances(consortiumId, **kwargs)	Sharing instances
startsharinginstance(consortiumId, ...)	POST /consortia/{consortiumId}/sharing/instances

getsharinginstancebyid(consortiumId, actionId)

GET /consortia/{consortiumId}/sharing/instances/{actionId}

Parameters

• consortiumId (str) –

• actionId (str) –

Returns

See Schema below.

Return type

dict

Raises

• OkapiRequestError – Bad request

• OkapiRequestNotFound – Resource not found

• OkapiRequestFatalError – Internal server error

Schema

{
    "description": "A JSON schema for the Sharing Instance",
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "format": "uuid"
        },
        "instanceIdentifier": {
            "type": "string",
            "format": "uuid"
        },
        "sourceTenantId": {
            "type": "string"
        },
        "targetTenantId": {
            "type": "string"
        },
        "status": {
            "type": "string",
            "$ref": "status.yaml#/Status"
        },
        "error": {
            "type": "string"
        },
        "metadata": {
            "type": "object",
            "$ref": "common.yaml#/Metadata"
        }
    },
    "additionalProperties": false,
    "required": [
        "instanceIdentifier",
        "sourceTenantId",
        "targetTenantId"
    ]
}

getsharinginstances(consortiumId, **kwargs)

Sharing instances

GET /consortia/{consortiumId}/sharing/instances

Parameters

consortiumId (str) –

Keyword Arguments

• instanceIdentifier (str) –

• sourceTenantId (str) – The ID of the source tenant

• targetTenantId (str) – The ID of the target tenant

• status (str) –

• offset (int) – Skip over a number of elements by specifying an offset value for the query (default: 0, minimum: 0, maximum: 2147483647)

• limit (int) – Limit the number of elements returned in the response (default: 10, minimum: 0, maximum: 2147483647)

Returns

See Schema below.

Return type

dict

Raises

• OkapiRequestError – Bad request

• OkapiRequestNotFound – Resource not found

• OkapiRequestFatalError – Internal server error

Schema

{
    "description": "A JSON schema for the Sharing Instances Collection",
    "type": "object",
    "properties": {
        "sharingInstances": {
            "type": "array",
            "description": "The list of sharing instances",
            "items": {
                "type": "object",
                "$ref": "sharingInstance.yaml#/SharingInstance"
            }
        },
        "totalRecords": {
            "type": "integer"
        }
    },
    "additionalProperties": false,
    "required": [
        "sharingInstances",
        "totalRecords"
    ]
}

startsharinginstance(consortiumId, sharingInstance)

POST /consortia/{consortiumId}/sharing/instances

Parameters

• consortiumId (str) –

• sharingInstance (dict) – See Schema below.

Returns

See Schema below.

Return type

dict

Raises

• OkapiRequestError – Bad request

• OkapiRequestNotFound – Resource not found

• OkapiRequestConflict – Validation errors

• OkapiRequestUnprocessableEntity – Validation errors

• OkapiRequestFatalError – Internal server error

Schema

{
    "description": "A JSON schema for the Sharing Instance",
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "format": "uuid"
        },
        "instanceIdentifier": {
            "type": "string",
            "format": "uuid"
        },
        "sourceTenantId": {
            "type": "string"
        },
        "targetTenantId": {
            "type": "string"
        },
        "status": {
            "type": "string",
            "$ref": "status.yaml#/Status"
        },
        "error": {
            "type": "string"
        },
        "metadata": {
            "type": "object",
            "$ref": "common.yaml#/Metadata"
        }
    },
    "additionalProperties": false,
    "required": [
        "instanceIdentifier",
        "sourceTenantId",
        "targetTenantId"
    ]
}