Skip to content

Marketplace Offering Referrals

Operations Summary

Method Endpoint Description
GET /api/marketplace-offering-referrals/ List Datacite referrals for offerings
GET /api/marketplace-offering-referrals/{uuid}/ Retrieve a specific Datacite referral

List Datacite referrals for offerings

Returns a paginated list of Datacite referrals associated with marketplace offerings. Referrals represent relationships between an offering (identified by a DOI) and other research outputs, such as publications or datasets. The list must be filtered by the offering's scope.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-referrals/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_referrals import marketplace_offering_referrals_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_referrals_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_offering_referrals_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceOfferingReferralsList } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingReferralsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
scope string
scope_uuid string (uuid)
pid string
relation_type string
resource_type string
creator string
publisher string
published string
title string
referral_url string

Retrieve a specific Datacite referral

Returns the details of a single Datacite referral record, identified by its UUID. Details include the related identifier (PID), the type of relationship, and metadata about the related work.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-referrals/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_referrals import marketplace_offering_referrals_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_referrals_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_offering_referrals_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingReferralsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingReferralsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
scope string
scope_uuid string (uuid)
pid string
relation_type string
resource_type string
creator string
publisher string
published string
title string
referral_url string