Components

A GET request will list all of the service’s components. The fields parameter defines which component object properties should be contained in the response.

Response structure

{snippets}/should_document_get_components_with_fields/response-fields.adoc

Example request

{snippets}/should_document_get_components_with_fields/curl-request.adoc

Example response

{snippets}/should_document_get_components_with_fields/http-response.adoc

Links

{snippets}/should_document_get_components_with_fields/links.adoc

Listing by name

A GET request will list all of the service’s components by component name.
Please set the request parameter &name=<NAME>.

Note : send query parameter’s value in encoded format. (Reference: https://datatracker.ietf.org/doc/html/rfc3986)

Response structure

{snippets}/should_document_get_components_by_name/response-fields.adoc

Example request

{snippets}/should_document_get_components_by_name/curl-request.adoc

Example response

{snippets}/should_document_get_components_by_name/http-response.adoc

Links

{snippets}/should_document_get_components_by_name/links.adoc

Listing by type

A GET request will list all of the service’s components by component type.
Component types = {INTERNAL, OSS, COTS, FREESOFTWARE, INNER_SOURCE, SERVICE, CODE_SNIPPET}

Response structure

{snippets}/should_document_get_components_by_type/response-fields.adoc

Example request

{snippets}/should_document_get_components_by_type/curl-request.adoc

Example response

{snippets}/should_document_get_components_by_type/http-response.adoc

Links

{snippets}/should_document_get_components_by_type/links.adoc

Get a single component

A GET request will get a single component.

Response structure

{snippets}/should_document_get_component/response-fields.adoc

Example request

{snippets}/should_document_get_component/curl-request.adoc

Example response

{snippets}/should_document_get_component/http-response.adoc

Links

{snippets}/should_document_get_component/links.adoc

Listing by external ids

A GET request will get all components corresponding to external ids
The request parameter supports MultiValueMap (allows to add duplicate keys with different values)
It’s possible to search for components only by the external id key by leaving the value.

Note : send query parameter’s value in encoded format. (Reference: https://datatracker.ietf.org/doc/html/rfc3986)

Response structure

{snippets}/should_document_get_components_by_external-ids/response-fields.adoc

Example request

{snippets}/should_document_get_components_by_external-ids/curl-request.adoc

Example response

{snippets}/should_document_get_components_by_external-ids/http-response.adoc

Listing attachment info

A GET request will get all attachment information of a component.

Response structure

{snippets}/should_document_get_component_attachment_info/response-fields.adoc

Example request

{snippets}/should_document_get_component_attachment_info/curl-request.adoc

Example response

{snippets}/should_document_get_component_attachment_info/http-response.adoc

Update attachment info

A PATCH request is used to update an attachment info

Request structure

{snippets}/should_document_update_component_attachment_info/request-fields.adoc

Response structure

{snippets}/should_document_update_component_attachment_info/response-fields.adoc

Example request

{snippets}/should_document_update_component_attachment_info/curl-request.adoc

Example response

{snippets}/should_document_update_component_attachment_info/http-response.adoc

Upload attachment to component

A POST request is used to upload attachment to component

Request structure

Path	Type	Description
file	file	File path of the attachment
attachment.filename	String	Name of the file
attachment.attachmentContentId	String	Id of attachment info
attachment.attachmentType	String	Type of attachment, possible values are: [DOCUMENT, SOURCE, DESIGN, REQUIREMENT, CLEARING_REPORT, COMPONENT_LICENSE_INFO_XML, COMPONENT_LICENSE_INFO_COMBINED, SCAN_RESULT_REPORT, SCAN_RESULT_REPORT_XML, SOURCE_SELF, BINARY, BINARY_SELF, DECISION_REPORT, LEGAL_EVALUATION, LICENSE_AGREEMENT, SCREENSHOT, OTHER, README_OSS]
attachment.checkStatus	String	Status of attachment, possible values are: [NOTCHECKED, ACCEPTED, REJECTED]
attachment.createdComment	String	Comment while uploading attachment.

Response structure

Complete Component will be returned

Example request

{snippets}/should_document_upload_attachment_to_component/curl-request.adoc

Example response

{snippets}/should_document_upload_attachment_to_component/http-response.adoc

Download attachment

A GET request will allow you to download an attachment of a component.
Please set the Accept-Header application/*. Only this Accept-Header is supported.

Example request

{snippets}/should_document_get_component_attachment/curl-request.adoc

Example response

{snippets}/should_document_get_component_attachment/http-response.adoc

Download attachment bundle

A GET request will allow you to download the attachment bundle of a component.
Please set the Accept-Header application/zip. Only this Accept-Header is supported.

Example request

{snippets}/should_document_get_component_attachment_bundle/curl-request.adoc

Example response

{snippets}/should_document_get_component_attachment_bundle/http-response.adoc

Delete attachments

With a DELETE request one or multiple attachments can be deleted from a component. To delete multiple attachments at once, just specify a comma-separated list of attachment IDs.

Note that attachments can only be deleted if they are not used by a project. Requests that cannot delete any of the attachments specified fail with response status 500.

Example request

{snippets}/should_document_delete_component_attachment/curl-request.adoc

Example response

{snippets}/should_document_delete_component_attachment/http-response.adoc

The response contains the updated component. Here the set of attachments is especially relevant. If multiple attachments were to be deleted, but the deletion failed for some of them, those can still be found in the set. So callers should inspect the set of attachments in the result to find out whether all delete operations have been successful.