Enumerations

SW360 enumeration values for the internal thrift API

SW360 thrift API is comprised of the following methods:

  • attachments
  • codescoop
  • components
  • cvesearch
  • fossology
  • importstatus
  • licenseinfo
  • licenses
  • moderation
  • projectimport
  • projects
  • schedule
  • search
  • sw360
  • users
  • vendors
  • vulnerabilities

Reference: https://github.com/eclipse/sw360/tree/master/libraries/lib-datahandler/src/main/thrift

Attachments

https://github.com/eclipse/sw360/blob/master/libraries/lib-datahandler/src/main/thrift/attachments.thrift

AttachmentType

ValueDescription.
DOCUMENTjusta document
SOURCEoriginal course code
DESIGNdesign document
REQUIREMENTrequirements document
CLEARING_REPORTOSS licensing reporting
COMPONENT_LICENSE_INFO_XMLXML document with licenseing information - e.g. SPDX
COMPONENT_LICENSE_INFO_COMBINEDXML document with licensing information covering multiple componnts at once - e.g. SPDX
SCAN_RESULT_REPORTOutput what a scanner for licenses has found
SCAN_RESULT_REPORT_XMLOutput what a scanner for licenses has found this time in XML
SOURCE_SELFSelf assembled source code distribution
BINARYBinary of component from vendor
BINARY_SELFSelf built binary
DECISION_REPORTdocumenting importing decisions for using this item
LEGAL_EVALUATIONSome legal evaluation created for this item
LICENSE_AGREEMENTA ruling license agreement for this item, note that this could be for commercial software for example
SCREENSHOTScreenshot, usually screenshot of the Website with licensing information
OTHERanything that dos not match to the given above

CheckStatus

ValueDescription.
NOTCHECKEDDefault value after upload.
ACCEPTEDReviewed and confirmed attachment.
REJECTEDDocument or attachment cannot be used.

CodeScoop Thrift File

https://github.com/eclipse/sw360/blob/master/libraries/lib-datahandler/src/main/thrift/codescoop.thrift

Components

https://github.com/eclipse/sw360/blob/master/libraries/lib-datahandler/src/main/thrift/components.thrift

cvesearch

https://github.com/eclipse/sw360/blob/master/libraries/lib-datahandler/src/main/thrift/cvesearch.thrift

ValueDescription
NEW
UPDATEDNew information for a notification message, so it is updated
OLD
FAILED

Fossology

https://github.com/eclipse/sw360/blob/master/libraries/lib-datahandler/src/main/thrift/fossology.thrift

No enumerations provided

Importstatus

https://github.com/eclipse/sw360/blob/master/libraries/lib-datahandler/src/main/thrift/importstatus.thrift

No enumerations provided

License Info

https://github.com/eclipse/sw360/blob/master/libraries/lib-datahandler/src/main/thrift/licenseinfo.thrift

No enumerations provided

LicenseInfoRequestStatus

ValueDescription
SUCCESS
NO_APPLICABLE_SOURCE
FAILURE

OutputFormatVariant

ValueDescription
REPORT
DISCLOSURE

Licenses

https://github.com/eclipse/sw360/blob/master/libraries/lib-datahandler/src/main/thrift/licenses.thrift

No enumerations provided

Moderation

https://github.com/eclipse/sw360/blob/master/libraries/lib-datahandler/src/main/thrift/moderation.thrift

DocumentType

ValueDescription
COMPONENT
RELEASE
PROJECT
LICENSE
USER

Project Import

https://github.com/eclipse/sw360/blob/master/libraries/lib-datahandler/src/main/thrift/projectimport.thrift

No enumerations provided

Projects

https://github.com/eclipse/sw360/blob/master/libraries/lib-datahandler/src/main/thrift/projects.thrift

Project State

ValueDescription
ACTIVEwell
PHASE_OUTwell
UNKNOWNwell

Project Type

ValueDescription
CUSTOMERProject that delivers artifacts to customer outside organisation
INTERNALProject that provides artifacts or service for internal use
PRODUCTJust that it is a product instead of a project
SERVICEProject that provides services to customer outside organisation
INNER_SOURCEInner source project, meaning that everyone inside org can use it

Project Relationship

ValueDescription
UNKNOWNunknown
REFERREDSister project
CONTAINEDSub project
DUPLICATEduplicate

Project Clearing State

ValueDescription
OPENnot started
IN_PROGRESS
CLOSED

Schedule

https://github.com/eclipse/sw360/blob/master/libraries/lib-datahandler/src/main/thrift/schedule.thrift

No enumerations provided

https://github.com/eclipse/sw360/blob/master/libraries/lib-datahandler/src/main/thrift/search.thrift

No enumerations provided

General SW360 Thrift

Software Mainline States

ValueDescription
OPENNot decided so far
MAINLINEOrganisation or person thinks that use of this software is recommended, which included multiple versions.
SPECIFICThe software is not recommended in general, but for special use case or for this particular version it is acceptable.
PHASE_OUTThe software has issues, please consider removing it soon, if in use.
DENIEDSoftware which is not allowed for use. For example, software that does not have licensing.

General SW360 Thrift

Software Mainline States

ValueDescription.
OPENNot decided so far
MAINLINEOrganisation or person thinks that use of this software is recommended, which included multiple versions.
SPECIFICThe software is not recommended in general, but for special use case or for this particular version it is acceptable.
PHASE_OUTThe software has issues, please consider removing it soon, if in use.
DENIEDSoftware which is not allowed for use. For example, software that does not have licensing.

Moderation States

ValueDescription
PENDINGNot opened so far.
APPROVEDA person who has received the moderation request (which could be creator of the document, a clearing admin, a moderator, etc.) has approved the moderation request. It could be deleted then.
REJECTEDA person who has received the moderation request (which could be creator of the document, a clearing admin, a moderator, etc.) has rejected the moderation request.
INPROGRESSA person who has received the moderation request (which could be creator of the document, a clearing admin, a moderator, etc.) has opened / viewed the moderation request, but did not decide.

Visibility

ValueDescription
PRIVATEOnly visible by creator (and admin which applies to all visibility levels).
ME_AND_MODERATORSVisible by creator and moderators.
BUISNESSUNIT_AND_MODERATORSAll users of the same group and the moderators.
EVERYONEEvery user who is logged into the system.

Verification State

ValueDescription
NOT_CHECKEDNo one has yet looked at this and verified it.
CHECKEDIt is verified.
INCORRECTIt was decided that the verification should be rejected.

Release Relationship

ValueDescriptionClearing releav nt
CONTAINEDIf you just do not know whether it is dynamically linked.Yes
REFERREDReferencing a stand alone used other part.No
UNKNOWNIf you just do not know.Yes
DYNAMICALLY_LINKEDSoftware dynamically linked - as the name says.Yes
STATICALLY_LINKEDSoftware statically linked - as the name says.Yes
SIDE_BY_SIDENot decided so far.Yes
STANDALONESoftware is given as standalone delivery, ie. not technically connected.Yes
INTERNAL_USEUsed for creating or building or ? the product or projects but not delivered.Yes
OPTIONALIs not mandatory part of the installation.Yes
TO_BE_REPLACEDIs there but should be moved out.Yes

Users

https://github.com/eclipse/sw360/blob/master/libraries/lib-datahandler/src/main/thrift/users.thrift

Vendors

https://github.com/eclipse/sw360/blob/master/libraries/lib-datahandler/src/main/thrift/vendors.thrift

No enumerations provided

Vulnerabilities

https://github.com/eclipse/sw360/blob/master/libraries/lib-datahandler/src/main/thrift/vulnerabilities.thrift

No enumerations provided

Last modified March 29, 2023: upd(project): Major updates (3fc96db)