Skip to main content

Attributions REST API

Use this REST API to manage Additional Attributions for a component.

Methods Supported:

  • GET

  • POST

  • DELETE

GET Additional Attributions

Use the GET method to retrieve previously added "Additional Attributions" for a specified component identifier.

GET /api/experimental/licenseLegalMetadata/{ownerType: application|organization}/{ownerId}/component/obligation/attribution

Example:

curl -u username:password 'http://localhost:8070/api/experimental/licenseLegalMetadata/application/client-frameworks/component/obligation/attribution?componentIdentifier=%7B%22format%22%3A%22pypi%22%2C%22coordinates%22%3A%7B%22extension%22%3A%22whl%22%2C%22name%22%3A%22anyio%22%2C%22qualifier%22%3A%22py3-none-any%22%2C%22version%22%3A%223.6.1%22%7D%7D' -H 'Accept: application/json, text/plain, */*' 

The response contains the "Additional Attributions" text that was previously added for the component identifier.

Add an Additional Attribution

Use the POST method to add an "Additional Attribution" for a specified component identifier. This will be included in the attribution report.

 POST /api/experimental/licenseLegalMetadata/{ownerType: application|organization}/{ownerId}/component/obligation/attribution

Example:

curl -u username:password 'http://localhost:8070/api/experimental/licenseLegalMetadata/application/client-frameworks/component/obligation/attribution' -H 'Accept: application/json, text/plain, */*' -H 'Content-Type: application/json' --data-raw '{"id":null,"componentIdentifier":{"format":"pypi","coordinates":{"extension":"whl","name":"anyio","qualifier":"py3-none-any","version":"3.6.1"}},"obligationName":null,"content":"This is generic attribution text."}'

Delete an Additional Attribution

Use the DELETE method to remove a previously added "Additional Attribution" for the specified obligation attribution ID.

 DELETE /api/experimental/licenseLegalMetadata/component/obligation/attribution/{componentObligationAttributionId}

Example:

curl -u username:password 'http://localhost:8070/api/experimental/licenseLegalMetadata/component/obligation/attribution/9369b876ad9e4900b398ad35ec01c13c?timestamp=1741718674017' \  -X 'DELETE' -H 'Accept: application/json, text/plain, */*'